custom_fields 1.0.0.beta2 → 1.0.0.beta.3

data/README

@@ -6,7 +6,7 @@ Manage custom fields to a mongoid document or a collection. This module is one o
 Requirements
 =======
 
-ActiveSupport 3.0, MongoDB 1.6 and mongoid 2.0.0.beta17
+ActiveSupport 3.0, MongoDB 1.6 and mongoid 2.0.0.rc.6
 
 
 Example
@@ -15,4 +15,4 @@ Example
 Coming soon but take a look of the tests to see what CustomFields is capable of.
 
 
-Copyright (c) 2010 [Didier Lafforgue], released under the MIT license
+Copyright (c) 2011 [Didier Lafforgue], released under the MIT license

data/lib/custom_fields/custom_fields_for.rb

@@ -6,9 +6,12 @@ module CustomFields
       base.extend(ClassMethods)
     end
 
-    # Enhance an embedded collection by providing methods to manage custom fields
+    # Enhance an embedded collection OR the instance itself (by passing self) by providing methods to manage custom fields.
     #
     # class Company
+    #
+    #   custom_fields_for :self
+    #
     #   embeds_many :employees
     #   custom_fields_for :employees
     # end
@@ -22,15 +25,35 @@ module CustomFields
     #
     # company.employees.build :name => 'Michael Scott', :position => 'Regional manager'
     #
+    #
+    # company.self_custom_fields.build :label => 'Shipping Address', :_alias => 'address', :kind => 'text'
+    #
+    # company.metadata.address = '700 S Laflin, 60607 Chicago'
+    #
+    # other_company.metadata.address # returns a "not defined method" error
+    #
     module ClassMethods
 
       def custom_fields_for(collection_name)
         singular_name = collection_name.to_s.singularize
 
+        if (itself = %w(itself self).include?(collection_name.to_s))
+          singular_name = '_metadata'
+
+          class_eval <<-EOV
+            embeds_one :#{singular_name}, :class_name => '::CustomFields::Metadata'
+
+            def metadata
+              self.#{singular_name} || self.build_#{singular_name}
+            end
+
+          EOV
+        end
+
         class_eval <<-EOV
           field :#{singular_name}_custom_fields_counter, :type => Integer, :default => 0
 
-          embeds_many :#{singular_name}_custom_fields, :class_name => "::CustomFields::Field"
+          embeds_many :#{singular_name}_custom_fields, :class_name => '::CustomFields::Field'
 
           validates_associated :#{singular_name}_custom_fields
 
@@ -39,8 +62,14 @@ module CustomFields
           def ordered_#{singular_name}_custom_fields
             self.#{singular_name}_custom_fields.sort { |a, b| (a.position || 0) <=> (b.position || 0) }
           end
-
         EOV
+
+        if itself
+          class_eval <<-EOV
+            alias :self_custom_fields :#{singular_name}_custom_fields
+          EOV
+        end
+
       end
 
     end

data/lib/custom_fields/extensions/mongoid/document.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+
+  # This is the base module for all domain objects that need to be persisted to
+  # the database as documents.
+  module Document
+
+    # Reloads the +Document+ attributes from the database. If the document has
+    # not been saved then an error will get raised if the configuration option
+    # was set.
+    #
+    # @example Reload the document.
+    #   person.reload
+    #
+    # @raise [ Errors::DocumentNotFound ] If the document was deleted.
+    #
+    # @return [ Document ] The document, reloaded.
+    def reload_with_custom_fields
+      reload_without_custom_fields.tap do
+        instance_variable_names.each do |name|
+          if name =~ /_proxy_class$/
+            remove_instance_variable("#{name}")
+          end
+        end
+      end
+    end
+
+    alias_method_chain :reload, :custom_fields
+
+  end
+end

