alba 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9adc72b171ef6c74c4198ddad4cc8f629c416c62c6b8d8a9698efdbe9dccc44
-  data.tar.gz: af33f05822bfee2bdfe455d4b7a9e75b0e2486c692297e24ab28768c0a839b24
+  metadata.gz: 9aae01860e12e1e5fd71f066e8772fb3a80b4aec6e99cf9dd55ad8652896ea24
+  data.tar.gz: c9930853dcaaa5ea2ff28e954c3b0d7e2ba559efc64b82e7da6b0c28968f55ed
 SHA512:
-  metadata.gz: 2b289f590bf7b4cc3682b13f7841e9408f61ba7d49c0521b05649fb658745cd76c91032f3c2ee83224a1407f17686dc01eb383d90219877ac6f077b05095ce4c
-  data.tar.gz: f842f9775b8355ed1b0dd88ea14aaecd57699fc578a11c38bf3a3d12ad04bbf01dbe0867bb30efc4cc73f1e7766d6e0e0e750741c6130dd33562434bfea6ba8b
+  metadata.gz: 7882b0950c339f87fc75b19e79bcdc2481a296331e9be47a646db997fa4db5639af31c49d529063d099cd5df405357d245397af23b0038c568e32feb86bd5718
+  data.tar.gz: 2bc8c03f0ca5049a23b7dd5c2f6582051f98296a0ba9e0a436e08e9a426a53896e7ac94af276cc3a82e5a0a253f30d381db5384e483c77918ff3d5ef9165a1b7

data/.rubocop.yml

@@ -18,9 +18,6 @@ AllCops:
 Bundler/GemComment:
   Enabled: false
 
-Layout/ClassStructure:
-  Enabled: true
-
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
@@ -38,14 +35,12 @@ Metrics/MethodLength:
   Max: 15
 
 Style/ConstantVisibility:
-  Enabled: false
+  Exclude:
+    - 'lib/alba/version.rb'
 
 Style/Copyright:
   Enabled: false
 
-Style/DocumentationMethod:
-  Enabled: false
-
 Style/FrozenStringLiteralComment:
   Enabled: false
 

data/.travis.yml

@@ -5,5 +5,6 @@ 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

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private
+--exclude lib/alba/version.rb

data/Gemfile

@@ -5,10 +5,11 @@ gemspec
 
 gem 'activesupport', require: false # For backend
 gem 'coveralls', require: false # For test coverage
-gem 'minitest', '~> 5.0' # For test
+gem 'minitest', '~> 5.14' # For test
 gem 'oj', '~> 3.10', 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.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
+gem 'yard', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alba (0.11.0)
+    alba (0.11.1)
 
 GEM
   remote: https://rubygems.org/
@@ -13,7 +13,6 @@ 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,9 +24,8 @@ GEM
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     json (2.3.1)
-    minitest (5.14.1)
-    oj (3.10.12)
-      bigdecimal (>= 1.0, < 3)
+    minitest (5.14.2)
+    oj (3.10.13)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
@@ -35,7 +33,7 @@ GEM
     rake (13.0.1)
     regexp_parser (1.7.1)
     rexml (3.2.4)
