serega 0.32.0 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06b324510e423bf61c19d440e522246d6d2223a5228a415a1fd5fcdbd87fd147
-  data.tar.gz: 5a31066675d38ad2c10032a6d9d7fdd9921db001a11e7b3916887a5215d1ab51
+  metadata.gz: 5cd7b294e87a2a489db28dc4b77e46a7a359cf667908350a15e74d919a340305
+  data.tar.gz: e273e63a8a9248b44da6fbd4d71be4fc5be3a01308e42fa8222cec76a94a23e6
 SHA512:
-  metadata.gz: 2da3083d578120365246d6b912777dc3d0c36a0dac1a09d4a0af0c5eeea6b398510b5f9dd5f7ca016c3d8d196c58f6990c39cee627646601d44682585b23e7de
-  data.tar.gz: e0389486ffdbf381d2db837bc7157a87224374abe8402f2b6d5bcd32e75a6cca72111bb38cb9b0955323af9774395a117d2e660725cbb1017e5a496390d7a923
+  metadata.gz: 94418c706174af2493fa63da4982a732fdaf5841d1664404f20f142d8e4bf798297375d6dc7d082a470a85eea18defa53975076e7778c468ef5f6faa5c8b8f59
+  data.tar.gz: 7b896b64920aa07a6ba01e4e03967e75cf67a21590978b226e018344e9f116ce0d579289b45eb7a1670989f5fc51591d33546c0f8c9a2dc28ba1fc4ca6120176

data/README.md

@@ -143,9 +143,8 @@ end
 
 ### Serializing
 
-We can serialize objects using class methods `.to_h`, `.to_json`, `.as_json` and
-same instance methods `#to_h`, `#to_json`, `#as_json`.
-The `to_h` method is also aliased as `call`.
+We can serialize objects using class method `.call` aliased ad `.to_h` and
+same instance methods `#call` and its alias `#to_h`.
 
 ```ruby
 user = OpenStruct.new(username: 'serega')
@@ -156,12 +155,6 @@ end
 
 UserSerializer.to_h(user) # => {username: "serega"}
 UserSerializer.to_h([user]) # => [{username: "serega"}]
-
-UserSerializer.to_json(user) # => '{"username":"serega"}'
-UserSerializer.to_json([user]) # => '[{"username":"serega"}]'
-
-UserSerializer.as_json(user) # => {"username":"serega"}
-UserSerializer.as_json([user]) # => [{"username":"serega"}]
 ```
 
 If serialized fields are constant, then it's a good idea to initiate the
@@ -333,8 +326,8 @@ Named loaders can be defined using the `batch_loader` class method and reused ac
 ```ruby
 class UserSerializer < Serega
   # Define named loaders
-  batch_loader :comments_count, ->(users) { Comment.where(user: users).group(:user_id).count }
-  batch_loader :comments_count, CommentsCountLoader # Example with callable class
+  batch :comments_count, ->(users) { Comment.where(user: users).group(:user_id).count }
+  batch :comments_count, CommentsCountLoader # Example with callable class
 
   # Full attribute example
   attribute :comments_count, batch: { use: :comments_count },
@@ -389,16 +382,22 @@ Here are the default options. Other options can be added with plugins.
 
 ```ruby
 class AppSerializer < Serega
-  # Configure adapter to serialize to JSON.
-  # It is `JSON.dump` by default. But if the Oj gem is loaded, then the default
-  # is changed to `Oj.dump(data, mode: :compat)`
-  config.to_json = ->(data) { Oj.dump(data, mode: :compat) }
-
-  # Configure adapter to de-serialize JSON.
-  # De-serialization is used only for the `#as_json` method.
-  # It is `JSON.parse` by default.
-  # When the Oj gem is loaded, then the default is `Oj.load(data)`
-  config.from_json = ->(data) { Oj.load(data) }
+  # With `activerecord_preloads` plugin it automatically adds `preload` option
+  # to attributes with `:delegate` or `:serializer` option.
+  # It helps to preload associations automatically, omitting N+1 requests.
+  config.auto_preload = false
+
+  # Automatically marks as hidden attributes with `:preload` or `:batch` options.
+  # By default is false. Useful option to not make extra DB requests if attribute
+  # was not requested
+  config.auto_hide = false
+
+  # Default method used on serialized object to resolve batch value
+  # For example:
+  #   attribute :counter, batch: CounterBatchLoader
+  #   # Attribute values will be resolved as:
+  #   proc { |object, batches:| batches[:counter][object.id] }
+  config.batch_id_option = :id
 
   # Disable/enable validation of modifiers (`:with, :except, :only`)
   # By default, this validation is enabled.

data/VERSION

@@ -1 +1 @@
-0.32.0
+0.33.0

data/lib/serega/batch/auto_resolver_factory.rb

@@ -22,26 +22,28 @@ class Serega
       # In other cases we should never call tis method here.
       #
       def self.get(serializer_class, attribute_name, batch_opt)
