serega 0.6.1 → 0.7.0

data/lib/serega/validations/check_initiate_params.rb

@@ -2,14 +2,31 @@
 
 class Serega
   module SeregaValidations
+    #
+    # Validations of serializer initialization options
+    #
     class CheckInitiateParams
+      #
+      # Validations of serializer initialization options instance methods
+      #
       module InstanceMethods
+        # @return [Hash] validated initialization options
         attr_reader :opts
 
+        #
+        # Initializes validator for initialization options
+        #
+        # @param opts [Hash] initialization options
+        #
+        # @return [void]
+        #
         def initialize(opts)
           @opts = opts
         end
 
+        #
+        # Validates initiating params
+        #
         def validate
           check_allowed_keys
           check_modifiers

data/lib/serega/validations/check_serialize_params.rb

@@ -2,14 +2,30 @@
 
 class Serega
   module SeregaValidations
+    #
+    # Validations of serialization options
+    #
     class CheckSerializeParams
+      #
+      # Validations of serialization options instance methods
+      #
       module InstanceMethods
         attr_reader :opts
 
+        #
+        # Initializes validator for serialization options
+        #
+        # @param opts [Hash] serialization options
+        #
+        # @return [void]
+        #
         def initialize(opts)
           @opts = opts
         end
 
+        #
+        # Validates serialization options
+        #
         def validate
           check_opts
         end

data/lib/serega/validations/initiate/check_modifiers.rb

@@ -2,9 +2,24 @@
 
 class Serega
   module SeregaValidations
+    #
+    # Validations that take place when initializing serializer
+    #
     module Initiate
+      #
+      # Modifiers validation
+      #
       class CheckModifiers
         class << self
+          # Validates provided fields names are existing attributes
+          #
+          # @param serializer_class [Serega]
+          # @param fields [Hash] validated fields
+          #
+          # @raise [Serega::AttributeNotExist] when modifier not exist as attribute
+          #
+          # @return [void]
+          #
           def call(serializer_class, fields)
             return unless fields
 

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

@@ -2,8 +2,22 @@
 
 class Serega
   module SeregaValidations
+    #
+    # Validations Utilities
+    #
     module Utils
+      #
+      # Utility to check all hash keys are allowed
+      #
       class CheckAllowedKeys
+        # Checks hash keys are allowed
+        #
+        # @param opts [Hash] Some options Hash
+        # @param allowed_keys [Array] Allowed hash keys
+        #
+        # @raise [Serega::SeregaError] error when any hash key is not allowed
+        #
+        # @return [void]
         def self.call(opts, allowed_keys)
           opts.each_key do |key|
             next if allowed_keys.include?(key)

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

@@ -3,7 +3,18 @@
 class Serega
   module SeregaValidations
     module Utils
+      #
+      # Utility to check hash key value is boolean
+      #
       class CheckOptIsBool
+        # Checks hash key has boolean value
+        #
+        # @param opts [Hash] Some options Hash
+        # @param key [Object] Hash key
+        #
+        # @raise [Serega::SeregaError] error when provided key exists and value is not boolean
+        #
+        # @return [void]
         def self.call(opts, key)
           return unless opts.key?(key)
 

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

@@ -3,7 +3,18 @@
 class Serega
   module SeregaValidations
     module Utils
+      #
+      # Utility to check hash key value is Hash
+      #
       class CheckOptIsHash
+        # Checks hash key value is Hash
+        #
+        # @param opts [Hash] Some options Hash
+        # @param key [Object] Hash key
+        #
+        # @raise [Serega::SeregaError] error when provided key exists and value is not a Hash
+        #
+        # @return [void]
         def self.call(opts, key)
           return unless opts.key?(key)
 

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

@@ -3,7 +3,18 @@
 class Serega
   module SeregaValidations
     module Utils
+      #
+      # Utility to check hash key value is String or Symbol
+      #
       class CheckOptIsStringOrSymbol
+        # Checks hash key has String or Symbol value
+        #
+        # @param opts [Hash] Some options Hash
+        # @param key [Object] Hash key
+        #
+        # @raise [Serega::SeregaError] error when provided key exists and value is not String or Symbol
+        #
+        # @return [void]
         def self.call(opts, key)
           return unless opts.key?(key)
 

data/lib/serega/version.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
 class Serega
+  # Serega gem version
+  #
+  # @return [String] SemVer gem version
+  #
   VERSION = File.read(File.join(File.dirname(__FILE__), "../../VERSION")).strip
 end

data/lib/serega.rb

@@ -38,7 +38,6 @@ require_relative "serega/validations/check_serialize_params"
 
 require_relative "serega/config"
 require_relative "serega/object_serializer"
-require_relative "serega/serializer"
 require_relative "serega/map_point"
 require_relative "serega/map"
 require_relative "serega/plugins"
