panko_serializer 0.8.2 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30c234d90f13454e0f54347e0b98ed6c1e3f935ef25769d55c825a462021f66b
-  data.tar.gz: 3c49a951469fad5249307c3569b1f9a1c03763f2cd961ed94ef19684ae63f0ab
+  metadata.gz: 7b4397a54b1f806131ee07ccaaa4062bba8eb5490c3810e5c6c3cc405b7167ec
+  data.tar.gz: 8f3127a38fe93844c3a82aa8e2a30ea82312ef1b0ebdf66f86bcd4761c392749
 SHA512:
-  metadata.gz: dcce669e933459d36d033abc5d94494b5aa6333c1fe97e3015609e6eaabc27a3d7d2376c328bbbd53f941b238c67725b6130a64e9bf313b90cb10800ed2c0af9
-  data.tar.gz: 1f83c4d03e1a175976044d78e920ab4864b9973569fc945f510f773a02ca06190e81557d259741b0fd15abf1b23eec2ebda6951bcb2e862fb83f177b78945fac
+  metadata.gz: 626bf9689a4be25a166a7ee3fe3b2274cfcc9b7bb17d57398d87301aca1c8039835d02ef37de647d62d3fa5c102cc22f752b2400e10240fa992d2007eaf9344c
+  data.tar.gz: 9a0048188abc83c9a064a0bb7721cc94a7f3965338f62a84fe4382a7b98f52941c1a1914f25dfee3bc7ed80168a1bb47f7def51954b9b1250029e4784f6f0a5d

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

data/.github/workflows/database_matrix.yml

@@ -0,0 +1,85 @@
+name: Database Tests
+
+on: [push, pull_request]
+
+jobs:
+  database-matrix:
+    runs-on: ubuntu-latest
+    
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.4"]
+        rails: ["7.2.0", "8.0.0"]
+        database: ["sqlite", "postgresql", "mysql"]
+    
+    services:
+      postgres:
+        image: postgres:17
+        env:
+          POSTGRES_DB: panko_test
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+          
+      mysql:
+        image: mysql:8.0
+        env:
+          MYSQL_DATABASE: panko_test
+          MYSQL_ROOT_PASSWORD: password
+        options: >-
+          --health-cmd="mysqladmin ping"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=3
+        ports:
+          - 3306:3306
+
+    steps:
+      - name: Install system dependencies
+        run: |
+          sudo apt update -y
+          sudo apt install -y libsqlite3-dev libpq-dev libmysqlclient-dev
+
+      - uses: actions/checkout@v5
+      
+      - name: Configure MySQL authentication
+        if: matrix.database == 'mysql'
+        run: |
+          # Configure MySQL to use mysql_native_password for Trilogy compatibility
+          mysql -h 127.0.0.1 -P 3306 -u root -ppassword -e "
+            ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'password';
+            ALTER USER 'root'@'%' IDENTIFIED WITH mysql_native_password BY 'password';
+            FLUSH PRIVILEGES;
+          "
+        
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          working-directory: .
+        env:
+          BUNDLE_GEMFILE: gemfiles/${{ matrix.rails }}.gemfile
+          DB: ${{ matrix.database }}
+
+      - name: Compile & test
+        env:
+          BUNDLE_GEMFILE: gemfiles/${{ matrix.rails }}.gemfile
+          DB: ${{ matrix.database }}
+          POSTGRES_HOST: localhost
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+          POSTGRES_PORT: 5432
+          MYSQL_HOST: localhost
+          MYSQL_USER: root
+          MYSQL_PASSWORD: password
+          MYSQL_PORT: 3306
+        run: |
+          bundle exec rake

data/.github/workflows/docs.yml

@@ -5,7 +5,7 @@ name: Docs Publishing
 
 on:
  push:
-   branches: [ master ]
+   branches: [ master, docup ]
 
 jobs:
   build:
@@ -15,11 +15,11 @@ jobs:
       working_directory: 'docs/'
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
-        node-version: '16.x'
+        node-version: '20.x'
 
     - name: Install Dependencies
       working-directory: ${{ env.working_directory }}
@@ -35,5 +35,5 @@ jobs:
       run: |
         git config --global user.email "action@github.com"
         git config --global user.name "GitHub Action"
-        GIT_USER=yosiat CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages
+        GIT_USER=yosiat CURRENT_BRANCH=master USE_SSH=true npm run deploy
 

data/.github/workflows/lint.yml

@@ -3,33 +3,27 @@ name: Lint
 on: [push, pull_request]
 
 jobs:
-  build:
+  lint:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.1.0
+      - uses: actions/checkout@v5
 
       - name: Install deps
         run: |
           sudo apt update -y
           sudo apt install -y libsqlite3-dev
 
-      - name: Install gems
-        run: |
-          gem install bundler
-          bundle config set path 'vendor/bundle'
-          bundle check || bundle install --jobs 4 --retry 3
-
-      - name: Lint ruby
-        run: |
-          bundle exec rake standard
+      - name: Lint Ruby code
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3
+          bundler-cache: true
+      - run: |
+          bundle exec rake rubocop
 
       - name: Lint C
-        uses: jidicula/clang-format-action@v4.11.0
+        uses: jidicula/clang-format-action@v4.16.0
         with:
           clang-format-version: "16"
           check-path: "ext/panko_serializer"

data/.github/workflows/{ruby.yml → tests.yml}

@@ -3,42 +3,29 @@ name: Panko Serializer CI
 on: [push, pull_request]
 
 jobs:
-  build:
+  tests:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.0", "3.1", "3.2", "3.3"]
-        rails: ["6.1.0", "7.0.0", "7.1.0"]
+        ruby: ["3.2", "3.3", "3.4"]
+        rails: ["7.2.0", "8.0.0", "8.1.0"]
 
     steps:
-      - uses: actions/checkout@v4
-      - 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@v3
+      - uses: actions/checkout@v5
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@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
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          working-directory: .
         env:
           BUNDLE_GEMFILE: gemfiles/${{ matrix.rails }}.gemfile
-        run: |
-          gem install bundler
-          bundle config set path 'vendor/bundle'
-          bundle check || bundle install --jobs 4 --retry 3
 
       - name: Compile & test
         env:

data/.gitignore

@@ -16,3 +16,5 @@
 node_modules
 
 /docs/build/
+.cache/
+.docusaurus/

data/.rubocop.yml

@@ -1,29 +1,37 @@
-AllCops:
-  TargetRubyVersion: 2.5
-  DisplayCopNames: true
-  StyleGuideCopsOnly: false
+# We want Exclude directives from different
+# config files to get merged, not overwritten
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - standard
+  - rubocop-performance
+  - standard-performance
+  - rubocop-rspec
+
+inherit_gem:
+  standard: config/base.yml
+  standard-performance: config/base.yml
 
-Metrics/LineLength:
-  Max: 120
+AllCops:
+  TargetRubyVersion: 3.1
+  SuggestExtensions: false
+  NewCops: disable
+  Exclude:
+    - ext/**/*
+    - gemfiles/**/*
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
 
 Style/FrozenStringLiteralComment:
   Enabled: true
   EnforcedStyle: always
+  SafeAutoCorrect: true
 
-Layout/TrailingBlankLines:
-  Enabled: true
-
-Layout/TrailingWhitespace:
-  Enabled: true
+# TODO: need to work on specs.
+RSpec:
+  Enabled: false
 
-Style/FrozenStringLiteralComment:
-  Enabled: true
-
-Style/RedundantFreeze:
-  Enabled: true
-
-Performance/UnfreezeString:
-  Enabled: true
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - spec/**/*

data/Appraisals

