benchable 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8cc2eab98fd2843682811029e789c3d50f28cef0cab9e607936700579e65cf6
-  data.tar.gz: 38f5b868dece18aaf0567603346ff9677b998486c12236a6915cfbedac0ead13
+  metadata.gz: 87cc0bd81e3bc20d1cff1143def72c70684a065f40b0077d709624a0303a1dd3
+  data.tar.gz: d8346382a1e72d1c39dc36ebf55089a0f85816445ce35f80c53f68e059d50266
 SHA512:
-  metadata.gz: 555bcfbff720e4f8044504d7055da3b265f3adf0ad73ba8039dd6f3cc31de82cce6932ce100934ddc72356c2e59021334fa9f83eab31f3e9d090f5d9d88d7aed
-  data.tar.gz: dbc3b735b5400fa4cd948bc4535cb2a5d2998463b8411b72cd569171dff21058bd89bb6d9c73a2f58d5cd3fdfe4470fbc1d636832c3fa5bbf00b45075afefbb1
+  metadata.gz: efae28a9f656b930e64ed9b443a9b75d50199de020c8a18e15b6e2fd648beae2a3bcf9915f31b9bae42988affac526c2908d8237e982b157a7fbc10f0d534f8d
+  data.tar.gz: 4f6cdd10159e9251eb7dabae2f16b7fcfb9909d8e252027b2dc12e8b070b1aec0095ea09c1cfbdc69c9d2d3a8384e8ff7bba19ec0b53f6456ea015cb3ceba726

data/.github/workflows/tests-and-linter.yml

@@ -2,19 +2,19 @@ name: Ruby
 
 on:
   push:
-    branches: [master]
+    branches: [main]
   pull_request:
-    branches: [master]
+    branches: [main]
 
 jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.6, 2.7, '3.0']
+        ruby: ['3.1', '3.2', '3.3', '3.4']
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.4

data/CHANGELOG.md

@@ -6,8 +6,25 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
 ---
 
+## [0.3.2] - 2025-05-29
+
+### Changed
+
+- Keep benchmark cases titles consistent
+
+Before, we would call "capitalize" on the title of the benchmark case, which
+would change the original string the user provided. This fixes it, so the report
+always uses the original title.
+
+## [0.3.1] - 2021-09-10
+
+### Changed
+
+- Fix benchmark arguments for Benchmark::Memory.
+
 ## [0.3.0] - 2021-09-09
 
 ### Added
@@ -42,6 +59,7 @@ end
 ## [0.2.0] - 2020-10-23
 
 ### Added
+
 - Support for `Benchmark.memory` via [benchmark-memory](https://github.com/michaelherold/benchmark-memory).
 
 [unreleased]: https://github.com/MatheusRich/benchable/compare/v0.2.0...HEAD
@@ -50,9 +68,12 @@ end
 ## [0.1.0] - 2020-08-16
 
 ### Added
+
 - Support for `Benchmark.bm`, `Benchmark.bmbm` and `Benchmark.ips`.
 
-[unreleased]: https://github.com/MatheusRich/benchable/compare/v0.3.0...HEAD
-[0.1.0]: https://github.com/MatheusRich/benchable/releases/tag/v0.1.0
+[unreleased]: https://github.com/MatheusRich/benchable/compare/v0.3.2...HEAD
+[0.3.2]: https://github.com/MatheusRich/benchable/releases/tag/v0.3.2
+[0.3.1]: https://github.com/MatheusRich/benchable/releases/tag/v0.3.1
+[0.3.0]: https://github.com/MatheusRich/benchable/releases/tag/v0.3.0
 [0.2.0]: https://github.com/MatheusRich/benchable/releases/tag/v0.2.0
-[0.3.0]: https://github.com/MatheusRich/benchable/releases/tag/v0.3.0
+[0.1.0]: https://github.com/MatheusRich/benchable/releases/tag/v0.1.0

data/Gemfile

@@ -8,7 +8,6 @@ gemspec
 gem "guard-rspec", require: false
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
-gem "standard", "~> 1.3.0"
-gem "simplecov", "~> 0.18.5", require: false
-gem "solargraph", "~> 0.39"
+gem "standard", "~> 1.30"
+gem "simplecov", "~> 0.22.0", require: false
 gem "yard", "~> 0.9.25"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    benchable (0.2.0)
+    benchable (0.3.2)
       benchmark-ips (~> 2.8, >= 2.8.2)
       benchmark-memory (~> 0.1.2)
 
@@ -9,18 +9,15 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    backport (1.2.0)
-    benchmark (0.1.1)
-    benchmark-ips (2.9.1)
+    benchmark-ips (2.14.0)
     benchmark-memory (0.1.2)
       memory_profiler (~> 0.9)
     coderay (1.1.3)
-    diff-lcs (1.4.4)
-    docile (1.4.0)
-    e2mmap (0.1.0)
-    ffi (1.15.4)
-    formatador (0.3.0)
-    guard (2.18.0)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    ffi (1.17.0)
+    formatador (1.1.0)
+    guard (2.19.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -34,96 +31,86 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    jaro_winkler (1.5.4)
-    kramdown (2.3.1)
-      rexml
-    kramdown-parser-gfm (1.1.0)
-      kramdown (~> 2.0)
-    listen (3.7.0)
+    json (2.9.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.8)
+    lumberjack (1.2.10)
     memory_profiler (0.9.14)
-    method_source (1.0.0)
-    mini_portile2 (2.6.1)
+    method_source (1.1.0)
     nenv (0.3.0)
-    nokogiri (1.12.4)
-      mini_portile2 (~> 2.6.1)
-      racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    parallel (1.26.3)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.5.2)
-    rainbow (3.0.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
     rake (12.3.3)
-    rb-fsevent (0.11.0)
-    rb-inotify (0.10.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
       ffi (~> 1.0)
-    regexp_parser (2.1.1)
-    reverse_markdown (2.0.0)
-      nokogiri
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.20.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.69.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.11.5)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.37.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
     shellany (0.0.1)
-    simplecov (0.18.5)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.3)
-    solargraph (0.43.0)
-      backport (~> 1.2)
-      benchmark
-      bundler (>= 1.17.2)
-      diff-lcs (~> 1.4)
-      e2mmap
-      jaro_winkler (~> 1.5)
-      kramdown (~> 2.3)
-      kramdown-parser-gfm (~> 1.1)
-      parser (~> 3.0)
-      reverse_markdown (>= 1.0.5, < 3)
-      rubocop (>= 0.52)
-      thor (~> 1.0)
-      tilt (~> 2.0)
-      yard (~> 0.9, >= 0.9.24)
-    standard (1.3.0)
-      rubocop (= 1.20.0)
-      rubocop-performance (= 1.11.5)
-    thor (1.1.0)
-    tilt (2.0.10)
-    unicode-display_width (2.0.0)
-    yard (0.9.26)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    standard (1.43.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.69.1)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.6)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.6.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.23.0)
+    thor (1.3.2)
+    unicode-display_width (3.1.3)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    yard (0.9.37)
 
 PLATFORMS
   ruby
