serega 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0677ac2e319673d37e712b840c9485abf9ec2cd578a66d0a4d667e6134b4b3e
-  data.tar.gz: 7711764ae779bd31ed3c203fff925279ca19c9c74acb94cc58e4a4a302da35a9
+  metadata.gz: 88e403fa3d489c2c708aca3f9df3734bcfc64f8e61eed4b96b9635cdf1a16622
+  data.tar.gz: 1c7f92f7defa3c2415257e69021ed70f0c07b43b0f468969589a1ed18148507b
 SHA512:
-  metadata.gz: e5f26401f3388020f8051543f19a03f223b424d55d9ce91a6c11c0ad7646e398d68d746227746297f5fb9dc387c7adaa84f6fdaa2d0829b8f2d3e13b516c28ec
-  data.tar.gz: 0fbb40978adcaa91756bd59f6ed70b5a905eb25f0b6e60d2bb22f85bd4e9f7c4a51f37c987d035cc761bb0cab52f400472718ea992b576c89a39d582267c6b9a
+  metadata.gz: 50aec430bd1d42cccc89c82635700734569ffde5de0780782af0454feae87fbb11fc273b91bb1c936fb3001c26d24db72726928fc8f7d93ccf4b4b846a43147f
+  data.tar.gz: 883c4e0e945663939b75c62e237b0268b9d8fd60ff2f31f7066a72021a9f90c045ca404c725ae787bc7268cf5f5cbd208f626c8f97ec22ebbc4208f0208e8233

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/lib/serega/attribute.rb

@@ -4,7 +4,7 @@ class Serega
   #
   # Stores Attribute data
   #
-  class Attribute
+  class SeregaAttribute
     #
     # Stores Attribute instance methods
     #
@@ -36,7 +36,7 @@ class Serega
         self.class.serializer_class::CheckAttributeParams.new(name, opts, block).validate
 
         @name = name.to_sym
-        @opts = Utils::EnumDeepDup.call(opts)
+        @opts = SeregaUtils::EnumDeepDup.call(opts)
         @block = block
       end
 
@@ -77,7 +77,7 @@ class Serega
       def value_block
         return @value_block if instance_variable_defined?(:@value_block)
 
-        @value_block = block || opts[:value] || const_block || keyword_block
+        @value_block = block || opts[:value] || const_block || delegate_block || keyword_block
       end
 
       #
@@ -123,9 +123,22 @@ class Serega
         key_method_name = key
         proc { |object| object.public_send(key_method_name) }
       end
+
+      def delegate_block
+        return unless opts.key?(:delegate)
+
+        key_method_name = key
+        delegate_to = opts[:delegate][:to]
+
+        if opts[:delegate][:allow_nil]
+          proc { |object| object.public_send(delegate_to)&.public_send(key_method_name) }
+        else
+          proc { |object| object.public_send(delegate_to).public_send(key_method_name) }
+        end
+      end
     end
 
-    extend Serega::Helpers::SerializerClassHelper
+    extend Serega::SeregaHelpers::SerializerClassHelper
     include AttributeInstanceMethods
   end
 end

data/lib/serega/config.rb

@@ -6,8 +6,8 @@ class Serega
   #
   # Core class that stores serializer configuration
   #
-  class Config
-    module ConfigInstanceMethods
+  class SeregaConfig
+    module SeregaConfigInstanceMethods
       extend Forwardable
 
       # @return [Hash] Current config data
@@ -20,7 +20,7 @@ class Serega
       # @param opts [Hash] Initial config options
       #
       def initialize(opts = {})
-        @opts = Utils::EnumDeepDup.call(opts)
+        @opts = SeregaUtils::EnumDeepDup.call(opts)
       end
 
       #
@@ -42,7 +42,7 @@ class Serega
       def_delegators :opts, :[], :[]=, :fetch, :keys, :has_key?
     end
 
