alba 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e445a59555f43f7c601699a3a2ceee967d33a37ea77f2b15a0e806dec0dfc5b8
-  data.tar.gz: 3506f93a8fd9c00c5d8d85566f41032f3bc23356c753d202ce48e9ba984f1acc
+  metadata.gz: 9018588ddacac0cf7db8dac1d23c8165665c7a93976b581d25ab51357ead7834
+  data.tar.gz: 6bde71c65d8fb6965d46cea2769cd9a97d4f76407136e47de4392cdfa1a58333
 SHA512:
-  metadata.gz: 46251245a639ad19d4c75d9b3afee2f9afdd19380ae70c1a1113ccc96966402bfff6434ac2fef9cdef4785873438d6ba828ee64712a8757dc497798fd890337a
-  data.tar.gz: ce096713947ae541071331d67212dc1fb35957dd7849b8d87b98ce6a8eda05b867406ec4ffad2d64eb76fcfe2a5d8be16486f2f4cd2c88e82c259b0e58b37887
+  metadata.gz: a7d907446dad8ff8a19814cbf27ba74bfc84a0f00fae8366f561efd5de03e1ac16d66f3b31641e8ec83b5081e6e5fc61074c5a5e47509343fade989ab65e41da
+  data.tar.gz: d81e0055f6899698d70ab1522e71adc8ce9e22e3a8855ad2a3db8b54e551d2ea459a77bc92242bc5c7f8121d150c322f3b99f6d286fd7118f5df2f94d0dc3fdc

