panko_serializer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30e3e534552c9c7592b512b679460e53de9eae33
+  data.tar.gz: a0a70502582161816691ba9aaa327ed17695bf8c
+SHA512:
+  metadata.gz: 26d0cf119bad48ec684ce49fc8c6413d3a35e976ca135c96d37d7d6e738f19f00f23225195873289bfa5aff3f6059c27bb8bf54fd3f881d75c3e57b4b3da6847
+  data.tar.gz: d55cb3c5e156c2f4d64ac67ac9429328d3476944876cdfe4a41ef0b149bd78a636b229061d9648d5a0a9eb3eca79ea68000ab0a6f7ca9d0b472be9163b546903

data/.clang-format

@@ -0,0 +1,102 @@
+---
+Language:        Cpp
+# BasedOnStyle:  Chromium
+AccessModifierOffset: -1
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Left
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: true
+BinPackArguments: true
+BinPackParameters: false
+BraceWrapping:   
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+  SplitEmptyFunctionBody: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     80
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:   [ foreach, Q_FOREACH, BOOST_FOREACH ]
+IncludeCategories: 
+  - Regex:           '^<.*\.h>'
+    Priority:        1
+  - Regex:           '^<.*'
+    Priority:        2
+  - Regex:           '.*'
+    Priority:        3
+IncludeIsMainRegex: '([-_](test|unittest))?$'
+IndentCaseLabels: true
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: false
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PointerAlignment: Left
+ReflowComments:  true
+SortIncludes:    true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Auto
+TabWidth:        8
+UseTab:          Never
+...
+

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  DisabledByDefault: true
+  TargetRubyVersion: 2.4.1
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+
+Metrics/LineLength:
+  Max: 120
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+
+Layout/TrailingBlankLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.4.1
+  - ruby-head
+before_install: gem install bundler
+after_success: bundle exec rake benchmarks