@@ -133,10 +120,9 @@ DEPENDENCIES
   guard-rspec
   rake (~> 12.0)
   rspec (~> 3.0)
-  simplecov (~> 0.18.5)
-  solargraph (~> 0.39)
-  standard (~> 1.3.0)
+  simplecov (~> 0.22.0)
+  standard (~> 1.30)
   yard (~> 0.9.25)
 
 BUNDLED WITH
-   2.1.4
+   2.6.2

data/README.md

@@ -123,7 +123,7 @@ You can provide benchmark options by passing a hash to the `Benchable.bench` met
 
 #### Options for `Benchmark.bm` and `Benchmark.bmbm`
 
-On `bm` and `bmbm` benchmarks the only available option is `width`, which specifies the leading spaces for labels on each line. The default width is `20`.
+The only available option is `width` on `bm` and `bmbm` benchmarks, which specifies the leading spaces for labels on each line. The default width is `20`.
 
 ```ruby
 Benchable.bench(width: 25) do
@@ -133,7 +133,7 @@ end
 
 #### Options for `Benchmark::IPS`
 
-If you're using `::IPS`, you can pass any option accepted by `Benchmark::IPS`' `config` method.
+If you're using `::IPS`, you can pass any option accepted by `Benchmark::IPS`'s `config` method.
 
 ```ruby
 Benchable.bench(:ips, time: 5, warmup: 2) do

data/benchable.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage = "https://github.com/MatheusRich/benchable"
   spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/MatheusRich/benchable"

data/lib/benchable/benchmark.rb

@@ -12,7 +12,7 @@ module Benchable
     DEFAULT_WIDTH = 20
     BENCHMARK_TYPES = %i[bm bmbm ips memory].freeze
 
-    def initialize(benchmark_type, options = {})
+    def initialize(benchmark_type, **options)
       @benchmark_type = benchmark_type
       @options = options
 
@@ -24,7 +24,7 @@ module Benchable
     end
 
     def self.bench(name, &block)
-      define_method(method_name_for(name), &block)
+      define_method(:"bench_#{name}", &block)
     end
 
     def setup
@@ -39,10 +39,6 @@ module Benchable
       public_methods.grep(/\Abench_/)
     end
 
-    private_class_method def self.method_name_for(name)
-      "bench_#{name.to_s.tr(" ", "_").downcase}"
-    end
-
     private
 
     attr_reader :benchmark_type, :options
@@ -53,10 +49,10 @@ module Benchable
 
     def run_benchmark
       benchmark do |b|
-        b.config(**options) if benchmark_type == :ips
+        b.config(options) if benchmark_type == :ips
 
         cases.each do |benchmark_case|
-          b.report(name_for(benchmark_case)) do
+          b.report(title_for(benchmark_case)) do
             method(benchmark_case).call
           end
         end
@@ -65,22 +61,24 @@ module Benchable
       end
     end
 
-    def name_for(benchmark_case)
-      benchmark_case.to_s.gsub("bench_", "").tr("_", " ").capitalize
+    def title_for(benchmark_case)
+      benchmark_case.to_s.delete_prefix("bench_")
     end
 
     def benchmark(&block)
-      ::Benchmark.public_send(*benchmark_args, &block)
+      if benchmark_type == :memory
+        ::Benchmark.public_send(benchmark_type, **benchmark_args, &block)
+      else
+        ::Benchmark.public_send(benchmark_type, *benchmark_args, &block)
+      end
     end
 
     def benchmark_args
-      width = options[:width] || DEFAULT_WIDTH
-
-      args = [benchmark_type]
-      args << width unless benchmark_type == :memory
-      args << options if benchmark_type == :memory
-
-      args
+      if benchmark_type == :memory
+        options.slice(:quiet)
+      else
+        options[:width] || DEFAULT_WIDTH
+      end
     end
   end
 end

data/lib/benchable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Benchable
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: benchable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Matheus Richard
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -44,7 +43,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
-description:
 email:
 - matheusrichardt@gmail.com
 executables: []
@@ -54,6 +52,7 @@ files:
 - ".github/workflows/tests-and-linter.yml"
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -75,7 +74,6 @@ metadata:
   homepage_uri: https://github.com/MatheusRich/benchable
   source_code_uri: https://github.com/MatheusRich/benchable
   changelog_uri: https://github.com/MatheusRich/benchable/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,15 +81,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Write benchmarks without the hassle
 test_files: []