alba 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f7b454e9de7d518fe1287a46d1b14a0c8cb8d13e3b10fcce3eee8a9e3df05c9
-  data.tar.gz: ab670cee9399503a4480f74b4533a40eb4fd67048a0b9c93b9f706712ecc1a8f
+  metadata.gz: d0bea04ee2e971c750f9d62eca519a5401e48ab1361199581bad50f3a89e7544
+  data.tar.gz: 726fc7d31243362d2ef4165a3784a1a36eb8f067af00fc9c25664ff1c15650ac
 SHA512:
-  metadata.gz: 758481e888e55ae7a1ac87d61060cdbe76f3effea46e59b0906a125c4d804ef54f337aee014cba3df35fbd819601ad66c84eaafb820fd1a1144842a48969125a
-  data.tar.gz: 5960c6958060c3169152c4634aaecd34af1a0920b7cb6461c9652e690e6fed661275efea1a6988513be0e7142eec6e13fe3a6f61658af68a70fc25ad04eaf430
+  metadata.gz: f249c1974afc00291145059d9fcb61250948138d0ccbf33cadf1b221be1318c3425b24a0a12b16233452363ec7eda292da3a798a3534465eafba9594740e301c
+  data.tar.gz: 3e5e3e6d6c5889fa26adf5f3164bac67f7904de765e55e67c3290e38024838bbd2439a1e4e69e2b284dd39624eb5094fd8740cc15ca56794ca1d5fdbd76d8288

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

@@ -42,7 +42,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      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.
@@ -53,7 +53,7 @@ jobs:
     # 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@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -67,4 +67,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

data/.github/workflows/main.yml

@@ -1,6 +1,10 @@
 name: CI
 
