alba 1.0.0 → 1.4.0

data/lib/alba/typed_attribute.rb

@@ -0,0 +1,61 @@
+module Alba
+  # Representing typed attributes to encapsulate logic about types
+  class TypedAttribute
+    # @param name [Symbol, String]
+    # @param type [Symbol, Class]
+    # @param converter [Proc]
+    def initialize(name:, type:, converter:)
+      @name = name
+      @type = type
+      @converter = case converter
+                   when true then default_converter
+                   when false, nil then null_converter
+                   else converter
+                   end
+    end
+
+    # @param object [Object] target to check and convert type with
+    # @return [String, Integer, Boolean] type-checked or type-converted object
+    def value(object)
+      value, result = check(object)
+      result ? value : @converter.call(value)
+    rescue TypeError
+      raise TypeError, "Attribute #{@name} is expected to be #{@type} but actually #{display_value_for(value)}."
+    end
+
+    private
+
+    def check(object)
+      value = object.public_send(@name)
+      type_correct = case @type
+                     when :String, ->(klass) { klass == String } then value.is_a?(String)
+                     when :Integer, ->(klass) { klass == Integer } then value.is_a?(Integer)
+                     when :Boolean then [true, false].include?(value)
+                     else
+                       raise Alba::UnsupportedType, "Unknown type: #{@type}"
+                     end
+      [value, type_correct]
+    end
+
+    def default_converter
+      case @type
+      when :String, ->(klass) { klass == String }
+        ->(object) { object.to_s }
+      when :Integer, ->(klass) { klass == Integer }
+        ->(object) { Integer(object) }
+      when :Boolean
+        ->(object) { !!object }
+      else
+        raise Alba::UnsupportedType, "Unknown type: #{@type}"
+      end
+    end
+
+    def null_converter
+      ->(_) { raise TypeError }
+    end
+
+    def display_value_for(value)
+      value.nil? ? 'nil' : value.class.name
+    end
+  end
+end

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.4.0'.freeze
 end

data/script/perf_check.rb

@@ -0,0 +1,174 @@
+# Benchmark script to run varieties of JSON serializers
+# Fetch Alba from local, otherwise fetch latest from RubyGems
+# exit(status)
+
+# --- Bundle dependencies ---
+
+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 "alba", path: '../'
+  gem "benchmark-ips"
+  gem "blueprinter"
+  gem "jbuilder"
+  gem "multi_json"
+  gem "oj"
+  gem "sqlite3"
+end
+
+# --- Test data model setup ---
+
+require "active_record"
+require "oj"
+require "sqlite3"
+Oj.optimize_rails
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+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
+
+# --- Alba serializers ---
+
+require "alba"
+
+class AlbaCommentResource
+  include ::Alba::Resource
+  attributes :id, :body
+end
+
+class AlbaPostResource
+  include ::Alba::Resource
+  attributes :id, :body
+  attribute :commenter_names do |post|
+    post.commenters.pluck(:name)
+  end
+  many :comments, resource: AlbaCommentResource
+end
+
+# --- Blueprint serializers ---
+
+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
+
+# --- JBuilder serializers ---
+
+require "jbuilder"
+
+class Post
+  def to_builder
+    Jbuilder.new do |post|
+      post.call(self, :id, :body, :commenter_names, :comments)
+    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
+
+# --- Test data creation ---
+
+100.times do |i|
+  post = Post.create!(body: "post#{i}")
+  user1 = User.create!(name: "John#{i}")
+  user2 = User.create!(name: "Jane#{i}")
+  10.times do |n|
+    post.comments.create!(commenter: user1, body: "Comment1_#{i}_#{n}")
+    post.comments.create!(commenter: user2, body: "Comment2_#{i}_#{n}")
+  end
+end
+
+posts = Post.all.to_a
+
+# --- Store the serializers in procs ---
+
+alba = Proc.new { AlbaPostResource.new(posts).serialize }
+blueprinter = Proc.new { PostBlueprint.render(posts) }
+jbuilder = Proc.new do
+  Jbuilder.new do |json|
+    json.array!(posts) do |post|
+      json.post post.to_builder
+    end
+  end.target!
+end
+
+# --- Run the benchmarks ---
+
+require 'benchmark/ips'
+result = Benchmark.ips do |x|
+  x.report(:alba, &alba)
+  x.report(:blueprinter, &blueprinter)
+  x.report(:jbuilder, &jbuilder)
+end
+
+entries = result.entries.map {|entry| [entry.label, entry.iterations]}
+alba_ips = entries.find {|e| e.first == :alba }.last
+blueprinter_ips = entries.find {|e| e.first == :blueprinter }.last
+jbuidler_ips = entries.find {|e| e.first == :jbuilder }.last
+# Alba should be as fast as jbuilder and faster than blueprinter
+alba_is_fast_enough = (alba_ips - jbuidler_ips) > -10.0 && (alba_ips - blueprinter_ips) > 10.0
+exit(alba_is_fast_enough)

data/sider.yml

@@ -49,10 +49,8 @@ linter:
 #     norc: true
 
 # # https://help.sider.review/getting-started/custom-configuration#ignore
-# ignore:
-#   - "*.pdf"
-#   - "*.mp4"
-#   - "images/**"
+ignore:
+  - 'test/**/*'
 
 # # https://help.sider.review/getting-started/custom-configuration#branchesexclude
 # branches:

metadata

@@ -1,25 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-07 00:00:00.000000000 Z
+date: 2021-06-30 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
-  do similar things. The internal is so simple that it's easy to hack and maintain.
+description: Alba is the fastest JSON serializer for Ruby. It focuses on performance,
+  flexibility and usability.
 email:
 - masafumi.o1988@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/dependabot.yml"
 - ".github/workflows/main.yml"
+- ".github/workflows/perf.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".yardopts"
@@ -29,17 +32,26 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - alba.gemspec
-- benchmark/local.rb
+- benchmark/collection.rb
+- benchmark/single_resource.rb
 - bin/console
 - bin/setup
+- codecov.yml
+- gemfiles/all.gemfile
+- gemfiles/without_active_support.gemfile
+- gemfiles/without_oj.gemfile
 - lib/alba.rb
 - lib/alba/association.rb
-- lib/alba/key_transformer.rb
+- lib/alba/default_inflector.rb
+- lib/alba/key_transform_factory.rb
 - lib/alba/many.rb
 - lib/alba/one.rb
 - lib/alba/resource.rb
+- lib/alba/typed_attribute.rb
 - lib/alba/version.rb
+- script/perf_check.rb
 - sider.yml
 homepage: https://github.com/okuramasafumi/alba
 licenses:
@@ -47,7 +59,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/okuramasafumi/alba
   source_code_uri: https://github.com/okuramasafumi/alba
-  changelog_uri: https://github.com/okuramasafumi/alba/CHANGELOG.md
+  changelog_uri: https://github.com/okuramasafumi/alba/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -56,14 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.7
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: Alba is the fastest JSON serializer for Ruby.

data/benchmark/local.rb

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