alba 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d76423c125b10f3a012066e6df3924c1dde50c1842e78be87179d99da8707a9e
-  data.tar.gz: 23bba5622260ac6926a669b1d4d4aa44e6a4189838b2c77b23f6e846c56ea14f
+  metadata.gz: 0f7b454e9de7d518fe1287a46d1b14a0c8cb8d13e3b10fcce3eee8a9e3df05c9
+  data.tar.gz: ab670cee9399503a4480f74b4533a40eb4fd67048a0b9c93b9f706712ecc1a8f
 SHA512:
-  metadata.gz: d57037b9ea77550953a6e8dc4f6896e314ce1e63e36925ec960ebca1e2cce043f61a289091f09c74ef308de50d541e2b2624ce977dcf613165175328c546b32c
-  data.tar.gz: 21ab608e1844f3a575985927f81ed892f1cb50c8bf9008302c4572d1acc9c9bebbc66c1afce173af29a22b03f67a6e0b117197d037ae64061401e5a19d1779e6
+  metadata.gz: 758481e888e55ae7a1ac87d61060cdbe76f3effea46e59b0906a125c4d804ef54f337aee014cba3df35fbd819601ad66c84eaafb820fd1a1144842a48969125a
+  data.tar.gz: 5960c6958060c3169152c4634aaecd34af1a0920b7cb6461c9652e690e6fed661275efea1a6988513be0e7142eec6e13fe3a6f61658af68a70fc25ad04eaf430

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,8 +6,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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
+
+- Fixed a bug where methods such as `test` or `params` cannot be used as attribute name [#344](https://github.com/okuramasafumi/alba/pull/344)
+- Remove redundant code
+
 ## [3.0.0] 2023-10-11
 
+### IMPORTANT
+
+**This release contains an important bug fix that can cause data corruption.**
+**If you're using Ruby 3, it's highly recommended to upgrade to [v3.0.0](https://rubygems.org/gems/alba/versions/3.0.0)**
+**If you're using Ruby 2, please upgrade to [v2.4.2](https://rubygems.org/gems/alba/versions/2.4.2) that contains bug fix only as soon as possible.**
+
 ### Added
 
 - Custom type [#333](https://github.com/okuramasafumi/alba/pull/333)

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,11 +6,22 @@
 [![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
 
 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).
+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.~~
+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
 
 Alba allows you to do something like below.
@@ -281,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
+
+  prefer_object_method! # <- important
 
-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.
+  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.

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/association.rb

@@ -57,7 +57,6 @@ module Alba
       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

data/lib/alba/conditional_attribute.rb

@@ -51,6 +51,8 @@ module Alba
 
     # 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
+    # rubocop:disable Style/OpenStructUse
+    # rubocop:disable Performance/OpenStruct
     def objectize(fetched_attribute)
       return fetched_attribute unless @body.is_a?(Alba::Association)
 
@@ -62,5 +64,7 @@ module Alba
         OpenStruct.new(fetched_attribute)
       end
     end
+    # rubocop:enable Style/OpenStructUse
+    # rubocop:enable Performance/OpenStruct
   end
 end

data/lib/alba/resource.rb

@@ -12,7 +12,7 @@ module Alba
   module Resource
     # @!parse include InstanceMethods
     # @!parse extend ClassMethods
-    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
+    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, _resource_methods: []}.freeze # rubocop:disable Layout/LineLength
     private_constant :INTERNAL_VARIABLES
 
     WITHIN_DEFAULT = Object.new.freeze
@@ -96,12 +96,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)
@@ -265,9 +264,15 @@ module Alba
       end
 
       def _fetch_attribute_from_resource_first(obj, attribute)
-        __send__(attribute, obj)
-      rescue NoMethodError
-        obj.__send__(attribute)
+        if @_resource_methods.include?(attribute)
+          begin
+            __send__(attribute, obj)
+          rescue NoMethodError
+            obj.__send__(attribute)
+          end
+        else
+          obj.__send__(attribute)
+        end
       end
 
       def nil_handler
@@ -302,6 +307,12 @@ module Alba
     module ClassMethods
       attr_reader(*INTERNAL_VARIABLES.keys)
 
+      # This `method_added` is used for defining "resource methods"
+      def method_added(method_name)
+        _resource_methods << method_name.to_sym unless method_name.to_sym == :_setup
+        super
+      end
+
       # @private
       def inherited(subclass)
         super

data/lib/alba/version.rb

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

metadata

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