alba 3.3.3 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3168959e9726c35e28faf0f027dd78010b4b0cf5ead0564b8fa8a7f32e5bf84
-  data.tar.gz: b9cab46abe11f69ef40ef15d3cc673a279a6f1ab12ab8a8b908250a8462f65e8
+  metadata.gz: ad9473eff6bbd8fb5f282d2ad7c9d84ad3f104b0a5e190999bd7788fcec2d8be
+  data.tar.gz: f778882ced7677d043694ba257df58bea4fb09fd108804fd4c0a28b7c722cc20
 SHA512:
-  metadata.gz: 8d5b3c0513e7f706d484fdc19c8423fc6261bd7b670eee46009b0cf15b9b47f8bdfc14041937a57f15e75c679ad3073fa84ecaf1bcc782ab0615fdebd141a6cc
-  data.tar.gz: 017b40ee4d711a50bcd2c74719a0a4a27b4965058cfb8f37382765a84b7400fc78af754fb98b0d4aeb7ba5c935656b3d61687e9c0784a09a047269fbd2e7356f
+  metadata.gz: 484f8725e3a71a7d7714f2d19e0c005c11fd995c33e59431bef48f1dac8336360fef3fdd7657f47984bded1753e366a85b4e8bd7101bd0e418c658a508788ccf
+  data.tar.gz: 0e7c53e58d3e9146b775b06d929b37e9860dba366114db7aca21e53628e78f946dd0ac13c7dc2788b0cc7fb10eb7211b9afc0c7ecf7c4bedd892786a07c04ea2

data/.github/workflows/main.yml

@@ -12,9 +12,11 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        ruby: ['3.0', 3.1, 3.2, 3.3, head, jruby, truffleruby]
+        ruby: ['3.0', 3.1, 3.2, 3.3, 3.4, head, jruby, truffleruby]
         gemfile: [all, without_active_support, without_oj]
         exclude:
+          - os: windows-latest
+            ruby: 3.4
           - os: windows-latest
             ruby: jruby
           - os: windows-latest
@@ -33,7 +35,7 @@ jobs:
       run: |
         bundle exec rake
     - name: CodeCov
-      uses: codecov/codecov-action@v4
+      uses: codecov/codecov-action@v5
       with:
         files: ./coverage/coverage.xml
         token: ${{ secrets.CODECOV_TOKEN }}

data/CHANGELOG.md

