panko_serializer 0.7.6 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4d6afa062eeef46ccbd192d068e9d407003acfd98dd60b3e269caff356bb756
-  data.tar.gz: 5049cbdef5d0e33e3731fe4a1469a047726c9b25be853d79f692b6eabe0888b5
+  metadata.gz: c07649ad9566fb8f9ef1088a20bff7b93f76b5d6295d0505b81bca45ed47788c
+  data.tar.gz: a9d3736b9ef189d9087f036bcf9c4977ae950ffbb1e3dfb1386ec138fdcef101
 SHA512:
-  metadata.gz: ef58e0cd54374934883ac2dd17146e00ddcdc7f2858664cfb57f78e113990ebe2a766e6766c71bd217db842e96024ff51695ef34a16506ab9d50e6f01462b271
-  data.tar.gz: d4bb8d589442812bd12a0e2d4c9d477ab3f5280c1eb9f80594eb93ca5e4153bbbbe0aa2ed517f851b247722d1d8c6240d7cb68dd625f067421a149b04988401b
+  metadata.gz: 609057962ee4975e8e392da3d762421e819f1bbac4d2511c156384732d9359922edd386d833353d112edea334f66c6a4f44f0dc593b16a8b1e62b2c64196f4df
+  data.tar.gz: 18d84743b9f94f59db2bffd7716ecd6e796da1d3c135b401d5c8f0ae258f3c74276706794703d3841663add5cec70fee97ccbf54561688ee9247cdd11bc6d115

data/.github/workflows/docs.yml

@@ -19,7 +19,7 @@ jobs:
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v1
       with:
-        node-version: '12.x'
+        node-version: '16.x'
 
     - name: Install Dependencies
       working-directory: ${{ env.working_directory }}

data/.github/workflows/lint.yml

@@ -0,0 +1,41 @@
+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
+          clang-format ext/**/*.{c,h}
+
+      - name: Lint C
+        uses: jidicula/clang-format-action@v4.10.1
+        with:
+          clang-format-version: "15"
+          check-path: "ext/panko_serializer"
+          fallback-style: "Google"

data/.github/workflows/ruby.yml

@@ -4,45 +4,44 @@ on: [push, pull_request]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.6', '2.7', '3.0']
-        rails: ['6.0.0', '6.1.0']
+        ruby: ["2.7", "3.0", "3.1.0", "3.2.0"]
+        rails: ["6.0.0", "6.1.0", "7.0.0"]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby ${{ matrix.ruby }}
-      uses: actions/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"
@@ -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/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"
@@ -32,14 +33,12 @@ 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
+    stdout.each do |line|
+      print_and_flush "."
+      lines << line
     end
+  rescue Errno::EIO
+    # ignore this
   end
 
   lines
@@ -51,15 +50,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"

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"
 

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

data/benchmarks/setup.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 ###########################################
 # Setup active record models
 ##########################################
 require "active_record"
 require "sqlite3"
 
-
 # Change the following to reflect your database settings
 ActiveRecord::Base.establish_connection(
   adapter: "sqlite3",
@@ -49,7 +49,7 @@ Post.transaction do
       body: "something about how password restrictions are evil, and less secure, and with the math to prove it.",
       title: "Your bank is does not know how to do security",
       author: Author.create(name: "Preston Sego"),
-      data: { a: 1, b: 2, c: 3 }
+      data: {a: 1, b: 2, c: 3}
     )
   end
 end

data/benchmarks/type_casts/bm_active_record.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "./support"
 
 def ar_type_convert(type_klass, from, to)
@@ -28,9 +29,9 @@ def ar_type_convert(type_klass, from, to)
 end
 
 def utc_ar_time
-	date = DateTime.new(2017, 3, 4, 12, 45, 23)
-	tz = ActiveSupport::TimeZone.new("UTC")
-	from = date.in_time_zone(tz).iso8601
+  date = DateTime.new(2017, 3, 4, 12, 45, 23)
+  tz = ActiveSupport::TimeZone.new("UTC")
+  from = date.in_time_zone(tz).iso8601
 
   type = ActiveRecord::ConnectionAdapters::PostgreSQL::OID::DateTime.new
   converter = ActiveRecord::AttributeMethods::TimeZoneConversion::TimeZoneConverter.new(type)
@@ -46,15 +47,12 @@ def utc_ar_time
   end
 end
 
-
-
 def db_ar_time
   type = ActiveRecord::ConnectionAdapters::PostgreSQL::OID::DateTime.new
   converter = ActiveRecord::AttributeMethods::TimeZoneConversion::TimeZoneConverter.new(type)
 
   from = "2017-07-10 09:26:40.937392"
 
-
   if ENV["RAILS_VERSION"].start_with? "4.2"
     Benchmark.run("ActiveRecord_Time_TypeCast_WithISO8601") do
       converter.type_cast_from_database(from).iso8601
@@ -79,10 +77,10 @@ if ENV["RAILS_VERSION"].start_with? "4.2"
   ar_type_convert ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Float, "Infinity", ::Float::INFINITY
 end
 if check_if_exists "ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Json"
-  ar_type_convert ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Json, '{"a":1}', {a:1}
+  ar_type_convert ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Json, '{"a":1}', {a: 1}
 end
 if check_if_exists "ActiveRecord::Type::Json"
-  ar_type_convert ActiveRecord::Type::Json, '{"a":1}', {a:1}
+  ar_type_convert ActiveRecord::Type::Json, '{"a":1}', {a: 1}
 end
 
 db_ar_time