-    rubocop (0.89.1)
+    rubocop (0.90.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
@@ -68,6 +66,7 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
+    yard (0.9.25)
     zeitwerk (2.4.0)
 
 PLATFORMS
@@ -77,13 +76,14 @@ DEPENDENCIES
   activesupport
   alba!
   coveralls
-  minitest (~> 5.0)
+  minitest (~> 5.14)
   oj (~> 3.10)
   rake (~> 13.0)
   rubocop (>= 0.79.0)
   rubocop-minitest (~> 0.10.1)
   rubocop-performance (~> 1.7.1)
   rubocop-sensible (~> 0.3.0)
+  yard
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -2,24 +2,26 @@
 [![Build Status](https://travis-ci.com/okuramasafumi/alba.svg?branch=master)](https://travis-ci.com/okuramasafumi/alba)
 [![Coverage Status](https://coveralls.io/repos/github/okuramasafumi/alba/badge.svg?branch=master)](https://coveralls.io/github/okuramasafumi/alba?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/fdab4cc0de0b9addcfe8/maintainability)](https://codeclimate.com/github/okuramasafumi/alba/maintainability)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/okuramasafumi/alba)
+![GitHub](https://img.shields.io/github/license/okuramasafumi/alba)
 
 # Alba
 
 `Alba` is the fastest JSON serializer for Ruby.
 
-# Why yet another JSON serializer?
+## 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
+### 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
+### Performance
 
 Alba is faster than most of the alternatives. We have a [benchmark](https://gist.github.com/okuramasafumi/4e375525bd3a28e4ca812d2a3b3e5829).
 
@@ -43,6 +45,32 @@ Or install it yourself as:
 
 Alba supports CRuby 2.5.7 and higher and latest TruffleRuby.
 
+## Documentation
+
+You can find the documentation on [RubyDoc](https://rubydoc.info/gems/alba).
+
+## Features
+
+* Resource-based serialization
+* Arbitrary attribute definition
+* One and many association with the ability to define them inline
+* Adding condition and filter to association
+* Parameters can be injected and used in attributes and associations
+* Setting root key separately in Serializer
+* Adding metadata
+* Selectable backend
+* No runtime dependencies
+
+## Anti features
+
+* Sorting keys
+* Class level support of parameters
+* Supporting all existing JSON encoder/decoder
+* Cache
+* [JSON:API](https://jsonapi.org) support
+* Association name inflection
+* And many others
+
 ## Usage
 
 ### Configuration
@@ -129,7 +157,7 @@ class ArticleResource
   attributes :title
 end
 
-class UserResource1
+class UserResource
   include Alba::Resource
 
   attributes :id
@@ -143,7 +171,7 @@ user.articles << article1
 article2 = Article.new(2, 'Super nice', 'Really nice!')
 user.articles << article2
 
-UserResource1.new(user).serialize
+UserResource.new(user).serialize
 # => '{"id":1,"articles":[{"title":"Hello World!"},{"title":"Super nice"}]}'
 ```
 

data/lib/alba.rb

@@ -1,21 +1,36 @@
-require 'alba/version'
-require 'alba/serializer'
-require 'alba/resource'
+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
 
+    # Set the backend, which actually serializes object into JSON
+    #
+    # @param backend [#to_sym, nil] the name of the backend
+    #   Possible values are `oj`, `active_support`, `default`, `json` and nil
+    # @return [Proc] the proc to encode object into JSON
+    # @raise [Alba::UnsupportedBackend] if backend is not supported
     def backend=(backend)
       @backend = backend&.to_sym
       set_encoder
     end
 
+    # Serialize the object with inline definitions
+    #
+    # @param object [Object] the object to be serialized
+    # @param with [nil, Proc, Alba::Serializer] selializer
+    # @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)
       raise ArgumentError, 'Block required' unless block
 

data/lib/alba/association.rb

@@ -2,6 +2,10 @@ module Alba
   # Base class for `One` and `Many`
   # Child class should implement `to_hash` method
   class Association
+    # @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)
       @name = name
       @condition = condition
@@ -10,6 +14,7 @@ module Alba
       raise ArgumentError, 'resource or block is required' if @resource.nil? && @block.nil?
     end
 
+    # @abstract
     def to_hash
       :not_implemented
     end

data/lib/alba/many.rb

@@ -1,8 +1,13 @@
-require 'alba/association'
+require_relative 'association'
 
 module Alba
   # Representing many association
   class Many < Association
+    # Recursively converts objects into an Array of Hashes
+    #
+    # @param target [Object] the object having an association method
+    # @param params [Hash] user-given Hash for arbitrary data
+    # @return [Array<Hash>]
     def to_hash(target, params: {})
       objects = target.public_send(@name)
       objects = @condition.call(objects, params) if @condition

data/lib/alba/one.rb

@@ -1,8 +1,13 @@
-require 'alba/association'
+require_relative 'association'
 
 module Alba
   # Representing one association
   class One < Association
+    # Recursively converts an object into a Hash
+    #
+    # @param target [Object] the object having an association method
+    # @param params [Hash] user-given Hash for arbitrary data
+    # @return [Hash]
     def to_hash(target, params: {})
       object = target.public_send(@name)
       object = @condition.call(object, params) if @condition

data/lib/alba/resource.rb

@@ -1,11 +1,16 @@
-require 'alba/serializer'
-require 'alba/one'
-require 'alba/many'
+require_relative 'serializer'
+require_relative 'one'
+require_relative 'many'
 
 module Alba
   # This module represents what should be serialized
   module Resource
+    # @!parse include InstanceMethods
+    # @!parse extend ClassMethods
     DSLS = {_attributes: {}, _serializer: nil, _key: nil}.freeze
+    private_constant :DSLS
+
+    # @private
     def self.included(base)
       super
       base.class_eval do
@@ -22,12 +27,18 @@ module Alba
     module InstanceMethods
       attr_reader :object, :_key, :params
 
+      # @param object [Object] the object to be serialized
+      # @param params [Hash] user-given Hash for arbitrary data
       def initialize(object, params: {})
         @object = object
-        @params = params
+        @params = params.freeze
         DSLS.each_key { |name| instance_variable_set("@#{name}", self.class.public_send(name)) }
       end
 
+      # Get serializer with `with` argument and serialize self with it
+      #
+      # @param with [nil, Proc, Alba::Serializer] selializer
+      # @return [String] serialized JSON string
       def serialize(with: nil)
         serializer = case with
                      when nil
@@ -42,11 +53,15 @@ module Alba
         serializer.new(self).serialize
       end
 
+      # A Hash for serialization
+      #
+      # @return [Hash]
       def serializable_hash
         collection? ? @object.map(&converter) : converter.call(@object)
       end
       alias to_hash serializable_hash
 
+      # @return [Symbol]
       def key
         @_key || self.class.name.delete_suffix('Resource').downcase.gsub(/:{2}/, '_').to_sym
       end
@@ -91,38 +106,72 @@ module Alba
     module ClassMethods
       attr_reader(*DSLS.keys)
 
+      # @private
       def inherited(subclass)
         super
         DSLS.each_key { |name| subclass.instance_variable_set("@#{name}", instance_variable_get("@#{name}").clone) }
       end
 
+      # Set multiple attributes at once
+      #
+      # @param attrs [Array<String, Symbol>]
       def attributes(*attrs)
         attrs.each { |attr_name| @_attributes[attr_name.to_sym] = attr_name.to_sym }
       end
 
+      # Set an attribute with the given block
+      #
+      # @param name [String, Symbol] key name
+      # @param block [Block] the block called during serialization
+      # @raise [ArgumentError] if block is absent
       def attribute(name, &block)
         raise ArgumentError, 'No block given in attribute method' unless block
 
         @_attributes[name.to_sym] = block
       end
 
+      # Set One association
+      #
+      # @param name [String, Symbol]
+      # @param condition [Proc]
+      # @param resource [Class<Alba::Resource>]
+      # @param key [String, Symbol] used as key when given
+      # @param block [Block]
+      # @see Alba::One#initialize
       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
 
+      # Set Many association
+      #
+      # @param name [String, Symbol]
+      # @param condition [Proc]
+      # @param resource [Class<Alba::Resource>]
+      # @param key [String, Symbol] used as key when given
+      # @param block [Block]
+      # @see Alba::Many#initialize
       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
 
+      # Set serializer for the resource
+      #
+      # @param name [Alba::Serializer]
       def serializer(name)
         @_serializer = name <= Alba::Serializer ? name : nil
       end
 
+      # Set key
+      #
+      # @param key [String, Symbol]
       def key(key)
         @_key = key.to_sym
       end
 
+      # Delete attributes
       # Use this DSL in child class to ignore certain attributes
+      #
+      # @param attributes [Array<String, Symbol>]
       def ignoring(*attributes)
         attributes.each do |attr_name|
           @_attributes.delete(attr_name.to_sym)

data/lib/alba/serializer.rb

@@ -1,6 +1,10 @@
 module Alba
   # This module represents how a resource should be serialized.
   module Serializer
+    # @!parse include InstanceMethods
+    # @!parse extend ClassMethods
+
+    # @private
     def self.included(base)
       super
       base.class_eval do
@@ -13,6 +17,7 @@ module Alba
 
     # Instance methods
     module InstanceMethods
+      # @param resource [Alba::Resource]
       def initialize(resource)
         @resource = resource
         @hash = resource.serializable_hash
@@ -21,6 +26,9 @@ module Alba
         @hash.is_a?(Hash) ? @hash.merge!(metadata.to_h) : @hash << metadata
       end
 
+      # Use real encoder to actually serialize to JSON
+      #
+      # @return [String] JSON string
       def serialize
         Alba.encoder.call(@hash)
       end
@@ -42,17 +50,25 @@ module Alba
     module ClassMethods
       attr_reader :_opts, :_metadata
 
+      # @private
       def inherited(subclass)
         super
         %w[_opts _metadata].each { |name| subclass.instance_variable_set("@#{name}", public_send(name).clone) }
       end
 
+      # Set options, currently key only
+      #
+      # @param key [Boolean, Symbol]
       def set(key: false)
         @_opts[:key] = key
       end
 
+      # Set metadata
+      #
+      # @param name [String, Symbol] key for the metadata
+      # @param block [Block] the content of the metadata
       def metadata(name, &block)
-        @_metadata[name] = block
+        @_metadata[name.to_sym] = block
       end
     end
   end

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '0.11.0'.freeze
+  VERSION = '0.11.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-09-02 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
@@ -22,6 +22,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock