custom_fields 1.0.0.beta.14 → 1.0.0.beta.15

data/README.textile

@@ -4,7 +4,7 @@ Manage custom fields to a mongoid document or a collection. This module is one o
 
 h2. Requirements
 
-ActiveSupport 3.0.7, MongoDB 1.6 and Mongoid 2.0.1
+ActiveSupport 3.0.7, MongoDB 1.6 and Mongoid 2.0.2
 
 
 h2. Example

data/lib/custom_fields/custom_fields_for.rb

@@ -2,8 +2,31 @@ module CustomFields
 
   module CustomFieldsFor
 
-    def self.included(base)
-      base.extend(ClassMethods)
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :custom_fields
+
+      self.custom_fields = []
+    end
+
+    module InstanceMethods
+
+      def custom_fields?(collection_name)
+        self.class.custom_fields?(collection_name)
+      end
+
+      def clone_metadata_for_custom_fields(metadata)
+        singular_name = metadata.name.to_s.singularize.gsub(/^_/, '')
+
+        klass = self.send(:"fetch_#{singular_name}_klass")
+
+        # safer to do that because we are going to modify the metadata klass for next operations
+        metadata.clone.tap do |metadata|
+          metadata.instance_variable_set(:@klass, klass)
+        end
+      end
+
     end
 
     # Enhance an embedded collection OR the instance itself (by passing self) by providing methods to manage custom fields.
@@ -34,19 +57,15 @@ module CustomFields
     #
     module ClassMethods
 
-      def custom_fields_for(collection_name)
-        singular_name = collection_name.to_s.singularize
+      def custom_fields?(collection_name)
+        self.custom_fields.include?(collection_name.to_s)
+      end
 
-        # generate the custom field for the couple defined by the class and the collection name
+      def custom_fields_for(collection_name)
+        singular_name                   = collection_name.to_s.singularize
         dynamic_custom_field_class_name = "#{self.name}#{singular_name.camelize}Field"
 
-        unless Object.const_defined?(dynamic_custom_field_class_name)
-          (klass = Class.new(::CustomFields::Field)).class_eval <<-EOF
-            embedded_in :#{self.name.underscore}, :inverse_of => :#{singular_name}_custom_fields
-          EOF
-
-          Object.const_set(dynamic_custom_field_class_name, klass)
-        end
+        self.declare_embedded_in_definition_in_custom_field(collection_name)
 
         # enhance the class itself
         if (itself = %w(itself self).include?(collection_name.to_s))
@@ -58,10 +77,12 @@ module CustomFields
             def safe_#{singular_name}
               self.#{collection_name} || self.build_#{collection_name}
             end
-
           EOV
         end
 
+        # record the collection_name
+        self.custom_fields << collection_name.to_s
+
         # common part
         class_eval <<-EOV
           field :#{singular_name}_custom_fields_counter, :type => Integer, :default => 0
@@ -141,6 +162,29 @@ module CustomFields
 
       end
 
+      protected
+
+      def dynamic_custom_field_class_name(collection_name)
+        "#{self.name}#{collection_name.to_s.singularize.camelize}Field"
+      end
+
+      # An embedded relationship has to be defined on both side in order for it
+      # to work properly. But because custom_field can be embedded in different
+      # models that it's not aware of, we have to declare manually the definition
+      # once we know the target class.
+      def declare_embedded_in_definition_in_custom_field(target_collection_name)
+        singular_name   = target_collection_name.to_s.singularize
+        klass_name      = self.dynamic_custom_field_class_name(target_collection_name)
+
+        unless Object.const_defined?(klass_name)
+          (klass = Class.new(::CustomFields::Field)).class_eval <<-EOF
+            embedded_in :#{self.name.underscore}, :inverse_of => :#{singular_name}_custom_fields
+          EOF
+
+          Object.const_set(klass_name, klass)
+        end
+      end
+
     end
 
   end

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

@@ -16,31 +16,14 @@ module Mongoid # :nodoc:
       #
       # @since 2.0.0.rc.1
       def create_relation_with_custom_fields(object, metadata)