@@ -1,17 +1,28 @@
-appraise "6.1.0" do
-  gem "activesupport", "~> 6.1.0"
-  gem "activemodel", "~> 6.1.0"
-  gem "activerecord", "~> 6.1.0", group: :test
+# frozen_string_literal: true
+
+appraise "7.2.0" do
+  gem "activesupport", "~> 7.2.0"
+  gem "activemodel", "~> 7.2.0"
+  gem "activerecord", "~> 7.2.0", group: :test
+
+  gem "trilogy"
+  gem "sqlite3", "~> 1.4"
 end
 
-appraise "7.0.0" do
-  gem "activesupport", "~> 7.0.0"
-  gem "activemodel", "~> 7.0.0"
-  gem "activerecord", "~> 7.0.0", group: :test
+appraise "8.0.0" do
+  gem "activesupport", "~> 8.0.0"
+  gem "activemodel", "~> 8.0.0"
+  gem "activerecord", "~> 8.0.0", group: :test
+
+  gem "trilogy"
+  gem "sqlite3", ">= 2.1"
 end
 
-appraise "7.1.0" do
-  gem "activesupport", "~> 7.1.0"
-  gem "activemodel", "~> 7.1.0"
-  gem "activerecord", "~> 7.1.0", group: :test
+appraise "8.1.0" do
+  gem "activesupport", "~> 8.1.0"
+  gem "activemodel", "~> 8.1.0"
+  gem "activerecord", "~> 8.1.0", group: :test
+
+  gem "trilogy"
+  gem "sqlite3", ">= 2.1"
 end

data/Gemfile

@@ -5,8 +5,9 @@ source "https://rubygems.org"
 gemspec
 
 group :benchmarks do
-  gem "sqlite3", "~> 1.4"
-  gem "pg", ">= 0.18", "< 2.0"
+  gem "vernier"
+  gem "stackprof"
+  gem "pg"
 
   gem "benchmark-ips"
   gem "active_model_serializers", "~> 0.10"
@@ -16,6 +17,7 @@ end
 
 group :test do
   gem "faker"
+  gem "temping"
 end
 
 group :development do
@@ -25,4 +27,11 @@ group :development do
   gem "rake-compiler"
 end
 
-gem "standard", group: [:development, :test]
+group :development, :test do
+  gem "rubocop"
+
+  gem "standard"
+  gem "standard-performance"
+  gem "rubocop-performance"
+  gem "rubocop-rspec"
+end

data/README.md

@@ -4,20 +4,20 @@
 
 Panko is a library which is inspired by ActiveModelSerializers 0.9 for serializing ActiveRecord/Ruby objects to JSON strings, fast.
 
