custom_fields 2.1.0 → 2.2.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 [Didier Lafforgue]
+Copyright (c) 2013 [Didier Lafforgue]
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.textile

@@ -2,7 +2,7 @@
 
 h1. CustomFields
 
-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.
+Manage custom fields to a mongoid document or a collection. This module is one of the core features we implemented in our custom cms, LocomotiveCMS.
 Basically, its aim is to provide to editors a way to manage extra fields to a Mongoid document through, for instance, a web UI.
 
 The main goals:
@@ -12,7 +12,7 @@ The main goals:
 
 h2. Requirements
 
-ActiveSupport 3.2.9, MongoDB 2.0 and Mongoid 2.4.12
+ActiveSupport 3.2.13, MongoDB 2.0 and Mongoid 3.1.3
 
 h2. Examples
 
@@ -42,7 +42,7 @@ company.save
 company.employees.build :name => 'Michael Scott', :position => 'Regional manager'
 
 another_company = Company.new
-employee = company.employees.build
+employee = another_company.employees.build
 employee.position # returns a "not defined method" error
 
 h3. On the class itself
@@ -67,4 +67,4 @@ h2. Contact
 
 Feel free to contact me at didier at nocoffee dot fr.
 
-Copyright (c) 2012 NoCoffee, released under the MIT license
+Copyright (c) 2013 NoCoffee, released under the MIT license

data/config/locales/de.yml

@@ -1,9 +1,15 @@
 de:
   custom_fields:
     type:
-      string: Einfache Texteingabe
-      text: Text
-      select: Auswahlbox
-      boolean: Checkbox
+      string: Einfacher Text
+      text: Formatierter Text
+      select: Auswahl-Liste
+      boolean: Auswahl-Box
+      integer: Ganzzahl
+      float: Fließkommazahl
+      money: Währung
       date: Datum
-      file: Datei
+      file: Datei
+      belongs_to: gehört zu
+      has_many: Hat viele
+      many_to_many: Hat und gehört zu vielen

data/config/locales/en.yml

@@ -6,7 +6,11 @@ en:
       select: Select
       boolean: Checkbox
       date: Date
+      integer: Integer
       file: File
+      integer: Integer
+      float: Float
+      money: Money
       belongs_to: Belongs to
       has_many: Has many
       many_to_many: Many To Many

data/config/locales/fr.yml

@@ -6,7 +6,11 @@ fr:
       select: Liste déroulante
       boolean: Case à cocher
       date: Date
+      integer: Nombre
       file: Fichier
+      integer: Entier
+      float: Décimal
+      money: Monnaie
       belongs_to: Appartient à
       has_many: A plusieurs
       many_to_many: A plusieurs et appartient à

data/config/locales/ru.yml

@@ -0,0 +1,15 @@
+ru:
+  custom_fields:
+    type:
+      string: Простая строка
+      text: Текст
+      select: Выбор
+      boolean: Чекбокс
+      date: Дата
+      file: Файл
+      integer: Целое число
+      float:  Число с дробной частью
+      money: Деньги
+      belongs_to: Относится к
+      has_many: Имеет много
+      many_to_many: Многие ко многим

data/lib/custom_fields.rb

@@ -2,11 +2,13 @@ $:.unshift File.expand_path(File.dirname(__FILE__))
 
 require 'active_support'
 require 'carrierwave/mongoid'
+require 'money'
 
 module CustomFields
 
   @@options = {
-    :reserved_names => Mongoid.destructive_fields + %w(id _id send class)
+    reserved_names:     Mongoid.destructive_fields + %w(id _id send class),
+    default_currency:   'EUR'
   }
 
   def self.options=(options)
@@ -19,31 +21,39 @@ module CustomFields
 
 end
 
