custom_fields 2.12.1 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3357d5d55b5957c388cd463667d4469225b2b2c5fcd2070c352e24356376d1f0
-  data.tar.gz: 074afdf57443c539afc384e140f1c0203f57f719207439bc61cee08733d35947
+  metadata.gz: 2c5b67a98147c90e024cfcd50690b26ac3d472837222ab577ed4e8cd211f97cf
+  data.tar.gz: 4564688d1fec136420b4353f23c8ff149f8ea5240c693a54b863925c5a262373
 SHA512:
-  metadata.gz: 3f7b9e7dc8dcb0a187ecbe36a05bfcce3a54911b94687beda218ee2b9c9274726eea8ea66598cf3f88cc5b143890f5d772ab9108a4ce90fbd8defd3ad35c8fb2
-  data.tar.gz: dc658cae3dd2628c9e43be55405e7a9c935623995e876976ca6ef751096d4a01604e44a29fdf778c7417f4d988d60f0aaf5a469cd2ea3cfa2477c7644b97e37d
+  metadata.gz: 1f4226fa0228d6ca2ab6a4b9d35a621560292edfd8baec8f68387954246d95b101d69ca6fd5ddf5a1a4859f24a2270c65b7917f8d71286388a90e9f54e73efc0
+  data.tar.gz: 772923aa4070480b8e7170783f75e3c7ef33620a6c85bc9b6dbfa31d65a5458373ef476c1ff84678e21ea272a1fe418de6a282b4bc41ecfcc81bf5333f5e2203

data/MIT-LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 NoCoffee
+Copyright (c) 2023 NoCoffee
 
 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

data/README.md

@@ -2,7 +2,6 @@
 ==============
 
 [![Travis CI Status][Travis CI Status]][Travis CI]
-[![Gemnasium Status][Gemnasium Status]][Gemnasium]
 
 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. Basically, its aim is to provide to editors a way to manage extra fields to a
@@ -16,9 +15,9 @@ The main goals:
 Requirements
 ------------
 
-* MongoDB 3.x
-* Mongoid 6.x
-* ActiveSupport 5.2.x
+* MongoDB 6+
+* Mongoid 8+
+* ActiveSupport 6+
 
 Examples
 --------
@@ -93,7 +92,7 @@ Feel free to contact me at did at locomotivecms dot com.
 License
 -------
 
-Copyright (c) 2018 NoCoffee, released under the [MIT License (MIT)], see [MIT-LICENSE].
+Copyright (c) 2023 NoCoffee, released under the [MIT License (MIT)], see [MIT-LICENSE].
 
 [CustomFields]: https://github.com/locomotivecms/custom_fields "Custom fields extension for Mongoid."
 [Gemnasium]: https://gemnasium.com/locomotivecms/custom_fields "CustomFields at Gemnasium"

data/lib/custom_fields/extensions/active_support.rb

@@ -1,30 +1,29 @@
-class String
+# frozen_string_literal: true
 
-  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 }
+module CustomFieldsStringExtension
+  def constantize
+    super
+  rescue NameError => e
+    # DEBUG: puts "constantizing #{self.inspect}"
+    # alright, does it look like a custom_fields dynamic klass ?
+    if self =~ CustomFields::KLASS_REGEXP
+      base = ::Regexp.last_match(1).constantize
+      # we can know it for sure
+      if base.with_custom_fields?
+        relation = base.relations.values.detect do |association|
+          association.options[:custom_fields_parent_klass] == true
+        end
 
-          # 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
+        # load the class which holds the recipe to build the dynamic klass
+        if relation && parent_instance = relation.klass.find(::Regexp.last_match(2))
+          # DEBUG: puts "re-building #{self}"
+          return parent_instance.klass_with_custom_fields(relation.inverse_of)
         end
       end
-      # not a custom_fields dynamic klass or unable to re-build it
-      raise exception
     end
+    # not a custom_fields dynamic klass or unable to re-build it
+    raise e
   end
-
-  alias_method :constantize_without_custom_fields, :constantize
-  alias_method :constantize, :constantize_with_custom_fields
-
 end
