alba 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0bea04ee2e971c750f9d62eca519a5401e48ab1361199581bad50f3a89e7544
-  data.tar.gz: 726fc7d31243362d2ef4165a3784a1a36eb8f067af00fc9c25664ff1c15650ac
+  metadata.gz: b3b0683f5d43a9e7ce7eaea591c2a67267f56d7327a045ab0e2da081256a4543
+  data.tar.gz: 0dd80fd3c618fe35bc7b727f01c6ce8c9357fe1b0d303e2a756daf245f6d7e50
 SHA512:
-  metadata.gz: f249c1974afc00291145059d9fcb61250948138d0ccbf33cadf1b221be1318c3425b24a0a12b16233452363ec7eda292da3a798a3534465eafba9594740e301c
-  data.tar.gz: 3e5e3e6d6c5889fa26adf5f3164bac67f7904de765e55e67c3290e38024838bbd2439a1e4e69e2b284dd39624eb5094fd8740cc15ca56794ca1d5fdbd76d8288
+  metadata.gz: ec6b56b091d9fe52bf05dd8ac7f9d67bc33db86e480e2281e2914cc075939a3c21b3b2cc1e6680a435c0a69069b3e73db0983b3a3d6433bb1c12b65f83ee307a
+  data.tar.gz: afb843e8dbaa8e45181526128704a4fbd0ed427306bb294d73dc6889477e037d86091ec2fc94bf9db6d973f5da07551ce74977d9469184c67fbc3354c904f906

data/.github/workflows/main.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        ruby: ['3.0', 3.1, 3.2, head, truffleruby] # TODO: Add jruby after the error is resolved
+        ruby: ['3.0', 3.1, 3.2, 3.3, head, jruby, truffleruby]
         gemfile: [all, without_active_support, without_oj]
         exclude:
           - os: windows-latest

data/.github/workflows/perf.yml

@@ -4,18 +4,13 @@ on: [pull_request]
 
 jobs:
   build:
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ['3.0', 3.1, 3.2]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
+        ruby-version: 3.3
     - name: Run benchmark
       run: |
         ruby script/perf_check.rb

data/.rubocop.yml

@@ -88,6 +88,11 @@ Minitest/NoTestCases:
   Exclude:
     - 'test/dependencies/test_dependencies.rb'
 
+# We need to use `OpenStruct` to wrap object in ConfitionalAttribute
+Performance/OpenStruct:
+  Exclude:
+    - 'lib/alba/conditional_attribute.rb'
+
 # We need to eval resource code to test errors on resource classes
 Security/Eval:
   Exclude:
@@ -140,6 +145,11 @@ Style/MethodCallWithArgsParentheses:
 Style/MissingElse:
   EnforcedStyle: case
 
+# We need to use `OpenStruct` to wrap object in ConfitionalAttribute
+Style/OpenStructUse:
+  Exclude:
+    - 'lib/alba/conditional_attribute.rb'
+
 # It's example code, please forgive us
 Style/OptionalBooleanParameter:
   Exclude:

data/CHANGELOG.md

