panko_serializer 0.7.7 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a55772372c4ae9e4d147a131c5dd59090b7dc928adc5e6830403246918fdb90b
-  data.tar.gz: e6ee39b058b87b81d19385d4ae03fb938e2c04859641499454ca7debe99aceb9
+  metadata.gz: 00eff973f0a008e93332c9a83da475001203d49479126e90311577aa8a3f4fd5
+  data.tar.gz: e94e6290b5103ddb0481110cf901d69da86b6831cc5ed59f95b94abf810dac29
 SHA512:
-  metadata.gz: eac9a9cad9ca9b99146527c25a935347b51a110ab36b0bc58165c961780415068c9899ebbe15ec3eb594a112d18665c54b5d5afd77ebd2449b078faa85e37981
-  data.tar.gz: 87081d7cc24b5a69b3c409232abedb79daab75c263aea45b405d24ef71570df0c10f8821a741f88bb4e690d38b802bd6f43a82c0cee4a5e24d0ebba04849318a
+  metadata.gz: b87365560a2953a4f5b4027672b6f1721f89cc199345b82ed4ebb421263bfcb91f621651184e0d0c0f88c77f82d45acef61a061a0a863c21e7c2b066f57691be
+  data.tar.gz: 58c278c92461ef9f6f10ebee1579ad8bd801f6b5395625c982fc8ca1a32ab8e5e59d91527b820ddb9f662eea45df85952f7acf6060a9c9ac216208fac2db4523

data/.github/workflows/lint.yml

@@ -0,0 +1,40 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.0
+
+      - name: Install deps
+        run: |
+          sudo apt update -y
+          sudo apt install -y libsqlite3-dev
+
+      - name: Install gems
+        env:
+          RAILS_VERSION: "7.0"
+        run: |
+          gem install bundler
+          bundle config set path 'vendor/bundle'
+          bundle check || bundle install --jobs 4 --retry 3
+
+      - name: Lint ruby
+        env:
+          RAILS_VERSION: "7.0"
+        run: |
+          bundle exec rake standard
+
+      - name: Lint C
+        uses: jidicula/clang-format-action@v4.11.0
+        with:
+          clang-format-version: "16"
+          check-path: "ext/panko_serializer"
+          fallback-style: "Google"

data/.github/workflows/ruby.yml

@@ -4,48 +4,44 @@ on: [push, pull_request]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.6', '2.7', '3.0', '3.1.0']
-        rails: ['6.0.0', '6.1.0', '7.0.0']
-        exclude:
-          - ruby: '2.6'
-            rails: '7.0.0'
+        ruby: ["3.0", "3.1", "3.2"]
+        rails: ["6.1.0", "7.0.0"]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby ${{ matrix.ruby }}
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-
-    - name: Install deps
-      run: |
-        sudo apt update -y
-        sudo apt install -y libsqlite3-dev
-
-    - name: Gems Cache
-      id: gem-cache
-      uses: actions/cache@v1
-      with:
-       path: vendor/bundle
-       key: ${{ runner.os }}-${{ matrix.ruby }}-${{ matrix.rails }}-gem
-       restore-keys: |
-         ${{ runner.os }}-${{ matrix.ruby }}-${{ matrix.rails }}-gem
-
-    - name: Install gems
-      env:
-        RAILS_VERSION: ${{ matrix.rails }}
-      run: |
-        gem install bundler
-        bundle config set path 'vendor/bundle'
-        bundle check || bundle install --jobs 4 --retry 3
-
-    - name: Compile & test
-      env:
-        RAILS_VERSION: ${{ matrix.rails }}
-      run: |
-        bundle exec rake
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install deps
+        run: |
+          sudo apt update -y
+          sudo apt install -y libsqlite3-dev
+
+      - name: Gems Cache
+        id: gem-cache
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-${{ matrix.rails }}-gem
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-${{ matrix.rails }}-gem
+
+      - name: Install gems
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}
+        run: |
+          gem install bundler
+          bundle config set path 'vendor/bundle'
+          bundle check || bundle install --jobs 4 --retry 3
+
+      - name: Compile & test
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}
+        run: |
+          bundle exec rake