data/Gemfile

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gemspec
+
+version = "4.2"
+gem_version = "~> #{version}.9"
+
+gem "rails", gem_version
+gem "railties", gem_version
+gem "activesupport", gem_version
+gem "activemodel", gem_version
+gem "actionpack", gem_version
+gem "activerecord", gem_version, group: :test
+
+group :benchmarks do
+  gem "sqlite3"
+  gem "pg"
+
+  gem "memory_profiler"
+  gem "ruby-prof"
+  gem "ruby-prof-flamegraph"
+
+  gem "benchmark-ips"
+  gem "active_model_serializers", "0.9.7"
+
+  gem "terminal-table"
+end
+
+group :test do
+  gem "faker"
+end
+
+group :development do
+  gem "byebug"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yosi Attias
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,8 @@
+# Panko
+
+[![Build Status](https://travis-ci.org/yosiat/panko.svg?branch=master)](https://travis-ci.org/yosiat/panko)
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "json"
+require "terminal-table"
+require "rake/extensiontask"
+
+gem = Gem::Specification.load( File.dirname(__FILE__) + "/panko_serializer.gemspec" )
+
+
+Rake::ExtensionTask.new("panko_serializer", gem) do |ext|
+  ext.lib_dir = "lib/panko"
+end
+
+Gem::PackageTask.new(gem) do |pkg|
+  pkg.need_zip = pkg.need_tar = false
+end
+
+RSpec::Core::RakeTask.new(:spec)
+Rake::Task[:spec].prerequisites << :compile
+
+task default: :spec
+
+
+def run_benchmarks(files, items_count: 14_000)
+  headings = ["Benchmark", "ip/s", "allocs/retained"]
+  files.each do |benchmark_file|
+    output = `ITEMS_COUNT=#{items_count} RAILS_ENV=production ruby #{benchmark_file}`
+
+    rows = output.each_line.map do |line|
+      result = JSON.parse(line)
+      result.values
+    end
+
+    puts "\n\n"
+    title = File.basename(benchmark_file, ".rb")
+    table = Terminal::Table.new title: title, headings: headings, rows: rows
+    puts table
+  end
+end
+
+desc "Run all benchmarks"
+task :benchmarks do
+  run_benchmarks Dir[File.join(__dir__, "benchmarks", "**", "bm_*")]
+end
+
+desc "Type Casts - Benchmarks"
+task :bm_type_casts do
+  run_benchmarks Dir[File.join(__dir__, "benchmarks", "type_casts", "bm_*")]
+end
+
+desc "Sanity Benchmarks"
+task :sanity do
+  puts Time.now.strftime("%d/%m %H:%M:%S")
+  puts "=========================="
+
+  run_benchmarks [
+    File.join(__dir__, "benchmarks", "sanity.rb")
+  ], items_count: 2300
+
+  puts "\n\n"
+end

data/benchmarks/BENCHMARKS.md

@@ -0,0 +1,48 @@
+## Initial state
+```
+Native_Posts_2300             57 ip/s      13802 allocs/op
+Native_Posts_50     2956 ip/s        302 allocs/op
+
+AMS_Simple_Posts_2300         21 ip/s      94309 allocs/op
+AMS_Simple_Posts_50         1008 ip/s       2059 allocs/op
+AMS_HasOne_Posts_2300          9 ip/s     147209 allocs/op
+AMS_HasOne_Posts_50          451 ip/s       3209 allocs/op
+
+Panko_HasOne_Posts_2300      164 ip/s       2372 allocs/op
+Panko_HasOne_Posts_50       6118 ip/s        122 allocs/op
+Panko_Reused_HasOne_Posts_2300       178 ip/s       2303 allocs/op
+Panko_Reused_HasOne_Posts_50        8203 ip/s         53 allocs/op
+
+Panko_Simple_Posts_2300      150 ip/s       2372 allocs/op
+Panko_Simple_Posts_50       5639 ip/s        122 allocs/op
+Panko_Reused_Simple_Posts_2300       180 ip/s       2303 allocs/op
+Panko_Reused_Simple_Posts_50        8388 ip/s         53 allocs/op
+```
+
+## Refactorings, method call support, combining
+
+### class eval
+```
+Panko_HasOne_Posts_2300       64 ip/s       9477 allocs/op
+Panko_HasOne_Posts_50       2397 ip/s        477 allocs/op
+Panko_Reused_HasOne_Posts_2300        70 ip/s       9423 allocs/op
+Panko_Reused_HasOne_Posts_50        2596 ip/s        423 allocs/op
+
+Panko_Simple_Posts_2300      191 ip/s       2472 allocs/op
+Panko_Simple_Posts_50       5128 ip/s        222 allocs/op
+Panko_Reused_Simple_Posts_2300       180 ip/s       2418 allocs/op
+Panko_Reused_Simple_Posts_50        5534 ip/s        168 allocs/op
+```
+
+### instance eval
+```
+Panko_HasOne_Posts_2300       60 ip/s       9473 allocs/op
+Panko_HasOne_Posts_50       2399 ip/s        473 allocs/op
+Panko_Reused_HasOne_Posts_2300        66 ip/s       9419 allocs/op
+Panko_Reused_HasOne_Posts_50        2582 ip/s        419 allocs/op
+
+Panko_Simple_Posts_2300      195 ip/s       2470 allocs/op
+Panko_Simple_Posts_50       4838 ip/s        220 allocs/op
+Panko_Reused_Simple_Posts_2300       196 ip/s       2416 allocs/op
+Panko_Reused_Simple_Posts_50        6241 ip/s        166 allocs/op
+```

data/benchmarks/allocs.rb

@@ -0,0 +1,23 @@
+
+# frozen_string_literal: true
+require_relative "./benchmarking_support"
+require_relative "./app"
+require_relative "./setup"
+
+require "memory_profiler"
+
+class PostFastSerializer < Panko::Serializer
+  attributes :id, :body, :title, :author_id
+end
+
+def count_allocs(&block)
+  memory_report = MemoryProfiler.report(&block)
+  puts memory_report.pretty_print
+end
+
+posts = Post.all.to_a
+merged_options = {}.merge(each_serializer: PostFastSerializer)
+posts_array_serializer = Panko::ArraySerializer.new([], merged_options)
+
+# prints out 18402
+count_allocs { posts_array_serializer.serialize_to_json posts }

data/benchmarks/app.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require "bundler/setup"
+
+
+require "rails"
+require "active_model"
+require "active_support"
+require "active_support/json"
+require "action_controller"
+require "action_controller/railtie"
+
+require "active_model_serializers"
+require "panko"

data/benchmarks/benchmarking_support.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require "benchmark/ips"
+require "json"
+require "memory_profiler"
+
+module Benchmark
+  module ActiveModelSerializers
+    def data
+      posts = Post.all.includes(:author).to_a
+      posts_50 = posts.first(50).to_a
+      { all: posts, small: posts_50 }
+    end
+
+    def ams(label = nil, time: 10, disable_gc: true, warmup: 3, &block)
+      fail ArgumentError.new, "block should be passed" unless block_given?
+
+      GC.start
+
+      if disable_gc
+        GC.disable
+      else
+        GC.enable
+      end
+
+      memory_report = MemoryProfiler.report(&block)
+
+      report = Benchmark.ips(time, warmup, true) do |x|
+        x.report(label) { yield }
+      end
+
+      results = {
+        label: label,
+        ips: ActiveSupport::NumberHelper.number_to_delimited(report.entries.first.ips.round(2)),
+        allocs: "#{memory_report.total_allocated}/#{memory_report.total_retained}"
+      }.to_json
+
+      puts results
+
+    end
+  end
+
+  extend Benchmark::ActiveModelSerializers
+end

data/benchmarks/bm_active_model_serializers.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require_relative "./benchmarking_support"
+require_relative "./app"
+require_relative "./setup"
+
+class AmsAuthorFastSerializer < ActiveModel::Serializer
+  attributes :id, :name
+end
+
+class AmsPostFastSerializer < ActiveModel::Serializer
+  attributes :id, :body, :title, :author_id
+end
+
+class AmsPostWithHasOneFastSerializer < ActiveModel::Serializer
+  attributes :id, :body, :title, :author_id
+
+  has_one :author, serializer: AmsAuthorFastSerializer
+end
+
+def benchmark_ams(prefix, serializer, options = {})
+  merged_options = options.merge(each_serializer: serializer)
+
+  data = Benchmark.data
+  posts = data[:all]
+  posts_50 = data[:small]
+
+
+  Benchmark.ams("AMS_#{prefix}_Posts_#{posts.count}") do
+    ActiveModel::ArraySerializer.new(posts, merged_options).serializable_object
+  end
+
+  data = Benchmark.data
+  posts = data[:all]
+  posts_50 = data[:small]
+
+  Benchmark.ams("AMS_#{prefix}_Posts_50") do
+    ActiveModel::ArraySerializer.new(posts_50, merged_options).serializable_object
+  end
+end
+
+
+benchmark_ams "HasOne", AmsPostWithHasOneFastSerializer
+benchmark_ams "Simple", AmsPostFastSerializer
+benchmark_ams "Except", AmsPostWithHasOneFastSerializer, except: [:title]
+benchmark_ams "Include", AmsPostWithHasOneFastSerializer, include: [:id, :body, :author_id, :author]

data/benchmarks/bm_controller.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+require_relative "./benchmarking_support"
+require_relative "./app"
+require_relative "./setup"
+
+class NullLogger < Logger
+  def initialize(*args)
+  end
+
+  def add(*args, &block)
+  end
+end
+
+class BenchmarkApp < Rails::Application
+  routes.append do
+    get "/simple" => "main#simple"
+    get "/text" => "main#text"
+
+    get "/serialize_to_string" => "main#serialize_to_string"
+  end
+
+  config.secret_token = "s"*30
+  config.secret_key_base = "foo"
+  config.consider_all_requests_local = false
+
+  # simulate production
+  config.cache_classes = true
+  config.eager_load = true
+  config.action_controller.perform_caching = true
+
+  # otherwise deadlock occured
+  config.middleware.delete "Rack::Lock"
+
+  # to disable log files
+  config.logger = NullLogger.new
+  config.active_support.deprecation = :log
+end
+
+BenchmarkApp.initialize!
+
+class AuthorFastSerializer < Panko::Serializer
+  attributes :id, :name
+end
+
+class PostWithHasOneFastSerializer < Panko::Serializer
+  attributes :id, :body, :title, :author_id
+
+  has_one :author, serializer: AuthorFastSerializer
+end
+
+class MainController < ActionController::Base
+  def text
+    render text: '{"ok":true}'.freeze, content_type: "application/json".freeze
+  end
+
+  def simple
+    render json: { ok: true }
+  end
+
+  def serialize_to_string
+    data = Benchmark.data[:all]
+    render text: Panko::ArraySerializer.new(data, each_serializer: PostWithHasOneFastSerializer).to_json, content_type: "application/json".freeze
+  end
+end
+
+class RouteNotFoundError < StandardError;end
+
+
+def request(method, path)
+  response = Rack::MockRequest.new(BenchmarkApp).send(method, path)
+  if response.status.in?([404, 500])
+    raise RouteNotFoundError.new, 'not found #{method.to_s.upcase} #{path}'
+  end
+  response
+end
+
+
+Benchmark.ams("text") { request(:get, "/text") }
+Benchmark.ams("simple") { request(:get, "/simple") }
+
+Benchmark.ams("serialize_to_string") { request(:get, "/serialize_to_string") }

data/benchmarks/bm_panko_json.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+require_relative "./benchmarking_support"
+require_relative "./app"
+require_relative "./setup"
+
+class AuthorFastSerializer < Panko::Serializer
+  attributes :id, :name
+end
+
+
+class PostFastSerializer < Panko::Serializer
+  attributes :id, :body, :title, :author_id
+end
+
+class PostFastWithMethodCallSerializer < Panko::Serializer
+  attributes :id, :body, :title, :author_id, :method_call
+
+  def method_call
+    object.id * 2
+  end
+end
+
+class PostWithHasOneFastSerializer < Panko::Serializer
+  attributes :id, :body, :title, :author_id
+
+  has_one :author, serializer: AuthorFastSerializer
+end
+
+class AuthorWithHasManyFastSerializer < Panko::Serializer
+  attributes :id, :name
+
+  has_many :posts, serializer: PostFastSerializer
+end
+
+
+def benchmark(prefix, serializer, options = {})
+  data = Benchmark.data
+  posts = data[:all]
+  posts_50 = data[:small]
+
+  merged_options = options.merge(each_serializer: serializer)
+
+  Benchmark.ams("Panko_#{prefix}_Posts_#{posts.count}") do
+    Panko::ArraySerializer.new(posts, merged_options).to_json
+  end
+
+  data = Benchmark.data
+  posts = data[:all]
+  posts_50 = data[:small]
+
+  Benchmark.ams("Panko_#{prefix}_Posts_50") do
+    Panko::ArraySerializer.new(posts_50, merged_options).to_json
+  end
+end
+
+benchmark "HasOne", PostWithHasOneFastSerializer
+benchmark "Simple", PostFastSerializer
+benchmark "SimpleWithMethodCall", PostFastWithMethodCallSerializer
+benchmark "Except", PostWithHasOneFastSerializer, except: [:title]
+benchmark "Include", PostWithHasOneFastSerializer, include: [:id, :body, :author_id, :author]

data/benchmarks/bm_panko_object.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+require_relative "./benchmarking_support"
+require_relative "./app"
+require_relative "./setup"
+
+class AuthorFastSerializer < Panko::Serializer
+  attributes :id, :name
+end
+
+
+class PostFastSerializer < Panko::Serializer
+  attributes :id, :body, :title, :author_id
+end
+
+class PostWithHasOneFastSerializer < Panko::Serializer
+  attributes :id, :body, :title, :author_id
+
+  has_one :author, serializer: AuthorFastSerializer
+end
+
+class AuthorWithHasManyFastSerializer < Panko::Serializer
+  attributes :id, :name
+
+  has_many :posts, serializer: PostFastSerializer
+end
+
+
+def benchmark(prefix, serializer, options = {})
+  data = Benchmark.data
+  posts = data[:all]
+  posts_50 = data[:small]
+
+  merged_options = options.merge(each_serializer: serializer)
+
+  Benchmark.ams("Panko_#{prefix}_Posts_#{posts.count}") do
+    Panko::ArraySerializer.new(posts, merged_options).to_a
+  end
+
+  data = Benchmark.data
+  posts = data[:all]
+  posts_50 = data[:small]
+
+  Benchmark.ams("Panko_#{prefix}_Posts_50") do
+    Panko::ArraySerializer.new(posts_50, merged_options).to_a
+  end
+
+  posts_array_serializer = Panko::ArraySerializer.new([], merged_options)
+
+  data = Benchmark.data
+  posts = data[:all]
+  posts_50 = data[:small]
+
+  Benchmark.ams("Panko_Reused_#{prefix}_Posts_#{posts.count}") do
+    posts_array_serializer.serialize posts
+  end
+
+  data = Benchmark.data
+  posts = data[:all]
+  posts_50 = data[:small]
+
+  Benchmark.ams("Panko_Reused_#{prefix}_Posts_50") do
+    posts_array_serializer.serialize posts_50
+  end
+end
+
+benchmark "HasOne", PostWithHasOneFastSerializer
+benchmark "Simple", PostFastSerializer
+benchmark "Except", PostWithHasOneFastSerializer, except: [:title]
+benchmark "Include", PostWithHasOneFastSerializer, include: [:id, :body, :author_id, :author]