ghost_dm-core 1.3.0.beta

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

@@ -0,0 +1,103 @@
+module DataMapper
+  module Model
+    module Hook
+      Model.append_inclusions self
+
+      extend Chainable
+
+      def self.included(model)
+        model.send(:include, DataMapper::Hook)
+        model.extend Methods
+        super
+      end
+
+      module Methods
+        def inherited(model)
+          copy_hooks(model)
+          super
+        end
+
+        # @api public
+        def before(target_method, method_sym = nil, &block)
+          setup_hook(:before, target_method, method_sym, block) { super }
+        end
+
+        # @api public
+        def after(target_method, method_sym = nil, &block)
+          setup_hook(:after, target_method, method_sym, block) { super }
+        end
+
+        # @api private
+        def hooks
+          @hooks ||= {
+            :save     => { :before => [], :after => [] },
+            :create   => { :before => [], :after => [] },
+            :update   => { :before => [], :after => [] },
+            :destroy  => { :before => [], :after => [] },
+          }
+        end
+
+      private
+
+        def setup_hook(type, name, method, proc)
+          types = hooks[name]
+          if types && types[type]
+            types[type] << if proc
+              ProcCommand.new(proc)
+            else
+              MethodCommand.new(self, method)
+            end
+          else
+            yield
+          end
+        end
+
+        # deep copy hooks from the parent model
+        def copy_hooks(model)
+          hooks = Hash.new do |hooks, name|
+            hooks[name] = Hash.new do |types, type|
+              if self.hooks[name]
+                types[type] = self.hooks[name][type].map do |command|
+                  command.copy(model)
+                end
+              end
+            end
+          end
+
+          model.instance_variable_set(:@hooks, hooks)
+        end
+
+      end
+
+      class ProcCommand
+        def initialize(proc)
+          @proc = proc.to_proc
+        end
+
+        def call(resource)
+          resource.instance_eval(&@proc)
+        end
+
+        def copy(model)
+          self
+        end
+      end
+
+      class MethodCommand
+        def initialize(model, method)
+          @model, @method = model, method.to_sym
+        end
+
+        def call(resource)
+          resource.__send__(@method)
+        end
+
+        def copy(model)
+          self.class.new(model, @method)
+        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,249 @@
+# 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, DataMapper::Property::Lookup
+
+      def self.extended(model)
+        model.instance_variable_set(:@properties,               {})
+        model.instance_variable_set(:@field_naming_conventions, {})
+        super
+      end
+
+      def inherited(model)
+        model.instance_variable_set(:@properties,               {})
+        model.instance_variable_set(:@field_naming_conventions, @field_naming_conventions.dup)
+
+        @properties.each do |repository_name, properties|
+          model_properties = model.properties(repository_name)
+          properties.each { |property| model_properties << property }
+        end
+
+        super
+      end
+
+      # Defines a Property on the Resource
+      #
+      # @param [Symbol] name
+      #   the name for which to call this property
+      # @param [Class] type
+      #   the ruby type to define this property as
+      # @param [Hash(Symbol => String)] options
+      #   a hash of available options
+      #
+      # @return [Property]
+      #   the created Property
+      #
+      # @see Property
+      #
+      # @api public
+      def property(name, type, options = {})
+        # if the type can be found within Property then
+        # use that class rather than the primitive
+        klass = DataMapper::Property.determine_class(type)
+
+        unless klass
+          raise ArgumentError, "+type+ was #{type.inspect}, which is not a supported type"
+        end
+
+        property = klass.new(self, name, options)
+
+        repository_name = self.repository_name
+        properties      = properties(repository_name)
+
+        properties << property
+
+        # Add property to the other mappings as well if this is for the default
+        # repository.
+
+        if repository_name == default_repository_name
+          other_repository_properties = DataMapper::Ext::Hash.except(@properties, default_repository_name)
+
+          other_repository_properties.each do |other_repository_name, properties|
+            next if properties.named?(name)
+
+            # make sure the property is created within the correct repository scope
+            DataMapper.repository(other_repository_name) do
+              properties << klass.new(self, name, 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 |context|
+            properties.lazy_context(context) << property
+          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|
+          descendant.properties(repository_name) << property
+        end
+
+        create_reader_for(property)
+        create_writer_for(property)
+
+        # FIXME: explicit return needed for YARD to parse this properly
+        return 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 [PropertySet]
+      #   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
+        repository_name = repository_name.to_sym
+
+        default_repository_name = self.default_repository_name
+
+        @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
+
+      # @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
+
+      # @api private
+      def properties_with_subclasses(repository_name = default_repository_name)
+        properties = properties(repository_name).dup
+
+        descendants.each do |model|
+          model.properties(repository_name).each do |property|
+            properties << property
+          end
+        end
+
+        properties
+      end
+
+      # @api private
+      def key_conditions(repository, key)
+        Hash[ self.key(repository.name).zip(key.nil? ? [] : key) ]
+      end
+
+    private
+
+      # Defines the anonymous module that is used to add properties.
+      # Using a single module here prevents having a very large number
+      # of anonymous modules, where each property has their own module.
+      # @api private
+      def property_module
+        @property_module ||= begin
+          mod = Module.new
+          class_eval do
+            include mod
+          end
+          mod
+        end
+      end
+
+      # 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
+        property_module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          #{reader_visibility}
+          def #{name}
+            return #{instance_variable_name} if defined?(#{instance_variable_name})
+            property = properties[#{name.inspect}]
+            #{instance_variable_name} = property ? persistence_state.get(property) : nil
+          end
+        RUBY
+
+        boolean_reader_name = "#{name}?"
+
+        if property.kind_of?(DataMapper::Property::Boolean)
+          property_module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            #{reader_visibility}
+            def #{boolean_reader_name}
+              #{name}
+            end
+          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}="
+        property_module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          #{writer_visibility}
+          def #{writer_name}(value)
+            property = properties[#{name.inspect}]
+            self.persistence_state = persistence_state.set(property, value)
+            persistence_state.get(property)
+          end
+        RUBY
+      end
+
+      # @api public
+      def method_missing(method, *args, &block)
+        if property = properties(repository_name)[method]
+          return property
+        end
+
+        super
+      end
+    end # module Property
+  end # module Model
+end # module DataMapper

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

@@ -0,0 +1,378 @@
+# 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 DataMapper::Assertions
+
+      # 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, {})
+        super
+      end
+
+      # When DataMapper model is inherited, relationships
+      # of parent are duplicated and copied to subclass model
+      #
+      # @api private
+      def inherited(model)
+        model.instance_variable_set(:@relationships, {})
+
+        @relationships.each do |repository_name, relationships|
+          model_relationships = model.relationships(repository_name)
+          relationships.each { |relationship| model_relationships << relationship }
+        end
+
+        super
+      end
+
+      # Returns copy of relationships set in given repository.
+      #
+      # @param [Symbol] repository_name
+      #   Name of the repository for which relationships set is returned
+      # @return [RelationshipSet]  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
+
+        default_repository_name = self.default_repository_name
+
+        @relationships[repository_name] ||= if repository_name == default_repository_name
+          RelationshipSet.new
+        else
+          relationships(default_repository_name).dup
+        end
+      end
+
+      # Used to express unlimited cardinality of association,
+      # see +has+
+      #
+      # @api public
+      def n
+        Infinity
+      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 *args [Model, Hash] model and/or options hash
+      #
+      # @option *args :through[Symbol] A association that this join should go through to form
+      #   a many-to-many association
+      # @option *args :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 *args :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)
+        name    = name.to_sym
+        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)
+
+        repository_name = repository.name
+
+        # 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 max > 1
+          options.key?(:through) ? Associations::ManyToMany::Relationship : Associations::OneToMany::Relationship
+        else
+          Associations::OneToOne::Relationship
+        end
+
+        relationship = klass.new(name, model, self, options)
+
+        relationships(repository_name) << relationship
+
+        descendants.each do |descendant|
+          descendant.relationships(repository_name) << relationship
+        end
+
+        create_relationship_reader(relationship)
+        create_relationship_writer(relationship)
+
+        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 *args [Model, Hash] model and/or options hash
+      #
+      # @option *args :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 *args :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)
+        name       = name.to_sym
+        model_name = self.name
+        model      = extract_model(args)
+        options    = extract_options(args)
+
+        if options.key?(:through)
+          raise "#{model_name}#belongs_to with :through is deprecated, use 'has 1, :#{name}, #{options.inspect}' in #{model_name} instead (#{caller.first})"
+        elsif options.key?(:model) && model
+          raise ArgumentError, 'should not specify options[:model] if passing the model in the third argument'
+        end
+
+        assert_valid_options(options)
+
+        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 = Associations::ManyToOne::Relationship.new(name, self, model, options)
+
+        relationships(repository_name) << relationship
+
+        descendants.each do |descendant|
+          descendant.relationships(repository_name) << relationship
+        end
+
+        create_relationship_reader(relationship)
+        create_relationship_writer(relationship)
+
+        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
+        options.respond_to?(:to_hash) ? options.to_hash.dup : {}
+      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 Infinity then [ 0,                 Infinity         ]
+          else
+            assert_kind_of 'options', options, Integer, Range, Infinity.class
+        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)
+          min = options[:min]
+          max = options[:max]
+
+          min = min.to_int unless min == Infinity
+          max = max.to_int unless max == Infinity
+
+          if min == Infinity && max == Infinity
+            raise ArgumentError, 'Cardinality may not be n..n.  The cardinality specifies the min/max number of results from the association'
+          elsif min > max
+            raise ArgumentError, "Cardinality min (#{min}) cannot be larger than the max (#{max})"
+          elsif min < 0
+            raise ArgumentError, "Cardinality min much be greater than or equal to 0, but was #{min}"
+          elsif max < 1
+            raise ArgumentError, "Cardinality max much be greater than or equal to 1, but was #{max}"
+          end
+        end
+
+        if options.key?(:repository)
+          options[:repository] = options[:repository].to_sym
+        end
+
+        if options.key?(:class_name)
+          raise "+options[:class_name]+ is deprecated, use :model instead (#{caller[1]})"
+        elsif options.key?(:remote_name)
+          raise "+options[:remote_name]+ is deprecated, use :via instead (#{caller[1]})"
+        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)
+            options[key] = Array(options[key])
+          end
+        end
+
+        if options.key?(:limit)
+          raise ArgumentError, '+options[:limit]+ should not be specified on a relationship'
+        end
+      end
+
+      # Defines the anonymous module that is used to add relationships.
+      # Using a single module here prevents having a very large number
+      # of anonymous modules, where each property has their own module.
+      # @api private
+      def relationship_module
+        @relationship_module ||= begin
+          mod = Module.new
+          class_eval do
+            include mod
+          end
+          mod
+        end
+      end
+
+      # Dynamically defines reader method
+      #
+      # @api private
+      def create_relationship_reader(relationship)
+        name        = relationship.name
+        reader_name = name.to_s
+
+        return if method_defined?(reader_name)
+
+        reader_visibility = relationship.reader_visibility
+
+        relationship_module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          #{reader_visibility}
+          def #{reader_name}(query = nil)
+            # TODO: when no query is passed in, return the results from
+            #       the ivar directly. This will require that the ivar
+            #       actually hold the resource/collection, and in the case
+            #       of 1:1, the underlying collection is hidden in a
+            #       private ivar, and the resource is in a known ivar
+
+            persistence_state.get(relationships[#{name.inspect}], query)
+          end
+        RUBY
+      end
+
+      # Dynamically defines writer method
+      #
+      # @api private
+      def create_relationship_writer(relationship)
+        name        = relationship.name
+        writer_name = "#{name}="
+
+        return if method_defined?(writer_name)
+
+        writer_visibility = relationship.writer_visibility
+
+        relationship_module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+          #{writer_visibility}
+          def #{writer_name}(target)
+            relationship = relationships[#{name.inspect}]
+            self.persistence_state = persistence_state.set(relationship, target)
+            persistence_state.get(relationship)
+          end
+        RUBY
+      end
+
+      # @api public
+      def method_missing(method, *args, &block)
+        if relationship = relationships(repository_name)[method]
+          return Query::Path.new([ relationship ])
+        end
+
+        super
+      end
+
+    end # module Relationship
+  end # module Model
+end # module DataMapper