alba 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4a5b866825838f457bb17c0c1037f68c3e88a9b96c86dd9e0c456d101f69158
-  data.tar.gz: d1f451fff558385b3ae4610355a3abb9aced052ce138eff9913169a12c8a23c6
+  metadata.gz: 993f4b887c19f4e1149ddb850cd07a8cb8c2042cde0fb3974b1380537707a55d
+  data.tar.gz: acf77a0aa35f7fe23fc3f98843064d2800e0b4e0739e587dd29aab65f06269ad
 SHA512:
-  metadata.gz: 71fdab1911c6fc9e1ba88e8cbdc553311b99aecd975462b05958e5be1e491aa10734b6b6f6f15f24ae98c8ab5a1b1021d6c544a172befcedd23ca80283529e98
-  data.tar.gz: 05f06f2e7f3ec93e0a616bec6e3d71a90590b68c7ce397050bb9c019d2bbf206b070ed1cf44603cd301fa5dd2634df50c4e08b75a8c478b2f0063b6551b5bdcc
+  metadata.gz: 9b8e52dcaf4ca33cba0685c2a0a06c16df69cd04b6d399c092e920548f5baa6a21aeab8097f90e92ab35ac9c260d83858c19462a9ec2a689d97c6999daef5e3a
+  data.tar.gz: e525a66c30477cab6741436128398a6f0309a0f786040fe946a9f2783d08f619df00d85157d04c5876cc579e19cceabf22dcb3556addf6ad061d44d1f0cfa888

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/.rubocop.yml

@@ -12,6 +12,7 @@ AllCops:
   Exclude:
     - 'Rakefile'
     - 'alba.gemspec'
+    - 'benchmark/**/*.rb'
   NewCops: enable
   EnabledByDefault: true
 

data/Gemfile

@@ -10,7 +10,7 @@ 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-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 'yard', require: false

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    alba (0.13.0)
+    alba (0.13.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.1)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    ast (2.4.1)
-    concurrent-ruby (1.1.7)
+    ast (2.4.2)
+    concurrent-ruby (1.1.8)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -21,19 +21,19 @@ GEM
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
     docile (1.3.2)
-    i18n (1.8.7)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     json (2.3.1)
     minitest (5.14.3)
-    oj (3.11.0)
+    oj (3.11.2)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
+    regexp_parser (2.1.1)
     rexml (3.2.4)
-    rubocop (1.8.1)
+    rubocop (1.11.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -42,11 +42,11 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     rubocop-minitest (0.10.3)
       rubocop (>= 0.87, < 2.0)
-    rubocop-performance (1.9.2)
+    rubocop-performance (1.10.1)
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.5.1)
@@ -83,7 +83,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rubocop (>= 0.79.0)
   rubocop-minitest (~> 0.10.3)
-  rubocop-performance (~> 1.9.2)
+  rubocop-performance (~> 1.10.1)
   rubocop-rake (>= 0.5.1)
   rubocop-sensible (~> 0.3.0)
   yard

data/README.md

@@ -19,11 +19,11 @@ Alba has some advantages over other JSON serializers which we've wanted to have.
 
 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!
+Alba is also understandable internally. The codebase is much smaller than the alternatives. In fact, it's about 330 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
 
-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
 
@@ -47,7 +47,7 @@ Alba supports CRuby 2.5.7 and higher and latest 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
 
