jmonteiro-mongo_mapper 0.1.0

data/lib/mongo_mapper/plugins/inspect.rb

@@ -0,0 +1,14 @@
+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,295 @@
+module MongoMapper
+  module Plugins
+    module Keys
+      module ClassMethods
+        def inherited(descendant)
+          descendant.instance_variable_set(:@keys, keys.dup)
+          super
+        end
+
+        def keys
+          @keys ||= HashWithIndifferentAccess.new
+        end
+
+        def key(*args)
+          key = Key.new(*args)
+          keys[key.name] = key
+
+          create_accessors_for(key)
+          create_key_in_descendants(*args)
+          create_indexes_for(key)
+          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 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
+
+        def load(attrs)
+          begin
+            klass = attrs['_type'].present? ? attrs['_type'].constantize : self
+            doc = klass.new(attrs)
+            doc.instance_variable_set("@new", false)
+            doc
+          rescue NameError
+            doc = new(attrs)
+            doc.instance_variable_set("@new", false)
+            doc
+          end
+        end
+
+        private
+          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_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)
+            return if descendants.blank?
+            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[: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 self.included(model)
+          model.key :_id, ObjectId
+        end
+        
+        def initialize(attrs={})
+          unless attrs.nil?
+            provided_keys = attrs.keys.map { |k| k.to_s }
+            unless provided_keys.include?('_id') || provided_keys.include?('id')
+              write_key :_id, Mongo::ObjectID.new
+            end
+          end
+          
+          @new = true
+          self._type = self.class.name if respond_to?(:_type=)
+          self.attributes = attrs
+        end
+        
+        def new?
+          @new
+        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
+
+          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)
+              attrs[association.name] = documents.map { |document| document.to_mongo }
+            end
+          end
+
+          attrs
+        end
+        alias :to_mongo :attributes
+        
+        def id
+          _id
+        end
+        
+        def id=(value)
+          if self.class.using_object_id?
+            value = MongoMapper.normalize_object_id(value)
+          end
+
+          self[:_id] = value
+        end
+
+        def [](name)
+          read_key(name)
+        end
+
+        def []=(name, value)
+          ensure_key_exists(name)
+          write_key(name, value)
+        end
+
+        # @api public
+        def keys
+          self.class.keys
+        end
+
+        # @api private?
+        def key_names
+          keys.keys
+        end
+
+        # @api private?
+        def non_embedded_keys
+          keys.values.select { |key| !key.embeddable? }
+        end
+
+        # @api private?
+        def embedded_keys
+          keys.values.select { |key| key.embeddable? }
+        end
+
+        private
+          def ensure_key_exists(name)
+            self.class.key(name) unless respond_to?("#{name}=")
+          end
+
+          def read_key(name)
+            if key = keys[name]
+              var_name = "@#{name}"
+              value = key.get(instance_variable_get(var_name))
+              instance_variable_set(var_name, value)
+            else
+              raise KeyNotFound, "Could not find key: #{name.inspect}"
+            end
+          end
+
+          def read_key_before_typecast(name)
+            instance_variable_get("@#{name}_before_typecast")
+          end
+
+          def write_key(name, value)
+            key = keys[name]
+            instance_variable_set "@#{name}_before_typecast", value
+            instance_variable_set "@#{name}", key.set(value)
+          end
+      end
+      
+      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 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
+
+        def set(value)
+          type.to_mongo(value)
+        end
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/logger.rb

@@ -0,0 +1,17 @@
+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/pagination.rb

@@ -0,0 +1,85 @@
+module MongoMapper
+  module Plugins
+    module Pagination
+      module ClassMethods
+        def per_page
+          25
+        end
+        
+        def paginate(options)
+          per_page      = options.delete(:per_page) || self.per_page
+          page          = options.delete(:page)
+          total_entries = count(options)
+          pagination    = Pagination::PaginationProxy.new(total_entries, page, per_page)
+
+          options.merge!(:limit => pagination.limit, :skip => pagination.skip)
+          pagination.subject = find_every(options)
+          pagination
+        end
+      end
+      
+      class PaginationProxy
+        instance_methods.each { |m| undef_method m unless m =~ /(^__|^nil\?$|^send$|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 send(method, *args, &block)
+          if respond_to?(method)
+            super
+          else
+            subject.send(method, *args, &block)
+          end
+        end
+
+        def ===(other)
+          other === subject
+        end
+
+        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
+end

data/lib/mongo_mapper/plugins/protected.rb

@@ -0,0 +1,31 @@
+module MongoMapper
+  module Plugins
+    module Protected
+      module ClassMethods
+        def attr_protected( *attrs )
+          self.write_inheritable_attribute( :attr_protected, Set.new(attrs) + (protected_attributes || []) )
+        end
+        def protected_attributes
+          self.read_inheritable_attribute( :attr_protected )
+        end
+      end
+
+      module InstanceMethods
+        def update_attributes( attrs = {} )
+          super filter_protected_attrs(attrs)
+        end
+
+        def update_attributes!( attrs = {} )
+          super filter_protected_attrs(attrs)
+        end
+
+      protected
+        def filter_protected_attrs( attrs )
+          prot_attrs = self.class.protected_attributes
+          return attrs  unless prot_attrs
+          attrs.dup.delete_if { |key, val|  prot_attrs.include?(key) }
+        end
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/rails.rb

@@ -0,0 +1,80 @@
+module MongoMapper
+  module Plugins
+    module Rails
+      module InstanceMethods
+        def to_param
+          id.to_s
+        end
+        
+        def new_record?
+          new?
+        end
+        
+        def read_attribute(name)
+          self[name]
+        end
+        
+        def read_attribute_before_typecast(name)
+          read_key_before_typecast(name)
+        end
+        
+        def write_attribute(name, value)
+          self[name] = value
+        end
+      end
+      
+      module ClassMethods
+        def has_one(*args)
+          one(*args)
+        end
+        
+        def has_many(*args)
+          many(*args)
+        end
+        
+        def column_names
+          keys.keys
+        end
+        
+        def self_and_descendants#nodoc:
+          klass = self
+          classes = [klass]
+          while klass != klass.base_class  
+            classes << klass = klass.superclass
+          end
+          classes
+        rescue
+          [self]
+        end
+
+        # Transforms attribute key names into a more humane format, such as "First name" instead of "first_name". Example:
+        #   Person.human_attribute_name("first_name") # => "First name"
+        # This used to be depricated in favor of humanize, but is now preferred, because it automatically uses the I18n
+        # module now.
+        # Specify +options+ with additional translating options.
+        def human_attribute_name(attribute_key_name, options = {})
+          defaults = self_and_descendants.map do |klass|
+            :"#{klass.name.underscore}.#{attribute_key_name}"
+          end
+          defaults << options[:default] if options[:default]
+          defaults.flatten!
+          defaults << attribute_key_name.to_s.humanize
+          options[:count] ||= 1
+          I18n.translate(defaults.shift, options.merge(:default => defaults, :scope => [:mongomapper, :attributes]))
+        end
+
+        # Transform the modelname into a more humane format, using I18n.
+        # Defaults to the basic humanize method.
+        # Default scope of the translation is mongomapper.models
+        # Specify +options+ with additional translating options.
+        def human_name(options = {})
+          defaults = self_and_descendants.map do |klass|
+            :"#{klass.name.underscore}"
+          end 
+          defaults << self.name.humanize
+          I18n.translate(defaults.shift, {:scope => [:mongomapper, :models], :count => 1, :default => defaults}.merge(options))
+        end
+      end
+    end
+  end
+end