serega 0.1.3 → 0.2.0

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,7 +12,7 @@ class Serega
 
       def self.load_plugin(serializer_class, **_opts)
         serializer_class.extend(ClassMethods)
-        serializer_class::Convert.include(ConvertInstanceMethods)
+        serializer_class::SeregaConvert.include(SeregaConvertInstanceMethods)
       end
 
       def self.after_load_plugin(serializer_class, **opts)
@@ -41,7 +41,7 @@ class Serega
         end
       end
 
-      module ConvertInstanceMethods
+      module SeregaConvertInstanceMethods
         def to_h
           hash = super
           root = build_root(opts)

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

data/lib/serega/plugins/validate_modifiers/validate.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  class AttributeNotExist < SeregaError
+  end
+
+  module SeregaPlugins
     module ValidateModifiers
       class Validate
         class << self
@@ -29,14 +32,14 @@ class Serega
           def raise_error(name, prev_names)
             field_name = field_name(name, prev_names)
 
-            raise Serega::Error, "Attribute #{field_name} not exists"
+            raise Serega::AttributeNotExist, "Attribute #{field_name} not exists"
           end
 
           def raise_nested_error(name, prev_names, nested_fields)
             field_name = field_name(name, prev_names)
             first_nested = nested_fields.keys.first
 
-            raise Serega::Error, "Attribute #{field_name} is not a relation to add '#{first_nested}' attribute"
+            raise Serega::AttributeNotExist, "Attribute #{field_name} has no :serializer option specified to add nested '#{first_nested}' attribute"
           end
 
           def field_name(name, prev_names)

data/lib/serega/plugins/validate_modifiers/validate_modifiers.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
+  module SeregaPlugins
     module ValidateModifiers
       def self.plugin_name
         :validate_modifiers

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/as_json.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Utils
+  module SeregaUtils
     class AsJSON
       DOUBLE_QUOTE = '"'
 

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
 

data/lib/serega/utils/to_json.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Utils
+  module SeregaUtils
     class ToJSON
       class << self
         def call(data)

data/lib/serega/validations/attribute/check_block.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Attribute
       class CheckBlock
         class << self
@@ -22,7 +22,7 @@ class Serega
           # @param opts [Proc] Attribute opts, we will check :value option
           # @param block [Proc] Block that returns serialized attribute value
           #
-          # @raise [Error] Error that block has invalid arguments
+          # @raise [SeregaError] SeregaError that block has invalid arguments
           #
           # @return [void]
           #
@@ -38,7 +38,7 @@ class Serega
             params = block.parameters
             return if (params.count <= 2) && params.all? { |par| par[0] == :opt }
 
-            raise Error, block_error
+            raise SeregaError, block_error
           end
 
           def block_error

data/lib/serega/validations/attribute/check_name.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Attribute
       class CheckName
         FORMAT_ONE_CHAR = /\A[a-zA-Z0-9]\z/
@@ -17,7 +17,7 @@ class Serega
           #
           # @param name [String, Symbol] Attribute name
           #
-          # @raise [Error] when name has invalid format
+          # @raise [SeregaError] when name has invalid format
           # @return [void]
           #
           def call(name)
@@ -32,7 +32,7 @@ class Serega
 
             return if valid
 
-            raise Error, message(name)
+            raise SeregaError, message(name)
           end
 
           private

data/lib/serega/validations/attribute/check_opt_const.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Attribute
       class CheckOptConst
         #
@@ -9,7 +9,7 @@ class Serega
         #
         # @param opts [Hash] Attribute options
         #
-        # @raise [Error] Attribute validation error
+        # @raise [SeregaError] Attribute validation error
         #
         # @return [void]
         #
@@ -23,9 +23,9 @@ class Serega
           private
 
           def check_usage_with_other_params(opts, block)
