serialbench 0.1.0 → 0.1.2

data/Rakefile

@@ -5,59 +5,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-desc 'Run benchmarks'
-task :benchmark do
-  require_relative 'lib/serialbench'
-
-  puts 'Running XML benchmarks...'
-  results = Serialbench.run_benchmarks
-
-  puts "\nGenerating reports..."
-  report_files = Serialbench.generate_reports(results)
-
-  puts "\nBenchmark complete!"
-  puts 'Reports generated:'
-  puts "  HTML: #{report_files[:html]}"
-  puts "  AsciiDoc: #{report_files[:asciidoc]}"
-  puts "  Charts: #{report_files[:charts].length} SVG files"
-end
-
-desc 'Install all XML library dependencies'
-task :install_deps do
-  gems = %w[ox nokogiri libxml-ruby oga memory_profiler]
-
-  puts 'Installing XML library dependencies...'
-  gems.each do |gem_name|
-    puts "Installing #{gem_name}..."
-    system("gem install #{gem_name}")
-  rescue StandardError => e
-    puts "Warning: Failed to install #{gem_name}: #{e.message}"
-  end
-  puts 'Done!'
-end
-
-desc 'Check which XML libraries are available'
-task :check_libs do
-  require_relative 'lib/serialbench'
-
-  runner = Serialbench::BenchmarkRunner.new
-
-  puts 'XML Library Availability Check'
-  puts '=' * 40
-
-  runner.parsers.each do |parser|
-    status = parser.available? ? '✓ Available' : '✗ Not available'
-    version = parser.available? ? " (#{parser.version})" : ''
-    puts "#{parser.name.ljust(15)} #{status}#{version}"
-  end
-
-  puts "\nMemory profiler: #{Serialbench::MemoryProfiler.available? ? '✓ Available' : '✗ Not available'}"
-end
-
-desc 'Clean generated files'
-task :clean do
-  FileUtils.rm_rf('results')
-  puts 'Cleaned generated files'
-end
-
 task default: :spec

data/config/benchmarks/full.yml

@@ -0,0 +1,29 @@
+# Configuration for comprehensive benchmarks - Full testing with all data sizes
+# Used by Docker script for complete performance analysis
+
+# Run name for identification
+name: full-benchmark
+
+data_sizes:
+- small
+- medium
+- large
+
+formats:
+- xml
+- json
+- yaml
+- toml
+
+iterations:
+  small: 20
+  medium: 5
+  large: 2
+
+operations:
+- parse
+- generate
+- streaming
+- memory
+
+warmup: 3

data/config/benchmarks/short.yml

@@ -0,0 +1,26 @@
+# Configuration for short benchmarks - Minimal memory usage for CI runners
+# Designed for Windows and Ubuntu runners with limited memory
+
+# Run name for identification
+name: short-benchmark
+
+data_sizes:
+- small
+
+formats:
+- xml
+- json
+- yaml
+- toml
+
+iterations:
+  small: 5
+  medium: 2
+  large: 1
+
+operations:
+- parse
+- generate
+- streaming
+
+warmup: 2

data/config/environments/asdf-ruby-3.2.yml

@@ -0,0 +1,8 @@
+---
+name: ruby-324-asdf
+kind: asdf
+created_at: '2025-06-12T22:54:43+08:00'
+ruby_build_tag: 3.2.4
+description: ASDF environment
+asdf:
+  auto_install: true

data/config/environments/asdf-ruby-3.3.yml

@@ -0,0 +1,8 @@
+---
+name: ruby-332-asdf
+kind: asdf
+created_at: '2025-06-12T22:53:24+08:00'
+ruby_build_tag: 3.3.2
+description: ASDF environment
+asdf:
+  auto_install: true

data/config/environments/docker-ruby-3.0.yml

@@ -0,0 +1,9 @@
+---
+name: docker-ruby-3.0
+kind: docker
+created_at: '2025-06-13T15:18:43+08:00'
+ruby_build_tag: "3.0.7"
+description: Docker environment for Ruby 3.0 benchmarks
+docker:
+  image: 'ruby:3.0-slim'
+  dockerfile: '../../docker/Dockerfile.ubuntu'

data/config/environments/docker-ruby-3.1.yml

@@ -0,0 +1,9 @@
+---
+name: docker-ruby-3.1
+kind: docker
+created_at: '2025-06-13T15:18:43+08:00'
+ruby_build_tag: "3.1.6"
+description: Docker environment for Ruby 3.1 benchmarks
+docker:
+  image: 'ruby:3.1-slim'
+  dockerfile: '../../docker/Dockerfile.ubuntu'

data/config/environments/docker-ruby-3.2.yml

