serialbench 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e90d8b6ebc8deebf308b1e02214b978597d0d2a9699c3845ebf6405953d733b7
-  data.tar.gz: 4cc9e46139f7054919657d66fd26ed6b40430856e0bdd317f2677451bc1bf715
+  metadata.gz: 7267d278bec24e38ca217bfbf164c10411f03b4fb333295f05c617c56f91a8b8
+  data.tar.gz: fcf4034a75ee9615197e2fd0cd3e7b63a795c7f3f0b1ba2c3b1cd0170babecb6
 SHA512:
-  metadata.gz: 38652e0714893c8ed9590fe1a7ef29c9c6e94cdbdcb0104d9190d12bad1c95f8635680b904d66b9edda72f55f7c037ce5e18894bf5fb66d5b88db21ba2dcaa3d
-  data.tar.gz: 728e8ee7c92138afdfd722cfb93ef7463c22e7d1c8882e5d83507dba7861637addd659e489df21c91a80a45680fc532eb0898f9ffed9ce48402a604962b73c85
+  metadata.gz: 4acd59cfc6d0b8d47d1d09172ea2f034063633ba5435fccc2fcfbd35ec11d96d41080210d84d149423979b3e14873cf3833512d36917515dfdb0ccdb698dfc1f
+  data.tar.gz: a913c26df13272e009996925fc6dd4789f74c6f968d27cd02da6155b71f1026d03e8bc2bb1cef1ba400ca19170b3c5a7f0d04ab125658ebf8a54c14551c5607b

data/.github/workflows/benchmark.yml

@@ -3,11 +3,7 @@ name: benchmark-weekly
 on:
   push:
     branches: [main]
-    paths-ignore:
-      - '.github/workflows/windows-debug.yml'
   pull_request:
-    paths-ignore:
-      - '.github/workflows/windows-debug.yml'
   schedule:
     # Run benchmarks weekly on Sundays at 2 AM UTC
     - cron: '0 2 * * 0'

data/.github/workflows/rake.yml

@@ -1,26 +1,23 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
 name: rake
 
 on:
   push:
-    branches: [ master, main ]
+    branches: [ main ]
     tags: [ v* ]
-    paths-ignore:
-      - '.github/workflows/windows-debug.yml'
   pull_request:
-    paths-ignore:
-      - '.github/workflows/windows-debug.yml'
+
+permissions:
+  contents: read
 
 jobs:
-  rake:
-    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
-    with:
-      before-setup-ruby: |
-        vcpkg install libxml2:x64-windows 2>&1 || true
-        vcpkg integrate install 2>&1 || true
-        mkdir -p .bundle 2>&1 || true
-        echo "---" > .bundle/config 2>&1 || true
-        echo 'BUNDLE_BUILD__LIBXML___RUBY: "--with-xml2-dir=C:/vcpkg/installed/x64-windows --with-xml2-include=C:/vcpkg/installed/x64-windows/include/libxml2 --with-xml2-lib=C:/vcpkg/installed/x64-windows/lib"' >> .bundle/config 2>&1 || true
-    secrets:
-      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+  rspec:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - run: bundle exec rspec --format progress

data/config/benchmarks/full-json.yml

@@ -17,8 +17,8 @@ iterations:
   large: 1
 
 operations:
-- parse
-- generate
+- parsing
+- generation
 - streaming
 - memory
 

data/config/benchmarks/full-toml.yml

@@ -17,8 +17,8 @@ iterations:
   large: 1
 
 operations:
-- parse
-- generate
+- parsing
+- generation
 - streaming
 - memory
 

data/config/benchmarks/full-xml.yml

@@ -17,8 +17,8 @@ iterations:
   large: 1
 
 operations:
-- parse
-- generate
+- parsing
+- generation
 - streaming
 - xpath
 - memory

data/config/benchmarks/full-yaml.yml

@@ -17,8 +17,8 @@ iterations:
   large: 1
 
 operations:
-- parse
-- generate
+- parsing
+- generation
 - streaming
 - memory
 

