custom_fields 2.0.0.rc1 → 2.0.0.rc2

data/lib/custom_fields/extensions/mongoid/fields/i18n.rb

@@ -37,7 +37,7 @@ module Mongoid #:nodoc
       end
 
       def self.with_locale(new_locale = nil)
-        if tmp_locale
+        if new_locale
           current_locale  = self.locale
           self.locale     = new_locale
         end

data/lib/custom_fields/extensions/mongoid/fields/internal/localized.rb

@@ -45,8 +45,9 @@ module Mongoid #:nodoc:
           return nil if object.nil?
 
           # puts "deserializing...#{locale.inspect} / #{object.inspect}" # DEBUG
-
-          value = if I18n.fallbacks?
+          value = if !object.respond_to?(:keys) # if no translation hash is given, we return the object itself
+            object
+          elsif I18n.fallbacks?
             object[I18n.fallbacks[locale.to_sym].map(&:to_s).find { |loc| !object[loc].nil? }]
           else
             object[locale.to_s]
@@ -69,6 +70,7 @@ module Mongoid #:nodoc:
           # puts "serializing...#{locale} / #{object.inspect} / #{options.inspect}" # DEBUG
 
           value = self.original_field_type.serialize(object)
+
           { locale.to_s => value }
         end
 

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

@@ -18,8 +18,9 @@ module Mongoid #:nodoc
       #
       # @since 2.1.0
       def replace_field(name, type, localize = false)
+        # puts "fields[#{name}] = #{fields[name.to_s].inspect} / #{fields.keys.inspect}" # DEBUG
         defaults.delete_one(name)
-        add_field(name, fields[name].options.merge(:type => type, :localize => localize))
+        add_field(name, fields[name.to_s].options.merge(:type => type, :localize => localize))
       end
 
     end

data/lib/custom_fields/source.rb

@@ -12,189 +12,185 @@ module CustomFields
       attr_accessor :_custom_field_localize_diff
     end
 
-    module InstanceMethods
-
-      # Determines if the relation is enhanced by the custom fields
-      #
-      # @example the Person class has somewhere in its code this: "custom_fields_for :addresses"
-      #   person.custom_fields_for?(:addresses)
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      #
-      # @return [ true, false ] True if enhanced, false if not.
-      #
-      def custom_fields_for?(name)
-        self.class.custom_fields_for?(name)
-      end
-
-      # Returns the class enhanced by the custom fields.
-      # Be careful, call this method only if the source class
-      # has been saved with success.
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      #
-      # @return [ Class ] The modified class.
-      #
-      def klass_with_custom_fields(name)
-        recipe = self.custom_fields_recipe_for(name)
-        target = self.send(name).metadata.klass
-        target.klass_with_custom_fields(recipe)
-      end
+    # Determines if the relation is enhanced by the custom fields
+    #
+    # @example the Person class has somewhere in its code this: "custom_fields_for :addresses"
+    #   person.custom_fields_for?(:addresses)
+    #
+    # @param [ String, Symbol ] name The name of the relation.
+    #
+    # @return [ true, false ] True if enhanced, false if not.
+    #
+    def custom_fields_for?(name)
+      self.class.custom_fields_for?(name)
+    end
 
-      # Returns the ordered list of custom fields for a relation
-      #
-      # @example the Person class has somewhere in its code this: "custom_fields_for :addresses"
-      #   person.ordered_custom_fields(:addresses)
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      #
-      # @return [ Collection ] The ordered list.
-      #
-      def ordered_custom_fields(name)
-        self.send(:"#{name}_custom_fields").sort { |a, b| (a.position || 0) <=> (b.position || 0) }
-      end
+    # Returns the class enhanced by the custom fields.
+    # Be careful, call this method only if the source class
+    # has been saved with success.
+    #
+    # @param [ String, Symbol ] name The name of the relation.
+    #
+    # @return [ Class ] The modified class.
+    #
+    def klass_with_custom_fields(name)
+      recipe = self.custom_fields_recipe_for(name)
+      target = self.send(name).metadata.klass
+      target.klass_with_custom_fields(recipe)
+    end
 
-      # Returns the recipe (meaning all the rules) needed to
-      # build the custom klass
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      #
-      # @return [ Array ] An array of hashes
-      #
-      def custom_fields_recipe_for(name)
-        {
-          'name'     => "#{name.to_s.classify}#{self._id}",
-          'rules'    => self.ordered_custom_fields(name).map(&:to_recipe),
-          'version'  => self.custom_fields_version(name)
-        }
-      end
+    # Returns the ordered list of custom fields for a relation
+    #
+    # @example the Person class has somewhere in its code this: "custom_fields_for :addresses"
+    #   person.ordered_custom_fields(:addresses)
+    #
+    # @param [ String, Symbol ] name The name of the relation.
+    #
+    # @return [ Collection ] The ordered list.
+    #
+    def ordered_custom_fields(name)
+      self.send(:"#{name}_custom_fields").sort { |a, b| (a.position || 0) <=> (b.position || 0) }
+    end
 