+
+::String.prepend CustomFieldsStringExtension

data/lib/custom_fields/extensions/carrierwave.rb

@@ -1,34 +1,12 @@
+# frozen_string_literal: true
+
 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} / #{::Mongoid::Fields::I18n.locale.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 :mount_uploader_without_localization, :mount_uploader
-    alias_method :mount_uploader, :mount_uploader_with_localization
-
-  end
-
   class Mounter
-
     def remove_previous_with_localization(before = nil, after = nil)
-      _before, _after = before, after
+      _before = before
+      _after = after
       locale = ::Mongoid::Fields::I18n.locale.to_s
 
       # custom case:
@@ -37,28 +15,19 @@ module CarrierWave
       # a different name.
       # We absolutely don't want to erase the file in the default locale
       if record.class.fields[column.to_s]&.localized? &&
-          record.changes[column]&.first == '_new_'
+         record.changes[column]&.first == '_new_'
         _before = [nil]
       end
 
       # FIXME: can't reproduce this behavior locally but it happens in production
-      if before && before.first.is_a?(Hash)
-        _before = [before.first[locale]]
-      end
+      _before = [before.first[locale]] if before && before.first.is_a?(Hash)
 
-      if after && after.first.is_a?(Hash)
-        _after = [after.first[locale]]
-      end
+      _after = [after.first[locale]] if after && after.first.is_a?(Hash)
 
       remove_previous_without_localization(_before, _after)
     end
 
-    alias_method :remove_previous_without_localization, :remove_previous
-    alias_method :remove_previous, :remove_previous_with_localization
-
-
+    alias remove_previous_without_localization remove_previous
+    alias remove_previous remove_previous_with_localization
   end
-
 end
-
-

data/lib/custom_fields/extensions/mongoid/association/referenced/has_many.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# 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 = {}, type = nil)
+#           if base.respond_to?(:custom_fields_for?) && base.custom_fields_for?(relation_metadata.name)
+#             # all the information about how to build the custom class are stored here
+#             recipe = base.custom_fields_recipe_for(relation_metadata.name)
+#             attributes ||= {}
+#             attributes.merge!(custom_fields_recipe: recipe)
+#             # build the class with custom_fields for the first time
+#             type = relation_metadata.klass.klass_with_custom_fields(recipe)
+#           end
+#           build_without_custom_fields(attributes, type)
+#         end
+
+#         alias_method :build_without_custom_fields, :build
+#         alias_method :build, :build_with_custom_fields
+
+#         # new should point to the new build method
+#         alias :new :build_with_custom_fields
+#       end
+
+#     end
+#   end
+# end
+
+module CustomFieldsManyExtension
+  def build(attributes = {}, type = nil)
+    if _base.respond_to?(:custom_fields_for?) && _base.custom_fields_for?(association.name)
+      # all the information about how to build the custom class are stored here
+      recipe = _base.custom_fields_recipe_for(association.name)
+      attributes ||= {}
+      attributes.merge!(custom_fields_recipe: recipe)
+      # build the class with custom_fields for the first time
+      type = association.klass.klass_with_custom_fields(recipe)
+    end
+    super(attributes, type)
+  end
+  alias new build
+end
+
+::Mongoid::Association::Referenced::HasMany::Proxy.prepend CustomFieldsManyExtension

data/lib/custom_fields/extensions/mongoid/association/referenced/has_one.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CustomFieldsInExtension
+  module ClassMethods
+    def valid_options
+      [:custom_fields_parent_klass] + super
+    end
+  end
+
+  def self.prepended(base)
+    class << base
+      prepend ClassMethods
+    end
+  end
+end
+
+::Mongoid::Association::Referenced::HasOne.prepend CustomFieldsInExtension

