datamapper-dm-core 0.9.11

data/lib/dm-core/associations.rb

@@ -0,0 +1,207 @@
+dir = Pathname(__FILE__).dirname.expand_path / 'associations'
+
+require dir / 'relationship'
+require dir / 'relationship_chain'
+require dir / 'many_to_many'
+require dir / 'many_to_one'
+require dir / 'one_to_many'
+require dir / 'one_to_one'
+
+module DataMapper
+  module Associations
+    include Assertions
+
+    class ImmutableAssociationError < RuntimeError
+    end
+
+    class UnsavedParentError < RuntimeError
+    end
+
+    # Returns all relationships that are many-to-one for this model.
+    #
+    # Used to find the relationships that require properties in any Repository.
+    #
+    # Example:
+    # class Plur
+    #   include DataMapper::Resource
+    #   def self.default_repository_name
+    #     :plur_db
+    #   end
+    #   repository(:plupp_db) do
+    #     has 1, :plupp
+    #   end
+    # end
+    #
+    # This resource has a many-to-one to the Plupp resource residing in the :plupp_db repository,
+    # but the Plur resource needs the plupp_id property no matter what repository itself lives in,
+    # ie we need to create that property when we migrate etc.
+    #
+    # Used in DataMapper::Model.properties_with_subclasses
+    #
+    # @api private
+    def many_to_one_relationships
+      relationships unless @relationships # needs to be initialized!
+      @relationships.values.collect do |rels| rels.values end.flatten.select do |relationship| relationship.child_model == self end
+    end
+
+    def relationships(repository_name = default_repository_name)
+      @relationships ||= {}
+      @relationships[repository_name] ||= repository_name == Repository.default_name ? {} : relationships(Repository.default_name).dup
+    end
+
+    def n
+      1.0/0
+    end
+
+    ##
+    # A shorthand, clear syntax for defining one-to-one, one-to-many and
+    # many-to-many resource relationships.
+    #
+    # @example [Usage]
+    #   * has 1, :friend                          # one friend
+    #   * has n, :friends                         # many friends
+    #   * has 1..3, :friends
+    #                         # many friends (at least 1, at most 3)
+    #   * has 3, :friends
+    #                         # many friends (exactly 3)
+    #   * has 1, :friend, :class_name => 'User'
+    #                         # one friend with the class name User
+    #   * has 3, :friends, :through => :friendships
+    #                         # many friends through the friendships relationship
+    #   * has n, :friendships => :friends
+    #                         # identical to above example
+    #
+    # @param cardinality [Integer, Range, Infinity]
+    #   cardinality that defines the association type and constraints
+    # @param name <Symbol>  the name that the association will be referenced by
+    # @param opts <Hash>    an options hash
+    #
+    # @option :through[Symbol]  A association that this join should go through to form
+    #       a many-to-many association
+    # @option :class_name[String] The name of the class to associate with, if omitted
+    #       then the association name is assumed to match the class name
+    # @option :remote_name[Symbol] In the case of a :through option being present, the
+    #       name of the relationship on the other end of the :through-relationship
+    #       to be linked to this relationship.
+    #
+    # @return [DataMapper::Association::Relationship] the relationship that was
+    #   created to reflect either a one-to-one, one-to-many or many-to-many
+    #   relationship
+    # @raise [ArgumentError] if the cardinality was not understood. Should be a
+    #   Integer, Range or Infinity(n)
+    #
+    # @api public
+    def has(cardinality, name, options = {})
+
+      # NOTE: the reason for this fix is that with the ability to pass in two
+      # hashes into has() there might be instances where people attempt to
+      # pass in the options into the name part and not know why things aren't
+      # working for them.
+      if name.kind_of?(Hash)
+        name_through, through = name.keys.first, name.values.first
+        cardinality_string = cardinality.to_s == 'Infinity' ? 'n' : cardinality.inspect
+        warn("In #{self.name} 'has #{cardinality_string}, #{name_through.inspect} => #{through.inspect}' is deprecated. Use 'has #{cardinality_string}, #{name_through.inspect}, :through => #{through.inspect}' instead")
+      end
+
+      options = options.merge(extract_min_max(cardinality))
+      options = options.merge(extract_throughness(name))
+
+      # do not remove this. There is alot of confusion on people's
+      # part about what the first argument to has() is.  For the record it
+      # is the min cardinality and max cardinality of the association.
+      # simply put, it constraints the number of resources that will be
+      # returned by the association.  It is not, as has been assumed,
+      # the number of results on the left and right hand side of the
+      # reltionship.
+      if options[:min] == n && options[:max] == n
+        raise ArgumentError, 'Cardinality may not be n..n.  The cardinality specifies the min/max number of results from the association', caller
+      end
+
+      klass = options[:max] == 1 ? OneToOne : OneToMany
+      klass = ManyToMany if options[:through] == DataMapper::Resource
+      relationship = klass.setup(options.delete(:name), self, options)
+
+      # Please leave this in - I will release contextual serialization soon
+      # which requires this -- guyvdb
+      # TODO convert this to a hook in the plugin once hooks work on class
+      # methods
+      self.init_has_relationship_for_serialization(relationship) if self.respond_to?(:init_has_relationship_for_serialization)
+
+      relationship
+    end
+
+    ##
+    # A shorthand, clear syntax for defining many-to-one resource relationships.
+    #
+    # @example [Usage]
+    #   * belongs_to :user                          # many_to_one, :friend
+    #   * belongs_to :friend, :class_name => 'User'  # many_to_one :friends
+    #
+    # @param name [Symbol] The name that the association will be referenced by
+    # @see #has
+    #
+    # @return [DataMapper::Association::ManyToOne] The association created
+    #   should not be accessed directly
+    #
+    # @api public
+    def belongs_to(name, options={})
+      @_valid_relations = false
+
+      if options.key?(:class_name) && !options.key?(:child_key)
+        warn "The inferred child_key will changing to be prefixed with the relationship name #{name}. " \
+          "When using :class_name in belongs_to specify the :child_key explicitly to avoid problems." \
+          "#{caller(0)[1]}"
+      end
+
+      relationship = ManyToOne.setup(name, self, options)
+      # Please leave this in - I will release contextual serialization soon
+      # which requires this -- guyvdb
+      # TODO convert this to a hook in the plugin once hooks work on class
+      # methods
+      self.init_belongs_relationship_for_serialization(relationship) if self.respond_to?(:init_belongs_relationship_for_serialization)
+
+      relationship
+    end
+
+    private
+
+    def extract_throughness(name)
+      assert_kind_of 'name', name, Hash, Symbol
+
+      case name
+        when Hash
+          unless name.keys.size == 1
+            raise ArgumentError, "name must have only one key, but had #{name.keys.size}", caller(2)
+          end
+
+          { :name => name.keys.first, :through => name.values.first }
+        when Symbol
+          { :name => name }
+      end
+    end
+
+    # A support method form converting Integer, Range or Infinity values into a
+    # { :min => x, :max => y } hash.
+    #
+    # @api private
+    def extract_min_max(constraints)
+      assert_kind_of 'constraints', constraints, Integer, Range unless constraints == n
+
+      case constraints
+        when Integer
+          { :min => constraints, :max => constraints }
+        when Range
+          if constraints.first > constraints.last
+            raise ArgumentError, "Constraint min (#{constraints.first}) cannot be larger than the max (#{constraints.last})"
+          end
+
+          { :min => constraints.first, :max => constraints.last }
+        when n
+          { :min => 0, :max => n }
+      end
+    end
+  end # module Associations
+
+  Model.append_extensions DataMapper::Associations
+
+end # module DataMapper

