alba 3.5.0 → 3.7.0

data/lib/alba.rb

@@ -46,13 +46,15 @@ module Alba
     # @param root_key [Symbol, nil, true]
     # @param block [Block] resource block
     # @return [String] serialized JSON string
-    # @raise [ArgumentError] if block is absent or `with` argument's type is wrong
+    # @raise [ArgumentError] if both object and block are not given
     def serialize(object = nil, with: :inference, root_key: nil, &block)
+      raise ArgumentError, 'Either object or block must be given' if object.nil? && block.nil?
+
       if collection?(object)
-        h = hashify_collection(object, with, &block)
+        h = hashify_collection(object, with, root_key, &block)
         Alba.encoder.call(h)
       else
-        resource = resource_with(object, &block)
+        resource = resource_for(object, &block)
         resource.serialize(root_key: root_key)
       end
     end
@@ -64,22 +66,24 @@ module Alba
     # @param root_key [Symbol, nil, true]
     # @param block [Block] resource block
     # @return [String] serialized JSON string
-    # @raise [ArgumentError] if block is absent or `with` argument's type is wrong
+    # @raise [ArgumentError] if both object and block are not given
     def hashify(object = nil, with: :inference, root_key: nil, &block)
+      raise ArgumentError, 'Either object or block must be given' if object.nil? && block.nil?
+
       if collection?(object)
-        hashify_collection(object, with, &block)
+        hashify_collection(object, with, root_key, &block)
       else
-        resource = resource_with(object, &block)
+        resource = resource_for(object, &block)
         resource.as_json(root_key: root_key)
       end
     end
 
     # Detect if object is a collection or not.
-    # When object is a Struct, it's Enumerable but not a collection
+    # When object is a Struct or a Range, it's Enumerable but not a collection
     #
     # @api private
     def collection?(object)
-      object.is_a?(Enumerable) && !object.is_a?(Struct)
+      object.is_a?(Enumerable) && !object.is_a?(Struct) && !object.is_a?(Range) && !object.is_a?(Hash)
     end
 
     # Enable inference for key and resource name
@@ -162,8 +166,9 @@ module Alba
     # @return [Symbol, String, nil]
     def regularize_key(key)
       return if key.nil?
+      return key.to_sym if @symbolize_keys
 
-      @symbolize_keys ? key.to_sym : key.to_s
+      key.is_a?(Symbol) ? key.name : key.to_s
     end
 
     # Transform a key with given transform_type
@@ -218,19 +223,45 @@ module Alba
       register_default_types
     end
 
+    # @deprecated Use resource_for instead
+    def resource_with(object, with: :inference, &block)
+      Kernel.warn('Alba.resource_with is deprecated. Use `Alba.resource_for` instead.')
+      _resource_for(object, with: with, &block)
+    end
+
     # Get a resource object from arguments
     # If block is given, it creates a resource class with the block
-    # Otherwise, it infers resource class from the object's class name
+    # Otherwise, it behaves depending on `with` argument
     #
-    # @ param object [Object] the object whose class name is used for inferring resource class
-    def resource_with(object, &block)
-      klass = block ? resource_class(&block) : infer_resource_class(object.class.name)
-
-      klass.new(object)
+    # @param object [Object] the object whose class name is used for inferring resource class
+    # @param with [:inference, Proc, Class<Alba::Resource>] determines how to get resource class for `object`
+    #   When it's `:inference`, it infers resource class from `object`'s class name
+    #   When it's a Proc, it calls the Proc with `object` as an argument
+    #   When it's a Class, it uses the Class as a resource class
+    #   Otherwise, it raises an ArgumentError
+    # @return [Alba::Resource] resource class with `object` as its target object
+    # @raise [ArgumentError] if `with` argument is not one of `:inference`, Proc or Class
+    def resource_for(object, with: :inference, &block)
+      _resource_for(object, with: with, &block)
     end
 
     private
 
+    def _resource_for(object, with: :inference, &block) # rubocop:disable Metrics/MethodLength
+      klass = if block
+                resource_class(&block)
+              else
+                case with
+                when :inference then infer_resource_class(object.class.name)
+                when Class then with
+                when Proc then with.call(object)
+                else raise ArgumentError, '`with` argument must be either :inference, Proc or Class'
+                end
+              end
+
+      klass.new(object)
+    end
+
     def inflector_from(name_or_module)
       case name_or_module
       when nil then nil
@@ -283,22 +314,14 @@ module Alba
       end
     end
 
-    def hashify_collection(collection, with, &block) # rubocop:disable Metrics/MethodLength
-      collection.map do |obj|
-        resource = if block
-                     resource_class(&block)
-                   else
-                     case with
-                     when Class then with
-                     when :inference then infer_resource_class(obj.class.name)
-                     when Proc then with.call(obj)
-                     else raise ArgumentError, '`with` argument must be either :inference, Proc or Class'
-                     end
-                   end
+    def hashify_collection(collection, with, root_key, &block)
+      array = collection.map do |obj|
+        resource = resource_for(obj, with: with, &block)
         raise Alba::Error if resource.nil?
 
-        resource.new(obj).to_h
+        resource.to_h
       end
+      root_key ? {root_key => array} : array
     end
 
     def validate_inflector(inflector)
@@ -329,7 +352,3 @@ module Alba
 
   reset!
 end
-
-# Monkey patch for TruffleRuby
-# Delete this after 24.1.2 is released
-File::SHARE_DELETE = 0 if defined?(Truffle)

metadata

@@ -1,28 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.7.0
 platform: ruby
 authors:
 - OKURA Masafumi
 bindir: exe
 cert_chain: []
-date: 2025-01-01 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'
+date: 2025-05-08 00:00:00.000000000 Z
+dependencies: []
 description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
   flexibility and usability.
 email:
@@ -31,40 +17,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".editorconfig"
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/dependabot.yml"
-- ".github/workflows/codeql-analysis.yml"
-- ".github/workflows/lint.yml"
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- ".yardopts"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Gemfile
-- HACKING.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- SECURITY.md
-- alba.gemspec
-- benchmark/Gemfile
-- benchmark/README.md
-- benchmark/collection.rb
-- benchmark/prep.rb
-- benchmark/single_resource.rb
-- bin/console
-- bin/setup
-- codecov.yml
-- docs/migrate_from_active_model_serializers.md
-- docs/migrate_from_jbuilder.md
-- docs/rails.md
-- gemfiles/without_active_support.gemfile
-- gemfiles/without_oj.gemfile
 - lib/alba.rb
 - lib/alba/association.rb
 - lib/alba/conditional_attribute.rb
@@ -79,16 +34,13 @@ files:
 - lib/alba/type.rb
 - lib/alba/typed_attribute.rb
 - lib/alba/version.rb
-- logo/alba-card.png
-- logo/alba-sign.png
-- logo/alba-typography.png
 homepage: https://github.com/okuramasafumi/alba
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/okuramasafumi/alba/issues
   changelog_uri: https://github.com/okuramasafumi/alba/blob/main/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/github/okuramasafumi/alba
+  documentation_uri: https://okuramasafumi.github.io/alba/
   source_code_uri: https://github.com/okuramasafumi/alba
   rubygems_mfa_required: 'true'
 rdoc_options: []
@@ -105,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.7.0.dev
 specification_version: 4
 summary: Alba is the fastest JSON serializer for Ruby.
 test_files: []

data/.codeclimate.yml

@@ -1,12 +0,0 @@
-version: "2"         # required to adjust maintainability checks
-
-checks:
-  method-complexity:
-    enabled: true
-    config:
-      threshold: 7
-
-exclude_patterns:
-  - "benchmark/**/*"
-  - "script/**/*"
-  - "test/**/*"

data/.editorconfig