-on: [push,pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 
 jobs:
   build:
@@ -29,6 +33,7 @@ jobs:
       run: |
         bundle exec rake
     - name: CodeCov
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v4
       with:
         files: ./coverage/coverage.xml
+        token: ${{ secrets.CODECOV_TOKEN }}

data/.rubocop.yml

@@ -15,7 +15,6 @@ require:
 
 AllCops:
   Exclude:
-    - 'Rakefile'
     - 'alba.gemspec'
     - 'benchmark/**/*.rb'
     - 'docs/**/*'

data/CHANGELOG.md

@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.1.0] 2024-03-23
+
+### Added
+
+- Add the ability to change key for metadata [#362](https://github.com/okuramasafumi/alba/pull/362)
+
+## [3.0.3] 2023-12-25
+
+### Fixed
+
+- Make `as_json` compatible with Rails [#350](https://github.com/okuramasafumi/alba/pull/350)
+- Fix circular association for nested_attribute [#353](https://github.com/okuramasafumi/alba/pull/353)
+
 ## [3.0.2] 2023-12-05
 
 ### Fixed

data/Gemfile

@@ -9,12 +9,12 @@ 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', '~> 1.62.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.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-minitest', '~> 0.35.0', require: false # For lint
+gem 'rubocop-performance', '~> 1.20.2', require: false # For lint
+gem 'rubocop-rake', '~> 0.6.0', require: false # For lint
 gem 'ruby-lsp', require: false # For language server
 gem 'simplecov', '~> 0.22.0', require: false # For test coverage
 gem 'simplecov-cobertura', require: false # For test coverage

data/README.md

@@ -130,6 +130,7 @@ You can find the documentation on [RubyDoc](https://rubydoc.info/github/okuramas
 * Selectable backend
 * Key transformation
 * Root key and association resource name inference
+* Inline definition without explicit classes
 * Error handling
 * Nil handling
 * Circular associations control
@@ -1232,6 +1233,65 @@ UserResource.new([user]).serialize
 
 UserResource.new([user]).serialize(meta: {foo: :bar})
 # => '{"users":[{"id":1,"name":"Masafumi OKURA"}],"meta":{"size":1,"foo":"bar"}}'
+```
+
+You can change the key for metadata. If you change the key, it also affects the key when you pass `meta` option.
+
+```ruby
+# You can change meta key
+class UserResourceWithDifferentMetaKey
+  include Alba::Resource
+
+  root_key :user, :users
+
+  attributes :id, :name
+
+  meta :my_meta do
+    {foo: :bar}
+  end
+end
+
+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}}'
+
+class UserResourceChangingMetaKeyOnly
+  include Alba::Resource
+
+  root_key :user, :users
+
+  attributes :id, :name
+
+  meta :my_meta
+end
+
+UserResourceChangingMetaKeyOnly.new([user]).serialize
+# => '{"users":[{"id":1,"name":"Masafumi OKURA"}]}'
+
+UserResourceChangingMetaKeyOnly.new([user]).serialize(meta: {extra: 42})
+# => '{"users":[{"id":1,"name":"Masafumi OKURA"}],"my_meta":{"extra":42}}'
+```
+
+It's also possible to remove the key for metadata, resulting a flat structure.
+
+```ruby
+class UserResourceRemovingMetaKey
+  include Alba::Resource
+
+  root_key :user, :users
+
+  attributes :id, :name
+
+  meta nil
+end
+
+UserResourceRemovingMetaKey.new([user]).serialize
+# => '{"users":[{"id":1,"name":"Masafumi OKURA"}]}'
+
+UserResourceRemovingMetaKey.new([user]).serialize(meta: {extra: 42})
+# => '{"users":[{"id":1,"name":"Masafumi OKURA"}],"extra":42}'
 
 # You can set metadata with `meta` option alone
 
@@ -1457,6 +1517,8 @@ end
 
 Within `helper` block, all methods should be defined without `self.`.
 
+`helper`
+
 ### Caching
 
 Currently, Alba doesn't support caching, primarily due to the behavior of `ActiveRecord::Relation`'s cache. See [the issue](https://github.com/rails/rails/issues/41784).
@@ -1563,6 +1625,40 @@ end
 
 In this way we have shorter and cleaner code. Note that we need to use `send` or `public_send` in `attribute` block to get attribute data.
 
+#### Using `helper`
+
+When we `extend AlbaExtension` like above, it's not available in inline associations.
+
+```ruby
+class BarResource
+  include Alba::Resource
+  extend AlbaExtension
+  # other attributes
+  formatted_time_attributes :created_at, :updated_at
+
+  one :something do
+    # This DOES NOT work!
+    formatted_time_attributes :updated_at
+  end
+end
+```
+
+In this case, we can use [helper](#helper) instead of `extend`.
+
+```ruby
+class BarResource
+  include Alba::Resource
+  helper AlbaExtension # HERE!
+  # other attributes
+  formatted_time_attributes :created_at, :updated_at
+
+  one :something do
+    # This WORKS!
+    formatted_time_attributes :updated_at
+  end
+end
+```
+
 ### Debugging
 
 Debugging is not easy. If you find Alba not working as you expect, there are a few things to do:

data/Rakefile

@@ -1,13 +1,15 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-ENV["BUNDLE_GEMFILE"] = File.expand_path("Gemfile") if ENV["BUNDLE_GEMFILE"] == File.expand_path("Gemfile") || ENV["BUNDLE_GEMFILE"].empty? || ENV["BUNDLE_GEMFILE"].nil?
+if ENV['BUNDLE_GEMFILE'] == File.expand_path('Gemfile') || ENV['BUNDLE_GEMFILE'].empty? || ENV['BUNDLE_GEMFILE'].nil?
+  ENV['BUNDLE_GEMFILE'] = File.expand_path('Gemfile')
+end
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  file_list = ENV["BUNDLE_GEMFILE"] == File.expand_path("Gemfile") ? FileList["test/**/*_test.rb"] : FileList["test/dependencies/test_dependencies.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  file_list = ENV['BUNDLE_GEMFILE'] == File.expand_path('Gemfile') ? FileList['test/**/*_test.rb'] : FileList['test/dependencies/test_dependencies.rb']
   t.test_files = file_list
 end
 
-task :default => :test
+task default: :test

data/lib/alba/layout.rb

@@ -12,17 +12,17 @@ module Alba
     # @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)
+      @body = if file
+                raise ArgumentError, 'File layout must be a String representing filename' unless file.is_a?(String)
 
-        @body = file
-      elsif inline
-        raise ArgumentError, 'Inline layout must be a Proc returning a Hash or a String' unless inline.is_a?(Proc)
+                file
+              elsif inline
+                raise ArgumentError, 'Inline layout must be a Proc returning a Hash or a String' unless inline.is_a?(Proc)
 
-        @body = inline
-      else
-        raise ArgumentError, 'Layout must be either String or Proc'
-      end
+                inline
+              else
+                raise ArgumentError, 'Layout must be either String or Proc'
+              end
     end
 
     # Serialize within layout

data/lib/alba/nested_attribute.rb

@@ -11,12 +11,13 @@ module Alba
 
     # @param object [Object] the object being serialized
     # @param params [Hash] params Hash inherited from Resource
+    # @param within [Object, nil, false, true] determines what associations to be serialized. If not set, it serializes all associations.
     # @return [Hash] hash serialized from running the class body in the object
-    def value(object:, params:)
+    def value(object:, params:, within:)
       resource_class = Alba.resource_class
       resource_class.transform_keys(@key_transformation)
       resource_class.class_eval(&@block)
-      resource_class.new(object, params: params).serializable_hash
+      resource_class.new(object, params: params, within: within).serializable_hash
     end
   end
 end

data/lib/alba/resource.rb

@@ -22,11 +22,11 @@ module Alba
     # @private
     def self.included(base) # rubocop:disable Metrics/MethodLength
       super
-      setup_method_body = 'private def _setup;'
+      setup_method_body = +'private def _setup;'
       base.class_eval do
         # Initialize
         INTERNAL_VARIABLES.each do |name, initial|
-          instance_variable_set("@#{name}", initial.dup) unless instance_variable_defined?("@#{name}")
+          instance_variable_set(:"@#{name}", initial.dup) unless instance_variable_defined?(:"@#{name}")
           setup_method_body << "@#{name} = self.class.#{name};"
         end
         base.define_method(:encode, Alba.encoder)
@@ -66,15 +66,23 @@ module Alba
       # @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)
+        confusing_options = options.keys.select { |k| k.to_sym == :only || k.to_sym == :except }
+        unless confusing_options.empty?
+          confusing_options.sort!
+          confusing_options.map! { |s| "\"#{s}\"" }
+          message = "You passed #{confusing_options.join(' and ')} options but ignored. Please refer to the document: https://github.com/okuramasafumi/alba/blob/main/docs/rails.md"
+          Kernel.warn(message)
+        end
+        serialize(root_key: root_key, meta: meta)
       end
 
       # Returns a Hash correspondng {#serialize}
       #
+      # @param _options [Hash] dummy parameter for Rails compatibility
       # @param root_key [Symbol, nil, true]
       # @param meta [Hash] metadata for this seialization
       # @return [Hash]
-      def as_json(root_key: nil, meta: {})
+      def as_json(_options = {}, root_key: nil, meta: {})
         key = root_key.nil? ? fetch_key : root_key
         key = Alba.regularize_key(key)
         if key && !key.empty?
@@ -95,17 +103,6 @@ module Alba
 
       private
 
-      def _to_json(root_key, meta, options)
-        confusing_options = options.keys.select { |k| k.to_sym == :only || k.to_sym == :except }
-        unless confusing_options.empty?
-          confusing_options.sort!
-          confusing_options.map! { |s| "\"#{s}\"" }
-          message = "You passed #{confusing_options.join(' and ')} options but ignored. Please refer to the document: https://github.com/okuramasafumi/alba/blob/main/docs/rails.md"
-          Kernel.warn(message)
-        end
-        serialize(root_key: root_key, meta: meta)
-      end
-
       def serialize_with(hash)
         serialized_json = encode(hash)
         return serialized_json unless @_layout
@@ -114,13 +111,22 @@ module Alba
       end
 
       def hash_with_metadata(hash, meta)
-        return hash if meta.empty? && @_meta.nil?
+        return hash if meta.empty? && @_meta&.last.nil?
+
+        key, block = @_meta || :meta
 
-        metadata = @_meta ? instance_eval(&@_meta).merge(meta) : meta
-        hash[:meta] = metadata
+        if key
+          hash[key] = _metadata(block, meta)
+        else
+          _metadata(block, meta).each { |k, v| hash[k] = v }
+        end
         hash
       end
 
+      def _metadata(block, meta)
+        block ? instance_eval(&block).merge(meta) : meta
+      end
+
       def serializable_hash_for_collection
         if @_collection_key
           @object.to_h do |item|
@@ -211,14 +217,17 @@ module Alba
       end
 
       def handle_error(error, obj, key, attribute, hash)
-        on_error = @_on_error || :raise
-        case on_error # rubocop:disable Style/MissingElse
+        case (on_error = @_on_error || :raise)
         when :raise, nil then raise(error)
         when :nullify then hash[key] = nil
         when :ignore then nil
         when Proc
           key, value = on_error.call(error, obj, key, attribute, self.class)
           hash[key] = value
+        else
+          # :nocov:
+          raise Alba::Error, 'Impossible path'
+          # :nocov:
         end
       end
 
@@ -232,11 +241,15 @@ module Alba
       end
 
       def _transform_key(inflector, key)
-        case @_transform_type # rubocop:disable Style/MissingElse
+        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
       end
 
@@ -246,9 +259,11 @@ module Alba
                 when Proc then instance_exec(obj, &attribute)
                 when Alba::Association then yield_if_within(attribute.name.to_sym) { |within| attribute.to_h(obj, params: params, within: within) }
                 when TypedAttribute then attribute.value(obj)
-                when NestedAttribute then attribute.value(object: obj, params: params)
+                when NestedAttribute then attribute.value(object: obj, params: params, within: @within)
                 when ConditionalAttribute then attribute.with_passing_condition(resource: self, object: obj) { |attr| fetch_attribute(obj, key, attr) }
+                  # :nocov:
                 else raise ::Alba::Error, "Unsupported type of attribute: #{attribute.class}"
+                  # :nocov:
                 end
         value.nil? && nil_handler ? instance_exec(obj, key, attribute, &nil_handler) : value
       end
@@ -265,11 +280,7 @@ module Alba
 
       def _fetch_attribute_from_resource_first(obj, attribute)
         if @_resource_methods.include?(attribute)
-          begin
-            __send__(attribute, obj)
-          rescue NoMethodError
-            obj.__send__(attribute)
-          end
+          __send__(attribute, obj)
         else
           obj.__send__(attribute)
         end
@@ -316,7 +327,7 @@ module Alba
       # @private
       def inherited(subclass)
         super
-        INTERNAL_VARIABLES.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
@@ -444,8 +455,8 @@ module Alba
       end
 
       # Set metadata
-      def meta(&block)
-        @_meta = block
+      def meta(key = :meta, &block)
+        @_meta = [key, block]
       end
 
       # Set layout

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '3.0.2'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/lib/alba.rb

@@ -239,11 +239,13 @@ 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) })
+    def register_default_types
+      [String, :String].each do |t|
+        register_type(t, check: ->(obj) { obj.is_a?(String) }, converter: ->(obj) { obj.to_s })
+      end
+      [Integer, :Integer].each do |t|
+        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 })
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2024-03-22 00:00:00.000000000 Z
 dependencies: []
 description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
   flexibility and usability.
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Alba is the fastest JSON serializer for Ruby.