data/.standard.yml

@@ -0,0 +1,4 @@
+ignore:
+  - "ext/**/*"
+  - "spec/**/*":
+    - Lint/ConstantDefinitionInBlock

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
@@ -10,7 +11,6 @@ gem "activesupport", rails_version
 gem "activemodel", rails_version
 gem "activerecord", rails_version, group: :test
 
-
 group :benchmarks do
   gem "sqlite3", "~> 1.4"
   gem "pg", ">= 0.18", "< 2.0"
@@ -20,7 +20,7 @@ group :benchmarks do
   gem "ruby-prof-flamegraph", platforms: [:mri]
 
   gem "benchmark-ips"
-  gem "active_model_serializers"
+  gem "active_model_serializers", "~> 0.10"
   gem "terminal-table"
 end
 
@@ -33,5 +33,6 @@ group :development do
   gem "rake"
   gem "rspec", "~> 3.0"
   gem "rake-compiler"
-  gem "rubocop"
 end
+
+gem "standard", group: [:development, :test]

data/README.md

@@ -1,6 +1,6 @@
 # Panko
 
-![Build Status](https://github.com/panko-serializer/panko_serializer/workflows/Panko%20Serializer%20CI/badge.svg?branch=github-actions)
+![Build Status](https://github.com/panko-serializer/panko_serializer/workflows/Panko%20Serializer%20CI/badge.svg?branch=master)
 
 Panko is library which is inspired by ActiveModelSerializers 0.9 for serializing ActiveRecord/Ruby objects to JSON strings, fast.
 

data/Rakefile

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "json"
 require "terminal-table"
 require "rake/extensiontask"
 require "pty"
+require "standard/rake"
 
-gem = Gem::Specification.load( File.dirname(__FILE__) + "/panko_serializer.gemspec" )
-
+gem = Gem::Specification.load(File.dirname(__FILE__) + "/panko_serializer.gemspec")
 
 Rake::ExtensionTask.new("panko_serializer", gem) do |ext|
   ext.lib_dir = "lib/panko"
@@ -31,15 +32,14 @@ end
 def run_process(cmd)
   puts "> Running #{cmd}"
   lines = []
-  PTY.spawn(cmd) do |stdout, stdin, pid|
-    begin
-      stdout.each do |line|
-        print_and_flush '.'
-        lines << line
-      end
-    rescue Errno::EIO
-      # ignore this
+  _stderr_reader, stderr_writer = IO.pipe
+  PTY.spawn(cmd, err: stderr_writer.fileno) do |stdout, stdin, pid|
+    stdout.each do |line|
+      print_and_flush "."
+      lines << line
     end
+  rescue Errno::EIO
+    # ignore this
   end
 
   lines
@@ -51,15 +51,12 @@ end
 def run_benchmarks(files, items_count: 2_300)
   headings = ["Benchmark", "ip/s", "allocs/retained"]
   files.each do |benchmark_file|
-
     lines = run_process "ITEMS_COUNT=#{items_count} RAILS_ENV=production ruby #{benchmark_file}"
     rows = lines.map do |line|
-      begin
-        row = JSON.parse(line)
-        row.values
-      rescue JSON::ParserError
-        puts "> [ERROR] Failed running #{benchmark_file} - #{lines.join}"
-      end
+      row = JSON.parse(line)
+      row.values
+    rescue JSON::ParserError
+      puts "> [ERROR] Failed running #{benchmark_file} - #{lines.join}"
     end
 
     puts "\n\n"
@@ -69,24 +66,26 @@ def run_benchmarks(files, items_count: 2_300)
   end
 end
 
-desc "Run all benchmarks"
-task :benchmarks do
-  run_benchmarks Dir[File.join(__dir__, "benchmarks", "**", "bm_*")]
-end
+namespace :benchmarks do
+  desc "All"
+  task :all 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_*")], items_count: 0
-end
+  desc "Type Casts"
+  task :type_casts do
+    run_benchmarks Dir[File.join(__dir__, "benchmarks", "type_casts", "bm_*")], items_count: 0
+  end
 
-desc "Sanity Benchmarks"
-task :sanity do
-  puts Time.now.strftime("%d/%m %H:%M:%S")
-  puts "=========================="
+  desc "Sanity"
+  task :sanity do
+    puts Time.now.strftime("%d/%m %H:%M:%S")
+    puts "=========================="
 
-  run_benchmarks [
-    File.join(__dir__, "benchmarks", "sanity.rb")
-  ], items_count: 2300
+    run_benchmarks [
+      File.join(__dir__, "benchmarks", "sanity.rb")
+    ], items_count: 2300
 
-  puts "\n\n"
+    puts "\n\n"
+  end
 end

data/benchmarks/allocs.rb

@@ -1,5 +1,5 @@
-
 # frozen_string_literal: true
+
 require_relative "./benchmarking_support"
 require_relative "./app"
 require_relative "./setup"

data/benchmarks/app.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require "bundler/setup"
 
+require "bundler/setup"
 
 require "active_model"
 require "active_record"

data/benchmarks/benchmarking_support.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "benchmark/ips"
 require "json"
 require "memory_profiler"
@@ -8,11 +9,11 @@ module Benchmark
     def data
       posts = Post.all.includes(:author).to_a
       posts_50 = posts.first(50).to_a
-      { all: posts, small: posts_50 }
+      {all: posts, small: posts_50}
     end
 
     def run(label = nil, time: 10, disable_gc: true, warmup: 3, &block)
-      fail ArgumentError.new, "block should be passed" unless block_given?
+      fail ArgumentError.new, "block should be passed" unless block
 
       GC.start
 
@@ -35,7 +36,6 @@ module Benchmark
       }.to_json
 
       puts results
-
     end
   end
 

data/benchmarks/bm_ams_0_10.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 require_relative "./benchmarking_support"
 require_relative "./app"
 require_relative "./setup"
 
 # disable logging for benchmarks
-ActiveModelSerializers.logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new('/dev/null'))
-
+ActiveModelSerializers.logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new("/dev/null"))
 
 class AmsAuthorFastSerializer < ActiveModel::Serializer
   attributes :id, :name
