alba 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dab0921e07fb607cfceb802a42fdb5f8cc20eb745522c46dc7b451b8a0cd14e
-  data.tar.gz: 6c6fcc0035ef543ee6d60bffa18ca83379d090e800950411d7316c21031784ad
+  metadata.gz: 405e177e9e1fcadf7dbb164d3ac6924e1b3563547f715fedb698211b527a9604
+  data.tar.gz: 2c534708583345ac9090c83b3ddc939b0c8bd335ed77017f554edb28578d0396
 SHA512:
-  metadata.gz: c97545976f850ba0191dcabf7f34b8daeebf54d2b82c9a37305f569cc7cadaa1b9f0f92dc42f81193e9fd56eae2e862d650b023c4bcd105739c18c0baaf35e13
-  data.tar.gz: 7423763628b13e5643193347379eefbcf2cc2d78266cafd147d8c86d3f755feca93dd3f2c9bca92e8ec008b1ec7d00c9ed7bf1590a2f26e83c99fa529a987de1
+  metadata.gz: 71f4712ac28d457fe9bf997fb127288ed66d7d2231ffd6dd438b2eb5c1dd82ff9e3e5c4000415c513012a582cda3d3c3e73fdf0beb4cc96b8583ff9a658dfa75
+  data.tar.gz: '07439ccffc5b48a0d5d4286236acadf4cc3e89ff1afa0a882a87c1fe5640015096a4cd85839cebdc4d6ef350a77043a494bfe4d7b6cff99f8e7db2ab9f8b3db0'

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 
 gem 'coveralls', require: false
 gem 'minitest', '~> 5.0'
+gem 'oj', '~> 3.10'
 gem 'rake', '~> 13.0'
 gem 'rubocop', '>= 0.79.0', require: false
 gem 'rubocop-performance', '~> 1.7.1', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alba (0.2.0)
+    alba (0.7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +16,7 @@ GEM
     docile (1.3.2)
     json (2.3.1)
     minitest (5.14.1)
+    oj (3.10.8)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
@@ -59,6 +60,7 @@ DEPENDENCIES
   alba!
   coveralls
   minitest (~> 5.0)
+  oj (~> 3.10)
   rake (~> 13.0)
   rubocop (>= 0.79.0)
   rubocop-performance (~> 1.7.1)

data/README.md

@@ -4,7 +4,7 @@
 
 # Alba
 
-`Alba` is a fast and flexible JSON serializer.
+`Alba` is a stupid, fast and easy to use JSON serializer.
 
 ## Installation
 
@@ -24,6 +24,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Simple serialization with key
+
 ```ruby
 class User
   attr_accessor :id, :name, :email, :created_at, :updated_at
@@ -57,6 +59,80 @@ UserResource.new(user).serialize
 # => "{\"id\":1,\"name\":\"Masafumi OKURA\",\"name_with_email\":\"Masafumi OKURA: masafumi@example.com\"}"
 ```
 
+### Serialization with associations
+
+```ruby
+class User
+  attr_reader :id, :created_at, :updated_at
+  attr_accessor :articles
+
+  def initialize(id)
+    @id = id
+    @created_at = Time.now
+    @updated_at = Time.now
+    @articles = []
+  end
+end
+
+class Article
+  attr_accessor :user_id, :title, :body
+
+  def initialize(user_id, title, body)
+    @user_id = user_id
+    @title = title
+    @body = body
+  end
+end
+
+class ArticleResource
+  include Alba::Resource
+
+  attributes :title
+end
+
+class UserResource1
+  include Alba::Resource
+
+  attributes :id
+
+  many :articles, resource: ArticleResource
+end
+
+user = User.new(1)
+article1 = Article.new(1, 'Hello World!', 'Hello World!!!')
+user.articles << article1
+article2 = Article.new(2, 'Super nice', 'Really nice!')
+user.articles << article2
+
+UserResource1.new(user).serialize
+# => '{"id":1,"articles":[{"title":"Hello World!"},{"title":"Super nice"}]}'
+```
+
+### Inline definition with `Alba.serialize`
+
+`Alba.serialize` method is a shortcut to define everything inline.
+
+```ruby
+Alba.serialize(user, with: proc { set key: :foo }) do
+  attributes :id
+  many :articles do
+    attributes :title, :body
+  end
+end
+# => '{"foo":{"id":1,"articles":[{"title":"Hello World!","body":"Hello World!!!"},{"title":"Super nice","body":"Really nice!"}]}}'
+```
+
+Although this might be useful sometimes, it's generally recommended to define a class for both Resource and Serializer.
+
+## Comparison
+
+Since Alba is intended to be stupid, there are many things Alba can't do while other gems can. However, from the same reason, it's extremely faster than alternatives.
+For a performance benchmark, see https://gist.github.com/okuramasafumi/4e375525bd3a28e4ca812d2a3b3e5829.
+
+## 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.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/alba.rb

@@ -1,6 +1,8 @@
 require 'alba/version'
+require 'alba/serializers/default_serializer'
+require 'alba/serializer'
 require 'alba/resource'
-require 'json'
+require 'alba/resources/default_resource'
 
 # Core module
 module Alba
@@ -8,24 +10,25 @@ module Alba
 
   class << self
     attr_reader :backend
-  end
+    attr_accessor :default_serializer
 
-  def self.backend=(backend)
-    @backend = backend&.to_sym
-  end
+    def backend=(backend)
+      @backend = backend&.to_sym
+    end
+
+    def serialize(object, with: 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)
+    end
+
+    private
 
-  def self.serialize(object)
-    fallback = ->(resource) { resource.to_json }
-    case backend
-    when :oj
-      begin
-        require 'oj'
-        ->(resource) { Oj.dump(resource) }
-      rescue LoadError
-        fallback
-      end
-    else
-      fallback
-    end.call(object)
+    def resource_class
+      ::Alba::Resources::DefaultResource.clone
+    end
   end
 end

data/lib/alba/many.rb

@@ -9,7 +9,7 @@ module Alba
     end
 
     def to_hash(target)
-      objects = target.__send__(@name)
+      objects = target.public_send(@name)
       @resource ||= resource_class
       objects.map { |o| @resource.new(o).to_hash }
     end

data/lib/alba/one.rb

@@ -9,7 +9,7 @@ module Alba
     end
 
     def to_hash(target)
-      object = target.__send__(@name)
+      object = target.public_send(@name)
       @resource ||= resource_class
       @resource.new(object).to_hash
     end

data/lib/alba/resource.rb

@@ -7,12 +7,17 @@ require 'alba/serializers/default_serializer'
 module Alba
   # This module represents what should be serialized
   module Resource
-    DSLS = [:_attributes, :_one, :_many, :_serializer].freeze
+    DSLS = [:_attributes, :_serializer, :_key].freeze
     def self.included(base)
       base.class_eval do
         # Initialize
         DSLS.each do |name|
-          initial = name == :_serializer ? nil : {}
+          initial = case name
+                    when :_attributes
+                      {}
+                    when :_serializer, :_name
+                      nil
+                    end
           instance_variable_set("@#{name}", initial) unless instance_variable_defined?("@#{name}")
         end
       end
@@ -29,41 +34,47 @@ module Alba
 
       def serialize(with: nil)
         serializer = case with
-                     when ->(obj) { obj.is_a?(Class) && obj <= Alba::Serializer }
-                       with
-                     when Symbol
-                       const_get(with.to_s.capitalize)
-                     when String
-                       const_get(with)
                      when nil
                        @_serializer || Alba::Serializers::DefaultSerializer
+                     when ->(obj) { obj.is_a?(Class) && obj <= Alba::Serializer }
+                       with
+                     when Proc
+                       inline_extended_serializer(with)
+                     else
+                       raise ArgumentError, 'Unexpected type for with, possible types are Class or Proc'
                      end
-        serializer.new(serializable_hash).serialize
+        serializer.new(self).serialize
       end
 
-      def serializable_hash
-        attrs.merge(ones).merge(manies)
+      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?
+                              @_resource.map(&get_attribute)
+                            else
+                              get_attribute.call(@_resource)
+                            end
+        with_key && @_key ? {@_key => serializable_hash} : serializable_hash
       end
       alias to_hash serializable_hash
 
-      private
-
-      def attrs
-        @_attributes.transform_values do |attribute|
-          attribute.to_hash(@_resource)
-        end || {}
+      def key
+        @_key || self.class.name.delete_suffix('Resource').downcase.gsub(/:{2}/, '_').to_sym
       end
 
-      def ones
-        @_one.transform_values do |one|
-          one.to_hash(@_resource)
-        end || {}
+      private
+
+      def inline_extended_serializer(with)
+        klass = ::Alba::Serializers::DefaultSerializer.clone
+        klass.class_eval(&with)
+        klass
       end
 
-      def manies
-        @_many.transform_values do |many|
-          many.to_hash(@_resource)
-        end || {}
+      def collection?
+        @_resource.is_a?(Enumerable)
       end
     end
 
@@ -86,16 +97,20 @@ module Alba
       end
 
       def one(name, resource: nil, &block)
-        @_one[name.to_sym] = One.new(name: name, resource: resource, &block)
+        @_attributes[name.to_sym] = One.new(name: name, resource: resource, &block)
       end
 
       def many(name, resource: nil, &block)
-        @_many[name.to_sym] = Many.new(name: name, resource: resource, &block)
+        @_attributes[name.to_sym] = Many.new(name: name, resource: resource, &block)
       end
 
       def serializer(name)
         @_serializer = name <= Alba::Serializer ? name : nil
       end
+
+      def key(key)
+        @_key = key.to_sym
+      end
     end
   end
 end

data/lib/alba/resources/default_resource.rb

@@ -0,0 +1,9 @@
+module Alba
+  module Resources
+    # Empty resource class, use this with `class_eval` for
+    # inline associations and serializations.
+    class DefaultResource
+      include ::Alba::Resource
+    end
+  end
+end

data/lib/alba/serializer.rb

@@ -1,6 +1,5 @@
 module Alba
   # This module represents how a resource should be serialized.
-  #
   module Serializer
     def self.included(base)
       base.include InstanceMethods
@@ -10,19 +9,27 @@ module Alba
     # Instance methods
     module InstanceMethods
       def initialize(resource)
-        @_resource = resource
         @_opts = self.class._opts || {}
-        key = @_opts[:key]
-        @_resource = {key.to_sym => @_resource} if key
+        key = case @_opts[:key]
+              when true
+                resource.key
+              else
+                @_opts[:key]
+              end
+        @hash = resource.serializable_hash(with_key: false)
+        @hash = {key.to_sym => @hash} if key
       end
 
       def serialize
-        fallback = -> { @_resource.to_json }
+        fallback = lambda do
+          require 'json'
+          JSON.dump(@hash)
+        end
         case Alba.backend
         when :oj
           begin
             require 'oj'
-            -> { Oj.dump(@_resource) }
+            -> { Oj.dump(@hash, mode: :strict) }
           rescue LoadError
             fallback
           end

data/lib/alba/serializers/default_serializer.rb

@@ -1,3 +1,5 @@
+require 'alba/serializer'
+
 module Alba
   module Serializers
     # DefaultSerializer class is used when a user doesn't specify serializer opt.

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.7.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-25 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies: []
 description: Fast and flexible JSON serializer
 email:
@@ -34,6 +34,7 @@ files:
 - lib/alba/many.rb
 - lib/alba/one.rb
 - lib/alba/resource.rb
+- lib/alba/resources/default_resource.rb
 - lib/alba/serializer.rb
 - lib/alba/serializers/default_serializer.rb
 - lib/alba/version.rb