alba 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a92c56eee7615f823efc93ed7edb87ba6c47a4bcf8e8b11e48edfc62c380545
-  data.tar.gz: 310eca11a4a5a83287d3d87c1346c2436900bf1283e5642baa3878c69087812d
+  metadata.gz: e8427c3365aa48ba76f97799757e5e32ae2f746d3b63c67d58e7c7ddadd17bae
+  data.tar.gz: c995206962d4a041032b76113a2f053e48f50f787af12c491437ff98c55d4d2e
 SHA512:
-  metadata.gz: 2fed0c44e90d2d876b2db635867741b3520a21c470acfb07a0218b7e0b627ce718edb1da964dfafdf0c79b3fe16bf7502a4fd873e998778c5307bd0c37d0c7c0
-  data.tar.gz: 334edc5389f1fceba2ee880a322f894ccb145533793a885777ac29c08c273b5dda9a31cf9885b493b6ec3fabcf859a1d1643ce37b848c225db66b658b36e3e34
+  metadata.gz: b513dea8cfa68bf09e76114c3d6e14bd77a381f94ad9342c8692034069240c114b9eac95bf071662905de14efe269ac606a7cb2b50ec4107fa393391ed5ddf9d
+  data.tar.gz: e44bc0f25be1342ea9424c3919c62cd40b1917eac62f6bf612cd7979ead6db5521200eae4d7ef9a795ee373145c4fb5c846886bc1869916fd744596ac57aecbc

data/.rubocop.yml

@@ -12,16 +12,45 @@ AllCops:
     - 'Rakefile'
     - 'alba.gemspec'
   NewCops: enable
+  EnabledByDefault: true
+
+# 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
 
+Layout/MultilineAssignmentLayout:
+  EnforcedStyle: same_line
+
+Lint/ConstantResolution:
+  Enabled: false
+
 Metrics/ClassLength:
   Exclude:
     - 'test/alba_test.rb'
 
 Metrics/MethodLength:
-  Max: 20
+  Max: 15
+
+Style/ConstantVisibility:
+  Enabled: false
+
+Style/Copyright:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
 
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+Style/InlineComment:
+  Enabled: false
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: false

data/Gemfile

@@ -3,12 +3,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in alba.gemspec
 gemspec
 
-gem 'activesupport', require: false
-gem 'coveralls', require: false
-gem 'minitest', '~> 5.0'
-gem 'oj', '~> 3.10', platforms: :ruby
-gem 'rake', '~> 13.0'
-gem 'rubocop', '>= 0.79.0', require: false
-gem 'rubocop-minitest', '~> 0.10.1', require: false
-gem 'rubocop-performance', '~> 1.7.1', require: false
-gem 'rubocop-sensible', '~> 0.3.0', require: false
+gem 'activesupport', require: false # For backend
+gem 'coveralls', require: false # For test coverage
+gem 'minitest', '~> 5.0' # For test
+gem 'oj', '~> 3.10', platforms: :ruby # 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-sensible', '~> 0.3.0', require: false # For lint

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alba (0.9.0)
+    alba (0.10.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,6 +13,7 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.1)
+    bigdecimal (2.0.0)
     concurrent-ruby (1.1.6)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
@@ -25,7 +26,8 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.3.1)
     minitest (5.14.1)
-    oj (3.10.8)
+    oj (3.10.12)
+      bigdecimal (>= 1.0, < 3)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)

data/README.md

@@ -7,6 +7,22 @@
 
 `Alba` is the fastest JSON serializer for Ruby.
 