@@ -28,7 +28,6 @@ def benchmark_ams(prefix, serializer, options = {})
   posts = data[:all]
   posts_50 = data[:small]
 
-
   Benchmark.run("AMS_#{prefix}_Posts_#{posts.count}") do
     ActiveModelSerializers::SerializableResource.new(posts, merged_options).to_json
   end
@@ -42,9 +41,7 @@ def benchmark_ams(prefix, serializer, options = {})
   end
 end
 
-
 benchmark_ams "Attributes_Simple", AmsPostFastSerializer
 benchmark_ams "Attributes_HasOne", AmsPostWithHasOneFastSerializer
 benchmark_ams "Attributes_Except", AmsPostWithHasOneFastSerializer, except: [:title]
 benchmark_ams "Attributes_Only", AmsPostWithHasOneFastSerializer, only: [:id, :body, :author_id, :author]
-

data/benchmarks/bm_object_writer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "./benchmarking_support"
 require_relative "./app"
 

data/benchmarks/bm_panko_json.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "./benchmarking_support"
 require_relative "./app"
 require_relative "./setup"
@@ -7,7 +8,6 @@ class AuthorFastSerializer < Panko::Serializer
   attributes :id, :name
 end
 
-
 class PostFastSerializer < Panko::Serializer
   attributes :id, :body, :title, :author_id, :created_at
 end

data/benchmarks/bm_panko_object.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "./benchmarking_support"
 require_relative "./app"
 require_relative "./setup"
@@ -7,7 +8,6 @@ class AuthorFastSerializer < Panko::Serializer
   attributes :id, :name
 end
 
-
 class PostFastSerializer < Panko::Serializer
   attributes :id, :body, :title, :author_id
 end
@@ -24,7 +24,6 @@ class AuthorWithHasManyFastSerializer < Panko::Serializer
   has_many :posts, serializer: PostFastSerializer
 end
 
-
 def benchmark(prefix, serializer, options = {})
   data = Benchmark.data
   posts = data[:all]

data/benchmarks/bm_plain_object.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "./benchmarking_support"
 require_relative "./app"
 
