serialbench 0.1.1 → 0.1.3

data/lib/serialbench/runners/docker_runner.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'json'
+require_relative '../ruby_build_manager'
+require_relative 'base'
+
+module Serialbench
+  module Runners
+    # Handles Docker-based benchmark execution
+    class DockerRunner < Base
+      class DockerError < StandardError; end
+
+      def initialize(environment_config, environment_config_path)
+        super
+
+        @docker_image = @environment_config.docker&.image
+        raise 'docker.image is required' unless @docker_image
+
+        # Handle dockerfile path relative to environment file
+        dockerfile_path = @environment_config.docker&.dockerfile
+        raise 'docker.dockerfile path is required' unless dockerfile_path
+
+        @dockerfile = Pathname.new(environment_config_path).dirname.join(dockerfile_path).to_s
+        raise "path '#{@dockerfile}' specified in docker.dockerfile is not found" unless File.exist?(@dockerfile)
+
+        validate_docker_available
+      end
+
+      # Build Docker image for this environment
+      def prepare
+        puts "🐳 Preparing Docker image for #{@name}..."
+
+        puts "   🐍 Using Docker image: #{base_image_string}"
+        puts "   🔨 Building Docker image: #{docker_image_string}"
+
+        cmd = [
+          'docker', 'build',
+          '--build-arg', "BASE_IMAGE=#{base_image_string}",
+          '-t', docker_image_string,
+          '-f', @dockerfile,
+          '.'
+        ]
+
+        # Show command being run
+        puts "   🔧 Running command: #{cmd.join(' ')}"
+        success = system(*cmd)
+
+        raise DockerError, "Failed to build Docker image '#{docker_image_string}'" unless success
+
+        puts "✅ Docker image prepared successfully for #{docker_image_string}"
+      end
+
+      def base_image_string
+        @environment_config.docker.image
+      end
+
+      def docker_image_string
+        "serialbench:#{@environment_config.ruby_build_tag}"
+      end
+
+      # Run benchmark for this environment
+      def run_benchmark(benchmark_config, benchmark_config_path, result_dir)
+        puts "🚀 Running benchmark at #{@environment_config_path}..."
+
+        FileUtils.mkdir_p(result_dir)
+
+        # Build image if not already built
+        prepare unless image_exists?
+
+        # Run the benchmark
+        run_benchmark_in_container(benchmark_config, benchmark_config_path, result_dir)
+
+        puts "✅ Benchmark completed for #{@environment_config_path}"
+      end
+
+      private
+
+      # Validate Docker is available
+      def validate_docker_available
+        raise DockerError, 'Docker is not installed or not available in PATH' unless system('docker --version > /dev/null 2>&1')
+
+        return if system('docker info > /dev/null 2>&1')
+
+        raise DockerError, 'Docker daemon is not running'
+      end
+
+      # Check if Docker image exists
+      def image_exists?
+        image_name = "serialbench:#{@name}"
+        system("docker image inspect #{image_name} > /dev/null 2>&1")
+      end
+
+      # Run benchmark in container
+      def run_benchmark_in_container(_benchmark_config, benchmark_config_path, result_dir)
+        puts '🏃 Running benchmark in Docker container...'
+        puts "   📁 Results will be saved to: #{result_dir}"
+        puts "   🐳 Using Docker image: #{docker_image_string}"
+
+        benchmark_log = File.join(result_dir, 'benchmark.log')
+
+        cmd = [
+          'docker', 'run', '--rm',
+          '-v', "#{File.expand_path(result_dir)}:/app/results",
+          '-v', "#{File.expand_path(@environment_config_path)}:/app/environment.yml",
+          '-v', "#{File.expand_path(benchmark_config_path)}:/app/benchmark_config.yml",
+          # TODO: do not hard code this path in the docker image
+          '-v', "#{RubyBuildManager::CACHE_FILE}:/root/.serialbench/ruby-build-definitions.yaml",
+          docker_image_string,
+          'benchmark',
+          '_docker_execute',
+          '--result_dir=/app/results',
+          '/app/environment.yml',
+          '/app/benchmark_config.yml'
+        ]
+
+        puts "   🔧 Running command: #{cmd.join(' ')}"
+        puts "   📝 Benchmark output will be logged to: #{benchmark_log}"
+        puts '   ⏳ This may take several minutes...'
+
+        success = system("#{cmd.join(' ')} > #{benchmark_log} 2>&1")
+        puts "   ✅ Command executed with status: #{success ? 'success' : 'failure'}"
+        puts "   📊 Checking if results saved to: #{File.join(result_dir, 'results.yaml')}"
+
+        if success && File.exist?(File.join(result_dir, 'results.yaml'))
+          puts '✅ Benchmark completed successfully'
+          puts "   📊 Results saved to: #{File.join(result_dir, 'results.yaml')}"
+        else
+          puts "❌ Benchmark failed (see #{benchmark_log})"
+          puts "   🔍 Check log file for details: #{benchmark_log}"
+          if File.exist?(benchmark_log)
+            puts '   📄 Last few lines of log:'
+            system("tail -10 #{benchmark_log} | sed 's/^/      /'")
+          end
+          raise DockerError, 'Benchmark execution failed'
+        end
+      end
+    end
+  end
+end

data/lib/serialbench/runners/local_runner.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require_relative 'base'
+require_relative '../benchmark_runner'
+require_relative '../models/result'
+require_relative '../models/platform'
+
+module Serialbench
+  module Runners
+    # Handles local benchmark execution using the current Ruby environment
+    class LocalRunner < Base
+      def prepare
+        # For local environments, no preparation is needed
+        # The current Ruby environment is already set up
+        puts "✅ Local environment ready (using current Ruby: #{RUBY_VERSION})"
+      end
+
+      def run_benchmark(benchmark_config, benchmark_config_path, result_dir)
+        puts "🏠 Running benchmark locally with Ruby #{RUBY_VERSION}..."
+        puts "   📁 Results will be saved to: #{result_dir}"
+
+        FileUtils.mkdir_p(result_dir)
+
+        # Run the benchmark
+        runner = Serialbench::BenchmarkRunner.new(
+          environment_config: @environment_config,
+          benchmark_config: benchmark_config
+        )
+
+        results = runner.run_all_benchmarks
+
+        # Get platform information with correct Ruby version from environment config
+        platform = Serialbench::Models::Platform.current_local(
+          ruby_version: @environment_config.ruby_build_tag
+        )
+
+        # Create metadata
+        metadata = Models::RunMetadata.new(
+          benchmark_config_path: benchmark_config_path,
+          environment_config_path: @environment_config_path,
+          tags: [
+            'local',
+            platform.os,
+            platform.arch,
+            "ruby-#{@environment_config.ruby_build_tag}"
+          ]
+        )
+
+        # Save results
+        results_model = Models::Result.new(
+          platform: platform,
+          metadata: metadata,
+          environment_config: @environment_config,
+          benchmark_config: benchmark_config,
+          benchmark_result: results
+        )
+
+        # Restore YAML to use Psych for output, otherwise lutaml-model's to_yaml
+        # will have no output (Syck gem overrides YAML constant)
+        Object.const_set(:YAML, Psych)
+
+        results_file = File.join(result_dir, 'results.yaml')
+        results_model.to_file(results_file)
+
+        puts "✅ Benchmark completed successfully"
+        puts "   📊 Results saved to: #{results_file}"
+      end
+    end
+  end
+end

data/lib/serialbench/serializers/base_serializer.rb

@@ -1,26 +1,20 @@
 # frozen_string_literal: true
 
+require 'singleton'
+
 module Serialbench
   module Serializers
     class BaseSerializer
+      include Singleton
+
       def initialize
         # Override in subclasses
       end
 
-      def available?
-        raise NotImplementedError, 'Subclasses must implement #available?'
-      end
-
-      def name
-        raise NotImplementedError, 'Subclasses must implement #name'
-      end
-
-      def version
-        raise NotImplementedError, 'Subclasses must implement #version'
-      end
-
-      def format
-        raise NotImplementedError, 'Subclasses must implement #format'
+      %w[name version format library_require_name available?].each do |method_name|
+        define_method(method_name) do
+          self.class.send(method_name)
+        end
       end
 
       def parse(data)
@@ -31,7 +25,7 @@ module Serialbench
         raise NotImplementedError, 'Subclasses must implement #generate'
       end
 
-      def stream_parse(data, &block)
+      def stream_parse(data)
         # Default implementation falls back to regular parsing
         # Override in subclasses that support streaming
         result = parse(data)
@@ -44,8 +38,6 @@ module Serialbench
         false
       end
 
-      protected
-
       def require_library(library_name)
         require library_name
         true

data/lib/serialbench/serializers/json/base_json_serializer.rb

@@ -6,7 +6,7 @@ module Serialbench
   module Serializers
     module Json
       class BaseJsonSerializer < BaseSerializer
-        def format
+        def self.format
           :json
         end
 
@@ -29,7 +29,9 @@ module Serialbench
           }
         end
 
-        protected
+        def supports_generation?
+          true
+        end
 
         def supports_pretty_print?
           true
@@ -48,8 +50,6 @@ module Serialbench
           raise NotImplementedError, 'Subclasses must implement #library_require_name'
         end
 
-        public
-
         # Check if the JSON library is available
         def available?
           return @available if defined?(@available)

data/lib/serialbench/serializers/json/json_serializer.rb

@@ -39,8 +39,6 @@ module Serialbench
           false
         end
 
-        protected
-
         def supports_pretty_print?
           true
         end

data/lib/serialbench/serializers/json/oj_serializer.rb

@@ -53,8 +53,6 @@ module Serialbench
           false
         end
 
-        protected
-
         def supports_pretty_print?
           true
         end

data/lib/serialbench/serializers/json/rapidjson_serializer.rb

@@ -27,7 +27,7 @@ module Serialbench
           RapidJSON.parse(json_string)
         end
 
-        def generate(object, options = {})
+        def generate(object, _options = {})
           require 'rapidjson'
           RapidJSON.dump(object)
         end

data/lib/serialbench/serializers/json/yajl_serializer.rb

@@ -60,8 +60,6 @@ module Serialbench
           end
         end
 
-        protected
-
         def library_require_name
           'yajl'
         end

data/lib/serialbench/serializers/toml/base_toml_serializer.rb

@@ -6,7 +6,7 @@ module Serialbench
   module Serializers
     module Toml
       class BaseTomlSerializer < BaseSerializer
-        def format
+        def self.format
           :toml
         end
 
@@ -29,13 +29,15 @@ module Serialbench
           }
         end
 
+        def supports_generation?
+          true
+        end
+
         def supports_streaming?
           # TOML is typically not streamed due to its structure
           false
         end
 
-        protected
-
         def supports_comments?
           false
         end
@@ -57,8 +59,6 @@ module Serialbench
           raise NotImplementedError, 'Subclasses must implement #library_require_name'
         end
 
-        public
-
         # Check if the TOML library is available
         def available?
           return @available if defined?(@available)

data/lib/serialbench/serializers/toml/toml_rb_serializer.rb

@@ -27,13 +27,11 @@ module Serialbench
           TomlRB.parse(toml_string)
         end
 
-        def generate(object, options = {})
+        def generate(object, _options = {})
           require 'toml-rb'
           TomlRB.dump(object)
         end
 
-        protected
-
         def supports_comments?
           false
         end

data/lib/serialbench/serializers/toml/tomlib_serializer.rb

@@ -24,7 +24,7 @@ module Serialbench
           # TOML doesn't typically support streaming parsing
           # Parse the entire document and yield it
           result = parse(toml_string)
-          block&.call(result) if block
+          block&.call(result)
           1 # Return 1 document processed
         end
 
@@ -39,8 +39,6 @@ module Serialbench
           Tomlib::VERSION
         end
 
-        protected
-
         def library_require_name
           'tomlib'
         end

data/lib/serialbench/serializers/toml/tomlrb_serializer.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'base_toml_serializer'
+
+module Serialbench
+  module Serializers
+    module Toml
+      class TomlrbSerializer < BaseTomlSerializer
+        def available?
+          require_library('tomlrb')
+        end
+
+        def name
+          'tomlrb'
+        end
+
+        def version
+          require 'tomlrb'
+          # tomlrb doesn't expose a VERSION constant, so we'll use gem version
+          Gem.loaded_specs['tomlrb']&.version&.to_s || 'unknown'
+        rescue LoadError, NameError
+          'unknown'
+        end
+
+        def parse(toml_string)
+          require 'tomlrb'
+          Tomlrb.parse(toml_string)
+        end
+
+        def generate(object, options = {})
+          raise NotImplementedError, 'tomlrb gem does not support TOML generation/dumping'
+        end
+
+        def supports_generation?
+          false
+        end
+
+        def supports_comments?
+          false
+        end
+
+        def supports_arrays_of_tables?
+          true
+        end
+
+        def supports_inline_tables?
+          true
+        end
+
+        def supports_multiline_strings?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/serialbench/serializers/xml/base_xml_serializer.rb

@@ -6,7 +6,7 @@ module Serialbench
   module Serializers
     module Xml
       class BaseXmlSerializer < BaseSerializer
-        def format
+        def self.format
           :xml
         end
 
@@ -33,7 +33,9 @@ module Serialbench
           }
         end
 
-        protected
+        def supports_generation?
+          true
+        end
 
         def supports_xpath?
           false
@@ -47,13 +49,6 @@ module Serialbench
           false
         end
 
-        # Subclasses should override this to specify their library name
-        def library_require_name
-          raise NotImplementedError, 'Subclasses must implement #library_require_name'
-        end
-
-        public
-
         # Check if the XML library is available
         def available?
           return @available if defined?(@available)

data/lib/serialbench/serializers/xml/libxml_serializer.rb

@@ -49,8 +49,6 @@ module Serialbench
           LibXML::XML::VERSION
         end
 
-        protected
-
         def library_require_name
           'libxml'
         end
@@ -60,26 +58,22 @@ module Serialbench
         def build_xml_from_data(data, name = 'root')
           require 'libxml'
 
+          element = LibXML::XML::Node.new(name.to_s)
           case data
           when Hash
-            element = LibXML::XML::Node.new(name.to_s)
             data.each do |key, value|
               child = build_xml_from_data(value, key.to_s)
               element << child
             end
-            element
           when Array
-            element = LibXML::XML::Node.new(name.to_s)
             data.each_with_index do |item, index|
               child = build_xml_from_data(item, "item_#{index}")
               element << child
             end
-            element
           else
-            element = LibXML::XML::Node.new(name.to_s)
             element.content = data.to_s
-            element
           end
+          element
         end
 
         # SAX handler for streaming
@@ -102,10 +96,10 @@ module Serialbench
             @element_stack.push(@current_element)
           end
 
-          def on_end_element(element)
+          def on_end_element(_element)
             element_data = @element_stack.pop
             if @element_stack.empty?
-              @block&.call(element_data) if @block
+              @block&.call(element_data)
             else
               @element_stack.last[:children] << element_data
             end

data/lib/serialbench/serializers/xml/nokogiri_serializer.rb

@@ -49,8 +49,6 @@ module Serialbench
           Nokogiri::VERSION
         end
 
-        protected
-
         def library_require_name
           'nokogiri'
         end
@@ -111,10 +109,10 @@ module Serialbench
             @element_stack.push(@current_element)
           end
 
-          def end_element(name)
+          def end_element(_name)
             element = @element_stack.pop
             if @element_stack.empty?
-              @block&.call(element) if @block
+              @block&.call(element)
             else
               @element_stack.last[:children] << element
             end

data/lib/serialbench/serializers/xml/oga_serializer.rb

@@ -49,8 +49,6 @@ module Serialbench
           Oga::VERSION
         end
 
-        protected
-
         def library_require_name
           'oga'
         end
@@ -60,27 +58,23 @@ module Serialbench
         def build_xml_from_data(data, name = 'root')
           require 'oga'
 
+          element = Oga::XML::Element.new(name: name)
           case data
           when Hash
-            element = Oga::XML::Element.new(name: name)
             data.each do |key, value|
               child = build_xml_from_data(value, key.to_s)
               element.children << child
             end
-            element
           when Array
-            element = Oga::XML::Element.new(name: name)
             data.each_with_index do |item, index|
               child = build_xml_from_data(item, "item_#{index}")
               element.children << child
             end
-            element
           else
-            element = Oga::XML::Element.new(name: name)
             text_node = Oga::XML::Text.new(text: data.to_s)
             element.children << text_node
-            element
           end
+          element
         end
 
         # SAX handler for streaming
@@ -110,10 +104,10 @@ module Serialbench
             @element_stack.last[:text] += text if @element_stack.any?
           end
 
-          def after_element(namespace, name)
+          def after_element(_namespace, _name)
             element = @element_stack.pop
             if @element_stack.empty?
-              @block&.call(element) if @block
+              @block&.call(element)
             else
               @element_stack.last[:children] << element
             end

data/lib/serialbench/serializers/xml/ox_serializer.rb

@@ -40,8 +40,6 @@ module Serialbench
           Ox::VERSION
         end
 
-        protected
-
         def library_require_name
           'ox'
         end
@@ -63,10 +61,10 @@ module Serialbench
             @element_stack.push(@current_element)
           end
 
-          def end_element(name)
+          def end_element(_name)
             element = @element_stack.pop
             if @element_stack.empty?
-              @block&.call(element) if @block
+              @block&.call(element)
             else
               @element_stack.last[:children] << element
             end

data/lib/serialbench/serializers/xml/rexml_serializer.rb

@@ -41,7 +41,7 @@ module Serialbench
 
           indent = options.fetch(:indent, 0)
           output = String.new
-          if indent > 0
+          if indent.positive?
             document.write(output, indent)
           else
             document.write(output)
@@ -77,8 +77,6 @@ module Serialbench
           false
         end
 
-        protected
-
         def supports_xpath?
           true
         end
@@ -122,7 +120,7 @@ module Serialbench
           @result = nil
         end
 
-        def start_element(uri, localname, qname, attributes)
+        def start_element(_uri, _localname, qname, attributes)
           @elements_processed += 1
           @block&.call(:start_element, { name: qname, attributes: attributes })
         end
@@ -134,7 +132,7 @@ module Serialbench
           @block&.call(:text, text)
         end
 
-        def end_element(uri, localname, qname)
+        def end_element(_uri, _localname, qname)
           @block&.call(:end_element, { name: qname })
         end
       end