alba 0.0.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a21e18114f54b4039fc354a92a248e3bb6d1d67680c086d8d7827ef201ffec0
-  data.tar.gz: 507160ee7625df8bfb18955cca17b1eef804be1783ce4c61fac8f383eeac6301
+  metadata.gz: 89b4df7ce18a63e20cee9e87bd2855ef9c4735c4f6e4e1ef55433c5ba0a2fbd0
+  data.tar.gz: 63fa94fa17cdf3f5bfeef5f2e7b0d6efeec1fd06ad8d5386fb389fea3db0343a
 SHA512:
-  metadata.gz: e97a450e7cbfaea63a048d20c396b6abfaae1cc55957e2e07cc1170fe4be5cc4174d807c1c398fb2534d120e9c3fa0cbb6f8cc9dd5c7026ddb448577a66ddf0f
-  data.tar.gz: '08e02980bbe0ae8c9dc355f483399a87b120c3817bb3d7ddbfaec4ccd584c76d08825bca81088a3004636b14373d675c3ca861ce82fd41efabc0669b1ab701f8'
+  metadata.gz: 063d913715faa3917df5658d798ceb1619b9a2aef1dc0875c92c1592b3d3f9025bec60a364ebe0d54fb0769e18ba78f5786caa288159d304dfeca7ab00149d2b
+  data.tar.gz: 66aed62d355cd6fd8527ad4da27c53c9c42bf98606586a562b84dc377e6041125653d9669cf77c14427b4a1796b6c7abd7e6b2861323bac51fde28bfe05a7e7a

data/.rubocop.yml

@@ -10,6 +10,7 @@ AllCops:
   Exclude:
     - 'Rakefile'
     - 'alba.gemspec'
+  NewCops: enable
 
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
@@ -17,5 +18,10 @@ Layout/SpaceInsideHashLiteralBraces:
 Metrics/MethodLength:
   Max: 20
 
+Naming/PredicateName:
+  AllowedMethods:
+    - 'has_one'
+    - 'has_many'
+
 Style/FrozenStringLiteralComment:
   Enabled: false

data/Gemfile

@@ -3,8 +3,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in alba.gemspec
 gemspec
 
+gem 'coveralls', require: false
 gem 'minitest', '~> 5.0'
 gem 'rake', '~> 13.0'
 gem 'rubocop', '>= 0.79.0', require: false
-gem 'rubocop-performance', '~> 1.5.0', require: false
+gem 'rubocop-performance', '~> 1.7.1', require: false
 gem 'rubocop-sensible', '~> 0.3.0', require: false

data/Gemfile.lock

@@ -1,42 +1,67 @@
 PATH
   remote: .
   specs:
