alba 0.11.1 → 1.0.1

data/Rakefile

@@ -1,10 +1,13 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+ENV["BUNDLE_GEMFILE"] = File.expand_path("gemfiles/all.gemfile") if ENV["BUNDLE_GEMFILE"] == File.expand_path("Gemfile") || ENV["BUNDLE_GEMFILE"].empty? || ENV["BUNDLE_GEMFILE"].nil?
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  file_list = ENV["BUNDLE_GEMFILE"] == File.expand_path("gemfiles/all.gemfile") ? FileList["test/**/*_test.rb"] : FileList["test/dependencies/test_dependencies.rb"]
+  t.test_files = file_list
 end
 
 task :default => :test

data/alba.gemspec

@@ -10,11 +10,11 @@ Gem::Specification.new do |spec|
   spec.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."
   spec.homepage      = 'https://github.com/okuramasafumi/alba'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.7')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/okuramasafumi/alba'
-  spec.metadata['changelog_uri'] = 'https://github.com/okuramasafumi/alba/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/okuramasafumi/alba/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

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/gemfiles/all.gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'activesupport', require: false # For backend
+gem 'minitest', '~> 5.14' # For test
+gem 'rake', '~> 13.0' # For test and automation
+gem 'rubocop', '>= 0.79.0', 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 '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/gemfiles/without_active_support.gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gem 'minitest', '~> 5.14' # For test
+gem 'rake', '~> 13.0' # For test and automation
+gem 'rubocop', '>= 0.79.0', 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 '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/gemfiles/without_oj.gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gem 'activesupport', require: false # For backend
+gem 'minitest', '~> 5.14' # For test
+gem 'rake', '~> 13.0' # For test and automation
+gem 'rubocop', '>= 0.79.0', 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 '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 'ruby-prof', require: false # For performance profiling
+end

data/lib/alba.rb

@@ -1,17 +1,16 @@
 require_relative 'alba/version'
-require_relative 'alba/serializer'
 require_relative 'alba/resource'
 
 # Core module
 module Alba
   # Base class for Errors
   class Error < StandardError; end
+
   # Error class for backend which is not supported
   class UnsupportedBackend < Error; end
 
   class << self
-    attr_reader :backend, :encoder
-    attr_accessor :default_serializer
+    attr_reader :backend, :encoder, :inferring, :_on_error
 
     # Set the backend, which actually serializes object into JSON
     #
@@ -27,17 +26,44 @@ module Alba
     # Serialize the object with inline definitions
     #
     # @param object [Object] the object to be serialized
-    # @param with [nil, Proc, Alba::Serializer] selializer
+    # @param key [Symbol]
     # @param block [Block] resource block
     # @return [String] serialized JSON string
     # @raise [ArgumentError] if block is absent or `with` argument's type is wrong
-    def serialize(object, with: nil, &block)
+    def serialize(object, key: nil, &block)
       raise ArgumentError, 'Block required' unless block
 
-      resource_class.class_eval(&block)
-      resource = resource_class.new(object)
-      with ||= @default_serializer
-      resource.serialize(with: with)
+      klass = Class.new
+      klass.include(Alba::Resource)
+      klass.class_eval(&block)
+      resource = klass.new(object)
+      resource.serialize(key: key)
+    end
+
+    # Enable inference for key and resource name
+    def enable_inference!
+      begin
+        require 'active_support/inflector'
+      rescue LoadError
+        raise ::Alba::Error, 'To enable inference, please install `ActiveSupport` gem.'
+      end
+      @inferring = true
+    end
+
+    # Disable inference for key and resource name
+    def disable_inference!
+      @inferring = false
+    end
+
+    # Set error handler
+    #
+    # @param [Symbol] handler
+    # @param [Block]
+    def on_error(handler = nil, &block)
+      raise ArgumentError, 'You cannot specify error handler with both Symbol and block' if handler && block
+      raise ArgumentError, 'You must specify error handler with either Symbol or block' unless handler || block
+
+      @_on_error = handler || block
     end
 
     private
@@ -59,6 +85,7 @@ module Alba
       require 'oj'
       ->(hash) { Oj.dump(hash, mode: :strict) }
     rescue LoadError
+      Kernel.warn '`Oj` is not installed, falling back to default JSON encoder.'
       default_encoder
     end
 
@@ -66,6 +93,7 @@ module Alba
       require 'active_support/json'
       ->(hash) { ActiveSupport::JSON.encode(hash) }
     rescue LoadError
+      Kernel.warn '`ActiveSupport` is not installed, falling back to default JSON encoder.'
       default_encoder
     end
 
@@ -75,14 +103,8 @@ module Alba
         JSON.dump(hash)
       end
     end
-
-    def resource_class
-      @resource_class ||= begin
-                             klass = Class.new
-                             klass.include(Alba::Resource)
-                           end
-    end
   end
 
   @encoder = default_encoder
+  @_on_error = :raise
 end

data/lib/alba/association.rb

@@ -2,25 +2,40 @@ module Alba
   # Base class for `One` and `Many`
   # Child class should implement `to_hash` method
   class Association
+    attr_reader :object
+
     # @param name [Symbol] name of the method to fetch association
     # @param condition [Proc] a proc filtering data
     # @param resource [Class<Alba::Resource>] a resource class for the association
     # @param block [Block] used to define resource when resource arg is absent
-    def initialize(name:, condition: nil, resource: nil, &block)
+    def initialize(name:, condition: nil, resource: nil, nesting: nil, &block)
       @name = name
       @condition = condition
       @block = block
-      @resource = resource || resource_class
-      raise ArgumentError, 'resource or block is required' if @resource.nil? && @block.nil?
-    end
+      @resource = resource
+      return if @resource
 
-    # @abstract
-    def to_hash
-      :not_implemented
+      if @block
+        @resource = resource_class
+      elsif Alba.inferring
+        const_parent = nesting.nil? ? Object : Object.const_get(nesting)
+        @resource = const_parent.const_get("#{ActiveSupport::Inflector.classify(@name)}Resource")
+      else
+        raise ArgumentError, 'When Alba.inferring is false, either resource or block is required'
+      end
     end
 
     private
 
+    def constantize(resource)
+      case resource # rubocop:disable Style/MissingElse
+      when Class
+        resource
+      when Symbol, String
+        Object.const_get(resource)
+      end
+    end
+
     def resource_class
       klass = Class.new
       klass.include(Alba::Resource)

data/lib/alba/key_transformer.rb

@@ -0,0 +1,32 @@
+module Alba
+  # Transform keys using `ActiveSupport::Inflector`
+  module KeyTransformer
+    begin
+      require 'active_support/inflector'
+    rescue LoadError
+      raise ::Alba::Error, 'To use transform_keys, please install `ActiveSupport` gem.'
+    end
+
+    module_function
+
+    # Transform key as given transform_type
+    #
+    # @params key [String] key to be transformed
+    # @params transform_type [Symbol] transform type
+    # @return [String] transformed key
+    # @raise [Alba::Error] when transform_type is not supported
+    def transform(key, transform_type)
+      key = key.to_s
+      case transform_type
+      when :camel
+        ActiveSupport::Inflector.camelize(key)
+      when :lower_camel
+        ActiveSupport::Inflector.camelize(key, false)
+      when :dash
+        ActiveSupport::Inflector.dasherize(key)
+      else
+        raise ::Alba::Error, "Unknown transform_type: #{transform_type}. Supported transform_type are :camel, :lower_camel and :dash."
+      end
+    end
+  end
+end