datamapper-dm-core 0.9.11 → 0.10.0

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

@@ -1,107 +1,254 @@
 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
+    module ManyToOne #:nodoc:
+      # Relationship class with implementation specific
+      # to n side of 1 to n association
+      class Relationship < Associations::Relationship
+        OPTIONS = superclass::OPTIONS.dup << :nullable
+
+        # TODO: document
+        # @api semipublic
+        alias source_repository_name child_repository_name
+
+        # TODO: document
+        # @api semipublic
+        alias source_model child_model
+
+        # TODO: document
+        # @api semipublic
+        alias target_repository_name parent_repository_name
+
+        # TODO: document
+        # @api semipublic
+        alias target_model parent_model
+
+        # TODO: document
+        # @api semipublic
+        alias target_key parent_key
+
+        # TODO: document
+        # @api semipublic
+        def nullable?
+          @nullable
+        end
 
-          def #{name}=(parent)
-            #{name}_association.replace(parent)
-          end
+        # Returns a set of keys that identify child model
+        #
+        # @return   [DataMapper::PropertySet]  a set of properties that identify child model
+        # @api private
+        def child_key
+          return @child_key if defined?(@child_key)
+
+          repository_name = child_repository_name || parent_repository_name
+          properties      = child_model.properties(repository_name)
 
-          private
+          child_key = parent_key.zip(@child_properties || []).map do |parent_property, property_name|
+            property_name ||= "#{name}_#{parent_property.name}".to_sym
 
-          def #{name}_association
-            @#{name}_association ||= begin
-              unless relationship = model.relationships(#{repository_name.inspect})[:#{name}]
-                raise ArgumentError, "Relationship #{name.inspect} does not exist in \#{model}"
+            properties[property_name] || begin
+              # create the property within the correct repository
+              DataMapper.repository(repository_name) do
+                type = parent_property.send(parent_property.type == DataMapper::Types::Boolean ? :type : :primitive)
+                child_model.property(property_name, type, child_key_options(parent_property))
               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) }
+          @child_key = properties.class.new(child_key).freeze
+        end
 
-        def replace(parent)
-          @parent = parent
-          @relationship.attach_parent(@child, @parent)
-          self
+        # TODO: document
+        # @api semipublic
+        alias source_key child_key
+
+        # Returns a Resoruce for this relationship with a given source
+        #
+        # @param [Resource] source
+        #   A Resource to scope the collection with
+        # @param [Query] other_query (optional)
+        #   A Query to further scope the collection with
+        #
+        # @return [Resource]
+        #   The resource scoped to the relationship, source and query
+        #
+        # @api private
+        def resource_for(source, other_query = nil)
+          query = query_for(source, other_query)
+
+          # TODO: lookup the resource in the Identity Map, and make sure
+          # it matches the query criteria, otherwise perform the query
+
+          target_model.first(query)
         end
 
-        def save
-          return false if @parent.nil?
-          return true  unless parent.new_record?
+        # Loads and returns association target (ex.: author) for given source resource
+        # (ex.: article)
+        #
+        # @param  source  [DataMapper::Resource]
+        #   Child object (ex.: instance of article)
+        # @param  other_query  [DataMapper::Query]
+        #   Query options
+        #
+        # @api semipublic
+        def get(source, other_query = nil)
+          assert_kind_of 'source', source, source_model
+
+          lazy_load(source) unless loaded?(source)
+
+          resource = get!(source)
+          if other_query.nil? || query_for(source, other_query).conditions.matches?(resource)
+            resource
+          end
+        end
 
-          @relationship.with_repository(parent) do
-            result = parent.save
-            @relationship.child_key.set(@child, @relationship.parent_key.get(parent)) if result
-            result
+        # Sets value of association target (ex.: author) for given source resource
+        # (ex.: article)
+        #
+        # @param source [DataMapper::Resource]
+        #   Child object (ex.: instance of article)
+        #
+        # @param source [DataMapper::Resource]
+        #   Parent object (ex.: instance of author)
+        #
+        # @api semipublic
+        def set(source, target)
+          assert_kind_of 'source', source, source_model
+          assert_kind_of 'target', target, target_model, Hash, NilClass
+
+          if target.kind_of?(Hash)
+            target = target_model.new(target)
           end
+
+          source_key.set(source, target.nil? ? [] : target_key.get(target))
+          set!(source, target)
         end
 
