gnuside-custom_fields 2.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f86fd3a6c13622b1fe2e5bd94d46f9076554639d
+  data.tar.gz: d7b5676d0bf7cf6e845e1cf35cf4e0b67c60b4cb
+SHA512:
+  metadata.gz: fa158bc35c5ee8b24870d941e6ebe07439a7e99ee1f4239bac8b8fb925aa12b20233d9b647906b93660f95a8a591c8263723bab6fc0a26d0e6d88bff64ff59d9
+  data.tar.gz: 17279f2aa0606472a81e468b01c39bffd77064faaf4e4e63a2c4e24aa4f275dfd22f82590b887d3c60ac9dd9b192526bb0b5eb716d359a7752d0a79b43fef772

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,70 @@
+"!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, 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:
+
+* offering a very secure way to add / edit / delete extra fields to a Mongoid document
+* scoping the modifications added to a Mongoid document so that other documents of the same class won't be updated.
+
+h2. Requirements
+
+ActiveSupport 3.2.13, MongoDB 2.0 and Mongoid 3.1.3
+
+h2. Examples
+
+h3. On a has_many relationship
+
+bc.. class Company
+  include CustomFields::Source
+
+  has_many :employees
+
+  custom_fields_for :employees
+end
+
+class Employee
+  include CustomFields::Target
+
+  field :name, String
+
+  belongs_to :company, :inverse_of => :employees
+end
+
+company = Company.new
+company.employees_custom_fields.build :label => 'His/her position', :name => 'position', :type => 'string', :required => true
+
+company.save
+
+company.employees.build :name => 'Michael Scott', :position => 'Regional manager'
+
+another_company = Company.new
+employee = another_company.employees.build
+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', :name => 'address', :type => 'text'
+
+company.save
+
+company.self_metadata.address = '700 S Laflin, 60607 Chicago'
+
+another_company = Company.new
+other_company.self_metadata.address # returns a "not defined method" error
+
+h2. Contact
+
+Feel free to contact me at didier at nocoffee dot fr.
+
+Copyright (c) 2013 NoCoffee, released under the MIT license

data/config/locales/de.yml

@@ -0,0 +1,15 @@
+de:
+  custom_fields:
+    type:
+      string: Einfacher Text
+      text: Formatierter Text
+      select: Auswahl-Liste
+      boolean: Auswahl-Box
+      integer: Ganzzahl
+      float: Fließkommazahl
+      money: Währung
+      date: Datum
+      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

@@ -0,0 +1,21 @@
+en:
+  custom_fields:
+    type:
+      string: Simple Input
+      text: Text
+      select: Select
+      boolean: Checkbox
+      date: Date
+      file: File
+      integer: Integer
+      float: Float
+      money: Money
+      email: E-mail
+      tags: Tags
+      belongs_to: Belongs to
+      has_many: Has many
+      many_to_many: Many To Many
+
+  errors:
+    messages:
+      at_least_one_element: "must have at least one element"

data/config/locales/fr.yml

@@ -0,0 +1,25 @@
+fr:
+  custom_fields:
+    type:
+      string: Texte
+      text: Zone de texte
+      select: Liste déroulante
+      boolean: Case à cocher
+      date: Date
+      integer: Nombre
+      file: Fichier
+      integer: Entier
+      float: Décimal
+      money: Monnaie
+      tags: Libellés
+      belongs_to: Appartient à
+      has_many: A plusieurs
+      many_to_many: A plusieurs et appartient à
+    text_formatting:
+      none: Aucun
+      html: HTML
+
+  errors:
+    messages:
+      blank: "doit être rempli(e)"
+      at_least_one_element: "doit avoir au moins un élément"

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/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/extensions/active_support.rb

