alba 0.12.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee2f8d482fedb98083c2acab37b425c7ecedb429ab7bae7698b4eea7949635d9
-  data.tar.gz: 1a44f23d425072253ba6743e18c6da9d8fa81de448b58720848c4e9667b12bfb
+  metadata.gz: 36890dfa4b9b73b60f1d6a09cf674de7ff7a6dd495ff4b74bbb3d048f9cf5a85
+  data.tar.gz: 3e3d49619f646be866262e14e21e5fba11e2caafbc24064d57eb9c549cb64e4d
 SHA512:
-  metadata.gz: 9bf421fcd99f06cb56499ee31c88dda019e004c58a1880c03326f2a1ce395f7dc4b64be7cee012169c7039530194e85a312b3c53d964b1aaf5288cdf8cb78ae4
-  data.tar.gz: 02f20dd839f72f9d2c1859b48470595fff263939f41421e240d74452677edae2dc0569078823984144f630cbc2e6000b6ac3bd0d4161a9ef65bd95dbf311294f
+  metadata.gz: fc7e025a035b41dadaab5300096cf920eb3557a4be900d31b514dfc66e8ae803b0fb63d77ec06174d72d70ad2e07da81c491502c8462ad306f2379720222fc65
+  data.tar.gz: 741f5c1c69b2809aec51d2a2a139d4d8e00060c9aa174bf5fb68d5dbcec7996096aced5fb377d77fa147d7b6086a65191c8c764802c65bbd88d3806751ec0eb4

data/.github/workflows/main.yml

@@ -0,0 +1,34 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        ruby: [2.5, 2.6, 2.7, 3.0, head, jruby, truffleruby]
+        gemfile: [all, without_active_support, without_oj]
+        exclude:
+          - 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: gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+    - uses: actions/checkout@v2
+    - 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@v1
+      with:
+        files: ./coverage/coverage.xml

data/.gitignore

@@ -6,3 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+Gemfile.lock
+/gemfiles/*.lock

data/.rubocop.yml

@@ -12,8 +12,10 @@ AllCops:
   Exclude:
     - 'Rakefile'
     - 'alba.gemspec'
+    - 'benchmark/**/*.rb'
   NewCops: enable
   EnabledByDefault: true
+  TargetRubyVersion: 2.5
 
 # Oneline comment is not valid so until it gets valid, we disable it
 Bundler/GemComment:
@@ -28,13 +30,29 @@ Layout/MultilineAssignmentLayout:
 Lint/ConstantResolution:
   Enabled: false
 
-Metrics/ClassLength:
+# In test code we don't care about the metrics!
+Metrics:
   Exclude:
-    - 'test/alba_test.rb'
+    - 'test/**/*.rb'
 
 Metrics/MethodLength:
   Max: 15
 
+# `Resource` module is a core module and its length tends to be long...
+Metrics/ModuleLength:
+  Max: 150
+
+# Resource class includes DSLs, which tend to accept long list of parameters
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/alba/resource.rb'
+    - 'test/**/*.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'
@@ -42,6 +60,10 @@ Style/ConstantVisibility:
 Style/Copyright:
   Enabled: false
 
+# I know what I do :)
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 
@@ -50,3 +72,7 @@ Style/InlineComment:
 
 Style/MethodCallWithArgsParentheses:
   Enabled: false
