alba 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4622052b8c6338ea135b98dd3376c8fdd51765b74fa51113edbfdc5afd17d58
-  data.tar.gz: eaddf9d21c440dc8385a5afa425b9c02b327e9537544c7772216898af48d6603
+  metadata.gz: 115b71c658fcda000dd3e4d4ccc0306c3cf94033f42fd96eb8e26223cba1ed3a
+  data.tar.gz: 8c9f023c9d60c905c35b6f285120f6de536b4a21258fdf42b867a5601c2162d6
 SHA512:
-  metadata.gz: cf931c28818461efff56c8e7b72a83157952bd464695e037ca3214a7aeb758c89b48b7ffe612016305c3087194a98c08b91944e4d993c0aa28ce6d5907208da6
-  data.tar.gz: f30ffac69df4a39fcbcabe838165cff348dbe01c1d8f8f8c48930d0c3898ac5b60574d80f891434f3a92438d4e079043288d9f5d1b425b867adbb6e371ee55f1
+  metadata.gz: 66bc3c85b71f412c761629a6eae760c038115edd826e1d2cc34d204e2cdb4164ababdc31fc3f9569eb89ea51d364176cfd2a53b9ffbfb995fb3daeada1c110e3
+  data.tar.gz: 6f8b53f011829b941ea6ebb6237f96f52dbc7cd36042db6cab996c7e4a4a3ead931f3801243c64be6f7c60f8d144cb85d5beea62f020f95e6d1bc3585bbadd1b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alba (0.3.0)
+    alba (0.4.0)
 
 GEM
   remote: https://rubygems.org/

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,64 @@ 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"}]}'
+```
+
+## 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,7 @@
 require 'alba/version'
+require 'alba/serializers/default_serializer'
+require 'alba/serializer'
 require 'alba/resource'
-require 'json'
 
 # Core module
 module Alba
@@ -15,17 +16,6 @@ module Alba
   end
 
   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)
+    Serializers::DefaultSerializer.new(object).serialize
   end
 end

data/lib/alba/serializer.rb

@@ -17,12 +17,15 @@ module Alba
       end
 
       def serialize
-        fallback = -> { @_resource.to_json }
+        fallback = lambda do
+          require 'json'
+          JSON.dump(@_resource)
+        end
         case Alba.backend
         when :oj
           begin
             require 'oj'
-            -> { Oj.dump(@_resource) }
+            -> { Oj.dump(@_resource, 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.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies: []
 description: Fast and flexible JSON serializer
 email: