alba 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86253dcf425b1a8bf489db53327a4f9a13c1ae046f87a5f558b75b9c1df18964
-  data.tar.gz: de8b3a29bd9b12f8cd6718a04f6140bec7611bedbf654232e9119f541d7f904e
+  metadata.gz: c68ec07a949642b11dfd36b3bf748249d0d725178ece9dd331e373fc2339cb8a
+  data.tar.gz: 7704431d69f96b88d9632c114dae90cfceae018c8372c8736c091efd2050b65a
 SHA512:
-  metadata.gz: dea93b6391ceaab7ec2759758d24df0eb14e8c59c52d8a174aeda79373afac23ca9f909a65aae3c2442106dd9d8dc700668eb6b791002ef0f9cf34833f53099a
-  data.tar.gz: 535c33bd2bea00d3029ab07a0848e37e8a30b8c6d66c3a1f894b51ad9b4aae30fc498dd000086c3e6a851c31069e6ab5d5ce11f8d96b4c687c26ae0174d42e54
+  metadata.gz: 98ca1b6fa7c6851f3a69d6d1cb54cd782a3142fccfb33391eb08cbc093ad691496a8fdb9e93e5ce89543032a0003ab8b60022ca8bbbba81c73de249b571a3fa6
+  data.tar.gz: 3756fe21da92358031a722d83b7169ef81e8749ccf6430bef577dfaac7ab4a80e68c07c6e0205497e54692f74b16e66aabad390db6eda09e486a732387541630

data/.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        ruby: [2.6, 2.7, 3.0, 3.1, head, jruby, truffleruby]
+        ruby: [2.7, 3.0, 3.1, 3.2, head, jruby, truffleruby]
         gemfile: [all, without_active_support, without_oj]
         exclude:
           - os: windows-latest

data/.rubocop.yml

@@ -16,7 +16,7 @@ AllCops:
     - 'script/**/*.rb'
   NewCops: enable
   EnabledByDefault: true
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 # Items in Gemfile is dev dependencies and we don't have to specify versions.
 Bundler/GemVersion:
@@ -58,6 +58,11 @@ Metrics/ParameterLists:
   Exclude:
     - 'test/**/*.rb'
 
+# Putting extra empty line is not valuable in test
+# We prefer shorter test code
+Minitest/EmptyLineBeforeAssertionMethods:
+  Enabled: false
+
 # We need to eval resource code to test errors on resource classes
 Security/Eval:
   Exclude:

data/CHANGELOG.md