@@ -0,0 +1,9 @@
+---
+name: docker-ruby-3.2
+kind: docker
+created_at: '2025-06-13T15:18:43+08:00'
+ruby_build_tag: "3.2.4"
+description: Docker environment for Ruby 3.2 benchmarks
+docker:
+  image: 'ruby:3.2-slim'
+  dockerfile: '../../docker/Dockerfile.ubuntu'

data/config/environments/docker-ruby-3.3.yml

@@ -0,0 +1,9 @@
+---
+name: docker-ruby-3.3
+kind: docker
+created_at: '2025-06-13T15:18:43+08:00'
+ruby_build_tag: "3.3.7"
+description: Docker environment for Ruby 3.3 benchmarks
+docker:
+  image: 'ruby:3.3-slim'
+  dockerfile: '../../docker/Dockerfile.ubuntu'

data/config/environments/docker-ruby-3.4.yml

@@ -0,0 +1,9 @@
+---
+name: docker-ruby-3.4
+kind: docker
+created_at: '2025-06-13T15:18:43+08:00'
+ruby_build_tag: "3.4.1"
+description: Docker environment for Ruby 3.4 benchmarks
+docker:
+  image: 'ruby:3.4-slim'
+  dockerfile: '../../docker/Dockerfile.ubuntu'

data/docker/Dockerfile.alpine

@@ -0,0 +1,33 @@
+# Alpine-based Ruby benchmark environment using official Ruby Alpine images
+ARG BASE_IMAGE=ruby:3.4-alpine
+FROM ${BASE_IMAGE}
+
+# Install system dependencies for XML libraries and build tools
+RUN apk add --no-cache \
+    build-base \
+    libxml2-dev \
+    libxslt-dev \
+    yaml-dev \
+    zlib-dev \
+    openssl-dev \
+    linux-headers \
+    git
+
+# Set working directory
+WORKDIR /app
+
+# Copy the entire application (gemspec needs full context)
+COPY . .
+
+# Update bundler and configure bundle for cross-platform compatibility
+RUN gem install bundler:2.5.22 && \
+    bundle config set --local deployment 'false' && \
+    bundle config set --local path '/usr/local/bundle' && \
+    bundle config set --local force_ruby_platform true && \
+    bundle install --jobs 4 --retry 3
+
+# Create results directory
+RUN mkdir -p /app/results
+
+# Default command runs benchmarks
+ENTRYPOINT ["bundle", "exec", "serialbench"]

data/docker/Dockerfile.ubuntu

@@ -0,0 +1,32 @@
+# Multi-stage Dockerfile for Ruby serialization benchmarks
+# Supports multiple Ruby versions for comprehensive testing
+
+ARG BASE_IMAGE=ruby:3.4-slim
+FROM ${BASE_IMAGE}
+
+# Install system dependencies for XML libraries
+RUN apt-get update && apt-get install -y \
+    libxml2-dev \
+    libxslt1-dev \
+    build-essential \
+    git \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set working directory
+WORKDIR /app
+
+# Copy the entire application (gemspec needs full context)
+COPY . .
+
+# Update bundler and configure bundle for cross-platform compatibility
+RUN gem install bundler:2.5.22 && \
+    bundle config set --local deployment 'false' && \
+    bundle config set --local path '/usr/local/bundle' && \
+    bundle config set --local force_ruby_platform true && \
+    bundle install --jobs 4 --retry 3
+
+# Create results directory
+RUN mkdir -p /app/results
+
+# Default command runs parsing and generation benchmarks (memory benchmarks disabled due to hanging in Docker)
+ENTRYPOINT ["bundle", "exec", "serialbench"]

data/docker/README.md