+        default_method = serializer_class.config.batch_id_option
+
         if batch_opt == true                        # ex: `batch: true`
-          loader_name = attribute_name
-          loader_id_method = :id
+          batch_name = attribute_name
+          batch_id_method = default_method
         elsif batch_opt.respond_to?(:call)          # ex: `batch: FooLoader`
-          serializer_class.batch_loader(attribute_name, batch_opt)
-          loader_name = attribute_name
-          loader_id_method = :id
+          serializer_class.batch(attribute_name, batch_opt)
+          batch_name = attribute_name
+          batch_id_method = default_method
         else
           use = batch_opt[:use]
-          loader_id_method = batch_opt[:id] || :id
+          batch_id_method = batch_opt[:id] || default_method
 
           if use.respond_to?(:call)                 # ex: `batch: { use: FooLoader }`
-            loader_name = attribute_name
-            serializer_class.batch_loader(loader_name, use)
+            batch_name = attribute_name
+            serializer_class.batch(batch_name, use)
           else                                      # ex: `batch: { use: :foo }` || batch: { id: :some_id }
-            loader_name = use || attribute_name
+            batch_name = use || attribute_name
           end
         end
 
-        AutoResolver.new(loader_name, loader_id_method)
+        AutoResolver.new(batch_name, batch_id_method)
       end
     end
   end

data/lib/serega/config.rb

@@ -33,12 +33,7 @@ class Serega
       max_cached_plans_per_serializer_count: 0,
       auto_preload: {has_delegate_option: false, has_serializer_option: false},
       auto_hide: {has_preload_option: false, has_batch_option: false},
-      # auto_preload_attributes_with_delegate: false,
-      # auto_preload_attributes_with_serializer: false,
-      # auto_hide_attributes_with_preload: false,
-      # hide_batch_attributes: false,
-      to_json: (SeregaJSON.adapter == :oj) ? SeregaJSON::OjDump : SeregaJSON::JSONDump,
-      from_json: (SeregaJSON.adapter == :oj) ? SeregaJSON::OjLoad : SeregaJSON::JSONLoad
+      batch_id_option: :id
     }.freeze
     # :nocov:
 
@@ -82,7 +77,7 @@ class Serega
         opts.fetch(:attribute_keys)
       end
 
-      # Returns options names allowed in `to_h, to_json, as_json` methods
+      # Returns options names allowed in `call, to_h` methods
       # @return [Array<Symbol>] Allowed options keys for serialization
       def serialize_keys
         opts.fetch(:serialize_keys)
@@ -191,30 +186,19 @@ class Serega
         opts[:check_attribute_name] = value
       end
 
-      # Returns current `to_json` adapter
-      # @return [#call] Callable that used to construct JSON
-      def to_json
-        opts.fetch(:to_json)
+      # Returns current batch_id_option
+      def batch_id_option
+        opts.fetch(:batch_id_option)
       end
 
-      # Sets current `to_json` adapter
-      # @param value [#call] Callable that used to construct JSON
-      # @return [#call] Provided callable object
-      def to_json=(value)
-        opts[:to_json] = value
-      end
-
-      # Returns current `from_json` adapter
-      # @return [#call] Callable that used to parse JSON
-      def from_json
-        opts.fetch(:from_json)
-      end
-
-      # Sets current `from_json` adapter
-      # @param value [#call] Callable that used to parse JSON
-      # @return [#call] Provided callable object
-      def from_json=(value)
-        opts[:from_json] = value
+      # Sets :batch_id_option config option
+      #
+      # @param value [Symbol] Set :batch_id_option config option
+      #
+      # @return [Symbol] New :check_attribute_name config option
+      def batch_id_option=(value)
+        raise SeregaError, "Must have Symbol value, #{value.inspect} provided" unless value.is_a?(Symbol)
+        opts[:batch_id_option] = value
       end
     end
 

data/lib/serega.rb

@@ -23,8 +23,6 @@ require_relative "serega/utils/preload_paths"
 require_relative "serega/utils/preloads_constructor"
 require_relative "serega/utils/symbol_name"
 require_relative "serega/utils/to_hash"
-require_relative "serega/json/adapter"
-
 require_relative "serega/attribute"
 require_relative "serega/attribute_normalizer"
 require_relative "serega/batch/attribute_loader"
@@ -78,7 +76,7 @@ class Serega
   check_serialize_params_class.serializer_class = self
   const_set(:CheckSerializeParams, check_serialize_params_class)
 
-  # Validates `Serializer.batch_loader` params
+  # Validates `Serializer.batch` params
   check_batch_loader_params_class = Class.new(SeregaValidations::CheckBatchLoaderParams)
   check_batch_loader_params_class.serializer_class = self
   const_set(:CheckBatchLoaderParams, check_batch_loader_params_class)
@@ -155,7 +153,7 @@ class Serega
     end
 
     #
-    # Lists batch loaders
+    # Lists defined batch loaders
     #
     # @return [Hash] batch loaders list
     #
