fast_serializer_ruby 0.2.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4226b5f0bc68c749226425f93db90d60bfe5b0cba0faa74a77e9cfd24680a73b
-  data.tar.gz: 697304fc0c88cdd9848c974027689c5eb4a0f90daa3e95fb4c2d2e723ceb8040
+  metadata.gz: 8d8ad37dfcd016a3db647dd533569d8d9f70850eb2bf6fe825867175eb9b6dc2
+  data.tar.gz: cf9225cb0900f487bbe5b066127dfde74aec433e79eddc9303d008b4242f30f4
 SHA512:
-  metadata.gz: ad76357998ec5b0de5768057e6dd6191f4cc8f7eba5dfc9170206245570ad725ba822f1bbf5d35dfed5364227f6dd28130aaadc70717158f42d80d906f76f98b
-  data.tar.gz: 2a43e81fe55e7d4a8dd56b56a489030d38f4d810564b332ee0f965b0d16b3152622a5aab97779dfa45b8cfe276640b16da6fd1eb7c81c4a629bbb82939ab6e05
+  metadata.gz: b2168332398602023551252abc1d458cf3f37d1449d80a701ac316bd44d2270381e8cd70e72dc2aa52e54c4701167f1d4f30050be8a059822158d1de438bd285
+  data.tar.gz: 396590ae7497cc7eae403cf7db3f0a6a6045cefb833442ddfc750ad34077a8bdbf1d7ed9056d011b31af20b9d8e90d3fd402c46b6ae3a78735f34d441961ed99

data/.gitignore

@@ -12,3 +12,6 @@
 # rspec failure tracking
 .rspec_status
 .rspec
+.history
+/.vscode
+.rubocop.yml

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
   - jruby-9.2.0.0
   - ruby-head
   - jruby-head
@@ -18,7 +19,8 @@ matrix:
     - rvm: jruby-head
 
 before_install:
-  - gem update --system -N
+  - yes | gem update --system --force
+  - gem install bundler
 
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
@@ -34,5 +36,5 @@ cache: bundler
 
 env:
   global:
-    CC_TEST_REPORTER_ID=a051d3d3560aa2e58cc5efb9f7b8eaafe87f983a1c4d6cb1573fda50ede5b685
+    CC_TEST_REPORTER_ID=99325a42b78ef51a9d51574d20dbcd6acdfe75c8568f1433f73b61f17149e05d
     COVERAGE=1

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at evgeny.stepanov@jetruby.com. All
+reported by contacting the project team at estepnv@icloud.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/Gemfile

@@ -4,5 +4,22 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in fast_serializer.gemspec
 gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'pry'
