custom_fields 1.1.0.rc1 → 2.0.0.rc1

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 [Didier Lafforgue]
+Copyright (c) 2011 [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

@@ -1,7 +1,9 @@
+"!https://secure.travis-ci.org/locomotivecms/custom_fields.png!":http://travis-ci.org/locomotivecms/custom_fields
+
 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.
-Basically, its aim is to provide to editors a way to manage extra fields to a Mongoid document through for instance a web UI.
+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:
 
@@ -10,26 +12,30 @@ The main goals:
 
 h2. Requirements
 
-ActiveSupport 3.1.1, MongoDB 2.0 and Mongoid 2.3.2
+ActiveSupport 3.1.3, MongoDB 2.0 and Mongoid 2.3.4
 
 h2. Examples
 
 h3. On a has_many relationship
 
 bc.. class Company
-  embeds_many :employees
+  include CustomFields::Source
+
+  has_many :employees
 
   custom_fields_for :employees
 end
 
 class Employee
+  include CustomFields::Target
+
   field :name, String
 
-  embedded_in :company, :inverse_of => :employees
+  belongs_to :company, :inverse_of => :employees
 end
 
 company = Company.new
-company.employees_custom_fields.build :label => 'His/her position', :_alias => 'position', :kind => 'string', :required => true
+company.employees_custom_fields.build :label => 'His/her position', :name => 'position', :type => 'string', :required => true
 
 company.save
 
@@ -41,12 +47,14 @@ employee.position # returns a "not defined method" error
 
 h3. On the class itself
 
+[IN PROGRESS]
+
 bc.. class Company
   custom_fields_for_itself
 end
 
 company = Company.new
-company.self_metadata_custom_fields.build :label => 'Shipping Address', :_alias => 'address', :kind => 'text'
+company.self_metadata_custom_fields.build :label => 'Shipping Address', :name => 'address', :type => 'text'
 
 company.save
 

data/config/locales/fr.yml

@@ -9,4 +9,8 @@ fr:
       file: Fichier
     text_formatting:
       none: Aucun
-      html: HTML
+      html: HTML
+
+  errors:
+    messages:
+      blank: "doit être rempli(e)"

data/lib/custom_fields.rb

@@ -6,7 +6,7 @@ require 'carrierwave/mongoid'
 module CustomFields
 
   @@options = {
-    :reserved_aliases => Mongoid.destructive_fields + %w(id _id send class)
+    :reserved_names => Mongoid.destructive_fields + %w(id _id send class)
   }
 
   def self.options=(options)
@@ -20,49 +20,23 @@ 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/relations/accessors'
-require 'custom_fields/extensions/mongoid/relations/builders'
+require 'custom_fields/extensions/mongoid/factory'
+require 'custom_fields/extensions/mongoid/relations/referenced/many'
+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/category'
-require 'custom_fields/types/boolean'
 require 'custom_fields/types/date'
+require 'custom_fields/types/boolean'
 require 'custom_fields/types/file'
-require 'custom_fields/types/has_one'
-require 'custom_fields/types/has_many/proxy_collection'
-require 'custom_fields/types/has_many/reverse_lookup_proxy_collection'
-require 'custom_fields/types/has_many'
-require 'custom_fields/proxy_class/base'
-require 'custom_fields/proxy_class/builder'
-require 'custom_fields/proxy_class/helper'
+require 'custom_fields/types/select'
 require 'custom_fields/field'
-require 'custom_fields/self_metadata'
-require 'custom_fields/custom_fields_for'
-
-module Mongoid
-  module CustomFields
-    extend ActiveSupport::Concern
-    included do
-      extend  ::CustomFields::ProxyClass::Helper
-      include ::CustomFields::CustomFieldsFor
-    end
-  end
-
-  module TargetCustomFields
-    extend ActiveSupport::Concern
-    included do
-      extend ::CustomFields::ProxyClass::Helper
-      extend ::CustomFields::ProxyClass::Builder
-    end
-  end
-end
-
-ActiveSupport::Inflector.inflections do |inflect|
-  inflect.irregular 'metadata', 'metadata'
-end
+require 'custom_fields/source'
+require 'custom_fields/target'
 
 # Load all the translation files
 I18n.load_path += Dir[File.join(File.dirname(__FILE__), '..', 'config', 'locales', '*.yml')]

data/lib/custom_fields/extensions/carrierwave.rb

@@ -0,0 +1,25 @@
+require 'carrierwave/mongoid'
+
+module CarrierWave
+
+  module Mongoid
+
+    def mount_uploader_with_localization(column, uploader=nil, options={}, &block)
+      mount_uploader_without_localization(column, uploader, options, &block)
+
+      define_method(:read_uploader) do |name|
+        # puts "read_uploader #{name} / #{read_attribute(name.to_sym).inspect}" # DEBUG
+
+        value = read_attribute(name.to_sym)
+        unless value.nil?
+          self.class.fields[name.to_s].deserialize(value)
+        else
+          nil
+        end
+      end
+    end
+
+    alias_method_chain :mount_uploader, :localization
+  end
+
+end

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

@@ -1,59 +1,21 @@
 # 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
+  module Document #:nodoc:
 
-  # This is the base module for all domain objects that need to be persisted to
-  # the database as documents.
-  module Reloading
+    module ClassMethods #:nodoc:
 
-    # 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
+      # The mongoid default document returns always false.
+      # The documents with custom fields return true.
+      #
+      # @return [ Boolean ] False
+      #
+      def with_custom_fields?
+        false
       end
-    end
 
-    alias_method_chain :reload, :custom_fields
+    end
 
   end
-end
+
+end

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

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+
+  # Instantiates documents that came from the database.
+  module Factory
+
+    def from_db_with_custom_fields(klass, attributes = {})
+      if klass.with_custom_fields?
+        klass.klass_with_custom_fields(attributes['custom_fields_recipe'])
+      end
+      from_db_without_custom_fields(klass, attributes)
+    end
+
+    # equivalent for "alias_method_chain :from_db, :custom_fields"
+    alias_method :from_db_without_custom_fields, :from_db unless method_defined?(:from_db_without_custom_fields)
+    alias_method :from_db, :from_db_with_custom_fields
+
+  end
+
+end

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

@@ -0,0 +1,29 @@
+module Mongoid #:nodoc
+
+  # This module defines behaviour for fields.
+  module Fields
+
+    module ClassMethods
+
+      # Replace a field with a new type.
+      #
+      # @example Replace the field.
+      #   Model.replace_field("_id", String)
+      #
+      # @param [ String ] name The name of the field.
+      # @param [ Class ] type The new type of field.
+      # @param [ Boolean ] localize The option to localize or not the field.
+      #
+      # @return [ Serializable ] The new field.
+      #
+      # @since 2.1.0
+      def replace_field(name, type, localize = false)
+        defaults.delete_one(name)
+        add_field(name, fields[name].options.merge(:type => type, :localize => localize))
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,53 @@
+module Mongoid #:nodoc
+
+  # This module defines behaviour for fields.
+  module Fields
+
+    class I18n
+
+      include Singleton
+
+      attr_accessor :locale, :fallbacks
+
+      def self.locale
+        self.instance.locale || ::I18n.locale
+      end
+
+      def self.locale=(value)
+        self.instance.locale = value.to_sym rescue nil
+      end
+
+      def self.fallbacks
+        if ::I18n.respond_to?(:fallbacks)
+          ::I18n.fallbacks
+        elsif !self.instance.fallbacks.blank?
+          self.instance.fallbacks
+        else
+          nil
+        end
+      end
+
+      def self.fallbacks_for(locale, fallbacks)
+        self.instance.fallbacks ||= {}
+        self.instance.fallbacks[locale.to_sym] = fallbacks
+      end
+
+      def self.fallbacks?
+        ::I18n.respond_to?(:fallbacks) || !self.instance.fallbacks.blank?
+      end
+
+      def self.with_locale(new_locale = nil)
+        if tmp_locale
+          current_locale  = self.locale
+          self.locale     = new_locale
+        end
+        yield
+      ensure
+        self.locale = current_locale if new_locale
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,84 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Fields #:nodoc:
+    module Internal #:nodoc:
+
+      # Defines the behaviour for localized string fields.
+      class Localized
+
+        attr_accessor :original_field_type
+
+        class << self
+
+          # Instantiate 2 field types:
+          # - a wrapper in charge of dealing with the translations
+          # - the original field type to help to serialize / deserialize types
+          #
+          # @param [ Hash ] options The field options.
+          #
+          # @option options [ Class ] :type The class of the field.
+          # @option options [ Object ] :default The default value for the field.
+          # @option options [ String ] :label The field's label.
+          #
+          def instantiate_with_localize(name, options = {})
+            instantiate_without_localize(name, options).tap do |field|
+              field.original_field_type = Mappings.for(options[:type], options[:identity]).instantiate(name, options)
+            end
+          end
+
+          alias_method_chain :instantiate, :localize
+
+        end
+
+        # Deserialize the object based on the current locale. Will look in the
+        # hash for the current locale.
+        #
+        # @example Get the deserialized value.
+        #   field.deserialize({ "en" => "testing" })
+        #
+        # @param [ Hash ] object The hash of translations.
+        #
+        # @return [ String ] The value for the current locale.
+        #
+        # @since 2.3.0
+        def deserialize(object)
+          return nil if object.nil?
+
+          # puts "deserializing...#{locale.inspect} / #{object.inspect}" # DEBUG
+
+          value = if I18n.fallbacks?
+            object[I18n.fallbacks[locale.to_sym].map(&:to_s).find { |loc| !object[loc].nil? }]
+          else
+            object[locale.to_s]
+          end
+
+          self.original_field_type.deserialize(value)
+        end
+
+        # Convert the provided string into a hash for the locale.
+        #
+        # @example Serialize the value.
+        #   field.serialize("testing")
+        #
+        # @param [ String ] object The string to convert.
+        #
+        # @return [ Hash ] The locale with string translation.
+        #
+        # @since 2.3.0
+        def serialize(object)
+          # puts "serializing...#{locale} / #{object.inspect} / #{options.inspect}" # DEBUG
+
+          value = self.original_field_type.serialize(object)
+          { locale.to_s => value }
+        end
+
+        protected
+
+        def locale
+          I18n.locale
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+  module Relations #:nodoc:
+    module Referenced #:nodoc:
+
+      # This class defines the behaviour for all relations that are a
+      # one-to-many between documents in different collections.
+      class Many < Relations::Many
+
+        def build_with_custom_fields(attributes = {}, options = {}, type = nil)
+          if base.respond_to?(:custom_fields_for?) && base.custom_fields_for?(metadata.name)
+            # all the information about how to build the custom class are stored here
+            recipe = base.custom_fields_recipe_for(metadata.name)
+
+            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
+      end
+
+    end
+  end
+end