alba 3.0.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a659a06525b2938d8115b64712344d9dc173ad86a3c6c2b392c283eccd5048fd
-  data.tar.gz: 9a9fa379c582928259580396277472438ce1afe566088214b08cccddd5836bae
+  metadata.gz: 7a2aa4a1fc6859ca700fefbe63af11657031743b9ad6c4ec9f97c7d7eac2cef7
+  data.tar.gz: 8703816ac23d30e432053c6836a8ed3e517f318a9924ae4bf67e5b3cff79f666
 SHA512:
-  metadata.gz: 6985bbc1306bc15d7173cab450df98aa8382dcaf9384975558b0a590e2f056c1d3fa16e53684033baabbeabc202fce975487afa34170691f174eafcca43043f7
-  data.tar.gz: 16eab414db7324830348eff012f269a670879138110c0595341101649acc7cf6432a9d916d44b65b885d91923d1387e6a19ca4094654f82ef60b152d94778d1d
+  metadata.gz: abd511841f6100e00e53687a3f4b7a58a04645090f3e7204edec2c7f8ea438d70e9014b576e56aae302db293796ccd793aa4d976b4241f91f25a1cf15d0e19e6
+  data.tar.gz: bf76202cdf514b5134b5a3f1e17b17cca78dbb9c9f1029f562d9d4ccc992c9d8aaeefbf01d1c45d1f4aff658d53a21e24b0caa279b6852e1516765c6ce62d99d

data/.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: Ruby
+name: CI
 
 on: [push,pull_request]
 
@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        ruby: ['3.0', 3.1, 3.2, head, jruby, truffleruby]
+        ruby: ['3.0', 3.1, 3.2, head, truffleruby] # TODO: Add jruby after the error is resolved
         gemfile: [all, without_active_support, without_oj]
         exclude:
           - os: windows-latest

data/CHANGELOG.md

@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+
+- Fixed warning when `location` option is given to `render json:` in Rails [#348](https://github.com/okuramasafumi/alba/pull/348)
+
 ## [3.0.1] 2023-10-13
 
 ### Fixed

data/CODE_OF_CONDUCT.md

@@ -1,74 +1,132 @@
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at masafumi.o1988@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported to the community leaders responsible for enforcement at masafumi.o1988@gmail.com .
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
 
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -6,6 +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)
 
 # Alba
 
@@ -14,9 +15,11 @@ Alba is a JSON serializer for Ruby, JRuby, and TruffleRuby.
 ## IMPORTANT NOTICE
 
 Both version `3.0.0` and `2.4.2` contain important bug fix.