+end
+
+group :test do
+  gem 'active_model_serializers', '~> 0.10.0'
+  gem 'factory_bot'
+  gem 'faker'
+  gem 'activesupport', '< 6'
+  gem 'allocation_stats'
+  gem 'simplecov', '~> 0.17.1'
+  gem 'benchmark-memory', '~> 0.1'
+  gem 'rspec', '~> 3.0'
+  gem 'rspec-benchmark'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    fast_serializer_ruby (0.2.0)
+    fast_serializer_ruby (0.6.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
-      rack (~> 2.0)
+    actionpack (5.2.4.1)
+      actionview (= 5.2.4.1)
+      activesupport (= 5.2.4.1)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
+    actionview (5.2.4.1)
+      activesupport (= 5.2.4.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
@@ -24,44 +24,49 @@ GEM
       activemodel (>= 4.1, < 6.1)
       case_transform (>= 0.2)
       jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activesupport (5.2.3)
+    activemodel (5.2.4.1)
+      activesupport (= 5.2.4.1)
+    activesupport (5.2.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    benchmark-malloc (0.1.0)
-    benchmark-perf (0.5.0)
-    benchmark-trend (0.3.0)
-    builder (3.2.3)
+    allocation_stats (0.1.5)
+    benchmark-malloc (0.2.0)
+    benchmark-memory (0.1.2)
+      memory_profiler (~> 0.9)
+    benchmark-perf (0.6.0)
+    benchmark-trend (0.4.0)
+    builder (3.2.4)
+    byebug (11.1.3)
     case_transform (0.2)
       activesupport
     coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    crass (1.0.5)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
     diff-lcs (1.3)
     docile (1.3.2)
     erubi (1.9.0)
     factory_bot (5.1.1)
       activesupport (>= 4.2.0)
-    faker (2.6.0)
-      i18n (>= 1.6, < 1.8)
-    ffi (1.11.1-java)
-    i18n (1.7.0)
+    faker (2.10.2)
+      i18n (>= 1.6, < 2)
+    ffi (1.12.2-java)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    json (2.2.0)
-    json (2.2.0-java)
+    json (2.3.0)
+    json (2.3.0-java)
     jsonapi-renderer (0.2.2)
-    loofah (2.3.1)
+    loofah (2.4.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
+    memory_profiler (0.9.14)
     method_source (0.9.2)
     mini_portile2 (2.4.0)
-    minitest (5.12.2)
-    nokogiri (1.10.5)
+    minitest (5.14.0)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    nokogiri (1.10.5-java)
+    nokogiri (1.10.9-java)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -69,7 +74,10 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
       spoon (~> 0.0)
-    rack (2.0.7)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -77,25 +85,25 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-benchmark (0.5.1)
-      benchmark-malloc (~> 0.1.0)
-      benchmark-perf (~> 0.5.0)
-      benchmark-trend (~> 0.3.0)
-      rspec (>= 3.0.0, < 4.0.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rspec-benchmark (0.6.0)
+      benchmark-malloc (~> 0.2)
+      benchmark-perf (~> 0.6)
+      benchmark-trend (~> 0.4)
+      rspec (>= 3.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+    rspec-support (3.9.2)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -105,7 +113,7 @@ GEM
       ffi
     thread_safe (0.3.6)
     thread_safe (0.3.6-java)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -115,14 +123,17 @@ PLATFORMS
 DEPENDENCIES
   active_model_serializers (~> 0.10.0)
   activesupport (< 6)
+  allocation_stats
+  benchmark-memory (~> 0.1)
   factory_bot
   faker
   fast_serializer_ruby!
   pry
-  rake (~> 10.0)
+  pry-byebug
+  rake
   rspec (~> 3.0)
   rspec-benchmark
-  simplecov
+  simplecov (~> 0.17.1)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Evgeny Stepanov
+Copyright (c) 2020 Evgeny Stepanov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,16 +1,25 @@
+[![Gem Version](https://badge.fury.io/rb/fast_serializer_ruby.svg)](https://badge.fury.io/rb/fast_serializer_ruby)
 [![Build Status](https://travis-ci.org/estepnv/fast_serializer.svg?branch=master)](https://travis-ci.org/estepnv/fast_serializer)
-[![Maintainability](https://api.codeclimate.com/v1/badges/74cca93390234e619cf5/maintainability)](https://codeclimate.com/github/estepnv/fast_serializer/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/74cca93390234e619cf5/test_coverage)](https://codeclimate.com/github/estepnv/fast_serializer/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/df7897bec85d376709bd/maintainability)](https://codeclimate.com/github/estepnv/fast_serializer/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/df7897bec85d376709bd/test_coverage)](https://codeclimate.com/github/estepnv/fast_serializer/test_coverage)
 
 # fast_serializer
 
-fast_serializer is a lightweight ruby objects serializer. 
+`fast_serializer_ruby` is a lightweight ruby object to hash transformer.
+This library intends to solve such a typical and on the other hand important problem as efficient ruby object to hash transformation.
 
-It has zero dependencies and written in pure ruby.
-That's why it's so performant.
+## Performance 🚀
+- running on ruby 2.7 is **at least 6 times faster** than AMS (benchmarks was borrowed from fast_jsonapi repository)
+- running on ruby 2.7 it consumes **6 times less RAM**
+- running on jruby 9.2.7.0 **is at least 4 times faster** than AMS after warming up
 
-- running on ruby 2.6 is **at least 3 times faster** than AMS (benchmarks was borrowed from fast_jsonapi repository)
-- running on jruby 9.2.7.0 **is at least 15 times faster** than AMS after warming up
+## Compatibility 👌
+I tried to keep the API as close as possible to active_model_serializer implementation because we all got used to it.
+
+## Features
+- conditional rendering
+- inheritence
+- included/excluded associations
 
 
 ## Installation
@@ -18,7 +27,7 @@ That's why it's so performant.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'fast_serializer'
+gem 'fast_serializer_ruby'
 ```
 
 And then execute:
@@ -27,38 +36,43 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install fast_serializer
+    $ gem install fast_serializer_ruby
 
 ## Usage
 
-fast_serializer supports default schema definition using class methods
+`fast_serializer` supports default schema definition using class methods
 
 ```ruby
 class ResourceSerializer
   include FastSerializer::Schema::Mixin
+
   root :resource
-  
+
   attributes :id, :email, :phone
-  
-  attribute(:string_id, if: -> (resource, params) { params[:stringify] }) { |resource, params| resource.id.to_s }
-  attribute(:float_id, unless: -> (resource, params) { params[:stringify] }) { |resource, params| resource.id.to_f }
-  attribute(:full_name) { |resource, params| params[:only_first_name] ? resource.first_name : "#{resource.first_name} #{resource.last_name}" }
-  
+
+  attribute(:string_id, if: -> { params[:stringify] }) { resource.id.to_s }
+  attribute(:float_id, unless: :stringify?) { object.id.to_f }
+  attribute(:full_name) { params[:only_first_name] ? resource.first_name : "#{resource.first_name} #{resource.last_name}" }
+
   has_one :has_one_relationship, serializer: ResourceSerializer
   has_many :has_many_relationship, serializer: ResourceSerializer
+
+  def stringify?
+    params[:stringify]
+  end
 end
 
-ResourceSerializer.new(resource, meta: {foo: "bar"}, only_first_name: false, stringify: true).serializable_hash
+ResourceSerializer.new(resource, meta: {foo: "bar"}, only_first_name: false, stringify: true, exclude: [:has_many_relationship]).serializable_hash
 => {
      :resource => {
-       :id => 7873392581, 
-       :email => "houston@luettgen.info", 
-       :full_name => "Jamar Graham", 
-       :phone => "627.051.6039 x1475", 
+       :id => 7873392581,
+       :email => "houston@luettgen.info",
+       :full_name => "Jamar Graham",
+       :phone => "627.051.6039 x1475",
        :has_one_relationship => {
-         :id => 6218322696, 
-         :email=>"terrellrobel@pagac.info", 
-         :full_name => "Clay Kuphal", 
+         :id => 6218322696,
+         :email=>"terrellrobel@pagac.info",
+         :full_name => "Clay Kuphal",
          :phone => "1-604-682-0732 x882"
        }
      },
@@ -80,14 +94,14 @@ schema.has_one(:has_one_relationship, schema: schema)
 
 schema.serializable_hash
 => {
-     :id => 7873392581, 
-     :email => "houston@luettgen.info", 
-     :full_name => "Jamar Graham", 
-     :phone => "627.051.6039 x1475", 
+     :id => 7873392581,
+     :email => "houston@luettgen.info",
+     :full_name => "Jamar Graham",
+     :phone => "627.051.6039 x1475",
      :has_one_relationship => {
-       :id => 6218322696, 
-       :email=>"terrellrobel@pagac.info", 
-       :full_name => "Clay Kuphal", 
+       :id => 6218322696,
+       :email=>"terrellrobel@pagac.info",
+       :full_name => "Clay Kuphal",
        :phone => "1-604-682-0732 x882"
      }
    }
@@ -101,8 +115,6 @@ schema.serializable_hash
 
 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/estepnv/fast_serializer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/fast_serializer.gemspec

@@ -10,10 +10,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Evgeny Stepanov']
   spec.email         = ['estepnv@icloud.com']
 
-  spec.summary       = 'Yet another serializer gem, but fast'
-  spec.description   = 'fast_serializer is a lightweight ruby objects serializer.'
+  spec.summary       = 'fast_serializer is a lightweight ruby objects serializer.'
+  spec.description   = 'This library intends to solve such a typical and on the other hand important problem as efficient ruby object to hash transformation.'
   spec.homepage      = 'https://github.com/estepnv/fast_serializer'
   spec.license       = 'MIT'
+  spec.platform      = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.3.0'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -31,17 +33,8 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{(test|spec|features|git|rspec|travis)/}) }
   end
-  spec.bindir        = 'exe'
+
+  spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'active_model_serializers', '~> 0.10.0'
-  spec.add_development_dependency 'activesupport', '<6'
-  spec.add_development_dependency 'factory_bot'
-  spec.add_development_dependency 'faker'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec-benchmark'
-  spec.add_development_dependency 'simplecov'
 end

data/lib/fast_serializer.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require 'fast_serializer/version'
+require 'fast_serializer/utils'
 require 'fast_serializer/configuration'
 require 'fast_serializer/json_model'
 require 'fast_serializer/schema'
+require 'fast_serializer/schema/mixin'
 
 module FastSerializer
   class Error < StandardError; end
-  # Your code goes here...
 end

data/lib/fast_serializer/configuration.rb

@@ -1,17 +1,29 @@
 # frozen_string_literal: true
 
+require 'json'
+
 module FastSerializer
   class Configuration
-    attr_accessor :coder
+    attr_reader :coder
+    attr_accessor :strict
 
     def initialize
       @coder = JSON
+      @strict = false
+    end
+
+    def coder=(obj)
+      unless obj.respond_to?(:dump) && obj.respond_to?(:load)
+        raise ArgumentError, 'must respond to #load and #dump methods'
+      end
+
+      @coder = obj
     end
   end
 
   class << self
     def config
-      @_config ||= Configuration.new
+      @config ||= Configuration.new
     end
 
     def configure(&block)