@@ -1,10 +0,0 @@
-[*]
-end_of_line              = lf
-insert_final_newline     = true
-charset                  = utf-8
-trim_trailing_whitespace = true
-indent_style = space
-indent_size  = 2
-
-[*.{md,markdown}]
-trim_trailing_whitespace = false

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,26 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
----
-
-## Describe the bug
-A clear and concise description of what the bug is.
-
-## To Reproduce
-Steps to reproduce the behavior:
-
-## Expected behavior
-A clear and concise description of what you expected to happen.
-
-## Actual behavior
-A clear and concise description of what actually happened.
-
-## Environment
-- Ruby version: 
-
-## Additional context
-Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: enhancement
-assignees: ''
-
----
-
-## Is your feature request related to a problem? Please describe.
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-## Describe the solution you'd like
-A clear and concise description of what you want to happen.
-
-## Describe alternatives you've considered
-A clear and concise description of any alternative solutions or features you've considered.
-
-## Additional context
-Add any other context or screenshots about the feature request here.

data/.github/dependabot.yml

@@ -1,12 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: github-actions
-  directory: "/"
-  schedule:
-    interval: daily
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "20:00"
-  open-pull-requests-limit: 10

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

@@ -1,70 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ main ]
-  schedule:
-    - cron: '21 4 * * 5'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'ruby' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://git.io/codeql-language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3

data/.github/workflows/lint.yml

@@ -1,17 +0,0 @@
-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

@@ -1,41 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-
-jobs:
-  build:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        ruby: ['3.0', 3.1, 3.2, 3.3, 3.4, head, jruby, truffleruby]
-        gemfile: [all, without_active_support, without_oj]
-        exclude:
-          - os: windows-latest
-            ruby: 3.4
-          - os: windows-latest
-            ruby: jruby
-          - os: windows-latest
-            ruby: truffleruby
-    runs-on: ${{ matrix.os }}
-    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@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler-cache: true
-    - name: Run the default task
-      run: |
-        bundle exec rake
-    - name: CodeCov
-      uses: codecov/codecov-action@v5
-      with:
-        files: ./coverage/coverage.xml
-        token: ${{ secrets.CODECOV_TOKEN }}

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-Gemfile.lock
-/gemfiles/*.lock

data/.rubocop.yml

@@ -1,156 +0,0 @@
----
-
-inherit_gem:
-  rubocop-gem_dev: 'config/rubocop.yml'
-
-inherit_mode:
-  merge:
-    - Exclude
-
-require:
-  - rubocop-md
-  - rubocop-minitest
-  - rubocop-performance
-  - rubocop-rake
-
-AllCops:
-  Exclude:
-    - 'alba.gemspec'
-    - 'benchmark/**/*.rb'
-    - 'docs/**/*'
-    - 'script/**/*.rb'
-  NewCops: enable
-  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
-
-# Test class is a class, but not really
-Layout/ClassStructure:
-  Exclude:
-    - 'test/**/*'
-
-# LineLength 80 comes from restrictions in good old days.
-Layout/LineLength:
-  Max: 160
-
-# We'd like to write something like:
-#   assert_equal(
-#     expected,
-#     actual
-#   )
-Layout/RedundantLineBreak:
-  Exclude:
-    - 'test/**/*'
-
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-
-Layout/MultilineAssignmentLayout:
-  EnforcedStyle: same_line
-
-Lint/ConstantResolution:
-  Enabled: false
-
-# In test code we don't care about the metrics!
-Metrics:
-  Exclude:
-    - 'test/**/*.rb'
-
-# `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'
-    - 'lib/alba.rb'
-
-# Resource class includes DSLs, which tend to accept long list of parameters
-Metrics/ParameterLists:
-  Max: 7
-  Exclude:
-    - 'test/**/*.rb'
-
-# Putting extra empty line is not valuable in test
-# We prefer shorter test code
-Minitest/EmptyLineBeforeAssertionMethods:
-  Enabled: false
-
-# By nature of that test
-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:
-    - 'test/**/*.rb'
-
-Style/ConstantVisibility:
-  Exclude:
-    - 'lib/alba/version.rb'
-    - 'test/**/*.rb'
-
-# Copyright is in README
-Style/Copyright:
-  Enabled: false
-
-# I know what I do :)
-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'
-
-# 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 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
-
-# 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:
-    - 'README.md'

data/.yardopts

@@ -1,4 +0,0 @@
---no-private
---exclude lib/alba/version.rb
---embed-mixin ClassMethods
---embed-mixin InstanceMethods