benny 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e40e81931380263c65f91bf4473aae25c84c82f9924f8d5e0b4901acf5b4772
+  data.tar.gz: cf0b191ac09dc6721824f49ce6c90f5afce68b2c54947f55ea490e92e8fc2cc9
+SHA512:
+  metadata.gz: c20d7b905bb13bf0b9e6bcda2099f39966a5936321cd207976016df79ce58942a44569e951bcb78d89d11cfcfe14a009aea3b652c9cf8dbad489d9b9b1aeb0b3
+  data.tar.gz: 821a9b332b3d6e4cae6f5bfe59aa17841123f781828cedf8608951062b789169c1cea1a16003c05521255197a7f4c4db35c50199b9cb1e8d12783eb977c51510

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2023 Joakim Antman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Benny, your Ruby benchmarking buddy
+
+This tool was created to answer the question: How does this version of a library compare to another version of the same library?
+For a familiar feel for Rubyists, [rspec](https://github.com/rspec/rspec-core) has been as inspiration for how benchmarks are structured and defined.
+
+## Basic structure of a benchmarking project
+
+A simple benchmark project looks something like this. To generate such a project you can execute:
+
+```
+gem install benny
+benny init my_benny_project
+```
+
+```
+my_benny_project/
+    ├── benchmarks/
+    │   ├── bench_helper.rb
+    │   └── test_bench.rb
+    ├── gemfiles/
+    │   ├── version-1.gemfile
+    │   └── version-2.gemfile
+    └── Gemfile
+```
+
+### Gemfile
+Dependencies are managed by [bundler](https://github.com/rubygems/rubygems/tree/master/bundler) and therefore a Gemfile is required
+
+```
+source 'https://rubygems.org'
+
+gem 'benny'
+```
+
+### benchmarks/ folder
+Contains files that define environments and benchmarks.
+
+### benchmarks/bench_helper.rb
+Configures the benchmarks and defines the different environments
+
+A simple configuration configuring two environments to be compared:
+```
+Benny.configure do |config|
+  config.environment 'Version 1' do
+    gemfile 'gemfiles/version-1.gemfile'
+  end
+  config.environment 'Version 2' do
+    gemfile 'gemfiles/version-2.gemfile'
+  end
+end
+```
+
+### benchmarks/*_bench.rb files
+All the files ending with the suffix `_bench.rb` will be evaluated and added to the benchmark suite.
+
+
+```
+Benny.define do
+  benchmark 'Simple calculation' do
+    700_000.times do
+      sum = 1+1
+    end
+  end
+end
+```
+
+### gemfiles/ folder
+
+The gemfile folder contains the different Gemfiles for version variations. These are referenced from the [benchmark/bench_helper.rb](#benchmarksbench_helperrb) file.
+[Aappraisal](https://github.com/thoughtbot/appraisal) can be used in combination with Benny for managing the different gemfiles.
+
+## Defining benchmarks
+
+TBD
+
+## Reporters
+
+TBD
+
+# Development and Tests
+
+## How to contribute
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## License
+
+See [LICENSE](LICENSE).

data/benny.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/benny/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'benny'
+  spec.version = Benny::VERSION
+  spec.authors = ['Joakim Antman']
+  spec.email = ['antmanj@gmail.com']
+
+  spec.summary = 'Benny the benchmark gem'
+  spec.description = 'Define and maintain your benchmarks in a familiarway.' \
+                     'Execute on different variations of environments'
+  spec.homepage = 'https://github.com/anakinj/benny'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/anakinj/benny'
+  spec.metadata['changelog_uri'] = 'https://github.com/anakinj/benny/blob/main/CHANGELOG.md'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").select do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[exe/ lib/ README benny.gemspec LICENSE])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'gruff', '~> 0.23'
+  spec.add_dependency 'terminal-table', '~> 3.0'
+  spec.add_dependency 'thor', '~> 1.3'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/exe/benny

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'benny/cli'
+
+Benny::CLI.start

data/lib/benny/cli.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'thor'
+
+module Benny
+  class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+    default_task :all
+
+    desc 'init NAME', 'Create a new benny project'
+    def init(name)
+      require_relative 'init'
+      Init.create(name)
+    end
+
+    desc 'all', 'Run all bechmarks in all environments'
+    def all
+      require 'benny'
+      Benny.load_env
+      Benny.execute
+    end
+
+    desc 'execute', 'Execute a set of benchmarks'
+    method_options 'result-path' => :string
+    method_options 'env-name' => :string
+    def execute
+      require 'benny'
+      Benny.load_env
+      Executors::Benchmark.execute(benchmarks: Benny.benchmarks,
+                                   reporter: Reporters::File.new(env_name: options['env-name'],
+                                                                 path: options['result-path']))
+    end
+  end
+end

data/lib/benny/configuration.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Benny
+  class Configuration
+    attr_reader :environments
+
+    class EnvironmentEntry
+      attr_reader :name
+
+      def initialize(name, &block)
+        @name = name
+        instance_exec(&block)
+      end
+
+      def gemfile(path = nil)
+        @gemfile = path unless path.nil?
+        @gemfile
+      end
+    end
+
+    def environment(name, &block)
+      @environments ||= []
+      @environments << EnvironmentEntry.new(name, &block)
+    end
+
+    def reporter(reporter = nil)
+      @reporter = reporter
+      @reporter || Reporters::Stdout.new
+    end
+
+    def benchmark_path(path = nil)
+      @benchmark_path = path unless path.nil?
+      @benchmark_path || 'benchmarks/**/*_bench.rb'
+    end
+  end
+end

data/lib/benny/dsl.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Benny
+  module DSL
+    class Definition
+      class WarmupOptions
+        attr_reader :iterations
+
+        def initialize(iterations:)
+          @iterations = iterations
+        end
+      end
+
+      class BenchmarkEntry
+        attr_reader :name, :block, :definition
+
+        def initialize(definition, name, &block)
+          @name = name
+          @block = block
+          @definition = definition
+        end
+      end
+
+      attr_reader :benchmarks, :before_blocks, :warmup_options
+
+      def initialize(&block)
+        @before_blocks = []
+        @benchmarks    = []
+        @warmup_options = WarmupOptions.new(iterations: 1)
+        instance_eval(&block)
+      end
+
+      def warmup(iterations:)
+        @warmup_options = WarmupOptions.new(iterations: iterations)
+      end
+
+      def before(&block)
+        @before_blocks << block
+      end
+
+      def benchmark(name, &block)
+        @benchmarks << BenchmarkEntry.new(self, name, &block)
+      end
+    end
+
+    def define(&block)
+      @definitions ||= []
+      @definitions << Definition.new(&block)
+    end
+
+    def benchmarks
+      definitions.flat_map(&:benchmarks)
+    end
+
+    def load(path)
+      instance_eval(File.read(path), path, 1)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    attr_reader :environments, :definitions
+  end
+end

data/lib/benny/executors/benchmark.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+
+module Benny
+  module Executors
+    class Benchmark
+      attr_reader :benchmarks, :reporter
+
+      def initialize(benchmarks:, reporter:)
+        @benchmarks = benchmarks
+        @reporter   = reporter
+      end
+
+      def execute
+        benchmarks.each do |benchmark|
+          execute_one(benchmark)
+        end
+      end
+
+      def execute_one(benchmark)
+        benchmark.definition.before_blocks.each(&:call)
+
+        benchmark.definition.warmup_options.iterations.times do
+          benchmark.block.call
+        end
+
+        measure = ::Benchmark.measure do
+          benchmark.block.call
+        end
+
+        reporter.report(benchmark, measure)
+      end
+
+      def self.execute(benchmarks:, reporter:)
+        new(benchmarks: benchmarks, reporter: reporter).execute
+      end
+    end
+  end
+end

data/lib/benny/executors/environment.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+require 'tmpdir'
+
+module Benny
+  module Executors
+    class Environment
+      attr_reader :environments, :reporter
+
+      def initialize(environments:, reporter:)
+        @environments = environments
+        @reporter     = reporter
+      end
+
+      def run!
+        Output.puts("Running benchmark for #{environments.size} environments. Reporter: #{reporter.class.name}")
+
+        Dir.mktmpdir('benny') do |dir|
+          environments.each do |e|
+            run_one(e, dir)
+          end
+          report(dir)
+        end
+      end
+
+      def run_one(environment, dir)
+        Bundler.with_original_env do
+          ENV['BUNDLE_GEMFILE'] = environment.gemfile
+          Output.puts('Installing dependencies...')
+          Kernel.system(Shellwords.join(%w[bundle install]))
+          Output.puts("Executing benchmark for '#{environment.name}'..")
+          Kernel.system(Shellwords.join(['bundle', 'exec', 'benny', 'execute',
+                                         '--result-path', dir,
+                                         '--env-name', environment.name]))
+        end
+      end
+
+      def report(dir)
+        Output.puts('Generating report...')
+        metrics = Dir.glob(File.join(dir, '*.json')).map { |file| JSON.parse(File.read(file), symbolize_names: true) }
+        reporter.report(metrics)
+      end
+
+      def self.run!(*args)
+        new(*args).run!
+      end
+    end
+  end
+end

data/lib/benny/init/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gem 'benny'

data/lib/benny/init/benchmarks/bench_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Benny.configure do |config|
+  config.environment 'latest' do
+    gemfile 'gemfiles/latest.gemfile'
+  end
+end

data/lib/benny/init/benchmarks/parse_bench.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+Benny.define do
+  before do
+    # Require dependencies or other setup
+  end
+
+  benchmark 'Description of benchmark' do
+    # Content of benchmark
+  end
+
+  benchmark 'Another benchmark' do
+    # Content of another benchmark
+  end
+end

data/lib/benny/init/gemfiles/latest.gemfile

@@ -0,0 +1,5 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "benny"

data/lib/benny/init.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Benny
+  module Init
+    def self.create(name)
+      raise ArgumentError, "The dir '#{name}' already exists" if Dir.exist?(name)
+
+      FileUtils.copy_entry(File.join(__dir__, 'init'), name)
+    end
+  end
+end

data/lib/benny/output.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Benny
+  module Output
+    def self.puts(txt)
+      $stdout.puts("[Benny] #{txt}")
+    end
+  end
+end

data/lib/benny/reporters/file.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Benny
+  module Reporters
+    class File
+      def initialize(path:, env_name:)
+        @path = path
+        @data = {
+          env_name: env_name,
+          benchmarks: []
+        }
+
+        at_exit { ::File.write(::File.join(@path, "#{Process.pid}.json"), JSON.dump(@data)) }
+      end
+
+      def report(benchmark, measure)
+        raise ArgumentError, "Measure of type #{measure.class} not supported." unless measure.is_a?(Benchmark::Tms)
+
+        @data[:benchmarks] << {
+          type: 'Benchmark::Tms',
+          name: benchmark.name,
+          utime: measure.utime,
+          stime: measure.stime,
+          total: measure.total
+        }
+      end
+    end
+  end
+end

data/lib/benny/reporters/gruff.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'gruff'
+
+module Benny
+  module Reporters
+    class Gruff
+      def report(metrics) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        g = ::Gruff::SideBar.new(800)
+        g.title = 'Benchmark results'
+        result = {}
+        labels = {}
+
+        metrics.each.with_index do |metric, i|
+          labels[i] = metric[:env_name]
+          metric[:benchmarks].each do |bm|
+            result[bm[:name]] ||= []
+            result[bm[:name]] << bm[:total]
+          end
+        end
+
+        g.labels = labels
+        result.each { |k, v| g.data(k, v) }
+
+        g.write('result.png')
+      end
+    end
+  end
+end

data/lib/benny/reporters/stdout.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'terminal-table'
+
+module Benny
+  module Reporters
+    class Stdout
+      def initialize
+        @io = $stdout
+      end
+
+      def report(metrics)  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        result = {}
+        labels = ['']
+
+        metrics.each.with_index do |metric, _i|
+          labels << metric[:env_name]
+          metric[:benchmarks].each do |bm|
+            result[bm[:name]] ||= []
+            result[bm[:name]] << bm[:total].round(5)
+          end
+        end
+
+        rows = result.map do |k, v|
+          ([k] + v)
+        end
+
+        puts Terminal::Table.new(headings: labels, rows: rows)
+      end
+    end
+  end
+end

data/lib/benny/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Benny
+  VERSION = '0.0.1'
+end

data/lib/benny.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'benny/dsl'
+require_relative 'benny/cli'
+require_relative 'benny/output'
+require_relative 'benny/configuration'
+require_relative 'benny/executors/benchmark'
+require_relative 'benny/executors/environment'
+require_relative 'benny/reporters/stdout'
+require_relative 'benny/reporters/gruff'
+require_relative 'benny/reporters/file'
+require_relative 'benny/version'
+
+module Benny
+  extend DSL
+
+  def self.load_env
+    load('benchmarks/bench_helper.rb')
+    load_benchmarks(configuration.benchmark_path)
+    Output.puts("Loaded #{benchmarks.size} benchmark(s)")
+  end
+
+  def self.execute
+    Executors::Environment.new(environments: configuration.environments,
+                               reporter: configuration.reporter).run!
+  end
+
+  def self.load_benchmarks(path)
+    Dir[path].each do |file|
+      load(file)
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: benny
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joakim Antman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gruff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Define and maintain your benchmarks in a familiarway.Execute on different
+  variations of environments
+email:
+- antmanj@gmail.com
+executables:
+- benny
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- benny.gemspec
+- exe/benny
+- lib/benny.rb
+- lib/benny/cli.rb
+- lib/benny/configuration.rb
+- lib/benny/dsl.rb
+- lib/benny/executors/benchmark.rb
+- lib/benny/executors/environment.rb
+- lib/benny/init.rb
+- lib/benny/init/Gemfile
+- lib/benny/init/benchmarks/bench_helper.rb
+- lib/benny/init/benchmarks/parse_bench.rb
+- lib/benny/init/gemfiles/latest.gemfile
+- lib/benny/output.rb
+- lib/benny/reporters/file.rb
+- lib/benny/reporters/gruff.rb
+- lib/benny/reporters/stdout.rb
+- lib/benny/version.rb
+homepage: https://github.com/anakinj/benny
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/anakinj/benny
+  source_code_uri: https://github.com/anakinj/benny
+  changelog_uri: https://github.com/anakinj/benny/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Benny the benchmark gem
+test_files: []