mongoid-braxton 2.0.2

data/lib/mongoid/relations/bindings/referenced/many_to_many.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+module Mongoid # :nodoc:
+  module Relations #:nodoc:
+    module Bindings #:nodoc:
+      module Referenced #:nodoc:
+
+        # Binding class for all references_and_referenced_in_many relations.
+        class ManyToMany < Binding
+
+          # Binds the base object to the inverse of the relation. This is so we
+          # are referenced to the actual objects themselves on both sides.
+          #
+          # This case sets the metadata on the inverse object as well as the
+          # document itself.
+          #
+          # @example Bind all the documents.
+          #   person.preferences.bind
+          #   person.preferences = [ Preference.new ]
+          #
+          # @param [ Hash ] options The binding options.
+          #
+          # @option options [ true, false ] :continue Continue binding the inverse.
+          # @option options [ true, false ] :binding Are we in build mode?
+          #
+          # @since 2.0.0.rc.1
+          def bind(options = {})
+            target.each { |doc| bind_one(doc, options) }
+          end
+
+          # Binds a single document with the inverse relation. Used
+          # specifically when appending to the proxy.
+          #
+          # @example Bind one document.
+          #   person.preferences.bind_one(preference)
+          #
+          # @param [ Document ] doc The single document to bind.
+          # @param [ Hash ] options The binding options.
+          #
+          # @option options [ true, false ] :continue Continue binding the inverse.
+          # @option options [ true, false ] :binding Are we in build mode?
+          #
+          # @since 2.0.0.rc.1
+          def bind_one(doc, options = {})
+            if options[:continue]
+              inverse = metadata.inverse(target)
+              if inverse
+                doc.do_or_do_not(
+                  inverse,
+                  false,
+                  OPTIONS
+                ).push(base, :binding => true, :continue => false)
+              end
+            end
+          end
+
+          # Unbinds the base object and the inverse, caused by setting the
+          # reference to nil.
+          #
+          # @example Unbind the documents.
+          #   person.preferences.unbind
+          #   person.preferences = nil
+          #
+          # @param [ Hash ] options The binding options.
+          #
+          # @option options [ true, false ] :continue Continue binding the inverse.
+          # @option options [ true, false ] :binding Are we in build mode?
+          #
+          # @since 2.0.0.rc.1
+          def unbind(options = {})
+            target.each { |doc| unbind_one(doc, options) }
+          end
+
+          # Unbind a single document.
+          #
+          # @example Unbind the document.
+          #   person.preferences.unbind_one(document)
+          #
+          # @todo Durran: Get rid of persistence operation in this method.
+          #
+          # @param [ Hash ] options The binding options.
+          #
+          # @option options [ true, false ] :continue Continue binding the inverse.
+          # @option options [ true, false ] :binding Are we in build mode?
+          #
+          # @since 2.0.0.rc.1
+          def unbind_one(doc, options = {})
+            base.do_or_do_not(metadata.foreign_key).delete(doc.id)
+            if options[:continue]
+              inverse = metadata.inverse(target)
+              if inverse
+                doc.do_or_do_not(
+                  inverse, false, OPTIONS
+                ).delete(base, :binding => true, :continue => false)
+              end
+            else
+              base.save if base.persisted?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations/bindings/referenced/one.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+module Mongoid # :nodoc:
+  module Relations #:nodoc:
+    module Bindings #:nodoc:
+      module Referenced #:nodoc:
+
+        # Binding class for references_one relations.
+        class One < Binding
+
+          # Binds the base object to the inverse of the relation. This is so we
+          # are referenced to the actual objects themselves on both sides.
+          #
+          # This case sets the metadata on the inverse object as well as the
+          # document itself.
+          #
+          # @example Bind the document.
+          #   person.game.bind(:continue => true)
+          #   person.game = Game.new
+          #
+          # @param [ Hash ] options The options to pass through.
+          #
+          # @option options [ true, false ] :continue Do we continue binding?
+          # @option options [ true, false ] :binding Are we in build mode?
+          #
+          # @since 2.0.0.rc.1
+          def bind(options = {})
+            if options[:continue]
+              target.do_or_do_not(metadata.foreign_key_setter, base.id)
+              target.do_or_do_not(
+                metadata.inverse_setter,
+                base,
+                OPTIONS
+              )
+            end
+          end
+          alias :bind_one :bind
+
+          # Unbinds the base object and the inverse, caused by setting the
+          # reference to nil.
+          #
+          # @example Unbind the document.
+          #   person.game.unbind(:continue => true)
+          #   person.game = nil
+          #
+          # @param [ Hash ] options The options to pass through.
+          #
+          # @option options [ true, false ] :continue Do we continue unbinding?
+          # @option options [ true, false ] :binding Are we in build mode?
+          #
+          # @since 2.0.0.rc.1
+          def unbind(options = {})
+            if options[:continue]
+              target.do_or_do_not(metadata.foreign_key_setter, nil)
+              target.do_or_do_not(
+                metadata.inverse_setter,
+                nil,
+                OPTIONS
+              )
+            end
+          end
+          alias :unbind_one :unbind
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations/builder.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module Mongoid # :nodoc:
+  module Relations #:nodoc:
+
+    # Superclass for all builder objects. Builders are responsible for either
+    # looking up a relation's target from the database, or creating them from a
+    # supplied attributes hash.
+    class Builder
+
+      attr_reader :metadata, :object
+      # Instantiate the new builder for a relation.
+      #
+      # @example Create the builder.
+      #   Builder.new(metadata, { :field => "value })
+      #
+      # @param [ Metdata ] metadata The metadata for the relation.
+      # @param [ Hash, BSON::ObjectId ] object The attributes to build from or
+      #   id to query with.
+      #
+      # @since 2.0.0.rc.1
+      def initialize(metadata, object)
+        @metadata, @object = metadata, object
+      end
+
+      protected
+      # Do we need to perform a database query? It will be so if the object we
+      # have is not a document.
+      #
+      # @example Should we query the database?
+      #   builder.query?
+      #
+      # @return [ true, false ] Whether a database query should happen.
+      #
+      # @since 2.0.0.rc.1
+      def query?
+        return true unless object.respond_to?(:to_a)
+        obj = object.to_a.first
+        !obj.respond_to?(:attributes) && !obj.nil?
+      end
+    end
+  end
+end