+
+# There are so many cases we just want `if` expression!
+Style/MissingElse:
+  EnforcedStyle: case

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.1.0] - 2021-04-23
+
+- [Feat] Implement circular associations control [71e1543]
+- [Feat] Support :oj_rails backend [76e519e]
+
+## [1.0.1] - 2021-04-15
+
+- [Fix] Don't cache resource class for `Alba.serialize` [9ed5253]
+- [Improve] Warn when `ActiveSupport` or `Oj` are absent [d3ab3eb]
+- [Fix] Delete unreachable `to_hash` method on Association [1ba1f90]
+- [Fix] Stringify key before transforming [b4eb79e]
+- [Misc] Support Ruby 2.5.0 and above, not 2.5.7 and above [43f1d17]
+- [Fix] Remove accidentally added `p` debug [5d0324b]
+
+## [1.0.0] - 2021-04-07
+
+This is the first major release of Alba and it includes so many features. To see all the features you can have a look at [README](https://github.com/okuramasafumi/alba/blob/master/README.md#features).

data/Gemfile

@@ -4,13 +4,19 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'activesupport', require: false # For backend
-gem 'coveralls', require: false # For test coverage
+gem 'ffaker', require: false # For testing
 gem 'minitest', '~> 5.14' # For test
-gem 'oj', '~> 3.11', platform: :ruby, require: false # For backend
 gem 'rake', '~> 13.0' # For test and automation
 gem 'rubocop', '>= 0.79.0', require: false # For lint
-gem 'rubocop-minitest', '~> 0.10.3', require: false # For lint
-gem 'rubocop-performance', '~> 1.9.2', require: false # For lint
+gem 'rubocop-minitest', '~> 0.11.0', require: false # For lint
+gem 'rubocop-performance', '~> 1.11.0', require: false # For lint
 gem 'rubocop-rake', '>= 0.5.1', require: false # For lint
 gem 'rubocop-sensible', '~> 0.3.0', require: false # For lint
+gem 'simplecov', '~> 0.21.0', require: false # For test coverage
+gem 'simplecov-cobertura', require: false # For test coverage
 gem 'yard', require: false
+
+platforms :ruby do
+  gem 'oj', '~> 3.11', require: false # For backend
+  gem 'ruby-prof', require: false # For performance profiling
+end

data/README.md

@@ -1,29 +1,37 @@
 [![Gem Version](https://badge.fury.io/rb/alba.svg)](https://badge.fury.io/rb/alba)
-[![Build Status](https://travis-ci.com/okuramasafumi/alba.svg?branch=master)](https://travis-ci.com/okuramasafumi/alba)
-[![Coverage Status](https://coveralls.io/repos/github/okuramasafumi/alba/badge.svg?branch=master)](https://coveralls.io/github/okuramasafumi/alba?branch=master)
+[![CI](https://github.com/okuramasafumi/alba/actions/workflows/main.yml/badge.svg)](https://github.com/okuramasafumi/alba/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/okuramasafumi/alba/branch/master/graph/badge.svg?token=3D3HEZ5OXT)](https://codecov.io/gh/okuramasafumi/alba)
 [![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)
 
 # Alba
 
-`Alba` is the fastest JSON serializer for Ruby.
+Alba is the fastest JSON serializer for Ruby, JRuby, and TruffleRuby.
 
-## Why yet another JSON serializer?
+## Discussions
 
-We know that there are several other JSON serializers for Ruby around, but none of them made us satisfied.
+Alba uses [GitHub Discussions](https://github.com/okuramasafumi/alba/discussions) to openly discuss the project.
 
-Alba has some advantages over other JSON serializers which we've wanted to have.
+If you've already used Alba, please consider posting your thoughts and feelings on [Feedback](https://github.com/okuramasafumi/alba/discussions/categories/feedback). The fact that you enjoy using Alba gives me energy to keep developing Alba!
 
-### Easy to understand
+If you have feature requests or interesting ideas, join us with [Ideas](https://github.com/okuramasafumi/alba/discussions/categories/ideas). Let's make Alba even better, together!
 
-DSL is great. It makes the coding experience natural and intuitive. However, remembering lots of DSL requires us a lot of effort. Unfortunately, most of the existing libraries have implemented their features via DSL and it's not easy to understand how they behave entirely. Alba's core DSL are only four (`attributes`, `attribute`, `one` and `many`) so it's easy to understand how to use.
+## Why Alba?
 
-Alba is also understandable internally. The codebase is much smaller than the alternatives. In fact, it's less than 300 lines of code. Look at the code on [GitHub](https://github.com/okuramasafumi/alba/tree/master/lib) and you'll be surprised how simple it is!
+Because it's fast, flexible and well-maintained!
 
-### Performance
+### Fast
 
-Alba is faster than most of the alternatives. We have a [benchmark](https://gist.github.com/okuramasafumi/4e375525bd3a28e4ca812d2a3b3e5829).
+Alba is faster than most of the alternatives. We have a [benchmark](https://github.com/okuramasafumi/alba/tree/master/benchmark).
+
+### Flexible
+
+Alba provides a small set of DSL to define your serialization logic. It also provides methods you can override to alter and filter serialized hash so that you have full control over the result.
+
+### Maintained
+
+Alba is well-maintained and adds features quickly. [Coverage Status](https://coveralls.io/github/okuramasafumi/alba?branch=master) and [CodeClimate Maintainability](https://codeclimate.com/github/okuramasafumi/alba/maintainability) show the code base is quite healthy.
 
 ## Installation
 
@@ -43,11 +51,11 @@ Or install it yourself as:
 
 ## Supported Ruby versions
 
-Alba supports CRuby 2.5.7 and higher and latest TruffleRuby.
+Alba supports CRuby 2.5 and higher and latest JRuby and TruffleRuby.
 
 ## Documentation
 
-You can find the documentation on [RubyDoc](https://rubydoc.info/gems/alba).
+You can find the documentation on [RubyDoc](https://rubydoc.info/github/okuramasafumi/alba).
 
 ## Features
 
@@ -56,9 +64,13 @@ You can find the documentation on [RubyDoc](https://rubydoc.info/gems/alba).
 * One and many association with the ability to define them inline
 * Adding condition and filter to association
 * Parameters can be injected and used in attributes and associations
-* Setting root key separately in Serializer
-* Adding metadata
+* Conditional attributes and associations
 * Selectable backend
+* Key transformation
+* Root key inference
+* Error handling
+* Resource name inflection based on association name
+* Circular associations control
 * No runtime dependencies
 
 ## Anti features
@@ -68,7 +80,6 @@ You can find the documentation on [RubyDoc](https://rubydoc.info/gems/alba).
 * Supporting all existing JSON encoder/decoder
 * Cache
 * [JSON:API](https://jsonapi.org) support
-* Association name inflection
 * And many others
 
 ## Usage
@@ -77,7 +88,7 @@ You can find the documentation on [RubyDoc](https://rubydoc.info/gems/alba).
 
 Alba's configuration is fairly simple.
 
-#### Backend
+#### Backend configuration
 
 Backend is the actual part serializing an object into JSON. Alba supports these backends.
 
@@ -91,6 +102,26 @@ You can set a backend like this:
 Alba.backend = :oj
 ```
 
+#### Inference configuration
+
+You can enable inference feature using `enable_inference!` method.
+
+```ruby
+Alba.enable_inference!
+```
+
+You must install `ActiveSupport` to enable inference.
+
+#### Error handling configuration
+
+You can configure error handling with `on_error` method.
+
+```ruby
+Alba.on_error :ignore
+```
+
+For the details, see [Error handling section](#error-handling)
+
 ### Simple serialization with key
 
 ```ruby
@@ -108,6 +139,8 @@ end
 class UserResource
   include Alba::Resource
 
+  key :user
+
   attributes :id, :name
 
   attribute :name_with_email do |resource|
@@ -115,12 +148,6 @@ class UserResource
   end
 end
 
-class SerializerWithKey
-  include Alba::Serializer
-
-  set key: :user
-end
-
 user = User.new(1, 'Masafumi OKURA', 'masafumi@example.com')
 UserResource.new(user).serialize
 # => "{\"id\":1,\"name\":\"Masafumi OKURA\",\"name_with_email\":\"Masafumi OKURA: masafumi@example.com\"}"
@@ -180,7 +207,7 @@ UserResource.new(user).serialize
 `Alba.serialize` method is a shortcut to define everything inline.
 
 ```ruby
-Alba.serialize(user, with: proc { set key: :foo }) do
+Alba.serialize(user, key: :foo) do
   attributes :id
   many :articles do
     attributes :title, :body
@@ -189,7 +216,7 @@ end
 # => '{"foo":{"id":1,"articles":[{"title":"Hello World!","body":"Hello World!!!"},{"title":"Super nice","body":"Really nice!"}]}}'
 ```
 
-Although this might be useful sometimes, it's generally recommended to define a class for both Resource and Serializer.
+Although this might be useful sometimes, it's generally recommended to define a class for Resource.
 
 ### Inheritance and Ignorance
 
@@ -221,10 +248,218 @@ RestrictedFooResouce.new(foo).serialize
 end
 ```
 
-## Comparison
+### Attribute key transformation
+
+** Note: You need to install `active_support` gem to use `transform_keys` DSL.
+
+With `active_support` installed, you can transform attribute keys.
+
+```ruby
+class User
+  attr_reader :id, :first_name, :last_name
+
+  def initialize(id, first_name, last_name)
+    @id = id
+    @first_name = first_name
+    @last_name = last_name
+  end
+end
+
+class UserResource
+  include Alba::Resource
+
+  attributes :id, :first_name, :last_name
+
+  transform_keys :lower_camel
+end
+
+user = User.new(1, 'Masafumi', 'Okura')
+UserResourceCamel.new(user).serialize
+# => '{"id":1,"firstName":"Masafumi","lastName":"Okura"}'
+```
+
+Supported transformation types are :camel, :lower_camel and :dash.
+
+### Filtering attributes
+
+You can filter attributes by overriding `Alba::Resource#converter` method, but it's a bit tricky.
+
+```ruby
+class User
+  attr_accessor :id, :name, :email, :created_at, :updated_at
+
+  def initialize(id, name, email)
+    @id = id
+    @name = name
+    @email = email
+  end
+end
+
+class UserResource
+  include Alba::Resource
+
+  attributes :id, :name, :email
+
+  private
+
+  # Here using `Proc#>>` method to compose a proc from `super`
+  def converter
+    super >> proc { |hash| hash.compact }
+  end
+end
+
+user = User.new(1, nil, nil)
+UserResource.new(user).serialize # => '{"id":1}'
+```
+
+The key part is the use of `Proc#>>` since `Alba::Resource#converter` returns a `Proc` which contains the basic logic and it's impossible to change its behavior by just overriding the method.
 
-Alba is faster than alternatives.
-For a performance benchmark, see https://gist.github.com/okuramasafumi/4e375525bd3a28e4ca812d2a3b3e5829.
+It's not recommended to swap the whole conversion logic. It's recommended to always call `super` when you override `converter`.
+
+### Conditional attributes
+
+Filtering attributes with overriding `convert` works well for simple cases. However, It's cumbersome when we want to filter various attributes based on different conditions for keys.
+
+In these cases, conditional attributes works well. We can pass `if` option to `attributes`, `attribute`, `one` and `many`. Below is an example for the same effect as [filtering attributes section](#filtering-attributes).
+
+```ruby
+class User
+  attr_accessor :id, :name, :email, :created_at, :updated_at
+
+  def initialize(id, name, email)
+    @id = id
+    @name = name
+    @email = email
+  end
+end
+
+class UserResource
+  include Alba::Resource
+
+  attributes :id, :name, :email, if: proc { |user, attribute| !attribute.nil? }
+end
+
+user = User.new(1, nil, nil)
+UserResource.new(user).serialize # => '{"id":1}'
+```
+
+### Inference
+
+After `Alba.enable_inference!` called, Alba tries to infer root key and association resource name.
+
+```ruby
+Alba.enable_inference!
+
+class User
+  attr_reader :id
+  attr_accessor :articles
+
+  def initialize(id)
+    @id = id
+    @articles = []
+  end
+end
+
+class Article
+  attr_accessor :id, :title
+
+  def initialize(id, title)
+    @id = id
+    @title = title
+  end
+end
+
+class ArticleResource
+  include Alba::Resource
+
+  attributes :title
+end
+
+class UserResource
+  include Alba::Resource
+
+  key!
+
+  attributes :id
+
+  many :articles
+end
+
+user = User.new(1)
+user.articles << Article.new(1, 'The title')
+
+UserResource.new(user).serialize # => '{"user":{"id":1,"articles":[{"title":"The title"}]}}'
+UserResource.new([user]).serialize # => '{"users":[{"id":1,"articles":[{"title":"The title"}]}]}'
+```
+
+This resource automatically sets its root key to either "users" or "user", depending on the given object is collection or not.
+
+Also, you don't have to specify which resource class to use with `many`. Alba infers it from association name.
+
+Note that to enable this feature you must install `ActiveSupport` gem.
+
+### Error handling
+
+You can set error handler globally or per resource using `on_error`.
+
+```ruby
+class User
+  attr_accessor :id, :name
+
+  def initialize(id, name, email)
+    @id = id
+    @name = name
+    @email = email
+  end
+
+  def email
+    raise RuntimeError, 'Error!'
+  end
+end
+
+class UserResource
+  include Alba::Resource
+
+  attributes :id, :name, :email
+
+  on_error :ignore
+end
+
+user = User.new(1, 'Test', 'email@example.com')
+UserResource.new(user).serialize # => '{"id":1,"name":"Test"}'
+```
+
+This way you can exclude an entry when fetching an attribute gives an exception.
+
+There are four possible arguments `on_error` method accepts.
+
+* `:raise` re-raises an error. This is the default behavior.
+* `:ignore` ignores the entry with the error.
+* `:nullify` sets the attribute with the error to `nil`.
+* Block gives you more control over what to be returned.
+
+The block receives five arguments, `error`, `object`, `key`, `attribute` and `resource class` and must return a two-element array. Below is an example.
+
+```ruby
+# Global error handling
+Alba.on_error do |error, object, key, attribute, resource_class|
+  if resource_class == MyResource
+    ['error_fallback', object.error_fallback]
+  else
+    [key, error.message]
+  end
+end
+```
+
+### Circular associations control
+
+You can control circular associations with `within` option. `within` option is a nested Hash such as `{book: {authors: books}}`. In this example, Alba serializes a book's authors' books. This means you can reference `BookResource` from `AuthorResource` and vice versa. This is really powerful when you have a complex data structure and serialize certain parts of it.
+
+For more details, please refer to [test code](https://github.com/okuramasafumi/alba/blob/master/test/usecases/circular_association_test.rb)
+
+### 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).
 
 ## Rails
 
@@ -232,23 +467,20 @@ When you use Alba in Rails, you can create an initializer file with the line bel
 
 ```ruby
 Alba.backend = :active_support
+# or
+Alba.backend = :oj_rails
 ```
 
 ## Why named "Alba"?
 
 The name "Alba" comes from "albatross", a kind of birds. In Japanese, this bird is called "Aho-dori", which means "stupid bird". I find it funny because in fact albatrosses fly really fast. I hope Alba looks stupid but in fact it does its job quick.
 
-## Alba internals
-
-Alba has three component, `Serializer`, `Resource` and `Value` (`Value` is conceptual and not implemented directly).
-
-`Serializer` is a component responsible for rendering JSON output with `Resource`. `Serializer` can add more data to `Resource` such as `metadata`. Users can define one single `Serializer` and reuse it for all `Resource`s. The main interface is `#serialize`.
-
-`Resource` is a component responsible for defining how an object (or a collection of objects) is converted into JSON. The difference between `Serializer` and `Resource` is that while `Serializer` can add arbitrary data into JSON, `Resource` can get data only from the object under it. The main interface is `#serializable_hash`.
+## Pioneers
 
-`One` and `Many` are the special object fetching other resources and converting them into Hash.
+There are great pioneers in Ruby's ecosystem which does basically the same thing as Alba does. To name a few:
 
-The main `Alba` module holds config values and one convenience method, `.serialize`.
+* [ActiveModelSerializers](https://github.com/rails-api/active_model_serializers) a.k.a AMS, the most famous implementation of JSON serializer for Ruby
+* [Blueprinter](https://github.com/procore/blueprinter) shares some concepts with Alba
 
 ## Development