-    include ConfigInstanceMethods
-    extend Serega::Helpers::SerializerClassHelper
+    include SeregaConfigInstanceMethods
+    extend Serega::SeregaHelpers::SerializerClassHelper
   end
 end

data/lib/serega/convert.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 class Serega
-  class Convert
-    module ConvertClassMethods
+  class SeregaConvert
+    module SeregaConvertClassMethods
       def call(object, **opts)
         new(object, **opts).to_h
       end
     end
 
-    module ConvertInstanceMethods
+    module SeregaConvertInstanceMethods
       attr_reader :object, :opts
 
       def initialize(object, **opts)
@@ -27,7 +27,7 @@ class Serega
       end
 
       def one(object)
-        self.class.serializer_class::ConvertItem.call(object, opts[:context], opts[:map])
+        self.class.serializer_class::SeregaConvertItem.call(object, opts[:context], opts[:map])
       end
 
       def many?
@@ -38,8 +38,8 @@ class Serega
       end
     end
 
-    extend Serega::Helpers::SerializerClassHelper
-    extend ConvertClassMethods
-    include ConvertInstanceMethods
+    extend Serega::SeregaHelpers::SerializerClassHelper
+    extend SeregaConvertClassMethods
+    include SeregaConvertInstanceMethods
   end
 end

data/lib/serega/convert_item.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 class Serega
-  class ConvertItem
-    module ConvertItemClassMethods
+  class SeregaConvertItem
+    module SeregaConvertItemClassMethods
       def call(object, context, map)
         return unless object
 
@@ -31,7 +31,7 @@ class Serega
       end
     end
 
-    extend Serega::Helpers::SerializerClassHelper
-    extend ConvertItemClassMethods
+    extend Serega::SeregaHelpers::SerializerClassHelper
+    extend SeregaConvertItemClassMethods
   end
 end

data/lib/serega/helpers/serializer_class_helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Helpers
+  module SeregaHelpers
     # Stores link to current serializer class
     module SerializerClassHelper
       # @return [Class<Serega>] Serializer class that current class is namespaced under.

data/lib/serega/map.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  class Map
+  class SeregaMap
     module ClassMethods
       def call(opts)
         @cache ||= {}
@@ -44,6 +44,6 @@ class Serega
     end
 
     extend ClassMethods
-    extend Serega::Helpers::SerializerClassHelper
+    extend Serega::SeregaHelpers::SerializerClassHelper
   end
 end

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     #
     # Plugin that checks used plugins and loads correct Preloader for selected response type
-    # @see Serega::Plugins::JsonApiActiverecordPreloader
-    # @see Serega::Plugins::SimpleApiActiverecordPreloader
+    # @see Serega::SeregaPlugins::JsonApiActiverecordPreloader
+    # @see Serega::SeregaPlugins::SimpleApiActiverecordPreloader
     #
     module ActiverecordPreloads
       # @return [Symbol] plugin name

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module ActiverecordPreloads
       class Preloader
         module ClassMethods
           def preload(object, preloads)
             preload_handler = handlers.find { |handler| handler.fit?(object) }
-            raise Error, "Can't preload #{preloads.inspect} to #{object.inspect}" unless preload_handler
+            raise SeregaError, "Can't preload #{preloads.inspect} to #{object.inspect}" unless preload_handler
 
             preload_handler.preload(object, preloads)
           end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module ContextMetadata
       DEFAULT_CONTEXT_METADATA_KEY = :meta
 
@@ -14,8 +14,8 @@ class Serega
       end
 
       def self.load_plugin(serializer_class, **_opts)
-        serializer_class.include(InstanceMethods)
-        serializer_class::Convert.include(ConvertInstanceMethods)
+        serializer_class::SeregaConvert.include(SeregaConvertInstanceMethods)
+        serializer_class::CheckSerializeParams.extend(CheckSerializeParamsClassMethods)
       end
 
       def self.after_load_plugin(serializer_class, **opts)
