panko_serializer 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30c234d90f13454e0f54347e0b98ed6c1e3f935ef25769d55c825a462021f66b
-  data.tar.gz: 3c49a951469fad5249307c3569b1f9a1c03763f2cd961ed94ef19684ae63f0ab
+  metadata.gz: e04b05a5a9a72ce68ad0768dd84b403e4adb6cefa8226f89c30a09d480993481
+  data.tar.gz: 1d7ff5f7b035a497e4b7d48e9749bfc13c3861cfb067b53b167b54c2ce5c8822
 SHA512:
-  metadata.gz: dcce669e933459d36d033abc5d94494b5aa6333c1fe97e3015609e6eaabc27a3d7d2376c328bbbd53f941b238c67725b6130a64e9bf313b90cb10800ed2c0af9
-  data.tar.gz: 1f83c4d03e1a175976044d78e920ab4864b9973569fc945f510f773a02ca06190e81557d259741b0fd15abf1b23eec2ebda6951bcb2e862fb83f177b78945fac
+  metadata.gz: 9bcb10f0e30eb48277dcdc9eea463dd475e892ed6eca37818d0d21eb9978cabeb1d0c7b1b8989ff69c1dc5c9b958fe8d0d073f0861d4b7207054e33677d615e7
+  data.tar.gz: 98846622471bed88140fe737f12144e9221e8a439c181c45d3e4ae1cd95aef265e640dd5bb4fda1d6beb8f4fc1f6eecc016620d31b9ec2a51fec6cc214683830

data/.github/dependabot.yml

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

data/.github/workflows/docs.yml

@@ -5,7 +5,7 @@ name: Docs Publishing
 
 on:
  push:
-   branches: [ master ]
+   branches: [ master, docup ]
 
 jobs:
   build:
@@ -17,9 +17,9 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - 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

@@ -8,28 +8,22 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - 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
-        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.13.0
         with:
           clang-format-version: "16"
           check-path: "ext/panko_serializer"

data/.github/workflows/ruby.yml

@@ -8,24 +8,28 @@ jobs:
     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.1", "3.2", "3.3"]
+        rails: ["7.0.0", "7.1.0", "7.2.0", "8.0.0"]
+        exclude:
+          - ruby: 3.1
+            rails: 8.0.0
 
     steps:
+      - name: Install deps
+        run: |
+          sudo apt update -y
+          sudo apt install -y libsqlite3-dev
+
       - 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/cache@v4
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-${{ matrix.ruby }}-${{ matrix.rails }}-gem

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,29 @@
-appraise "6.1.0" do
-  gem "activesupport", "~> 6.1.0"
-  gem "activemodel", "~> 6.1.0"
-  gem "activerecord", "~> 6.1.0", group: :test
-end
+# frozen_string_literal: true
 
 appraise "7.0.0" do
+  gem "sqlite3", "~> 1.4"
   gem "activesupport", "~> 7.0.0"
   gem "activemodel", "~> 7.0.0"
   gem "activerecord", "~> 7.0.0", group: :test
 end
 
 appraise "7.1.0" do
-  gem "activesupport", "~> 7.1.0"
-  gem "activemodel", "~> 7.1.0"
-  gem "activerecord", "~> 7.1.0", group: :test
+  gem "sqlite3", "~> 1.4"
+  gem "activesupport", "~> 7.1.5"
+  gem "activemodel", "~> 7.1.5"
+  gem "activerecord", "~> 7.1.5", group: :test
+end
+
+appraise "7.2.0" do
+  gem "sqlite3", "~> 1.4"
+  gem "activesupport", "~> 7.2.0"
+  gem "activemodel", "~> 7.2.0"
+  gem "activerecord", "~> 7.2.0", group: :test
+end
+
+appraise "8.0.0" do
+  gem "sqlite3", ">= 2.1"
+  gem "activesupport", "~> 8.0.0"
+  gem "activemodel", "~> 8.0.0"
+  gem "activerecord", "~> 8.0.0", group: :test
 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"