data/lib/mongoid/relations/builders.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+require "mongoid/relations/builder"
+require "mongoid/relations/nested_builder"
+require "mongoid/relations/builders/embedded/in"
+require "mongoid/relations/builders/embedded/many"
+require "mongoid/relations/builders/embedded/one"
+require "mongoid/relations/builders/nested_attributes/one"
+require "mongoid/relations/builders/nested_attributes/many"
+require "mongoid/relations/builders/referenced/in"
+require "mongoid/relations/builders/referenced/many"
+require "mongoid/relations/builders/referenced/many_to_many"
+require "mongoid/relations/builders/referenced/one"
+
+module Mongoid # :nodoc:
+  module Relations #:nodoc:
+
+    # This module is responsible for defining the build and create methods used
+    # in one to one relations.
+    #
+    # @example Methods that get created.
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     embeds_one :name
+    #   end
+    #
+    #   # The following methods get created:
+    #   person.build_name({ :first_name => "Durran" })
+    #   person.create_name({ :first_name => "Durran" })
+    #
+    # @since 2.0.0.rc.1
+    module Builders
+      extend ActiveSupport::Concern
+
+      module ClassMethods #:nodoc:
+
+        # Defines a builder method for an embeds_one relation. This is
+        # defined as #build_name.
+        #
+        # @example
+        #   Person.builder("name")
+        #
+        # @param [ String, Symbol ] name The name of the relation.
+        #
+        # @return [ Class ] The class being set up.
+        #
+        # @since 2.0.0.rc.1
+        def builder(name, metadata)
+          tap do
+            define_method("build_#{name}") do |*args|
+              document = Factory.build(metadata.klass, args.first || {})
+              send("#{name}=", document, :binding => true)
+            end
+          end
+        end
+
+        # Defines a creator method for an embeds_one relation. This is
+        # defined as #create_name. After the object is built it will
+        # immediately save.
+        #
+        # @example
+        #   Person.creator("name")
+        #
+        # @param [ String, Symbol ] name The name of the relation.
+        #
+        # @return [ Class ] The class being set up.
+        #
+        # @since 2.0.0.rc.1
+        def creator(name)
+          tap do
+            define_method("create_#{name}") do |*args|
+              send("build_#{name}", *args).tap(&:save)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations/builders/embedded/in.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Mongoid # :nodoc:
+  module Relations #:nodoc:
+    module Builders #:nodoc:
+      module Embedded #:nodoc:
+        class In < Builder #:nodoc:
+
+          # This builder doesn't actually build anything, just returns the
+          # parent since it should already be instantiated.
+          #
+          # @example Build the document.
+          #   Builder.new(meta, attrs).build
+          #
+          # @param [ String ] type Not used in this context.
+          #
+          # @return [ Document ] A single document.
+          def build(type = nil)
+            return object unless object.is_a?(Hash)
+            Mongoid::Factory.from_db(metadata.klass, object)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations/builders/embedded/many.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Mongoid # :nodoc:
+  module Relations #:nodoc:
+    module Builders #:nodoc:
+      module Embedded #:nodoc:
+        class Many < Builder #:nodoc:
+
+          # Builds the document out of the attributes using the provided
+          # metadata on the relation. Instantiates through the factory in order
+          # to make sure subclasses and allocation are used if fitting. This
+          # case will return many documents.
+          #
+          # @example Build the documents.
+          #   Builder.new(meta, attrs).build
+          #
+          # @param [ String ] type Not used in this context.
+          #
+          # @return [ Array<Document ] The documents.
+          def build(type = nil)
+            return [] if object.blank?
+            return object if object.first.is_a?(Document)
+            object.inject([]) do |documents, attrs|
+              documents.tap do |docs|
+                docs << Mongoid::Factory.from_db(metadata.klass, attrs)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations/builders/embedded/one.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Mongoid # :nodoc:
+  module Relations #:nodoc:
+    module Builders #:nodoc:
+      module Embedded #:nodoc:
+        class One < Builder #:nodoc:
+
+          # Builds the document out of the attributes using the provided
+          # metadata on the relation. Instantiates through the factory in order
+          # to make sure subclasses and allocation are used if fitting.
+          #
+          # @example Build the document.
+          #   Builder.new(meta, attrs).build
+          #
+          # @param [ String ] type Not used in this context.
+          #
+          # @return [ Document ] A single document.
+          def build(type = nil)
+            return object unless object.is_a?(Hash)
+            Mongoid::Factory.from_db(metadata.klass, object)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/relations/builders/nested_attributes/many.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+module Mongoid # :nodoc:
+  module Relations #:nodoc:
+    module Builders #:nodoc:
+      module NestedAttributes #:nodoc:
+        class Many < NestedBuilder
+
+          # Builds the relation depending on the attributes and the options
+          # passed to the macro.
+          #
+          # This attempts to perform 3 operations, either one of an update of
+          # the existing relation, a replacement of the relation with a new
+          # document, or a removal of the relation.
+          #
+          # Example:
+          #
+          # <tt>many.build(person)</tt>
+          #
+          # Options:
+          #
+          # parent: The parent document of the relation.
+          def build(parent)
+            @existing = parent.send(metadata.name)
+            if over_limit?(attributes)
+              raise Errors::TooManyNestedAttributeRecords.new(existing, options[:limit])
+            end
+            attributes.each do |attrs|
+              if attrs.respond_to?(:with_indifferent_access)
+                process(attrs)
+              else
+                process(attrs[1])
+              end
+            end
+          end
+
+          # Create the new builder for nested attributes on one-to-many
+          # relations.
+          #
+          # Example:
+          #
+          # <tt>One.new(metadata, attributes, options)</tt>
+          #
+          # Options:
+          #
+          # metadata: The relation metadata
+          # attributes: The attributes hash to attempt to set.
+          # options: The options defined.
+          #
+          # Returns:
+          #
+          # A new builder.
+          def initialize(metadata, attributes, options = {})
+            if attributes.respond_to?(:with_indifferent_access)
+              @attributes = attributes.with_indifferent_access.sort do |a, b|
+                a[0].to_i <=> b[0].to_i
+              end
+            else
+              @attributes = attributes
+            end
+            @metadata = metadata
+            @options = options
+          end
+
+          private
+
+          # Can the existing relation potentially be deleted?
+          #
+          # Example:
+          #
+          # <tt>destroyable?({ :_destroy => "1" })</tt>
+          #
+          # Options:
+          #
+          # attributes: The attributes to pull the flag from.
+          #
+          # Returns:
+          #
+          # True if the relation can potentially be deleted.
+          def destroyable?(attributes)
+            destroy = attributes.delete(:_destroy)
+            [ 1, "1", true, "true" ].include?(destroy) && allow_destroy?
+          end
+
+          # Are the supplied attributes of greater number than the supplied
+          # limit?
+          #
+          # Example:
+          #
+          # <tt>builder.over_limit?({ "street" => "Bond" })</tt>
+          #
+          # Options:
+          #
+          # attributes: The attributes being set.
+          #
+          # Returns:
+          #
+          # True if a limit supplied and the attributes are of greater number.
+          def over_limit?(attributes)
+            limit = options[:limit]
+            limit ? attributes.size > limit : false
+          end
+
+          # Process each set of attributes one at a time for each potential
+          # new, existing, or ignored document.
+          #
+          # Example:
+          #
+          # <tt>builder.process({ "id" => 1, "street" => "Bond" })
+          #
+          # Options:
+          #
+          # attrs: The single document attributes to process.
+          def process(attrs)
+            return if reject?(attrs)
+            if id = attrs[:id] || attrs["id"] || attrs["_id"]
+              document = existing.find(convert_id(id))
+              destroyable?(attrs) ? document.destroy : document.update_attributes(attrs)
+            else
+              existing.push(metadata.klass.new(attrs)) unless destroyable?(attrs)
+            end
+          end
+        end
+      end
+    end
+  end
+end