-      # Returns the number of the version for relation with custom fields
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      #
-      # @return [ Integer ] The version number
-      #
-      def custom_fields_version(name)
-        self.send(:"#{name}_custom_fields_version") || 0
-      end
+    # Returns the recipe (meaning all the rules) needed to
+    # build the custom klass
+    #
+    # @param [ String, Symbol ] name The name of the relation.
+    #
+    # @return [ Array ] An array of hashes
+    #
+    def custom_fields_recipe_for(name)
+      {
+        'name'     => "#{name.to_s.classify}#{self._id}",
+        'rules'    => self.ordered_custom_fields(name).map(&:to_recipe),
+        'version'  => self.custom_fields_version(name)
+      }
+    end
 
-      # When the fields have been modified and before the object is saved,
-      # we bump the version.
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      #
-      def bump_custom_fields_version(name)
-        version = self.custom_fields_version(name) + 1
-        self.send(:"#{name}_custom_fields_version=", version)
-      end
+    # Returns the number of the version for relation with custom fields
+    #
+    # @param [ String, Symbol ] name The name of the relation.
+    #
+    # @return [ Integer ] The version number
+    #
+    def custom_fields_version(name)
+      self.send(:"#{name}_custom_fields_version") || 0
+    end
 
-      # Change the metadata of a relation enhanced by the custom fields.
-      # In Mongoid, all the instances of a same document share the same metadata objects.
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      #
-      def refresh_metadata_with_custom_fields(name)
-        return if !self.persisted? || self.send(:"#{name}_custom_fields").blank? # do not generate a klass without all the information
+    # When the fields have been modified and before the object is saved,
+    # we bump the version.
+    #
+    # @param [ String, Symbol ] name The name of the relation.
+    #
+    def bump_custom_fields_version(name)
+      version = self.custom_fields_version(name) + 1
+      self.send(:"#{name}_custom_fields_version=", version)
+    end
 
-        old_metadata = self.send(name).metadata
+    # Change the metadata of a relation enhanced by the custom fields.
+    # In Mongoid, all the instances of a same document share the same metadata objects.
+    #
+    # @param [ String, Symbol ] name The name of the relation.
+    #
+    def refresh_metadata_with_custom_fields(name)
+      return if !self.persisted? || self.send(:"#{name}_custom_fields").blank? # do not generate a klass without all the information
 
-        # puts "old_metadata = #{old_metadata.klass.inspect} / #{old_metadata.object_id.inspect}" # DEBUG
+      old_metadata = self.send(name).metadata
 
-        self.send(name).metadata = old_metadata.clone.tap do |metadata|
-          metadata.instance_variable_set(:@klass, self.klass_with_custom_fields(name))
-        end
+      # puts "old_metadata = #{old_metadata.klass.inspect} / #{old_metadata.object_id.inspect}" # DEBUG
 
-        # puts "new_metadata = #{self.send(name).metadata.klass.inspect} / #{self.send(name).metadata.object_id.inspect}" # DEBUG
+      self.send(name).metadata = old_metadata.clone.tap do |metadata|
+        metadata.instance_variable_set(:@klass, self.klass_with_custom_fields(name))
       end
 
-      # Initializes the object tracking the modifications
-      # of the custom fields
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      #
-      def initialize_custom_fields_diff(name)
-        self._custom_field_localize_diff ||= Hash.new([])
+      # puts "new_metadata = #{self.send(name).metadata.klass.inspect} / #{self.send(name).metadata.object_id.inspect}" # DEBUG
+    end
 
-        self._custom_fields_diff ||= {}
-        self._custom_fields_diff[name] = { '$set' => {}, '$unset' => {}, '$rename' => {} }
-      end
+    # Initializes the object tracking the modifications
+    # of the custom fields
+    #
+    # @param [ String, Symbol ] name The name of the relation.
+    #
+    def initialize_custom_fields_diff(name)
+      self._custom_field_localize_diff ||= Hash.new([])
 
-      # Collects all the modifications of the custom fields
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      #
-      # @return [ Array ] An array of hashes storing the modifications
-      #
-      def collect_custom_fields_diff(name, fields)
-        # puts "==> collect_custom_fields_diff for #{name}, #{fields.size}" # DEBUG
+      self._custom_fields_diff ||= {}
+      self._custom_fields_diff[name] = { '$set' => {}, '$unset' => {}, '$rename' => {} }
+    end
 