-        association_name = metadata.name.to_s.gsub(/^_/, '')
-
-        if custom_fields?(self, association_name)
-          metadata = metadata.clone # 2 parent instances should not share the exact same option instance
-
-          custom_fields = self.send(:"ordered_#{custom_fields_association_name(association_name)}")
-
-          klass = metadata.klass.to_klass_with_custom_fields(custom_fields, self, association_name)
-
-          metadata.instance_variable_set(:@klass, klass)
+        if self.respond_to?(:custom_fields?) && self.custom_fields?(metadata.name)
+          metadata = self.clone_metadata_for_custom_fields(metadata)
         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

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

@@ -0,0 +1,27 @@
+module Mongoid # :nodoc:
+  module Relations #:nodoc:
+
+    module Builders
+      extend ActiveSupport::Concern
+
+      module ClassMethods #:nodoc:
+
+        def builder_with_custom_fields(name, metadata)
+          tap do
+            define_method("build_#{name}") do |*args|
+              if self.custom_fields?(metadata.name)
+                metadata = self.clone_metadata_for_custom_fields(metadata)
+              end
+
+              document = Factory.build(metadata.klass, args.first || {})
+              send("#{name}=", document, :binding => true)
+            end
+          end
+        end
+
+        alias_method_chain :builder, :custom_fields
+
+      end
+    end
+  end
+end

data/lib/custom_fields/version.rb

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

data/lib/custom_fields.rb

@@ -4,24 +4,25 @@ require 'active_support'
 require 'carrierwave/orm/mongoid'
 
 module CustomFields
-  
+
   @@options = {
     :reserved_aliases => Mongoid.destructive_fields
   }
-  
+
   def self.options=(options)
     @@options.merge!(options)
   end
-  
+
   def self.options
     @@options
   end
-  
+
 end
 
 require 'custom_fields/version'
 require 'custom_fields/extensions/mongoid/document'
 require 'custom_fields/extensions/mongoid/relations/accessors'
+require 'custom_fields/extensions/mongoid/relations/builders'
 require 'custom_fields/types/default'
 require 'custom_fields/types/string'
 require 'custom_fields/types/text'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: custom_fields
 version: !ruby/object:Gem::Version 
-  hash: 62196383
+  hash: 62196381
   prerelease: 6
   segments: 
   - 1
   - 0
   - 0
   - beta
-  - 14
-  version: 1.0.0.beta.14
+  - 15
+  version: 1.0.0.beta.15
 platform: ruby
 authors: 
 - Didier Lafforgue
@@ -17,27 +17,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-04 00:00:00 +02:00
-default_executable: 
+date: 2011-06-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: mongoid
   prerelease: false
+  type: :runtime
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 11
         segments: 
         - 2
         - 0
-        - 1
-        version: 2.0.1
-  type: :runtime
+        - 2
+        version: 2.0.2
   requirement: *id001
-  name: mongoid
 - !ruby/object:Gem::Dependency 
+  name: activesupport
   prerelease: false
+  type: :runtime
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -49,11 +50,11 @@ dependencies:
         - 0
         - 7
         version: 3.0.7
-  type: :runtime
   requirement: *id002
-  name: activesupport
 - !ruby/object:Gem::Dependency 
+  name: locomotive_carrierwave
   prerelease: false
+  type: :runtime
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -63,9 +64,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
   requirement: *id003
-  name: locomotive_carrierwave
 description: Manage custom fields to a mongoid document or a collection. This module is one of the core features we implemented in our custom cms named Locomotive.
 email: 
 - didier@nocoffee.fr
@@ -83,6 +82,7 @@ files:
 - lib/custom_fields/custom_fields_for.rb
 - lib/custom_fields/extensions/mongoid/document.rb
 - lib/custom_fields/extensions/mongoid/relations/accessors.rb
+- lib/custom_fields/extensions/mongoid/relations/builders.rb
 - lib/custom_fields/field.rb
 - lib/custom_fields/metadata.rb
 - lib/custom_fields/proxy_class_enabler.rb
@@ -101,7 +101,6 @@ files:
 - config/locales/en.yml
 - config/locales/fr.yml
 - config/locales/pt-BR.yml
-has_rdoc: true
 homepage: http://github.com/locomotivecms/custom_fields
 licenses: []
 
@@ -133,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: nowarning
-rubygems_version: 1.4.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Custom fields extension for Mongoid