tpitale-mongo_mapper 0.6.9

data/lib/mongo_mapper/embedded_document.rb

@@ -0,0 +1,384 @@
+module MongoMapper
+  module EmbeddedDocument
+    def self.included(model)
+      model.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+        
+        extend Associations::ClassMethods
+        include Associations::InstanceMethods
+
+        include RailsCompatibility::EmbeddedDocument
+        include Validatable
+        include Serialization
+
+        extend Validations::Macros
+
+        key :_id, ObjectId
+        attr_accessor :_root_document
+      end
+    end
+
+    module ClassMethods
+      def logger
+        MongoMapper.logger
+      end
+
+      def inherited(subclass)
+        unless subclass.embeddable?
+          subclass.set_collection_name(collection_name)
+        end
+
+        (@subclasses ||= []) << subclass
+      end
+
+      def subclasses
+        @subclasses
+      end
+
+      def keys
+        @keys ||= if parent = parent_model
+          parent.keys.dup
+        else
+          HashWithIndifferentAccess.new
+        end
+      end
+
+      def key(*args)
+        key = Key.new(*args)
+        keys[key.name] = key
+
+        create_accessors_for(key)
+        create_key_in_subclasses(*args)
+        create_validations_for(key)
+
+        key
+      end
+      
+      def using_object_id?
+        object_id_key?(:_id)
+      end
+      
+      def object_id_key?(name)
+        key = keys[name.to_s]
+        key && key.type == ObjectId
+      end
+
+      def embeddable?
+        !self.ancestors.include?(Document)
+      end
+
+      def parent_model
+        (ancestors - [self,EmbeddedDocument]).find do |parent_class|
+          parent_class.ancestors.include?(EmbeddedDocument)
+        end
+      end
+      
+      def to_mongo(instance)
+        return nil if instance.nil?
+        instance.to_mongo
+      end
+      
+      def from_mongo(value)
+        return nil if value.nil?
+        value.is_a?(self) ? value : initialize_doc(value)
+      end
+      
+    private
+      def initialize_doc(doc)
+        begin
+          klass = doc['_type'].present? ? doc['_type'].constantize : self
+          klass.new(doc)
+        rescue NameError
+          new(doc)
+        end
+      end
+      
+      def accessors_module
+        module_defined =  if method(:const_defined?).arity == 1 # Ruby 1.9 compat check
+                            const_defined?('MongoMapperKeys')
+                          else
+                            const_defined?('MongoMapperKeys', false)
+                          end
+
+        if module_defined
+          const_get 'MongoMapperKeys'
+        else
+          const_set 'MongoMapperKeys', Module.new
+        end
+      end
+
+      def create_accessors_for(key)
+        accessors_module.module_eval <<-end_eval
+          def #{key.name}
+            read_attribute(:'#{key.name}')
+          end
+
+          def #{key.name}_before_typecast
+            read_attribute_before_typecast(:'#{key.name}')
+          end
+
+          def #{key.name}=(value)
+            write_attribute(:'#{key.name}', value)
+          end
+
+          def #{key.name}?
+            read_attribute(:#{key.name}).present?
+          end
+        end_eval
+        include accessors_module
+      end
+      
+      def create_key_in_subclasses(*args)
+        return if subclasses.blank?
+
+        subclasses.each do |subclass|
+          subclass.key(*args)
+        end
+      end
+
+      def create_validations_for(key)
+        attribute = key.name.to_sym
+
+        if key.options[:required]
+          validates_presence_of(attribute)
+        end
+
+        if key.options[:unique]
+          validates_uniqueness_of(attribute)
+        end
+
+        if key.options[:numeric]
+          number_options = key.type == Integer ? {:only_integer => true} : {}
+          validates_numericality_of(attribute, number_options)
+        end
+
+        if key.options[:format]
+          validates_format_of(attribute, :with => key.options[:format])
+        end
+
+        if key.options[:length]
+          length_options = case key.options[:length]
+          when Integer
+            {:minimum => 0, :maximum => key.options[:length]}
+          when Range
+            {:within => key.options[:length]}
+          when Hash
+            key.options[:length]
+          end
+          validates_length_of(attribute, length_options)
+        end
+      end
+    end
+
+    module InstanceMethods
+      def initialize(attrs={})
+        unless attrs.nil?
+          associations.each do |name, association|
+            if collection = attrs.delete(name)
+              if association.many? && association.klass.embeddable?
+                root_document = attrs[:_root_document] || self
+                collection.each do |doc|
+                  doc[:_root_document] = root_document
+                end
+              end
+              send("#{association.name}=", collection)
+            end
+          end
+
+          self.attributes = attrs
+          
+          if respond_to?(:_type=) && self['_type'].blank?
+            self._type = self.class.name
+          end
+        end
+
+        if self.class.embeddable?
+          if read_attribute(:_id).blank?
+            write_attribute :_id, Mongo::ObjectID.new
+            @new_document = true
+          else
+            @new_document = false
+          end
+        end
+      end
+
+      def new?
+        !!@new_document
+      end
+      
+      def to_param
+        id.to_s
+      end
+
+      def attributes=(attrs)
+        return if attrs.blank?
+        attrs.each_pair do |name, value|
+          writer_method = "#{name}="
+
+          if respond_to?(writer_method)
+            self.send(writer_method, value)
+          else
+            self[name.to_s] = value
+          end
+        end
+      end
+
+      def attributes
+        attrs = HashWithIndifferentAccess.new
+        
+        embedded_keys.each do |key|
+          attrs[key.name] = read_attribute(key.name).try(:attributes)
+        end
+        
+        non_embedded_keys.each do |key|
+          attrs[key.name] = read_attribute(key.name)
+        end
+        
+        embedded_associations.each do |association|
+          documents = instance_variable_get(association.ivar)
+          next if documents.nil?
+          attrs[association.name] = documents.collect { |doc| doc.attributes }
+        end
+        
+        attrs
+      end
+      
+      def to_mongo
+        attrs = HashWithIndifferentAccess.new
+        
+        _keys.each_pair do |name, key|
+          value = key.set(read_attribute(key.name))
+          attrs[name] = value unless value.nil?
+        end
+        
+        embedded_associations.each do |association|
+          if documents = instance_variable_get(association.ivar)
+            attrs[association.name] = documents.map { |document| document.to_mongo }
+          end
+        end
+        
+        attrs
+      end
+
+      def clone
+        clone_attributes = self.attributes
+        clone_attributes.delete("_id")
+        self.class.new(clone_attributes)
+      end
+
+      def [](name)
+        read_attribute(name)
+      end
+
+      def []=(name, value)
+        ensure_key_exists(name)
+        write_attribute(name, value)
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && _id == other._id
+      end
+
+      def id
+        read_attribute(:_id)
+      end
+
+      def id=(value)
+        if self.class.using_object_id?
+          value = MongoMapper.normalize_object_id(value)
+        else
+          @using_custom_id = true
+        end
+        
+        write_attribute :_id, value
+      end
+
+      def using_custom_id?
+        !!@using_custom_id
+      end
+
+      def inspect
+        attributes_as_nice_string = key_names.collect do |name|
+          "#{name}: #{read_attribute(name).inspect}"
+        end.join(", ")
+        "#<#{self.class} #{attributes_as_nice_string}>"
+      end
+
+      def save
+        if _root_document
+          _root_document.save
+        end
+      end
+      
+      def save!
+        if _root_document
+          _root_document.save!
+        end
+      end
+
+      def update_attributes(attrs={})
+        self.attributes = attrs
+        save
+      end
+
+      def update_attributes!(attrs={})
+        self.attributes = attrs
+        save!
+      end
+      
+      def logger
+        self.class.logger
+      end
+
+      private
+        def _keys
+          self.metaclass.keys
+        end
+        
+        def key_names
+          _keys.keys
+        end
+        
+        def non_embedded_keys
+          _keys.values.select { |key| !key.embeddable? }
+        end
+        
+        def embedded_keys
+          _keys.values.select { |key| key.embeddable? }
+        end
+        
+        def ensure_key_exists(name)
+          self.metaclass.key(name) unless respond_to?("#{name}=")
+        end
+
+        def read_attribute(name)
+          if key = _keys[name]
+            value = key.get(instance_variable_get("@#{name}"))
+            instance_variable_set "@#{name}", value if !frozen?
+            value
+          else
+            raise KeyNotFound, "Could not find key: #{name.inspect}"
+          end
+        end
+
+        def read_attribute_before_typecast(name)
+          instance_variable_get("@#{name}_before_typecast")
+        end
+
+        def write_attribute(name, value)
+          key = _keys[name]
+          instance_variable_set "@#{name}_before_typecast", value
+          instance_variable_set "@#{name}", key.set(value)
+        end
+        
+        def embedded_associations
+          associations.select do |name, association|
+            association.embeddable?
+          end.map do |name, association|
+            association
+          end
+        end
+    end # InstanceMethods
+  end # EmbeddedDocument
+end # MongoMapper

data/lib/mongo_mapper/finder_options.rb

@@ -0,0 +1,133 @@
+module MongoMapper
+  # Controls the parsing and handling of options used by finders.
+  #
+  # == Important Note
+  #
+  # This class is private to MongoMapper and should not be considered part of 
+  # MongoMapper's public API. Some documentation herein, however, may prove 
+  # useful for understanding how MongoMapper handles the parsing of finder 
+  # conditions and options.
+  #
+  # @private  
+  class FinderOptions
+    OptionKeys = [:fields, :select, :skip, :offset, :limit, :sort, :order]
+
+    def initialize(model, options)
+      raise ArgumentError, "Options must be a hash" unless options.is_a?(Hash)
+      options = options.symbolize_keys
+
+      @model      = model
+      @options    = {}
+      @conditions = options.delete(:conditions) || {}
+
+      options.each_pair do |key, value|
+        if OptionKeys.include?(key)
+          @options[key] = value
+        else
+          @conditions[key] = value
+        end
+      end
+
+      add_sci_scope
+    end
+    
+    # @return [Hash] Mongo compatible criteria options
+    #
+    # @see FinderOptions#to_mongo_criteria
+    def criteria
+      to_mongo_criteria(@conditions)
+    end
+    
+    # @return [Hash] Mongo compatible options
+    def options
+      fields = @options.delete(:fields) || @options.delete(:select)
+      skip   = @options.delete(:skip)   || @options.delete(:offset) || 0
+      limit  = @options.delete(:limit)  || 0
+      sort   = @options.delete(:sort)   || convert_order_to_sort(@options.delete(:order))
+
+      {:fields => to_mongo_fields(fields), :skip => skip.to_i, :limit => limit.to_i, :sort => sort}
+    end
+    
+    # @return [Array<Hash>] Mongo criteria and options enclosed in an Array
+    def to_a
+      [criteria, options]
+    end
+
+    private
+      def to_mongo_criteria(conditions, parent_key=nil)
+        criteria = {}
+
+        conditions.each_pair do |field, value|
+          field = normalized_field(field)
+          
+          if @model.object_id_key?(field) && value.is_a?(String)
+            value = Mongo::ObjectID.from_string(value)
+          end
+          
+          if field.is_a?(FinderOperator)
+            criteria.merge!(field.to_criteria(value))
+            next
+          end
+          
+          case value
+            when Array
+              criteria[field] = operator?(field) ? value : {'$in' => value}
+            when Hash
+              criteria[field] = to_mongo_criteria(value, field)
+            else            
+              criteria[field] = value
+          end
+        end
+
+        criteria
+      end
+
+      def operator?(field)
+        field.to_s =~ /^\$/
+      end
+
+      def normalized_field(field)
+        field.to_s == 'id' ? :_id : field
+      end
+
+      # adds _type single collection inheritance scope for models that need it
+      def add_sci_scope
+        if @model.single_collection_inherited?
+          @conditions[:_type] = @model.to_s
+        end
+      end
+
+      def to_mongo_fields(fields)
+        return if fields.blank?
+
+        if fields.is_a?(String)
+          fields.split(',').map { |field| field.strip }
+        else
+          fields.flatten.compact
+        end
+      end
+
+      def convert_order_to_sort(sort)
+        return if sort.blank?
+        pieces = sort.split(',')
+        pieces.map { |s| to_mongo_sort_piece(s) }
+      end
+
+      def to_mongo_sort_piece(str)
+        field, direction = str.strip.split(' ')
+        direction ||= 'ASC'
+        direction = direction.upcase == 'ASC' ? 1 : -1
+        [field, direction]
+      end
+  end
+  
+  class FinderOperator
+    def initialize(field, operator)
+      @field, @operator = field, operator
+    end
+    
+    def to_criteria(value)
+      {@field => {@operator => value}}
+    end
+  end
+end

data/lib/mongo_mapper/key.rb

@@ -0,0 +1,36 @@
+module MongoMapper
+  class Key
+    attr_accessor :name, :type, :options, :default_value
+    
+    def initialize(*args)
+      options = args.extract_options!
+      @name, @type = args.shift.to_s, args.shift
+      self.options = (options || {}).symbolize_keys
+      self.default_value = self.options.delete(:default)
+    end
+
+    def ==(other)
+      @name == other.name && @type == other.type
+    end
+
+    def set(value)
+      type.to_mongo(value)
+    end
+
+    def embeddable?
+      type.respond_to?(:embeddable?) && type.embeddable? ? true : false
+    end
+    
+    def number?
+      [Integer, Float].include?(type)
+    end
+
+    def get(value)
+      if value.nil? && !default_value.nil?
+        return default_value
+      end
+      
+      type.from_mongo(value)
+    end
+  end
+end

data/lib/mongo_mapper/observing.rb

@@ -0,0 +1,50 @@
+require 'observer'
+require 'singleton'
+require 'set'
+
+module MongoMapper
+  module Observing #:nodoc:
+    def self.included(model)
+      model.class_eval do
+        extend Observable
+      end      
+    end
+  end
+
+  class Observer
+    include Singleton
+
+    class << self
+      def observe(*models)
+        models.flatten!
+        models.collect! { |model| model.is_a?(Symbol) ? model.to_s.camelize.constantize : model }
+        define_method(:observed_classes) { Set.new(models) }
+      end
+
+      def observed_class
+        if observed_class_name = name[/(.*)Observer/, 1]
+          observed_class_name.constantize
+        else
+          nil
+        end
+      end
+    end
+
+    def initialize
+      Set.new(observed_classes).each { |klass| add_observer! klass }
+    end
+
+    def update(observed_method, object) #:nodoc:
+      send(observed_method, object) if respond_to?(observed_method)
+    end
+
+    protected
+      def observed_classes
+        Set.new([self.class.observed_class].compact.flatten)
+      end
+      
+      def add_observer!(klass)
+        klass.add_observer(self)
+      end
+  end
+end

data/lib/mongo_mapper/pagination.rb

@@ -0,0 +1,55 @@
+module MongoMapper
+  module Pagination
+    class PaginationProxy
+      instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|proxy_|^object_id$)/ }
+      
+      attr_accessor :subject
+      attr_reader :total_entries, :per_page, :current_page
+      alias limit per_page
+      
+      def initialize(total_entries, current_page, per_page=nil)
+        @total_entries    = total_entries.to_i
+        self.per_page     = per_page
+        self.current_page = current_page
+      end
+      
+      def total_pages
+        (total_entries / per_page.to_f).ceil
+      end
+      
+      def out_of_bounds?
+        current_page > total_pages
+      end
+      
+      def previous_page
+        current_page > 1 ? (current_page - 1) : nil
+      end
+      
+      def next_page
+        current_page < total_pages ? (current_page + 1) : nil
+      end
+      
+      def skip
+        (current_page - 1) * per_page
+      end
+      alias offset skip # for will paginate support
+      
+      
+      def method_missing(name, *args, &block)
+        @subject.send(name, *args, &block)
+      end
+      
+      private
+        def per_page=(value)
+          value = 25 if value.blank?
+          @per_page = value.to_i
+        end
+        
+        def current_page=(value)
+          value = value.to_i
+          value = 1 if value < 1
+          @current_page = value
+        end
+    end
+  end
+end

data/lib/mongo_mapper/rails_compatibility/document.rb

@@ -0,0 +1,15 @@
+module MongoMapper
+  module RailsCompatibility
+    module Document
+      def self.included(model)
+        model.class_eval do
+          alias_method :new_record?, :new?
+          
+          def human_name
+            self.name.demodulize.titleize
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongo_mapper/rails_compatibility/embedded_document.rb

@@ -0,0 +1,27 @@
+module MongoMapper
+  module RailsCompatibility
+    module EmbeddedDocument
+      def self.included(model)
+        model.class_eval do
+          extend ClassMethods
+          
+          alias_method :new_record?, :new?
+        end
+
+        class << model
+          alias has_many many
+        end
+      end
+
+      module ClassMethods
+        def column_names
+          keys.keys
+        end
+        
+        def human_name
+          self.name.demodulize.titleize
+        end
+      end
+    end
+  end
+end