serega 0.18.0 → 0.20.0

data/VERSION

@@ -1 +1 @@
-0.18.0
+0.20.0

data/lib/serega/attribute.rb

@@ -21,6 +21,10 @@ class Serega
       # @return [Boolean, nil] Attribute :many option
       attr_reader :many
 
+      # Attribute :default option
+      # @return [Object, nil] Attribute :default option
+      attr_reader :default
+
       # Attribute :hide option
       # @return [Boolean, nil] Attribute :hide option
       attr_reader :hide
@@ -108,9 +112,10 @@ class Serega
 
       def set_normalized_vars(normalizer)
         @name = normalizer.name
+        @many = normalizer.many
+        @default = normalizer.default
         @value_block = normalizer.value_block
         @hide = normalizer.hide
-        @many = normalizer.many
         @serializer = normalizer.serializer
       end
     end

data/lib/serega/attribute_normalizer.rb

@@ -86,6 +86,19 @@ class Serega
         @serializer = prepare_serializer
       end
 
+      #
+      # Shows the default attribute value. It is a value that replaces found nils.
+      #
+      # When custom :default is not specified, we set empty array as default when `many: true` specified
+      #
+      # @return [Object] Attribute default value
+      #
+      def default
+        return @default if instance_variable_defined?(:@default)
+
+        @default = prepare_default
+      end
+
       private
 
       def prepare_name
@@ -97,11 +110,14 @@ class Serega
       # - plugin :formatters (wraps resulted block in formatter block and formats :const values)
       #
       def prepare_value_block
-        prepare_init_block ||
+        value_block =
+          prepare_init_block ||
           prepare_value_option_block ||
           prepare_const_block ||
           prepare_delegate_block ||
           prepare_keyword_block
+
+        prepare_value_block_with_default(value_block)
       end
 
       #
@@ -158,6 +174,20 @@ class Serega
         end
       end
 
+      def prepare_value_block_with_default(callable)
+        default_value = default
+        return callable if default_value.nil?
+
+        proc { |obj, ctx|
+          res = callable.call(obj, ctx)
+          res.nil? ? default_value : res
+        }
+      end
+
+      def prepare_default
+        init_opts.fetch(:default) { many ? FROZEN_EMPTY_ARRAY : nil }
+      end
+
       def prepare_delegate_block
         delegate = init_opts[:delegate]
         return unless delegate

data/lib/serega/config.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "forwardable"
-
 class Serega
   #
   # Stores serialization config
@@ -15,7 +13,7 @@ class Serega
     DEFAULTS = {
       plugins: [],
       initiate_keys: %i[only with except check_initiate_params].freeze,
-      attribute_keys: %i[method value serializer many hide const delegate].freeze,
+      attribute_keys: %i[method value serializer many hide const delegate default].freeze,
       serialize_keys: %i[context many].freeze,
       check_attribute_name: true,
       check_initiate_params: true,

data/lib/serega/errors.rb

@@ -11,5 +11,13 @@ class Serega
   # @example
   #   Serega.new(only: 'FOO')
   #   # => Attribute 'FOO' not exists (Serega::AttributeNotExist)
-  class AttributeNotExist < SeregaError; end
+  class AttributeNotExist < SeregaError
+    attr_reader :serializer, :attributes
+
+    def initialize(message = nil, serializer = nil, attributes = nil)
+      super(message)
+      @serializer = serializer
+      @attributes = attributes
+    end
+  end
 end

data/lib/serega/object_serializer.rb

@@ -38,8 +38,8 @@ class Serega
 
       private
 
-      def serialize_array(object)
-        object.map { |obj| serialize_object(obj) }
+      def serialize_array(objects)
+        objects.map { |object| serialize_object(object) }
       end
 
       # Patched in:
@@ -79,11 +79,16 @@ class Serega
       end
 
       def relation_value(value, point)
-        child_plan = point.child_plan
-        child_serializer = point.child_object_serializer
-        child_many = point.many
-        serializer = child_serializer.new(context: context, plan: child_plan, many: child_many, **opts)
-        serializer.serialize(value)
+        child_serializer(point).serialize(value)
+      end
+
+      def child_serializer(point)
+        point.child_object_serializer.new(
+          context: context,
+          plan: point.child_plan,
+          many: point.many,
+          **opts
+        )
       end
 
       def array?(object, many)

data/lib/serega/plan_point.rb

@@ -9,8 +9,6 @@ class Serega
     # SeregaPlanPoint instance methods
     #
     module InstanceMethods
-      extend Forwardable
-
       # Link to current plan this point belongs to
       # @return [SeregaAttribute] Current plan
       attr_reader :plan
@@ -27,20 +25,6 @@ class Serega
       # @return [Hash] Attributes to serialize
       attr_reader :modifiers
 
-      # @!method name
-      #   Attribute `name`
-      #   @see SeregaAttribute::AttributeInstanceMethods#name
-      # @!method value
-      #   Attribute `value` block
-      #   @see SeregaAttribute::AttributeInstanceMethods#value
-      # @!method many
-      #   Attribute `many` option
-      #   @see SeregaAttribute::AttributeInstanceMethods#many
-      # @!method serializer
-      #   Attribute `serializer` option
-      #   @see SeregaAttribute::AttributeInstanceMethods#serializer
-      def_delegators :@attribute, :name, :value, :many, :serializer
-
       #
       # Initializes plan point
       #
@@ -60,6 +44,30 @@ class Serega
         set_normalized_vars
       end
 
+      # Attribute `value`
+      # @see SeregaAttribute::AttributeInstanceMethods#value
+      def value(obj, ctx)
+        attribute.value(obj, ctx)
+      end
+
+      # Attribute `name`
+      # @see SeregaAttribute::AttributeInstanceMethods#value
+      def name
+        attribute.name
+      end
+
+      # Attribute `many` option
+      # @see SeregaAttribute::AttributeInstanceMethods#many
+      def many
+        attribute.many
+      end
+
+      # Attribute `serializer` option
+      # @see SeregaAttribute::AttributeInstanceMethods#serializer
+      def serializer
+        attribute.serializer
+      end
+
       #
       # @return [SeregaObjectSerializer] object serializer for child plan
       #

data/lib/serega/plugins/activerecord_preloads/activerecord_preloads.rb

@@ -54,17 +54,21 @@ class Serega
       # Checks requirements to load plugin
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] plugins options
+      # @param opts [Hash] plugin options
       #
       # @return [void]
       #