+# 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
+
+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
+
+Alba is faster than most of the alternatives. We have a [benchmark](https://gist.github.com/okuramasafumi/4e375525bd3a28e4ca812d2a3b3e5829).
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/alba.rb

@@ -7,6 +7,7 @@ require 'alba/resources/default_resource'
 # Core module
 module Alba
   class Error < StandardError; end
+  class UnsupportedBackend < Error; end
 
   class << self
     attr_reader :backend, :encoder
@@ -31,26 +32,30 @@ module Alba
     def set_encoder
       @encoder = case @backend
                  when :oj
-                   begin
-                     require 'oj'
-                     ->(hash) { Oj.dump(hash, mode: :strict) }
-                   rescue LoadError
-                     default_encoder
-                   end
+                   try_oj
                  when :active_support
-                   begin
-                     require 'active_support/json'
-                     ->(hash) { ActiveSupport::JSON.encode(hash) }
-                   rescue LoadError
-                     default_encoder
-                   end
+                   try_active_support
                  when nil, :default, :json
                    default_encoder
                  else
-                   raise Alba::Error, "Unsupported backend, #{backend}"
+                   raise Alba::UnsupportedBackend, "Unsupported backend, #{backend}"
                  end
     end
 
+    def try_oj
+      require 'oj'
+      ->(hash) { Oj.dump(hash, mode: :strict) }
+    rescue LoadError
+      default_encoder
+    end
+
+    def try_active_support
+      require 'active_support/json'
+      ->(hash) { ActiveSupport::JSON.encode(hash) }
+    rescue LoadError
+      default_encoder
+    end
+
     def default_encoder
       lambda do |hash|
         require 'json'

data/lib/alba/association.rb

@@ -2,10 +2,11 @@ module Alba
   # Base class for `One` and `Many`
   # Child class should implement `to_hash` method
   class Association
-    def initialize(name:, resource: nil, &block)
+    def initialize(name:, condition: nil, resource: nil, &block)
       @name = name
-      @resource = resource
+      @condition = condition
       @block = block
+      @resource = resource || resource_class
       raise ArgumentError, 'resource or block is required' if @resource.nil? && @block.nil?
     end
 

data/lib/alba/many.rb

@@ -3,10 +3,10 @@ require 'alba/association'
 module Alba
   # Representing many association
   class Many < Association
-    def to_hash(target)
+    def to_hash(target, params: {})
       objects = target.public_send(@name)
-      @resource ||= resource_class
-      objects.map { |o| @resource.new(o).to_hash }
+      objects = @condition.call(objects) if @condition
+      objects.map { |o| @resource.new(o, params: params).to_hash }
     end
   end
 end

data/lib/alba/one.rb

@@ -3,10 +3,10 @@ require 'alba/association'
 module Alba
   # Representing one association
   class One < Association
-    def to_hash(target)
+    def to_hash(target, params: {})
       object = target.public_send(@name)
-      @resource ||= resource_class
-      @resource.new(object).to_hash
+      object = @condition.call(object) if @condition
+      @resource.new(object, params: params).to_hash
     end
   end
 end

data/lib/alba/resource.rb

@@ -63,7 +63,9 @@ module Alba
             when Proc
               instance_exec(resource, &attribute)
             when Alba::One, Alba::Many
-              attribute.to_hash(resource)
+              attribute.to_hash(resource, params: params)
+            else
+              raise ::Alba::Error, "Unsupported type of attribute: #{attribute.class}"
             end
           end
         end
@@ -90,21 +92,21 @@ module Alba
       end
 
       def attributes(*attrs)
-        attrs.each { |attr_name| @_attributes[attr_name] = attr_name }
+        attrs.each { |attr_name| @_attributes[attr_name.to_sym] = attr_name.to_sym }
       end
 
       def attribute(name, &block)
         raise ArgumentError, 'No block given in attribute method' unless block
 
-        @_attributes[name] = block
+        @_attributes[name.to_sym] = block
       end
 
-      def one(name, resource: nil, &block)
-        @_attributes[name.to_sym] = One.new(name: name, resource: resource, &block)
+      def one(name, condition = nil, resource: nil, key: nil, &block)
+        @_attributes[key&.to_sym || name.to_sym] = One.new(name: name, condition: condition, resource: resource, &block)
       end
 
-      def many(name, resource: nil, &block)
-        @_attributes[name.to_sym] = Many.new(name: name, resource: resource, &block)
+      def many(name, condition = nil, resource: nil, key: nil, &block)
+        @_attributes[key&.to_sym || name.to_sym] = Many.new(name: name, condition: condition, resource: resource, &block)
       end
 
       def serializer(name)
@@ -118,7 +120,7 @@ module Alba
       # Use this DSL in child class to ignore certain attributes
       def ignoring(*attributes)
         attributes.each do |attr_name|
-          @_attributes.delete(attr_name)
+          @_attributes.delete(attr_name.to_sym)
         end
       end
     end

data/lib/alba/serializer.rb

@@ -25,12 +25,7 @@ module Alba
 
       def key
         opts = self.class._opts || {}
-        case opts[:key]
-        when true
-          @resource.key
-        else
-          opts[:key]
-        end
+        opts[:key] == true ? @resource.key : opts[:key]
       end
 
       def metadata

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '0.9.0'.freeze
+  VERSION = '0.10.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-08-23 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