-        def reload
-          @parent = nil
-          self
+        # TODO: document
+        # @api private
+        def inherited_by(model)
+          model.relationships(source_repository_name)[name] ||
+            self.class.new(name, model, parent_model_name, options_with_inverse)
+        end
+
+        private
+
+        # Initializes the relationship, always using max cardinality of 1.
+        #
+        # @api semipublic
+        def initialize(name, source_model, target_model, options = {})
+          @nullable      = options.fetch(:nullable, false)
+          target_model ||= Extlib::Inflection.camelize(name)
+          options        = { :min => @nullable ? 0 : 1, :max => 1 }.update(options)
+          super
         end
 
-        def kind_of?(klass)
-          super || parent.kind_of?(klass)
+        # Dynamically defines reader method for source side of association
+        # (for instance, method article for model Paragraph)
+        #
+        # @api semipublic
+        def create_reader
+          return if source_model.resource_method_defined?(name.to_s)
+
+          source_model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            public  # TODO: make this configurable
+
+            # FIXME: if the writer is used, caching nil in the ivar
+            # and then the FK(s) are set, the cache in the writer should
+            # be cleared.
+
+            def #{name}(query = nil)                          # def article(query = nil)
+              relationships[#{name.inspect}].get(self, query) #   relationships["article"].get(self, query)
+            end                                               # end
+          RUBY
         end
 
-        def respond_to?(method, include_private = false)
-          super || parent.respond_to?(method, include_private)
+        # Dynamically defines writer method for source side of association
+        # (for instance, method article= for model Paragraph)
+        #
+        # @api semipublic
+        def create_writer
+          writer_name = "#{name}="
+
+          return if source_model.resource_method_defined?(writer_name)
+
+          source_model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            public  # TODO: make this configurable
+            def #{writer_name}(target)                         # def article=(target)
+              relationships[#{name.inspect}].set(self, target) #   relationships["article"].set(self, target)
+            end                                                # end
+          RUBY
         end
 
-        def instance_variable_get(variable)
-          super || parent.instance_variable_get(variable)
+        # Loads association target and sets resulting value on
+        # given source resource
+        #
+        # @param [Resource] source
+        #   the source resource for the association
+        #
+        # @return [undefined]
+        #
+        # @api private
+        def lazy_load(source)
+          return unless source_key.get(source).all?
+
+          # SEL: load all related resources in the source collection
+          if source.saved? && source.collection.size > 1
+            eager_load(source.collection)
+          end
+
+          unless loaded?(source)
+            set!(source, resource_for(source))
+          end
         end
 
-        private
+        # Sets the association targets in the resource
+        #
+        # @param [Resource] source
+        #   the source to set
+        # @param [Array(Resource)] targets
+        #   the target resource for the association
+        # @param [Query, Hash] query
+        #   not used
+        #
+        # @return [undefined]
+        #
+        # @api private
+        def eager_load_targets(source, targets, query)
+          set(source, targets.first)
+        end
 
-        def initialize(relationship, child)
-          assert_kind_of 'relationship', relationship, Relationship
-          assert_kind_of 'child',        child,        Resource
+        # Returns the inverse relationship class
+        #
+        # @api private
+        def inverse_class
+          OneToMany::Relationship
+        end
 
-          @relationship = relationship
-          @child        = child
+        # Returns the inverse relationship name
+        #
+        # @api private
+        def inverse_name
+          super || Extlib::Inflection.underscore(Extlib::Inflection.demodulize(source_model.name)).pluralize.to_sym
         end
 
-        def parent
-          @parent ||= @relationship.get_parent(@child)
+        # TODO: document
+        # @api private
+        def child_key_options(parent_property)
+          options = parent_property.options.only(:length, :precision, :scale).update(:index => name, :nullable => nullable?)
+
+          if parent_property.primitive == Integer && parent_property.min && parent_property.max
+            options.update(:min => parent_property.min, :max => parent_property.max)
+          end
+
+          options
         end
 
-        def method_missing(method, *args, &block)
-          parent.__send__(method, *args, &block)
+        # TODO: document
+        # @api private
+        def child_properties
+          child_key.map { |property| property.name }
         end
-      end # class Proxy
+      end # class Relationship
     end # module ManyToOne
   end # module Associations
 end # module DataMapper