data/lib/custom_fields/extensions/mongoid/association/relatable.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CustomFieldsRelatableExtension
+  def resolve_name(mod, name)
+    super
+  rescue NameError => e
+    return name.constantize if name =~ CustomFields::KLASS_REGEXP
+
+    raise e
+  end
+
+  def validate!
+    option = @options.delete(:custom_fields_parent_klass)
+    super.tap do
+      @options[:custom_fields_parent_klass] = option if option
+    end
+  end
+end
+
+[
+  Mongoid::Association::Embedded::EmbeddedIn,
+  Mongoid::Association::Embedded::EmbedsMany,
+  Mongoid::Association::Embedded::EmbedsOne,
+  Mongoid::Association::Referenced::BelongsTo,
+  Mongoid::Association::Referenced::HasMany,
+  Mongoid::Association::Referenced::HasAndBelongsToMany,
+  Mongoid::Association::Referenced::HasOne,
+].each do |klass|
+  klass.prepend CustomFieldsRelatableExtension
+end

data/lib/custom_fields/extensions/mongoid/criteria/queryable/smash.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Criteria
     module Queryable
-
       # This is a smart hash for use with options and selectors.
       class Smash < Hash
-
         private
 
         # Get the localized value for the key if needed. If the field uses
@@ -24,11 +23,9 @@ module Mongoid
         #
         # @since 1.0.0
         def localized_key(name, serializer)
-          serializer && serializer.localized? ? "#{name}.#{::Mongoid::Fields::I18n.locale}" : name
+          serializer&.localized? ? "#{name}.#{::Mongoid::Fields::I18n.locale}" : name
         end
-
       end
-
     end
   end
 end

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

@@ -1,9 +1,8 @@
-module Mongoid #:nodoc:
-
-  module Document #:nodoc:
-
-    module ClassMethods #:nodoc:
+# frozen_string_literal: true
 
+module Mongoid # :nodoc:
+  module Document # :nodoc:
+    module ClassMethods # :nodoc:
       # The mongoid default document returns always false.
       # The documents with custom fields return true.
       #
@@ -12,9 +11,6 @@ module Mongoid #:nodoc:
       def with_custom_fields?
         false
       end
-
     end
-
   end
-
 end

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

@@ -1,18 +1,16 @@
-module Mongoid #:nodoc:
+# frozen_string_literal: true
 
+module Mongoid # :nodoc:
   # Instantiates documents that came from the database.
   module Factory
+    def from_db_with_custom_fields(klass, attributes = nil, criteria = nil, selected_fields = nil)
+      klass.klass_with_custom_fields(attributes['custom_fields_recipe']) if klass.with_custom_fields?
 
-    def from_db_with_custom_fields(klass, attributes = nil, selected_fields = nil)
-      if klass.with_custom_fields?
-        klass.klass_with_custom_fields(attributes['custom_fields_recipe'])
-      end
-
-      from_db_without_custom_fields(klass, attributes, selected_fields)
+      from_db_without_custom_fields(klass, attributes, criteria, selected_fields)
     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
+    alias from_db_without_custom_fields from_db unless method_defined?(:from_db_without_custom_fields)
+    alias from_db from_db_with_custom_fields
   end
 end

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

@@ -1,10 +1,11 @@
-module Mongoid #:nodoc
+# frozen_string_literal: true
 
+# :nodoc
+
+module Mongoid
   # This module defines behaviour for fields.
   module Fields
-
     class I18n
-
       attr_accessor :locale, :fallbacks
 
       def self.instance
@@ -12,48 +13,47 @@ module Mongoid #:nodoc
       end
 
       def self.locale
-        self.instance.locale || ::I18n.locale
+        instance.locale || ::I18n.locale
       end
 
       def self.locale=(value)
-        self.instance.locale = value.to_sym rescue nil
+        instance.locale = begin
+          value.to_sym
+        rescue StandardError
+          nil
+        end
       end
 
       def self.fallbacks
-        if !self.instance.fallbacks.blank?
-          self.instance.fallbacks
+        if !instance.fallbacks.blank?
+          instance.fallbacks
         elsif ::I18n.respond_to?(:fallbacks)
           ::I18n.fallbacks
-        else
-          nil
         end
       end
 
       def self.fallbacks_for(locale, fallbacks)
-        self.instance.fallbacks ||= {}
-        self.instance.fallbacks[locale.to_sym] = fallbacks
+        instance.fallbacks ||= {}
+        instance.fallbacks[locale.to_sym] = fallbacks
       end
 
       def self.fallbacks?