@@ -0,0 +1,28 @@
+class String
+
+  def constantize_with_custom_fields
+    begin
+      constantize_without_custom_fields
+    rescue NameError => exception
+      # DEBUG: puts "constantizing #{self.inspect}"
+      # alright, does it look like a custom_fields dynamic klass ?
+      if self =~ /(.*)([0-9a-fA-F]{24})$/
+        base = $1.constantize
+        # we can know it for sure
+        if base.with_custom_fields?
+          relation = base.relations.values.detect { |metadata| metadata[:custom_fields_parent_klass] == true }
+
+          # load the class which holds the recipe to build the dynamic klass
+          if relation && parent_instance = relation.klass.find($2)
+            # DEBUG: puts "re-building #{self}"
+            return parent_instance.klass_with_custom_fields(relation.inverse_of)
+          end
+        end
+      end
+      # not a custom_fields dynamic klass or unable to re-build it
+      raise exception
+    end
+  end
+
+  alias_method_chain :constantize, :custom_fields
+end

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].demongoize(value)
+        else
+          nil
+        end
+      end
+    end
+
+    alias_method_chain :mount_uploader, :localization
+  end
+
+end

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

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module Mongoid #:nodoc:
+
+  module Document #:nodoc:
+
+    module ClassMethods #:nodoc:
+
+      # The mongoid default document returns always false.
+      # The documents with custom fields return true.
+      #
+      # @return [ Boolean ] False
+      #
+      def with_custom_fields?
+        false
+      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 = {}, 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, criteria_instance_id)
+    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/i18n.rb

@@ -0,0 +1,55 @@
+module Mongoid #:nodoc
+
+  # This module defines behaviour for fields.
+  module Fields
+
+    class I18n
+
+      attr_accessor :locale, :fallbacks
+
+      def self.instance
+        Thread.current[:mongoid_i18n] ||= Mongoid::Fields::I18n.new
+      end
+
+      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 new_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/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/fields.rb

@@ -0,0 +1,31 @@
+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)
+        # puts "fields[#{name}] = #{fields[name.to_s].inspect} / #{fields.keys.inspect}" # DEBUG
+        #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

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

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module Mongoid # :nodoc:
+  module Relations #:nodoc:
+    module Referenced #:nodoc:
+
+      class In < Relations::One
+
+        class << self
+
+          def valid_options_with_parent_class
+            valid_options_without_parent_class.push :custom_fields_parent_klass
+          end
+
+          alias_method_chain :valid_options, :parent_class
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# 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 ||= {}
+
+            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
+
+        # new should point to the new build method
+        alias :new :build_with_custom_fields
+      end
+
+    end
+  end
+end

data/lib/custom_fields/extensions/mongoid/validations/collection_size.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+module Mongoid
+  module Validations
+
+    # Validates that the specified collections do or do not match a certain
+    # size.
+    #
+    # @example Set up the collection size validator.
+    #
+    #   class Person
+    #     include Mongoid::Document
+    #     has_many :addresses
+    #
+    #     validates_collection_size_of :addresses, in: 1..10
+    #   end
+    class CollectionSizeValidator < LengthValidator
+
+      def validate_each_with_collection(record, attribute, value)
+        value = collection_to_size(record, attribute)
+
+        self.validate_each_without_collection(record, attribute, value)
+      end
+
+      alias_method_chain :validate_each, :collection
+
+      private
+
+      def collection_to_size(record, attribute)
+        relation = record.relations[attribute.to_s]
+
+        source = case relation.macro
+        when :embeds_many, :has_many
+          record.send(attribute)
+        when :has_and_belongs_to_many
+          record.send(relation.key.to_sym)
+        end
+
+        OpenStruct.new(length: source.try(:size) || 0)
+      end
+
+    end
+  end
+end

data/lib/custom_fields/extensions/mongoid/validations/macros.rb

@@ -0,0 +1,25 @@
+module Mongoid
+  module Validations
+    module Macros
+      extend ActiveSupport::Concern
+
+      # Validates the size of a collection.
+      #
+      # @example
+      #   class Person
+      #     include Mongoid::Document
+      #     has_many :addresses
+      #
+      #     validates_collection_size_of :addresses, minimum: 1
+      #   end
+      #
+      # @param [ Array ] args The names of the fields to validate.
+      #
+      # @since 2.4.0
+      def validates_collection_size_of(*args)
+        validates_with(Mongoid::Validations::CollectionSizeValidator, _merge_attributes(args))
+      end
+
+    end
+  end
+end