data/lib/custom_fields/extensions/mongoid/relations/accessors.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+module Mongoid # :nodoc:
+  module Relations #:nodoc:
+
+    module Accessors
+
+      # Create a relation from an object and metadata.
+      #
+      # @example Create the relation.
+      #   person.create_relation(document, metadata)
+      #
+      # @param [ Document, Array<Document ] object The relation target.
+      # @param [ Metadata ] metadata The relation metadata.
+      #
+      # @return [ Proxy ] The relation.
+      #
+      # @since 2.0.0.rc.1
+      def create_relation_with_custom_fields(object, metadata)
+        if custom_fields?(self, metadata.name)
+          metadata = metadata.clone # 2 parent instances should not share the exact same option instance
+
+          custom_fields = self.send(:"ordered_#{custom_fields_association_name(metadata.name)}")
+
+          klass = metadata.klass.to_klass_with_custom_fields(custom_fields, self, metadata.name)
+
+          metadata.instance_variable_set(:@klass, klass)
+        end
+
+        create_relation_without_custom_fields(object, metadata)
+      end
+
+      alias_method_chain :create_relation, :custom_fields
+
+      def custom_fields_association_name(association_name)
+        "#{association_name.to_s.singularize}_custom_fields".to_sym
+      end
+
+      def custom_fields?(object, association_name)
+        object.respond_to?(custom_fields_association_name(association_name))
+      end
+
+    end
+
+  end
+end

data/lib/custom_fields/field.rb

@@ -3,7 +3,7 @@ module CustomFields
   class Field
     include ::Mongoid::Document
     include ::Mongoid::Timestamps
-    
+
     # types ##
     include Types::Default
     include Types::String
@@ -12,7 +12,7 @@ module CustomFields
     include Types::Boolean
     include Types::Date
     include Types::File
-  
+
     ## fields ##
     field :label
     field :_alias
@@ -20,63 +20,106 @@ module CustomFields
     field :kind
     field :hint
     field :position, :type => Integer, :default => 0
-      
+
     ## validations ##
     validates_presence_of :label, :kind
-    validate :uniqueness_of_label
-      
+    validates_exclusion_of :_alias, :in => Mongoid.destructive_fields
+    validate :uniqueness_of_label_and_alias
+
+    ## other accessors ##
+    attr_accessor :association_name # missing in 2.0.0 rc
+
     ## methods ##
-    
+
     def field_type
       self.class.field_types[self.kind.downcase.to_sym]
     end
-    
+
     def apply(klass)
-      return unless self.valid?
-      
+      return false unless self.valid?
+
       klass.field self._name, :type => self.field_type if self.field_type
-      
+
       apply_method_name = :"apply_#{self.kind.downcase}_type"
-      
+
       if self.respond_to?(apply_method_name)
         self.send(apply_method_name, klass)
       else
         apply_default_type(klass)
       end
+
+      true
     end
-    
+
     def safe_alias
       self.set_alias
-      self._alias 
+      self._alias
+    end
+
+    def write_attributes_with_invalidation(attrs = nil)
+      if self.association_name.to_s == '_metadata_custom_fields'
+        target_name = 'metadata'
+      else
+        target_name = self.association_name.to_s.gsub('_custom_fields', '').pluralize
+      end
+
+      klass = self._parent.send(target_name).metadata.klass
+
+      write_attributes_without_invalidation(attrs)
+
+      klass.apply_custom_field(self)
     end
-  
+
+    alias_method_chain :write_attributes, :invalidation
+
     protected
-    
-    def uniqueness_of_label
-      duplicate = self.siblings.detect { |f| f.label == self.label && f._id != self._id }
-      if not duplicate.nil?
+
+    def uniqueness_of_label_and_alias
+      if self.siblings.any? { |f| f.label == self.label && f._id != self._id }
         self.errors.add(:label, :taken)
       end
+
+      if self.siblings.any? { |f| f._alias == self._alias && f._id != self._id }
+        self.errors.add(:_alias, :taken)
+      end
     end