@@ -1,11 +1,18 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [3.2.0] 2024-06-21
+
+### Added
+
+- Rails controller integration [#370](https://github.com/okuramasafumi/alba/pull/370)
+- Modification API: `transform_keys!` [#372](https://github.com/okuramasafumi/alba/pull/372)
+
 ## [3.1.0] 2024-03-23
 
 ### Added

data/Gemfile

@@ -9,13 +9,12 @@ 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.62.0', require: false # For lint
+gem 'rubocop', '~> 1.64.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.35.0', require: false # For lint
-gem 'rubocop-performance', '~> 1.20.2', require: false # For lint
+gem 'rubocop-performance', '~> 1.21.0', require: false # For lint
 gem 'rubocop-rake', '~> 0.6.0', require: false # For lint
-gem 'ruby-lsp', require: false # For language server
 gem 'simplecov', '~> 0.22.0', require: false # For test coverage
 gem 'simplecov-cobertura', require: false # For test coverage
 # gem 'steep', require: false # For language server and typing

data/README.md

@@ -92,7 +92,7 @@ Alba is easy to use because there are only a few methods to remember. It's also
 
 ### Feature rich
 
-While Alba's core is simple, it provides additional features when you need them, For example, Alba provides [a way to control circular associations](#circular-associations-control), [root key and association resource name inference](#root-key-and-association-resource-name-inference) and [supports layouts](#layout).
+While Alba's core is simple, it provides additional features when you need them. For example, Alba provides [a way to control circular associations](#circular-associations-control), [root key and association resource name inference](#root-key-and-association-resource-name-inference) and [supports layouts](#layout).
 
 ### Other reasons
 
@@ -363,7 +363,7 @@ end
 FooResource.new(Foo.new).serialize
 # => '{"bar":"This is Foo"}'
 ```
- 
+
 #### Params
 
 You can pass a Hash to the resource for internal use. It can be used as "flags" to control attribute content.
@@ -1517,7 +1517,36 @@ end
 
 Within `helper` block, all methods should be defined without `self.`.
 
-`helper`
+### Experimental: modification API
+
+Alba now provides an experimental API to modify existing resource class without adding new classes. Currently only `transform_keys!` is implemented.
+
+Modification API returns a new class with given modifications. It's useful when you want lots of resource classes with small changes. See it in action:
+
+```ruby
+class FooResource
+  include Alba::Resource
+
+  transform_keys :camel
+
+  attributes :id
+end
+
+# Rails app
+class FoosController < ApplicationController
+  def index
+    foos = Foo.where(some: :condition)
+    key_transformation_type = params[:key_transformation_type] # Say it's "lower_camel"
+    # When params is absent, do not use modification API since it's slower
+    resource_class = key_transformation_type ? FooResource.transform_keys!(key_transformation_type) : FooResource
+    render json: resource_class.new(foos).serialize # The keys are lower_camel
+  end
+end
+```
+
+The point is that there's no need to define classes for each key transformation type (dash, camel, lower_camel and snake). This gives even more flexibility.
+
+There are some drawbacks with this approach. For example, it creates an internal, anonymous class when it's called, so there is a performance penalty and debugging difficulty. It's recommended to define classes manually when you don't need high flexibility.
 
 ### Caching
 
@@ -1659,6 +1688,20 @@ class BarResource
 end
 ```
 
+You can also pass options to your helpers.
+
+```ruby
+module AlbaExtension
+  def time_attributes(*attrs, **options)
+    attrs.each do |attr|
+      attribute(attr, **options) do |object|
+        object.__send__(attr).iso8601
+      end
+    end
+  end
+end
+```
+
 ### Debugging
 
 Debugging is not easy. If you find Alba not working as you expect, there are a few things to do:
@@ -1695,7 +1738,7 @@ module Logging
   # `...` was added in Ruby 2.7
   def serialize(...)
     puts serializable_hash
-    super(...)
+    super
   end
 end
 

data/benchmark/prep.rb

@@ -7,7 +7,7 @@ gemfile(true) do
   git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
   gem "active_model_serializers"
-  gem "activerecord", "6.1.3"
+  gem "activerecord", "~> 7.1"
   gem "alba", path: '../'
   gem "benchmark-ips"
   gem "benchmark-memory"
@@ -23,7 +23,7 @@ gemfile(true) do
   gem "oj"
   gem "representable"
   gem "simple_ams"
-  gem "sqlite3"
+  gem "sqlite3", "~> 1.4"
 end
 
 # --- Test data model setup ---

data/docs/rails.md

@@ -44,3 +44,13 @@ render json: FooResource.new(foo), only: [:id]
 # This is OK
 render json: FooResource.new(foo), status: 200
 ```
+
+### Shorthand for rendering JSON with Alba
+
+Now you can render JSON with shorthand.
+
+First, using `render json: serialize(target)` renders JSON for given target object. You can pass `with: SomeSerializer` option to render with `SomeSerializer` in this case. If you skip `with` option Alba tries to find the correct serialize automatically.
+
+There is a shorter version: `render_serialized_json(target)`. It also accepts `with` option.
+
+It's recommended to use `with` option now since it cannot automatically find correct serializers sometimes.

data/lib/alba/association.rb

@@ -29,6 +29,11 @@ module Alba
       assign_resource(nesting, key_transformation, block, helper)
     end
 
+    # This is the same API in `NestedAttribute`
+    def key_transformation=(type)
+      @resource.transform_keys(type) unless @resource.is_a?(Proc)
+    end
+
     # Recursively converts an object into a Hash
     #
     # @param target [Object] the object having an association method
@@ -65,13 +70,9 @@ module Alba
       end
     end
 
-    def assign_resource(nesting, key_transformation, block, helper) # rubocop:disable Metrics/MethodLength
+    def assign_resource(nesting, key_transformation, block, helper)
       @resource = if block
-                    klass = Alba.resource_class
-                    klass.helper(helper) if helper
-                    klass.transform_keys(key_transformation)
-                    klass.class_eval(&block)
-                    klass
+                    charged_resource_class(helper, key_transformation, block)
                   elsif Alba.inflector
                     Alba.infer_resource_class(@name, nesting: nesting)
                   else
@@ -79,6 +80,14 @@ module Alba
                   end
     end
 
+    def charged_resource_class(helper, key_transformation, block)
+      klass = Alba.resource_class
+      klass.helper(helper) if helper
+      klass.transform_keys(key_transformation)
+      klass.class_eval(&block)
+      klass
+    end
+
     def to_h_with_each_resource(object, within, params)
       object.map do |item|
         @resource.call(item).new(item, within: within, params: params).to_h

data/lib/alba/conditional_attribute.rb

@@ -51,8 +51,6 @@ module Alba
 
     # OpenStruct is used as a simple solution for converting Hash or Array of Hash into an object
     # Using OpenStruct is not good in general, but in this case there's no other solution
-    # rubocop:disable Style/OpenStructUse
-    # rubocop:disable Performance/OpenStruct
     def objectize(fetched_attribute)
       return fetched_attribute unless @body.is_a?(Alba::Association)
 
@@ -64,7 +62,5 @@ module Alba
         OpenStruct.new(fetched_attribute)
       end
     end
-    # rubocop:enable Style/OpenStructUse
-    # rubocop:enable Performance/OpenStruct
   end
 end

data/lib/alba/nested_attribute.rb

@@ -2,6 +2,9 @@ module Alba
   # Representing nested attribute
   # @api private
   class NestedAttribute
+    # Setter for key_transformation, used when it's changed after class definition
+    attr_writer :key_transformation
+
     # @param key_transformation [Symbol] determines how to transform keys
     # @param block [Proc] class body
     def initialize(key_transformation: :none, &block)

data/lib/alba/railtie.rb

@@ -3,6 +3,17 @@ module Alba
   class Railtie < Rails::Railtie
     initializer 'alba.initialize' do
       Alba.inflector = :active_support
+
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.define_method(:serialize) do |obj, with: nil, &block|
+          with.nil? ? Alba.resource_with(obj, &block) : with.new(obj)
+        end
+
+        ActionController::Base.define_method(:render_serialized_json) do |obj, with: nil, &block|
+          json = with.nil? ? Alba.resource_with(obj, &block) : with.new(obj)
+          render json: json
+        end
+      end
     end
   end
 end

data/lib/alba/resource.rb

@@ -22,17 +22,17 @@ module Alba
     # @private
     def self.included(base) # rubocop:disable Metrics/MethodLength
       super
-      setup_method_body = +'private def _setup;'
       base.class_eval do
         # Initialize
+        setup_method_body = +'private def _setup;'
         INTERNAL_VARIABLES.each do |name, initial|
           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)
+        setup_method_body << 'end'
+        class_eval(setup_method_body, __FILE__, __LINE__ + 1)
+        define_method(:encode, Alba.encoder)
       end
-      setup_method_body << 'end'
-      base.class_eval(setup_method_body, __FILE__, __LINE__ + 1)
       base.include InstanceMethods
       base.extend ClassMethods
     end
@@ -486,6 +486,26 @@ module Alba
         @_key_transformation_cascade = cascade
       end
 
+      # Transform keys as specified type AFTER the class is defined
+      # Note that this is an experimental API and may be removed/changed
+      #
+      # @see #transform_keys
+      def transform_keys!(type)
+        dup.class_eval do
+          transform_keys(type, root: @_transforming_root_key, cascade: @_key_transformation_cascade)
+
+          if @_key_transformation_cascade
+            # We need to update key transformation of associations and nested attributes
+            @_attributes.each_value do |attr|
+              next unless attr.is_a?(Association) || attr.is_a?(NestedAttribute)
+
+              attr.key_transformation = type
+            end
+          end
+          self # Return the new class
+        end
+      end
+
       # Sets key for collection serialization
       #
       # @param key [String, Symbol]

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.2.0'.freeze
 end

data/lib/alba.rb

@@ -170,8 +170,6 @@ module Alba
       register_default_types
     end
 
-    private
-
     # This method could be part of public API, but for now it's private
     def resource_with(object, &block)
       klass = block ? resource_class(&block) : infer_resource_class(object.class.name)
@@ -179,6 +177,8 @@ module Alba
       klass.new(object)
     end
 
+    private
+
     def inflector_from(name_or_module)
       case name_or_module
       when nil then nil
@@ -241,7 +241,7 @@ module Alba
 
     def register_default_types
       [String, :String].each do |t|
-        register_type(t, check: ->(obj) { obj.is_a?(String) }, converter: ->(obj) { obj.to_s })
+        register_type(t, check: ->(obj) { obj.is_a?(String) }, converter: lambda(&:to_s))
       end
       [Integer, :Integer].each do |t|
         register_type(t, check: ->(obj) { obj.is_a?(Integer) }, converter: ->(obj) { Integer(obj) })

data/script/perf_check.rb

@@ -2,74 +2,7 @@
 # Fetch Alba from local, otherwise fetch latest from RubyGems
 # exit(status)
 
-# --- Bundle dependencies ---
-
-require "bundler/inline"
-
-gemfile(true) do
-  source "https://rubygems.org"
-  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-  gem "activerecord", "~> 6.1.3"
-  gem "alba", path: '../'
-  gem "benchmark-ips"
-  gem "blueprinter"
-  gem "jbuilder"
-  gem "multi_json"
-  gem "oj"
-  gem "sqlite3"
-end
-
-# --- Test data model setup ---
-
-require "active_record"
-require "oj"
-require "sqlite3"
-Oj.optimize_rails
-
-ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
-
-ActiveRecord::Schema.define do
-  create_table :posts, force: true do |t|
-    t.string :body
-  end
-
-  create_table :comments, force: true do |t|
-    t.integer :post_id
-    t.string :body
-    t.integer :commenter_id
-  end
-
-  create_table :users, force: true do |t|
-    t.string :name
-  end
-end
-
-class Post < ActiveRecord::Base
-  has_many :comments
-  has_many :commenters, through: :comments, class_name: 'User', source: :commenter
-
-  def attributes
-    {id: nil, body: nil, commenter_names: commenter_names}
-  end
-
-  def commenter_names
-    commenters.pluck(:name)
-  end
-end
-
-class Comment < ActiveRecord::Base
-  belongs_to :post
-  belongs_to :commenter, class_name: 'User'
-
-  def attributes
-    {id: nil, body: nil}
-  end
-end
-
-class User < ActiveRecord::Base
-  has_many :comments
-end
+require_relative '../benchmark/prep'
 
 # --- Alba serializers ---
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2024-06-21 00:00:00.000000000 Z
 dependencies: []
 description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
   flexibility and usability.
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Alba is the fastest JSON serializer for Ruby.