data/lib/custom_fields/extensions/origin/smash.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module Origin
+
+  # This is a smart hash for use with options and selectors.
+  class Smash < Hash
+
+    private
+
+    # Get the normalized value for the key. If localization is in play the
+    # current locale will be appended to the key in MongoDB dot notation.
+    #
+    # FIXME (Did).
+    # This version DOES NOT USE ::I18n.locale directly.
+    # See the localized.rb file for more explanation.
+    #
+    # @api private
+    #
+    # @example Get the normalized key name.
+    #   smash.normalized_key("field", serializer)
+    #
+    # @param [ String ] name The name of the field.
+    # @param [ Object ] serializer The optional field serializer.
+    #
+    # @return [ String ] The normalized key.
+    #
+    # @since 1.0.0
+    def normalized_key(name, serializer)
+      # serializer && serializer.localized? ? "#{name}.#{::I18n.locale}" : name
+      serializer && serializer.localized? ? "#{name}.#{::Mongoid::Fields::I18n.locale}" : name
+    end
+
+  end
+end

data/lib/custom_fields/field.rb

@@ -0,0 +1,106 @@
+module CustomFields
+
+  class Field
+
+    include ::Mongoid::Document
+    include ::Mongoid::Timestamps
+
+    AVAILABLE_TYPES = %w(default string text email date date_time boolean file select float integer
+       money tags relationship_default belongs_to has_many many_to_many)
+
+    ## types ##
+    AVAILABLE_TYPES.each do |type|
+      include "CustomFields::Types::#{type.camelize}::Field".constantize
+    end
+
+    ## fields ##
+    field :label
+    field :name
+    field :type
+    field :hint
+    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_inclusion_of  :type, in: AVAILABLE_TYPES, allow_blank: true
+    validates_format_of     :name, with: /^[a-z]([A-Za-z0-9_]+)?$/
+    validate                :uniqueness_of_label_and_name
+
+    ## callbacks ##
+    before_validation :set_name
+
+    ## methods ##
+
+    # Builds the mongodb updates based on
+    # the new state of the field.
+    # Call a different method if the field has a different behaviour.
+    #
+    # @param [ Hash ] memo Store the updates
+    #
+    # @return [ Hash ] The memo object upgraded
+    #
+    def collect_diff(memo)
+      method_name = :"collect_#{self.type}_diff"
+
+      if self.respond_to?(method_name)
+        self.send(method_name, memo)
+      else
+        collect_default_diff(memo)
+      end
+    end
+
+    # Returns the information (name, type, required, ...etc) needed to build
+    # the custom class.
+    # That will be stored into the target instance.
+    #
+    # @return [ Hash ] The hash
+    #
+    def to_recipe
+      method_name       = :"#{self.type}_to_recipe"
+      custom_to_recipe  = self.send(method_name) rescue {}
+
+      { 'name'      => self.name,
+        'type'      => self.type,
+        'required'  => self.required?,
+        'unique'    => self.unique?,
+        'localized' => self.localized? }.merge(custom_to_recipe)
+    end
+
+    def as_json(options = {})
+      method_name     = :"#{self.type}_as_json"
+      custom_as_json  = self.send(method_name) rescue {}
+
+      super(options).merge(custom_as_json)
+    end
+
+    protected
+
+    def uniqueness_of_label_and_name
+      if self.siblings.any? { |f| f.label == self.label && f._id != self._id }
+        self.errors.add(:label, :taken)
+      end
+
+      if self.siblings.any? { |f| f.name == self.name && f._id != self._id }
+        self.errors.add(:name, :taken)
+      end
+    end
+
+    def set_name
+      return if self.label.blank? && self.name.blank?
+
+      if self.name.blank?
+        self.name = self.label.parameterize('_').gsub('-', '_').downcase
+      end
+    end
+
+    def siblings
+      self._parent.send(self.metadata.name)
+    end
+
+  end
+
+end