-      def self.before_load_plugin(serializer_class, **_opts)
+      def self.before_load_plugin(serializer_class, **opts)
+        opts.each_key do |key|
+          raise SeregaError, "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. No options are allowed"
+        end
+
         unless serializer_class.plugin_used?(:preloads)
-          raise SeregaError, "Please load `plugin :preloads` first"
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded after the :preloads plugin. Please load the :preloads plugin first"
         end
 
         if serializer_class.plugin_used?(:batch)
-          raise SeregaError, "Plugin `activerecord_preloads` must be loaded before `batch`"
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded before the :batch plugin"
         end
       end
 
@@ -72,7 +76,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/batch/batch.rb

@@ -14,7 +14,7 @@ class Serega
     #   end
     #
     #   class UserSerializer < AppSerializer
-    #     attribute :comments_count, batch: { loader: CommentsCountBatchLoader, default: 0 }
+    #     attribute :comments_count, batch: { loader: CommentsCountBatchLoader }, default: 0
     #     attribute :company, serializer: CompanySerializer, batch: { loader: UserCompanyBatchLoader }
     #   end
     #
@@ -25,11 +25,30 @@ class Serega
         :batch
       end
 
+      # Checks requirements to load plugin
+      #
+      # @param serializer_class [Class<Serega>] Current serializer class
+      # @param opts [Hash] plugin options
+      #
+      # @return [void]
+      #
+      def self.before_load_plugin(serializer_class, **opts)
+        allowed_keys = %i[auto_hide id_method]
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :auto_hide [Boolean] - Marks attribute as hidden when it has :batch loader specified\n" \
+            "  - :id_method [Symbol, #call] - Specified the default method to use to find object identifier"
+        end
+      end
+
       #
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -60,7 +79,7 @@ class Serega
       # Runs callbacks after plugin was attached
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/batch/lib/modules/attribute_normalizer.rb

@@ -47,8 +47,6 @@ class Serega
           id_method = batch[:id_method] || self.class.serializer_class.config.batch.id_method
           id_method = prepare_batch_id_method(id_method)
 
-          default = batch.fetch(:default) { many ? FROZEN_EMPTY_ARRAY : nil }
-
           {loader: loader, id_method: id_method, default: default}
         end
 

data/lib/serega/plugins/batch/lib/validations/check_opt_batch.rb

@@ -23,7 +23,7 @@ class Serega
             SeregaValidations::Utils::CheckOptIsHash.call(opts, :batch)
 
             batch = opts[:batch]
-            SeregaValidations::Utils::CheckAllowedKeys.call(batch, %i[id_method loader default], :batch)
+            SeregaValidations::Utils::CheckAllowedKeys.call(batch, %i[id_method loader], :batch)
 
             check_batch_opt_id_method(batch, serializer_class)
             check_batch_opt_loader(batch, serializer_class)

data/lib/serega/plugins/camel_case/camel_case.rb

@@ -48,11 +48,29 @@ class Serega
         :camel_case
       end
 
+      # Checks requirements to load plugin
+      #
+      # @param serializer_class [Class<Serega>] Current serializer class
+      # @param opts [Hash] plugin options
+      #
+      # @return [void]
+      #
+      def self.before_load_plugin(serializer_class, **opts)
+        allowed_keys = %i[transform]
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :transform [#call] - Custom transformation"
+        end
+      end
+
       #
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -66,7 +84,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/context_metadata/context_metadata.rb

@@ -30,13 +30,22 @@ class Serega
       # Checks requirements and loads additional plugins
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #
       def self.before_load_plugin(serializer_class, **opts)
+        allowed_keys = %i[context_metadata_key]
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :context_metadata_key [Symbol] - The key name that must be used to add metadata. Default is :meta."
+        end
+
         unless serializer_class.plugin_used?(:root)
-          raise SeregaError, "Please load :root plugin first so we can wrap serialization response into top-level hash to add metadata there"
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded after the :root plugin. Please load the :root plugin first"
         end
       end
 
@@ -44,7 +53,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -58,7 +67,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/depth_limit/depth_limit.rb

@@ -41,11 +41,29 @@ class Serega
         :depth_limit
       end
 
+      # Checks requirements
+      #
+      # @param serializer_class [Class<Serega>] Current serializer class
+      # @param opts [Hash] Plugin options
+      #
+      # @return [void]
+      #
+      def self.before_load_plugin(serializer_class, **opts)
+        allowed_keys = %i[limit]
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :limit [Integer] - Maximum serialization depth."
+        end
+      end
+
       #
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -58,7 +76,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/explicit_many_option/explicit_many_option.rb

@@ -35,7 +35,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/formatters/formatters.rb

@@ -51,13 +51,22 @@ class Serega
       # Checks requirements and loads additional plugins
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #
       def self.before_load_plugin(serializer_class, **opts)
+        allowed_keys = %i[formatters]
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :formatters [Hash<Symbol, #call>] - Formatters (names and according callable values)"
+        end
+
         if serializer_class.plugin_used?(:batch)
-          raise SeregaError, "Plugin `formatters` must be loaded before `batch`"
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded before the :batch plugin"
         end
       end
 
@@ -65,7 +74,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -79,7 +88,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/if/if.rb

@@ -51,7 +51,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -72,7 +72,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/metadata/meta_attribute.rb

@@ -65,7 +65,7 @@ class Serega
           def normalize_block(value, const, block)
             return proc { const } if const
 
-            callable = (value || block)
+            callable = value || block
             params_count = SeregaUtils::ParamsCount.call(callable, max_count: 2)
 
             case params_count

data/lib/serega/plugins/metadata/metadata.rb

@@ -46,13 +46,13 @@ class Serega
       # Checks requirements and loads additional plugins
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] loaded plugins opts
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
       def self.before_load_plugin(serializer_class, **_opts)
         unless serializer_class.plugin_used?(:root)
-          raise SeregaError, "Please load :root plugin first so we can wrap serialization response into top-level hash to add metadata there"
+          raise SeregaError, "Plugin #{plugin_name.inspect} must be loaded after the :root plugin. Please load the :root plugin first"
         end
       end
 
@@ -60,7 +60,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -87,7 +87,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] loaded plugins opts
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/preloads/lib/preloads_config.rb

@@ -51,7 +51,7 @@ class Serega
             opts.fetch(method_name)
           end
 
-          define_method("#{method_name}=") do |value|
+          define_method(:"#{method_name}=") do |value|
             raise SeregaError, "Must have boolean value, #{value.inspect} provided" if (value != true) && (value != false)
             opts[method_name] = value
           end

data/lib/serega/plugins/preloads/preloads.rb

@@ -70,11 +70,31 @@ class Serega
         :preloads
       end
 
+      # Checks requirements to load plugin
+      #
+      # @param serializer_class [Class<Serega>] Current serializer class
+      # @param opts [Hash] plugin options
+      #
+      # @return [void]
+      #
+      def self.before_load_plugin(serializer_class, **opts)
+        allowed_keys = DEFAULT_CONFIG.keys
+        opts.each_key do |key|
+          next if allowed_keys.include?(key)
+
+          raise SeregaError,
+            "Plugin #{plugin_name.inspect} does not accept the #{key.inspect} option. Allowed options:\n" \
+            "  - :auto_preload_attributes_with_delegate [Boolean] - Automatically adds `preload: <delegate_to>` option to attributes with :delegate option specified\n" \
+            "  - :auto_preload_attributes_with_serializer [Boolean] - Automatically adds `preload: <attribute_name>` option to attributes with :serializer option specified\n" \
+            "  - :auto_hide_attributes_with_preload [Boolean] - Automatically adds `hide: true` option to attributes with :preload option (specified manually or added automatically)"
+        end
+      end
+
       #
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -104,7 +124,7 @@ class Serega
       # Adds config options and runs other callbacks after plugin was loaded
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param opts [Hash] loaded plugins opts
+      # @param opts [Hash] Plugin options
       #
       # @return [void]
       #

data/lib/serega/plugins/presenter/presenter.rb

@@ -29,7 +29,7 @@ class Serega
       # Applies plugin code to specific serializer
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] Loaded plugins options
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #
@@ -42,7 +42,7 @@ class Serega
       # Runs callbacks after plugin was attached
       #
       # @param serializer_class [Class<Serega>] Current serializer class
-      # @param _opts [Hash] loaded plugins opts
+      # @param _opts [Hash] Plugin options
       #
       # @return [void]
       #