dm-core 0.9.11 → 0.10.0

data/lib/dm-core/model/descendant_set.rb

@@ -0,0 +1,81 @@
+module DataMapper
+  module Model
+    class DescendantSet
+      include Enumerable
+
+      # Append a model as a descendant
+      #
+      # @param [Model] model
+      #   the descendant model
+      #
+      # @return [DescendantSet]
+      #   self
+      #
+      # @api private
+      def <<(model)
+        @descendants << model unless @descendants.include?(model)
+        @ancestors   << model if @ancestors
+        self
+      end
+
+      # Iterate over each descendant
+      #
+      # @yield [model]
+      #   iterate over each descendant
+      # @yieldparam [Model] model
+      #   the descendant model
+      #
+      # @return [DescendantSet]
+      #   self
+      #
+      # @api private
+      def each
+        @descendants.each { |model| yield model }
+        self
+      end
+
+      # Remove a descendant
+      #
+      # Also removed the descendant from the ancestors.
+      #
+      # @param [Model] model
+      #   the model to remove
+      #
+      # @return [Model, NilClass]
+      #   the model is return if it is a descendant
+      #
+      # @api private
+      def delete(model)
+        @ancestors.delete(model) if @ancestors
+        @descendants.delete(model)
+      end
+
+      # Return an Array representation of descendants
+      #
+      # @return [Array]
+      #   the descendants
+      #
+      # @api private
+      def to_ary
+        @descendants.dup
+      end
+
+      private
+
+      # Initialize a DescendantSet instance
+      #
+      # @param [Model] model
+      #   the base model
+      # @param [DescendantSet] ancestors
+      #   the ancestors to notify when a descendant is added
+      #
+      # @api private
+      def initialize(model = nil, ancestors = nil)
+        @descendants = []
+        @ancestors   = ancestors
+
+        @descendants << model if model
+      end
+    end
+  end
+end

data/lib/dm-core/model/hook.rb

@@ -0,0 +1,45 @@
+module DataMapper
+  module Model
+    module Hook
+      Model.append_inclusions self
+
+      def self.included(model)
+        model.send(:include, Extlib::Hook)
+        model.extend Methods
+        model.register_instance_hooks :create_hook, :update_hook, :destroy
+      end
+
+      module Methods
+        # TODO: document
+        # @api public
+        def before(target_method, *args, &block)
+          remap_target_method(target_method).each do |target_method|
+            super(target_method, *args, &block)
+          end
+        end
+
+        # TODO: document
+        # @api public
+        def after(target_method, *args, &block)
+          remap_target_method(target_method).each do |target_method|
+            super(target_method, *args, &block)
+          end
+        end
+
+        private
+
+        # TODO: document
+        # @api private
+        def remap_target_method(target_method)
+          case target_method
+            when :create then [ :create_hook               ]
+            when :update then [ :update_hook               ]
+            when :save   then [ :create_hook, :update_hook ]
+            else              [ target_method              ]
+          end
+        end
+      end
+
+    end # module Hook
+  end # module Model
+end # module DataMapper

data/lib/dm-core/model/is.rb

@@ -0,0 +1,32 @@
+module DataMapper
+  module Model
+    # Module that provides a common way for plugin authors
+    # to implement "is ... " traits (object behaviors that can be shared)
+    module Is
+      # A common interface to activate plugins for a resource. For instance:
+      #
+      # class Widget
+      #   include DataMapper::Resource
+      #
+      #   is :list
+      # end
+      #
+      # adds list item behavior to the model. Plugin that wants to conform
+      # to "is API" of DataMapper must supply is_+behavior name+ method,
+      # for example above it would be is_list.
+      #
+      # @api public
+      def is(plugin, *args, &block)
+        generator_method = "is_#{plugin}".to_sym
+
+        if respond_to?(generator_method)
+          send(generator_method, *args, &block)
+        else
+          raise PluginNotFoundError, "could not find plugin named #{plugin}"
+        end
+      end
+    end # module Is
+
+    include Is
+  end # module Model
+end # module DataMapper

data/lib/dm-core/model/property.rb