@@ -184,7 +182,7 @@ class Serega
     # Defines a batch loader
     #
     # @example
-    #   batch_loader :tags, PostTagsLoader
+    #   batch :tags, PostTagsLoader
     #
     # @example with block
     #   batch_loader(:tags) do |posts|
@@ -208,7 +206,7 @@ class Serega
     #
     # @return [#call] Batch loader
     #
-    def batch_loader(name, value = nil, &block)
+    def batch(name, value = nil, &block)
       raise SeregaError, "Batch loader must be defined with a callable value or block" if (value && block) || (!value && !block)
 
       batch_loader = self::SeregaBatchLoader.new(name: name, block: value || block)
@@ -245,59 +243,7 @@ class Serega
       new(modifiers_opts).to_h(object, serialize_opts)
     end
 
-    #
-    # Serializes provided object to Hash
-    #
-    # @param object [Object] Serialized object
-    # @param opts [Hash, nil] 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 to_h(object, opts = nil)
-      call(object, opts)
-    end
-
-    #
-    # Serializes provided object to JSON string
-    #
-    # @param object [Object] Serialized object
-    # @param opts [Hash, nil] 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 = nil)
-      config.to_json.call(to_h(object, opts))
-    end
-
-    #
-    # Serializes provided object as JSON
-    #
-    # @param object [Object] Serialized object
-    # @param opts [Hash, nil] 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 = nil)
-      config.from_json.call(to_json(object, opts))
-    end
+    alias_method :to_h, :call
 
     private
 
@@ -362,7 +308,7 @@ class Serega
 
       # Assign same batch loaders
       batch_loaders.each_value do |loader|
-        subclass.batch_loader(loader.name, loader.block)
+        subclass.batch(loader.name, loader.block)
       end
 
       super
@@ -431,36 +377,6 @@ class Serega
       @preloads ||= SeregaUtils::PreloadsConstructor.call(plan)
     end
 
-    #
-    # Serializes provided object to JSON string
-    #
-    # @param object [Object] Serialized object
-    # @param opts [Hash, nil] 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
-    #
-    def to_json(object, opts = nil)
-      hash = to_h(object, opts)
-      config.to_json.call(hash)
-    end
-
-    #
-    # Serializes provided object as JSON
-    #
-    # @param object [Object] Serialized object
-    # @param opts [Hash, nil] 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
-    #
-    def as_json(object, opts = nil)
-      json = to_json(object, opts)
-      config.from_json.call(json)
-    end
-
     private
 
     attr_reader :opts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serega
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.33.0
 platform: ruby
 authors:
 - Andrey Glushkov
@@ -37,9 +37,6 @@ files:
 - lib/serega/config.rb
 - lib/serega/errors.rb
 - lib/serega/helpers/serializer_class_helper.rb
-- lib/serega/json/adapter.rb
-- lib/serega/json/json.rb
-- lib/serega/json/oj.rb
 - lib/serega/object_serializer.rb
 - lib/serega/plan.rb
 - lib/serega/plan_point.rb

data/lib/serega/json/adapter.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  #
-  # JSON adapters
-  #
-  module SeregaJSON
-    # Current JSON adapter
-    #
-    # @return [Symbol] Current JSON adapter name - :oj or :json
-    def self.adapter
-      @adapter ||=
-        if defined?(::Oj)
-          require_relative "oj"
-          :oj
-        else
-          require "json"
-          require_relative "json"
-          :json
-        end
-    end
-  end
-end

data/lib/serega/json/json.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaJSON
-    #
-    # JSON dump adapter for ::JSON
-    #
-    class JSONDump
-      #
-      # Dumps data to JSON string
-      #
-      # @param data [Object] Anything
-      #
-      # @return [String] Data serialized to JSON
-      #
-      def self.call(data)
-        ::JSON.dump(data)
-      end
-    end
-
-    #
-    # JSON parse adapter for ::JSON
-    #
-    class JSONLoad
-      #
-      # Loads object from JSON string
-      #
-      # @param json_string [String] JSON String
-      #
-      # @return [Object] Deserialized data
-      #
-      def self.call(json_string)
-        ::JSON.parse(json_string)
-      end
-    end
-  end
-end

data/lib/serega/json/oj.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-class Serega
-  module SeregaJSON
-    #
-    # JSON dump adapter for ::Oj
-    #
-    class OjDump
-      # Default Oj serialization options
-      OPTS = {mode: :compat}.freeze
-
-      #
-      # Dumps data to JSON string
-      #
-      # @param data [Object] Anything
-      #
-      # @return [String] Data serialized to JSON
-      #
-      def self.call(data)
-        ::Oj.dump(data, OPTS)
-      end
-    end
-
-    #
-    # JSON parse adapter for ::Oj
-    #
-    class OjLoad
-      #
-      # Loads object from JSON string
-      #
-      # @param json_string [String] JSON String
-      #
-      # @return [Object] Deserialized data
-      #
-      def self.call(json_string)
-        ::Oj.load(json_string)
-      end
-    end
-  end
-end