-        memo = self.initialize_custom_fields_diff(name)
+    # Collects all the modifications of the custom fields
+    #
+    # @param [ String, Symbol ] name The name of the relation.
+    #
+    # @return [ Array ] An array of hashes storing the modifications
+    #
+    def collect_custom_fields_diff(name, fields)
+      # puts "==> collect_custom_fields_diff for #{name}, #{fields.size}" # DEBUG
 
-        fields.map do |field|
-          field.collect_diff(memo)
-        end
+      memo = self.initialize_custom_fields_diff(name)
 
-        # collect fields with a modified localized field
-        fields.each do |field|
-          if field.localized_changed? && field.persisted?
-            self._custom_field_localize_diff[name] << { :field => field.name, :localized => field.localized? }
-          end
+      fields.map do |field|
+        field.collect_diff(memo)
+      end
+
+      # collect fields with a modified localized field
+      fields.each do |field|
+        if field.localized_changed? && field.persisted?
+          self._custom_field_localize_diff[name] << { :field => field.name, :localized => field.localized? }
         end
       end
+    end
 
-      # Apply the modifications collected from the custom fields by
-      # updating all the documents of the relation.
-      # The update uses the power of mongodb to make it fully optimized.
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      #
-      def apply_custom_fields_diff(name)
-        # puts "==> apply_custom_fields_recipes for #{name}, #{self._custom_fields_diff[name].inspect}" # DEBUG
+    # Apply the modifications collected from the custom fields by
+    # updating all the documents of the relation.
+    # The update uses the power of mongodb to make it fully optimized.
+    #
+    # @param [ String, Symbol ] name The name of the relation.
+    #
+    def apply_custom_fields_diff(name)
+      # puts "==> apply_custom_fields_recipes for #{name}, #{self._custom_fields_diff[name].inspect}" # DEBUG
 
-        operations = self._custom_fields_diff[name]
-        operations['$set'].merge!({ 'custom_fields_recipe.version' => self.custom_fields_version(name) })
-        collection, selector = self.send(name).collection, self.send(name).criteria.selector
+      operations = self._custom_fields_diff[name]
+      operations['$set'].merge!({ 'custom_fields_recipe.version' => self.custom_fields_version(name) })
+      collection, selector = self.send(name).collection, self.send(name).criteria.selector
 
-        # puts "selector = #{selector.inspect}, memo = #{attributes.inspect}" # DEBUG
+      # puts "selector = #{selector.inspect}, memo = #{attributes.inspect}" # DEBUG
 
-        collection.update selector, operations, :multi => true
-      end
+      collection.update selector, operations, :multi => true
+    end
 
-      # If the localized attribute has been changed in at least one of the custom fields,
-      # we have to upgrade all the records enhanced by custom_fields in order to make
-      # the values consistent with the mongoid localize option.
-      #
-      # Ex: post.attributes[:name] = 'Hello world' => post.attributes[:name] = { :en => 'Hello world' }
-      #
-      # @param [ String, Symbol ] name The name of the relation.
-      #
-      def apply_custom_fields_localize_diff(name)
-        return if self._custom_field_localize_diff[name].empty?
-
-        self.send(name).all.each do |record|
-          updates = {}
-
-          # puts "[apply_custom_fields_localize_diff] processing: record #{record._id} / #{self._custom_field_localize_diff[name].inspect}" # DEBUG
-          self._custom_field_localize_diff[name].each do |changes|
-            if changes[:localized]
-              value = record.read_attribute(changes[:field].to_sym)
-              updates[changes[:field]] = { I18n.locale.to_s => value }
-            else
-              # the other way around
-              value = record.read_attribute(changes[:field].to_sym)
-              next if value.nil?
-              updates[changes[:field]] = value[I18n.locale.to_s]
-            end
+    # If the localized attribute has been changed in at least one of the custom fields,
+    # we have to upgrade all the records enhanced by custom_fields in order to make
+    # the values consistent with the mongoid localize option.
+    #
+    # Ex: post.attributes[:name] = 'Hello world' => post.attributes[:name] = { :en => 'Hello world' }
+    #
+    # @param [ String, Symbol ] name The name of the relation.
+    #
+    def apply_custom_fields_localize_diff(name)
+      return if self._custom_field_localize_diff[name].empty?
+
+      self.send(name).all.each do |record|
+        updates = {}
+
+        # puts "[apply_custom_fields_localize_diff] processing: record #{record._id} / #{self._custom_field_localize_diff[name].inspect}" # DEBUG
+        self._custom_field_localize_diff[name].each do |changes|
+          if changes[:localized]
+            value = record.read_attribute(changes[:field].to_sym)
+            updates[changes[:field]] = { I18n.locale.to_s => value }
+          else
+            # the other way around
+            value = record.read_attribute(changes[:field].to_sym)
+            next if value.nil?
+            updates[changes[:field]] = value[I18n.locale.to_s]
           end
