serega 0.1.4 → 0.3.0

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)
+            Utils::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
+
+            Utils::CheckOptIsStringOrSymbol.call(delegate_opts, :to)
+          end
+
+          def check_opt_delegate_allow_nil(delegate_opts)
+            return unless delegate_opts.key?(:allow_nil)
+
+            Utils::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,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]
         #

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]
         #
@@ -24,9 +24,9 @@ class Serega
           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,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]
         #

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
@@ -28,6 +28,7 @@ class Serega
           Utils::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)
@@ -40,12 +41,12 @@ class Serega
         end
 
         def allowed_opts_keys
-          self.class.serializer_class.config[:attribute_keys]
+          self.class.serializer_class.config.attribute_keys
         end
       end
 
       include InstanceMethods
-      extend Serega::Helpers::SerializerClassHelper
+      extend Serega::SeregaHelpers::SerializerClassHelper
     end
   end
 end

data/lib/serega/validations/check_initiate_params.rb

@@ -1,26 +1,39 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     class CheckInitiateParams
-      module ClassMethods
-        def call(opts)
-          check_opts(opts)
+      module InstanceMethods
+        attr_reader :opts
+
+        def initialize(opts)
+          @opts = opts
+        end
+
+        def validate
+          check_allowed_keys
+          check_modifiers
         end
 
         private
 
-        def check_opts(opts)
-          Utils::CheckAllowedKeys.call(opts, allowed_opts_keys)
+        def check_allowed_keys
+          Utils::CheckAllowedKeys.call(opts, serializer_class.config.initiate_keys)
+        end
+
+        def check_modifiers
+          Initiate::CheckModifiers.call(serializer_class, opts[:only])
+          Initiate::CheckModifiers.call(serializer_class, opts[:except])
+          Initiate::CheckModifiers.call(serializer_class, opts[:with])
         end
 
-        def allowed_opts_keys
-          serializer_class.config[:initiate_keys]
+        def serializer_class
+          self.class.serializer_class
         end
       end
 
-      extend ClassMethods
-      extend Serega::Helpers::SerializerClassHelper
+      include InstanceMethods
+      extend Serega::SeregaHelpers::SerializerClassHelper
     end
   end
 end

data/lib/serega/validations/check_serialize_params.rb

@@ -1,29 +1,35 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     class CheckSerializeParams
-      module ClassMethods
-        def call(opts)
-          check_opts(opts)
+      module InstanceMethods
+        attr_reader :opts
+
+        def initialize(opts)
+          @opts = opts
+        end
+
+        def validate
+          check_opts
         end
 
         private
 
-        def check_opts(opts)
-          Utils::CheckAllowedKeys.call(opts, allowed_opts_keys)
+        def check_opts
+          Utils::CheckAllowedKeys.call(opts, serializer_class.config.serialize_keys)
 
           Utils::CheckOptIsHash.call(opts, :context)
           Utils::CheckOptIsBool.call(opts, :many)
         end
 
-        def allowed_opts_keys
-          serializer_class.config[:serialize_keys]
+        def serializer_class
+          self.class.serializer_class
         end
       end
 
-      extend ClassMethods
-      extend Serega::Helpers::SerializerClassHelper
+      include InstanceMethods
+      extend Serega::SeregaHelpers::SerializerClassHelper
     end
   end
 end

data/lib/serega/{plugins/validate_modifiers/validate.rb → validations/initiate/check_modifiers.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 class Serega
-  module Plugins
-    module ValidateModifiers
-      class Validate
+  module SeregaValidations
+    module Initiate
+      class CheckModifiers
         class << self
           def call(serializer_class, fields)
             return unless fields
@@ -29,14 +29,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/validations/utils/check_allowed_keys.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Utils
       class CheckAllowedKeys
         def self.call(opts, allowed_keys)
           opts.each_key do |key|
             next if allowed_keys.include?(key)
 
-            raise Error, "Invalid option #{key.inspect}. Allowed options are: #{allowed_keys.map(&:inspect).join(", ")}"
+            raise SeregaError, "Invalid option #{key.inspect}. Allowed options are: #{allowed_keys.map(&:inspect).join(", ")}"
           end
         end
       end

data/lib/serega/validations/utils/check_opt_is_bool.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Utils
       class CheckOptIsBool
         def self.call(opts, key)
@@ -10,7 +10,7 @@ class Serega
           value = opts[key]
           return if value.equal?(true) || value.equal?(false)
 
-          raise Error, "Invalid option #{key.inspect} => #{value.inspect}. Must have a boolean value"
+          raise SeregaError, "Invalid option #{key.inspect} => #{value.inspect}. Must have a boolean value"
         end
       end
     end

data/lib/serega/validations/utils/check_opt_is_hash.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Utils
       class CheckOptIsHash
         def self.call(opts, key)
@@ -10,7 +10,7 @@ class Serega
           value = opts[key]
           return if value.is_a?(Hash)
 
-          raise Error, "Invalid option #{key.inspect} => #{value.inspect}. Must have a Hash value"
+          raise SeregaError, "Invalid option #{key.inspect} => #{value.inspect}. Must have a Hash value"
         end
       end
     end

data/lib/serega/validations/utils/check_opt_is_string_or_symbol.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Serega
-  module Validations
+  module SeregaValidations
     module Utils
       class CheckOptIsStringOrSymbol
         def self.call(opts, key)
@@ -10,7 +10,7 @@ class Serega
           value = opts[key]
           return if value.is_a?(String) || value.is_a?(Symbol)
 
-          raise Error, "Invalid option #{key.inspect} => #{value.inspect}. Must be a String or a Symbol"
+          raise SeregaError, "Invalid option #{key.inspect} => #{value.inspect}. Must be a String or a Symbol"
         end
       end
     end