-To achieve its [performance](https://panko.dev/docs/performance.html):
+To achieve its [performance](https://panko.dev/performance/):
 
 * Oj - Panko relies on Oj since it's fast and allows for incremental serialization using `Oj::StringWriter`
 * Serialization Descriptor - Panko computes most of the metadata ahead of time, to save time later in serialization.
 * Type casting — Panko does type casting by itself, instead of relying on ActiveRecord.
 
-To dig deeper about the performance choices, read [Design Choices](https://panko.dev/docs/design-choices.html).
+To dig deeper about the performance choices, read [Design Choices](https://panko.dev/design-choices/).
 
 
 Support
 -------
 
-- [Documentation](https://panko.dev/docs)
-- [Getting Started](https://panko.dev/docs/getting-started.html)
+- [Documentation](https://panko.dev/)
+- [Getting Started](https://panko.dev/getting-started/)
 
 License
 -------

data/Rakefile

@@ -6,7 +6,7 @@ require "json"
 require "terminal-table"
 require "rake/extensiontask"
 require "pty"
-require "standard/rake"
+require "rubocop/rake_task"
 
 gem = Gem::Specification.load(File.dirname(__FILE__) + "/panko_serializer.gemspec")
 
@@ -24,6 +24,8 @@ Rake::Task[:compile].prerequisites << :clean
 
 task default: :spec
 
+RuboCop::RakeTask.new
+
 def print_and_flush(str)
   print str
   $stdout.flush

data/benchmarks/allocs.rb

@@ -10,8 +10,8 @@ class PostFastSerializer < Panko::Serializer
   attributes :id, :body, :title, :author_id
 end
 
-def count_allocs(&block)
-  memory_report = MemoryProfiler.report(&block)
+def count_allocs(&)
+  memory_report = MemoryProfiler.report(&)
   puts memory_report.pretty_print
 end
 

data/benchmarks/benchmarking_support.rb

@@ -9,7 +9,8 @@ module Benchmark
     def data
       posts = Post.all.includes(:author).to_a
       posts_50 = posts.first(50).to_a
-      {all: posts, small: posts_50}
+      posts_single = posts.first(1).to_a
+      {all: posts, small: posts_50, single: posts_single}
     end
 
     def run(label = nil, time: 10, disable_gc: true, warmup: 3, &block)

data/benchmarks/bm_ams_0_10.rb

@@ -5,7 +5,7 @@ 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(File::NULL))
 
 class AmsAuthorFastSerializer < ActiveModel::Serializer
   attributes :id, :name
@@ -24,17 +24,13 @@ end
 def benchmark_ams(prefix, serializer, options = {})
   merged_options = options.merge(each_serializer: serializer)
 
-  data = Benchmark.data
-  posts = data[:all]
-  posts_50 = data[:small]
+  posts = Benchmark.data[:all]
 
   Benchmark.run("AMS_#{prefix}_Posts_#{posts.count}") do
     ActiveModelSerializers::SerializableResource.new(posts, merged_options).to_json
   end
 
-  data = Benchmark.data
-  posts = data[:all]
-  posts_50 = data[:small]
+  posts_50 = Benchmark.data[:small]
 
   Benchmark.run("AMS_#{prefix}_Posts_50") do
     ActiveModelSerializers::SerializableResource.new(posts_50, merged_options).to_json

data/benchmarks/bm_panko_json.rb

@@ -37,9 +37,7 @@ class AuthorWithHasManyFastSerializer < Panko::Serializer
 end
 
 def benchmark(prefix, serializer, options = {})
-  data = Benchmark.data
-  posts = data[:all]
-  posts_50 = data[:small]
+  posts = Benchmark.data[:all]
 
   merged_options = options.merge(each_serializer: serializer)
 
@@ -47,9 +45,7 @@ def benchmark(prefix, serializer, options = {})
     Panko::ArraySerializer.new(posts, merged_options).to_json
   end
 
-  data = Benchmark.data
-  posts = data[:all]
-  posts_50 = data[:small]
+  posts_50 = Benchmark.data[:small]
 
   Benchmark.run("Panko_ActiveRecord_#{prefix}_Posts_50") do
     Panko::ArraySerializer.new(posts_50, merged_options).to_json

data/benchmarks/bm_panko_object.rb

@@ -25,9 +25,7 @@ class AuthorWithHasManyFastSerializer < Panko::Serializer
 end
 
 def benchmark(prefix, serializer, options = {})
-  data = Benchmark.data
-  posts = data[:all]
-  posts_50 = data[:small]
+  posts = Benchmark.data[:all]
 
   merged_options = options.merge(each_serializer: serializer)
 
@@ -35,9 +33,7 @@ def benchmark(prefix, serializer, options = {})
     Panko::ArraySerializer.new(posts, merged_options).to_a
   end
 
-  data = Benchmark.data
-  posts = data[:all]
-  posts_50 = data[:small]
+  posts_50 = Benchmark.data[:small]
 
   Benchmark.run("Panko_ActiveRecord_#{prefix}_Posts_50") do
     Panko::ArraySerializer.new(posts_50, merged_options).to_a

data/benchmarks/bm_plain_object.rb

@@ -78,7 +78,6 @@ end
 def benchmark(prefix, serializer, options = {})
   data = benchmark_data
   posts = data[:all]
-  posts_50 = data[:small]
 
   merged_options = options.merge(each_serializer: serializer)
 
@@ -86,9 +85,7 @@ def benchmark(prefix, serializer, options = {})
     Panko::ArraySerializer.new(posts, merged_options).to_json
   end
 
-  data = benchmark_data
-  posts = data[:all]
-  posts_50 = data[:small]
+  posts_50 = benchmark_data[:small]
 
   Benchmark.run("Panko_Plain_#{prefix}_Posts_50") do
     Panko::ArraySerializer.new(posts_50, merged_options).to_json

data/benchmarks/bm_serialization_descriptor.rb

@@ -6,7 +6,7 @@ require "active_support"
 require "panko_serializer"
 
 def generate_attributes(count)
-  (1..count).map { |i| "attr_#{i}".to_sym }
+  (1..count).map { |i| :"attr_#{i}" }
 end
 
 class LeafASerializer < Panko::Serializer

data/benchmarks/bm_to_object.rb

@@ -62,9 +62,7 @@ class AuthorWithHasManyFastSerializer < Panko::Serializer
 end
 
 def benchmark(prefix, serializer, options = {})
-  data = Benchmark.data
-  posts = data[:all]
-  posts_50 = data[:small]
+  posts = Benchmark.data[:all]
 
   merged_options = options.merge(each_serializer: serializer)
 
@@ -72,9 +70,7 @@ def benchmark(prefix, serializer, options = {})
     Panko::ArraySerializer.new(posts, merged_options).to_a
   end
 
-  data = Benchmark.data
-  posts = data[:all]
-  posts_50 = data[:small]
+  posts_50 = Benchmark.data[:small]
 
   Benchmark.run("Panko_#{prefix}_Posts_50") do
     Panko::ArraySerializer.new(posts_50, merged_options).to_a

data/benchmarks/profile.rb

@@ -78,8 +78,8 @@ def request(method, path)
   response
 end
 
-def memory(&block)
-  mem = MemoryProfiler.report(&block)
+def memory(&)
+  mem = MemoryProfiler.report(&)
   mem.pretty_print
 end
 

data/benchmarks/sanity.rb

@@ -62,9 +62,7 @@ class AuthorWithHasManyFastSerializer < Panko::Serializer
 end
 
 def benchmark(prefix, serializer, options = {})
-  data = Benchmark.data
-  posts = data[:all]
-  posts_50 = data[:small]
+  posts = Benchmark.data[:all]
 
   merged_options = options.merge(each_serializer: serializer)
 
@@ -72,9 +70,7 @@ def benchmark(prefix, serializer, options = {})
     Panko::ArraySerializer.new(posts, merged_options).to_json
   end
 
-  data = Benchmark.data
-  posts = data[:all]
-  posts_50 = data[:small]
+  posts_50 = Benchmark.data[:small]
 
   Benchmark.run("Panko_#{prefix}_Posts_50") do
     Panko::ArraySerializer.new(posts_50, merged_options).to_json

data/benchmarks/setup.rb

@@ -5,6 +5,7 @@
 ##########################################
 require "active_record"
 require "sqlite3"
+require "securerandom"
 
 # Change the following to reflect your database settings
 ActiveRecord::Base.establish_connection(
@@ -46,9 +47,9 @@ Author.destroy_all
 Post.transaction do
   ENV.fetch("ITEMS_COUNT", "2300").to_i.times do
     Post.create(
-      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"),
+      body: SecureRandom.hex(30),
+      title: SecureRandom.hex(20),
+      author: Author.create(name: SecureRandom.alphanumeric),
       data: {a: 1, b: 2, c: 3}
     )
   end

data/benchmarks/type_casts/support.rb

@@ -25,4 +25,3 @@ def check_if_exists(module_name)
 end
 
 Time.zone = "UTC"
-ActiveSupport::Deprecation.behavior = :stderr