@@ -0,0 +1,247 @@
+# TODO: move paranoid property concerns to a ParanoidModel that is mixed
+# into Model when a Paranoid property is used
+
+# TODO: update Model#respond_to? to return true if method_method missing
+# would handle the message
+
+module DataMapper
+  module Model
+    module Property
+      Model.append_extensions self
+
+      extend Chainable
+
+      def self.extended(model)
+        model.instance_variable_set(:@properties,               {})
+        model.instance_variable_set(:@field_naming_conventions, {})
+        model.instance_variable_set(:@paranoid_properties,      {})
+      end
+
+      chainable do
+        def inherited(model)
+          model.instance_variable_set(:@properties,               {})
+          model.instance_variable_set(:@field_naming_conventions, @field_naming_conventions.dup)
+          model.instance_variable_set(:@paranoid_properties,      @paranoid_properties.dup)
+
+          @properties.each do |repository_name, properties|
+            properties.each do |property|
+              model.properties(repository_name) << property
+            end
+          end
+
+          super
+        end
+      end
+
+      # Defines a Property on the Resource
+      #
+      # @param [Symbol] name
+      #   the name for which to call this property
+      # @param [Type] type
+      #   the type to define this property ass
+      # @param [Hash(Symbol => String)] options
+      #   a hash of available options
+      #
+      # @return [Property]
+      #   the created Property
+      #
+      # @see Property
+      #
+      # @api public
+      def property(name, type, options = {})
+        property = DataMapper::Property.new(self, name, type, options)
+
+        properties(repository_name) << property
+
+        # Add property to the other mappings as well if this is for the default
+        # repository.
+        if repository_name == default_repository_name
+          @properties.except(repository_name).each do |repository_name, properties|
+            next if properties.named?(name)
+
+            # make sure the property is created within the correct repository scope
+            DataMapper.repository(repository_name) do
+              properties << DataMapper::Property.new(self, name, type, options)
+            end
+          end
+        end
+
+        # Add the property to the lazy_loads set for this resources repository
+        # only.
+        # TODO Is this right or should we add the lazy contexts to all
+        # repositories?
+        if property.lazy?
+          context = options.fetch(:lazy, :default)
+          context = :default if context == true
+
+          Array(context).each do |item|
+            properties(repository_name).lazy_context(item) << name
+          end
+        end
+
+        # add the property to the child classes only if the property was
+        # added after the child classes' properties have been copied from
+        # the parent
+        descendants.each do |descendant|
+          next if descendant.properties(repository_name).named?(name)
+          descendant.property(name, type, options)
+        end
+
+        create_reader_for(property)
+        create_writer_for(property)
+
+        property
+      end
+
+      # Gets a list of all properties that have been defined on this Model in
+      # the requested repository
+      #
+      # @param [Symbol, String] repository_name
+      #   The name of the repository to use. Uses the default Repository
+      #   if none is specified.
+      #
+      # @return [Array]
+      #   A list of Properties defined on this Model in the given Repository
+      #
+      # @api public
+      def properties(repository_name = default_repository_name)
+        # TODO: create PropertySet#copy that will copy the properties, but assign the
+        # new Relationship objects to a supplied repository and model.  dup does not really
+        # do what is needed
+
+        @properties[repository_name] ||= if repository_name == default_repository_name
+          PropertySet.new
+        else
+          properties(default_repository_name).dup
+        end
+      end
+
+      # Gets the list of key fields for this Model in +repository_name+
+      #
+      # @param [String] repository_name
+      #   The name of the Repository for which the key is to be reported
+      #
+      # @return [Array]
+      #   The list of key fields for this Model in +repository_name+
+      #
+      # @api public
+      def key(repository_name = default_repository_name)
+        properties(repository_name).key
+      end
+
+      # TODO: document
+      # @api public
+      def serial(repository_name = default_repository_name)
+        key(repository_name).detect { |property| property.serial? }
+      end
+
+      # Gets the field naming conventions for this resource in the given Repository
+      #
+      # @param [String, Symbol] repository_name
+      #   the name of the Repository for which the field naming convention
+      #   will be retrieved
+      #
+      # @return [#call]
+      #   The naming convention for the given Repository
+      #
+      # @api public
+      def field_naming_convention(repository_name = default_storage_name)
+        @field_naming_conventions[repository_name] ||= repository(repository_name).adapter.field_naming_convention
+      end
+
+      # TODO: document
+      # @api private
+      def properties_with_subclasses(repository_name = default_repository_name)
+        properties = PropertySet.new
+
+        descendants.each do |model|
+          model.properties(repository_name).each do |property|
+            properties << property unless properties.named?(property.name)
+          end
+        end
+
+        properties
+      end
+
+      # TODO: document
+      # @api private
+      def paranoid_properties
+        @paranoid_properties
+      end
+
+      # TODO: document
+      # @api private
+      def set_paranoid_property(name, &block)
+        paranoid_properties[name] = block
+      end
+
+      # TODO: document
+      # @api private
+      def key_conditions(repository, key)
+        self.key(repository.name).zip(key).to_hash
+      end
+
+      private
+
+      # defines the reader method for the property
+      #
+      # @api private
+      def create_reader_for(property)
+        name                   = property.name.to_s
+        reader_visibility      = property.reader_visibility
+        instance_variable_name = property.instance_variable_name
+        primitive              = property.primitive
+
+        unless resource_method_defined?(name)
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            #{reader_visibility}
+            def #{name}
+              return #{instance_variable_name} if defined?(#{instance_variable_name})
+              #{instance_variable_name} = properties[#{name.inspect}].get(self)
+            end
+          RUBY
+        end
+
+        boolean_reader_name = "#{name}?"
+
+        if primitive == TrueClass && !resource_method_defined?(boolean_reader_name)
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            #{reader_visibility}
+            alias #{boolean_reader_name} #{name}
+          RUBY
+        end
+      end
+
+      # defines the setter for the property
+      #
+      # @api private
+      def create_writer_for(property)
+        name              = property.name
+        writer_visibility = property.writer_visibility
+
+        writer_name = "#{name}="
+
+        return if resource_method_defined?(writer_name)
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          #{writer_visibility}
+          def #{writer_name}(value)
+            properties[#{name.inspect}].set(self, value)
+          end
+        RUBY
+      end
+
+      chainable do
+        # TODO: document
+        # @api public
+        def method_missing(method, *args, &block)
+          if property = properties(repository_name)[method]
+            return property
+          end
+
+          super
+        end
+      end
+    end # module Property
+  end # module Model
+end # module DataMapper

data/lib/dm-core/model/relationship.rb

@@ -0,0 +1,335 @@
+# TODO: update Model#respond_to? to return true if method_method missing
+# would handle the message
+
+module DataMapper
+  module Model
+    module Relationship
+      Model.append_extensions self
+
+      include Extlib::Assertions
+      extend Chainable
+
+      # Initializes relationships hash for extended model
+      # class.
+      #
+      # When model calls has n, has 1 or belongs_to, relationships
+      # are stored in that hash: keys are repository names and
+      # values are relationship sets.
+      #
+      # @api private
+      def self.extended(model)
+        model.instance_variable_set(:@relationships, {})
+      end
+
+      chainable do
+        # When DataMapper model is inherited, relationships
+        # of parent are duplicated and copied to subclass model
+        #
+        # @api private
+        def inherited(model)
+          # TODO: Create a RelationshipSet class, and then add a method that allows copying the relationships to the supplied repository and model
+          model.instance_variable_set(:@relationships, duped_relationships = {})
+
+          @relationships.each do |repository_name, relationships|
+            dup = duped_relationships[repository_name] ||= Mash.new
+
+            relationships.each do |name, relationship|
+              dup[name] = relationship.inherited_by(model)
+            end
+          end
+
+          super
+        end
+      end
+
+      # Returns copy of relationships set in given repository.
+      #
+      # @param [Symbol] repository_name
+      #   Name of the repository for which relationships set is returned
+      # @return [Mash]  relationships set for given repository
+      #
+      # @api semipublic
+      def relationships(repository_name = default_repository_name)
+        # TODO: create RelationshipSet#copy that will copy the relationships, but assign the
+        # new Relationship objects to a supplied repository and model.  dup does not really
+        # do what is needed
+
+        @relationships[repository_name] ||= if repository_name == default_repository_name
+          Mash.new
+        else
+          relationships(default_repository_name).dup
+        end
+      end
+
+      # Used to express unlimited cardinality of association,
+      # see +has+
+      #
+      # @api public
+      def n
+        1.0/0
+      end
+
+      # A shorthand, clear syntax for defining one-to-one, one-to-many and
+      # many-to-many resource relationships.
+      #
+      #  * 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,  'User'                    # one friend with the class User
+      #  * has 3,    :friends, :through => :friendships  # many friends through the friendships relationship
+      #
+      # @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 model [Model, #to_str]
+      #   the target model of the relationship
+      # @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 :model[Model, String] The name of the class to associate with, if omitted
+      #   then the association name is assumed to match the class name
+      # @option :repository[Symbol]
+      #   name of child model repository
+      #
+      # @return [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, *args)
+        assert_kind_of 'cardinality', cardinality, Integer, Range, n.class
+        assert_kind_of 'name',        name,        Symbol
+
+        model   = extract_model(args)
+        options = extract_options(args)
+
+        min, max = extract_min_max(cardinality)
+        options.update(:min => min, :max => max)
+
+        assert_valid_options(options)
+
+        if options.key?(:model) && model
+          raise ArgumentError, 'should not specify options[:model] if passing the model in the third argument'
+        end
+
+        model ||= options.delete(:model)
+
+        # TODO: change to :target_respository_name and :source_repository_name
+        options[:child_repository_name]  = options.delete(:repository)
+        options[:parent_repository_name] = repository.name
+
+        klass = if options[:max] > 1
+          options.key?(:through) ? Associations::ManyToMany::Relationship : Associations::OneToMany::Relationship
+        else
+          Associations::OneToOne::Relationship
+        end
+
+        relationship = relationships(repository.name)[name] = klass.new(name, model, self, options)
+
+        descendants.each do |descendant|
+          descendant.relationships(repository.name)[name] ||= relationship.inherited_by(descendant)
+        end
+
+        relationship
+      end
+
+      # A shorthand, clear syntax for defining many-to-one resource relationships.
+      #
+      #  * belongs_to :user                              # many to one user
+      #  * belongs_to :friend, :model => 'User'          # many to one friend
+      #  * belongs_to :reference, :repository => :pubmed # association for repository other than default
+      #
+      # @param name [Symbol]
+      #   the name that the association will be referenced by
+      # @param model [Model, #to_str]
+      #   the target model of the relationship
+      # @param opts [Hash]
+      #   an options hash
+      #
+      # @option :model[Model, String] The name of the class to associate with, if omitted
+      #   then the association name is assumed to match the class name
+      # @option :repository[Symbol]
+      #   name of child model repository
+      #
+      # @return [Association::Relationship] The association created
+      #   should not be accessed directly
+      #
+      # @api public
+      def belongs_to(name, *args)
+        assert_kind_of 'name', name, Symbol
+
+        model   = extract_model(args)
+        options = extract_options(args)
+
+        if options.key?(:through)
+          warn "#{self.name}#belongs_to with :through is deprecated, use 'has 1, :#{name}, #{options.inspect}' in #{self.name} instead (#{caller[0]})"
+          return has(1, name, model, options)
+        end
+
+        assert_valid_options(options)
+
+        if options.key?(:model) && model
+          raise ArgumentError, 'should not specify options[:model] if passing the model in the third argument'
+        end
+
+        model ||= options.delete(:model)
+
+        repository_name = repository.name
+
+        # TODO: change to source_repository_name and target_respository_name
+        options[:child_repository_name]  = repository_name
+        options[:parent_repository_name] = options.delete(:repository)
+
+        relationship = relationships(repository.name)[name] = Associations::ManyToOne::Relationship.new(name, self, model, options)
+
+        descendants.each do |descendant|
+          descendant.relationships(repository.name)[name] ||= relationship.inherited_by(descendant)
+        end
+
+        relationship
+      end
+
+      private
+
+      # Extract the model from an Array of arguments
+      #
+      # @param [Array(Model, String, Hash)]
+      #   The arguments passed to an relationship declaration
+      #
+      # @return [Model, #to_str]
+      #   target model for the association
+      #
+      # @api private
+      def extract_model(args)
+        model = args.first
+
+        if model.kind_of?(Model)
+          model
+        elsif model.respond_to?(:to_str)
+          model.to_str
+        else
+          nil
+        end
+      end
+
+      # Extract the model from an Array of arguments
+      #
+      # @param [Array(Model, String, Hash)]
+      #   The arguments passed to an relationship declaration
+      #
+      # @return [Hash]
+      #   options for the association
+      #
+      # @api private
+      def extract_options(args)
+        options = args.last
+
+        if options.kind_of?(Hash)
+          options.dup
+        else
+          {}
+        end
+      end
+
+      # A support method for converting Integer, Range or Infinity values into two
+      # values representing the minimum and maximum cardinality of the association
+      #
+      # @return [Array]  A pair of integers, min and max
+      #
+      # @api private
+      def extract_min_max(cardinality)
+        case cardinality
+          when Integer then [ cardinality,       cardinality      ]
+          when Range   then [ cardinality.first, cardinality.last ]
+          when n       then [ 0,                 n                ]
+        end
+      end
+
+      # Validates options of association method like belongs_to or has:
+      # verifies types of cardinality bounds, repository, association class,
+      # keys and possible values of :through option.
+      #
+      # @api private
+      def assert_valid_options(options)
+        # TODO: update to match Query#assert_valid_options
+        #   - perform options normalization elsewhere
+
+        if options.key?(:min) && options.key?(:max)
+          assert_kind_of 'options[:min]', options[:min], Integer
+          assert_kind_of 'options[:max]', options[:max], Integer, n.class
+
+          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'
+          elsif options[:min] > options[:max]
+            raise ArgumentError, "Cardinality min (#{options[:min]}) cannot be larger than the max (#{options[:max]})"
+          elsif options[:min] < 0
+            raise ArgumentError, "Cardinality min much be greater than or equal to 0, but was #{options[:min]}"
+          elsif options[:max] < 1
+            raise ArgumentError, "Cardinality max much be greater than or equal to 1, but was #{options[:max]}"
+          end
+        end
+
+        if options.key?(:repository)
+          assert_kind_of 'options[:repository]', options[:repository], Repository, Symbol
+
+          if options[:repository].kind_of?(Repository)
+            options[:repository] = options[:repository].name
+          end
+        end
+
+        if options.key?(:class_name)
+          assert_kind_of 'options[:class_name]', options[:class_name], String
+          warn "+options[:class_name]+ is deprecated, use :model instead (#{caller[1]})"
+          options[:model] = options.delete(:class_name)
+        end
+
+        if options.key?(:remote_name)
+          assert_kind_of 'options[:remote_name]', options[:remote_name], Symbol
+          warn "+options[:remote_name]+ is deprecated, use :via instead (#{caller[1]})"
+          options[:via] = options.delete(:remote_name)
+        end
+
+        if options.key?(:through)
+          assert_kind_of 'options[:through]', options[:through], Symbol, Module
+        end
+
+        [ :via, :inverse ].each do |key|
+          if options.key?(key)
+            assert_kind_of "options[#{key.inspect}]", options[key], Symbol, Associations::Relationship
+          end
+        end
+
+        # TODO: deprecate :child_key and :parent_key in favor of :source_key and
+        # :target_key (will mean something different for each relationship)
+
+        [ :child_key, :parent_key ].each do |key|
+          if options.key?(key)
+            assert_kind_of "options[#{key.inspect}]", options[key], Enumerable
+          end
+        end
+
+        if options.key?(:limit)
+          raise ArgumentError, '+options[:limit]+ should not be specified on a relationship'
+        end
+      end
+
+      chainable do
+        # TODO: document
+        # @api public
+        def method_missing(method, *args, &block)
+          if relationship = relationships(repository_name)[method]
+            return Query::Path.new([ relationship ])
+          end
+
+          super
+        end
+      end
+    end # module Relationship
+  end # module Model
+end # module DataMapper