@@ -6,7 +7,6 @@ class AuthorFastSerializer < Panko::Serializer
   attributes :id, :name
 end
 
-
 class PostFastSerializer < Panko::Serializer
   attributes :id, :body, :title, :author_id, :created_at
 end
@@ -32,11 +32,12 @@ class AuthorWithHasManyFastSerializer < Panko::Serializer
 end
 
 class Post
-  attr_accessor :id, :body, :title, :created_at, :author, :author_id
+  attr_accessor :id, :body, :title, :created_at, :author_id
+  attr_reader :author
 
   def self.create(attrs)
     p = Post.new
-    attrs.each do |k,v|
+    attrs.each do |k, v|
       p.send :"#{k}=", v
     end
     p
@@ -44,7 +45,7 @@ class Post
 
   def author=(author)
     @author = author
-    @author_id = author_id
+    @author_id = author.id
   end
 end
 
@@ -53,7 +54,7 @@ class Author
 
   def self.create(attrs)
     a = Author.new
-    attrs.each do |k,v|
+    attrs.each do |k, v|
       a.send :"#{k}=", v
     end
     a
@@ -71,10 +72,9 @@ def benchmark_data
     )
   end
 
-  { all: posts, small: posts.first(50) }
+  {all: posts, small: posts.first(50)}
 end
 
-
 def benchmark(prefix, serializer, options = {})
   data = benchmark_data
   posts = data[:all]

data/benchmarks/bm_serialization_descriptor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "./benchmarking_support"
 require "active_support"
 
@@ -9,15 +10,15 @@ def generate_attributes(count)
 end
 
 class LeafASerializer < Panko::Serializer
-  attributes *generate_attributes(5)
+  attributes(*generate_attributes(5))
 end
 
 class LeafBSerializer < Panko::Serializer
-  attributes *generate_attributes(6)
+  attributes(*generate_attributes(6))
 end
 
 class ChildrenSerializer < Panko::Serializer
-  attributes *generate_attributes(28)
+  attributes(*generate_attributes(28))
 
   has_one :leaf_a, serializer: LeafASerializer
   has_one :leaf_b, serializer: LeafBSerializer
@@ -39,11 +40,10 @@ class ChildrenSerializer < Panko::Serializer
 end
 
 class ParentSerializer < Panko::Serializer
-  attributes *generate_attributes(46)
+  attributes(*generate_attributes(46))
 
   has_many :children, serializer: ChildrenSerializer
 
-
   def attr_1
   end
 

data/benchmarks/bm_serializer_resolver.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "./benchmarking_support"
 require_relative "./app"
 
@@ -9,13 +10,13 @@ class RealSerializer < Panko::Serializer
 end
 
 Benchmark.run("CantFindConst") do
-  Panko::SerializerResolver.resolve("cant_find_const")
+  Panko::SerializerResolver.resolve("cant_find_const", Object)
 end
 
 Benchmark.run("NotSerializer") do
-  Panko::SerializerResolver.resolve("not")
+  Panko::SerializerResolver.resolve("not", Object)
 end
 
 Benchmark.run("RealSerializer") do
-  Panko::SerializerResolver.resolve("real")
+  Panko::SerializerResolver.resolve("real", Object)
 end

data/benchmarks/bm_to_object.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 require_relative "./benchmarking_support"
 require_relative "./app"
 require_relative "./setup"
 
 class PostWithAliasModel < ActiveRecord::Base
-  self.table_name = 'posts'
+  self.table_name = "posts"
 
   alias_attribute :new_id, :id
   alias_attribute :new_body, :body
@@ -20,7 +21,6 @@ end
 def benchmark_aliased(prefix, serializer, options = {})
   posts = PostWithAliasModel.all.to_a
   posts_50 = posts.first(50).to_a
-  data = { all: posts, small: posts_50 }
 
   merged_options = options.merge(each_serializer: serializer)
 
@@ -28,10 +28,6 @@ def benchmark_aliased(prefix, serializer, options = {})
     Panko::ArraySerializer.new(posts, merged_options).to_json
   end
 
