custom_fields 2.12.1 → 2.13.1

data/lib/custom_fields/types/select.rb

@@ -1,11 +1,9 @@
-module CustomFields
+# frozen_string_literal: true
 
+module CustomFields
   module Types
-
     module Select
-
       class Option
-
         include Mongoid::Document
 
         field :name,      localize: true
@@ -15,68 +13,66 @@ module CustomFields
 
         validates_presence_of :name
 
-        def as_json(options = nil)
-          super methods: %w(_id name position)
+        def as_json(_options = nil)
+          super methods: %w[_id name position]
         end
-
       end
 
       module Field
-
         extend ActiveSupport::Concern
 
         included do
-
           embeds_many :select_options, class_name: 'CustomFields::Types::Select::Option'
 
           validates_associated :select_options
 
           accepts_nested_attributes_for :select_options, allow_destroy: true
-
         end
 
         def ordered_select_options
-          self.select_options.sort { |a, b| (a.position || 0) <=> (b.position || 0) }.to_a
+          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|
+            'select_options' => 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) }
+        def select_as_json(_options = {})
+          { 'select_options' => ordered_select_options.map(&:as_json) }
         end
-
       end
 
       module Target
-
         extend ActiveSupport::Concern
 
         module ClassMethods
-
           # Adds a select field
           #
           # @param [ Class ] klass The class to modify
           # @param [ Hash ] rule It contains the name of the field and if it is required or not
           #
           def apply_select_custom_field(klass, rule)
-            name, base_collection_name = rule['name'], "#{rule['name']}_options".to_sym
+            name = rule['name']
+            base_collection_name = "#{rule['name']}_options".to_sym
 
-            klass.field :"#{name}_id", type: BSON::ObjectId, localize: rule['localized'] || false, default: ->{ _set_select_option(name, rule['default']) }
+            klass.field :"#{name}_id", type: BSON::ObjectId, localize: rule['localized'] || false, default: lambda {
+                                                                                                              _set_select_option(name, rule['default'])
+                                                                                                            }
 
             klass.cattr_accessor "_raw_#{base_collection_name}"
-            klass.send :"_raw_#{base_collection_name}=", rule['select_options'].sort { |a, b| a['position'] <=> b['position'] }
+            klass.send :"_raw_#{base_collection_name}=", rule['select_options'].sort { |a, b|
+                                                           a['position'] <=> b['position']
+                                                         }
 
             # other methods
             klass.send(:define_method, name.to_sym) { _get_select_option(name) }
             klass.send(:define_method, :"#{name}=") { |value| _set_select_option(name, value) }
 
-            klass.class_eval <<-EOV
+            klass.class_eval <<-EOV, __FILE__, __LINE__ + 1
 
               def self.#{base_collection_name}
                 self._select_options('#{name}')
@@ -84,9 +80,9 @@ module CustomFields
 
             EOV
 
-            if rule['required']
-              klass.validates_presence_of name
-            end
+            return unless rule['required']
+
+            klass.validates_presence_of name
           end
 
           # Build a hash storing the values (id and option name) for
@@ -100,8 +96,8 @@ module CustomFields
           def select_attribute_get(instance, name)
             if value = instance.send(name.to_sym)
               {
-                name          => value,
-                "#{name}_id"  => instance.send(:"#{name}_id")
+                name => value,
+                "#{name}_id" => instance.send(:"#{name}_id")
               }
             else
               {}
@@ -116,7 +112,7 @@ module CustomFields
           # @param [ Hash ] attributes The attributes used to fetch the values
           #
           def select_attribute_set(instance, name, attributes)
-            id_or_name  = attributes[name] || attributes["#{name}_id"]
+            id_or_name = attributes[name] || attributes["#{name}_id"]
 
             return if id_or_name.nil?
 
@@ -134,7 +130,7 @@ module CustomFields
           #
           def group_by_select_option(name, order_by = nil)
             name_id = "#{name}_id"
-            groups = self.each.group_by { |x| x.send(name_id) }.map do |(k, v)|
+            groups = each.group_by { |x| x.send(name_id) }.map do |(k, v)|
               { name_id => k, 'group' => v }
             end
 
@@ -144,33 +140,32 @@ module CustomFields
 
               groups.delete(group) if group
 
-              { name: option['name'], entries: self._order_select_entries(list, order_by) }.with_indifferent_access
+              { name: option['name'], entries: _order_select_entries(list, order_by) }.with_indifferent_access
             end.tap do |array|
-              if not groups.empty? # orphan entries ?
+              unless groups.empty? # orphan entries ?
                 empty = { name: nil, entries: [] }.with_indifferent_access
                 groups.each do |group|
                   empty[:entries] += group['group']
                 end
-                empty[:entries] = self._order_select_entries(empty[:entries], order_by)
+                empty[:entries] = _order_select_entries(empty[:entries], order_by)
                 array << empty
               end
             end
           end
 
           def _select_options(name)
-            self.send(:"_raw_#{name}_options").map do |option|
-
+            send(:"_raw_#{name}_options").map do |option|
               locale = Mongoid::Fields::I18n.locale.to_s
 
               name = if !option['name'].respond_to?(:merge)