@@ -61,7 +60,9 @@ class Serega
   check_serialize_params_class.serializer_class = self
   const_set(:CheckSerializeParams, check_serialize_params_class)
 
-  # Core serializer class methods
+  #
+  # Serializers class methods
+  #
   module ClassMethods
     # @return [SeregaConfig] current serializer config
     attr_reader :config
@@ -84,10 +85,6 @@ class Serega
       map_point_class.serializer_class = subclass
       subclass.const_set(:SeregaMapPoint, map_point_class)
 
-      serega_serializer_class = Class.new(self::SeregaSerializer)
-      serega_serializer_class.serializer_class = subclass
-      subclass.const_set(:SeregaSerializer, serega_serializer_class)
-
       object_serializer_class = Class.new(self::SeregaObjectSerializer)
       object_serializer_class.serializer_class = subclass
       subclass.const_set(:SeregaObjectSerializer, object_serializer_class)
@@ -145,7 +142,7 @@ class Serega
     #
     # @param name [Symbol, Class<Module>] Plugin name or plugin module itself
     #
-    # @return [Boolean]
+    # @return [Boolean] Is plugin used
     #
     def plugin_used?(name)
       plugin_name =
@@ -180,37 +177,80 @@ class Serega
       attributes[attribute.name] = attribute
     end
 
+    #
+    # Serializes provided object to Hash
+    #
+    # @param object [Object] Serialized object
+    # @param opts [Hash] Serializer modifiers and other instantiating options
+    # @option opts [Array, Hash, String, Symbol] :only The only attributes to serialize
+    # @option opts [Array, Hash, String, Symbol] :except Attributes to hide
+    # @option opts [Array, Hash, String, Symbol] :with Attributes (usually hidden) to serialize additionally
+    # @option opts [Boolean] :validate Validates provided modifiers (Default is true)
+    # @option opts [Hash] :context Serialization context
+    # @option opts [Boolean] :many Set true if provided multiple objects (Default `object.is_a?(Enumerable)`)
+    #
+    # @return [Hash] Serialization result
+    #
     def call(object, opts = FROZEN_EMPTY_HASH)
       initiate_keys = config.initiate_keys
       new(opts.slice(*initiate_keys)).to_h(object, opts.except(*initiate_keys))
     end
 
+    # @see #call
     def to_h(object, opts = FROZEN_EMPTY_HASH)
       call(object, opts)
     end
 
+    #
+    # Serializes provided object to JSON string
+    #
+    # @param object [Object] Serialized object
+    # @param opts [Hash] Serializer modifiers and other instantiating options
+    # @option opts [Array, Hash, String, Symbol] :only The only attributes to serialize
+    # @option opts [Array, Hash, String, Symbol] :except Attributes to hide
+    # @option opts [Array, Hash, String, Symbol] :with Attributes (usually hidden) to serialize additionally
+    # @option opts [Boolean] :validate Validates provided modifiers (Default is true)
+    # @option opts [Hash] :context Serialization context
+    # @option opts [Boolean] :many Set true if provided multiple objects (Default `object.is_a?(Enumerable)`)
+    #
+    # @return [String] Serialization result
+    #
     def to_json(object, opts = FROZEN_EMPTY_HASH)
       initiate_keys = config.initiate_keys
       new(opts.slice(*initiate_keys)).to_json(object, opts.except(*initiate_keys))
     end
 
+    #
+    # Serializes provided object as JSON
+    #
+    # @param object [Object] Serialized object
+    # @param opts [Hash] Serializer modifiers and other instantiating options
+    # @option opts [Array, Hash, String, Symbol] :only The only attributes to serialize
+    # @option opts [Array, Hash, String, Symbol] :except Attributes to hide
+    # @option opts [Array, Hash, String, Symbol] :with Attributes (usually hidden) to serialize additionally
+    # @option opts [Boolean] :validate Validates provided modifiers (Default is true)
+    # @option opts [Hash] :context Serialization context
+    # @option opts [Boolean] :many Set true if provided multiple objects (Default `object.is_a?(Enumerable)`)
+    #
+    # @return [Hash] Serialization result
+    #
     def as_json(object, opts = FROZEN_EMPTY_HASH)
       config.from_json.call(to_json(object, opts))
     end
   end
 
   #
-  # Core serializer instance methods
+  # Serializers instance methods
   #
   module InstanceMethods
-    attr_reader :opts
-
     #
     # Instantiates new Serega class
     #
-    # @param only [Array, Hash, String, Symbol] The only attributes to serialize
-    # @param except [Array, Hash, String, Symbol] Attributes to hide
-    # @param with [Array, Hash, String, Symbol] Attributes (usually hidden) to serialize additionally
+    # @param opts [Hash] Serializer modifiers and other instantiating options
+    # @option opts [Array, Hash, String, Symbol] :only The only attributes to serialize
+    # @option opts [Array, Hash, String, Symbol] :except Attributes to hide
+    # @option opts [Array, Hash, String, Symbol] :with Attributes (usually hidden) to serialize additionally
+    # @option opts [Boolean] :validate Validates provided modifiers (Default is true)
     #
     def initialize(opts = FROZEN_EMPTY_HASH)
       @opts = (opts == FROZEN_EMPTY_HASH) ? opts : prepare_modifiers(opts)