-  posts = PostWithAliasModel.all.to_a
-  posts_50 = posts.first(50).to_a
-  data = { all: posts, small: posts_50 }
-
   Benchmark.run("Panko_#{prefix}_Posts_50") do
     Panko::ArraySerializer.new(posts_50, merged_options).to_json
   end
@@ -41,7 +37,6 @@ class AuthorFastSerializer < Panko::Serializer
   attributes :id, :name
 end
 
-
 class PostFastSerializer < Panko::Serializer
   attributes :id, :body, :title, :author_id, :created_at
 end
@@ -66,7 +61,6 @@ class AuthorWithHasManyFastSerializer < Panko::Serializer
   has_many :posts, serializer: PostFastSerializer
 end
 
-
 def benchmark(prefix, serializer, options = {})
   data = Benchmark.data
   posts = data[:all]
@@ -87,7 +81,5 @@ def benchmark(prefix, serializer, options = {})
   end
 end
 
-
-
 benchmark "Simple", PostFastSerializer
 benchmark "HasOne", PostWithHasOneFastSerializer

data/benchmarks/profile.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "./benchmarking_support"
 require_relative "./app"
 require_relative "./setup"
@@ -22,7 +23,7 @@ class BenchmarkApp < Rails::Application
     get "/serialize_to_stream" => "streaming#serialize_to_stream"
   end
 
-  config.secret_token = "s"*30
+  config.secret_token = "s" * 30
   config.secret_key_base = "foo"
   config.consider_all_requests_local = false
 
@@ -55,7 +56,7 @@ class StreamingController < ActionController::Base
   include ActionController::Live
 
   def serialize_to_stream
-    headers["Content-Type".freeze] = "application/json".freeze
+    headers["Content-Type"] = "application/json"
 
     data = Benchmark.data[:all]
     serializer = Panko::ArraySerializer.new([], each_serializer: PostWithHasOneFastSerializer)
@@ -67,19 +68,16 @@ class StreamingController < ActionController::Base
   end
 end
 
-
-class RouteNotFoundError < StandardError;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}'
+    raise RouteNotFoundError.new, "not found #{method.to_s.upcase} #{path}"
   end
   response
 end
 
-
 def memory(&block)
   mem = MemoryProfiler.report(&block)
   mem.pretty_print

data/benchmarks/sanity.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 require_relative "./benchmarking_support"
 require_relative "./app"
 require_relative "./setup"
 
 class PostWithAliasModel < ActiveRecord::Base
-  self.table_name = 'posts'
+  self.table_name = "posts"
 
   alias_attribute :new_id, :id
   alias_attribute :new_body, :body
@@ -20,7 +21,6 @@ end
 def benchmark_aliased(prefix, serializer, options = {})
   posts = PostWithAliasModel.all.to_a
   posts_50 = posts.first(50).to_a
-  data = { all: posts, small: posts_50 }
 
   merged_options = options.merge(each_serializer: serializer)
 
@@ -28,10 +28,6 @@ def benchmark_aliased(prefix, serializer, options = {})
     Panko::ArraySerializer.new(posts, merged_options).to_json
   end
 
-  posts = PostWithAliasModel.all.to_a
-  posts_50 = posts.first(50).to_a
-  data = { all: posts, small: posts_50 }
-
   Benchmark.run("Panko_#{prefix}_Posts_50") do
     Panko::ArraySerializer.new(posts_50, merged_options).to_json
   end
@@ -41,7 +37,6 @@ class AuthorFastSerializer < Panko::Serializer
   attributes :id, :name
 end
 
-
 class PostFastSerializer < Panko::Serializer
   attributes :id, :body, :title, :author_id, :created_at
 end
@@ -66,7 +61,6 @@ class AuthorWithHasManyFastSerializer < Panko::Serializer
   has_many :posts, serializer: PostFastSerializer
 end
 
-
 def benchmark(prefix, serializer, options = {})
   data = Benchmark.data
   posts = data[:all]
@@ -87,8 +81,6 @@ def benchmark(prefix, serializer, options = {})
   end
 end
 
-
-
 benchmark "Simple", PostFastSerializer
 benchmark "HasOne", PostWithHasOneFastSerializer
 benchmark "SimpleWithMethodCall", PostFastWithMethodCallSerializer