mongodb/mongoid

View on GitHub
lib/mongoid/association/nested/nested_buildable.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true
# rubocop:todo all

module Mongoid
  module Association
    module Nested

      # Mixin module containing common functionality used to
      # perform #accepts_nested_attributes_for attribute assignment
      # on associations.
      module Buildable

        attr_accessor :attributes, :existing, :association, :options

        # Determines if destroys are allowed for this document.
        #
        # @example Do we allow a destroy?
        #   builder.allow_destroy?
        #
        # @return [ true | false ] True if the allow destroy option was set.
        def allow_destroy?
          options[:allow_destroy] || false
        end

        # Returns the reject if option defined with the macro.
        #
        # @example Is there a reject proc?
        #   builder.reject?
        #
        # @param [ Document ] document The parent document of the association
        # @param [ Hash ] attrs The attributes to check for rejection.
        #
        # @return [ true | false ] True and call proc or method if rejectable, false if not.
        def reject?(document, attrs)
          case callback = options[:reject_if]
            when Symbol
              document.method(callback).arity == 0 ? document.send(callback) : document.send(callback, attrs)
            when Proc
              callback.call(attrs)
            else
              false
          end
        end

        # Determines if only updates can occur. Only valid for one-to-one
        # associations.
        #
        # @example Is this update only?
        #   builder.update_only?
        #
        # @return [ true | false ] True if the update_only option was set.
        def update_only?
          options[:update_only] || false
        end

        # Convert an id to its appropriate type.
        #
        # @example Convert the id.
        #   builder.convert_id(Person, "4d371b444835d98b8b000010")
        #
        # @param [ Class ] klass The class we're trying to convert for.
        # @param [ String ] id The id, usually coming from the form.
        #
        # @return [ BSON::ObjectId | String | Object ] The converted id.
        def convert_id(klass, id)
          klass.using_object_ids? ? BSON::ObjectId.mongoize(id) : id
        end

        private

        # Get the id attribute from the given hash, whether it's
        # prefixed with an underscore or is a symbol.
        #
        # @example Get the id.
        #   extract_id({ _id: 1 })
        #
        # @param [ Hash ] hash The hash from which to extract.
        #
        # @return [ Object ] The value of the id.
        def extract_id(hash)
          hash['_id'] || hash[:_id] || hash['id'] || hash[:id]
        end

        # Deletes the id key from the given hash.
        #
        # @example Delete an id value.
        #   delete_id({ "_id" => 1 })
        #
        # @param [ Hash ] hash The hash from which to delete.
        #
        # @return [ Object ] The deleted value, or nil.
        def delete_id(hash)
          hash.delete('_id') || hash.delete(:_id) || hash.delete('id') || hash.delete(:id)
        end
      end
    end
  end
end