@@ -218,10 +258,12 @@ class Serega
     end
 
     #
-    # Serializes provided object to hash
+    # Serializes provided object to Hash
     #
     # @param object [Object] Serialized object
-    # @param opts [Hash] Serialization options, like :context and :many
+    # @param opts [Hash] Serializer modifiers and other instantiating options
+    # @option opts [Hash] :context Serialization context
+    # @option opts [Boolean] :many Set true if provided multiple objects (Default `object.is_a?(Enumerable)`)
     #
     # @return [Hash] Serialization result
     #
@@ -229,7 +271,7 @@ class Serega
       self.class::CheckSerializeParams.new(opts).validate
       opts[:context] ||= {}
 
-      self.class::SeregaSerializer.new(points: map, **opts).serialize(object)
+      serialize(object, opts)
     end
 
     # @see #call
@@ -238,9 +280,12 @@ class Serega
     end
 
     #
-    # Serializes provided object to json
+    # Serializes provided object to JSON string
     #
     # @param object [Object] Serialized object
+    # @param opts [Hash] Serializer modifiers and other instantiating options
+    # @option opts [Hash] :context Serialization context
+    # @option opts [Boolean] :many Set true if provided multiple objects (Default `object.is_a?(Enumerable)`)
     #
     # @return [Hash] Serialization result
     #
@@ -250,11 +295,12 @@ class Serega
     end
 
     #
-    # Serializes provided object as json (uses only JSON-compatible types)
-    # When you later serialize/de-serialize it from JSON you should receive
-    # equal object
+    # Serializes provided object as JSON
     #
     # @param object [Object] Serialized object
+    # @param opts [Hash] Serializer modifiers and other instantiating options
+    # @option opts [Hash] :context Serialization context
+    # @option opts [Boolean] :many Set true if provided multiple objects (Default `object.is_a?(Enumerable)`)
     #
     # @return [Hash] Serialization result
     #
@@ -263,22 +309,35 @@ class Serega
       config.from_json.call(json)
     end
 
+    #
+    # Array of MapPoints, which are attributes combined with nested attributes.
+    # This map can be traversed to find currently serializing attributes.
+    #
+    # @return [Array<Serega::SeregaMapPoint>] map
+    def map
+      @map ||= self.class::SeregaMap.call(opts)
+    end
+
     private
 
+    attr_reader :opts
+
     def config
       self.class.config
     end
 
-    def map
-      @map ||= self.class::SeregaMap.call(opts)
-    end
-
     def prepare_modifiers(opts)
       opts.each_with_object({}) do |(key, value), obj|
         value = SeregaUtils::ToHash.call(value) if (key == :only) || (key == :except) || (key == :with)
         obj[key] = value
       end
     end
+
+    def serialize(object, opts)
+      self.class::SeregaObjectSerializer
+        .new(**opts, points: map)
+        .serialize(object)
+    end
   end
 
   extend ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serega
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrey Glushkov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-03 00:00:00.000000000 Z
+date: 2022-12-07 00:00:00.000000000 Z
 dependencies: []
 description: |
   JSON Serializer
@@ -68,7 +68,6 @@ files:
 - lib/serega/plugins/root/root.rb
 - lib/serega/plugins/string_modifiers/parse_string_modifiers.rb
 - lib/serega/plugins/string_modifiers/string_modifiers.rb
-- lib/serega/serializer.rb
 - lib/serega/utils/enum_deep_dup.rb
 - lib/serega/utils/to_hash.rb
 - lib/serega/validations/attribute/check_block.rb

data/lib/serega/serializer.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  class SeregaSerializer
-    module SeregaSerializerInstanceMethods
-      # @param context [Hash] Serialization context
-      # @param many [TrueClass|FalseClass] is object is enumerable
-      # @param points [Array<MapPoint>] Serialization points (attributes)
-      # @param opts [Hash] Any custom options
-      def initialize(context:, points:, many: nil, **opts)
-        @context = context
-        @points = points
-        @many = many
-        @opts = opts
-      end
-
-      # @param object [Object] Serialized object
-      def serialize(object)
-        self.class.serializer_class::SeregaObjectSerializer
-          .new(context: context, points: points, many: many, **opts)
-          .serialize(object)
-      end
-
-      private
-
-      attr_reader :context, :points, :many, :opts
-    end
-
-    extend Serega::SeregaHelpers::SerializerClassHelper
-    include SeregaSerializerInstanceMethods
-  end
-end