alba 2.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89ce66083a51c7811468f9435288afbc53f81418f21635af4393eaf1ac635d14
-  data.tar.gz: 7344d77ba35c156a6a18abe6f5ff498b7a8cd24b460c5b3f6bf1f0739bd0c8aa
+  metadata.gz: d76423c125b10f3a012066e6df3924c1dde50c1842e78be87179d99da8707a9e
+  data.tar.gz: 23bba5622260ac6926a669b1d4d4aa44e6a4189838b2c77b23f6e846c56ea14f
 SHA512:
-  metadata.gz: 33e534a676d589ba88db064b8ba57bbd10a20d268c417d8ed89fbc9b830f2861e4d3c1b46772d9151fce5dcff909e591f26f4fe1be77c247da4e1ceb4998d1cc
-  data.tar.gz: 401030ee3033228b11d2b75fa411809e7707b0c8b6791c2fe9da8bf9ce290c290225cb4e23895bc31019cc8cead19ac20335fffb24682c58ebc7f09a8250999a
+  metadata.gz: d57037b9ea77550953a6e8dc4f6896e314ce1e63e36925ec960ebca1e2cce043f61a289091f09c74ef308de50d541e2b2624ce977dcf613165175328c546b32c
+  data.tar.gz: 21ab608e1844f3a575985927f81ed892f1cb50c8bf9008302c4572d1acc9c9bebbc66c1afce173af29a22b03f67a6e0b117197d037ae64061401e5a19d1779e6

data/.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

data/.github/workflows/lint.yml

@@ -0,0 +1,17 @@
+name: Lint
+
+on: [push,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.0 # The lowest version Alba supports
+        bundler-cache: true
+    - name: Run RuboCop
+      run: |
+        bundle exec rubocop

data/.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        ruby: [2.7, 3.0, 3.1, 3.2, head, jruby, truffleruby]
+        ruby: ['3.0', 3.1, 3.2, head, jruby, truffleruby]
         gemfile: [all, without_active_support, without_oj]
         exclude:
           - os: windows-latest
@@ -19,7 +19,7 @@ jobs:
     env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
       BUNDLE_GEMFILE: ${{ (matrix.gemfile == 'without_active_support' && 'gemfiles/without_active_support.gemfile') || (matrix.gemfile == 'without_oj' && 'gemfiles/without_oj.gemfile') || null }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.github/workflows/perf.yml

@@ -7,10 +7,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.7, 3.0, 3.1]
+        ruby: ['3.0', 3.1, 3.2]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.rubocop.yml

@@ -22,7 +22,7 @@ AllCops:
     - 'script/**/*.rb'
   NewCops: enable
   EnabledByDefault: true
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 # Items in Gemfile is dev dependencies and we don't have to specify versions.
 Bundler/GemVersion:
@@ -62,6 +62,12 @@ Metrics:
 
 # `Resource` module is a core module and its length tends to be long...
 # `Alba` main module is also long because it has all parts of configuration
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/alba/resource.rb'
+    - 'lib/alba.rb'
+    - 'test/**/*.rb' # Neec to specify this
+
 Metrics/ModuleLength:
   Exclude:
     - 'lib/alba/resource.rb'
@@ -93,6 +99,7 @@ Style/ConstantVisibility:
     - 'lib/alba/version.rb'
     - 'test/**/*.rb'
 
+# Copyright is in README
 Style/Copyright:
   Enabled: false
 
@@ -100,34 +107,41 @@ Style/Copyright:
 Style/DisableCopsWithinSourceCodeDirective:
   Enabled: false
 
+# Test files doesn't need to have documentation
 Style/Documentation:
   Exclude:
     - 'test/**/*'
 
+# In README it's so obvious
 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:
     - 'README.md'
 
+# We use it, don't we?
 Style/InlineComment:
   Enabled: false
 
 Style/MethodCallWithArgsParentheses:
   AllowedMethods: ['require', 'require_relative', 'include', 'extend', 'puts', 'p', 'warn', 'raise', 'send', 'public_send', 'alias_method']
   Exclude:
-    # There are so many `attributes` call without parenthese and that's absolutely fine
+    # There are so many calls like `attributes` and `register_type` without parenthese and that's absolutely fine
     - 'test/**/*.rb'
+    - 'README.md'
 
 # There are so many cases we just want `if` expression!
 Style/MissingElse:
   EnforcedStyle: case
 
+# It's example code, please forgive us
 Style/OptionalBooleanParameter:
   Exclude:
     - 'README.md'

data/CHANGELOG.md

@@ -6,6 +6,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.0] 2023-10-11
+
+### Added
+
+- Custom type [#333](https://github.com/okuramasafumi/alba/pull/333)
+
+### Changed
+
+- Prefer resource method [#323](https://github.com/okuramasafumi/alba/pull/323)
+
+### Fixed
+
+- Multithread bug [No PR](https://github.com/okuramasafumi/alba/commit/d20ed9efbf2f99827c12b8a07308e2f5aea6ab6d)
+  - This is a critical bug that can cause data corruption.
+
+### Removed
+
+- Drop support for Ruby 2 series [No PR](https://github.com/okuramasafumi/alba/commit/20be222555bde69c31fa9cbe4408b3f638cd7580)
+
+## [2.4.1] 2023-08-02
+
+#### Fixed
+
+- Fix the bug of resource name inference for classes whose name end with "Serializer" [No PR](https://github.com/okuramasafumi/alba/commit/1695af4351981725231fd071aaef5b2e4174fb26)
+
 ## [2.4.0] 2023-08-02
 
 ### Added

data/README.md

@@ -83,6 +83,12 @@ Alba is easy to use because there are only a few methods to remember. It's also
 
 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
+
+- 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))
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -101,7 +107,7 @@ Or install it yourself as:
 
 ## Supported Ruby versions
 
-Alba supports CRuby 2.7 and higher and latest JRuby and TruffleRuby.
+Alba supports CRuby 3.0 and higher and latest JRuby and TruffleRuby.
 
 ## Documentation
 
@@ -130,13 +136,13 @@ Alba's configuration is fairly simple.
 
 Backend is the actual part serializing an object into JSON. Alba supports these backends.
 
-|name|description|requires_external_gem|
-|--|--|--|
-|`oj`, `oj_strict`|Using Oj in `strict` mode|Yes(C extension)|
-|`oj_rails`|It's `oj` but in `rails` mode|Yes(C extension)|
-|`oj_default`|It's `oj` but respects mode set by users|Yes(C extension)|
-|`active_support`|For Rails compatibility|Yes|
-|`default`, `json`|Using `json` gem|No|
+|name|description|requires_external_gem| encoder|
+|--|--|--|--|
+|`oj`, `oj_strict`|Using Oj in `strict` mode|Yes(C extension)|`Oj.dump(object, mode: :strict)`|
+|`oj_rails`|It's `oj` but in `rails` mode|Yes(C extension)|`Oj.dump(object, mode: :rails)`|
+|`oj_default`|It's `oj` but respects mode set by users|Yes(C extension)|`Oj.dump(object)`|
+|`active_support`|For Rails compatibility|Yes|`ActiveSupport::JSON.encode(object)`|
+|`default`, `json`|Using `json` gem|No|`JSON.generate(object)`|
 
 You can set a backend like this:
 
@@ -144,6 +150,12 @@ You can set a backend like this:
 Alba.backend = :oj
 ```
 
+This is equivalent as:
+
+```ruby
+Alba.encoder = ->(object) { Oj.dump(object, mode: :strict) }
+```
+
 #### Encoder configuration
 
 You can also set JSON encoder directly with a Proc.
@@ -284,7 +296,7 @@ class User
   end
 
   def name_with_email
-    "dummy!"
+    'dummy!'
   end
 end
 
@@ -1231,7 +1243,7 @@ You can control circular associations with `within` option. `within` option is a
 
 For more details, please refer to [test code](https://github.com/okuramasafumi/alba/blob/main/test/usecases/circular_association_test.rb)
 
-### Experimental support of types
+### Types
 
 You can validate and convert input with types.
 
@@ -1270,7 +1282,26 @@ UserResource.new(user).serialize
 # => TypeError, 'Attribute bio is expected to be String but actually nil.'
 ```
 
-Note that this feature is experimental and interfaces are subject to change.
+#### Custom types
+
+You can define custom types to abstract data conversion logic. To define custom types, you can use `Alba.register_type` like below.
+
+```ruby
+# Typically in initializer
+Alba.register_type :iso8601, converter: ->(time) { time.iso8601(3) }, auto_convert: true
+```
+
+Then use it as regular types.
+
+```rb
+class UserResource
+  include Alba::Resource
+
+  attributes :id, created_at: :iso8601
+end
+```
+
+You now get `created_at` attribute with `iso8601` format!
 
 ### Collection serialization into Hash
 
@@ -1376,7 +1407,7 @@ class ApplicationResource
   include Alba::Resource
 
   def self.with_id
-    attributes :id
+    attributes(:id)
   end
 end
 
@@ -1401,7 +1432,7 @@ class ApplicationResource
 
   helper do
     def with_id
-      attributes :id
+      attributes(:id)
     end
   end
 end
@@ -1561,7 +1592,7 @@ FooResource.new(foo).serialize
 # => "{:id=>1}" is printed
 ```
 
-Here, we override `serialize` method with `prepend`. In overridden method we print the result of `serializable_hash` that gives the basic hash for serialization to `serialize` method. Using `...` allows us to override without knowing method signiture of `serialize`.
+Here, we override `serialize` method with `prepend`. In overridden method we print the result of `serializable_hash` that gives the basic hash for serialization to `serialize` method. Using `...` allows us to override without knowing method signature of `serialize`.
 
 Don't forget calling `super` in this way.
 

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.7.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
 
   spec.metadata = {
     'bug_tracker_uri' => 'https://github.com/okuramasafumi/alba/issues',

data/lib/alba/association.rb

@@ -8,11 +8,12 @@ module Alba
       attr_reader :const_cache
     end
 
-    attr_reader :object, :name
+    attr_reader :name
 
     # @param name [Symbol, String] name of the method to fetch association
     # @param condition [Proc, nil] a proc filtering data
-    # @param resource [Class<Alba::Resource>, nil] a resource class for the association
+    # @param resource [Class<Alba::Resource>, Proc, String, Symbol, nil]
+    #   a resource class for the association, a proc returning a resource class or a name of the resource
     # @param params [Hash] params override for the association
     # @param nesting [String] a namespace where source class is inferred with
     # @param key_transformation [Symbol] key transformation type
@@ -36,29 +37,32 @@ module Alba
     # @return [Hash]
     def to_h(target, within: nil, params: {})
       params = params.merge(@params)
-      @object = target.__send__(@name)
-      @object = @condition.call(object, params, target) if @condition
-      return if @object.nil?
+      object = target.__send__(@name)
+      object = @condition.call(object, params, target) if @condition
+      return if object.nil?
 
       if @resource.is_a?(Proc)
-        return to_h_with_each_resource(within, params) if @object.is_a?(Enumerable)
+        return to_h_with_each_resource(object, within, params) if object.is_a?(Enumerable)
 
-        @resource.call(@object).new(@object, within: within, params: params).to_h
+        @resource.call(object).new(object, within: within, params: params).to_h
       else
-        to_h_with_constantize_resource(within, params)
+        to_h_with_constantize_resource(object, within, params)
       end
     end
 
     private
 
     def constantize(resource)
-      case resource # rubocop:disable Style/MissingElse
+      case resource
       when Class
         resource
       when Symbol, String
+        Object.const_get(resource)
         self.class.const_cache.fetch(resource) do
           self.class.const_cache[resource] = Object.const_get(resource)
         end
+      else
+        raise Error, "Unexpected resource type: #{resource.class}"
       end
     end
 
@@ -76,13 +80,13 @@ module Alba
                   end
     end
 
-    def to_h_with_each_resource(within, params)
-      @object.map do |item|
+    def to_h_with_each_resource(object, within, params)
+      object.map do |item|
         @resource.call(item).new(item, within: within, params: params).to_h
       end
     end
 
-    def to_h_with_constantize_resource(within, params)
+    def to_h_with_constantize_resource(object, within, params)
       @resource = constantize(@resource)
       @resource.new(object, params: params, within: within).to_h
     end

data/lib/alba/conditional_attribute.rb

@@ -1,5 +1,6 @@
 require_relative 'association'
 require_relative 'constants'
+require 'ostruct'
 
 module Alba
   # Represents attribute with `if` option
@@ -23,7 +24,7 @@ module Alba
       fetched_attribute = yield(@body)
       return fetched_attribute unless with_two_arity_proc_condition
 
-      return Alba::REMOVE_KEY unless resource.instance_exec(object, attribute_from_association_body_or(fetched_attribute), &@condition)
+      return Alba::REMOVE_KEY unless resource.instance_exec(object, objectize(fetched_attribute), &@condition)
 
       fetched_attribute
     end
@@ -48,8 +49,18 @@ module Alba
       @condition.is_a?(Proc) && @condition.arity >= 2
     end
 
-    def attribute_from_association_body_or(fetched_attribute)
-      @body.is_a?(Alba::Association) ? @body.object : fetched_attribute
+    # 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
+    def objectize(fetched_attribute)
+      return fetched_attribute unless @body.is_a?(Alba::Association)
+
+      if fetched_attribute.is_a?(Array)
+        fetched_attribute.map do |hash|
+          OpenStruct.new(hash)
+        end
+      else
+        OpenStruct.new(fetched_attribute)
+      end
     end
   end
 end

data/lib/alba/resource.rb

@@ -1,6 +1,7 @@
 require_relative 'association'
 require_relative 'conditional_attribute'
 require_relative 'constants'
+require_relative 'type'
 require_relative 'typed_attribute'
 require_relative 'nested_attribute'
 require_relative 'deprecation'
@@ -11,8 +12,8 @@ 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, _key_transformation_cascade: true, _on_error: nil, _on_nil: nil, _layout: nil, _collection_key: nil, _helper: nil}.freeze # rubocop:disable Layout/LineLength
-    private_constant :DSLS
+    INTERNAL_VARIABLES = {_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, _helper: nil}.freeze # rubocop:disable Layout/LineLength
+    private_constant :INTERNAL_VARIABLES
 
     WITHIN_DEFAULT = Object.new.freeze
     private_constant :WITHIN_DEFAULT
@@ -24,7 +25,7 @@ module Alba
       setup_method_body = 'private def _setup;'
       base.class_eval do
         # Initialize
-        DSLS.each do |name, initial|
+        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
@@ -59,25 +60,13 @@ module Alba
         serialize_with(as_json(root_key: root_key, meta: meta))
       end
 
-      if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.0')
-        # For Rails compatibility
-        # The first options is a dummy parameter but required
-        # You can pass empty Hash if you don't want to pass any arguments
-        #
-        # @see #serialize
-        # @see https://github.com/rails/rails/blob/7-0-stable/actionpack/lib/action_controller/metal/renderers.rb#L156
-        def to_json(options, root_key: nil, meta: {})
-          _to_json(root_key, meta, options)
-        end
-      else
-        # For Rails compatibility
-        # The first options is a dummy parameter
-        #
-        # @see #serialize
-        # @see https://github.com/rails/rails/blob/7-0-stable/actionpack/lib/action_controller/metal/renderers.rb#L156
-        def to_json(options = {}, root_key: nil, meta: {})
-          _to_json(root_key, meta, options)
-        end
+      # For Rails compatibility
+      # The first options is a dummy parameter
+      #
+      # @see #serialize
+      # @see https://github.com/rails/rails/blob/7-0-stable/actionpack/lib/action_controller/metal/renderers.rb#L156
+      def to_json(options = {}, root_key: nil, meta: {})
+        _to_json(root_key, meta, options)
       end
 
       # Returns a Hash correspondng {#serialize}
@@ -265,9 +254,8 @@ module Alba
         value.nil? && nil_handler ? instance_exec(obj, key, attribute, &nil_handler) : value
       end
 
-      # TODO: from version 3, `_fetch_attribute_from_resource_first` is default
       def fetch_attribute_from_object_and_resource(obj, attribute)
-        _fetch_attribute_from_object_first(obj, attribute)
+        _fetch_attribute_from_resource_first(obj, attribute)
       end
 
       def _fetch_attribute_from_object_first(obj, attribute)
@@ -312,12 +300,12 @@ module Alba
 
     # Class methods
     module ClassMethods
-      attr_reader(*DSLS.keys)
+      attr_reader(*INTERNAL_VARIABLES.keys)
 
       # @private
       def inherited(subclass)
         super
-        DSLS.each_key { |name| subclass.instance_variable_set("@#{name}", instance_variable_get("@#{name}").clone) }
+        INTERNAL_VARIABLES.each_key { |name| subclass.instance_variable_set("@#{name}", instance_variable_get("@#{name}").clone) }
       end
 
       # Defining methods for DSLs and disable parameter number check since for users' benefits increasing params is fine
@@ -382,9 +370,9 @@ module Alba
       # @return [void]
       # @see Alba::Association#initialize
       def association(name, condition = nil, resource: nil, key: nil, params: {}, **options, &block)
-        key_transformation = @_key_transformation_cascade ? @_transform_type : :none
+        transformation = @_key_transformation_cascade ? @_transform_type : :none
         assoc = Association.new(
-          name: name, condition: condition, resource: resource, params: params, nesting: nesting, key_transformation: key_transformation, helper: @_helper, &block
+          name: name, condition: condition, resource: resource, params: params, nesting: nesting, key_transformation: transformation, helper: @_helper, &block
         )
         @_attributes[key&.to_sym || name.to_sym] = options[:if] ? ConditionalAttribute.new(body: assoc, condition: options[:if]) : assoc
       end
@@ -533,4 +521,7 @@ module Alba
       end
     end
   end
+
+  Serializer = Resource
+  public_constant :Serializer
 end

data/lib/alba/type.rb

@@ -0,0 +1,43 @@
+module Alba
+  # Representing type itself, combined with {Alba::TypedAttribute}
+  class Type
+    attr_reader :name
+    attr_writer :auto_convert
+
+    # @param name [Symbol, String] name of the type
+    # @param check [Proc, Boolean] proc to check type
+    #   If false, type check is skipped
+    # @param converter [Proc] proc to convert type
+    # @param auto_convert [Boolean] whether to convert type automatically
+    def initialize(name, check:, converter:, auto_convert: false)
+      @name = name
+      @check = check
+      @converter = converter
+      @auto_convert = auto_convert
+    end
+
+    # Type check
+    #
+    # @param value [Object] value to check
+    # @return [Boolean] the result of type check
+    def check(value)
+      @check == false ? false : @check.call(value)
+    end
+
+    # Type convert
+    # If @auto_convert is true, @convert proc is called with obj
+    # Otherwise, it raises an exception that is caught by {Alba::TypedAttribute}
+    #
+    # @param obj [Object] object to convert
+    def convert(obj)
+      @auto_convert ? @converter.call(obj) : raise(TypeError)
+    end
+
+    # Enable auto convert with given converter
+    # @param converter [Proc] proc to convert type
+    def auto_convert_with(converter)
+      @converter = converter
+      @auto_convert = true
+    end
+  end
+end

data/lib/alba/typed_attribute.rb

@@ -7,54 +7,27 @@ module Alba
     # @param converter [Proc]
     def initialize(name:, type:, converter:)
       @name = name
-      @type = type
-      @converter = case converter
-                   when true then default_converter
-                   when false, nil then null_converter
-                   else converter
-                   end
+      t = Alba.find_type(type)
+      @type = case converter
+              when true then t.dup.tap { _1.auto_convert = true }
+              when false, nil then t
+              else
+                t.dup.tap { _1.auto_convert_with(converter) }
+              end
     end
 
     # @param object [Object] target to check and convert type with
     # @return [String, Integer, Boolean] type-checked or type-converted object
     def value(object)
-      value, result = check(object)
-      result ? value : @converter.call(value)
+      v = object.__send__(@name)
+      result = @type.check(v)
+      result ? v : @type.convert(v)
     rescue TypeError
-      raise TypeError, "Attribute #{@name} is expected to be #{@type} but actually #{display_value_for(value)}."
+      raise TypeError, "Attribute #{@name} is expected to be #{@type.name} but actually #{display_value_for(v)}."
     end
 
     private
 
-    def check(object)
-      value = object.__send__(@name)
-      type_correct = case @type
-                     when :String, ->(klass) { klass == String } then value.is_a?(String)
-                     when :Integer, ->(klass) { klass == Integer } then value.is_a?(Integer)
-                     when :Boolean then [true, false].include?(value)
-                     else
-                       raise Alba::UnsupportedType, "Unknown type: #{@type}"
-                     end
-      [value, type_correct]
-    end
-
-    def default_converter
-      case @type
-      when :String, ->(klass) { klass == String }
-        ->(object) { object.to_s }
-      when :Integer, ->(klass) { klass == Integer }
-        ->(object) { Integer(object) }
-      when :Boolean
-        ->(object) { !!object }
-      else
-        raise Alba::UnsupportedType, "Unknown type: #{@type}"
-      end
-    end
-
-    def null_converter
-      ->(_) { raise TypeError }
-    end
-
     def display_value_for(value)
       value.nil? ? 'nil' : value.class.name
     end

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '2.4.0'.freeze
+  VERSION = '3.0.0'.freeze
 end

data/lib/alba.rb

@@ -114,7 +114,11 @@ module Alba
       raise Alba::Error, 'Inference is disabled so Alba cannot infer resource name. Set inflector before use.' unless Alba.inflector
 
       const_parent = nesting.nil? ? Object : Object.const_get(nesting)
-      const_parent.const_get("#{inflector.classify(name)}Resource")
+      begin
+        const_parent.const_get("#{inflector.classify(name)}Resource")
+      rescue NameError # Retry for serializer
+        const_parent.const_get("#{inflector.classify(name)}Serializer")
+      end
     end
 
     # Configure Alba to symbolize keys
@@ -138,6 +142,23 @@ module Alba
       @symbolize_keys ? key.to_sym : key.to_s
     end
 
+    # Register types, used for both builtin and custom types
+    #
+    # @see Alba::Type
+    # @return [void]
+    def register_type(name, check: false, converter: nil, auto_convert: false)
+      @types[name] = Type.new(name, check: check, converter: converter, auto_convert: auto_convert)
+    end
+
+    # Find type by name
+    #
+    # @return [Alba::Type]
+    def find_type(name)
+      @types.fetch(name) do
+        raise(Alba::UnsupportedType, "Unknown type: #{name}")
+      end
+    end
+
     # Reset config variables
     # Useful for test cleanup
     def reset!
@@ -145,6 +166,8 @@ module Alba
       @symbolize_keys = false
       @_on_error = :raise
       @_on_nil = nil
+      @types = {}
+      register_default_types
     end
 
     private
@@ -171,7 +194,7 @@ module Alba
 
     def set_encoder_from_backend
       @encoder = case @backend
-                 when :oj, :oj_strict then try_oj
+                 when :oj, :oj_strict then try_oj(mode: :strict)
                  when :oj_rails then try_oj(mode: :rails)
                  when :oj_default then try_oj(mode: :default)
                  when :active_support then try_active_support
@@ -181,7 +204,7 @@ module Alba
                  end
     end
 
-    def try_oj(mode: :strict)
+    def try_oj(mode:)
       require 'oj'
       case mode
       when :default
@@ -215,6 +238,14 @@ module Alba
 
       inflector
     end
+
+    def register_default_types # rubocop:disable Metrics/AbcSize
+      register_type(:String, check: ->(obj) { obj.is_a?(String) }, converter: ->(obj) { obj.to_s })
+      register_type(String, check: ->(obj) { obj.is_a?(String) }, converter: ->(obj) { obj.to_s })
+      register_type(:Integer, check: ->(obj) { obj.is_a?(Integer) }, converter: ->(obj) { Integer(obj) })
+      register_type(Integer, check: ->(obj) { obj.is_a?(Integer) }, converter: ->(obj) { Integer(obj) })
+      register_type(:Boolean, check: ->(obj) { [true, false].include?(obj) }, converter: ->(obj) { !!obj })
+    end
   end
 
   reset!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies: []
 description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
   flexibility and usability.
@@ -24,6 +24,7 @@ files:
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/dependabot.yml"
 - ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/lint.yml"
 - ".github/workflows/main.yml"
 - ".github/workflows/perf.yml"
 - ".gitignore"
@@ -62,6 +63,7 @@ files:
 - lib/alba/nested_attribute.rb
 - lib/alba/railtie.rb
 - lib/alba/resource.rb
+- lib/alba/type.rb
 - lib/alba/typed_attribute.rb
 - lib/alba/version.rb
 - logo/alba-card.png
@@ -85,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="