-However, version `3.0.0` has some bugs (see https://github.com/okuramasafumi/alba/issues/342).
+~~However, version `3.0.0` has some bugs (see https://github.com/okuramasafumi/alba/issues/342).
 Until they get fixed, it's highly recommended to upgrade to version `2.4.2`.
-Dependabot and similar tools might create an automated Pull Request to upgrade to `3.0.0`, so it might be required to upgrade to `2.4.2` manually.
+Dependabot and similar tools might create an automated Pull Request to upgrade to `3.0.0`, so it might be required to upgrade to `2.4.2` manually.~~
+Version `3.0.1` has been released so Ruby 3 users should upgrade to `3.0.1`.
+For Ruby 2 users, it's highly recommended to upgrade to `2.4.2`.
 Sorry for the inconvenience.
 
 ## TL;DR
@@ -289,72 +292,77 @@ class UserResource
 end
 ```
 
-#### Prefer methods on resource
+#### Methods conflict
 
-By default, Alba prefers methods on the object to methods on the resource. This means if you have a following situation:
+Consider following code:
 
 ```ruby
-class User
-  attr_accessor :id, :name, :email
-
-  def initialize(id, name, email)
-    @id = id
-    @name = name
-    @email = email
-  end
-
-  def name_with_email
-    'dummy!'
+class Foo
+  def bar
+    'This is Foo'
   end
 end
 
-class UserResource
+class FooResource
   include Alba::Resource
 
-  root_key :user, :users # Later is for plural
-
-  attributes :id, :name, :name_with_email
+  attributes :bar
 
-  # Same method exists in `User` class!
-  # This is not called
-  def name_with_email(user)
-    "#{user.name}: #{user.email}"
+  def bar
+    'This is FooResource'
   end
 end
 
-user = User.new(1, 'Masafumi OKURA', 'masafumi@example.com')
-UserResource.new(user).serialize
-# => '{"user":{"id":1,"name":"Masafumi OKURA","name_with_email":"dummy!"}}'
+FooResource.new(Foo.new).serialize
 ```
 
-You can see that `name_with_email` is now `dummy!` from `User#name_with_email`. You cna change this behavior by using `prefer_resource_method!` DSL in a resource class:
+By default, Alba create the JSON as `'{"bar":"This is FooResource"}'`. This means Alba calls a method on a Resource class and doesn't call a method on a target object. This rule is applied to methods that are explicitly defined on Resource class, so methods that Resource class inherits from `Object` class such as `format` are ignored.
 
 ```ruby
-# With the same `User` class
+class Foo
+  def format
+    'This is Foo'
+  end
+end
 
-class UserResource
+class FooResource
   include Alba::Resource
 
-  prefer_resource_method! # This line is important
+  attributes :bar
 
-  root_key :user, :users # Later is for plural
+  # Here, `format` method is available
+end
 
-  attributes :id, :name, :name_with_email
+FooResource.new(Foo.new).serialize
+# => '{"bar":"This is Foo"}'
+```
 
-  # Same method exists in `User` class!
-  # But now this is called!
-  def name_with_email(user)
-    "#{user.name}: #{user.email}"
+If you'd like Alba to call methods on a target object, use `prefer_object_method!` like below.
+
+```ruby
+class Foo
+  def bar
+    'This is Foo'
   end
 end
 
-user = User.new(1, 'Masafumi OKURA', 'masafumi@example.com')
-UserResource.new(user).serialize
-# => '{"user":{"id":1,"name":"Masafumi OKURA","name_with_email":"Masafumi OKURA: masafumi@example.com"}}'
-```
+class FooResource
+  include Alba::Resource
 
-The next major version of Alba will change this default behavior to prefer resource methods. In case you want to preserve current behavior, there's `prefer_object_method!` DSL, which does that.
+  prefer_object_method! # <- important
 
+  attributes :bar
+
+  # This is not called
+  def bar
+    'This is FooResource'
+  end
+end
+
+FooResource.new(Foo.new).serialize
+# => '{"bar":"This is Foo"}'
+```
+ 
 #### Params
 
 You can pass a Hash to the resource for internal use. It can be used as "flags" to control attribute content.
@@ -1449,6 +1457,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).
@@ -1555,6 +1565,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/docs/migrate_from_jbuilder.md

@@ -13,7 +13,7 @@ This guide is aimed at helping Jbuilder users transition to Alba, and it consist
 
 ## Example class
 
-This example will also be replaced by ActiveReord.
+This example will also be replaced by ActiveRecord.
 
 ```rb
 class User

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

@@ -26,7 +26,7 @@ module Alba
       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)
@@ -71,10 +71,11 @@ module Alba
 
       # 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?
@@ -96,12 +97,11 @@ module Alba
       private
 
       def _to_json(root_key, meta, options)
-        options.reject! { |k, _| %i[layout prefixes template status].include?(k) } # Rails specific guard
-        names = options.filter_map { |k, v| k unless v.nil? }
-        unless names.empty?
-          names.sort!
-          names.map! { |s| "\"#{s}\"" }
-          message = "You passed #{names.join(', ')} options but ignored. Please refer to the document: https://github.com/okuramasafumi/alba/blob/main/docs/rails.md"
+        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)
@@ -247,7 +247,7 @@ 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) }
                 else raise ::Alba::Error, "Unsupported type of attribute: #{attribute.class}"
                 end
@@ -317,7 +317,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

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '3.0.1'.freeze
+  VERSION = '3.0.3'.freeze
 end

data/lib/alba.rb

@@ -114,11 +114,14 @@ 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)
+      # rubocop-performance 1.20.2 might resolve this
+      # rubocop:disable Performance/StringIdentifierArgument
       begin
         const_parent.const_get("#{inflector.classify(name)}Resource")
       rescue NameError # Retry for serializer
         const_parent.const_get("#{inflector.classify(name)}Serializer")
       end
+      # rubocop:enable Performance/StringIdentifierArgument
     end
 
     # Configure Alba to symbolize keys

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.3
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-13 00:00:00.000000000 Z
+date: 2023-12-25 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.20
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Alba is the fastest JSON serializer for Ruby.