panko_serializer 0.8.4 → 1.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panko_serializer
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Yosi Attias
@@ -35,14 +35,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -60,110 +60,60 @@ dependencies:
 email:
 - yosy101@gmail.com
 executables: []
-extensions:
-- ext/panko_serializer/extconf.rb
+extensions: []
 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
-- ext/panko_serializer/attributes_writer/attributes_writer.h
-- ext/panko_serializer/attributes_writer/common.c
-- ext/panko_serializer/attributes_writer/common.h
-- ext/panko_serializer/attributes_writer/hash.c
-- ext/panko_serializer/attributes_writer/hash.h
-- ext/panko_serializer/attributes_writer/plain.c
-- ext/panko_serializer/attributes_writer/plain.h
-- ext/panko_serializer/attributes_writer/type_cast/time_conversion.c
-- ext/panko_serializer/attributes_writer/type_cast/time_conversion.h
-- ext/panko_serializer/attributes_writer/type_cast/type_cast.c
-- ext/panko_serializer/attributes_writer/type_cast/type_cast.h
-- ext/panko_serializer/common.h
-- ext/panko_serializer/extconf.rb
-- ext/panko_serializer/panko_serializer.c
-- ext/panko_serializer/panko_serializer.h
-- ext/panko_serializer/serialization_descriptor/association.c
-- ext/panko_serializer/serialization_descriptor/association.h
-- ext/panko_serializer/serialization_descriptor/attribute.c
-- 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
-- lib/panko/object_writer.rb
+- lib/panko/code_gen.rb
+- lib/panko/code_gen/active_record/access_classifier.rb
+- lib/panko/code_gen/active_record/define_attribute_methods.rb
+- lib/panko/code_gen/code_builder.rb
+- lib/panko/code_gen/compile_cache.rb
+- lib/panko/code_gen/compiler.rb
+- lib/panko/code_gen/config.rb
+- lib/panko/code_gen/datetime_format.rb
+- lib/panko/code_gen/descriptor.rb
+- lib/panko/code_gen/descriptor_builder.rb
+- lib/panko/code_gen/dump.rb
+- lib/panko/code_gen/errors.rb
+- lib/panko/code_gen/filter.rb
+- lib/panko/code_gen/filter_adapter.rb
+- lib/panko/code_gen/filters/indexed.rb
+- lib/panko/code_gen/filters/none.rb
+- lib/panko/code_gen/generator.rb
+- lib/panko/code_gen/generators/banner.rb
+- lib/panko/code_gen/generators/class_emitter.rb
+- lib/panko/code_gen/generators/cycle_membership.rb
+- lib/panko/code_gen/generators/descriptor_walk.rb
+- lib/panko/code_gen/generators/fanout.rb
+- lib/panko/code_gen/generators/field_index.rb
+- lib/panko/code_gen/generators/field_walk.rb
+- lib/panko/code_gen/generators/generated_names.rb
+- lib/panko/code_gen/generators/hash_sink.rb
+- lib/panko/code_gen/generators/json_sink.rb
+- lib/panko/code_gen/generators/record_access/generic.rb
+- lib/panko/code_gen/generators/record_access/specialized.rb
+- lib/panko/code_gen/generators/release.rb
+- lib/panko/code_gen/generators/sink.rb
+- lib/panko/code_gen/instance_pool.rb
+- lib/panko/code_gen/runtime.rb
+- lib/panko/code_gen/serializer_cache.rb
+- lib/panko/code_gen/validators/callable_arity.rb
+- lib/panko/code_gen/validators/name_uniqueness.rb
+- lib/panko/code_gen/validators/source_resolution.rb
+- lib/panko/code_gen/validators/validator.rb
+- lib/panko/code_gen/writers_pool.rb
+- lib/panko/compile_all.rb
+- lib/panko/compile_all_result.rb
+- lib/panko/config.rb
+- lib/panko/descriptor.rb
 - lib/panko/response.rb
-- lib/panko/serialization_descriptor.rb
 - lib/panko/serializer.rb
 - lib/panko/serializer_resolver.rb
 - lib/panko/version.rb
 - lib/panko_serializer.rb
-- panko_serializer.gemspec
 homepage: https://panko.dev
 licenses:
 - MIT
@@ -179,14 +129,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.20
 specification_version: 4
 summary: High Performance JSON Serialization for ActiveRecord & Ruby Objects
 test_files: []

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

data/benchmarks/BENCHMARKS.md

@@ -1,48 +0,0 @@
-## Initial state
-```
-Native_Posts_2300             57 ip/s      13802 allocs/op
-Native_Posts_50     2956 ip/s        302 allocs/op
-
-AMS_Simple_Posts_2300         21 ip/s      94309 allocs/op
-AMS_Simple_Posts_50         1008 ip/s       2059 allocs/op
-AMS_HasOne_Posts_2300          9 ip/s     147209 allocs/op
-AMS_HasOne_Posts_50          451 ip/s       3209 allocs/op
-
-Panko_HasOne_Posts_2300      164 ip/s       2372 allocs/op
-Panko_HasOne_Posts_50       6118 ip/s        122 allocs/op
-Panko_Reused_HasOne_Posts_2300       178 ip/s       2303 allocs/op
-Panko_Reused_HasOne_Posts_50        8203 ip/s         53 allocs/op
-
-Panko_Simple_Posts_2300      150 ip/s       2372 allocs/op
-Panko_Simple_Posts_50       5639 ip/s        122 allocs/op
-Panko_Reused_Simple_Posts_2300       180 ip/s       2303 allocs/op
-Panko_Reused_Simple_Posts_50        8388 ip/s         53 allocs/op
-```
-
-## Refactorings, method call support, combining
-
-### class eval
-```
-Panko_HasOne_Posts_2300       64 ip/s       9477 allocs/op
-Panko_HasOne_Posts_50       2397 ip/s        477 allocs/op
-Panko_Reused_HasOne_Posts_2300        70 ip/s       9423 allocs/op
-Panko_Reused_HasOne_Posts_50        2596 ip/s        423 allocs/op
-
-Panko_Simple_Posts_2300      191 ip/s       2472 allocs/op
-Panko_Simple_Posts_50       5128 ip/s        222 allocs/op
-Panko_Reused_Simple_Posts_2300       180 ip/s       2418 allocs/op
-Panko_Reused_Simple_Posts_50        5534 ip/s        168 allocs/op
-```
-
-### instance eval
-```
-Panko_HasOne_Posts_2300       60 ip/s       9473 allocs/op
-Panko_HasOne_Posts_50       2399 ip/s        473 allocs/op
-Panko_Reused_HasOne_Posts_2300        66 ip/s       9419 allocs/op
-Panko_Reused_HasOne_Posts_50        2582 ip/s        419 allocs/op
-
-Panko_Simple_Posts_2300      195 ip/s       2470 allocs/op
-Panko_Simple_Posts_50       4838 ip/s        220 allocs/op
-Panko_Reused_Simple_Posts_2300       196 ip/s       2416 allocs/op
-Panko_Reused_Simple_Posts_50        6241 ip/s        166 allocs/op
-```