data/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.1] 2022-11-02
+
+### Fix
+
+- the bug including key not in `within` [#262](https://github.com/okuramasafumi/alba/pull/262)
+- key transformation now cascades multiple levels [#263](https://github.com/okuramasafumi/alba/pull/263)
+
 ## [2.0.0] 2022-10-21
 
 ### Breaking changes
@@ -13,16 +20,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - All Hash-related methods now return String key instead of Symbol key  
     This affects all users, but you can use `deep_symbolize_keys` in Rails environment if you prefer Symbol keys
     Some DSLs that take key argument such as `on_nil` and `on_error`, are also affected
+- Remove deprecated methods: `Resource#to_hash`, `Resource.ignoring`, `Alba.on_nil`, `Alba.on_error`, `Alba.enable_root_key_transformation!` and `Alba.disable_root_key_transformation!`
+- If using `transform_keys`, the default inflector is no longer set by default [d02245c8](https://github.com/okuramasafumi/alba/commit/d02245c87e9df303cb20e354a81e5457ea460bdd#diff-ecd8c835d2390b8cb89e7ff75e599f0c15cdbe18c30981d6090f4a515566686f)
+    To retain this functionality in Rails, add an initializer with the following:
+    `Alba.enable_inference!(with: :active_support)`
 
 ### New features
 
-- Passing an initial object to proc function in associations
-- Allow association resource to be Proc
-- `collection_key` to serialize collection into a Hash
-- params is now overridable
-- Key transformation now cascades
-- nested attribute
-- Implement `as_json`
+- Passing an initial object to proc function in associations [#209](https://github.com/okuramasafumi/alba/pull/209)
+- Allow association resource to be Proc [#213](https://github.com/okuramasafumi/alba/pull/213)
+- `collection_key` to serialize collection into a Hash [#119](https://github.com/okuramasafumi/alba/pull/119)
+- params is now overridable [#227](https://github.com/okuramasafumi/alba/pull/227)
+- Key transformation now cascades [#232](https://github.com/okuramasafumi/alba/pull/232)
+- nested attribute [#237](https://github.com/okuramasafumi/alba/pull/237)
+- Implement `as_json` [#249](https://github.com/okuramasafumi/alba/pull/249)
 
 ### Bugfix
 

data/Gemfile

@@ -10,7 +10,7 @@ gem 'inch', require: false # For inline documents
 gem 'minitest', '~> 5.14' # For test
 gem 'rake', '~> 13.0' # For test and automation
 gem 'rubocop', '>= 0.79.0', require: false # For lint
-gem 'rubocop-minitest', '~> 0.22.0', require: false # For lint
+gem 'rubocop-minitest', '~> 0.23.0', require: false # For lint
 gem 'rubocop-performance', '~> 1.15.0', require: false # For lint
 gem 'rubocop-rake', '>= 0.5.1', require: false # For lint
 gem 'rubocop-sensible', '~> 0.3.0', require: false # For lint

data/lib/alba/association.rb

@@ -20,10 +20,9 @@ module Alba
       @condition = condition
       @resource = resource
       @params = params
-      @key_transformation = key_transformation
       return if @resource
 
-      assign_resource(nesting, block)
+      assign_resource(nesting, key_transformation, block)
     end
 
     # Recursively converts an object into a Hash
@@ -58,9 +57,12 @@ module Alba
       end
     end
 
-    def assign_resource(nesting, block)
+    def assign_resource(nesting, key_transformation, block)
       @resource = if block
-                    Alba.resource_class(&block)
+                    klass = Alba.resource_class
+                    klass.transform_keys(key_transformation)
+                    klass.class_eval(&block)
+                    klass
                   elsif Alba.inferring
                     Alba.infer_resource_class(@name, nesting: nesting)
                   else
@@ -76,7 +78,6 @@ module Alba
 
     def to_h_with_constantize_resource(within, params)
       @resource = constantize(@resource)
-      @resource.transform_keys(@key_transformation)
       @resource.new(object, params: params, within: within).to_h
     end
   end

data/lib/alba/conditional_attribute.rb

@@ -1,9 +1,9 @@
+require_relative 'association'
+require_relative 'constants'
+
 module Alba
   # Represents attribute with `if` option
   class ConditionalAttribute
-    CONDITION_UNMET = Object.new.freeze
-    public_constant :CONDITION_UNMET # It's public for use in `Alba::Resource`
-
     # @param body [Symbol, Proc, Alba::Association, Alba::TypedAttribute] real attribute wrapped with condition
     # @param condition [Symbol, Proc] condition to check
     def initialize(body:, condition:)
@@ -15,14 +15,14 @@ module Alba
     #
     # @param resource [Alba::Resource]
     # @param object [Object] needed for collection, each object from collection
-    # @return [ConditionalAttribute::CONDITION_UNMET, Object] CONDITION_UNMET if condition is unmet, fetched attribute otherwise
+    # @return [Alba::REMOVE_KEY, Object] REMOVE_KEY if condition is unmet, fetched attribute otherwise
     def with_passing_condition(resource:, object: nil)
-      return CONDITION_UNMET unless condition_passes?(resource, object)
+      return Alba::REMOVE_KEY unless condition_passes?(resource, object)
 
       fetched_attribute = yield(@body)
       return fetched_attribute if fetched_attribute.nil? || !with_two_arity_proc_condition
 
-      return CONDITION_UNMET unless resource.instance_exec(object, attribute_from_association_body_or(fetched_attribute), &@condition)
+      return Alba::REMOVE_KEY unless resource.instance_exec(object, attribute_from_association_body_or(fetched_attribute), &@condition)
 
       fetched_attribute
     end

data/lib/alba/constants.rb

@@ -0,0 +1,5 @@
+# This file includes public constants to prevent circular dependencies.
+module Alba
+  REMOVE_KEY = Object.new.freeze # A constant to remove key from serialized JSON
+  public_constant :REMOVE_KEY
+end

data/lib/alba/nested_attribute.rb

@@ -10,8 +10,9 @@ module Alba
 
     # @return [Hash]
     def value(object)
-      resource_class = Alba.resource_class(&@block)
+      resource_class = Alba.resource_class
       resource_class.transform_keys(@key_transformation)
+      resource_class.class_eval(&@block)
       resource_class.new(object).serializable_hash
     end
   end

data/lib/alba/resource.rb

@@ -1,5 +1,6 @@
 require_relative 'association'
 require_relative 'conditional_attribute'
+require_relative 'constants'
 require_relative 'typed_attribute'
 require_relative 'nested_attribute'
 require_relative 'deprecation'
@@ -215,7 +216,7 @@ module Alba
       def set_key_and_attribute_body_from(object, key, attribute, hash)
         key = transform_key(key)
         value = fetch_attribute(object, key, attribute)
-        hash[key] = value unless value == ConditionalAttribute::CONDITION_UNMET
+        hash[key] = value unless value == Alba::REMOVE_KEY
       end
 
       def handle_error(error, object, key, attribute, hash)
@@ -271,7 +272,7 @@ module Alba
 
       def yield_if_within(association_name)
         within = check_within(association_name)
-        yield(within) if within
+        within ? yield(within) : Alba::REMOVE_KEY
       end
 
       def check_within(association_name)

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.0.1'.freeze
 end

data/lib/alba.rb

@@ -69,7 +69,7 @@ module Alba
     def resource_class(&block)
       klass = Class.new
       klass.include(Alba::Resource)
-      klass.class_eval(&block)
+      klass.class_eval(&block) if block
       klass
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-21 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies: []
 description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
   flexibility and usability.
@@ -52,6 +52,7 @@ files:
 - lib/alba.rb
 - lib/alba/association.rb
 - lib/alba/conditional_attribute.rb
+- lib/alba/constants.rb
 - lib/alba/default_inflector.rb
 - lib/alba/deprecation.rb
 - lib/alba/errors.rb