serega 0.33.2 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5ecb4ac9c23db4ed45c7118bcd62b8a07f20710bac2ea8fd57aea0f66e136af
-  data.tar.gz: b5af4351059c516658d6031f68fbf5dfa0e9e5a5e03e9c70d904848e7a5a8a4d
+  metadata.gz: bbda67f020296ab580f7cde1b9f867c5ab68b84f3c4cfa9c7f7517d87367640b
+  data.tar.gz: bfea118712593fc12ea96bdea8dd3d8245bf01239474b6a034d408f1fdf04342
 SHA512:
-  metadata.gz: 33267e2460b8b48da8b2b0886ac1fa2dc4c47fad82f594e277195c092d3100891b98901824c802bf5d23b3ee045ef00e6c9c904ab059faa52f403cb91ccc88fc
-  data.tar.gz: d89903f46ee168ab027bad60e253170c50c67fc029e4357db5947aef48066c94edc581fb156323f9f6eb5a822ad21da5909fb5591f473fda936fc22c5bb74b91
+  metadata.gz: 29d6e54cd973362751eda5533765cb44d8dac8621b77f335956de25d85e436e8c71889c72d4bb599a2114f98b9e2bc459c66f3a24f1e3e44441230ca32f923e3
+  data.tar.gz: bf4ea013fbd1a69e8c742964116834ae3bd4d5c4dc8dd62dd864acfcc53268277fb187a3b4f0b9a6cfb077464e6f24e4fd6222d54e6a54c53054775fe2c1707f

data/README.md

@@ -319,7 +319,7 @@ Serega includes built-in batch loading functionality to efficiently load data on
 
 #### Defining Named Batch Loaders
 
-Named loaders can be defined using the `batch_loader` class method and reused across attributes:
+Named loaders can be defined using the `batch` class method and reused across attributes:
 
 ```ruby
 class UserSerializer < Serega
@@ -385,10 +385,14 @@ class AppSerializer < Serega
   # 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
+  # Hides attributes by default. Accepts:
+  #   false         - nothing hidden (default)
+  #   true          - all attributes hidden
+  #   [:preload]    - attributes with :preload option hidden
+  #   [:batch]      - attributes with :batch option hidden
+  #   [:preload, :batch] - either option triggers hiding
+  # Useful to avoid extra DB requests for attributes that were not requested.
+  config.hide_by_default = false
 
   # Default method used on serialized object to resolve batch value
   # For example:
@@ -418,9 +422,8 @@ into a single associations hash.
 
 Configuration options:
 
-- `config.auto_preload_attributes_with_delegate` - default `false`
-- `config.auto_preload_attributes_with_serializer` - default `false`
-- `config.auto_hide_attributes_with_preload` - default `false`
+- `config.auto_preload` - default `false` (use `true` or `{ has_delegate_option: true, has_serializer_option: true }`)
+- `config.hide_by_default` - default `false` (use `[:preload]` to hide attributes with preloads)
 
 These options are extremely useful if you want to forget about finding
 preloads manually.
@@ -433,9 +436,8 @@ For some examples, **please read the comments in the code below**
 
 ```ruby
 class AppSerializer < Serega
-  config.auto_preload_attributes_with_delegate = true
-  config.auto_preload_attributes_with_serializer = true
-  config.auto_hide_attributes_with_preload = true
+  config.auto_preload = true
+  config.hide_by_default = [:preload]
 end
 
 class UserSerializer < AppSerializer
@@ -447,11 +449,11 @@ class UserSerializer < AppSerializer
     value: proc { |user| user.user_stats.followers_count }
 
   # `preload: :user_stats` added automatically, as
-  # `auto_preload_attributes_with_delegate` option is true
+  # `auto_preload` includes `has_delegate_option: true`
   attribute :comments_count, delegate: { to: :user_stats }
 
   # `preload: :albums` added automatically as
-  # `auto_preload_attributes_with_serializer` option is true
+  # `auto_preload` includes `has_serializer_option: true`
   attribute :albums, serializer: 'AlbumSerializer'
 end
 
@@ -459,7 +461,7 @@ class AlbumSerializer < AppSerializer
   attribute :images_count, delegate: { to: :album_stats }
 end
 
-# By default, preloads are empty, as we specify `auto_hide_attributes_with_preload`
+# By default, preloads are empty, as we specify `hide_by_default = [:preload]`
 # so attributes with preloads will be skipped and nothing will be preloaded
 UserSerializer.new.preloads
 # => {}