-  
+
     def set_unique_name!
       self._name ||= "custom_field_#{self.increment_counter!}"
     end
-    
+
     def set_alias
       return if self.label.blank? && self._alias.blank?
       self._alias = (self._alias.blank? ? self.label : self._alias).parameterize('_').downcase
     end
-  
+
     def increment_counter!
       next_value = (self._parent.send(:"#{self.association_name}_counter") || 0) + 1
       self._parent.send(:"#{self.association_name}_counter=", next_value)
       next_value
     end
-  
+
     def siblings
       self._parent.send(self.association_name)
     end
+
+    def parentize_with_custom_fields(object)
+      object_name = object.class.to_s.underscore
+
+      self.association_name = self.metadata ? self.metadata.name : self.relations[object_name].inverse_of
+
+      if !self.relations.key?(object_name)
+        self.singleton_class.embedded_in object_name.to_sym, :inverse_of => self.association_name
+      end
+
+      parentize_without_custom_fields(object)
+
+      self.send(:set_unique_name!)
+      self.send(:set_alias)
+    end
+
+    alias_method_chain :parentize, :custom_fields
+
   end
-  
+
 end

data/lib/custom_fields/metadata.rb

@@ -0,0 +1,31 @@
+module CustomFields
+
+  class Metadata
+
+    include ::Mongoid::Document
+    include CustomFields::ProxyClassEnabler
+
+    ## other accessors ##
+    attr_accessor :association_name # missing in 2.0.0 rc
+
+    protected
+
+    def parentize_with_custom_fields(object)
+      object_name = object.class.to_s.underscore
+
+      self.association_name = self.metadata ? self.metadata.name : self.relations[object_name].inverse_of
+
+      if !self.relations.key?(object_name)
+        self.singleton_class.embedded_in object_name.to_sym, :inverse_of => self.association_name
+      end
+
+      parentize_without_custom_fields(object)
+    end
+
+    alias_method_chain :parentize, :custom_fields
+
+
+
+  end
+
+end

data/lib/custom_fields/proxy_class_enabler.rb

@@ -5,33 +5,73 @@ module CustomFields
 
     included do
 
-      cattr_accessor :klass_with_custom_fields
+      def self.to_klass_with_custom_fields(fields, parent, association_name)
+        target_name = "#{association_name}_proxy_class"
 
-      def self.to_klass_with_custom_fields(fields)
-        return klass_with_custom_fields unless klass_with_custom_fields.nil?
+        klass = parent.instance_variable_get(:"@#{target_name}")
+
+        if klass.nil?
+          klass = self.build_proxy_class_with_custom_fields(fields, parent, association_name)
+
+          parent.instance_variable_set(:"@#{target_name}", klass)
+        end
+
+        klass
+      end
+
+      def self.build_proxy_class_with_custom_fields(fields, parent, association_name)
+        (klass = Class.new(self)).class_eval <<-EOF
 
-        klass = Class.new(self)
-        klass.class_eval <<-EOF
           cattr_accessor :custom_fields, :_parent, :association_name
 
           def self.model_name
             @_model_name ||= ActiveModel::Name.new(self.superclass)
           end
 
-          def custom_fields
-            self.class.custom_fields
+          def self.apply_custom_field(field)
+            return unless field.valid?
+
+            (self.custom_fields ||= []) << field
+
+            field.apply(self)
+          end
+
+          def self.lookup_custom_field(name)
+            self.custom_fields.detect { |f| f._name == name }
           end
 
           def self.hereditary?
             false
           end
+
+          def custom_fields
+            self.class.custom_fields
+          end
+
+          def aliased_attributes
+            hash = { :created_at => self.created_at, :updated_at => self.updated_at } rescue {}
+
+            self.custom_fields.each do |field|
+              case field.kind
+              when 'file' then hash[field._alias] = self.send(field._name.to_sym).url
+              else
+                hash[field._alias] = self.send(field._name.to_sym)
+              end
+            end
+
+            hash
+          end
         EOF
 