@@ -59,6 +59,7 @@ You can find the documentation on [RubyDoc](https://rubydoc.info/gems/alba).
 * Setting root key separately in Serializer
 * Adding metadata
 * Selectable backend
+* Key transformation
 * No runtime dependencies
 
 ## Anti features
@@ -253,6 +254,44 @@ UserResourceCamel.new(user).serialize
 
 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`.
+
 ## Comparison
 
 Alba is faster than alternatives.

data/benchmark/local.rb

@@ -0,0 +1,198 @@
+# Benchmark script to run varieties of JSON serializers
+# Fetch Alba from local, otherwise fetch latest from RubyGems
+
+require "bundler/inline"
+
+gemfile(true) do
+  source "https://rubygems.org"
+
+  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+  gem "activerecord", "6.1.3"
+  gem "sqlite3"
+  gem "jbuilder"
+  gem "active_model_serializers"
+  gem "blueprinter"
+  gem "representable"
+  gem "alba", path: '../'
+  gem "oj"
+  gem "multi_json"
+end
+
+require "active_record"
+require "sqlite3"
+require "logger"
+require "oj"
+Oj.optimize_rails
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+# ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+ActiveRecord::Schema.define do
+  create_table :posts, force: true do |t|
+    t.string :body
+  end
+
+  create_table :comments, force: true do |t|
+    t.integer :post_id
+    t.string :body
+    t.integer :commenter_id
+  end
+
+  create_table :users, force: true do |t|
+    t.string :name
+  end
+end
+
+class Post < ActiveRecord::Base
+  has_many :comments
+  has_many :commenters, through: :comments, class_name: 'User', source: :commenter
+
+  def attributes
+    {id: nil, body: nil, commenter_names: commenter_names}
+  end
+
+  def commenter_names
+    commenters.pluck(:name)
+  end
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+  belongs_to :commenter, class_name: 'User'
+
+  def attributes
+    {id: nil, body: nil}
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :comments
+end
+
+require "alba"
+Alba.backend = :oj
+
+class AlbaCommentResource
+  include ::Alba::Resource
+  attributes :id, :body
+end
+
+class AlbaPostResource
+  include ::Alba::Resource
+  attributes :id, :body
+  many :comments, resource: AlbaCommentResource
+  attribute :commenter_names do |post|
+    post.commenters.pluck(:name)
+  end
+end
+
+require "jbuilder"
+class Post
+  def to_builder
+    Jbuilder.new do |post|
+      post.call(self, :id, :body, :comments, :commenter_names)
+    end
+  end
+
+  def commenter_names
+    commenters.pluck(:name)
+  end
+end
+
+class Comment
+  def to_builder
+    Jbuilder.new do |comment|
+      comment.call(self, :id, :body)
+    end
+  end
+end
+
+require "active_model_serializers"
+
+class AMSCommentSerializer < ActiveModel::Serializer
+  attributes :id, :body
+end
+
+class AMSPostSerializer < ActiveModel::Serializer
+  attributes :id, :body
+  has_many :comments, serializer: AMSCommentSerializer
+  attribute :commenter_names
+  def commenter_names
+    object.commenters.pluck(:name)
+  end
+end
+
+require "blueprinter"
+
+class CommentBlueprint < Blueprinter::Base
+  fields :id, :body
+end
+
+class PostBlueprint < Blueprinter::Base
+  fields :id, :body, :commenter_names
+  association :comments, blueprint: CommentBlueprint
+  def commenter_names
+    commenters.pluck(:name)
+  end
+end
+
+require "representable"
+
+class CommentRepresenter < Representable::Decorator
+  include Representable::JSON
+
+  property :id
+  property :body
+end
+
+class PostRepresenter < Representable::Decorator
+  include Representable::JSON
+
+  property :id
+  property :body
+  property :commenter_names
+  collection :comments
+
+  def commenter_names
+    commenters.pluck(:name)
+  end
+end
+
+post = Post.create!(body: 'post')
+user1 = User.create!(name: 'John')
+user2 = User.create!(name: 'Jane')
+post.comments.create!(commenter: user1, body: 'Comment1')
+post.comments.create!(commenter: user2, body: 'Comment2')
+post.reload
+
+alba = Proc.new { AlbaPostResource.new(post).serialize }
+jbuilder = Proc.new { post.to_builder.target! }
+ams = Proc.new { AMSPostSerializer.new(post, {}).to_json }
+rails = Proc.new { ActiveSupport::JSON.encode(post.serializable_hash(include: :comments)) }
+blueprinter = Proc.new { PostBlueprint.render(post) }
+representable = Proc.new { PostRepresenter.new(post).to_json }
+alba_inline = Proc.new do
+  Alba.serialize(post) do
+    attributes :id, :body
+    attribute :commenter_names do |post|
+      post.commenters.pluck(:name)
+    end
+    many :comments do
+      attributes :id, :body
+    end
+  end
+end
+[alba, jbuilder, ams, rails, blueprinter, representable, alba_inline].each {|x| puts x.call }
+
+require 'benchmark'
+time = 1000
+Benchmark.bmbm do |x|
+  x.report(:alba) { time.times(&alba) }
+  x.report(:jbuilder) { time.times(&jbuilder) }
+  x.report(:ams) { time.times(&ams) }
+  x.report(:rails) { time.times(&rails) }
+  x.report(:blueprinter) { time.times(&blueprinter) }
+  x.report(:representable) { time.times(&representable) }
+  x.report(:alba_inline) { time.times(&alba_inline) }
+end

data/lib/alba/key_transformer.rb

@@ -24,7 +24,7 @@ module Alba
       when :dash
         ActiveSupport::Inflector.dasherize(key)
       else
-        raise ::Alba::Error, "Unknown transform_type: #{transform_type}. Supported transform_type are :camel and :dash."
+        raise ::Alba::Error, "Unknown transform_type: #{transform_type}. Supported transform_type are :camel, :lower_camel and :dash."
       end
     end
   end

data/lib/alba/many.rb

@@ -11,6 +11,8 @@ module Alba
     def to_hash(target, params: {})
       objects = target.public_send(@name)
       objects = @condition.call(objects, params) if @condition
+      return if objects.nil?
+
       objects.map { |o| @resource.new(o, params: params).to_hash }
     end
   end

data/lib/alba/one.rb

@@ -11,6 +11,8 @@ module Alba
     def to_hash(target, params: {})
       object = target.public_send(@name)
       object = @condition.call(object, params) if @condition
+      return if object.nil?
+
       @resource.new(object, params: params).to_hash
     end
   end

data/lib/alba/resource.rb

@@ -196,7 +196,7 @@ module Alba
 
       # Transform keys as specified type
       #
-      # @params type [String, Symbol]
+      # @param type [String, Symbol]
       def transform_keys(type)
         @_transform_keys = type.to_sym
       end

data/lib/alba/serializer.rb

@@ -7,10 +7,8 @@ module Alba
     # @private
     def self.included(base)
       super
-      base.class_eval do
-        @_opts = {} unless instance_variable_defined?('@_opts')
-        @_metadata = {} unless instance_variable_defined?('@_metadata')
-      end
+      base.instance_variable_set('@_opts', {}) unless base.instance_variable_defined?('@_opts')
+      base.instance_variable_set('@_metadata', {}) unless base.instance_variable_defined?('@_metadata')
       base.include InstanceMethods
       base.extend ClassMethods
     end

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.13.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies: []
 description: Alba is designed to be a simple, easy to use and fast alternative to
   existing JSON serializers. Its performance is better than almost all gems which
@@ -19,9 +19,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -30,6 +30,7 @@ files:
 - README.md
 - Rakefile
 - alba.gemspec
+- benchmark/local.rb
 - bin/console
 - bin/setup
 - lib/alba.rb
@@ -63,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.11
 signing_key:
 specification_version: 4
 summary: Alba is the fastest JSON serializer for Ruby.

data/.travis.yml

@@ -1,10 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-  # - ruby-head # oj doesn't work with Ruby 2.8.0
-  - truffleruby
-before_install: gem install bundler -v 2.1.4