custom_fields 1.0.0.beta.4 → 1.0.0.beta.5

data/config/locales/de.yml

@@ -0,0 +1,9 @@
+de:
+  custom_fields:
+    kind:
+      string: Einfache Texteingabe
+      text: Text
+      category: Auswahlbox
+      boolean: Checkbox
+      date: Datum
+      file: Datei

data/config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  custom_fields:
+    kind:
+      string: Simple Input
+      text: Text
+      category: Select
+      boolean: Checkbox
+      date: Date
+      file: File

data/config/locales/fr.yml

@@ -0,0 +1,12 @@
+fr:
+  custom_fields:
+    kind:
+      string: Texte
+      text: Zone de texte
+      category: Liste déroulante
+      boolean: Case à cocher
+      date: Date
+      file: Fichier
+    text_formatting:
+      none: Aucun
+      html: HTML

data/config/locales/pt-BR.yml

@@ -0,0 +1,9 @@
+pt-BR:
+  custom_fields:
+    kind:
+      string: Texto Simples
+      text: Texto
+      category: Caixa de Seleção
+      boolean: Checkbox
+      date: Data
+      file: Arquivo

data/init.rb

@@ -1,2 +1,2 @@
-# Include hook code here
+# Init
 require File.dirname(__FILE__) + '/lib/custom_fields'

data/lib/custom_fields.rb

@@ -28,5 +28,19 @@ module Mongoid
 end
 
 ActiveSupport::Inflector.inflections do |inflect|
-  inflect.uncountable 'metadata'
+  inflect.irregular 'metadata', 'metadata'
 end
+
+# Load all the translation files
+I18n.load_path += Dir[File.join(File.dirname(__FILE__), '..', 'config', 'locales', '*.yml')]
+
+module MyBenchmark
+
+  def self.measure(caption, &block)
+    t1 = Time.now
+    returned_value = block.call
+    puts "[MyBenchmark] #{caption} took #{((Time.now - t1) * 1000).to_i} ms"
+    returned_value
+  end
+
+end

data/lib/custom_fields/custom_fields_for.rb

@@ -37,31 +37,61 @@ module CustomFields
       def custom_fields_for(collection_name)
         singular_name = collection_name.to_s.singularize
 
+        # generate the custom field for the couple defined by the class and the collection name
+        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
+
+        # enhance the class itself
         if (itself = %w(itself self).include?(collection_name.to_s))
-          singular_name = '_metadata'
+          collection_name, singular_name = '_metadata', 'metadata'
 
           class_eval <<-EOV
-            embeds_one :#{singular_name}, :class_name => '::CustomFields::Metadata'
+            embeds_one :#{collection_name}, :class_name => '::CustomFields::Metadata'
 
-            def metadata
-              self.#{singular_name} || self.build_#{singular_name}
+            def #{singular_name}
+              self.#{collection_name} || self.build_#{collection_name}
             end
 
           EOV
         end
 
+        # common part
         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 => '#{dynamic_custom_field_class_name}'
 
           validates_associated :#{singular_name}_custom_fields
 
+          after_validation do |record|
+            if record.errors.empty?
+              record.invalidate_#{singular_name}_klass
+            end
+          end
+          after_destroy     :invalidate_#{singular_name}_klass
+
           accepts_nested_attributes_for :#{singular_name}_custom_fields, :allow_destroy => true
 
           def ordered_#{singular_name}_custom_fields
             self.#{singular_name}_custom_fields.sort { |a, b| (a.position || 0) <=> (b.position || 0) }
           end
+
+          def fetch_#{singular_name}_klass
+            metadata = self.relations['#{collection_name.to_s}']
+            metadata.klass.to_klass_with_custom_fields(self.ordered_#{singular_name}_custom_fields, self, metadata.name)
+          end
+
+          def invalidate_#{singular_name}_klass
+            metadata = self.relations['#{collection_name.to_s}']
+            metadata.klass.invalidate_proxy_class_with_custom_fields(self, metadata.name)
+          end
         EOV
 
         if itself

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

@@ -16,12 +16,14 @@ module Mongoid # :nodoc:
       #
       # @since 2.0.0.rc.1
       def create_relation_with_custom_fields(object, metadata)
-        if custom_fields?(self, metadata.name)
+        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(metadata.name)}")
+          custom_fields = self.send(:"ordered_#{custom_fields_association_name(association_name)}")
 
