alba 3.3.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cabbda58cec9e9d6d1c96149f6d72d589a653f3db8112781a8a5267e4d3a5c25
-  data.tar.gz: b670cb0a6d034da44cab1f267a32e44fe2e99defd3d4318cbe03efc6bf02c8f4
+  metadata.gz: 61d5619d6222aee091fc2401da8a274a2d8aa5beebf3d8626f2bc82c6c24e89f
+  data.tar.gz: c6368081ef1701ec0d7444c9e544071d03ab5ae706fc344c9d52b027833efa4b
 SHA512:
-  metadata.gz: 350fd6d656ef37072e22033cb77cf9bb50f613f53392fcb20a0bc229ceeaa4a90f03ad41f75e1176f1adca65bb5a2eeffef13c33e60d288a71600fbaa5fb2572
-  data.tar.gz: 494d0202f252fd01613ba3621284e8d100d25df5d0e73e8732d4aaddc989ecf05282320c6f24c38548cd7ebc1d45920a44da6abaa09fb9efe7b180898d0ffdf3
+  metadata.gz: d303cd41e825e8c9bbdfd9213d9e76b99969b348e1943ebee1deb2d9ee469338dcfcab5e5fb3661915f602e1e9bed532ac96add4a387e843e1e74f356e4aae1b
+  data.tar.gz: 73cc7d1b8236c33c4f3a24f633e7029ec59f288b57fe5668da1363c926ea0d87062170440b2aef3332ada59515b8c11c9548f195137ea63507ca06705ec9547a

data/.rubocop.yml

@@ -23,6 +23,10 @@ AllCops:
   EnabledByDefault: true
   TargetRubyVersion: 3.0
 
+Bundler/GemComment:
+  Exclude:
+    - 'benchmark/**/*'
+
 # Items in Gemfile is dev dependencies and we don't have to specify versions.
 Bundler/GemVersion:
   Enabled: false

data/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.3.2] 2024-10-30
+
+### Fixed
+
+- Rails integration with `ActionController::API`
+
+## [3.3.1] 2024-10-17
+
+### Fixed
+
+- Add ostruct as gemspec dependency to be prepared for ruby 3.3.5. [#386](https://github.com/okuramasafumi/alba/pull/386)
+
 ## [3.3.0] 2024-10-09
 
 ### Added

data/Gemfile

@@ -11,7 +11,7 @@ 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.66.1', require: false # For lint
+gem 'rubocop', '~> 1.67.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

data/README.md

@@ -6,7 +6,7 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/fdab4cc0de0b9addcfe8/maintainability)](https://codeclimate.com/github/okuramasafumi/alba/maintainability)
 ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/okuramasafumi/alba)
 ![GitHub](https://img.shields.io/github/license/okuramasafumi/alba)
-[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
 
 # Alba
 

data/alba.gemspec

@@ -28,4 +28,6 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+
+  spec.add_dependency "ostruct", "~> 0.6"
 end

data/benchmark/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+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 'jserializer'
+gem 'multi_json'
+gem 'oj'
+gem 'oj_serializers'
+gem 'panko_serializer'
+gem 'pg'
+gem 'primalize'
+gem 'representable'
+gem 'simple_ams'
+gem 'sqlite3', '~> 1.4'
+gem 'turbostreamer'

data/lib/alba/railtie.rb

@@ -7,11 +7,11 @@ module Alba
       Alba.inflector = :active_support
 
       ActiveSupport.on_load(:action_controller) do
-        ActionController::Base.define_method(:serialize) do |obj, with: nil, &block|
+        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|
+        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

data/lib/alba/version.rb

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

data/lib/alba.rb

@@ -261,7 +261,7 @@ module Alba
       inflector
     end
 
-    def register_default_types # rubocop:disable Mertics/AbcSize
+    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))
       end

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.2
 platform: ruby
 authors:
 - OKURA Masafumi
 bindir: exe
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
-dependencies: []
+date: 2024-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
   flexibility and usability.
 email:
@@ -25,7 +39,6 @@ files:
 - ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/lint.yml"
 - ".github/workflows/main.yml"