+        end
 
-          next if updates.empty?
+        next if updates.empty?
 
-          collection = self.send(name).collection
-          collection.update record.atomic_selector, { '$set' => updates }
-        end
+        collection = self.send(name).collection
+        collection.update record.atomic_selector, { '$set' => updates }
       end
-
     end
 
     module ClassMethods

data/lib/custom_fields/target.rb

@@ -16,10 +16,6 @@ module CustomFields
 
     end
 
-    module InstanceMethods
-
-    end
-
     module ClassMethods
 
       # A document with custom fields always returns true.
@@ -45,7 +41,7 @@ module CustomFields
           klass.version = recipe['version']
 
           # copy scopes from the parent class (scopes does not inherit automatically from the parents in mongoid)
-          klass.write_inheritable_attribute(:scopes, self.scopes)
+          # klass.write_inheritable_attribute(:scopes, self.scopes) # not needed it
 
           recipe['rules'].each do |rule|
             self.send(:"apply_#{rule['type']}_custom_field", klass, rule)

data/lib/custom_fields/types/date.rb

@@ -33,23 +33,19 @@ module CustomFields
 
         end
 
-        module InstanceMethods
+        protected
 
-          protected
-
-          def _set_formatted_date(name, value)
-            if value.is_a?(::String) && !value.blank?
-              date  = ::Date._strptime(value, I18n.t('date.formats.default'))
-              value = ::Date.new(date[:year], date[:mon], date[:mday])
-            end
-
-            self.send(:"#{name}=", value)
+        def _set_formatted_date(name, value)
+          if value.is_a?(::String) && !value.blank?
+            date  = ::Date._strptime(value, I18n.t('date.formats.default'))
+            value = ::Date.new(date[:year], date[:mon], date[:mday])
           end
 
-          def _get_formatted_date(name)
-            self.send(name.to_sym).strftime(I18n.t('date.formats.default')) rescue nil
-          end
+          self.send(:"#{name}=", value)
+        end
 
+        def _get_formatted_date(name)
+          self.send(name.to_sym).strftime(I18n.t('date.formats.default')) rescue nil
         end
 
       end

data/lib/custom_fields/types/select.rb

@@ -35,24 +35,20 @@ module CustomFields
 
         end
 
-        module InstanceMethods
-
-          def ordered_select_options
-            self.select_options.sort { |a, b| (a.position || 0) <=> (b.position || 0) }.to_a
-          end
-
-          def select_to_recipe
-            {
-              'select_options' => self.ordered_select_options.map do |option|
-                { '_id' => option._id, 'name' => option.name_translations }
-              end
-            }
-          end
+        def ordered_select_options
+          self.select_options.sort { |a, b| (a.position || 0) <=> (b.position || 0) }.to_a
+        end
 
-          def select_as_json(options = {})
-            { 'select_options' => self.ordered_select_options.map(&:as_json) }
-          end
+        def select_to_recipe
+          {
+            'select_options' => self.ordered_select_options.map do |option|
+              { '_id' => option._id, 'name' => option.name_translations }
+            end
+          }
+        end
 
+        def select_as_json(options = {})
+          { 'select_options' => self.ordered_select_options.map(&:as_json) }
         end
 
       end
@@ -151,28 +147,24 @@ module CustomFields
 
         end
 
-        module InstanceMethods
-
-          def _select_option_id(name)
-            self.send(:"#{name}_id")
-          end
-
-          def _find_select_option(name, id_or_name)
-            self.class._select_options(name).detect do |option|
-              option['name'] == id_or_name || option['_id'].to_s == id_or_name.to_s
-            end
-          end
+        def _select_option_id(name)
+          self.send(:"#{name}_id")
+        end
 
-          def _get_select_option(name)
-            option = self._find_select_option(name, self._select_option_id(name))
-            option ? option['name'] : nil
+        def _find_select_option(name, id_or_name)
+          self.class._select_options(name).detect do |option|
+            option['name'] == id_or_name || option['_id'].to_s == id_or_name.to_s
           end
+        end
 
-          def _set_select_option(name, value)
-            option = self._find_select_option(name, value)
-            self.send(:"#{name}_id=", option ? option['_id'] : nil)
-          end
+        def _get_select_option(name)
+          option = self._find_select_option(name, self._select_option_id(name))
+          option ? option['name'] : nil
+        end
 
+        def _set_select_option(name, value)
+          option = self._find_select_option(name, value)
+          self.send(:"#{name}_id=", option ? option['_id'] : nil)
         end
 
       end

data/lib/custom_fields/version.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
 module CustomFields #:nodoc
-  VERSION = "2.0.0.rc1"
+
+  VERSION = '2.0.0.rc2'
+
 end