-        !self.instance.fallbacks.blank? || (::I18n.respond_to?(:fallbacks) && !::I18n.fallbacks.blank?)
+        !instance.fallbacks.blank? || (::I18n.respond_to?(:fallbacks) && !::I18n.fallbacks.blank?)
       end
 
       def self.clear_fallbacks
-        self.instance.fallbacks.try(:clear)
+        instance.fallbacks.try(:clear)
       end
 
       def self.with_locale(new_locale = nil)
         if new_locale
-          current_locale  = self.locale
+          current_locale  = 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

@@ -1,6 +1,7 @@
-module Mongoid #:nodoc:
-  module Fields #:nodoc:
+# frozen_string_literal: true
 
+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:
@@ -9,7 +10,6 @@ module Mongoid #:nodoc:
     # TODO: use this gem instead https://github.com/simi/mongoid-localizer
     #
     class Localized < Standard
-
       def mongoize(object)
         { locale.to_s => type.mongoize(object) }
       end
@@ -17,33 +17,33 @@ module Mongoid #:nodoc:
       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?
-          lookup_with_fallback(object)
-        else
-          nil
-        end
-      end
+        value = if object.key?(locale.to_s)
+                  object[locale.to_s]
+                elsif object.key?(locale)
+                  object[locale]
+                end
+        return value unless value.nil?
 
-      def lookup_with_fallback(object)
-        fallback_locales = I18n.fallbacks[locale].try(:map, &:to_s)
+        return unless fallbacks? && i18n.respond_to?(:fallbacks)
 
-        if fallback_locales
-          _locale = fallback_locales.find { |loc| !object[loc].nil? }
-          object[_locale]
-        else
-          nil
+        fallback_key = i18n.fallbacks[locale].find do |loc|
+          object.key?(loc.to_s) || object.key?(loc)
         end
+        object[fallback_key.to_s] || object[fallback_key]
+      end
+
+      def fallbacks?
+        i18n.fallbacks?
       end
 
       def locale
         # be careful, it does not return ::I18n.locale
-        I18n.locale
+        i18n.locale
       end
 
+      def i18n
+        ::Mongoid::Fields::I18n
+      end
     end
   end
 end

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

@@ -1,10 +1,11 @@
-module Mongoid #:nodoc
+# frozen_string_literal: true
 
+# :nodoc
+
+module Mongoid
   # This module defines behaviour for fields.
   module Fields
-
     module ClassMethods
-
       # Replace a field with a new type.
       #
       # @example Replace the field.
@@ -19,13 +20,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
-        #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/validatable/collection_size.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Validatable
+    # 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 < Mongoid::Validatable::LengthValidator
+      def validate_each(record, attribute, value)
+        value = collection_to_size(record, attribute)
+
+        super(record, attribute, value)
+      end
+
+      private
+
+      def collection_to_size(record, attribute)
+        # TODO: find an example with a has_and_belongs_to_many relationship...
+        # 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
+
+        source = record.send(attribute)
+
+        OpenStruct.new(length: source.try(:size) || 0)
+      end
+    end
+  end
+end
+
+# 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 < Mongoid::Validatable::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 :validate_each_without_collection, :validate_each
+#       alias_method :validate_each, :validate_each_with_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 → validatable}/macros.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Validatable
     module Macros
@@ -17,9 +19,8 @@ module Mongoid
       #
       # @since 2.4.0
       def validates_collection_size_of(*args)
-        validates_with(Mongoid::Validations::CollectionSizeValidator, _merge_attributes(args))
+        validates_with(Mongoid::Validatable::CollectionSizeValidator, _merge_attributes(args))
       end
-
     end
   end
 end

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

@@ -1,8 +1,8 @@
-module Origin
+# frozen_string_literal: true
 
+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
@@ -25,8 +25,7 @@ module Origin
     # @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
+      serializer&.localized? ? "#{name}.#{::Mongoid::Fields::I18n.locale}" : name
     end
-
   end
-end
+end