serega 0.1.4 → 0.3.0

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

@@ -1,19 +1,26 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Metadata
       def self.plugin_name
         :metadata
       end
 
       def self.before_load_plugin(serializer_class, **opts)
-        serializer_class.plugin(:root, **opts) unless serializer_class.plugin_used?(:root)
+        if serializer_class.plugin_used?(:root)
+          root = serializer_class.config.root
+          root.one = opts[:root_one] if opts.key?(:root_one)
+          root.many = opts[:root_many] if opts.key?(:root_many)
+        else
+          serializer_class.plugin(:root, **opts)
+        end
       end
 
       def self.load_plugin(serializer_class, **_opts)
         serializer_class.extend(ClassMethods)
-        serializer_class::Convert.include(ConvertInstanceMethods)
+        serializer_class::SeregaConfig.include(ConfigInstanceMethods)
+        serializer_class::SeregaConvert.include(SeregaConvertInstanceMethods)
 
         require_relative "./meta_attribute"
         require_relative "./validations/check_block"
@@ -28,7 +35,25 @@ class Serega
       end
 
       def self.after_load_plugin(serializer_class, **_opts)
-        serializer_class.config[plugin_name] = {attribute_keys: %i[path hide_nil hide_empty]}
+        serializer_class.config.opts[:metadata] = {attribute_keys: %i[path hide_nil hide_empty]}
+      end
+
+      class MetadataConfig
+        attr_reader :opts
+
+        def initialize(opts)
+          @opts = opts
+        end
+
+        def attribute_keys
+          opts.fetch(:attribute_keys)
+        end
+      end
+
+      module ConfigInstanceMethods
+        def metadata
+          MetadataConfig.new(opts.fetch(:metadata))
+        end
       end
 
       module ClassMethods
@@ -79,7 +104,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,11 +1,17 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     #
     # Plugin adds `.preloads` method to find relations that must be preloaded
     #
     module Preloads
+      DEFAULT_CONFIG = {
+        auto_preload_attributes_with_delegate: false,
+        auto_preload_attributes_with_serializer: false,
+        auto_hide_attributes_with_preload: false
+      }.freeze
+
       # @return [Symbol] plugin name
       def self.plugin_name
         :preloads
@@ -21,7 +27,8 @@ 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::SeregaConfig.include(ConfigInstanceMethods)
 
         serializer_class::CheckAttributeParams.include(CheckAttributeParamsInstanceMethods)
 
@@ -29,13 +36,20 @@ 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.attribute_keys << :preload << :preload_path
+
+        preloads_opts = DEFAULT_CONFIG.merge(opts.slice(*DEFAULT_CONFIG.keys))
+        config.opts[:preloads] = {}
+        preloads_config = config.preloads
+        preloads_config.auto_preload_attributes_with_delegate = preloads_opts[:auto_preload_attributes_with_delegate]
+        preloads_config.auto_preload_attributes_with_serializer = preloads_opts[:auto_preload_attributes_with_serializer]
+        preloads_config.auto_hide_attributes_with_preload = preloads_opts[:auto_hide_attributes_with_preload]
       end
 
       # Adds #preloads instance method
@@ -46,6 +60,35 @@ class Serega
         end
       end
 
+      class PreloadsConfig
+        attr_reader :opts
+
+        def initialize(opts)
+          @opts = opts
+        end
+
+        %i[
+          auto_preload_attributes_with_delegate
+          auto_preload_attributes_with_serializer
+          auto_hide_attributes_with_preload
+        ].each do |method_name|
+          define_method(method_name) do
+            opts.fetch(method_name)
+          end
+
+          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
+        end
+      end
+
+      module ConfigInstanceMethods
+        def preloads
+          PreloadsConfig.new(opts.fetch(:preloads))
+        end
+      end
+
       # Adds #preloads and #preloads_path Attribute instance method
       module AttributeMethods
         def preloads
@@ -60,15 +103,29 @@ 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?
+          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 +147,7 @@ class Serega
 
         def check_opts
           super
+          CheckOptPreload.call(opts)
           CheckOptPreloadPath.call(opts)
         end
       end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaPlugins
+    module Preloads
+      class CheckOptPreload
+        class << self
+          def call(opts)
+            return unless opts.key?(:preload)
+
+            raise SeregaError, "Option :preload can not be used together with option :const" if opts.key?(:const)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Preloads
       class CheckOptPreloadPath
         class << self