-                option['name']
-              elsif option['name'].has_key?(locale)
-                option['name'][locale.to_s]
-              elsif Mongoid::Fields::I18n.fallbacks?
-                option['name'][Mongoid::Fields::I18n.fallbacks[locale.to_sym].map(&:to_s).find { |loc| !option['name'][loc].nil? }]
-              else
-                nil
-              end
+                       option['name']
+                     elsif option['name'].key?(locale)
+                       option['name'][locale.to_s]
+                     elsif Mongoid::Fields::I18n.fallbacks?
+                       option['name'][Mongoid::Fields::I18n.fallbacks[locale.to_sym].map(&:to_s).find do |loc|
+                                        !option['name'][loc].nil?
+                                      end]
+                     end
 
               { '_id' => option['_id'], 'name' => name }
             end
@@ -181,17 +176,18 @@ module CustomFields
 
             column, direction = order_by.flatten
 
-            list = list.sort { |a, b| (a.send(column) && b.send(column)) ? (a.send(column) || 0) <=> (b.send(column) || 0) : 0 }
+            list = list.sort do |a, b|
+              a.send(column) && b.send(column) ? (a.send(column) || 0) <=> (b.send(column) || 0) : 0
+            end
 
             direction == 'asc' ? list : list.reverse
 
             list
           end
-
         end
 
         def _select_option_id(name)
-          self.send(:"#{name}_id")
+          send(:"#{name}_id")
         end
 
         def _find_select_option(name, id_or_name)
@@ -201,19 +197,15 @@ module CustomFields
         end
 
         def _get_select_option(name)
-          option = self._find_select_option(name, self._select_option_id(name))
+          option = _find_select_option(name, _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)
+          option = _find_select_option(name, value)
+          send(:"#{name}_id=", option ? option['_id'] : nil)
         end
-
       end
-
     end
-
   end
-
 end

data/lib/custom_fields/types/string.rb

@@ -1,17 +1,14 @@
-module CustomFields
+# frozen_string_literal: true
 
+module CustomFields
   module Types
-
     module String
-
       module Field; end
 
       module Target
-
         extend ActiveSupport::Concern
 
         module ClassMethods
-
           # Add a string field
           #
           # @param [ Class ] klass The class to modify
@@ -30,7 +27,7 @@ module CustomFields
           # @return [ Hash ] field name => raw value
           #
           def string_attribute_get(instance, name)
-            self.default_attribute_get(instance, name)
+            default_attribute_get(instance, name)
           end
 
           # Set the value for the instance and the string field specified by
@@ -41,15 +38,10 @@ module CustomFields
           # @param [ Hash ] attributes The attributes used to fetch the values
           #
           def string_attribute_set(instance, name, attributes)
-            self.default_attribute_set(instance, name, attributes)
+            default_attribute_set(instance, name, attributes)
           end
-
         end
-
       end
-
     end
-
   end
-
-end
+end

data/lib/custom_fields/types/tags.rb

@@ -1,35 +1,35 @@
+# frozen_string_literal: true
+
 module CustomFields
   module Types
     module Tags
       module Field; end
-      
+
       module Target
         extend ActiveSupport::Concern
-        
-        module ClassMethods
 
+        module ClassMethods
           def apply_tags_custom_field(klass, rule)
             klass.field rule['name'], localize: rule['localized'] || false, type: Array
-            
+
             klass.class_eval do
               define_method("#{rule['name']}=") do |val|
-                #FIXME I would use is_a?(), but it doesn't work in my machine!
-                val = val.split(/ *, */) if val.class.to_s == "String" 
+                # FIXME: I would use is_a?(), but it doesn't work in my machine!
+                val = val.split(/ *, */) if val.class.to_s == 'String'
                 super(val)
               end
             end
           end
-          
+
           def tags_attribute_get(instance, name)
-            self.default_attribute_get(instance, name)
+            default_attribute_get(instance, name)
           end
 
           def tags_attribute_set(instance, name, attributes)
-            self.default_attribute_set(instance, name, attributes)
+            default_attribute_set(instance, name, attributes)
           end
         end
       end
-      
     end
   end
-end
+end

data/lib/custom_fields/types/text.rb

@@ -1,27 +1,20 @@
-module CustomFields
+# frozen_string_literal: true
 
+module CustomFields
   module Types
-
     module Text
-
       module Field
-
         extend ActiveSupport::Concern
 
         included do
-
           field :text_formatting, default: 'html'
-
         end
-
       end
 
       module Target
-
         extend ActiveSupport::Concern
 
         module ClassMethods
-
           # Adds a text field (simply a string field)
           #
           # @param [ Class ] klass The class to modify
@@ -51,15 +44,10 @@ module CustomFields
           # @param [ Hash ] attributes The attributes used to fetch the values
           #
           def text_attribute_set(instance, name, attributes)
-            self.default_attribute_set(instance, name, attributes)
+            default_attribute_set(instance, name, attributes)
           end
-
         end
-
       end
-
     end
-
   end
-
-end
+end

data/lib/custom_fields/version.rb

