alba 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 592412974accb17b359ab871e293e2c839519f7cfffb31a04485bfe261b88202
-  data.tar.gz: d8fbb2ec751eac8e7dbe278e8993da6641eaa88f302b3438055b2062c08bd229
+  metadata.gz: 3a92c56eee7615f823efc93ed7edb87ba6c47a4bcf8e8b11e48edfc62c380545
+  data.tar.gz: 310eca11a4a5a83287d3d87c1346c2436900bf1283e5642baa3878c69087812d
 SHA512:
-  metadata.gz: 97c3fc639d1d6b7fa588c78fa84f4be7318982ebf3154b9037e1b9c6ac38d1d9a0528bcf45618a5d1b1dc009df30441589eb27d1bdfbd8afaca1e61a0708e31e
-  data.tar.gz: 7abd201ba80bdfff652840e948e8aede24e90d0cfc26722f08044916f239387fd0bada0a1e9a0d71cf252ced9400d1549124349a1070ea7bd8c8e5a7be0ebc38
+  metadata.gz: 2fed0c44e90d2d876b2db635867741b3520a21c470acfb07a0218b7e0b627ce718edb1da964dfafdf0c79b3fe16bf7502a4fd873e998778c5307bd0c37d0c7c0
+  data.tar.gz: 334edc5389f1fceba2ee880a322f894ccb145533793a885777ac29c08c273b5dda9a31cf9885b493b6ec3fabcf859a1d1643ce37b848c225db66b658b36e3e34

data/.rubocop.yml

@@ -16,6 +16,10 @@ AllCops:
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
+Metrics/ClassLength:
+  Exclude:
+    - 'test/alba_test.rb'
+
 Metrics/MethodLength:
   Max: 20
 

data/.travis.yml

@@ -5,4 +5,5 @@ rvm:
   - 2.5.8
   - 2.6.6
   - 2.7.1
+  - truffleruby
 before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -3,9 +3,10 @@ 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'
+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

data/Gemfile.lock

@@ -1,12 +1,19 @@
 PATH
   remote: .
   specs:
-    alba (0.8.0)
+    alba (0.9.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.1)
+    concurrent-ruby (1.1.6)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -14,6 +21,8 @@ GEM
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
     docile (1.3.2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
     json (2.3.1)
     minitest (5.14.1)
     oj (3.10.8)
@@ -24,17 +33,17 @@ GEM
     rake (13.0.1)
     regexp_parser (1.7.1)
     rexml (3.2.4)
-    rubocop (0.88.0)
+    rubocop (0.89.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.2.0)
-      parser (>= 2.7.0.1)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     rubocop-minitest (0.10.1)
       rubocop (>= 0.87)
     rubocop-performance (1.7.1)
@@ -51,14 +60,19 @@ GEM
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (1.0.1)
+    thread_safe (0.3.6)
     tins (1.25.0)
       sync
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   alba!
   coveralls
   minitest (~> 5.0)

data/README.md

@@ -25,6 +25,24 @@ Or install it yourself as:
 
 ## Usage
 
+### Configuration
+
+Alba's configuration is fairly simple.
+
+#### Backend
+
+Backend is the actual part serializing an object into JSON. Alba supports these backends.
+
+* Oj, the fastest. Gem installation required.
+* active_support, mostly for Rails. Gem installation required.
+* default or json, with no external dependencies.
+
+You can set a backend like this:
+
+```ruby
+Alba.backend = :oj
+```
+
 ### Simple serialization with key
 
 ```ruby
@@ -125,11 +143,49 @@ end
 
 Although this might be useful sometimes, it's generally recommended to define a class for both Resource and Serializer.
 
+### Inheritance and Ignorance
+
+You can `exclude` or `ignore` certain attributes using `ignoring`.
+
+```ruby
+class Foo
+  attr_accessor :id, :name, :body
+
+  def initialize(id, name, body)
+    @id = id
+    @name = name
+    @body = body
+  end
+end
+
+class GenericFooResource
+  include Alba::Resource
+
+  attributes :id, :name, :body
+end
+
+class RestrictedFooResouce < GenericFooResource
+  ignoring :id, :body
+end
+
+RestrictedFooResouce.new(foo).serialize
+# => '{"name":"my foo"}'
+end
+```
+
 ## Comparison
 
 Alba is faster than alternatives.
 For a performance benchmark, see https://gist.github.com/okuramasafumi/4e375525bd3a28e4ca812d2a3b3e5829.
 
+## Rails
+
+When you use Alba in Rails, you can create an initializer file with the line below for compatibility with Rails JSON encoder.
+
+```ruby
+Alba.backend = :active_support
+```
+
 ## Why named "Alba"?
 
 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.
@@ -142,7 +198,7 @@ Alba has three component, `Serializer`, `Resource` and `Value` (`Value` is conce
 
 `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`.
 
-`Value` is either `Attribute`, `One` or `Many`. They are responsible for fetching data from the object for `Resource`. The main interface is `#to_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`.
 

data/lib/alba.rb

@@ -9,11 +9,12 @@ module Alba
   class Error < StandardError; end
 
   class << self
-    attr_reader :backend
+    attr_reader :backend, :encoder
     attr_accessor :default_serializer
 
     def backend=(backend)
       @backend = backend&.to_sym
+      set_encoder
     end
 
     def serialize(object, with: nil, &block)
@@ -27,8 +28,40 @@ module Alba
 
     private
 
+    def set_encoder
+      @encoder = case @backend
+                 when :oj
+                   begin
+                     require 'oj'
+                     ->(hash) { Oj.dump(hash, mode: :strict) }
+                   rescue LoadError
+                     default_encoder
+                   end
+                 when :active_support
+                   begin
+                     require 'active_support/json'
+                     ->(hash) { ActiveSupport::JSON.encode(hash) }
+                   rescue LoadError
+                     default_encoder
+                   end
+                 when nil, :default, :json
+                   default_encoder
+                 else
+                   raise Alba::Error, "Unsupported backend, #{backend}"
+                 end
+    end
+
+    def default_encoder
+      lambda do |hash|
+        require 'json'
+        JSON.dump(hash)
+      end
+    end
+
     def resource_class
       ::Alba::Resources::DefaultResource.clone
     end
   end
+
+  @encoder = default_encoder
 end

data/lib/alba/association.rb

@@ -0,0 +1,25 @@
+module Alba
+  # Base class for `One` and `Many`
+  # Child class should implement `to_hash` method
+  class Association
+    def initialize(name:, resource: nil, &block)
+      @name = name
+      @resource = resource
+      @block = block
+      raise ArgumentError, 'resource or block is required' if @resource.nil? && @block.nil?
+    end
+
+    def to_hash
+      :not_implemented
+    end
+
+    private
+
+    def resource_class
+      klass = ::Alba::Resources::DefaultResource.dup
+      klass.reset
+      klass.class_eval(&@block)
+      klass
+    end
+  end
+end

data/lib/alba/many.rb

@@ -1,26 +1,12 @@
+require 'alba/association'
+
 module Alba
   # Representing many association
-  class Many
-    def initialize(name:, resource: nil, &block)
-      @name = name
-      @resource = resource
-      @block = block
-      raise ArgumentError, 'resource or block is required' if @resource.nil? && @block.nil?
-    end
-
+  class Many < Association
     def to_hash(target)
       objects = target.public_send(@name)
       @resource ||= resource_class
       objects.map { |o| @resource.new(o).to_hash }
     end
-
-    private
-
-    def resource_class
-      klass = Class.new
-      klass.include(::Alba::Resource)
-      klass.class_exec(&@block)
-      klass
-    end
   end
 end

data/lib/alba/one.rb

@@ -1,26 +1,12 @@
+require 'alba/association'
+
 module Alba
   # Representing one association
-  class One
-    def initialize(name:, resource: nil, &block)
-      @name = name
-      @resource = resource
-      @block = block
-      raise ArgumentError, 'resource or block is required' if @resource.nil? && @block.nil?
-    end
-
+  class One < Association
     def to_hash(target)
       object = target.public_send(@name)
       @resource ||= resource_class
       @resource.new(object).to_hash
     end
-
-    private
-
-    def resource_class
-      klass = Class.new
-      klass.include(::Alba::Resource)
-      klass.class_exec(&@block)
-      klass
-    end
   end
 end

data/lib/alba/resource.rb

@@ -1,5 +1,4 @@
 require 'alba/serializer'
-require 'alba/attribute'
 require 'alba/one'
 require 'alba/many'
 require 'alba/serializers/default_serializer'
@@ -7,18 +6,13 @@ require 'alba/serializers/default_serializer'
 module Alba
   # This module represents what should be serialized
   module Resource
-    DSLS = [:_attributes, :_serializer, :_key].freeze
+    DSLS = {_attributes: {}, _serializer: nil, _key: nil}.freeze
     def self.included(base)
+      super
       base.class_eval do
         # Initialize
-        DSLS.each do |name|
-          initial = case name
-                    when :_attributes
-                      {}
-                    when :_serializer, :_name
-                      nil
-                    end
-          instance_variable_set("@#{name}", initial) unless instance_variable_defined?("@#{name}")
+        DSLS.each do |name, initial|
+          instance_variable_set("@#{name}", initial.dup) unless instance_variable_defined?("@#{name}")
         end
       end
       base.include InstanceMethods
@@ -27,11 +21,12 @@ module Alba
 
     # Instance methods
     module InstanceMethods
-      attr_reader :_object
+      attr_reader :object, :_key, :params
 
-      def initialize(object)
-        @_object = object
-        DSLS.each { |name| instance_variable_set("@#{name}", self.class.public_send(name)) }
+      def initialize(object, params: {})
+        @object = object
+        @params = params
+        DSLS.each_key { |name| instance_variable_set("@#{name}", self.class.public_send(name)) }
       end
 
       def serialize(with: nil)
@@ -48,18 +43,8 @@ module Alba
         serializer.new(self).serialize
       end
 
-      def serializable_hash(with_key: true)
-        get_attribute = lambda do |resource|
-          @_attributes.transform_values do |attribute|
-            attribute.to_hash(resource)
-          end
-        end
-        serializable_hash = if collection?
-                              @_object.map(&get_attribute)
-                            else
-                              get_attribute.call(@_object)
-                            end
-        with_key && @_key ? {@_key => serializable_hash} : serializable_hash
+      def serializable_hash
+        collection? ? @object.map(&converter) : converter.call(@object)
       end
       alias to_hash serializable_hash
 
@@ -69,6 +54,21 @@ module Alba
 
       private
 
+      def converter
+        lambda do |resource|
+          @_attributes.transform_values do |attribute|
+            case attribute
+            when Symbol
+              resource.public_send attribute
+            when Proc
+              instance_exec(resource, &attribute)
+            when Alba::One, Alba::Many
+              attribute.to_hash(resource)
+            end
+          end
+        end
+      end
+
       def inline_extended_serializer(with)
         klass = ::Alba::Serializers::DefaultSerializer.clone
         klass.class_eval(&with)
@@ -76,26 +76,27 @@ module Alba
       end
 
       def collection?
-        @_object.is_a?(Enumerable)
+        @object.is_a?(Enumerable)
       end
     end
 
     # Class methods
     module ClassMethods
-      attr_reader(*DSLS)
+      attr_reader(*DSLS.keys)
 
       def inherited(subclass)
-        DSLS.each { |name| subclass.instance_variable_set("@#{name}", instance_variable_get("@#{name}")) }
+        super
+        DSLS.each_key { |name| subclass.instance_variable_set("@#{name}", instance_variable_get("@#{name}").clone) }
       end
 
       def attributes(*attrs)
-        attrs.each { |attr_name| @_attributes[attr_name] = Attribute.new(name: attr_name, method: attr_name) }
+        attrs.each { |attr_name| @_attributes[attr_name] = attr_name }
       end
 
       def attribute(name, &block)
         raise ArgumentError, 'No block given in attribute method' unless block
 
-        @_attributes[name] = Attribute.new(name: name, method: block)
+        @_attributes[name] = block
       end
 
       def one(name, resource: nil, &block)
@@ -113,6 +114,13 @@ module Alba
       def key(key)
         @_key = key.to_sym
       end
+
+      # Use this DSL in child class to ignore certain attributes
+      def ignoring(*attributes)
+        attributes.each do |attr_name|
+          @_attributes.delete(attr_name)
+        end
+      end
     end
   end
 end

data/lib/alba/resources/default_resource.rb

@@ -3,7 +3,11 @@ module Alba
     # Empty resource class, use this with `class_eval` for
     # inline associations and serializations.
     class DefaultResource
-      include ::Alba::Resource
+      include Alba::Resource
+
+      def self.reset
+        @_attributes = {}
+      end
     end
   end
 end

data/lib/alba/serializer.rb

@@ -2,6 +2,7 @@ module Alba
   # This module represents how a resource should be serialized.
   module Serializer
     def self.included(base)
+      super
       base.include InstanceMethods
       base.extend ClassMethods
     end
@@ -9,37 +10,32 @@ module Alba
     # Instance methods
     module InstanceMethods
       def initialize(resource)
-        @_opts = self.class._opts || {}
-        @_metadata = self.class._metadata || {}
-        @_metadata = @_metadata.transform_values { |block| block.call(resource._object) }
-        key = case @_opts[:key]
-              when true
-                resource.key
-              else
-                @_opts[:key]
-              end
-        @hash = resource.serializable_hash(with_key: false)
+        @resource = resource
+        @hash = resource.serializable_hash
         @hash = {key.to_sym => @hash} if key
         # @hash is either Hash or Array
-        @hash.is_a?(Hash) ? @hash.merge!(@_metadata.to_h) : @hash << @_metadata
+        @hash.is_a?(Hash) ? @hash.merge!(metadata.to_h) : @hash << metadata
       end
 
       def serialize
-        fallback = lambda do
-          require 'json'
-          JSON.dump(@hash)
-        end
-        case Alba.backend
-        when :oj
-          begin
-            require 'oj'
-            -> { Oj.dump(@hash, mode: :strict) }
-          rescue LoadError
-            fallback
-          end
+        Alba.encoder.call(@hash)
+      end
+
+      private
+
+      def key
+        opts = self.class._opts || {}
+        case opts[:key]
+        when true
+          @resource.key
         else
-          fallback
-        end.call
+          opts[:key]
+        end
+      end
+
+      def metadata
+        metadata = self.class._metadata || {}
+        metadata.transform_values { |block| block.call(@resource.object) }
       end
     end
 
@@ -48,6 +44,7 @@ module Alba
       attr_reader :_opts, :_metadata
 
       def inherited(subclass)
+        super
         %w[_opts _metadata].each { |name| subclass.instance_variable_set("@#{name}", instance_variable_get("@#{name}")) }
       end
 

data/lib/alba/version.rb

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

data/sider.yml

@@ -4,6 +4,7 @@ linter:
 #   # https://help.sider.review/tools/ruby/rubocop
   rubocop:
     gems:
+      - "rubocop-minitest"
       - "rubocop-performance"
       - "rubocop-sensible"
     safe: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2020-08-11 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
@@ -32,7 +32,7 @@ files:
 - bin/console
 - bin/setup
 - lib/alba.rb
-- lib/alba/attribute.rb
+- lib/alba/association.rb
 - lib/alba/many.rb
 - lib/alba/one.rb
 - lib/alba/resource.rb

data/lib/alba/attribute.rb

@@ -1,19 +0,0 @@
-module Alba
-  # This class represents an attribute, which is serialized
-  # by either sending message or calling a Proc.
-  class Attribute
-    def initialize(name:, method:)
-      @name = name
-      @method = method
-    end
-
-    def to_hash(target)
-      case @method
-      when Symbol, String
-        target.public_send(@method)
-      when Proc
-        @method.arity.zero? ? target.instance_exec(&@method) : @method.call(target)
-      end
-    end
-  end
-end