-require 'custom_fields/version'
-require 'custom_fields/extensions/active_support'
-require 'custom_fields/extensions/carrierwave'
-require 'custom_fields/extensions/mongoid/document'
-require 'custom_fields/extensions/mongoid/factory'
-require 'custom_fields/extensions/mongoid/relations/referenced/many'
-require 'custom_fields/extensions/mongoid/relations/referenced/in'
-require 'custom_fields/extensions/mongoid/fields.rb'
-require 'custom_fields/extensions/mongoid/fields/i18n.rb'
-require 'custom_fields/extensions/mongoid/fields/internal/localized.rb'
-require 'custom_fields/types/default'
-require 'custom_fields/types/string'
-require 'custom_fields/types/text'
-require 'custom_fields/types/date'
-require 'custom_fields/types/boolean'
-require 'custom_fields/types/file'
-require 'custom_fields/types/select'
-require 'custom_fields/types/relationship_default'
-require 'custom_fields/types/belongs_to'
-require 'custom_fields/types/has_many'
-require 'custom_fields/types/many_to_many'
-require 'custom_fields/field'
-require 'custom_fields/source'
-require 'custom_fields/target_helpers'
-require 'custom_fields/target'
+%w(  version
+     extensions/active_support
+     extensions/carrierwave
+     extensions/mongoid/document
+     extensions/mongoid/factory
+     extensions/mongoid/relations/referenced/many
+     extensions/mongoid/relations/referenced/in
+     extensions/mongoid/fields.rb
+     extensions/mongoid/fields/i18n.rb
+     extensions/mongoid/fields/localized.rb
+     types/default
+     types/string
+     types/text
+     types/email
+     types/date
+     types/boolean
+     types/file
+     types/select
+     types/integer
+     types/float
+     types/money
+     types/relationship_default
+     types/belongs_to
+     types/has_many
+     types/many_to_many
+     types/tags
+     field
+     source
+     target_helpers
+     target
+    ).each do |lib|
+      require_relative "./custom_fields/#{lib}"
+    end
 
 # Load all the translation files
 I18n.load_path += Dir[File.join(File.dirname(__FILE__), '..', 'config', 'locales', '*.yml')]
@@ -57,4 +67,4 @@ module MyBenchmark
     returned_value
   end
 
-end
+end

data/lib/custom_fields/extensions/active_support.rb

@@ -25,4 +25,4 @@ class String
   end
 
   alias_method_chain :constantize, :custom_fields
-end
+end

data/lib/custom_fields/extensions/carrierwave.rb

@@ -12,7 +12,7 @@ module CarrierWave
 
         value = read_attribute(name.to_sym)
         unless value.nil?
-          self.class.fields[name.to_s].deserialize(value)
+          self.class.fields[name.to_s].demongoize(value)
         else
           nil
         end
@@ -22,4 +22,4 @@ module CarrierWave
     alias_method_chain :mount_uploader, :localization
   end
 
-end
+end

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

@@ -4,11 +4,11 @@ module Mongoid #:nodoc:
   # Instantiates documents that came from the database.
   module Factory
 
-    def from_db_with_custom_fields(klass, attributes = {})
+    def from_db_with_custom_fields(klass, attributes = {}, criteria_instance_id = nil)
       if klass.with_custom_fields?
         klass.klass_with_custom_fields(attributes['custom_fields_recipe'])
       end
-      from_db_without_custom_fields(klass, attributes)
+      from_db_without_custom_fields(klass, attributes, criteria_instance_id)
     end
 
     # equivalent for "alias_method_chain :from_db, :custom_fields"
@@ -17,4 +17,4 @@ module Mongoid #:nodoc:
 
   end
 
-end
+end

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

@@ -19,12 +19,13 @@ 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.to_s].options.merge(:type => type, :localize => localize))
+        #attribute_names.delete_one(name)
+        remove_defaults(name)
+        add_field(name, fields[name.to_s].options.merge(type: type, localize: localize))
       end
 
     end
 
   end
 
-end
+end

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