@@ -9,13 +9,13 @@ class Serega
             return unless opts.key?(:preload_path)
 
             value = opts[:preload_path]
-            raise Error, "Invalid option :preload_path => #{value.inspect}. Can be provided only when :preload option provided" unless opts[:preload]
-            raise Error, "Invalid option :preload_path => #{value.inspect}. Can be provided only when :serializer option provided" unless opts[:serializer]
+            raise SeregaError, "Invalid option :preload_path => #{value.inspect}. Can be provided only when :preload option provided" unless opts[:preload]
+            raise SeregaError, "Invalid option :preload_path => #{value.inspect}. Can be provided only when :serializer option provided" unless opts[:serializer]
 
             path = Array(value).map!(&:to_sym)
             preloads = FormatUserPreloads.call(opts[:preload])
             allowed_paths = paths(preloads)
-            raise Error, "Invalid option :preload_path => #{value.inspect}. Can be one of #{allowed_paths.inspect[1..-2]}" unless allowed_paths.include?(path)
+            raise SeregaError, "Invalid option :preload_path => #{value.inspect}. Can be one of #{allowed_paths.inspect[1..-2]}" unless allowed_paths.include?(path)
           end
 
           private

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

@@ -4,7 +4,7 @@ require "delegate"
 require "forwardable"
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     #
     # Plugin Presenter adds possibility to use declare Presenter for your objects inside serializer
     #
@@ -35,7 +35,7 @@ class Serega
       #
       def self.load_plugin(serializer_class, **_opts)
         serializer_class.extend(ClassMethods)
-        serializer_class::ConvertItem.extend(ConvertItemClassMethods)
+        serializer_class::SeregaConvertItem.extend(SeregaConvertItemClassMethods)
       end
 
       #
@@ -69,7 +69,7 @@ class Serega
           end
         end
 
-        extend Helpers::SerializerClassHelper
+        extend SeregaHelpers::SerializerClassHelper
         extend Forwardable
         include InstanceMethods
       end
@@ -85,7 +85,7 @@ class Serega
         end
 
         # Overrides {Serega::ClassMethods#attribute} method, additionally adds method
-        # to Presenter to not hit {Serega::Plugins::Presenter::Presenter#method_missing}
+        # to Presenter to not hit {Serega::SeregaPlugins::Presenter::Presenter#method_missing}
         # @see Serega::ClassMethods#attribute
         def attribute(_name, **_opts, &_block)
           super.tap do |attribute|
@@ -94,8 +94,8 @@ class Serega
         end
       end
 
-      # Includes methods to override ConvertItem class
-      module ConvertItemClassMethods
+      # Includes methods to override SeregaConvertItem class
+      module SeregaConvertItemClassMethods
         #
         # Replaces serialized object with Presenter.new(object)
         #

data/lib/serega/plugins/root/root.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module Root
       # @return [Symbol] Default response root key
       ROOT_DEFAULT = :data
@@ -12,12 +12,17 @@ class Serega
 
       def self.load_plugin(serializer_class, **_opts)
         serializer_class.extend(ClassMethods)
-        serializer_class::Convert.include(ConvertInstanceMethods)
+        serializer_class::SeregaConfig.include(SeregaConfigInstanceMethods)
+        serializer_class::SeregaConvert.include(SeregaConvertInstanceMethods)
       end
 
       def self.after_load_plugin(serializer_class, **opts)
-        serializer_class.root(opts[:root] || ROOT_DEFAULT, one: opts[:root_one], many: opts[:root_many])
-        serializer_class.config[:serialize_keys] << :root
+        config = serializer_class.config
+        default = opts[:root] || ROOT_DEFAULT
+        one = (opts[:root_one] || default).to_sym
+        many = (opts[:root_many] || default).to_sym
+        config.opts[:root] = {one: one, many: many}
+        config.serialize_keys << :root
       end
 
       module ClassMethods
@@ -37,11 +42,46 @@ class Serega
           one = one.to_sym if one
           many = many.to_sym if many
 
-          config[:root] = {one: one, many: many}
+          config.root = {one: one, many: many}
         end
       end
 
