panko_serializer 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b4397a54b1f806131ee07ccaaa4062bba8eb5490c3810e5c6c3cc405b7167ec
-  data.tar.gz: 8f3127a38fe93844c3a82aa8e2a30ea82312ef1b0ebdf66f86bcd4761c392749
+  metadata.gz: f713e7a7ea669bf0f3fa26ed2780c3f84a56a0faa0013f5514f6e732c49c86c3
+  data.tar.gz: b3eace69707162028e2ea379687cd7e3ee0d1bf8b2d1e68dda0402df3da9166e
 SHA512:
-  metadata.gz: 626bf9689a4be25a166a7ee3fe3b2274cfcc9b7bb17d57398d87301aca1c8039835d02ef37de647d62d3fa5c102cc22f752b2400e10240fa992d2007eaf9344c
-  data.tar.gz: 9a0048188abc83c9a064a0bb7721cc94a7f3965338f62a84fe4382a7b98f52941c1a1914f25dfee3bc7ed80168a1bb47f7def51954b9b1250029e4784f6f0a5d
+  metadata.gz: 0a12aa0fd1d42cd6b19867c87e278f5d0df045b25f2f93580a6c7e939d44d5859f7f3b983655d828cacafd20574e4278b620c89eabbccfdf387f17bc201dfcad
+  data.tar.gz: 5f0d4103ab1382af51d22278006a938bc013829878a709bded8e0564d87ee5f2d945ef3d93c5eadf9c9ee8d309adf416d1b6bea90c72ffac729af6a5b62e9ffe

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/performance/):
+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/design-choices/).
+To dig deeper about the performance choices, read [Design Choices](https://panko.dev/design-choices).
 
 
 Support
 -------
 
 - [Documentation](https://panko.dev/)
-- [Getting Started](https://panko.dev/getting-started/)
+- [Getting Started](https://panko.dev/getting-started)
 
 License
 -------

data/ext/panko_serializer/attributes_writer/type_cast/type_cast.c

@@ -34,21 +34,22 @@ static int initiailized = 0;
 VALUE cache_postgres_type_lookup(VALUE ar) {
   VALUE ar_connection_adapters, ar_postgresql, ar_oid;
 
-  ar_connection_adapters = rb_const_get_at(ar, rb_intern("ConnectionAdapters"));
-  if (ar_connection_adapters == Qundef) {
+  if (rb_const_defined_at(ar, rb_intern("ConnectionAdapters")) != (int)Qtrue) {
     return Qfalse;
   }
+  ar_connection_adapters = rb_const_get_at(ar, rb_intern("ConnectionAdapters"));
 
-  ar_postgresql =
-      rb_const_get_at(ar_connection_adapters, rb_intern("PostgreSQL"));
-  if (ar_postgresql == Qundef) {
+  if (rb_const_defined_at(ar_connection_adapters, rb_intern("PostgreSQL")) !=
+      (int)Qtrue) {
     return Qfalse;
   }
+  ar_postgresql =
+      rb_const_get_at(ar_connection_adapters, rb_intern("PostgreSQL"));
 
-  ar_oid = rb_const_get_at(ar_postgresql, rb_intern("OID"));
-  if (ar_oid == Qundef) {
+  if (rb_const_defined_at(ar_postgresql, rb_intern("OID")) != (int)Qtrue) {
     return Qfalse;
   }
+  ar_oid = rb_const_get_at(ar_postgresql, rb_intern("OID"));
 
   if (rb_const_defined_at(ar_oid, rb_intern("Float")) == (int)Qtrue) {
     ar_pg_float_type = rb_const_get_at(ar_oid, rb_intern("Float"));
@@ -85,18 +86,23 @@ VALUE cache_time_zone_type_lookup(VALUE ar) {
   VALUE ar_attr_methods, ar_time_zone_conversion;
 
   // ActiveRecord::AttributeMethods
-  ar_attr_methods = rb_const_get_at(ar, rb_intern("AttributeMethods"));
-  if (ar_attr_methods == Qundef) {
+  if (rb_const_defined_at(ar, rb_intern("AttributeMethods")) != (int)Qtrue) {
     return Qfalse;
   }
+  ar_attr_methods = rb_const_get_at(ar, rb_intern("AttributeMethods"));
 
   // ActiveRecord::AttributeMethods::TimeZoneConversion
+  if (rb_const_defined_at(ar_attr_methods, rb_intern("TimeZoneConversion")) !=
+      (int)Qtrue) {
+    return Qfalse;
+  }
   ar_time_zone_conversion =
       rb_const_get_at(ar_attr_methods, rb_intern("TimeZoneConversion"));
-  if (ar_time_zone_conversion == Qundef) {
+
+  if (rb_const_defined_at(ar_time_zone_conversion,
+                          rb_intern("TimeZoneConverter")) != (int)Qtrue) {
     return Qfalse;
   }
-
   ar_time_zone_converter =
       rb_const_get_at(ar_time_zone_conversion, rb_intern("TimeZoneConverter"));
 
@@ -136,11 +142,16 @@ void cache_type_lookup() {
     ar_json_type = rb_const_get_at(ar_type, rb_intern("Json"));
   }
 
-  // TODO: if we get error or not, add this to some debug log
   int isErrored;
   rb_protect(cache_postgres_type_lookup, ar, &isErrored);
+  if (isErrored) {
+    rb_set_errinfo(Qnil);
+  }
 
   rb_protect(cache_time_zone_type_lookup, ar, &isErrored);
+  if (isErrored) {
+    rb_set_errinfo(Qnil);
+  }
 }
 
 bool is_string_or_text_type(VALUE type_klass) {

data/lib/panko/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Panko
-  VERSION = "0.8.4"
+  VERSION = "0.8.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panko_serializer
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Yosi Attias
@@ -64,65 +64,8 @@ extensions:
 - ext/panko_serializer/extconf.rb
 extra_rdoc_files: []
 files:
-- ".clang-format"
-- ".github/dependabot.yml"
-- ".github/workflows/database_matrix.yml"
-- ".github/workflows/docs.yml"
-- ".github/workflows/lint.yml"
-- ".github/workflows/tests.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- Appraisals
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- benchmarks/BENCHMARKS.md
-- benchmarks/allocs.rb
-- benchmarks/app.rb
-- benchmarks/benchmarking_support.rb
-- benchmarks/bm_ams_0_10.rb
-- benchmarks/bm_object_writer.rb
-- benchmarks/bm_panko_json.rb
-- benchmarks/bm_panko_object.rb
-- benchmarks/bm_plain_object.rb
-- benchmarks/bm_serialization_descriptor.rb
-- benchmarks/bm_serializer_resolver.rb
-- benchmarks/bm_to_object.rb
-- benchmarks/profile.rb
-- benchmarks/sanity.rb
-- benchmarks/setup.rb
-- benchmarks/type_casts/bm_active_record.rb
-- benchmarks/type_casts/bm_panko.rb
-- benchmarks/type_casts/support.rb
-- docs/docs/associations.md
-- docs/docs/attributes.md
-- docs/docs/design-choices.md
-- docs/docs/getting-started.md
-- docs/docs/introduction.md
-- docs/docs/performance.md
-- docs/docs/response-bag.md
-- docs/docusaurus.config.js
-- docs/package-lock.json
-- docs/package.json
-- docs/sidebars.json
-- docs/src/css/customTheme.css
-- docs/static/.DS_Store
-- docs/static/CNAME
-- docs/static/css/custom.css
-- docs/static/img/favicon.ico
-- docs/static/img/oss_logo.png
-- docs/static/img/undraw_code_review.svg
-- docs/static/img/undraw_monitor.svg
-- docs/static/img/undraw_note_list.svg
-- docs/static/img/undraw_online.svg
-- docs/static/img/undraw_open_source.svg
-- docs/static/img/undraw_operating_system.svg
-- docs/static/img/undraw_react.svg
-- docs/static/img/undraw_tweetstorm.svg
-- docs/static/img/undraw_youtube_tutorial.svg
-- docs/static/index.html
 - ext/panko_serializer/attributes_writer/active_record.c
 - ext/panko_serializer/attributes_writer/active_record.h
 - ext/panko_serializer/attributes_writer/attributes_writer.c
@@ -147,12 +90,6 @@ files:
 - ext/panko_serializer/serialization_descriptor/attribute.h
 - ext/panko_serializer/serialization_descriptor/serialization_descriptor.c
 - ext/panko_serializer/serialization_descriptor/serialization_descriptor.h
-- gemfiles/7.2.0.gemfile
-- gemfiles/7.2.0.gemfile.lock
-- gemfiles/8.0.0.gemfile
-- gemfiles/8.0.0.gemfile.lock
-- gemfiles/8.1.0.gemfile
-- gemfiles/8.1.0.gemfile.lock
 - lib/panko/array_serializer.rb
 - lib/panko/association.rb
 - lib/panko/attribute.rb
@@ -163,7 +100,6 @@ files:
 - lib/panko/serializer_resolver.rb
 - lib/panko/version.rb
 - lib/panko_serializer.rb
-- panko_serializer.gemspec
 homepage: https://panko.dev
 licenses:
 - MIT

data/.clang-format

@@ -1,3 +0,0 @@
----
-Language:        Cpp
-BasedOnStyle:  Google

data/.github/dependabot.yml

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

data/.github/workflows/database_matrix.yml

@@ -1,85 +0,0 @@
-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

@@ -1,39 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Docs Publishing
-
-on:
- push:
-   branches: [ master, docup ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-    env:
-      working_directory: 'docs/'
-
-    steps:
-    - uses: actions/checkout@v5
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: '20.x'
-
-    - name: Install Dependencies
-      working-directory: ${{ env.working_directory }}
-      run: npm install
-
-    - name: Install SSH Client 🔑
-      uses: webfactory/ssh-agent@v0.6.0
-      with:
-        ssh-private-key: ${{ secrets.DEPLOY_KEY }}
-
-    - name: Publish
-      working-directory: ${{ env.working_directory }}
-      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 deploy
-

data/.github/workflows/lint.yml

@@ -1,30 +0,0 @@
-name: Lint
-
-on: [push, pull_request]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v5
-
-      - name: Install deps
-        run: |
-          sudo apt update -y
-          sudo apt install -y libsqlite3-dev
-
-      - 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.16.0
-        with:
-          clang-format-version: "16"
-          check-path: "ext/panko_serializer"
-          fallback-style: "Google"

data/.github/workflows/tests.yml

@@ -1,34 +0,0 @@
-name: Panko Serializer CI
-
-on: [push, pull_request]
-
-jobs:
-  tests:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ["3.2", "3.3", "3.4"]
-        rails: ["7.2.0", "8.0.0", "8.1.0"]
-
-    steps:
-      - name: Install deps
-        run: |
-          sudo apt update -y
-          sudo apt install -y libsqlite3-dev
-
-      - uses: actions/checkout@v5
-      - 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
-
-      - name: Compile & test
-        env:
-          BUNDLE_GEMFILE: gemfiles/${{ matrix.rails }}.gemfile
-        run: |
-          bundle exec rake

data/.gitignore

@@ -1,20 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/vendor/bundle/
-.byebug_history
-*.bundle
-
-# rspec failure tracking
-.rspec_status
-node_modules
-
-/docs/build/
-.cache/
-.docusaurus/

data/.rspec

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

data/.rubocop.yml

@@ -1,37 +0,0 @@
-# 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
-
-AllCops:
-  TargetRubyVersion: 3.1
-  SuggestExtensions: false
-  NewCops: disable
-  Exclude:
-    - ext/**/*
-    - gemfiles/**/*
-
-
-Style/FrozenStringLiteralComment:
-  Enabled: true
-  EnforcedStyle: always
-  SafeAutoCorrect: true
-
-# TODO: need to work on specs.
-RSpec:
-  Enabled: false
-
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - spec/**/*

data/Appraisals

@@ -1,28 +0,0 @@
-# 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 "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 "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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec
-
-group :benchmarks do
-  gem "vernier"
-  gem "stackprof"
-  gem "pg"
-
-  gem "benchmark-ips"
-  gem "active_model_serializers", "~> 0.10"
-  gem "terminal-table"
-  gem "memory_profiler"
-end
-
-group :test do
-  gem "faker"
-  gem "temping"
-end
-
-group :development do
-  gem "byebug"
-  gem "rake"
-  gem "rspec", "~> 3.0"
-  gem "rake-compiler"
-end
-
-group :development, :test do
-  gem "rubocop"
-
-  gem "standard"
-  gem "standard-performance"
-  gem "rubocop-performance"
-  gem "rubocop-rspec"
-end

data/Rakefile

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "json"
-require "terminal-table"
-require "rake/extensiontask"
-require "pty"
-require "rubocop/rake_task"
-
-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
-Rake::Task[:compile].prerequisites << :clean
-
-task default: :spec
-
-RuboCop::RakeTask.new
-
-def print_and_flush(str)
-  print str
-  $stdout.flush
-end
-
-def run_process(cmd)
-  puts "> Running #{cmd}"
-  lines = []
-  _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
-rescue PTY::ChildExited
-  puts "The child process exited! - #{cmd}"
-  []
-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|
-      row = JSON.parse(line)
-      row.values
-    rescue JSON::ParserError
-      puts "> [ERROR] Failed running #{benchmark_file} - #{lines.join}"
-    end
-
-    puts "\n\n"
-    title = File.basename(benchmark_file, ".rb")
-    table = Terminal::Table.new title: title, headings: headings, rows: rows
-    puts table
-  end
-end
-
-namespace :benchmarks do
-  desc "All"
-  task :all do
-    run_benchmarks Dir[File.join(__dir__, "benchmarks", "**", "bm_*")]
-  end
-
-  desc "Type Casts"
-  task :type_casts do
-    run_benchmarks Dir[File.join(__dir__, "benchmarks", "type_casts", "bm_*")], items_count: 0
-  end
-
-  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
-
-    puts "\n\n"
-  end
-end