ssherman-mongo_mapper 0.8.6

data/lib/mongo_mapper/plugins/indexes.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+module MongoMapper
+  module Plugins
+    module Indexes
+      module ClassMethods
+        def ensure_index(spec, options={})
+          collection.create_index(spec, options)
+        end
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/inspect.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+module MongoMapper
+  module Plugins
+    module Inspect
+      module InstanceMethods
+        def inspect
+          attributes_as_nice_string = key_names.collect do |name|
+            "#{name}: #{self[name].inspect}"
+          end.join(", ")
+          "#<#{self.class} #{attributes_as_nice_string}>"
+        end
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/keys.rb

@@ -0,0 +1,313 @@
+# encoding: UTF-8
+require 'mongo_mapper/plugins/keys/key'
+
+module MongoMapper
+  module Plugins
+    module Keys
+      def self.configure(model)
+        model.key :_id, ObjectId
+      end
+
+      module ClassMethods
+        def inherited(descendant)
+          descendant.instance_variable_set(:@keys, keys.dup)
+          super
+        end
+
+        def keys
+          @keys ||= HashWithIndifferentAccess.new
+        end
+
+        def key(*args)
+          Key.new(*args).tap do |key|
+            keys[key.name] = key
+            create_accessors_for(key)
+            create_key_in_descendants(*args)
+            create_indexes_for(key)
+            create_validations_for(key)
+          end
+        end
+
+        def key?(key)
+          keys.keys.include?(key.to_s)
+        end
+
+        def using_object_id?
+          object_id_key?(:_id)
+        end
+
+        def object_id_keys
+          keys.keys.select { |key| keys[key].type == ObjectId }.map(&:to_sym)
+        end
+
+        def object_id_key?(name)
+          object_id_keys.include?(name.to_sym)
+        end
+
+        # API Private
+        def can_default_id?
+          keys['_id'].can_default_id?
+        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 : load(value)
+        end
+
+        # load is overridden in identity map to ensure same objects are loaded
+        def load(attrs)
+          return nil if attrs.nil?
+          begin
+            attrs['_type'].present? ? attrs['_type'].constantize : self
+          rescue NameError
+            self
+          end.allocate.initialize_from_database(attrs)
+        end
+
+        private
+          def key_accessors_module_defined?
+            if method(:const_defined?).arity == 1 # Ruby 1.9 compat check
+              const_defined?('MongoMapperKeys')
+            else
+              const_defined?('MongoMapperKeys', false)
+            end
+          end
+
+          def accessors_module
+            if key_accessors_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_key(:#{key.name})
+              end
+
+              def #{key.name}_before_typecast
+                read_key_before_typecast(:#{key.name})
+              end
+
+              def #{key.name}=(value)
+                write_key(:#{key.name}, value)
+              end
+
+              def #{key.name}?
+                read_key(:#{key.name}).present?
+              end
+            end_eval
+
+            include accessors_module
+          end
+
+          def create_key_in_descendants(*args)
+            descendants.each { |descendant| descendant.key(*args) }
+          end
+
+          def create_indexes_for(key)
+            ensure_index key.name if key.options[:index] && !key.embeddable?
+          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[:in]
+              validates_inclusion_of(attribute, :within => key.options[:in])
+            end
+
+            if key.options[:not_in]
+              validates_exclusion_of(attribute, :within => key.options[:not_in])
+            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={})
+          default_id_value(attrs)
+          @_new = true
+          assign(attrs)
+        end
+
+        def initialize_from_database(attrs={})
+          @_new = false
+          load_from_database(attrs)
+          self
+        end
+
+        def persisted?
+          !new? && !destroyed?
+        end
+
+        def attributes=(attrs)
+          return if attrs.blank?
+
+          attrs.each_pair do |key, value|
+            if respond_to?(:"#{key}=")
+              self.send(:"#{key}=", value)
+            else
+              self[key] = value
+            end
+          end
+        end
+
+        def attributes
+          HashWithIndifferentAccess.new.tap do |attrs|
+            keys.each_pair do |name, key|
+              value = key.set(self[key.name])
+              attrs[name] = value
+            end
+
+            embedded_associations.each do |association|
+              if documents = instance_variable_get(association.ivar)
+                if association.one?
+                  attrs[association.name] = documents.to_mongo
+                else
+                  attrs[association.name] = documents.map { |document| document.to_mongo }
+                end
+              end
+            end
+          end
+        end
+        alias :to_mongo :attributes
+
+        def assign(attrs={})
+          self.attributes = attrs
+        end
+
+        def update_attributes(attrs={})
+          assign(attrs)
+          save
+        end
+
+        def update_attributes!(attrs={})
+          assign(attrs)
+          save!
+        end
+
+        def id
+          _id
+        end
+
+        def id=(value)
+          if self.class.using_object_id?
+            value = ObjectId.to_mongo(value)
+          end
+
+          self[:_id] = value
+        end
+
+        def [](name)
+          read_key(name)
+        end
+
+        def []=(name, value)
+          ensure_key_exists(name)
+          write_key(name, value)
+        end
+
+        def keys
+          self.class.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
+
+        private
+          def load_from_database(attrs)
+            return if attrs.blank?
+            attrs.each do |key, value|
+              if respond_to?(:"#{key}=") && !self.class.key?(key)
+                self.send(:"#{key}=", value)
+              else
+                self[key] = value
+              end
+            end
+          end
+
+          def default_id_value(attrs)
+            unless attrs.nil?
+              id_provided = attrs.keys.map { |k| k.to_s }.detect { |k| k == 'id' || k == '_id' }
+              if !id_provided && self.class.can_default_id?
+                write_key :_id, BSON::ObjectId.new
+              end
+            end
+          end
+
+          def ensure_key_exists(name)
+            self.class.key(name) unless respond_to?("#{name}=")
+          end
+
+          def set_parent_document(key, value)
+            if key.embeddable? && value.is_a?(key.type)
+              value._parent_document = self
+            end
+          end
+
+          def read_key(key_name)
+            if key = keys[key_name]
+              value = key.get(instance_variable_get(:"@#{key_name}"))
+              set_parent_document(key, value)
+              instance_variable_set(:"@#{key_name}", value)
+            end
+          end
+
+          def read_key_before_typecast(name)
+            instance_variable_get(:"@#{name}_before_typecast")
+          end
+
+          def write_key(name, value)
+            key = keys[name.to_s]
+            set_parent_document(key, value)
+            instance_variable_set :"@#{name}_before_typecast", value
+            instance_variable_set :"@#{name}", key.set(value)
+          end
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/keys/key.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+module MongoMapper
+  module Plugins
+    module Keys
+      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[:default]
+        end
+
+        def ==(other)
+          @name == other.name && @type == other.type
+        end
+
+        def embeddable?
+          return false unless type.respond_to?(:embeddable?)
+          type.embeddable?
+        end
+
+        def can_default_id?
+          type && [ObjectId, BSON::ObjectId, String].include?(type)
+        end
+
+        def number?
+          [Integer, Float].include?(type)
+        end
+
+        def get(value)
+          if value.nil? && !default_value.nil?
+            if default_value.respond_to?(:call)
+              return default_value.call
+            else
+              return default_value
+            end
+          end
+
+          type.from_mongo(value)
+        end
+
+        def set(value)
+          type.to_mongo(value).tap do |values|
+            if options[:typecast].present?
+              values.map! { |v| typecast_class.to_mongo(v) }
+            end
+          end
+        end
+        
+        private
+          def typecast_class
+            @typecast_class ||= options[:typecast].constantize
+          end
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/logger.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+module MongoMapper
+  module Plugins
+    module Logger
+      module ClassMethods
+        def logger
+          MongoMapper.logger
+        end
+      end
+
+      module InstanceMethods
+        def logger
+          self.class.logger
+        end
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/modifiers.rb

@@ -0,0 +1,112 @@
+# encoding: UTF-8
+module MongoMapper
+  module Plugins
+    module Modifiers
+      module ClassMethods
+        def increment(*args)
+          modifier_update('$inc', args)
+        end
+
+        def decrement(*args)
+          criteria, keys = criteria_and_keys_from_args(args)
+          values, to_decrement = keys.values, {}
+          keys.keys.each_with_index { |k, i| to_decrement[k] = -values[i].abs }
+          collection.update(criteria, {'$inc' => to_decrement}, :multi => true)
+        end
+
+        def set(*args)
+          criteria, updates = criteria_and_keys_from_args(args)
+          updates.each do |key, value|
+            updates[key] = keys[key].set(value) if key?(key)
+          end
+          collection.update(criteria, {'$set' => updates}, :multi => true)
+        end
+
+        def unset(*args)
+          if args[0].is_a?(Hash)
+            criteria, keys = args.shift, args
+          else
+            keys, ids = args.partition { |arg| arg.is_a?(Symbol) }
+            criteria = {:id => ids}
+          end
+
+          criteria  = criteria_hash(criteria).to_hash
+          modifiers = keys.inject({}) { |hash, key| hash[key] = 1; hash }
+          collection.update(criteria, {'$unset' => modifiers}, :multi => true)
+        end
+
+        def push(*args)
+          modifier_update('$push', args)
+        end
+
+        def push_all(*args)
+          modifier_update('$pushAll', args)
+        end
+
+        def add_to_set(*args)
+          modifier_update('$addToSet', args)
+        end
+        alias push_uniq add_to_set
+
+        def pull(*args)
+          modifier_update('$pull', args)
+        end
+
+        def pull_all(*args)
+          modifier_update('$pullAll', args)
+        end
+
+        def pop(*args)
+          modifier_update('$pop', args)
+        end
+
+        private
+          def modifier_update(modifier, args)
+            criteria, updates = criteria_and_keys_from_args(args)
+            collection.update(criteria, {modifier => updates}, :multi => true)
+          end
+
+          def criteria_and_keys_from_args(args)
+            keys     = args.pop
+            criteria = args[0].is_a?(Hash) ? args[0] : {:id => args}
+            [criteria_hash(criteria).to_hash, keys]
+          end
+      end
+
+      module InstanceMethods
+        def unset(*keys)
+          self.class.unset(id, *keys)
+        end
+
+        def increment(hash)
+          self.class.increment(id, hash)
+        end
+
+        def decrement(hash)
+          self.class.decrement(id, hash)
+        end
+
+        def set(hash)
+          self.class.set(id, hash)
+        end
+
+        def push(hash)
+          self.class.push(id, hash)
+        end
+
+        def pull(hash)
+          self.class.pull(id, hash)
+        end
+
+        def add_to_set(hash)
+          self.class.push_uniq(id, hash)
+        end
+        alias push_uniq add_to_set
+
+        def pop(hash)
+          self.class.pop(id, hash)
+        end
+      end
+    end
+  end
+end