@@ -487,10 +489,8 @@ other user associations. You should specify `preload: nil` to preload
 
 ```ruby
 class AppSerializer < Serega
-  plugin :preloads,
-    auto_preload_attributes_with_delegate: true,
-    auto_preload_attributes_with_serializer: true,
-    auto_hide_attributes_with_preload: true
+  config.auto_preload = true
+  config.hide_by_default = [:preload]
 end
 
 class UserSerializer < AppSerializer
@@ -511,9 +511,7 @@ achieve this:
 
 ```ruby
 class AppSerializer < Serega
-  plugin :preloads,
-    auto_preload_attributes_with_delegate: true,
-    auto_preload_attributes_with_serializer: true
+  config.auto_preload = true
 end
 
 class UserSerializer < AppSerializer
@@ -570,9 +568,8 @@ uses ActiveRecord::Associations::Preloader to preload associations to objects.
 
 ```ruby
 class AppSerializer < Serega
-  config.auto_preload_attributes_with_delegate = true
-  config.auto_preload_attributes_with_serializer = true
-  config.auto_hide_attributes_with_preload = false
+  config.auto_preload = true
+  config.hide_by_default = false
 
   plugin :activerecord_preloads
 end

data/VERSION

@@ -1 +1 @@
-0.33.2
+0.34.0

data/lib/serega/attribute_normalizer.rb

@@ -153,18 +153,18 @@ class Serega
       end
 
       def prepare_hide
-        # Return provided durectly value
+        # Return provided directly value
         hide = init_opts[:hide]
         return hide if (hide == true) || (hide == false)
 
-        # Auto hide when `:preload` option provided
-        if config.auto_hide.fetch(:has_preload_option)
-          return true if preloads
-        end
+        hide_setting = config.hide_by_default
 
-        # Auto hide when `:batch` option provided
-        if config.auto_hide.fetch(:has_batch_option)
-          return true if batch_loaders.any?
+        case hide_setting
+        when true
+          return true
+        when Array
+          return true if hide_setting.include?(:preload) && preloads # hide when attribute has `:preload` option
+          return true if hide_setting.include?(:batch) && batch_loaders.any? # hide when attribute has `:batch` option
         end
 
         # Return nil for undefined value which means "not hide" but allows

data/lib/serega/config.rb

@@ -32,7 +32,7 @@ class Serega
       delegate_default_allow_nil: false,
       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},
+      hide_by_default: false,
       batch_id_option: :id
     }.freeze
     # :nocov:
@@ -115,23 +115,28 @@ class Serega
         opts[:delegate_default_allow_nil] = value
       end
 
-      # @return [Hash] auto_hide option
-      def auto_hide
-        opts.fetch(:auto_hide)
+      # Returns :hide_by_default config option
+      # @return [Boolean, Array<Symbol>] Current :hide_by_default config option
+      def hide_by_default
+        opts.fetch(:hide_by_default)
       end
 
-      # Validates and sets auto_hide option
-      # @return [Hash] New auto_hide option with attributes that trigger auto hide
-      def auto_hide=(value)
-        opts[:auto_hide] =
+      # Sets :hide_by_default config option
+      #
+      # @param value [Boolean, Array<Symbol>] false, true, or array of :preload/:batch symbols
+      #
+      # @return [Boolean, Array<Symbol>] New :hide_by_default config option
+      def hide_by_default=(value)
+        opts[:hide_by_default] =
           case value
-          when true then {has_preload_option: true, has_batch_option: true}
-          when false then {has_preload_option: false, has_batch_option: false}
-          when Hash
-            SeregaValidations::Utils::CheckAllowedKeys.call(value, %i[has_preload_option has_batch_option], "auto_hide")
-            {has_preload_option: !!value[:has_preload_option], has_batch_option: !!value[:has_batch_option]}
+          when true, false
+            value
+          when Array
+            invalid = value - %i[preload batch]
+            raise SeregaError, "Must have true, false, or an Array of [:preload, :batch], #{value.inspect} provided" if invalid.any?
+            value
           else
-            raise SeregaError, "Must have boolean value or Hash, #{value.inspect} provided"
+            raise SeregaError, "Must have true, false, or an Array of [:preload, :batch], #{value.inspect} provided"
           end
       end
 

data/lib/serega/plugins/activerecord_preloads/activerecord_preloads.rb

@@ -15,7 +15,7 @@ class Serega
     #   class AppSerializer < Serega
     #     config.auto_preload_attributes_with_delegate = true
     #     config.auto_preload_attributes_with_serializer = true
-    #     config.auto_hide_attributes_with_preload = true
+    #     config.hide_by_default = [:preload]
     #
     #     plugin :activerecord_preloads
     #   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serega
 version: !ruby/object:Gem::Version
-  version: 0.33.2
+  version: 0.34.0
 platform: ruby
 authors:
 - Andrey Glushkov
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.9
 specification_version: 4
 summary: JSON Serializer
 test_files: []