alba 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f7b454e9de7d518fe1287a46d1b14a0c8cb8d13e3b10fcce3eee8a9e3df05c9
-  data.tar.gz: ab670cee9399503a4480f74b4533a40eb4fd67048a0b9c93b9f706712ecc1a8f
+  metadata.gz: 7a2aa4a1fc6859ca700fefbe63af11657031743b9ad6c4ec9f97c7d7eac2cef7
+  data.tar.gz: 8703816ac23d30e432053c6836a8ed3e517f318a9924ae4bf67e5b3cff79f666
 SHA512:
-  metadata.gz: 758481e888e55ae7a1ac87d61060cdbe76f3effea46e59b0906a125c4d804ef54f337aee014cba3df35fbd819601ad66c84eaafb820fd1a1144842a48969125a
-  data.tar.gz: 5960c6958060c3169152c4634aaecd34af1a0920b7cb6461c9652e690e6fed661275efea1a6988513be0e7142eec6e13fe3a6f61658af68a70fc25ad04eaf430
+  metadata.gz: abd511841f6100e00e53687a3f4b7a58a04645090f3e7204edec2c7f8ea438d70e9014b576e56aae302db293796ccd793aa4d976b4241f91f25a1cf15d0e19e6
+  data.tar.gz: bf76202cdf514b5134b5a3f1e17b17cca78dbb9c9f1029f562d9d4ccc992c9d8aaeefbf01d1c45d1f4aff658d53a21e24b0caa279b6852e1516765c6ce62d99d

data/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.3] 2023-12-25
+
+### Fixed
+
+- Make `as_json` compatible with Rails [#350](https://github.com/okuramasafumi/alba/pull/350)
+- Fix circular association for nested_attribute [#353](https://github.com/okuramasafumi/alba/pull/353)
+
 ## [3.0.2] 2023-12-05
 
 ### Fixed

data/README.md

@@ -1457,6 +1457,8 @@ end
 
 Within `helper` block, all methods should be defined without `self.`.
 
+`helper`
+
 ### Caching
 
 Currently, Alba doesn't support caching, primarily due to the behavior of `ActiveRecord::Relation`'s cache. See [the issue](https://github.com/rails/rails/issues/41784).
@@ -1563,6 +1565,40 @@ end
 
 In this way we have shorter and cleaner code. Note that we need to use `send` or `public_send` in `attribute` block to get attribute data.
 
+#### Using `helper`
+
+When we `extend AlbaExtension` like above, it's not available in inline associations.
+
+```ruby
+class BarResource
+  include Alba::Resource
+  extend AlbaExtension
+  # other attributes
+  formatted_time_attributes :created_at, :updated_at
+
+  one :something do
+    # This DOES NOT work!
+    formatted_time_attributes :updated_at
+  end
+end
+```
+
+In this case, we can use [helper](#helper) instead of `extend`.
+
+```ruby
+class BarResource
+  include Alba::Resource
+  helper AlbaExtension # HERE!
+  # other attributes
+  formatted_time_attributes :created_at, :updated_at
+
+  one :something do
+    # This WORKS!
+    formatted_time_attributes :updated_at
+  end
+end
+```
+
 ### Debugging
 
 Debugging is not easy. If you find Alba not working as you expect, there are a few things to do:

data/lib/alba/nested_attribute.rb

@@ -11,12 +11,13 @@ module Alba
 
     # @param object [Object] the object being serialized
     # @param params [Hash] params Hash inherited from Resource
+    # @param within [Object, nil, false, true] determines what associations to be serialized. If not set, it serializes all associations.
     # @return [Hash] hash serialized from running the class body in the object
-    def value(object:, params:)
+    def value(object:, params:, within:)
       resource_class = Alba.resource_class
       resource_class.transform_keys(@key_transformation)
       resource_class.class_eval(&@block)
-      resource_class.new(object, params: params).serializable_hash
+      resource_class.new(object, params: params, within: within).serializable_hash
     end
   end
 end

data/lib/alba/resource.rb

@@ -26,7 +26,7 @@ module Alba
       base.class_eval do
         # Initialize
         INTERNAL_VARIABLES.each do |name, initial|
-          instance_variable_set("@#{name}", initial.dup) unless instance_variable_defined?("@#{name}")
+          instance_variable_set(:"@#{name}", initial.dup) unless instance_variable_defined?(:"@#{name}")
           setup_method_body << "@#{name} = self.class.#{name};"
         end
         base.define_method(:encode, Alba.encoder)
@@ -71,10 +71,11 @@ module Alba
 
       # Returns a Hash correspondng {#serialize}
       #
+      # @param _options [Hash] dummy parameter for Rails compatibility
       # @param root_key [Symbol, nil, true]
       # @param meta [Hash] metadata for this seialization
       # @return [Hash]
-      def as_json(root_key: nil, meta: {})
+      def as_json(_options = {}, root_key: nil, meta: {})
         key = root_key.nil? ? fetch_key : root_key
         key = Alba.regularize_key(key)
         if key && !key.empty?
@@ -246,7 +247,7 @@ module Alba
                 when Proc then instance_exec(obj, &attribute)
                 when Alba::Association then yield_if_within(attribute.name.to_sym) { |within| attribute.to_h(obj, params: params, within: within) }
                 when TypedAttribute then attribute.value(obj)
-                when NestedAttribute then attribute.value(object: obj, params: params)
+                when NestedAttribute then attribute.value(object: obj, params: params, within: @within)
                 when ConditionalAttribute then attribute.with_passing_condition(resource: self, object: obj) { |attr| fetch_attribute(obj, key, attr) }
                 else raise ::Alba::Error, "Unsupported type of attribute: #{attribute.class}"
                 end
@@ -316,7 +317,7 @@ module Alba
       # @private
       def inherited(subclass)
         super
-        INTERNAL_VARIABLES.each_key { |name| subclass.instance_variable_set("@#{name}", instance_variable_get("@#{name}").clone) }
+        INTERNAL_VARIABLES.each_key { |name| subclass.instance_variable_set(:"@#{name}", instance_variable_get(:"@#{name}").clone) }
       end
 
       # Defining methods for DSLs and disable parameter number check since for users' benefits increasing params is fine

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '3.0.2'.freeze
+  VERSION = '3.0.3'.freeze
 end

data/lib/alba.rb

@@ -114,11 +114,14 @@ module Alba
       raise Alba::Error, 'Inference is disabled so Alba cannot infer resource name. Set inflector before use.' unless Alba.inflector
 
       const_parent = nesting.nil? ? Object : Object.const_get(nesting)
+      # rubocop-performance 1.20.2 might resolve this
+      # rubocop:disable Performance/StringIdentifierArgument
       begin
         const_parent.const_get("#{inflector.classify(name)}Resource")
       rescue NameError # Retry for serializer
         const_parent.const_get("#{inflector.classify(name)}Serializer")
       end
+      # rubocop:enable Performance/StringIdentifierArgument
     end
 
     # Configure Alba to symbolize keys

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2023-12-25 00:00:00.000000000 Z
 dependencies: []
 description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
   flexibility and usability.