@@ -0,0 +1,39 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+
+    # The behaviour of the Localized fields in the custom fields gem is different
+    # because we do not rely on I18n directly but on a slight version Mongoid::Fields::I18n.
+    # The main reason is only practical to handle the following case:
+    # -> Back-office in English and editing content in French.
+    #
+    # TODO: use this gem instead https://github.com/simi/mongoid-localizer
+    #
+    class Localized < Standard
+
+      def mongoize(object)
+        { locale.to_s => type.mongoize(object) }
+      end
+
+      private
+
+      def lookup(object)
+        if !object.respond_to?(:keys) # if no translation hash is given, we return the object itself
+          object
+        elsif object.has_key?(locale.to_s)
+          object[locale.to_s]
+        elsif I18n.fallbacks?
+          object[I18n.fallbacks[locale].map(&:to_s).find { |loc| !object[loc].nil? }]
+        else
+          nil
+        end
+      end
+
+      def locale
+        # be careful, it does not return ::I18n.locale
+        I18n.locale
+      end
+
+    end
+  end
+end

data/lib/custom_fields/extensions/mongoid/relations/referenced/in.rb

@@ -17,4 +17,4 @@ module Mongoid # :nodoc:
 
     end
   end
-end
+end

data/lib/custom_fields/extensions/mongoid/relations/referenced/many.rb

@@ -14,13 +14,13 @@ module Mongoid #:nodoc:
 
             attributes ||= {}
 
-            attributes.merge!(:custom_fields_recipe => recipe)
+            attributes.merge!(custom_fields_recipe: recipe)
 
             # build the class with custom_fields for the first time
             type = metadata.klass.klass_with_custom_fields(recipe)
           end
-
           build_without_custom_fields(attributes, options, type)
+
         end
 
         alias_method_chain :build, :custom_fields
@@ -31,4 +31,4 @@ module Mongoid #:nodoc:
 
     end
   end
-end
+end

data/lib/custom_fields/field.rb

@@ -6,7 +6,8 @@ module CustomFields
     include ::Mongoid::Timestamps
 
     ## types ##
-    %w(default string text date boolean file select relationship_default belongs_to has_many many_to_many).each do |type|
+    %w(default string text email date boolean file select float integer money
+       relationship_default belongs_to has_many many_to_many).each do |type|
       include "CustomFields::Types::#{type.classify}::Field".constantize
     end
 
@@ -15,14 +16,15 @@ module CustomFields
     field :name
     field :type
     field :hint
-    field :position,  :type => Integer, :default => 0
-    field :required,  :type => Boolean, :default => false
-    field :localized, :type => Boolean, :default => false
+    field :position,  type: ::Integer, default: 0
+    field :required,  type: ::Boolean, default: false
+    field :unique,    type: ::Boolean, default: false
+    field :localized, type: ::Boolean, default: false
 
     ## validations ##
     validates_presence_of   :label, :type
-    validates_exclusion_of  :name, :in => lambda { |f| CustomFields.options[:reserved_names].map(&:to_s) }
-    validates_format_of     :name, :with => /^[a-z]([A-Za-z0-9_]+)?$/
+    validates_exclusion_of  :name, in: lambda { |f| CustomFields.options[:reserved_names].map(&:to_s) }
+    validates_format_of     :name, with: /^[a-z]([A-Za-z0-9_]+)?$/
     validate                :uniqueness_of_label_and_name
 
     ## callbacks ##
@@ -58,7 +60,11 @@ module CustomFields
       method_name       = :"#{self.type}_to_recipe"
       custom_to_recipe  = self.send(method_name) rescue {}
 
-      { 'name' => self.name, 'type' => self.type, 'required' => self.required?, 'localized' => self.localized? }.merge(custom_to_recipe)
+      { 'name'      => self.name,
+        'type'      => self.type,
+        'required'  => self.required?,
+        'unique'    => self.unique?,
+        'localized' => self.localized? }.merge(custom_to_recipe)
     end
 
     def as_json(options = {})
@@ -94,4 +100,4 @@ module CustomFields
 
   end
 
-end
+end

data/lib/custom_fields/source.rb

@@ -65,7 +65,8 @@ module CustomFields
       {
         'name'     => "#{self.relations[name.to_s].class_name.demodulize}#{self._id}",
         'rules'    => self.ordered_custom_fields(name).map(&:to_recipe),
-        'version'  => self.custom_fields_version(name)
+        'version'  => self.custom_fields_version(name),
+        'model_name' => self.relations[name.to_s].class_name.constantize.model_name
       }
     end
 