-        klass.custom_fields = fields
+        # copy scopes from the parent class
+        klass.write_inheritable_attribute(:scopes, self.scopes)
+
+        klass.association_name = association_name
+        klass._parent = parent
 
-        [*fields].each { |field| field.apply(klass) }
+        [*fields].each { |field| klass.apply_custom_field(field) }
 
-        klass_with_custom_fields = klass
+        klass
       end
 
     end

data/lib/custom_fields/types/category.rb

@@ -29,11 +29,12 @@ module CustomFields
         end
 
         def apply_category_type(klass)
-          klass.cattr_accessor :"#{self.safe_alias}_items"
+          klass.class_eval <<-EOF
 
-          klass.send("#{self.safe_alias}_items=", self.ordered_category_items)
+            def self.#{self.safe_alias}_items
+              self.lookup_custom_field('#{self._name}').ordered_category_items
+            end
 
-          klass.class_eval <<-EOF
             def self.#{self.safe_alias}_names
               self.#{self.safe_alias}_items.collect(&:name)
             end
@@ -58,7 +59,6 @@ module CustomFields
             def #{self.safe_alias}=(id)
               category = self.class.#{self.safe_alias}_items.find { |item| item.name == id || item._id.to_s == id.to_s }
               category_id = category ? category._id : nil