-      module ConvertInstanceMethods
+      class RootConfig
+        attr_reader :opts
+
+        def initialize(opts)
+          @opts = opts
+        end
+
+        def one
+          opts.fetch(:one)
+        end
+
+        def many
+          opts.fetch(:many)
+        end
+
+        def one=(value)
+          opts[:one] = value
+        end
+
+        def many=(value)
+          opts[:many] = value
+        end
+      end
+
+      module SeregaConfigInstanceMethods
+        def root
+          RootConfig.new(opts.fetch(:root))
+        end
+
+        def root=(value)
+          root.one = value.fetch(:one)
+          root.many = value.fetch(:many)
+        end
+      end
+
+      module SeregaConvertInstanceMethods
         def to_h
           hash = super
           root = build_root(opts)
@@ -54,8 +94,8 @@ class Serega
         def build_root(opts)
           return opts[:root] if opts.key?(:root)
 
-          root_config = self.class.serializer_class.config[:root]
-          many? ? root_config[:many] : root_config[:one]
+          root = self.class.serializer_class.config.root
+          many? ? root.many : root.one
         end
       end
     end

data/lib/serega/plugins/string_modifiers/parse_string_modifiers.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module StringModifiers
       class ParseStringModifiers
         COMMA = ","

data/lib/serega/plugins/string_modifiers/string_modifiers.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module StringModifiers
       def self.plugin_name
         :string_modifiers
@@ -16,13 +16,13 @@ class Serega
         private
 
         def prepare_modifiers(opts)
-          opts = {
-            only: ParseStringModifiers.call(opts[:only]),
-            except: ParseStringModifiers.call(opts[:except]),
-            with: ParseStringModifiers.call(opts[:with])
-          }
+          parsed_opts =
+            opts.each_with_object({}) do |(key, value), obj|
+              value = ParseStringModifiers.call(value) if (key == :only) || (key == :except) || (key == :with)
+              obj[key] = value
+            end
 
-          super
+          super(parsed_opts)
         end
       end
     end

data/lib/serega/plugins.rb

@@ -2,7 +2,7 @@
 
 class Serega
   # Module in which all Serega plugins should be stored
-  module Plugins
+  module SeregaPlugins
     @plugins = {}
 
     class << self
@@ -10,7 +10,7 @@ class Serega
       # Registers given plugin to be able to load it using symbol name.
       #
       # @example Register plugin
-      #   Serega::Plugins.register_plugin(:plugin_name, PluginModule)
+      #   Serega::SeregaPlugins.register_plugin(:plugin_name, PluginModule)
       def register_plugin(name, mod)
         @plugins[name] = mod
       end
@@ -20,13 +20,13 @@ class Serega
       #
       # @param name [Symbol, Module] plugin name or plugin itself
       #
-      # @raise [Error] Raises Error when plugin was not found
+      # @raise [SeregaError] Raises SeregaError when plugin was not found
       #
       # @example Find plugin when providing name
-      #   Serega::Plugins.find_plugin(:presenter) # => Serega::Plugins::Presenter
+      #   Serega::SeregaPlugins.find_plugin(:presenter) # => Serega::SeregaPlugins::Presenter
       #
       # @example Find plugin when providing plugin itself
-      #   Serega::Plugins.find_plugin(Presenter) # => Presenter
+      #   Serega::SeregaPlugins.find_plugin(Presenter) # => Presenter
       #
       # @return [Class<Module>] Plugin core module
       #
@@ -36,7 +36,7 @@ class Serega
 
         require_plugin(name)
 
-        @plugins[name] || raise(Error, "Plugin '#{name}' did not register itself correctly")
+        @plugins[name] || raise(SeregaError, "Plugin '#{name}' did not register itself correctly")
       end
 
       private
@@ -44,7 +44,7 @@ class Serega
       def require_plugin(name)
         require "serega/plugins/#{name}/#{name}"
       rescue LoadError
-        raise Error, "Plugin '#{name}' does not exist"
+        raise SeregaError, "Plugin '#{name}' does not exist"
       end
     end
   end

data/lib/serega/utils/enum_deep_dup.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Utils
+  module SeregaUtils
     # Duplicates nested hashes and arrays
     class EnumDeepDup
       DUP = {

data/lib/serega/utils/to_hash.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Utils
+  module SeregaUtils
     class ToHash
       module ClassMethods
         def call(value)
@@ -11,7 +11,7 @@ class Serega
           when NilClass, FalseClass then nil_to_hash(value)
           when String then string_to_hash(value)
           when Symbol then symbol_to_hash(value)
-          else raise Error, "Cant convert #{value.class} class object to hash"
+          else raise SeregaError, "Cant convert #{value.class} class object to hash"
           end
         end