@@ -0,0 +1,214 @@
+# Serialbench Docker Setup
+
+This directory contains Docker infrastructure for running Serialbench across multiple Ruby versions in isolated environments.
+
+## Files
+
+- `Dockerfile.ubuntu` - Multi-stage Dockerfile for building benchmark environments
+- `run-benchmarks.sh` - Automated script for running benchmarks across multiple Ruby versions
+
+## Quick Start
+
+### Prerequisites
+
+- Docker installed and running
+- Bash shell (Linux/macOS/WSL)
+
+### Running Multi-Ruby Benchmarks
+
+```bash
+# From the project root directory
+./docker/run-benchmarks.sh
+```
+
+This will:
+1. Build Docker images for Ruby 3.1, 3.2, 3.3, and 3.4 (skipping existing images)
+2. Run comprehensive benchmarks in each environment
+3. Merge results from all Ruby versions
+4. Generate GitHub Pages with comparative results
+
+#### Force Rebuild Images
+
+To force rebuild all Docker images (even if they already exist):
+
+```bash
+# Force rebuild all images
+./docker/run-benchmarks.sh --force-rebuild
+
+# Or use the short form
+./docker/run-benchmarks.sh -f
+```
+
+This is useful when:
+- Dependencies have been updated
+- Dockerfile has been modified
+- You want to ensure fresh builds
+- Troubleshooting build-related issues
+
+#### Command Line Options
+
+```bash
+# Show help and available options
+./docker/run-benchmarks.sh --help
+
+# Available options:
+#   --force-rebuild, -f    Force rebuild of Docker images even if they exist
+#   --help, -h             Show help message
+```
+
+### Results
+
+Results are saved in `docker-results/`:
+```
+docker-results/
+├── ruby-3.1/           # Ruby 3.1 results
+├── ruby-3.2/           # Ruby 3.2 results
+├── ruby-3.3/           # Ruby 3.3 results
+├── ruby-3.4/           # Ruby 3.4 results
+├── merged/             # Merged results from all versions
+└── docs/               # GitHub Pages site
+```
+
+## Manual Docker Usage
+
+### Build Image for Specific Ruby Version
+
+```bash
+docker build \
+  --build-arg RUBY_VERSION=3.3 \
+  -t serialbench:ruby-3.3 \
+  -f docker/Dockerfile.ubuntu \
+  .
+```
+
+### Run Benchmarks
+
+```bash
+# Create results directory
+mkdir -p results
+
+# Run benchmarks
+docker run \
+  --rm \
+  -v $(pwd)/results:/app/results \
+  serialbench:ruby-3.3
+```
+
+### Custom Configuration
+
+```bash
+# Use custom config file
+docker run \
+  --rm \
+  -v $(pwd)/results:/app/results \
+  -v $(pwd)/config:/app/config \
+  serialbench:ruby-3.3 \
+  bundle exec serialbench benchmark --config config/ci.yml
+```
+
+## Supported Ruby Versions
+
+- Ruby 3.1
+- Ruby 3.2
+- Ruby 3.3
+- Ruby 3.4
+
+## Environment Variables
+
+The Docker images support these environment variables:
+
+- `BUNDLE_PATH` - Bundle installation path
+- `BUNDLE_BIN` - Bundle binary path
+- `PATH` - System PATH including bundle binaries
+
+## Troubleshooting
+
+### Build Failures
+
+Check build logs in `docker-results/build-ruby-X.X.log`:
+
+```bash
+cat docker-results/build-ruby-3.3.log
+```
+
+### Runtime Failures
+
+Check benchmark logs in `docker-results/ruby-X.X/benchmark.log`:
+
+```bash
+cat docker-results/ruby-3.3/benchmark.log
+```
+
+### Docker Issues
+
+Ensure Docker is running:
+```bash
+docker info
+```
+
+Clean up Docker resources:
+```bash
+# Remove all serialbench images
+docker rmi $(docker images serialbench -q)
+
+# Remove all containers
+docker container prune
+```
+
+## Customization
+
+### Adding Ruby Versions
+
+Edit `RUBY_VERSIONS` array in `run-benchmarks.sh`:
+
+```bash
+RUBY_VERSIONS=("3.1" "3.2" "3.3" "3.4" "head")
+```
+
+### Custom Benchmark Configuration
+
+Create custom config files in `config/` directory and reference them:
+
+```bash
+# In run-benchmarks.sh
+CONFIG_FILE="config/custom.yml"
+```
+
+### Output Directory
+
+Change the output directory:
+
+```bash
+# In run-benchmarks.sh
+OUTPUT_DIR="my-results"
+```
+
+## Integration with CI/CD
+
+The Docker setup integrates with GitHub Actions. See `.github/workflows/benchmark.yml` for automated benchmark runs.
+
+### GitHub Actions Usage
+
+```yaml
+- name: Run Docker Benchmarks
+  run: ./docker/run-benchmarks.sh
+
+- name: Upload Results
+  uses: actions/upload-artifact@v3
+  with:
+    name: benchmark-results
+    path: docker-results/
+```
+
+## Performance Considerations
+
+- Each Ruby version runs in isolation
+- Results are automatically merged for comparison
+- Memory profiling is enabled by default
+- Build caching optimizes subsequent runs
+
+## Security
+
+- Containers run with minimal privileges
+- No network access required during benchmarks
+- Results are written to mounted volumes only

data/exe/serialbench

@@ -3,4 +3,4 @@
 
 require_relative '../lib/serialbench'
 
-Serialbench::Cli.start(ARGV)
+Serialbench::CLI.start(ARGV)