@@ -1,5 +1,7 @@
-module CustomFields #:nodoc
+# frozen_string_literal: true
 
-  VERSION = '2.12.1'
+# :nodoc
 
+module CustomFields
+  VERSION = '2.13.1'
 end

data/lib/custom_fields.rb

@@ -1,4 +1,6 @@
-$:.unshift File.expand_path(File.dirname(__FILE__))
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift __dir__
 
 require 'active_support'
 require 'carrierwave/mongoid'
@@ -8,10 +10,12 @@ require 'bcrypt'
 Money.locale_backend = :currency
 
 module CustomFields
+  # Regexp to check if a Ruby class has been built by the CustomFields gem
+  KLASS_REGEXP = /(.*)([0-9a-fA-F]{24})$/o
 
   @@options = {
-    reserved_names:     Mongoid.destructive_fields + %w(id _id send class destroy system),
-    default_currency:   'EUR'
+    reserved_names: Mongoid.destructive_fields + %w[id _id send class destroy system],
+    default_currency: 'EUR'
   }
 
   def self.options=(options)
@@ -21,23 +25,22 @@ module CustomFields
   def self.options
     @@options
   end
-
 end
 
-%w(  version
+%w[  version
      extensions/active_support
      extensions/carrierwave
      extensions/mongoid/document
      extensions/mongoid/factory
      extensions/mongoid/criteria/queryable/smash
-     extensions/mongoid/relations/options
-     extensions/mongoid/relations/referenced/many
-     extensions/mongoid/relations/referenced/in
+     extensions/mongoid/association/relatable
+     extensions/mongoid/association/referenced/has_many
+     extensions/mongoid/association/referenced/has_one
      extensions/mongoid/fields.rb
      extensions/mongoid/fields/i18n.rb
      extensions/mongoid/fields/localized.rb
-     extensions/mongoid/validations/collection_size.rb
-     extensions/mongoid/validations/macros.rb
+     extensions/mongoid/validatable/collection_size.rb
+     extensions/mongoid/validatable/macros.rb
      extensions/origin/smash.rb
      types/default
      types/string
@@ -62,21 +65,18 @@ end
      field
      source
      target_helpers
-     target
-    ).each do |lib|
-      require_relative "./custom_fields/#{lib}"
-    end
+     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')]
 
 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

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: custom_fields
 version: !ruby/object:Gem::Version
-  version: 2.12.1
+  version: 2.13.1
 platform: ruby
 authors:
 - Didier Lafforgue
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mongoid
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: carrierwave-mongoid
+  name: bcrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 3.1.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 3.1.18
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: carrierwave-mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: monetize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
-  name: bcrypt
+  name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.1.11
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.11
+        version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 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 LocomotiveCMS.
 email: didier@nocoffee.fr
@@ -111,17 +111,17 @@ files:
 - lib/custom_fields.rb
 - lib/custom_fields/extensions/active_support.rb
 - lib/custom_fields/extensions/carrierwave.rb
+- lib/custom_fields/extensions/mongoid/association/referenced/has_many.rb
+- lib/custom_fields/extensions/mongoid/association/referenced/has_one.rb
+- lib/custom_fields/extensions/mongoid/association/relatable.rb
 - lib/custom_fields/extensions/mongoid/criteria/queryable/smash.rb
 - lib/custom_fields/extensions/mongoid/document.rb
 - lib/custom_fields/extensions/mongoid/factory.rb
 - lib/custom_fields/extensions/mongoid/fields.rb
 - lib/custom_fields/extensions/mongoid/fields/i18n.rb
 - lib/custom_fields/extensions/mongoid/fields/localized.rb
-- lib/custom_fields/extensions/mongoid/relations/options.rb
-- lib/custom_fields/extensions/mongoid/relations/referenced/in.rb
-- lib/custom_fields/extensions/mongoid/relations/referenced/many.rb
-- lib/custom_fields/extensions/mongoid/validations/collection_size.rb
-- lib/custom_fields/extensions/mongoid/validations/macros.rb
+- lib/custom_fields/extensions/mongoid/validatable/collection_size.rb
+- lib/custom_fields/extensions/mongoid/validatable/macros.rb
 - lib/custom_fields/extensions/origin/smash.rb
 - lib/custom_fields/field.rb
 - lib/custom_fields/source.rb
@@ -152,23 +152,23 @@ homepage: https://github.com/locomotivecms/custom_fields
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Custom fields extension for Mongoid.
 test_files: []

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

@@ -1,19 +0,0 @@
-# encoding: utf-8
-module Mongoid
-  module Relations
-
-    module Options
-
-      def validate_with_custom_fields!(options)
-        _options = options.dup
-        _options.delete(:custom_fields_parent_klass)
-        validate_without_custom_fields!(_options)
-      end
-
-      alias_method :validate_without_custom_fields!, :validate!
-      alias_method :validate!, :validate_with_custom_fields!
-
-    end
-
-  end
-end

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

@@ -1,18 +0,0 @@
-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 :valid_options_without_parent_class, :valid_options
-          alias_method :valid_options, :valid_options_with_parent_class
-
-        end
-      end
-    end
-  end
-end