-- ".github/workflows/perf.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".yardopts"
@@ -39,6 +52,7 @@ files:
 - Rakefile
 - SECURITY.md
 - alba.gemspec
+- benchmark/Gemfile
 - benchmark/README.md
 - benchmark/collection.rb
 - benchmark/prep.rb
@@ -68,7 +82,6 @@ files:
 - logo/alba-card.png
 - logo/alba-sign.png
 - logo/alba-typography.png
-- script/perf_check.rb
 homepage: https://github.com/okuramasafumi/alba
 licenses:
 - MIT

data/.github/workflows/perf.yml

@@ -1,16 +0,0 @@
-name: Performance Check
-
-on: [pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.3
-    - name: Run benchmark
-      run: |
-        ruby script/perf_check.rb

data/script/perf_check.rb

@@ -1,107 +0,0 @@
-# Benchmark script to run varieties of JSON serializers
-# Fetch Alba from local, otherwise fetch latest from RubyGems
-# exit(status)
-
-require_relative '../benchmark/prep'
-
-# --- Alba serializers ---
-
-require "alba"
-
-class AlbaCommentResource
-  include ::Alba::Resource
-  attributes :id, :body
-end
-
-class AlbaPostResource
-  include ::Alba::Resource
-  attributes :id, :body
-  attribute :commenter_names do |post|
-    post.commenters.pluck(:name)
-  end
-  many :comments, resource: AlbaCommentResource
-end
-
-# --- Blueprint serializers ---
-
-require "blueprinter"
-
-class CommentBlueprint < Blueprinter::Base
-  fields :id, :body
-end
-
-class PostBlueprint < Blueprinter::Base
-  fields :id, :body, :commenter_names
-  association :comments, blueprint: CommentBlueprint
-
-  def commenter_names
-    commenters.pluck(:name)
-  end
-end
-
-# --- JBuilder serializers ---
-
-require "jbuilder"
-
-class Post
-  def to_builder
-    Jbuilder.new do |post|
-      post.call(self, :id, :body, :commenter_names, :comments)
-    end
-  end
-
-  def commenter_names
-    commenters.pluck(:name)
-  end
-end
-
-class Comment
-  def to_builder
-    Jbuilder.new do |comment|
-      comment.call(self, :id, :body)
-    end
-  end
-end
-
-# --- Test data creation ---
-
-100.times do |i|
-  post = Post.create!(body: "post#{i}")
-  user1 = User.create!(name: "John#{i}")
-  user2 = User.create!(name: "Jane#{i}")
-  10.times do |n|
-    post.comments.create!(commenter: user1, body: "Comment1_#{i}_#{n}")
-    post.comments.create!(commenter: user2, body: "Comment2_#{i}_#{n}")
-  end
-end
-
-posts = Post.all.to_a
-
-# --- Store the serializers in procs ---
-
-alba = Proc.new { AlbaPostResource.new(posts).serialize }
-blueprinter = Proc.new { PostBlueprint.render(posts) }
-jbuilder = Proc.new do
-  Jbuilder.new do |json|
-    json.array!(posts) do |post|
-      json.post post.to_builder
-    end
-  end.target!
-end
-
-# --- Run the benchmarks ---
-
-require 'benchmark/ips'
-result = Benchmark.ips do |x|
-  x.report(:alba, &alba)
-  x.report(:blueprinter, &blueprinter)
-  x.report(:jbuilder, &jbuilder)
-end
-
-entries = result.entries.map {|entry| [entry.label, entry.iterations]}
-alba_ips = entries.find {|e| e.first == :alba }.last
-blueprinter_ips = entries.find {|e| e.first == :blueprinter }.last
-jbuidler_ips = entries.find {|e| e.first == :jbuilder }.last
-# Alba should be as fast as jbuilder and faster than blueprinter
-alba_is_fast_enough = (alba_ips - jbuidler_ips) > -10.0 && (alba_ips - blueprinter_ips) > 10.0
-exit(alba_is_fast_enough)