o-serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20456000ece5bd3ea6f400d9d1c8dbdaab293a35b935af7f3b0212a1717f826a
+  data.tar.gz: 94bac97ed93fddaead4b3fccf450d0aed4cbd6913bb99533a82ffa362ead40bf
+SHA512:
+  metadata.gz: 5b50edf922a3461ae00288f3c669f9774aeff476165a4bcb4e4d257ea75aec404dcf4726d9a5a86eb5e7d1344deaad9ffd8490c852620ce2021381489c285b7a
+  data.tar.gz: 837b7bad46345a621847f7a9a98ba5aa761f2964e69bd4cc6cde2abe74d6da4212c80e956ca1c28c423fc70318d7d627f50eee0c863d5b6fb100453f7a0401bc

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in o-serializer.gemspec
+gemspec
+
+gem 'pry'
+gem 'active_model_serializers'
+gem 'fast_jsonapi'
+gem 'benchmark-ips'

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    o-serializer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    active_model_serializers (0.10.7)
+      actionpack (>= 4.1, < 6)
+      activemodel (>= 4.1, < 6)
+      case_transform (>= 0.2)
+      jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    benchmark-ips (2.7.2)
+    builder (3.2.3)
+    case_transform (0.2)
+      activesupport
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    diff-lcs (1.3)
+    erubi (1.7.0)
+    fast_jsonapi (1.0.17)
+      activerecord (~> 5.0)
+      activesupport (~> 5.0)
+      multi_json (~> 1.12)
+      oj (~> 3.3)
+    i18n (0.9.4)
+      concurrent-ruby (~> 1.0)
+    jsonapi-renderer (0.2.0)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    oj (3.4.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.4)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_model_serializers
+  benchmark-ips
+  bundler (~> 1.16)
+  fast_jsonapi
+  o-serializer!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,121 @@
+# O::Serializer
+
+OO-based data serialization library
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'o-serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install o-serializer
+
+## Usage
+
+Every `O` object responds to `.call`, that's a convention.
+
+1. Basic Usage
+
+``` ruby
+User = Struct.new(:email, :password)
+
+UserSerializer = O::Serializer[
+  email: O::Field[:email],
+  password: O::Field[:password]
+]
+
+UserSerializer.call(User.new('one', 'two'))
+# => { email: 'one', password: 'two' }
+```
+
+2. Shortcut `O::PlainFields`
+
+``` ruby
+UserSerializer = O::Serializer[
+  **O::PlainFields[:email, :password]
+]
+# => exactly the same behavior, works through 'to_hash' method
+```
+
+3. Collections
+
+``` ruby
+ProfileSerializer = O::Serializer[
+  name: O::Field[:name]
+]
+
+profiles = [...]
+
+O::Many[ProfileSerializer].call(users)
+# => [ { ... }, { ... }, ...]
+```
+
+`O::Many` can be use to define associations.
+
+``` ruby
+UserSerializer = O::Serializer[
+  tags: O::Many[TagSerializer]
+]
+```
+
+4. Keys transformation
+
+``` ruby
+require 'ostruct'
+
+user = OpenStruct.new(
+  :active? => true,
+  __tags: [OpenStruct.new(value: 'tag1')]
+)
+
+TagSerializer = O::Serializer[**O::PlainFields[:value]]
+
+UserSerializer = O::Serializer[
+  is_active: O::Field[:active?],
+  tags: O::From[:__tags, O::Many[TagSerializer]]
+]
+
+UserSerializer.call(user)
+# => {:is_active=>true, :tags=>[{:value=>"tag1"}]}
+```
+
+## Benchmarks
+
+See `benchmark/run.rb`
+
+```
+Warming up --------------------------------------
+            #to_hash    12.722k i/100ms
+       O::Serializer     4.425k i/100ms
+                 AMS   330.000  i/100ms
+        fast_jsonapi     4.323k i/100ms
+Calculating -------------------------------------
+            #to_hash    139.382k (± 6.5%) i/s -    699.710k in   5.042120s
+       O::Serializer     46.346k (± 4.5%) i/s -    234.525k in   5.071141s
+                 AMS      3.359k (± 3.3%) i/s -     16.830k in   5.015951s
+        fast_jsonapi     44.541k (± 4.5%) i/s -    224.796k in   5.057236s
+
+Comparison:
+            #to_hash:   139381.5 i/s
+       O::Serializer:    46346.3 i/s - 3.01x  slower
+        fast_jsonapi:    44540.7 i/s - 3.13x  slower
+                 AMS:     3359.0 i/s - 41.49x  slower
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/o-serializer.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/benchmark/run.rb

@@ -0,0 +1,177 @@
+require 'bundler/setup'
+
+require 'o/serializer'
+require 'active_model_serializers'
+require 'fast_jsonapi'
+require 'benchmark/ips'
+
+class User
+  include ActiveModel::Model
+  include ActiveModel::Serialization
+
+  attr_accessor :id, :email, :password, :profile, :tags
+
+  def active?
+    true
+  end
+
+  def to_hash
+    {
+      id: id,
+      is_active: active?,
+      email: email,
+      profile: profile ? profile.to_hash : nil,
+      tags: tags.map(&:to_hash)
+    }
+  end
+
+  # FastJsonapi doesn't support custom methods
+  def is_active
+    active?
+  end
+
+  # FastJsonapi uses FKs for optimizations
+  def profile_id
+    profile.id if profile
+  end
+
+  def tag_ids
+    tags.map(&:id)
+  end
+end
+
+class Profile
+  include ActiveModel::Model
+  include ActiveModel::Serialization
+
+  attr_accessor :id, :first_name, :last_name
+
+  def avatar
+    "https://example.com/#{first_name}-#{last_name}.png"
+  end
+
+  def to_hash
+    {
+      first_name: first_name,
+      last_name: last_name,
+      avatar: avatar
+    }
+  end
+end
+
+class Tag
+  include ActiveModel::Model
+  include ActiveModel::Serialization
+
+  attr_accessor :id, :name
+
+  def to_hash
+    {
+      name: name
+    }
+  end
+end
+
+tag1 = Tag.new(id: 1, name: 'tag1')
+tag2 = Tag.new(id: 2, name: 'tag2')
+tag3 = Tag.new(id: 3, name: 'tag3')
+
+profile1 = Profile.new(id: 1, first_name: 'fname1', last_name: 'lname1')
+profile2 = Profile.new(id: 2, first_name: 'fname2')
+
+user1 = User.new(email: 'email1', profile: profile1, tags: [tag1, tag2])
+user2 = User.new(email: 'email2', profile: profile2, tags: [tag2, tag3])
+user3 = User.new(email: 'email3', profile: nil, tags: [], id: 'ID')
+
+users = [user1, user2, user3]
+
+module O
+  TagSerializer = O::Serializer.new(
+    name: O::Field[:name]
+  )
+
+  ProfileSerializer = O::Serializer.new(
+    **O::PlainFields[
+      :first_name,
+      :last_name,
+      :avatar
+    ]
+  )
+
+  UserSerializer = O::Serializer.new(
+    id: ->(user) { user.id },
+    is_active: O::Field[:active?],
+    email: O::Field[:email],
+    profile: O::From[:profile, ProfileSerializer],
+    tags: O::From[:tags, O::Many[TagSerializer]]
+  )
+end
+
+module AMS
+  class TagSerializer < ActiveModel::Serializer
+    attributes :name
+  end
+
+  class ProfileSerializer < ActiveModel::Serializer
+    attributes :first_name, :last_name, :avatar
+  end
+
+  class UserSerializer < ActiveModel::Serializer
+    attributes :id, :is_active, :email
+
+    has_one :profile, serializer: ProfileSerializer
+    has_many :tags, serializer: TagSerializer
+
+    def is_active
+      object.active?
+    end
+  end
+end
+
+module FastJsonApi
+  class TagSerializer
+    include FastJsonapi::ObjectSerializer
+    attributes :name
+  end
+
+  class ProfileSerializer
+    include FastJsonapi::ObjectSerializer
+    attributes :first_name, :last_name, :avatar
+  end
+
+  class UserSerializer
+    include FastJsonapi::ObjectSerializer
+
+    attributes :id, :is_active, :email
+
+    has_one :profile, serializer: ProfileSerializer
+    has_many :tags, serializer: TagSerializer
+  end
+end
+
+Benchmark.ips do |x|
+  x.config time: 5, warmup: 2
+
+  x.report '#to_hash' do
+    users.map(&:to_hash)
+  end
+
+  x.report 'O::Serializer' do
+    O::Many[O::UserSerializer].call(users)
+  end
+
+  x.report 'AMS' do
+    ActiveModel::Serializer::CollectionSerializer.new(users, serializer: AMS::UserSerializer).as_json
+  end
+
+  x.report 'fast_jsonapi' do
+    FastJsonApi::UserSerializer.new(users).serializable_hash
+  end
+
+  x.compare!
+end
+
+# p users.map(&:to_hash)
+# p O::Many[O::UserSerializer].call(users)
+# p ActiveModel::Serializer::CollectionSerializer.new(users, serializer: AMS::UserSerializer).as_json
+# p FastJsonApi::UserSerializer.new(users).serializable_hash

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "o/serializer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/o/serializer.rb

@@ -0,0 +1,83 @@
+require "o/serializer/version"
+
+module O
+  module ArefShortcut
+    def [](*args)
+      new(*args)
+    end
+  end
+
+  READ = ->(object, key) {
+    object.respond_to?(:read_attribute_for_serialization) ?
+      object.read_attribute_for_serialization(key) :
+      object.public_send(key)
+  }
+
+  class Serializer
+    extend ArefShortcut
+
+    def initialize(fields)
+      @fields = fields
+    end
+
+    def call(object)
+      return nil if object.nil?
+      @fields
+        .map { |key, field| [key, field.call(object)] }
+        .to_h
+    end
+  end
+
+  class Field
+    extend ArefShortcut
+
+    def initialize(key)
+      @key = key
+    end
+
+    def call(object)
+      return nil if object.nil?
+      READ[object, @key]
+    end
+  end
+
+  class Many
+    extend ArefShortcut
+
+    def initialize(serializer)
+      @serializer = serializer
+    end
+
+    def call(collection)
+      collection.map { |item| @serializer.call(item) }
+    end
+  end
+
+  class PlainFields
+    extend ArefShortcut
+
+    def initialize(*keys)
+      @keys = keys
+    end
+
+    def to_hash
+      @keys
+        .map { |key| [key, Field[key]] }
+        .to_h
+    end
+  end
+
+  class From
+    extend ArefShortcut
+
+    def initialize(key, serializer)
+      @key = key
+      @serializer = serializer
+    end
+
+    def call(object)
+      return nil if object.nil?
+      @serializer.call(READ[object, @key])
+    end
+  end
+end

data/lib/o/serializer/version.rb

@@ -0,0 +1,5 @@
+module O
+  class Serializer
+    VERSION = "0.1.0"
+  end
+end

data/o-serializer.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "o/serializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "o-serializer"
+  spec.version       = O::Serializer::VERSION
+  spec.authors       = ["Ilya Bylich"]
+  spec.email         = ["ibylich@gmail.com"]
+
+  spec.summary       = %q{o-serializer}
+  spec.description   = %q{o-serializer}
+  spec.homepage      = "https://github.com/iliabylich/o-serializer"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: o-serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ilya Bylich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: o-serializer
+email:
+- ibylich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- benchmark/run.rb
+- bin/console
+- bin/setup
+- lib/o/serializer.rb
+- lib/o/serializer/version.rb
+- o-serializer.gemspec
+homepage: https://github.com/iliabylich/o-serializer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: o-serializer
+test_files: []