-    alba (0.0.1)
+    alba (0.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    jaro_winkler (1.5.4)
-    minitest (5.14.0)
-    parallel (1.19.1)
-    parser (2.7.0.2)
-      ast (~> 2.4.0)
+    ast (2.4.1)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    docile (1.3.2)
+    json (2.3.1)
+    minitest (5.14.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.88.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
     rubocop-sensible (0.3.0)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.25.0)
+      sync
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   alba!
+  coveralls
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (>= 0.79.0)
-  rubocop-performance (~> 1.5.0)
+  rubocop-performance (~> 1.7.1)
   rubocop-sensible (~> 0.3.0)
 
 BUNDLED WITH

data/README.md

@@ -1,6 +1,10 @@
+[![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)
+
 # Alba
 
-`Alba` is a fast and flexible JSON serializer.
+`Alba` is a stupid, fast and easy to use JSON serializer.
 
 ## Installation
 
@@ -20,15 +24,115 @@ Or install it yourself as:
 
 ## Usage
 
+### Simple serialization with key
+
 ```ruby
-# If you don't bundle 'oj', that's file
-Alba.serialize({foo: 42}) # => '{"foo":42}'
+class User
+  attr_accessor :id, :name, :email, :created_at, :updated_at
+  def initialize(id, name, email)
+    @id = id
+    @name = name
+    @email = email
+    @created_at = Time.now
+    @updated_at = Time.now
+  end
+end
+
+class UserResource
+  include Alba::Resource
+
+  attributes :id, :name
+
+  attribute :name_with_email do |resource|
+    "#{resource.name}: #{resource.email}"
+  end
+end
+
+class SerializerWithKey
+  include Alba::Serializer
+
+  set key: :user
+end
+
+user = User.new(1, 'Masafumi OKURA', 'masafumi@example.com')
+UserResource.new(user).serialize
+# => "{\"id\":1,\"name\":\"Masafumi OKURA\",\"name_with_email\":\"Masafumi OKURA: masafumi@example.com\"}"
+```
+
+### Serialization with associations
 
-# bundle 'oj' in your Gemfile, then
-Alba.backend = :oj
-Alba.serialize({foo: 42}) # => '{"foo":42}'
+```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,30 +1,32 @@
 require 'alba/version'
-require 'json'
+require 'alba/serializers/default_serializer'
+require 'alba/serializer'
+require 'alba/resource'
+require 'alba/resources/default_resource'
 
 # Core module
 module Alba
   class Error < StandardError; end
 
-  def self.backend=(backend)
-    @backend = backend&.to_sym
-  end
+  class << self
+    attr_reader :backend
 
-  def self.backend
-    @backend
-  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)
+      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/attribute.rb

@@ -0,0 +1,19 @@
+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

data/lib/alba/many.rb

@@ -0,0 +1,26 @@
+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
+
+    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

@@ -0,0 +1,26 @@
+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
+
+    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

@@ -0,0 +1,91 @@
+require 'alba/serializer'
+require 'alba/attribute'
+require 'alba/one'
+require 'alba/many'
+require 'alba/serializers/default_serializer'
+
+module Alba
+  # This module represents what should be serialized
+  module Resource
+    DSLS = [:_attributes, :_serializer].freeze
+    def self.included(base)
+      base.class_eval do
+        # Initialize
+        DSLS.each do |name|
+          initial = name == :_serializer ? nil : {}
+          instance_variable_set("@#{name}", initial) unless instance_variable_defined?("@#{name}")
+        end
+      end
+      base.include InstanceMethods
+      base.extend ClassMethods
+    end
+
+    # Instance methods
+    module InstanceMethods
+      def initialize(resource)
+        @_resource = resource
+        DSLS.each { |name| instance_variable_set("@#{name}", self.class.public_send(name)) }
+      end
+
+      def serialize(with: nil)
+        serializer = case 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
+      end
+
+      def serializable_hash
+        @_attributes.transform_values do |attribute|
+          attribute.to_hash(@_resource)
+        end
+      end
+      alias to_hash serializable_hash
+
+      private
+
+      def inline_extended_serializer(with)
+        klass = ::Alba::Serializers::DefaultSerializer.clone
+        klass.class_eval(&with)
+        klass
+      end
+    end
+
+    # Class methods
+    module ClassMethods
+      attr_accessor(*DSLS)
+
+      def inherited(subclass)
+        DSLS.each { |name| subclass.public_send("#{name}=", instance_variable_get("@#{name}")) }
+      end
+
+      def attributes(*attrs)
+        attrs.each { |attr_name| @_attributes[attr_name] = Attribute.new(name: attr_name, method: 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)
+      end
+
+      def one(name, resource: nil, &block)
+        @_attributes[name.to_sym] = One.new(name: name, resource: resource, &block)
+      end
+
+      def many(name, resource: nil, &block)
+        @_attributes[name.to_sym] = Many.new(name: name, resource: resource, &block)
+      end
+
+      def serializer(name)
+        @_serializer = name <= Alba::Serializer ? name : nil
+      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

@@ -0,0 +1,48 @@
+module Alba
+  # This module represents how a resource should be serialized.
+  #
+  module Serializer
+    def self.included(base)
+      base.include InstanceMethods
+      base.extend ClassMethods
+    end
+
+    # Instance methods
+    module InstanceMethods
+      def initialize(resource)
+        @_resource = resource
+        @_opts = self.class._opts || {}
+        key = @_opts[:key]
+        @_resource = {key.to_sym => @_resource} if key
+      end
+
+      def serialize
+        fallback = lambda do
+          require 'json'
+          JSON.dump(@_resource)
+        end
+        case Alba.backend
+        when :oj
+          begin
+            require 'oj'
+            -> { Oj.dump(@_resource, mode: :strict) }
+          rescue LoadError
+            fallback
+          end
+        else
+          fallback
+        end.call
+      end
+    end
+
+    # Class methods
+    module ClassMethods
+      attr_reader :_opts
+
+      def set(key: false)
+        @_opts ||= {}
+        @_opts[:key] = key
+      end
+    end
+  end
+end

data/lib/alba/serializers/default_serializer.rb

@@ -0,0 +1,11 @@
+require 'alba/serializer'
+
+module Alba
+  module Serializers
+    # DefaultSerializer class is used when a user doesn't specify serializer opt.
+    # It's basically an alias of Alba::Serializer, but since it's a module this class simply include it.
+    class DefaultSerializer
+      include Alba::Serializer
+    end
+  end
+end

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/sider.yml

@@ -0,0 +1,60 @@
+linter:
+# # https://help.sider.review/getting-started/custom-configuration
+
+#   # https://help.sider.review/tools/ruby/rubocop
+  rubocop:
+    gems:
+      - "rubocop-performance"
+      - "rubocop-sensible"
+    safe: false
+
+#   # https://help.sider.review/tools/ruby/reek
+#   reek:
+#     gems:
+#       - name: "reek"
+#         version: "5.2.0"
+#     target:
+#       - lib/
+#       - test/
+#     config: config/.reek.yml
+
+#   # https://help.sider.review/tools/ruby/querly
+#   querly:
+#     gems:
+#       - "slim"
+
+#   # https://help.sider.review/tools/others/misspell
+#   misspell:
+#     exclude:
+#       - vendor
+#       - "**/*.min.js"
+#       - exclude_file.rb
+#     targets:
+#       - target_directory
+#       - another_target_directory/foo.rb
+#       - bar.rb
+#     locale: UK
+#     ignore: center,behavior
+
+#   # https://help.sider.review/tools/shellscript/shellcheck
+#   shellcheck:
+#     target: "src/**/*.{sh,bash}"
+#     include: "SC2104,SC2105"
+#     exclude: "SC1000,SC1118"
+#     enable: "all"
+#     shell: "bash"
+#     severity: "error"
+#     norc: true
+
+# # https://help.sider.review/getting-started/custom-configuration#ignore
+# ignore:
+#   - "*.pdf"
+#   - "*.mp4"
+#   - "images/**"
+
+# # https://help.sider.review/getting-started/custom-configuration#branchesexclude
+# branches:
+#   exclude:
+#     - master
+#     - development
+#     - /^release-.*$/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.5.0
 platform: ruby
 authors:
 - OKURA Masafumi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-07-30 00:00:00.000000000 Z
 dependencies: []
 description: Fast and flexible JSON serializer
 email:
@@ -30,7 +30,15 @@ files:
 - bin/console
 - bin/setup
 - lib/alba.rb
+- lib/alba/attribute.rb
+- 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
+- sider.yml
 homepage: https://github.com/okuramasafumi/alba
 licenses:
 - MIT
@@ -38,7 +46,7 @@ metadata:
   homepage_uri: https://github.com/okuramasafumi/alba
   source_code_uri: https://github.com/okuramasafumi/alba
   changelog_uri: https://github.com/okuramasafumi/alba/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,8 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Fast and flexible JSON serializer
 test_files: []