@@ -25,20 +25,16 @@ class Serega
         config[:serialize_keys] << meta_key
       end
 
-      module InstanceMethods
-        def to_h(object, **opts)
-          meta_key = self.class.config[:context_metadata][:key]
-          meta = opts[meta_key]
-
-          if meta && !meta.is_a?(Hash)
-            raise Serega::Error, "Option :#{meta_key} must be a Hash, but #{meta.class} was given"
-          end
-
+      module CheckSerializeParamsClassMethods
+        def check_opts(opts)
           super
+
+          meta_key = serializer_class.config[:context_metadata][:key]
+          SeregaValidations::SeregaUtils::CheckOptIsHash.call(opts, meta_key)
         end
       end
 
-      module ConvertInstanceMethods
+      module SeregaConvertInstanceMethods
         def to_h
           super.tap do |hash|
             add_context_metadata(hash)

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

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Formatters
       def self.plugin_name
         :formatters
       end
 
       def self.load_plugin(serializer_class, **_opts)
-        serializer_class::Attribute.include(AttributeInstanceMethods)
+        serializer_class::SeregaAttribute.include(AttributeInstanceMethods)
       end
 
       def self.after_load_plugin(serializer_class, **_opts)
@@ -25,7 +25,15 @@ class Serega
           formatter = opts[:format]
           return original_block unless formatter
 
-          @value_block = formatted_block(formatter, original_block)
+          new_value_block = formatted_block(formatter, original_block)
+
+          # Detect formatted :const value in advance
+          if opts.key?(:const)
+            const_value = new_value_block.call
+            new_value_block = proc { const_value }
+          end
+
+          @value_block = new_value_block
         end
 
         private

data/lib/serega/plugins/hide_nil/hide_nil.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     #
     # Plugin adds `:hide_nil` option to attributes to delete them from final result
     # if value is nil
@@ -21,9 +21,9 @@ class Serega
       # @return [void]
       #
       def self.load_plugin(serializer_class, **_opts)
-        serializer_class::Attribute.include(AttributeMethods)
+        serializer_class::SeregaAttribute.include(AttributeMethods)
         serializer_class::CheckAttributeParams.include(CheckAttributeParamsInstanceMethods)
-        serializer_class::ConvertItem.extend(ConvertItemClassMethods)
+        serializer_class::SeregaConvertItem.extend(SeregaConvertItemClassMethods)
       end
 
       def self.after_load_plugin(serializer_class, **opts)
@@ -52,7 +52,7 @@ class Serega
         #
         # @param opts [Hash] Attribute options
         #
-        # @raise [Serega::Error] Error that option has invalid value
+        # @raise [Serega::SeregaError] SeregaError that option has invalid value
         #
         # @return [void]
         #
@@ -62,11 +62,11 @@ class Serega
           value = opts[:hide_nil]
           return if (value == true) || (value == false)
 
-          raise Error, "Invalid option :hide_nil => #{value.inspect}. Must have a boolean value"
+          raise SeregaError, "Invalid option :hide_nil => #{value.inspect}. Must have a boolean value"
         end
       end
 
-      module ConvertItemClassMethods
+      module SeregaConvertItemClassMethods
         private
 
         def attach_value(value, *args)

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Metadata
       #
       # Stores Attribute data
@@ -36,8 +36,8 @@ class Serega
             check(path, opts, block)
 
             @name = path.join(".").to_sym
-            @path = Utils::EnumDeepDup.call(path)
-            @opts = Utils::EnumDeepDup.call(opts)
+            @path = SeregaUtils::EnumDeepDup.call(path)
+            @opts = SeregaUtils::EnumDeepDup.call(opts)
             @block = block
           end
 
@@ -66,7 +66,7 @@ class Serega
           end
         end
 
-        extend Serega::Helpers::SerializerClassHelper
+        extend Serega::SeregaHelpers::SerializerClassHelper
         include InstanceMethods
       end
     end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Metadata
       def self.plugin_name
         :metadata
@@ -13,7 +13,7 @@ class Serega
 
       def self.load_plugin(serializer_class, **_opts)
         serializer_class.extend(ClassMethods)
-        serializer_class::Convert.include(ConvertInstanceMethods)
+        serializer_class::SeregaConvert.include(SeregaConvertInstanceMethods)
 
         require_relative "./meta_attribute"
         require_relative "./validations/check_block"
@@ -79,7 +79,7 @@ class Serega
         end
       end
 
-      module ConvertInstanceMethods
+      module SeregaConvertInstanceMethods
         def to_h
           hash = super
           add_metadata(hash)

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Metadata
       class MetaAttribute
         class CheckBlock
@@ -25,17 +25,17 @@ class Serega
             #
             # @param block [Proc] Block that returns serialized meta attribute value
             #
-            # @raise [Error] Error that block has invalid arguments
+            # @raise [SeregaError] SeregaError that block has invalid arguments
             #
             # @return [void]
             #
             def call(block)
-              raise Error, "Block must be provided when defining meta attribute" unless block
+              raise SeregaError, "Block must be provided when defining meta attribute" unless block
 
               params = block.parameters
               return if (params.count <= 2) && params.all? { |par| ALLOWED_PARAM_TYPES.include?(par[0]) }
 
-              raise Error, "Block can have maximum 2 regular parameters (no **keyword or *array args)"
+              raise SeregaError, "Block can have maximum 2 regular parameters (no **keyword or *array args)"
             end
           end
         end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Metadata
       class MetaAttribute
         class CheckOptHideEmpty
@@ -11,7 +11,7 @@ class Serega
             #
             # @param opts [Hash] Attribute options
             #
-            # @raise [Error] Error that option has invalid value
+            # @raise [SeregaError] SeregaError that option has invalid value
             #
             # @return [void]
             #
@@ -21,7 +21,7 @@ class Serega
               value = opts[:hide_empty]
               return if value == true
 
-              raise Error, "Invalid option :hide_empty => #{value.inspect}. Must be true"
+              raise SeregaError, "Invalid option :hide_empty => #{value.inspect}. Must be true"
             end
           end
         end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Metadata
       class MetaAttribute
         class CheckOptHideNil
@@ -11,7 +11,7 @@ class Serega
             #
             # @param opts [Hash] Attribute options
             #
-            # @raise [Error] Error that option has invalid value
+            # @raise [SeregaError] SeregaError that option has invalid value
             #
             # @return [void]
             #
@@ -21,7 +21,7 @@ class Serega
               value = opts[:hide_nil]
               return if value == true
 
-              raise Error, "Invalid option :hide_nil => #{value.inspect}. Must be true"
+              raise SeregaError, "Invalid option :hide_nil => #{value.inspect}. Must be true"
             end
           end
         end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Metadata
       class MetaAttribute
         class CheckOpts
@@ -13,7 +13,7 @@ class Serega
             # @param opts [Hash] Attribute options
             # @param attribute_keys [Array<Symbol>] Allowed options keys
             #
-            # @raise [Error] when attribute has invalid options
+            # @raise [SeregaError] when attribute has invalid options
             #
             # @return [void]
             #
@@ -21,7 +21,7 @@ class Serega
               opts.each_key do |key|
                 next if attribute_keys.include?(key.to_sym)
 
-                raise Error, "Invalid option #{key.inspect}. Allowed options are: #{attribute_keys.map(&:inspect).join(", ")}"
+                raise SeregaError, "Invalid option #{key.inspect}. Allowed options are: #{attribute_keys.map(&:inspect).join(", ")}"
               end
 
               check_each_opt(opts)

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Metadata
       class MetaAttribute
         class CheckPath
@@ -18,7 +18,7 @@ class Serega
             #
             # @param path [Array<String, Symbol>] Metadata attribute path names
             #
-            # @raise [Error] when metadata attribute name has invalid format
+            # @raise [SeregaError] when metadata attribute name has invalid format
             # @return [void]
             #
             def call(path)
@@ -39,7 +39,7 @@ class Serega
 
               return if valid
 
-              raise Error, message(name)
+              raise SeregaError, message(name)
             end
 
             def message(name)

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Preloads
       # Freezes nested enumerable data
       class EnumDeepFreeze

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Preloads
       # Transforms user provided preloads to hash
       class FormatUserPreloads

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Preloads
       class MainPreloadPath
         module ClassMethods

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Preloads
       #
       # Finds relations to preload for provided serializer
@@ -29,7 +29,7 @@ class Serega
               next unless current_preloads
 
               has_nested = nested_map.any?
-              current_preloads = Utils::EnumDeepDup.call(current_preloads) if has_nested
+              current_preloads = SeregaUtils::EnumDeepDup.call(current_preloads) if has_nested
               append_current(preloads, current_preloads)
               next unless has_nested
 

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     #
     # Plugin adds `.preloads` method to find relations that must be preloaded
     #
@@ -21,7 +21,7 @@ class Serega
       #
       def self.load_plugin(serializer_class, **_opts)
         serializer_class.include(InstanceMethods)
-        serializer_class::Attribute.include(AttributeMethods)
+        serializer_class::SeregaAttribute.include(AttributeMethods)
 
         serializer_class::CheckAttributeParams.include(CheckAttributeParamsInstanceMethods)
 
@@ -29,13 +29,18 @@ class Serega
         require_relative "./lib/format_user_preloads"
         require_relative "./lib/main_preload_path"
         require_relative "./lib/preloads_constructor"
+        require_relative "./validations/check_opt_preload"
         require_relative "./validations/check_opt_preload_path"
       end
 
       def self.after_load_plugin(serializer_class, **opts)
         config = serializer_class.config
         config[:attribute_keys] += [:preload, :preload_path]
-        config[:preloads] = {auto_preload_relations: opts.fetch(:auto_preload_relations, true)}
+        config[:preloads] = {
+          auto_preload_attributes_with_delegate: opts.fetch(:auto_preload_attributes_with_delegate, false),
+          auto_preload_attributes_with_serializer: opts.fetch(:auto_preload_attributes_with_serializer, false),
+          auto_hide_attributes_with_preload: opts.fetch(:auto_hide_attributes_with_preload, false)
+        }
       end
 
       # Adds #preloads instance method
@@ -60,15 +65,31 @@ class Serega
           @preloads_path = get_preloads_path
         end
 
+        def hide
+          res = super
+          return res unless res.nil?
+
+          auto_hide_attribute_with_preloads? || nil
+        end
+
         private
 
+        def auto_hide_attribute_with_preloads?
+          return @auto_hide_attribute_with_preloads if defined?(@auto_hide_attribute_with_preloads)
+
+          auto = self.class.serializer_class.config[:preloads][:auto_hide_attributes_with_preload]
+          @auto_hide_attribute_with_preloads = auto && !preloads.nil? && (preloads != false) && (preloads != {})
+        end
+
         def get_preloads
           preloads_provided = opts.key?(:preload)
           preloads =
             if preloads_provided
               opts[:preload]
-            elsif relation? && self.class.serializer_class.config[:preloads][:auto_preload_relations]
+            elsif relation? && self.class.serializer_class.config[:preloads][:auto_preload_attributes_with_serializer]
               key
+            elsif opts.key?(:delegate) && self.class.serializer_class.config[:preloads][:auto_preload_attributes_with_delegate]
+              opts[:delegate].fetch(:to)
             end
 
           # Nil and empty hash differs as we can preload nested results to
@@ -90,6 +111,7 @@ class Serega
 
         def check_opts
           super
+          CheckOptPreload.call(opts)
           CheckOptPreloadPath.call(opts)
         end
       end