data/lib/dm-core/associations/many_to_many.rb

@@ -0,0 +1,147 @@
+require File.join(File.dirname(__FILE__), "one_to_many")
+module DataMapper
+  module Associations
+    module ManyToMany
+      extend Assertions
+
+      # Setup many to many relationship between two models
+      # -
+      # @api private
+      def self.setup(name, model, options = {})
+        assert_kind_of 'name',    name,    Symbol
+        assert_kind_of 'model',   model,   Model
+        assert_kind_of 'options', options, Hash
+
+        repository_name = model.repository.name
+
+        model.class_eval <<-EOS, __FILE__, __LINE__
+          def #{name}(query = {})
+            #{name}_association.all(query)
+          end
+
+          def #{name}=(children)
+            #{name}_association.replace(children)
+          end
+
+          private
+
+          def #{name}_association
+            @#{name}_association ||= begin
+              unless relationship = model.relationships(#{repository_name.inspect})[#{name.inspect}]
+                raise ArgumentError, "Relationship #{name.inspect} does not exist in \#{model}"
+              end
+              association = Proxy.new(relationship, self)
+              parent_associations << association
+              association
+            end
+          end
+        EOS
+
+        opts = options.dup
+        opts.delete(:through)
+        opts[:child_model]              ||= opts.delete(:class_name)  || Extlib::Inflection.classify(name)
+        opts[:parent_model]             =   model
+        opts[:repository_name]          =   repository_name
+        opts[:remote_relationship_name] ||= opts.delete(:remote_name) || Extlib::Inflection.tableize(opts[:child_model])
+        opts[:parent_key]               =   opts[:parent_key]
+        opts[:child_key]                =   opts[:child_key]
+        opts[:mutable]                  =   true
+
+        names        = [ opts[:child_model], opts[:parent_model].name ].sort
+        model_name   = names.join.gsub("::", "")
+        storage_name = Extlib::Inflection.tableize(Extlib::Inflection.pluralize(names[0]) + names[1])
+
+        opts[:near_relationship_name] = Extlib::Inflection.tableize(model_name).to_sym
+
+        model.has(model.n, opts[:near_relationship_name])
+
+        relationship = model.relationships(repository_name)[name] = RelationshipChain.new(opts)
+
+        unless Object.const_defined?(model_name)
+          model = DataMapper::Model.new(storage_name)
+
+          model.class_eval <<-EOS, __FILE__, __LINE__
+            def self.name; #{model_name.inspect} end
+            def self.default_repository_name; #{repository_name.inspect} end
+            def self.many_to_many; true end
+          EOS
+
+          names.each do |n|
+            model.belongs_to(Extlib::Inflection.underscore(n).gsub('/', '_').to_sym)
+          end
+
+          Object.const_set(model_name, model)
+        end
+
+        relationship
+      end
+
+      class Proxy < DataMapper::Associations::OneToMany::Proxy
+        def delete(resource)
+          through = near_association.get(*(@parent.key + resource.key))
+          near_association.delete(through)
+          orphan_resource(super)
+        end
+
+        def clear
+          near_association.clear
+          super
+        end
+
+        def destroy
+          near_association.destroy
+          super
+        end
+
+        def save
+        end
+
+        private
+
+        def new_child(attributes)
+          remote_relationship.parent_model.new(attributes)
+        end
+
+        def relate_resource(resource)
+          assert_mutable
+          add_default_association_values(resource)
+          @orphans.delete(resource)
+
+          # TODO: fix this so it does not automatically save on append, if possible
+          resource.save if resource.new_record?
+          through_resource = @relationship.child_model.new
+          @relationship.child_key.zip(@relationship.parent_key) do |child_key,parent_key|
+            through_resource.send("#{child_key.name}=", parent_key.get(@parent))
+          end
+          remote_relationship.child_key.zip(remote_relationship.parent_key) do |child_key,parent_key|
+            through_resource.send("#{child_key.name}=", parent_key.get(resource))
+          end
+          near_association << through_resource
+
+          resource
+        end
+
+        def orphan_resource(resource)
+          assert_mutable
+          @orphans << resource
+          resource
+        end
+
+        def assert_mutable
+        end
+
+        def remote_relationship
+          @remote_relationship ||= @relationship.send(:remote_relationship)
+        end
+
+        def near_association
+          @near_association ||= @parent.send(near_relationship_name)
+        end
+
+        def near_relationship_name
+          @near_relationship_name ||= @relationship.send(:instance_variable_get, :@near_relationship_name)
+        end
+      end # class Proxy
+    end # module ManyToMany
+  end # module Associations
+end # module DataMapper

data/lib/dm-core/associations/many_to_one.rb

@@ -0,0 +1,107 @@
+module DataMapper
+  module Associations
+    module ManyToOne
+      extend Assertions
+
+      # Setup many to one relationship between two models
+      # -
+      # @api private
+      def self.setup(name, model, options = {})
+        assert_kind_of 'name',    name,    Symbol
+        assert_kind_of 'model',   model,   Model
+        assert_kind_of 'options', options, Hash
+
+        repository_name = model.repository.name
+
+        model.class_eval <<-EOS, __FILE__, __LINE__
+          def #{name}
+            #{name}_association.nil? ? nil : #{name}_association
+          end
+
+          def #{name}=(parent)
+            #{name}_association.replace(parent)
+          end
+
+          private
+
+          def #{name}_association
+            @#{name}_association ||= begin
+              unless relationship = model.relationships(#{repository_name.inspect})[:#{name}]
+                raise ArgumentError, "Relationship #{name.inspect} does not exist in \#{model}"
+              end
+              association = Proxy.new(relationship, self)
+              child_associations << association
+              association
+            end
+          end
+        EOS
+
+        model.relationships(repository_name)[name] = Relationship.new(
+          name,
+          repository_name,
+          model,
+          options.fetch(:class_name, Extlib::Inflection.classify(name)),
+          options
+        )
+      end
+
+      class Proxy
+        include Assertions
+
+        instance_methods.each { |m| undef_method m unless %w[ __id__ __send__ object_id kind_of? respond_to? assert_kind_of should should_not instance_variable_set instance_variable_get ].include?(m.to_s) }
+
+        def replace(parent)
+          @parent = parent
+          @relationship.attach_parent(@child, @parent)
+          self
+        end
+
+        def save
+          return false if @parent.nil?
+          return true  unless parent.new_record?
+
+          @relationship.with_repository(parent) do
+            result = parent.save
+            @relationship.child_key.set(@child, @relationship.parent_key.get(parent)) if result
+            result
+          end
+        end
+
+        def reload
+          @parent = nil
+          self
+        end
+
+        def kind_of?(klass)
+          super || parent.kind_of?(klass)
+        end
+
+        def respond_to?(method, include_private = false)
+          super || parent.respond_to?(method, include_private)
+        end
+
+        def instance_variable_get(variable)
+          super || parent.instance_variable_get(variable)
+        end
+
+        private
+
+        def initialize(relationship, child)
+          assert_kind_of 'relationship', relationship, Relationship
+          assert_kind_of 'child',        child,        Resource
+
+          @relationship = relationship
+          @child        = child
+        end
+
+        def parent
+          @parent ||= @relationship.get_parent(@child)
+        end
+
+        def method_missing(method, *args, &block)
+          parent.__send__(method, *args, &block)
+        end
+      end # class Proxy
+    end # module ManyToOne
+  end # module Associations
+end # module DataMapper