@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.2.0] 2023-02-17
+
+### Added
+
+- Rails integration to set default inflector [#298](https://github.com/okuramasafumi/alba/pull/298)
+
+### Fixed
+
+- Fix cascade not working with association and inheritance [#300](https://github.com/okuramasafumi/alba/pull/300)
+
+### Removed
+
+- Drop support of Ruby 2.6
+
 ## [2.1.0] 2022-12-03
 
 ### Added

data/CONTRIBUTING.md

@@ -27,4 +27,4 @@ You're more than welcomed to submit a Pull Request! You are expected to follow t
 ## Documents
 
 * [code of conduct](https://github.com/okuramasafumi/alba/blob/master/CODE_OF_CONDUCT.md) for all contributors
-* [hacking document](https://github.com/okuramasafumi/alba/blob/master/DESIGN.md) for those who want to know the internal of Alba
+* [hacking document](https://github.com/okuramasafumi/alba/blob/main/HACKING.md) for those who want to know the internal of Alba

data/Gemfile

@@ -7,10 +7,11 @@ gem 'activesupport', require: false # For backend
 gem 'dry-inflector', require: false # For inflection
 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', '>= 0.79.0', require: false # For lint
-gem 'rubocop-minitest', '~> 0.24.0', require: false # For lint
-gem 'rubocop-performance', '~> 1.15.0', require: false # For lint
+gem 'rubocop-minitest', '>= 0.25.0', require: false # For lint
+gem 'rubocop-performance', '>= 1.15.0', require: false # For lint
 gem 'rubocop-rake', '>= 0.5.1', require: false # For lint
 gem 'rubocop-sensible', '~> 0.3.0', require: false # For lint
 gem 'ruby-lsp', require: false # For language server

data/README.md

@@ -23,6 +23,16 @@ If you have feature requests or interesting ideas, join us with [Ideas](https://
 
 If you want to know more about Alba, there's a [screencast](https://hanamimastery.com/episodes/21-serialization-with-alba) created by Sebastian from [Hanami Mastery](https://hanamimastery.com/). It covers basic features of Alba and how to use it in Hanami.
 
+## What users say about Alba
+
+> Alba is a well-maintained JSON serialization engine, for Ruby, JRuby, and TruffleRuby implementations, and what I like in this gem - except of its speed, is the easiness of use, no dependencies and the fact it plays well with any Ruby application!
+
+[Hanami Mastery by Seb Wilgosz](https://hanamimastery.com/episodes/21-serialization-with-alba)
+
+> Alba is more feature-rich and pretty fast, too
+
+[Gemfile of dreams by Evil Martians](https://evilmartians.com/chronicles/gemfile-of-dreams-libraries-we-use-to-build-rails-apps)
+
 ## Why Alba?
 
 Because it's fast, easy and feature rich!
@@ -57,7 +67,7 @@ Or install it yourself as:
 
 ## Supported Ruby versions
 
-Alba supports CRuby 2.6 and higher and latest JRuby and TruffleRuby.
+Alba supports CRuby 2.7 and higher and latest JRuby and TruffleRuby.
 
 ## Documentation
 
@@ -1072,7 +1082,7 @@ You can validate and convert input with types.
 class User
   attr_reader :id, :name, :age, :bio, :admin, :created_at
 
-  def initialize(id, name, age, bio = '', admin = false) # rubocop:disable Style/OptionalBooleanParameter
+  def initialize(id, name, age, bio = '', admin = false)
     @id = id
     @name = name
     @age = age

data/alba.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Alba is the fastest JSON serializer for Ruby. It focuses on performance, flexibility and usability."
   spec.homepage      = 'https://github.com/okuramasafumi/alba'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata = {
     'bug_tracker_uri' => 'https://github.com/okuramasafumi/issues',

data/lib/alba/layout.rb

@@ -8,8 +8,8 @@ module Alba
 
     def_delegators :@resource, :object, :params, :serializable_hash, :to_h
 
-    # @params file [String] name of the layout file
-    # @params inline [Proc] a proc returning JSON string or a Hash representing JSON
+    # @param file [String] name of the layout file
+    # @param inline [Proc] a proc returning JSON string or a Hash representing JSON
     def initialize(file:, inline:)
       if file
         raise ArgumentError, 'File layout must be a String representing filename' unless file.is_a?(String)

data/lib/alba/railtie.rb

@@ -0,0 +1,8 @@
+module Alba
+  # Rails integration
+  class Railtie < Rails::Railtie
+    initializer 'alba.initialize' do
+      Alba.inflector = :active_support
+    end
+  end
+end

data/lib/alba/resource.rb

@@ -11,7 +11,7 @@ module Alba
   module Resource
     # @!parse include InstanceMethods
     # @!parse extend ClassMethods
-    DSLS = {_attributes: {}, _key: nil, _key_for_collection: nil, _meta: nil, _transform_type: :none, _transforming_root_key: false, _on_error: nil, _on_nil: nil, _layout: nil, _collection_key: nil}.freeze # rubocop:disable Layout/LineLength
+    DSLS = {_attributes: {}, _key: nil, _key_for_collection: nil, _meta: nil, _transform_type: :none, _transforming_root_key: false, _key_transformation_cascade: true, _on_error: nil, _on_nil: nil, _layout: nil, _collection_key: nil}.freeze # rubocop:disable Layout/LineLength
     private_constant :DSLS
 
     WITHIN_DEFAULT = Object.new.freeze
@@ -78,7 +78,6 @@ module Alba
       #
       # @param root_key [Symbol, nil, true]
       # @param meta [Hash] metadata for this seialization
-      # @param symbolize_root_key [Boolean] determines if root key should be symbolized
       # @return [Hash]
       def as_json(root_key: nil, meta: {})
         key = root_key.nil? ? fetch_key : root_key.to_s
@@ -442,8 +441,8 @@ module Alba
 
       # Set layout
       #
-      # @params file [String] name of the layout file
-      # @params inline [Proc] a proc returning JSON string or a Hash representing JSON
+      # @param file [String] name of the layout file
+      # @param inline [Proc] a proc returning JSON string or a Hash representing JSON
       def layout(file: nil, inline: nil)
         @_layout = Layout.new(file: file, inline: inline)
       end

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/lib/alba.rb

@@ -4,6 +4,8 @@ require_relative 'alba/errors'
 require_relative 'alba/resource'
 require_relative 'alba/deprecation'
 
+require_relative 'alba/railtie' if defined?(Rails::Railtie)
+
 # Core module
 module Alba
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-03 00:00:00.000000000 Z
+date: 2023-02-17 00:00:00.000000000 Z
 dependencies: []
 description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
   flexibility and usability.
@@ -59,6 +59,7 @@ files:
 - lib/alba/errors.rb
 - lib/alba/layout.rb
 - lib/alba/nested_attribute.rb
+- lib/alba/railtie.rb
 - lib/alba/resource.rb
 - lib/alba/typed_attribute.rb
 - lib/alba/version.rb
@@ -83,14 +84,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Alba is the fastest JSON serializer for Ruby.