@@ -25,4 +26,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/docs/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/docs/design-choices/).
 
 
 Support
 -------
 
 - [Documentation](https://panko.dev/docs)
-- [Getting Started](https://panko.dev/docs/getting-started.html)
+- [Getting Started](https://panko.dev/docs/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

data/docs/docs/associations.md

@@ -3,18 +3,19 @@ id: associations
 title: Associations
 sidebar_label: Associations
 ---
-
 A serializer can define it's own associations - both `has_many` and `has_one` to serializer under the context of the object.
 
 For example:
 
 ```ruby
+
 class PostSerializer < Panko::Serializer
   attributes :title, :body
 
   has_one :author, serializer: AuthorSerializer
   has_many :comments, each_serializer: CommentSerializer
 end
+
 ```
 
 ### Associations with aliases
@@ -23,33 +24,40 @@ An association key name can be aliased with the `name` option.
 
 For example:
 the `actual_author` property will be converted to `alias_author`.
+
 ```ruby
+
 class PostSerializer < Panko::Serializer
   attributes :title, :body
 
   has_one :actual_author, serializer: AuthorSerializer, name: :alias_author
   has_many :comments, each_serializer: CommentSerializer
 end
+
 ```
+
 ### Inference
 
 Panko can find the type of the serializer by looking at the realtionship name, so instead specifying
 the serializer at the above example, we can -
 
 ```ruby
+
 class PostSerializer < Panko::Serializer
   attributes :title, :body
 
   has_one :author
   has_many :comments
 end
+
 ```
 
 The logic of inferencing is -
-- Take the name of the relationship (for example - `:author` / `:comments`) singularize and camelize it
-- Look for const defined with the name aboe and "Serializer" suffix (by using `Object.const_get`)
 
-> If Panko can't find the serializer it will throw an error on startup time, for example: `Can't find serializer for PostSerializer.author has_one relationship`
+-   Take the name of the relationship (for example - `:author` / `:comments`) singularize and camelize it
+-   Look for const defined with the name aboe and "Serializer" suffix (by using `Object.const_get`)
+
+&gt; If Panko can't find the serializer it will throw an error on startup time, for example: `Can't find serializer for PostSerializer.author has_one relationship`
 
 ## Nested Filters
 
@@ -61,6 +69,7 @@ For example, let's say one portion of the application needs to serializer list o
 We can declare tailored serializer for this, or we can re-use the above defined serializer - `PostSerializer` and use nested filters.
 
 ```ruby
+
 posts = Post.all
 
 Panko::ArraySerializer.new(posts, each_serializer: PostSerializer, only: {
@@ -68,17 +77,20 @@ Panko::ArraySerializer.new(posts, each_serializer: PostSerializer, only: {
   author: [:id],
   comments: [:id],
 })
+
 ```
 
 Let's dissect `only` option we passed -
-* `instance` - list of attributes (and associations) we want to serializer for current instance of the serializer, in this case - `PostSerializer`.
-* `author`, `comments` - here we specify the list of attributes we want to serialize for each association.
+
+-   `instance` - list of attributes (and associations) we want to serializer for current instance of the serializer, in this case - `PostSerializer`.
+-   `author`, `comments` - here we specify the list of attributes we want to serialize for each association.
 
 It's important to note that Nested Filters, are recursive, in other words, we can filter the association's associations.
 
 For example, `CommentSerializer` have has_one association `Author`, and for each `comments.author` we only it's name.
 
 ```ruby
+
 posts = Post.all
 
 Panko::ArraySerializer.new(posts, only: {
@@ -89,6 +101,7 @@ Panko::ArraySerializer.new(posts, only: {
     author: [:name]
   }
 })
+
 ```
 
 As you see now in `comments` the `instance` have different meaning, the `CommentSerializer`.