-            raise Error, "Option :const can not be used together with option :key" if opts.key?(:key)
-            raise Error, "Option :const can not be used together with option :value" if opts.key?(:value)
-            raise Error, "Option :const can not be used together with block" if block
+            raise SeregaError, "Option :const can not be used together with option :key" if opts.key?(:key)
+            raise SeregaError, "Option :const can not be used together with option :value" if opts.key?(:value)
+            raise SeregaError, "Option :const can not be used together with block" if block
           end
         end
       end

data/lib/serega/validations/attribute/check_opt_delegate.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class Serega
+  module SeregaValidations
+    module Attribute
+      class CheckOptDelegate
+        #
+        # Checks attribute :delegate option
+        # It must have :to option and can have :optional allow_nil option
+        #
+        # @param opts [Hash] Attribute options
+        #
+        # @raise [SeregaError] Attribute validation error
+        #
+        # @return [void]
+        #
+        class << self
+          def call(opts, block = nil)
+            return unless opts.key?(:delegate)
+
+            check_opt_delegate(opts)
+            check_usage_with_other_params(opts, block)
+          end
+
+          private
+
+          def check_opt_delegate(opts)
+            SeregaUtils::CheckOptIsHash.call(opts, :delegate)
+
+            delegate_opts = opts[:delegate]
+            check_opt_delegate_to(delegate_opts)
+            check_opt_delegate_allow_nil(delegate_opts)
+          end
+
+          def check_opt_delegate_to(delegate_opts)
+            to_exist = delegate_opts.key?(:to)
+            raise SeregaError, "Option :delegate must have a :to option" unless to_exist
+
+            SeregaUtils::CheckOptIsStringOrSymbol.call(delegate_opts, :to)
+          end
+
+          def check_opt_delegate_allow_nil(delegate_opts)
+            return unless delegate_opts.key?(:allow_nil)
+
+            SeregaUtils::CheckOptIsBool.call(delegate_opts, :allow_nil)
+          end
+
+          def check_usage_with_other_params(opts, block)
+            raise SeregaError, "Option :delegate can not be used together with option :const" if opts.key?(:const)
+            raise SeregaError, "Option :delegate can not be used together with option :value" if opts.key?(:value)
+            raise SeregaError, "Option :delegate can not be used together with block" if block
+          end
+        end
+      end
+    end
+  end
+end

data/lib/serega/validations/attribute/check_opt_hide.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Attribute
       class CheckOptHide
         #
@@ -9,12 +9,12 @@ 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]
         #
         def self.call(opts)
-          Utils::CheckOptIsBool.call(opts, :hide)
+          SeregaUtils::CheckOptIsBool.call(opts, :hide)
         end
       end
     end

data/lib/serega/validations/attribute/check_opt_key.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Attribute
       class CheckOptKey
         #
@@ -9,7 +9,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]
         #
@@ -18,15 +18,15 @@ class Serega
             return unless opts.key?(:key)
 
             check_usage_with_other_params(opts, block)
-            Utils::CheckOptIsStringOrSymbol.call(opts, :key)
+            SeregaUtils::CheckOptIsStringOrSymbol.call(opts, :key)
           end
 
           private
 
           def check_usage_with_other_params(opts, block)
-            raise Error, "Option :key can not be used together with option :const" if opts.key?(:const)
-            raise Error, "Option :key can not be used together with option :value" if opts.key?(:value)
-            raise Error, "Option :key can not be used together with block" if block
+            raise SeregaError, "Option :key can not be used together with option :const" if opts.key?(:const)
+            raise SeregaError, "Option :key can not be used together with option :value" if opts.key?(:value)
+            raise SeregaError, "Option :key can not be used together with block" if block
           end
         end
       end

data/lib/serega/validations/attribute/check_opt_many.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Attribute
       class CheckOptMany
         #
@@ -9,12 +9,12 @@ 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]
         #
         def self.call(opts)
-          Utils::CheckOptIsBool.call(opts, :many)
+          SeregaUtils::CheckOptIsBool.call(opts, :many)
         end
       end
     end

data/lib/serega/validations/attribute/check_opt_serializer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Attribute
       class CheckOptSerializer
         class << self
@@ -10,7 +10,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]
           #