-          klass = metadata.klass.to_klass_with_custom_fields(custom_fields, self, metadata.name)
+          klass = metadata.klass.to_klass_with_custom_fields(custom_fields, self, association_name)
 
           metadata.instance_variable_set(:@klass, klass)
         end

data/lib/custom_fields/field.rb

@@ -20,6 +20,7 @@ module CustomFields
     field :kind
     field :hint
     field :position, :type => Integer, :default => 0
+    field :required, :type => Boolean, :default => false
 
     ## validations ##
     validates_presence_of :label, :kind
@@ -27,28 +28,29 @@ module CustomFields
     validate :uniqueness_of_label_and_alias
 
     ## other accessors ##
-    attr_accessor :association_name # missing in 2.0.0 rc
+    attr_accessor :association_name # missing in 2.0.0 rc 7
+
+    attr_accessor :parentized_done # for performance purpose
+
+    ## callbacks ##
+    before_validation :set_alias
 
     ## methods ##
 
     def field_type
-      self.class.field_types[self.kind.downcase.to_sym]
+      self.class.field_types[self.safe_kind.to_sym]
     end
 
     def apply(klass)
-      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"
+      apply_method_name = :"apply_#{self.safe_kind}_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
@@ -56,6 +58,10 @@ module CustomFields
       self._alias
     end
 
+    def safe_kind
+      self.kind.downcase # for compatibility purpose: prior version of CustomFields used to have the value of kind in uppercase.
+    end
+
     def write_attributes_with_invalidation(attrs = nil)
       if self.association_name.to_s == '_metadata_custom_fields'
         target_name = 'metadata'
@@ -63,7 +69,7 @@ module CustomFields
         target_name = self.association_name.to_s.gsub('_custom_fields', '').pluralize
       end
 
-      klass = self._parent.send(target_name).metadata.klass
+      klass = self._parent.send(:"fetch_#{target_name.singularize}_klass")
 
       write_attributes_without_invalidation(attrs)
 
@@ -72,6 +78,21 @@ module CustomFields
 
     alias_method_chain :write_attributes, :invalidation
 
+    def to_hash(more = {})
+      self.fields.keys.inject({}) do |memo, meth|
+        memo[meth] = self.send(meth.to_sym); memo
+      end.merge({
+        'id'          => self._id,
+        'new_record'  => self.new_record?,
+        'errors'      => self.errors,
+        'kind_name'   => I18n.t("custom_fields.kind.#{self.safe_kind}")
+      }).merge(more)
+    end
+
+    def to_json
+      self.to_hash.to_json
+    end
+
     protected
 
     def uniqueness_of_label_and_alias
@@ -104,18 +125,17 @@ module CustomFields
     end
 
     def parentize_with_custom_fields(object)
+      return if self.parentized_done
+
       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)
+
+      self.parentized_done = true
     end
 
     alias_method_chain :parentize, :custom_fields

data/lib/custom_fields/proxy_class_enabler.rb

@@ -6,19 +6,31 @@ module CustomFields
     included do
 
       def self.to_klass_with_custom_fields(fields, parent, association_name)
-        target_name = "#{association_name}_proxy_class"
+        klass_name = self.klass_name_with_custom_fields(parent, association_name)
 
-        klass = parent.instance_variable_get(:"@#{target_name}")
+        klass = Object.const_defined?(klass_name) ? Object.const_get(klass_name): nil
 
         if klass.nil?
           klass = self.build_proxy_class_with_custom_fields(fields, parent, association_name)
 
-          parent.instance_variable_set(:"@#{target_name}", klass)
+          Object.const_set(klass_name, klass)
         end
 
         klass
       end
 
+      def self.invalidate_proxy_class_with_custom_fields(parent, association_name)
+        klass_name = self.klass_name_with_custom_fields(parent, association_name)
+
+        if Object.const_defined?(klass_name)
+          Object.send(:remove_const, klass_name)
+        end
+      end
+
+      def self.klass_name_with_custom_fields(parent, association_name)
+        "#{association_name.to_s.gsub(/^_/, '').singularize.camelize}#{parent.class.name.camelize}#{parent._id}"
+      end
+
       def self.build_proxy_class_with_custom_fields(fields, parent, association_name)
         (klass = Class.new(self)).class_eval <<-EOF
 