data/config/benchmarks/full.yml

@@ -25,8 +25,8 @@ iterations:
   large: 1
 
 operations:
-- parse
-- generate
+- parsing
+- generation
 - streaming
 - xpath
 - memory

data/config/benchmarks/short.yml

@@ -19,8 +19,8 @@ iterations:
   large: 1
 
 operations:
-- parse
-- generate
+- parsing
+- generation
 - streaming
 
 warmup: 2

data/lib/serialbench/benchmark_runner.rb

@@ -21,6 +21,7 @@ module Serialbench
       @serializers = Serializers.available
       @test_data = {}
       @results = []
+      validate_operations!
       load_test_data
     end
 
@@ -45,11 +46,13 @@ module Serialbench
       puts "Test data sizes: #{@test_data.keys.join(', ')}"
       puts
 
+      selected = @benchmark_config.operations
+      selected = OPERATIONS.keys + ['memory'] if selected.nil? || selected.empty?
       results = {}
       OPERATIONS.each do |name, handler|
-        results[name.to_sym] = run_benchmark_type(name, name, &handler)
+        results[name.to_sym] = selected.include?(name) ? run_benchmark_type(name, name, &handler) : []
       end
-      results[:memory] = run_memory_benchmarks
+      results[:memory] = selected.include?('memory') ? run_memory_benchmarks : []
 
       Models::BenchmarkResult.new(
         serializers: Serializers.information,
@@ -165,6 +168,13 @@ module Serialbench
       end
     end
 
+    def validate_operations!
+      unknown = (@benchmark_config.operations || []) - (OPERATIONS.keys + ['memory'])
+      return if unknown.empty?
+
+      raise ArgumentError, "unknown operations #{unknown.inspect}; expected: #{OPERATIONS.keys.join(', ')}, memory"
+    end
+
     def load_test_data
       @test_data = TestData.load(@benchmark_config)
     end

data/lib/serialbench/cli/benchmark_cli.rb

@@ -284,7 +284,6 @@ module Serialbench
 
         say '✅ Local benchmark completed successfully!', :green
         say "Results saved to: #{result_dir}", :cyan
-        say "Generate site: serialbench benchmark build-site #{result_dir}", :white
       rescue StandardError => e
         say "❌ Local benchmark failed: #{e.message}", :red
         say "Details: #{e.backtrace.first(3).join("\n")}", :white if options[:verbose]
@@ -308,7 +307,6 @@ module Serialbench
 
         say '✅ Docker benchmark completed successfully!', :green
         say "Results saved to: #{result_dir}", :cyan
-        say "Generate site: serialbench benchmark build-site #{result_dir}", :white
       rescue StandardError => e
         say "❌ Docker benchmark failed: #{e.message}", :red
         say "Details: #{e.backtrace.first(3).join("\n")}", :white if options[:verbose]
@@ -357,92 +355,21 @@ module Serialbench
         exit 1
       end
 
-      # def execute_local_benchmark(environment, config, benchmark_config_path)
-      #   say '🏠 Executing local benchmark', :green
-
-      #   # Create benchmark runner with config
-      #   runner_options = {
-      #     formats: (config['formats'] || %w[xml json yaml toml]).map(&:to_sym),
-      #     iterations: config['iterations'] || 10,
-      #     warmup: config['warmup'] || 3,
-      #     config: config
-      #   }
-
-      #   runner = Serialbench::BenchmarkRunner.new(**runner_options)
-
-      #   # Run benchmarks
-      #   say "Running benchmarks with #{runner_options[:iterations]} iterations...", :white
-      #   results = runner.run_all_benchmarks
-
-      #   # Create platform-specific directory name using environment's ruby_build_tag
-      #   require_relative '../models/platform'
-      #   platform = Serialbench::Models::Platform.current_local
-      #   platform_string = "local-#{platform.os}-#{platform.arch}-ruby-#{environment['ruby_build_tag']}"
-
-      #   # Create results directory
-      #   result_dir = "results/runs/#{environment['name']}"
-      #   FileUtils.mkdir_p(result_dir)
-
-      #   # Save results to single YAML file with platform and metadata merged in
-      #   results_file = File.join(result_dir, 'results.yaml')
-      #   full_results = {
-      #     'platform' => {
-      #       'platform_string' => platform_string,
-      #       'os' => platform.os,
-      #       'arch' => platform.arch
-      #     },
-      #     'metadata' => {
-      #       'environment_name' => environment['name'],
-      #       'benchmark_config' => benchmark_config_path,
-      #       'created_at' => Time.now.iso8601,
-      #       'tags' => ['local', platform.os, platform.arch, "ruby-#{environment['ruby_build_tag']}"]
-      #     },
-      #     'environment' => {
-      #       'name' => environment['name'],
-      #       'type' => environment.kind,
-      #       'ruby_build_tag' => environment['ruby_build_tag'],
-      #       'created_at' => Time.now.iso8601
-      #     },
-      #     'config' => {
-      #       'benchmark_config' => benchmark_config_path,
-      #       'formats' => config['formats'],
-      #       'iterations' => config['iterations'],
-      #       'data_sizes' => config['data_sizes']
-      #     },
-      #     'results' => results
-      #   }
-
-      #   File.write(results_file, full_results.to_yaml)
-
-      #   say '✅ Local benchmark completed successfully!', :green
-      #   say "Results saved to: #{result_dir}", :cyan
-      #   say "Generate site: serialbench benchmark build-site #{result_dir}", :white
-      # rescue StandardError => e
-      #   say "❌ Local benchmark failed: #{e.message}", :red
-      #   say "Details: #{e.backtrace.first(3).join("\n")}", :white if options[:verbose]
-      #   raise e
-      # end
-
-      def execute_asdf_benchmark(environment, _config, benchmark_config_path)
+      def execute_asdf_benchmark(environment, config, benchmark_config_path)
         say '🔧 Executing ASDF benchmark', :green
 
-        # Use the ASDF runner to execute the benchmark
-        require_relative '../asdf_runner'
+        require_relative '../runners/asdf_runner'
 
-        # Create a config object that AsdfRunner expects
-        asdf_config = environment.merge({
-                                          'benchmark_config' => benchmark_config_path
-                                        })
+        environment_config_path = "config/environments/#{environment.name}.yml"
+        runner = Runners::AsdfRunner.new(environment, environment_config_path)
 
-        runner = Serialbench::AsdfRunner.new(asdf_config)
+        result_dir = "results/runs/#{environment.name}-results"
+        FileUtils.mkdir_p(result_dir)
 
-        say "Installing Ruby #{environment['ruby_build_tag']} via ASDF...", :white
-        runner.prepare
-        runner.benchmark
+        runner.run_benchmark(config, benchmark_config_path, result_dir)
 
         say '✅ ASDF benchmark completed successfully!', :green
-        say "Results saved to: results/runs/#{environment['name']}", :cyan
-        say "Generate site: serialbench benchmark build-site results/runs/#{environment['name']}", :white
+        say "Results saved to: #{result_dir}", :cyan
       rescue StandardError => e
         say "❌ ASDF benchmark failed: #{e.message}", :red
         say "Details: #{e.backtrace.first(3).join("\n")}", :white if options[:verbose]

data/lib/serialbench/models/benchmark_config.rb

@@ -51,7 +51,7 @@ module Serialbench
       attribute :formats, :string, collection: true, values: %w[xml json yaml toml]
       attribute :iterations, BenchmarkIteration
       attribute :warmup, :integer, default: -> { 1 }
-      attribute :operations, :string, collection: true, values: %w[parse generate memory streaming]
+      attribute :operations, :string, collection: true, values: %w[parsing generation xpath streaming memory]
 
       key_value do
         map 'name', to: :name

data/lib/serialbench/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Serialbench
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serialbench
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ribose
@@ -260,7 +260,6 @@ files:
 - ".github/workflows/benchmark.yml"
 - ".github/workflows/rake.yml"
 - ".github/workflows/release.yml"
-- ".github/workflows/windows-debug.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"

data/.github/workflows/windows-debug.yml

@@ -1,171 +0,0 @@
-name: Windows Debug
-
-on:
-  push:
-    branches: [ master, main ]
-    paths:
-      - '.github/workflows/windows-debug.yml'
-  pull_request:
-    paths:
-      - '.github/workflows/windows-debug.yml'
-  workflow_dispatch:
-
-jobs:
-  test-libxml2-install:
-    runs-on: windows-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: ['3.1', '3.4']
-        method: ['vcpkg', 'msys2', 'direct']
-
-    name: Test ${{ matrix.method }} on Ruby ${{ matrix.ruby }}
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-
-      - name: Install via vcpkg
-        if: matrix.method == 'vcpkg'
-        shell: powershell
-        run: |
-          Write-Host "Installing libxml2 via vcpkg..."
-          vcpkg install libxml2:x64-windows
-          vcpkg integrate install
-
-          # Find the libxml2 installation
-          $vcpkgRoot = "C:\vcpkg"
-          $libxml2Path = Join-Path $vcpkgRoot "installed\x64-windows"
-
-          Write-Host "libxml2 installed at: $libxml2Path"
-
-          # Set environment variables
-          echo "LIBXML2_INCLUDE=$libxml2Path\include" >> $env:GITHUB_ENV
-          echo "LIBXML2_LIB=$libxml2Path\lib" >> $env:GITHUB_ENV
-          echo "PKG_CONFIG_PATH=$libxml2Path\lib\pkgconfig" >> $env:GITHUB_ENV
-
-          # Add to PATH
-          $currentPath = [Environment]::GetEnvironmentVariable("PATH", "Process")
-          $newPath = "$libxml2Path\bin;$currentPath"
-          echo "$newPath" >> $env:GITHUB_PATH
-
-          # Verify installation
-          Get-ChildItem -Path $libxml2Path -Recurse | Where-Object { $_.Name -like "*libxml*" } | Select-Object FullName
-
-      - name: Install via msys2
-        if: matrix.method == 'msys2'
-        shell: powershell
-        run: |
-          Write-Host "Installing libxml2 via msys2..."
-          choco install -y msys2
-
-          # Initialize msys2 and install libxml2
-          C:\tools\msys64\usr\bin\bash -lc "pacman -Syu --noconfirm"
-          C:\tools\msys64\usr\bin\bash -lc "pacman -S --noconfirm mingw-w64-x86_64-libxml2 mingw-w64-x86_64-pkg-config"
-
-          # Set environment variables
-          $msys2Root = "C:\tools\msys64\mingw64"
-          echo "LIBXML2_INCLUDE=$msys2Root\include\libxml2" >> $env:GITHUB_ENV
-          echo "LIBXML2_LIB=$msys2Root\lib" >> $env:GITHUB_ENV
-          echo "PKG_CONFIG_PATH=$msys2Root\lib\pkgconfig" >> $env:GITHUB_ENV
-
-          # Add to PATH
-          echo "$msys2Root\bin" >> $env:GITHUB_PATH
-
-          # Verify installation
-          Get-ChildItem -Path $msys2Root -Recurse | Where-Object { $_.Name -like "*libxml*" } | Select-Object FullName
-
-      - name: Install via direct download
-        if: matrix.method == 'direct'
-        shell: powershell
-        run: |
-          Write-Host "Installing libxml2 via direct download..."
-
-          # Download pre-built binaries from gnome.org
-          $downloadDir = "$env:TEMP\libxml2"
-          New-Item -ItemType Directory -Force -Path $downloadDir
-
-          # Download libxml2 and dependencies
-          $libxml2Url = "https://download.gnome.org/binaries/win64/libxml2/2.9/libxml2-2.9.14-x64_dll.zip"
-          $zlibUrl = "https://download.gnome.org/binaries/win64/dependencies/zlib-1.2.13-x64_dll.zip"
-          $iconvUrl = "https://download.gnome.org/binaries/win64/dependencies/libiconv-1.17-x64_dll.zip"
-
-          Invoke-WebRequest -Uri $libxml2Url -OutFile "$downloadDir\libxml2.zip"
-          Invoke-WebRequest -Uri $zlibUrl -OutFile "$downloadDir\zlib.zip"
-          Invoke-WebRequest -Uri $iconvUrl -OutFile "$downloadDir\iconv.zip"
-
-          # Extract archives
-          Expand-Archive -Path "$downloadDir\libxml2.zip" -DestinationPath "C:\libxml2" -Force
-          Expand-Archive -Path "$downloadDir\zlib.zip" -DestinationPath "C:\libxml2" -Force
-          Expand-Archive -Path "$downloadDir\iconv.zip" -DestinationPath "C:\libxml2" -Force
-
-          # Set environment variables
-          echo "LIBXML2_INCLUDE=C:\libxml2\include" >> $env:GITHUB_ENV
-          echo "LIBXML2_LIB=C:\libxml2\lib" >> $env:GITHUB_ENV
-
-          # Add to PATH
-          echo "C:\libxml2\bin" >> $env:GITHUB_PATH
-
-          # Verify installation
-          Get-ChildItem -Path "C:\libxml2" -Recurse | Where-Object { $_.Name -like "*libxml*" } | Select-Object FullName
-
-      - name: Verify pkg-config
-        shell: powershell
-        run: |
-          Write-Host "Checking for pkg-config..."
-          try {
-            $pkgConfigPath = Get-Command pkg-config -ErrorAction Stop
-            Write-Host "pkg-config found at: $($pkgConfigPath.Source)"
-            pkg-config --version
-          } catch {
-            Write-Host "pkg-config not found, installing pkgconfiglite..."
-            choco install -y pkgconfiglite
-            pkg-config --version
-          }
-
-          # Try to find libxml2 via pkg-config
-          Write-Host "`nSearching for libxml-2.0.pc..."
-          if ($env:PKG_CONFIG_PATH) {
-            Write-Host "PKG_CONFIG_PATH: $env:PKG_CONFIG_PATH"
-            pkg-config --list-all | Select-String libxml
-          }
-
-      - name: Install bundler
-        run: gem install bundler
-
-      - name: Try to install libxml-ruby gem
-        shell: powershell
-        continue-on-error: true
-        run: |
-          Write-Host "Attempting to install libxml-ruby..."
-
-          # Set additional environment variables for gem installation
-          if ($env:LIBXML2_INCLUDE) {
-            $env:CFLAGS = "-I$env:LIBXML2_INCLUDE"
-            $env:CPPFLAGS = "-I$env:LIBXML2_INCLUDE"
-          }
-          if ($env:LIBXML2_LIB) {
-            $env:LDFLAGS = "-L$env:LIBXML2_LIB"
-          }
-
-          gem install libxml-ruby --verbose
-
-      - name: Report results
-        if: always()
-        shell: powershell
-        run: |
-          Write-Host "`n=== Installation Method: ${{ matrix.method }} ==="
-          Write-Host "Ruby Version: ${{ matrix.ruby }}"
-          Write-Host "`nEnvironment Variables:"
-          Write-Host "LIBXML2_INCLUDE: $env:LIBXML2_INCLUDE"
-          Write-Host "LIBXML2_LIB: $env:LIBXML2_LIB"
-          Write-Host "PKG_CONFIG_PATH: $env:PKG_CONFIG_PATH"
-          Write-Host "`nPATH:"
-          $env:PATH -split ';' | ForEach-Object { Write-Host "  $_" }
-
-          Write-Host "`nChecking for libxml2 files..."
-          Get-ChildItem C:\ -Recurse -ErrorAction SilentlyContinue -Include libxml2.dll,libxml2.lib,xml2-config.h 2>$null | Select-Object FullName