alba 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3b0683f5d43a9e7ce7eaea591c2a67267f56d7327a045ab0e2da081256a4543
-  data.tar.gz: 0dd80fd3c618fe35bc7b727f01c6ce8c9357fe1b0d303e2a756daf245f6d7e50
+  metadata.gz: cabbda58cec9e9d6d1c96149f6d72d589a653f3db8112781a8a5267e4d3a5c25
+  data.tar.gz: b670cb0a6d034da44cab1f267a32e44fe2e99defd3d4318cbe03efc6bf02c8f4
 SHA512:
-  metadata.gz: ec6b56b091d9fe52bf05dd8ac7f9d67bc33db86e480e2281e2914cc075939a3c21b3b2cc1e6680a435c0a69069b3e73db0983b3a3d6433bb1c12b65f83ee307a
-  data.tar.gz: afb843e8dbaa8e45181526128704a4fbd0ed427306bb294d73dc6889477e037d86091ec2fc94bf9db6d973f5da07551ce74977d9469184c67fbc3354c904f906
+  metadata.gz: 350fd6d656ef37072e22033cb77cf9bb50f613f53392fcb20a0bc229ceeaa4a90f03ad41f75e1176f1adca65bb5a2eeffef13c33e60d288a71600fbaa5fb2572
+  data.tar.gz: 494d0202f252fd01613ba3621284e8d100d25df5d0e73e8732d4aaddc989ecf05282320c6f24c38548cd7ebc1d45920a44da6abaa09fb9efe7b180898d0ffdf3

data/.rubocop.yml

@@ -121,10 +121,6 @@ Style/DocumentationMethod:
   Exclude:
     - 'README.md'
 
-# This might be true in the future, but not many good things
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 # I don't want to think about error class in example code
 Style/ImplicitRuntimeError:
   Exclude:

data/CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.3.0] 2024-10-09
+
+### Added
+
+- Add `ArrayOfString` and `ArrayOfInteger` type [#378](https://github.com/okuramasafumi/alba/pull/378)
+
 ## [3.2.0] 2024-06-21
 
 ### Added

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in alba.gemspec
@@ -9,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.64.0', require: false # For lint
+gem 'rubocop', '~> 1.66.1', 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.21.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-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

data/README.md

@@ -98,7 +98,7 @@ While Alba's core is simple, it provides additional features when you need them.
 
 - Dependency free, no need to install `oj` or `activesupport` while Alba works well with them
 - Well tested, the test coverage is 99%
-- Well maintained, gettings frequent update and new releases (see [version history](https://rubygems.org/gems/alba/versions))
+- Well maintained, getting frequent update and new releases (see [version history](https://rubygems.org/gems/alba/versions))
 
 ## Installation
 
@@ -317,7 +317,7 @@ end
 FooResource.new(Foo.new).serialize
 ```
 
-By default, Alba create the JSON as `'{"bar":"This is FooResource"}'`. This means Alba calls a method on a Resource class and doesn't call a method on a target object. This rule is applied to methods that are explicitly defined on Resource class, so methods that Resource class inherits from `Object` class such as `format` are ignored.
+By default, Alba creates the JSON as `'{"bar":"This is FooResource"}'`. This means Alba calls a method on a Resource class and doesn't call a method on a target object. This rule is applied to methods that are explicitly defined on Resource class, so methods that Resource class inherits from `Object` class such as `format` are ignored.
 
 ```ruby
 class Foo
@@ -1023,6 +1023,36 @@ user = User.new(1, nil, nil)
 UserResource.new(user).serialize # => '{"id":1}'
 ```
 
+#### Caution for the second parameter in `if` proc
+
+`if` proc takes two parameters. The first one is the target object, `user` in the example above. The second one is `attribute` representing each attribute `if` option affects. Note that it actually calls attribute methods, so you cannot use it to prevent attribute methods called. This means if the target object is an `ActiveRecord::Base` object and using `association` with `if` option, you might want to skip the second parameter so that the SQL query won't be issued.
+
+Example:
+
+```ruby
+class User < ApplicationRecord
+  has_many :posts
+end
+
+class Post < ApplicationRecord
+  belongs_to :user
+end
+
+class UserResource
+  include Alba::Resource
+
+  # Since `_posts` parameter exists, `user.posts` are loaded
+  many :posts, if: proc { |user, _posts| user.admin? }
+end
+
+class UserResource2
+  include Alba::Resource
+
+  # Since `_posts` parameter doesn't exist, `user.posts` are NOT loaded
+  many :posts, if: proc { |user| user.admin? && params[:include_post] }
+end
+```
+
 ### Default
 
 Alba doesn't support default value for attributes, but it's easy to set a default value.
@@ -1255,7 +1285,7 @@ UserResourceWithDifferentMetaKey.new([user]).serialize
 # => '{"users":[{"id":1,"name":"Masafumi OKURA"}],"my_meta":{"foo":"bar"}}'
 
 UserResourceWithDifferentMetaKey.new([user]).serialize(meta: {extra: 42})
-# => '{"users":[{"id":1,"name":"Masafumi OKURA"}],"meta":{"size":1,"extra":42}}'
+# => '{"users":[{"id":1,"name":"Masafumi OKURA"}],"my_meta":{"foo":"bar","extra":42}}'
 
 class UserResourceChangingMetaKeyOnly
   include Alba::Resource
@@ -1379,6 +1409,12 @@ end
 
 You now get `created_at` attribute with `iso8601` format!
 
+#### Generating TypeScript types with typelizer gem
+
+We often want TypeScript types corresponding to serializers. That's possible with [typelizer](https://github.com/skryukov/typelizer) gem.
+
+For more information, please read its README.
+
 ### Collection serialization into Hash
 
 Sometimes we want to serialize a collection into a Hash, not an Array. It's possible with Alba.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 

data/benchmark/README.md

@@ -10,76 +10,110 @@ Machine spec:
 
 |Key|Value|
 |---|---|
-|OS|macOS 13.2.1|
-|CPU|Intel Corei7 Quad Core 2.3Ghz|
-|RAM|32GB|
-|Ruby|ruby 3.2.1 (2023-02-08 revision 31819e82c8) [x86_64-darwin21]|
+|OS|macOS 14.7|
+|CPU|Apple M1 Pro|
+|RAM|16GB|
+|Ruby|ruby 3.3.5 (2024-09-03 revision ef084cc8f4) [arm64-darwin23]|
 
 Library versions:
 
 |Library|Version|
 |---|---|
-|alba|2.2.0|
-|blueprinter|0.25.3|
+|alba|3.2.0|
+|blueprinter|1.1.0|
 |fast_serializer_ruby|0.6.9|
 |jserializer|0.2.1|
-|oj|3.14.2|
+|oj|3.16.6|
 |simple_ams|0.2.6|
 |representable|3.2.0|
-|turbostreamer|1.10.0|
-|jbuilder|2.11.5|
-|panko_serializer|0.7.9|
-|active_model_serializers|0.10.13|
+|turbostreamer|1.11.0|
+|jbuilder|2.13.0|
+|panko_serializer|0.8.2|
+|active_model_serializers|0.10.14|
 
 `benchmark-ips` with `Oj.optimize_rails`:
 
 ```
 Comparison:
-               panko:      310.4 i/s
-         jserializer:      120.6 i/s - 2.57x  slower
-       turbostreamer:      117.3 i/s - 2.65x  slower
-               rails:      114.0 i/s - 2.72x  slower
-         alba_inline:       99.3 i/s - 3.13x  slower
-                alba:       94.1 i/s - 3.30x  slower
-     fast_serializer:       67.8 i/s - 4.58x  slower
-         blueprinter:       57.6 i/s - 5.39x  slower
-       representable:       36.3 i/s - 8.56x  slower
-          simple_ams:       23.3 i/s - 13.32x  slower
-                 ams:       10.9 i/s - 28.53x  slower
+               panko:      447.0 i/s
+         jserializer:      168.9 i/s - 2.65x  slower
+         alba_inline:      149.4 i/s - 2.99x  slower
+                alba:      146.5 i/s - 3.05x  slower
+       turbostreamer:      138.7 i/s - 3.22x  slower
+               rails:      105.6 i/s - 4.23x  slower
+     fast_serializer:       97.6 i/s - 4.58x  slower
+         blueprinter:       66.7 i/s - 6.70x  slower
+       representable:       50.6 i/s - 8.83x  slower
+          simple_ams:       35.5 i/s - 12.57x  slower
+                 ams:       14.8 i/s - 30.25x  slower
 ```
 
 `benchmark-ips` without `Oj.optimize_rails`:
 
 ```
 Comparison:
-               panko:      326.1 i/s
-       turbostreamer:      120.6 i/s - 2.70x  slower
-         jserializer:      119.2 i/s - 2.74x  slower
-         alba_inline:      104.3 i/s - 3.13x  slower
-                alba:      102.2 i/s - 3.19x  slower
-     fast_serializer:       66.9 i/s - 4.88x  slower
-         blueprinter:       56.7 i/s - 5.75x  slower
-               rails:       33.9 i/s - 9.63x  slower
-       representable:       30.3 i/s - 10.77x  slower
-          simple_ams:       16.4 i/s - 19.84x  slower
-                 ams:        9.4 i/s - 34.56x  slower
+               panko:      457.9 i/s
+         jserializer:      165.9 i/s - 2.76x  slower
+                alba:      160.1 i/s - 2.86x  slower
+         alba_inline:      158.5 i/s - 2.89x  slower
+       turbostreamer:      141.7 i/s - 3.23x  slower
+     fast_serializer:       96.2 i/s - 4.76x  slower
+               rails:       87.2 i/s - 5.25x  slower
+         blueprinter:       67.4 i/s - 6.80x  slower
+       representable:       43.4 i/s - 10.55x  slower
+          simple_ams:       34.7 i/s - 13.20x  slower
+                 ams:       14.2 i/s - 32.28x  slower
+```
+
+`benchmark-ips` with `Oj.optimize_rail` and YJIT:
+
+```
+Comparison:
+               panko:      676.6 i/s
+         jserializer:      285.3 i/s - 2.37x  slower
+       turbostreamer:      264.2 i/s - 2.56x  slower
+                alba:      258.9 i/s - 2.61x  slower
+     fast_serializer:      179.0 i/s - 3.78x  slower
+               rails:      150.7 i/s - 4.49x  slower
+         alba_inline:      131.5 i/s - 5.15x  slower
+         blueprinter:      110.0 i/s - 6.15x  slower
+       representable:       73.5 i/s - 9.21x  slower
+          simple_ams:       62.8 i/s - 10.77x  slower
+                 ams:       20.4 i/s - 33.10x  slower
+```
+
+`benchmark-ips` with YJIT and without `Oj.optimize_rail`:
+
+```
+Comparison:
+               panko:      701.9 i/s
+                alba:      311.1 i/s - 2.26x  slower
+         jserializer:      281.6 i/s - 2.49x  slower
+       turbostreamer:      240.4 i/s - 2.92x  slower
+     fast_serializer:      180.5 i/s - 3.89x  slower
+         alba_inline:      135.6 i/s - 5.18x  slower
+               rails:      131.4 i/s - 5.34x  slower
+         blueprinter:      110.7 i/s - 6.34x  slower
+       representable:       70.5 i/s - 9.96x  slower
+          simple_ams:       57.3 i/s - 12.24x  slower
+                 ams:       20.3 i/s - 34.51x  slower
 ```
 
 `benchmark-memory`:
 
 ```
 Comparison:
-               panko:     242426 allocated
-       turbostreamer:     817568 allocated - 3.37x more
-         jserializer:     831705 allocated - 3.43x more
-                alba:    1072217 allocated - 4.42x more
-         alba_inline:    1084889 allocated - 4.48x more
-     fast_serializer:    1244385 allocated - 5.13x more
-               rails:    1272761 allocated - 5.25x more
-         blueprinter:    1680137 allocated - 6.93x more
-       representable:    2892425 allocated - 11.93x more
-                 ams:    4479569 allocated - 18.48x more
-          simple_ams:    6957913 allocated - 28.70x more
+               panko:     259178 allocated
+       turbostreamer:     817800 allocated - 3.16x more
+         jserializer:     826425 allocated - 3.19x more
+                alba:     846465 allocated - 3.27x more
+         alba_inline:     867361 allocated - 3.35x more
+     fast_serializer:    1474345 allocated - 5.69x more
+               rails:    2265905 allocated - 8.74x more
+         blueprinter:    2469905 allocated - 9.53x more
+       representable:    4994281 allocated - 19.27x more
+                 ams:    5233265 allocated - 20.19x more
+          simple_ams:    9506817 allocated - 36.68x more
 ```
 
 Conclusion: panko is extremely fast but it's a C extension gem. As pure Ruby gems, Alba, `turbostreamer` and `jserializer` are notably faster than others, but Alba is slightly slower than other two. With `Oj.optimize_rails`, `jbuilder` and Rails standard serialization are also fast.

data/benchmark/collection.rb

@@ -221,7 +221,6 @@ blueprinter = Proc.new { PostBlueprint.render(posts) }
 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 }
-primalize = proc { PrimalizePostsResource.new(posts: posts).to_json }
 rails = Proc.new do
   ActiveSupport::JSON.encode(posts.map{ |post| post.serializable_hash(include: :comments) })
 end
@@ -253,8 +252,7 @@ end
 
 # --- Run the benchmarks ---
 
-require 'benchmark/ips'
-Benchmark.ips do |x|
+benchmark_body = lambda do |x|
   x.report(:alba, &alba)
   x.report(:alba_inline, &alba_inline)
   x.report(:ams, &ams)
@@ -270,20 +268,8 @@ Benchmark.ips do |x|
   x.compare!
 end
 
+require 'benchmark/ips'
+Benchmark.ips(&benchmark_body)
 
 require 'benchmark/memory'
-Benchmark.memory do |x|
-  x.report(:alba, &alba)
-  x.report(:alba_inline, &alba_inline)
-  x.report(:ams, &ams)
-  x.report(:blueprinter, &blueprinter)
-  x.report(:fast_serializer, &fast_serializer)
-  x.report(:jserializer, &jserializer)
-  x.report(:panko, &panko)
-  x.report(:rails, &rails)
-  x.report(:representable, &representable)
-  x.report(:simple_ams, &simple_ams)
-  x.report(:turbostreamer, &turbostreamer)
-
-  x.compare!
-end
+Benchmark.memory(&benchmark_body)

data/benchmark/prep.rb

@@ -1,33 +1,7 @@
-# --- Bundle dependencies ---
-
-require "bundler/inline"
-
-gemfile(true) do
-  source "https://rubygems.org"
-  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-  gem "active_model_serializers"
-  gem "activerecord", "~> 7.1"
-  gem "alba", path: '../'
-  gem "benchmark-ips"
-  gem "benchmark-memory"
-  gem "blueprinter"
-  gem "fast_serializer_ruby"
-  gem "jbuilder"
-  gem 'turbostreamer'
-  gem "jserializer"
-  gem "multi_json"
-  gem "panko_serializer"
-  gem "pg"
-  gem "primalize"
-  gem "oj"
-  gem "representable"
-  gem "simple_ams"
-  gem "sqlite3", "~> 1.4"
-end
-
 # --- Test data model setup ---
 
+RubyVM::YJIT.enable if ENV["YJIT"]
+require "csv"
 require "pg"
 require "active_record"
 require "active_record/connection_adapters/postgresql_adapter"

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'alba'

data/gemfiles/without_active_support.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'minitest', '~> 5.14' # For test

data/gemfiles/without_oj.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'activesupport', require: false # For backend

data/lib/alba/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Representing association
   # @api private

data/lib/alba/conditional_attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'association'
 require_relative 'constants'
 require 'ostruct'

data/lib/alba/constants.rb

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

data/lib/alba/default_inflector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'active_support/inflector'
   require 'active_support/core_ext/module/delegation'

data/lib/alba/deprecation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Module for printing deprecation warning
   # @api private

data/lib/alba/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Base class for Errors
   class Error < StandardError; end

data/lib/alba/layout.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'forwardable'
 

data/lib/alba/nested_attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Representing nested attribute
   # @api private

data/lib/alba/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Rails integration
   class Railtie < Rails::Railtie

data/lib/alba/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'association'
 require_relative 'conditional_attribute'
 require_relative 'constants'
@@ -234,23 +236,7 @@ module Alba
       def transform_key(key)
         return Alba.regularize_key(key) if @_transform_type == :none || key.nil? || key.empty? # We can skip transformation
 
-        inflector = Alba.inflector
-        raise Alba::Error, 'Inflector is nil. You must set inflector before transforming keys.' unless inflector
-
-        Alba.regularize_key(_transform_key(inflector, key.to_s))
-      end
-
-      def _transform_key(inflector, key)
-        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
-          # :nocov:
-          raise Alba::Error, "Unknown transform type: #{@_transform_type}"
-          # :nocov:
-        end
+        Alba.transform_key(key, transform_type: @_transform_type)
       end
 
       def fetch_attribute(obj, key, attribute) # rubocop:disable Metrics/CyclomaticComplexity

data/lib/alba/type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Representing type itself, combined with {Alba::TypedAttribute}
   class Type

data/lib/alba/typed_attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
   # Representing typed attributes to encapsulate logic about types
   # @api private

data/lib/alba/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Alba
-  VERSION = '3.2.0'.freeze
+  VERSION = '3.3.0'
 end

data/lib/alba.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require_relative 'alba/version'
 require_relative 'alba/errors'
@@ -142,6 +144,26 @@ module Alba
       @symbolize_keys ? key.to_sym : key.to_s
     end
 
+    # Transform a key with given transform_type
+    #
+    # @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:)
+      raise Alba::Error, 'Inflector is nil. You must set inflector before transforming keys.' unless inflector
+
+      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
+      regularize_key(k)
+    end
+
     # Register types, used for both builtin and custom types
     #
     # @see Alba::Type
@@ -239,7 +261,7 @@ module Alba
       inflector
     end
 
-    def register_default_types
+    def register_default_types # rubocop:disable Mertics/AbcSize
       [String, :String].each do |t|
         register_type(t, check: ->(obj) { obj.is_a?(String) }, converter: lambda(&:to_s))
       end
@@ -247,6 +269,9 @@ module Alba
         register_type(t, check: ->(obj) { obj.is_a?(Integer) }, converter: ->(obj) { Integer(obj) })
       end
       register_type(:Boolean, check: ->(obj) { [true, false].include?(obj) }, converter: ->(obj) { !!obj })
+      [String, Integer].each do |t|
+        register_type(:"ArrayOf#{t}", check: ->(d) { d.is_a?(Array) && d.all? { _1.is_a?(t) } })
+      end
     end
   end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - OKURA Masafumi
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-21 00:00:00.000000000 Z
+date: 2024-10-09 00:00:00.000000000 Z
 dependencies: []
 description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
   flexibility and usability.
@@ -79,7 +78,6 @@ metadata:
   documentation_uri: https://rubydoc.info/github/okuramasafumi/alba
   source_code_uri: https://github.com/okuramasafumi/alba
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: Alba is the fastest JSON serializer for Ruby.
 test_files: []