@@ -29,7 +41,9 @@ module CustomFields
           end
 
           def self.apply_custom_field(field)
-            return unless field.valid?
+            unless field.persisted?
+              return unless field.valid?
+            end
 
             (self.custom_fields ||= []) << field
 
@@ -66,7 +80,7 @@ module CustomFields
         # copy scopes from the parent class
         klass.write_inheritable_attribute(:scopes, self.scopes)
 
-        klass.association_name = association_name
+        klass.association_name = association_name.to_sym
         klass._parent = parent
 
         [*fields].each { |field| klass.apply_custom_field(field) }

data/lib/custom_fields/types/date.rb

@@ -1,35 +1,36 @@
 module CustomFields
   module Types
     module Date
-        
+
       extend ActiveSupport::Concern
-      
+
       included do
         register_type :date, ::Date
       end
-    
+
       module InstanceMethods
-        
+
         def apply_date_type(klass)
-          
+
           klass.class_eval <<-EOF
             def #{self.safe_alias}
               self.#{self._name}.strftime(I18n.t('date.formats.default')) rescue nil
             end
-            
+
             def #{self.safe_alias}=(value)
-              if value.is_a?(String)
+              if value.is_a?(::String)
                 date = ::Date._strptime(value, I18n.t('date.formats.default'))
-                value = Date.new(date[:year], date[:mon], date[:mday])
+                value = ::Date.new(date[:year], date[:mon], date[:mday])
               end
+
               self.#{self._name} = value
             end
           EOF
-          
+
         end
-          
+
       end
-    
+
     end
   end
 end

data/lib/custom_fields/types/default.rb

@@ -1,36 +1,41 @@
 module CustomFields
-  module Types        
+  module Types
     module Default
       extend ActiveSupport::Concern
-            
+
       included do
         cattr_accessor :field_types
-      end      
-            
+      end
+
       module InstanceMethods
-        
+
         def apply_default_type(klass)
           klass.class_eval <<-EOF
             alias :#{self.safe_alias} :#{self._name}
             alias :#{self.safe_alias}= :#{self._name}=
           EOF
+
+          # add validation if required field
+          if self.required?
+            klass.validates_presence_of self.safe_alias.to_sym
+          end
         end
-        
+
       end
-      
+
       module ClassMethods
 
         def register_type(kind, klass = ::String)
           self.field_types ||= {}
           self.field_types[kind.to_sym] = klass unless klass.nil?
-          
+
           self.class_eval <<-EOF
             def #{kind.to_s}?
               self.kind.downcase == '#{kind}' rescue false
             end
           EOF
         end
-        
+
       end
     end
   end

data/lib/custom_fields/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: custom_fields
 version: !ruby/object:Gem::Version 
-  hash: 62196363
+  hash: 62196361
   prerelease: 6
   segments: 
   - 1
   - 0
   - 0
   - beta
-  - 4
-  version: 1.0.0.beta.4
+  - 5
+  version: 1.0.0.beta.5
 platform: ruby
 authors: 
 - Didier Lafforgue
@@ -17,47 +17,46 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-27 00:00:00 +01:00
+date: 2011-03-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: mongoid
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15424089
+        hash: 15424091
         segments: 
         - 2
         - 0
         - 0
         - rc
-        - 6
-        version: 2.0.0.rc.6
+        - 7
+        version: 2.0.0.rc.7
   type: :runtime
-  version_requirements: *id001
+  requirement: *id001
+  name: mongoid
 - !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 15
         segments: 
         - 3
         - 0
-        - 0
-        version: 3.0.0
+        - 4
+        version: 3.0.4
   type: :runtime
-  version_requirements: *id002
+  requirement: *id002
+  name: activesupport
 - !ruby/object:Gem::Dependency 
-  name: locomotive_carrierwave
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -67,7 +66,8 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id003
+  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
@@ -97,6 +97,10 @@ files:
 - lib/custom_fields/types/text.rb
 - lib/custom_fields/version.rb
 - lib/custom_fields.rb
+- config/locales/de.yml
+- config/locales/en.yml
+- config/locales/fr.yml
+- config/locales/pt-BR.yml
 has_rdoc: true
 homepage: http://github.com/locomotivecms/custom_fields
 licenses: []