alba 0.11.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9adc72b171ef6c74c4198ddad4cc8f629c416c62c6b8d8a9698efdbe9dccc44
-  data.tar.gz: af33f05822bfee2bdfe455d4b7a9e75b0e2486c692297e24ab28768c0a839b24
+  metadata.gz: c3999a63b9564e6bf0a7b00dfeb64a19d6d076c94047f7ee869a4ac4a38c6646
+  data.tar.gz: dd7244bf63111e4795639a62dac91a744e51adb38f6a88d851c9cc6de3043dc0
 SHA512:
-  metadata.gz: 2b289f590bf7b4cc3682b13f7841e9408f61ba7d49c0521b05649fb658745cd76c91032f3c2ee83224a1407f17686dc01eb383d90219877ac6f077b05095ce4c
-  data.tar.gz: f842f9775b8355ed1b0dd88ea14aaecd57699fc578a11c38bf3a3d12ad04bbf01dbe0867bb30efc4cc73f1e7766d6e0e0e750741c6130dd33562434bfea6ba8b
+  metadata.gz: f93aaadf9b8fae4b9ae334f87647c3b0f1645147fd237b62f12451f4306f5cb6699ed25c935b563b68ab45c965bb1cfb8f2c73e08b23899a477384c37124d325
+  data.tar.gz: adb456a4796782e725bffa5720d1b5e6f831c1e0ec215721a814b331890f4a1d0ebe592e7e906239138729dd81586ad6e1c850ece61c5495ce829551feada9a1

data/.github/workflows/main.yml

@@ -0,0 +1,25 @@
+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, truffleruby]
+        exclude:
+          - os: windows-latest
+            ruby: truffleruby
+    runs-on: ${{ matrix.os }}
+    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

data/.gitignore

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

data/.rubocop.yml

@@ -6,21 +6,21 @@ inherit_gem:
 require:
   - rubocop-minitest
   - rubocop-performance
+  - rubocop-rake
 
 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:
   Enabled: false
 
-Layout/ClassStructure:
-  Enabled: true
-
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
@@ -37,13 +37,20 @@ Metrics/ClassLength:
 Metrics/MethodLength:
   Max: 15
 
+# Resource class includes DSLs, which tend to accept long list of parameters
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/alba/resource.rb'
+
 Style/ConstantVisibility:
-  Enabled: false
+  Exclude:
+    - 'lib/alba/version.rb'
 
 Style/Copyright:
   Enabled: false
 
-Style/DocumentationMethod:
+# I know what I do :)
+Style/DisableCopsWithinSourceCodeDirective:
   Enabled: false
 
 Style/FrozenStringLiteralComment:

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private
+--exclude lib/alba/version.rb

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 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.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

@@ -5,10 +5,13 @@ gemspec
 
 gem 'activesupport', require: false # For backend
 gem 'coveralls', require: false # For test coverage
-gem 'minitest', '~> 5.0' # For test
-gem 'oj', '~> 3.10', platform: :ruby, require: false # For backend
+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.1', require: false # For lint
-gem 'rubocop-performance', '~> 1.7.1', require: false # For lint
+gem 'rubocop-minitest', '~> 0.11.0', require: false # For lint
+gem 'rubocop-performance', '~> 1.10.1', 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 'ruby-prof', require: false # For performance profiling
+gem 'yard', require: false

data/README.md

@@ -2,26 +2,26 @@
 [![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)
 [![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.
 
-# Why yet another JSON serializer?
+## Why yet another JSON serializer?
 
 We know that there are several other JSON serializers for Ruby around, but none of them made us satisfied.
 
 Alba has some advantages over other JSON serializers which we've wanted to have.
 
-## Easy to understand
+### Easy to understand
 
 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.
 
-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!
+### Performance
 
-## Performance
-
-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).
 
 ## Installation
 
@@ -43,13 +43,41 @@ Or install it yourself as:
 
 Alba supports CRuby 2.5.7 and higher and latest TruffleRuby.
 
+## Documentation
+
+You can find the documentation on [RubyDoc](https://rubydoc.info/github/okuramasafumi/alba).
+
+## Features
+
+* Resource-based serialization
+* Arbitrary attribute definition
+* 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
+* Conditional attributes and associations
+* Selectable backend
+* Key transformation
+* Root key inference
+* Error handling
+* Resource name inflection based on association name
+* No runtime dependencies
+
+## Anti features
+
+* Sorting keys
+* Class level support of parameters
+* Supporting all existing JSON encoder/decoder
+* Cache
+* [JSON:API](https://jsonapi.org) support
+* And many others
+
 ## Usage
 
 ### Configuration
 
 Alba's configuration is fairly simple.
 
-#### Backend
+#### Backend configuration
 
 Backend is the actual part serializing an object into JSON. Alba supports these backends.
 
@@ -63,6 +91,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
@@ -80,6 +128,8 @@ end
 class UserResource
   include Alba::Resource
 
+  key :user
+
   attributes :id, :name
 
   attribute :name_with_email do |resource|
@@ -87,12 +137,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\"}"
@@ -129,7 +173,7 @@ class ArticleResource
   attributes :title
 end
 
-class UserResource1
+class UserResource
   include Alba::Resource
 
   attributes :id
@@ -143,7 +187,7 @@ user.articles << article1
 article2 = Article.new(2, 'Super nice', 'Really nice!')
 user.articles << article2
 
-UserResource1.new(user).serialize
+UserResource.new(user).serialize
 # => '{"id":1,"articles":[{"title":"Hello World!"},{"title":"Super nice"}]}'
 ```
 
@@ -152,7 +196,7 @@ UserResource1.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
@@ -161,7 +205,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
 
@@ -193,6 +237,209 @@ RestrictedFooResouce.new(foo).serialize
 end
 ```
 
+### 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.
+
+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
+```
+
 ## Comparison
 
 Alba is faster than alternatives.
@@ -210,18 +457,6 @@ Alba.backend = :active_support
 
 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`.
-
-`One` and `Many` are the special object fetching other resources and converting them into Hash.
-
-The main `Alba` module holds config values and one convenience method, `.serialize`.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.