@@ -111,10 +112,18 @@ module CustomFields
 
         metadata.instance_variable_set(:@klass, self.klass_with_custom_fields(name))
       end
-
+      set_attribute_localization(name)
       # puts "new_metadata = #{self.send(name).metadata.klass.inspect} / #{self.send(name).metadata.object_id.inspect}" # DEBUG
     end
 
+    def set_attribute_localization(name)
+      klass_name = name.singularize.to_sym
+      self.send(:"#{name}_custom_fields").each do |cf|
+        I18n.backend.store_translations ::I18n.locale,
+                          {mongoid: { attributes: {klass_name => {cf.name.to_sym => cf.label}}}}
+      end
+    end
+
     # Initializes the object tracking the modifications
     # of the custom fields
     #
@@ -145,7 +154,7 @@ module CustomFields
       # 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? }
+          self._custom_field_localize_diff[name] << { field: field.name, localized: field.localized? }
         end
       end
     end
@@ -165,14 +174,14 @@ module CustomFields
 
       # puts "selector = #{selector.inspect}, memo = #{attributes.inspect}" # DEBUG
 
-      collection.update selector, operations, :multi => true
+      collection.find(selector).update 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' }
+    # Ex: post.attributes[:name] = 'Hello world' => post.attributes[:name] = { en: 'Hello world' }
     #
     # @param [ String, Symbol ] name The name of the relation.
     #
@@ -198,7 +207,7 @@ module CustomFields
         next if updates.empty?
 
         collection = self.send(name).collection
-        collection.update record.atomic_selector, { '$set' => updates }
+        collection.find(record.atomic_selector).update({ '$set' => updates })
       end
     end
 
@@ -228,13 +237,13 @@ module CustomFields
       #   end
       #
       #   class Employee
-      #     embedded_in :company, :inverse_of => :employees
+      #     embedded_in :company, inverse_of: :employees
       #     field :name, String
       #   end
       #
-      #   company.employees_custom_fields.build :label => 'His/her position', :name => 'position', :kind => 'string'
+      #   company.employees_custom_fields.build label: 'His/her position', name: 'position', kind: 'string'
       #   company.save
-      #   company.employees.build :name => 'Michael Scott', :position => 'Regional manager'
+      #   company.employees.build name: 'Michael Scott', position: 'Regional manager'
       #
       def custom_fields_for(name)
         self.declare_embedded_in_definition_in_custom_field(name)
@@ -254,11 +263,11 @@ module CustomFields
       #
       def extend_for_custom_fields(name)
         class_eval do
-          field :"#{name}_custom_fields_version", :type => Integer, :default => 0
+          field :"#{name}_custom_fields_version", type: ::Integer, default: 0
 
-          embeds_many :"#{name}_custom_fields", :class_name => self.dynamic_custom_field_class_name(name) #, :cascade_callbacks => true # FIXME ?????
+          embeds_many :"#{name}_custom_fields", class_name: self.dynamic_custom_field_class_name(name) #, cascade_callbacks: true # FIXME ?????
 
-          accepts_nested_attributes_for :"#{name}_custom_fields", :allow_destroy => true
+          accepts_nested_attributes_for :"#{name}_custom_fields", allow_destroy: true
         end
 
         class_eval <<-EOV
@@ -324,7 +333,7 @@ module CustomFields
 
         unless source.const_defined?(klass_name)
           (klass = Class.new(::CustomFields::Field)).class_eval <<-EOF
-            embedded_in :#{self.name.demodulize.underscore}, :inverse_of => :#{name}_custom_fields, :class_name => '#{self.name}'
+            embedded_in :#{self.name.demodulize.underscore}, inverse_of: :#{name}_custom_fields, class_name: '#{self.name}'
           EOF
 
           source.const_set(klass_name, klass)
@@ -335,4 +344,4 @@ module CustomFields
 
   end
 
-end
+end