@@ -6,6 +6,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.5.0] 2025-01-01
+
+### Added
+
+-  `render_serialized_json` now works with `root_key` and `meta` [#398](https://github.com/okuramasafumi/alba/pull/398)
+
+### Improved
+
+- Add transform_keys caching [#402](https://github.com/okuramasafumi/alba/pull/402)
+
+## [3.4.0] 2024-12-01
+
+### Added
+
+- `Alba.serialize` now works with heterogeneous collection [#396](https://github.com/okuramasafumi/alba/pull/396)
+
 ## [3.3.3] 2024-11-09
 
 ### Fixed

data/Gemfile

@@ -11,11 +11,11 @@ gem 'ffaker', require: false # For testing
 gem 'minitest', '~> 5.14' # For test
 gem 'railties', require: false # For Rails integration testing
 gem 'rake', '~> 13.0' # For test and automation
-gem 'rubocop', '~> 1.68.0', require: false # For lint
+gem 'rubocop', '~> 1.69.0', require: false # For lint
 gem 'rubocop-gem_dev', '>= 0.3.0', require: false # For lint
 gem 'rubocop-md', '~> 1.0', require: false # For lint
 gem 'rubocop-minitest', '~> 0.36.0', require: false # For lint
-gem 'rubocop-performance', '~> 1.22.1', require: false # For lint
+gem 'rubocop-performance', '~> 1.23.0', require: false # For lint
 gem 'rubocop-rake', '~> 0.6.0', require: false # For lint
 gem 'simplecov', '~> 0.22.0', require: false # For test coverage
 gem 'simplecov-cobertura', require: false # For test coverage
@@ -23,6 +23,16 @@ gem 'simplecov-cobertura', require: false # For test coverage
 # gem 'typeprof', require: false # For language server and typing
 gem 'yard', require: false # For documentation
 
+# FIXME: There is an upstream JRuby 9.4.9.0 issue with `psych` and the latest
+# version of `jar-dependencies`. The issue will be resolved with the release of
+# 9.4.10.0. Then, we can remove this `jar-dependencies` dependency lock.
+#
+# For more information, see: https://github.com/jruby/jruby/issues/8488
+#
+if defined?(JRUBY_VERSION) && Gem::Version.new(JRUBY_VERSION) < Gem::Version.new('9.4.10.0')
+  gem 'jar-dependencies', '< 0.5' # Fix
+end
+
 platforms :ruby do
   gem 'oj', '~> 3.11', require: false # For backend
   gem 'ruby-prof', require: false # For performance profiling

data/README.md

@@ -686,7 +686,7 @@ Alba.serialize(something)
 # => Same as `FooResource.new(something).serialize` when `something` is an instance of `Foo`.
 ```
 
-Although this might be useful sometimes, it's generally recommended to define a class for Resource.
+Although this might be useful sometimes, it's generally recommended to define a class for Resource. Defining a class is often more readable and more maintainable, and inline definitions cannot levarage the benefit of YJIT (it's the slowest with the benchmark YJIT enabled).
 
 #### Inline definition for multiple root keys
 
@@ -730,6 +730,60 @@ end
 # => JSON containing "foo" and "bar" as root keys
 ```
 
+#### Inline definition with heterogeneous collection
+
+Alba allows to serialize a heterogeneous collection with `Alba.serialize`.
+
+```ruby
+Foo = Data.define(:id, :name)
+Bar = Data.define(:id, :address)
+
+class FooResource
+  include Alba::Resource
+
+  attributes :id, :name
+end
+
+class BarResource
+  include Alba::Resource
+
+  attributes :id, :address
+end
+
+class CustomFooResource
+  include Alba::Resource
+
+  attributes :id
+end
+
+foo1 = Foo.new(1, 'foo1')
+foo2 = Foo.new(2, 'foo2')
+bar1 = Bar.new(1, 'bar1')
+bar2 = Bar.new(2, 'bar2')
+
+# This works only when inflector is set
+Alba.serialize([foo1, bar1, foo2, bar2], with: :inference)
+# => '[{"id":1,"name":"foo1"},{"id":1,"address":"bar1"},{"id":2,"name":"foo2"},{"id":2,"address":"bar2"}]'
+
+Alba.serialize(
+  [foo1, bar1, foo2, bar2],
+  # `with` option takes a lambda to return resource class
+  with: lambda do |obj|
+          case obj
+          when Foo
+            CustomFooResource
+          when Bar
+            BarResource
+          else
+            raise # Impossible in this case
+          end
+        end
+)
+# => '[{"id":1},{"id":1,"address":"bar1"},{"id":2},{"id":2,"address":"bar2"}]'
+# Note `CustomFooResource` is used here
+
+```
+
 ### Serializable Hash
 
 Instead of serializing to JSON, you can also output a Hash by calling `serializable_hash` or the `to_h` alias. Note also that the `serialize` method is aliased as `to_json`.
@@ -1102,7 +1156,7 @@ end
 class UserResource
   include Alba::Resource
 
-  root_key!
+  root_key! # This is required to add inferred root key, otherwise it has no root key
 
   attributes :id
 

data/benchmark/Gemfile

@@ -9,9 +9,11 @@ gem 'alba', path: '../'
 gem 'benchmark-ips'
 gem 'benchmark-memory'
 gem 'blueprinter'
+gem 'csv'
 gem 'fast_serializer_ruby'
 gem 'jbuilder'
 gem 'jserializer'
+gem 'json'
 gem 'multi_json'
 gem 'oj'
 gem 'oj_serializers'

data/benchmark/README.md

@@ -1,6 +1,24 @@
 ## Benchmark for json serializers
 
-This directory contains a few different benchmark scripts. They all use inline Bundler definitions so you can run them by `ruby benchmark/collection.rb` for instance.
+This directory contains a few different benchmark scripts.
+
+## How to run
+
+```
+bundle install
+
+# with `Oj.optimize_rails`
+bundle exec ruby collection.rb
+
+# without `Oj.optimize_rails`
+NO_OJ_OPTIMIZE_RAILS=1 bundle exec ruby collection.rb
+
+# with `Oj.optimize_rails` and YJIT
+YJIT=1 bundle exec ruby collection.rb
+
+# with YJIT and without `Oj.optimize_rails`
+YJIT=1 NO_OJ_OPTIMIZE_RAILS=1 bundle exec ruby collection.rb
+```
 
 ## Result
 
@@ -65,7 +83,7 @@ Comparison:
                  ams:       14.2 i/s - 32.28x  slower
 ```
 
-`benchmark-ips` with `Oj.optimize_rail` and YJIT:
+`benchmark-ips` with `Oj.optimize_rails` and YJIT:
 
 ```
 Comparison:
@@ -82,7 +100,7 @@ Comparison:
                  ams:       20.4 i/s - 33.10x  slower
 ```
 
-`benchmark-ips` with YJIT and without `Oj.optimize_rail`:
+`benchmark-ips` with YJIT and without `Oj.optimize_rails`:
 
 ```
 Comparison:

data/benchmark/collection.rb

@@ -7,6 +7,8 @@ require_relative 'prep'
 
 require "alba"
 
+Alba.inflector = :active_support
+
 class AlbaCommentResource
   include ::Alba::Resource
   attributes :id, :body
@@ -21,6 +23,16 @@ class AlbaPostResource
   many :comments, resource: AlbaCommentResource
 end
 
+class AlbaCommentWithTransformationResource < AlbaCommentResource
+  transform_keys :lower_camel
+end
+
+class AlbaPostWithTransformationResource < AlbaPostResource
+  many :comments, resource: AlbaCommentWithTransformationResource
+
+  transform_keys :lower_camel
+end
+
 # --- ActiveModelSerializer serializers ---
 
 require "active_model_serializers"
@@ -133,7 +145,7 @@ class PostsRepresenter < Representable::Decorator
     property :id
     property :body
     property :commenter_names
-    collection :comments
+    collection :comments, decorator: CommentRepresenter
   end
 
   def commenter_names
@@ -205,6 +217,7 @@ posts = Post.all.includes(:comments, :commenters)
 # --- Store the serializers in procs ---
 
 alba = Proc.new { AlbaPostResource.new(posts).serialize }
+alba_with_transformation = Proc.new { AlbaPostWithTransformationResource.new(posts).serialize }
 alba_inline = Proc.new do
   Alba.serialize(posts) do
     attributes :id, :body
@@ -222,7 +235,7 @@ fast_serializer = Proc.new { FastSerializerPostResource.new(posts).to_json }
 jserializer = Proc.new { JserializerPostSerializer.new(posts, is_collection: true).to_json }
 panko = proc { Panko::ArraySerializer.new(posts, each_serializer: PankoPostSerializer).to_json }
 rails = Proc.new do
-  ActiveSupport::JSON.encode(posts.map{ |post| post.serializable_hash(include: :comments) })
+  posts.to_json(include: {comments: {only: [:id, :body]}}, methods: [:commenter_names])
 end
 representable = Proc.new { PostsRepresenter.new(posts).to_json }
 simple_ams = Proc.new { SimpleAMS::Renderer::Collection.new(posts, serializer: SimpleAMSPostSerializer).to_json }
@@ -254,6 +267,7 @@ end
 
 benchmark_body = lambda do |x|
   x.report(:alba, &alba)
+  x.report(:alba_with_transformation, &alba_with_transformation)
   x.report(:alba_inline, &alba_inline)
   x.report(:ams, &ams)
   x.report(:blueprinter, &blueprinter)
@@ -273,3 +287,11 @@ Benchmark.ips(&benchmark_body)
 
 require 'benchmark/memory'
 Benchmark.memory(&benchmark_body)
+
+# --- Show gem versions ---
+
+puts "Gem versions:"
+gems = %w[alba active_model_serializers blueprinter fast_serializer jserializer panko_serializer representable simple_ams turbostreamer]
+Bundler.load.specs.each do |spec|
+  puts "#{spec.name}: #{spec.version}" if gems.include?(spec.name)
+end

data/lib/alba/railtie.rb

@@ -7,13 +7,14 @@ module Alba
       Alba.inflector = :active_support
 
       ActiveSupport.on_load(:action_controller) do
-        define_method(:serialize) do |obj, with: nil, &block|
-          with.nil? ? Alba.resource_with(obj, &block) : with.new(obj)
+        define_method(:serialize) do |obj, with: nil, root_key: nil, meta: {}, &block|
+          resource = with.nil? ? Alba.resource_with(obj, &block) : with.new(obj)
+          resource.to_json(root_key: root_key, meta: meta)
         end
 
-        define_method(:render_serialized_json) do |obj, with: nil, &block|
+        define_method(:render_serialized_json) do |obj, with: nil, root_key: nil, meta: {}, &block|
           json = with.nil? ? Alba.resource_with(obj, &block) : with.new(obj)
-          render json: json
+          render json: json.to_json(root_key: root_key, meta: meta)
         end
       end
     end

data/lib/alba/resource.rb

@@ -56,7 +56,7 @@ module Alba
       # Serialize object into JSON string
       #
       # @param root_key [Symbol, nil, true]
-      # @param meta [Hash] metadata for this seialization
+      # @param meta [Hash] metadata for this serialization
       # @return [String] serialized JSON string
       def serialize(root_key: nil, meta: {})
         serialize_with(as_json(root_key: root_key, meta: meta))
@@ -78,11 +78,11 @@ module Alba
         serialize(root_key: root_key, meta: meta)
       end
 
-      # Returns a Hash correspondng {#serialize}
+      # Returns a Hash corresponding {#serialize}
       #
       # @param _options [Hash] dummy parameter for Rails compatibility
       # @param root_key [Symbol, nil, true]
-      # @param meta [Hash] metadata for this seialization
+      # @param meta [Hash] metadata for this serialization
       # @return [Hash]
       def as_json(_options = {}, root_key: nil, meta: {})
         key = root_key.nil? ? fetch_key : root_key
@@ -99,7 +99,7 @@ module Alba
       #
       # @return [Hash]
       def serializable_hash
-        collection? ? serializable_hash_for_collection : converter.call(@object)
+        Alba.collection?(@object) ? serializable_hash_for_collection : converter.call(@object)
       end
       alias to_h serializable_hash
 
@@ -143,7 +143,7 @@ module Alba
 
       # @return [String]
       def fetch_key
-        k = collection? ? _key_for_collection : _key
+        k = Alba.collection?(@object) ? _key_for_collection : _key
         transforming_root_key? ? transform_key(k) : k
       end
 
@@ -292,12 +292,6 @@ module Alba
           raise Alba::Error, "Unknown type for within option: #{@within.class}"
         end
       end
-
-      # Detect if object is a collection or not.
-      # When object is a Struct, it's Enumerable but not a collection
-      def collection?
-        @object.is_a?(Enumerable) && !@object.is_a?(Struct)
-      end
     end
 
     # Class methods

data/lib/alba/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Alba
-  VERSION = '3.3.3'
+  VERSION = '3.5.0'
 end

data/lib/alba.rb

@@ -42,25 +42,44 @@ module Alba
     # Serialize the object with inline definitions
     #
     # @param object [Object] the object to be serialized
+    # @param with [:inference, Proc, Class<Alba::Resource>] determines how to get resource class for each object
     # @param root_key [Symbol, nil, true]
     # @param block [Block] resource block
     # @return [String] serialized JSON string
     # @raise [ArgumentError] if block is absent or `with` argument's type is wrong
-    def serialize(object = nil, root_key: nil, &block)
-      resource = resource_with(object, &block)
-      resource.serialize(root_key: root_key)
+    def serialize(object = nil, with: :inference, root_key: nil, &block)
+      if collection?(object)
+        h = hashify_collection(object, with, &block)
+        Alba.encoder.call(h)
+      else
+        resource = resource_with(object, &block)
+        resource.serialize(root_key: root_key)
+      end
     end
 
     # Hashify the object with inline definitions
     #
     # @param object [Object] the object to be serialized
+    # @param with [:inference, Proc, Class<Alba::Resource>] determines how to get resource class for each object
     # @param root_key [Symbol, nil, true]
     # @param block [Block] resource block
     # @return [String] serialized JSON string
     # @raise [ArgumentError] if block is absent or `with` argument's type is wrong
-    def hashify(object = nil, root_key: nil, &block)
-      resource = resource_with(object, &block)
-      resource.as_json(root_key: root_key)
+    def hashify(object = nil, with: :inference, root_key: nil, &block)
+      if collection?(object)
+        hashify_collection(object, with, &block)
+      else
+        resource = resource_with(object, &block)
+        resource.as_json(root_key: root_key)
+      end
+    end
+
+    # Detect if object is a collection or not.
+    # When object is a Struct, it's Enumerable but not a collection
+    #
+    # @api private
+    def collection?(object)
+      object.is_a?(Enumerable) && !object.is_a?(Struct)
     end
 
     # Enable inference for key and resource name
@@ -98,6 +117,7 @@ module Alba
     #   When it's a Class or a Module, it should have some methods, see {Alba::DefaultInflector}
     def inflector=(inflector)
       @inflector = inflector_from(inflector)
+      reset_transform_keys
     end
 
     # @param block [Block] resource body
@@ -125,11 +145,13 @@ module Alba
 
     # Configure Alba to symbolize keys
     def symbolize_keys!
+      reset_transform_keys unless @symbolize_keys
       @symbolize_keys = true
     end
 
     # Configure Alba to stringify (not symbolize) keys
     def stringify_keys!
+      reset_transform_keys if @symbolize_keys
       @symbolize_keys = false
     end
 
@@ -149,19 +171,22 @@ module Alba
     # @param key [String] a target key
     # @param transform_type [Symbol] a transform type, either one of `camel`, `lower_camel`, `dash` or `snake`
     # @return [String]
-    def transform_key(key, transform_type:)
+    def transform_key(key, transform_type:) # rubocop:disable Metrics/MethodLength
       raise Alba::Error, 'Inflector is nil. You must set inflector before transforming keys.' unless inflector
 
-      key = key.to_s
+      @_transformed_keys[transform_type][key] ||= begin
+        key = key.to_s
+
+        k = case transform_type
+            when :camel then inflector.camelize(key)
+            when :lower_camel then inflector.camelize_lower(key)
+            when :dash then inflector.dasherize(key)
+            when :snake then inflector.underscore(key)
+            else raise Alba::Error, "Unknown transform type: #{transform_type}"
+            end
 
-      k = case transform_type
-          when :camel then inflector.camelize(key)
-          when :lower_camel then inflector.camelize_lower(key)
-          when :dash then inflector.dasherize(key)
-          when :snake then inflector.underscore(key)
-          else raise Alba::Error, "Unknown transform type: #{transform_type}"
-          end
-      regularize_key(k)
+        regularize_key(k)
+      end
     end
 
     # Register types, used for both builtin and custom types
@@ -189,10 +214,15 @@ module Alba
       @_on_error = :raise
       @_on_nil = nil
       @types = {}
+      reset_transform_keys
       register_default_types
     end
 
-    # This method could be part of public API, but for now it's private
+    # Get a resource object from arguments
+    # If block is given, it creates a resource class with the block
+    # Otherwise, it infers resource class from the object's class name
+    #
+    # @ param object [Object] the object whose class name is used for inferring resource class
     def resource_with(object, &block)
       klass = block ? resource_class(&block) : infer_resource_class(object.class.name)
 
@@ -253,6 +283,24 @@ module Alba
       end
     end
 
+    def hashify_collection(collection, with, &block) # rubocop:disable Metrics/MethodLength
+      collection.map do |obj|
+        resource = if block
+                     resource_class(&block)
+                   else
+                     case with
+                     when Class then with
+                     when :inference then infer_resource_class(obj.class.name)
+                     when Proc then with.call(obj)
+                     else raise ArgumentError, '`with` argument must be either :inference, Proc or Class'
+                     end
+                   end
+        raise Alba::Error if resource.nil?
+
+        resource.new(obj).to_h
+      end
+    end
+
     def validate_inflector(inflector)
       unless %i[camelize camelize_lower dasherize classify].all? { |m| inflector.respond_to?(m) }
         raise Alba::Error, "Given inflector, #{inflector.inspect} is not valid. It must implement `camelize`, `camelize_lower`, `dasherize` and `classify`."
@@ -261,6 +309,10 @@ module Alba
       inflector
     end
 
+    def reset_transform_keys
+      @_transformed_keys = Hash.new { |h, k| h[k] = {} }
+    end
+
     def register_default_types # rubocop:disable Metrics/AbcSize
       [String, :String].each do |t|
         register_type(t, check: ->(obj) { obj.is_a?(String) }, converter: lambda(&:to_s))
@@ -277,3 +329,7 @@ module Alba
 
   reset!
 end
+
+# Monkey patch for TruffleRuby
+# Delete this after 24.1.2 is released
+File::SHARE_DELETE = 0 if defined?(Truffle)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.5.0
 platform: ruby
 authors:
 - OKURA Masafumi
 bindir: exe
 cert_chain: []
-date: 2024-11-09 00:00:00.000000000 Z
+date: 2025-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ostruct