-
               write_attribute(:#{self._name}, category_id)
             end
 

data/lib/custom_fields/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module CustomFields
-    VERSION = "1.0.0.beta2"
+    VERSION = "1.0.0.beta.3"
   end
 end

data/lib/custom_fields.rb

@@ -4,10 +4,8 @@ require 'active_support'
 require 'carrierwave/orm/mongoid'
 
 require 'custom_fields/version'
-require 'custom_fields/extensions/mongoid/hierarchy'
-require 'custom_fields/extensions/mongoid/associations/proxy'
-require 'custom_fields/extensions/mongoid/associations/references_many'
-require 'custom_fields/extensions/mongoid/associations/embeds_many'
+require 'custom_fields/extensions/mongoid/document'
+require 'custom_fields/extensions/mongoid/relations/accessors'
 require 'custom_fields/types/default'
 require 'custom_fields/types/string'
 require 'custom_fields/types/text'
@@ -17,6 +15,7 @@ require 'custom_fields/types/date'
 require 'custom_fields/types/file'
 require 'custom_fields/proxy_class_enabler'
 require 'custom_fields/field'
+require 'custom_fields/metadata'
 require 'custom_fields/custom_fields_for'
 
 module Mongoid
@@ -27,3 +26,7 @@ module Mongoid
     end
   end
 end
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.uncountable 'metadata'
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: custom_fields
 version: !ruby/object:Gem::Version 
-  hash: -1848230054
-  prerelease: true
+  hash: 62196357
+  prerelease: 6
   segments: 
   - 1
   - 0
   - 0
-  - beta2
-  version: 1.0.0.beta2
+  - beta
+  - 3
+  version: 1.0.0.beta.3
 platform: ruby
 authors: 
 - Didier Lafforgue
@@ -16,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-19 00:00:00 +02:00
+date: 2011-01-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,11 +83,10 @@ files:
 - MIT-LICENSE
 - README
 - lib/custom_fields/custom_fields_for.rb
-- lib/custom_fields/extensions/mongoid/associations/embeds_many.rb
-- lib/custom_fields/extensions/mongoid/associations/proxy.rb
-- lib/custom_fields/extensions/mongoid/associations/references_many.rb
-- lib/custom_fields/extensions/mongoid/hierarchy.rb
+- lib/custom_fields/extensions/mongoid/document.rb
+- lib/custom_fields/extensions/mongoid/relations/accessors.rb
 - lib/custom_fields/field.rb
+- lib/custom_fields/metadata.rb
 - lib/custom_fields/proxy_class_enabler.rb
 - lib/custom_fields/types/boolean.rb
 - lib/custom_fields/types/category.rb
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: nowarning
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Custom fields extension for Mongoid

data/lib/custom_fields/extensions/mongoid/associations/embeds_many.rb

@@ -1,31 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Associations #:nodoc:
-    class EmbedsMany < Proxy
-      
-      def initialize_with_custom_fields(parent, options, target_array = nil)
-        if custom_fields?(parent, options.name)
-          options = options.clone # 2 parent instances should not share the exact same option instance
-          
-          custom_fields = parent.send(:"ordered_#{custom_fields_association_name(options.name)}")
-        
-          klass = options.klass.to_klass_with_custom_fields(custom_fields)
-          klass._parent = parent
-          klass.association_name = options.name
-        
-          options.instance_eval <<-EOF
-            def klass=(klass); @klass = klass; end
-            def klass; @klass || class_name.constantize; end
-          EOF
-        
-          options.klass = klass
-        end
-        
-        initialize_without_custom_fields(parent, options, target_array)
-      end
-      
-      alias_method_chain :initialize, :custom_fields
-      
-    end
-  end
-end

data/lib/custom_fields/extensions/mongoid/associations/proxy.rb

@@ -1,20 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc
-  module Associations #:nodoc
-    class Proxy #:nodoc
-      
-      def custom_fields_association_name(association_name)
-        "#{association_name.to_s.singularize}_custom_fields".to_sym
-      end
-      
-      def custom_fields?(object, association_name)
-        object.respond_to?(custom_fields_association_name(association_name))
-      end
-      
-      def klass
-        @klass
-      end
-      
-    end
-  end
-end

data/lib/custom_fields/extensions/mongoid/associations/references_many.rb

@@ -1,33 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc:
-  module Associations #:nodoc:
-    # Represents an relational one-to-many association with an object in a
-    # separate collection or database.
-    class ReferencesMany < Proxy
-      
-      def initialize_with_custom_fields(parent, options, target_array = nil)
-        if custom_fields?(parent, options.name)
-          options = options.clone # 2 parent instances should not share the exact same option instance
-          
-          custom_fields = parent.send(:"ordered_#{custom_fields_association_name(options.name)}")
-          
-          klass = options.klass.to_klass_with_custom_fields(custom_fields)
-          klass._parent = parent
-          klass.association_name = options.name
-          
-          options.instance_eval <<-EOF
-            def klass=(klass); @klass = klass; end
-            def klass; @klass || class_name.constantize; end
-          EOF
-          
-          options.klass = klass
-        end
-        
-        initialize_without_custom_fields(parent, options, target_array)
-      end
-      
-      alias_method_chain :initialize, :custom_fields
-      
-    end
-  end
-end

data/lib/custom_fields/extensions/mongoid/hierarchy.rb

@@ -1,28 +0,0 @@
-# encoding: utf-8
-module Mongoid #:nodoc
-  module Hierarchy #:nodoc
-    module InstanceMethods
-      
-      def parentize_with_custom_fields(object, association_name)
-        if association_name.to_s.ends_with?('_custom_fields')
-          self.singleton_class.associations = {}
-          self.singleton_class.embedded_in object.class.to_s.underscore.to_sym, :inverse_of => association_name
-        end
-            
-        parentize_without_custom_fields(object, association_name)
-        
-        if self.embedded? && self.instance_variable_get(:"@association_name").nil?
-          self.instance_variable_set(:"@association_name", association_name) # weird bug with proxy class
-        end
-        
-        if association_name.to_s.ends_with?('_custom_fields')
-          self.send(:set_unique_name!)
-          self.send(:set_alias)
-        end
-      end
-      
-      alias_method_chain :parentize, :custom_fields
-      
-    end
-  end
-end