@@ -20,7 +20,7 @@ class Serega
             value = opts[:serializer]
             return if valid_serializer?(value)
 
-            raise Error, "Invalid option :serializer => #{value.inspect}." \
+            raise SeregaError, "Invalid option :serializer => #{value.inspect}." \
               " Can be a Serega subclass, a String or a Proc without arguments"
           end
 

data/lib/serega/validations/attribute/check_opt_value.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Attribute
       class CheckOptValue
         #
@@ -9,7 +9,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]
         #
@@ -24,13 +24,13 @@ class Serega
           private
 
           def check_usage_with_other_params(opts, block)
-            raise Error, "Option :value can not be used together with option :key" if opts.key?(:key)
-            raise Error, "Option :value can not be used together with option :const" if opts.key?(:const)
-            raise Error, "Option :value can not be used together with block" if block
+            raise SeregaError, "Option :value can not be used together with option :key" if opts.key?(:key)
+            raise SeregaError, "Option :value can not be used together with option :const" if opts.key?(:const)
+            raise SeregaError, "Option :value can not be used together with block" if block
           end
 
           def check_proc(value)
-            raise Error, value_error unless value.is_a?(Proc)
+            raise SeregaError, value_error unless value.is_a?(Proc)
 
             params = value.parameters
 
@@ -40,7 +40,7 @@ class Serega
               return
             end
 
-            raise Error, value_error
+            raise SeregaError, value_error
           end
 
           def value_error

data/lib/serega/validations/check_attribute_params.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     class CheckAttributeParams
       module InstanceMethods
         attr_reader :name, :opts, :block
@@ -25,9 +25,10 @@ class Serega
         end
 
         def check_opts
-          Utils::CheckAllowedKeys.call(opts, allowed_opts_keys)
+          SeregaUtils::CheckAllowedKeys.call(opts, allowed_opts_keys)
 
           Attribute::CheckOptConst.call(opts, block)
+          Attribute::CheckOptDelegate.call(opts, block)
           Attribute::CheckOptHide.call(opts)
           Attribute::CheckOptKey.call(opts, block)
           Attribute::CheckOptMany.call(opts)
@@ -45,7 +46,7 @@ class Serega
       end
 
       include InstanceMethods
-      extend Serega::Helpers::SerializerClassHelper
+      extend Serega::SeregaHelpers::SerializerClassHelper
     end
   end
 end

data/lib/serega/validations/check_initiate_params.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     class CheckInitiateParams
       module ClassMethods
         def call(opts)
@@ -11,7 +11,7 @@ class Serega
         private
 
         def check_opts(opts)
-          Utils::CheckAllowedKeys.call(opts, allowed_opts_keys)
+          SeregaUtils::CheckAllowedKeys.call(opts, allowed_opts_keys)
         end
 
         def allowed_opts_keys
@@ -20,7 +20,7 @@ class Serega
       end
 
       extend ClassMethods
-      extend Serega::Helpers::SerializerClassHelper
+      extend Serega::SeregaHelpers::SerializerClassHelper
     end
   end
 end

data/lib/serega/validations/check_serialize_params.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     class CheckSerializeParams
       module ClassMethods
         def call(opts)
@@ -11,10 +11,10 @@ class Serega
         private
 
         def check_opts(opts)
-          Utils::CheckAllowedKeys.call(opts, allowed_opts_keys)
+          SeregaUtils::CheckAllowedKeys.call(opts, allowed_opts_keys)
 
-          Utils::CheckOptIsHash.call(opts, :context)
-          Utils::CheckOptIsBool.call(opts, :many)
+          SeregaUtils::CheckOptIsHash.call(opts, :context)
+          SeregaUtils::CheckOptIsBool.call(opts, :many)
         end
 
         def allowed_opts_keys
@@ -23,7 +23,7 @@ class Serega
       end
 
       extend ClassMethods
-      extend Serega::Helpers::SerializerClassHelper
+      extend Serega::SeregaHelpers::SerializerClassHelper
     end
   end
 end