benchmark-inputs 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6e909d515239a8262e68c3f13b3cdb6d3840be4999b647aa1267dbd3184f69b
-  data.tar.gz: 37c78630c9af1f254438db2cb427e073a2bc97e2b25f7cedf4a0f73deba34d00
+  metadata.gz: 479396b0af0c6982d03041ed914bb253c3aba964f83eeecf6d45e251958d4b03
+  data.tar.gz: 664df72e260c22324f408d8b32d577748b1b499d1e1168d90f452c3bd37f40b6
 SHA512:
-  metadata.gz: 184afc9a7110ad536dce0881db8c092958986e245e0a90af9040ac70372afac583811b29765c0098b5233e7e1c637c3c10188cce44e4e4c0d48930b96e5ccf8d
-  data.tar.gz: 9859889f725c6849d524d6fd08cb1a579c6598f1135b7000adc4cc77cb3910899a8700ee931f3679d36b36cbd11b7c19e08350b4c03b708dc8896b4f7af0c22e
+  metadata.gz: 163229a9605d1cbca73e25eacf6dcff8624317dd33da2b8dbdef650c1364be343b45500e1322f8c353a315c021993b214ae649172cdc8500ef9d9c1fd5416f83
+  data.tar.gz: 22e98dc216a2d82e4824fcc6ffd6a8b7b2cbe904190133f8bef8d59969009db8f32ad0c4c1ebd9a18d44ec6fd6c1f79ed0627e0f6f66ca96474a3ed35c6128ab

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 2.0.0
+
+* Drop support for Ruby < 3.4
+* Exclude `.gitignore` and `.github` files from the released gem
+
+
+## 1.1.1
+
+* Fix Ruby 2.7 kwarg warnings
+
+
 ## 1.1.0
 
 * Support `Benchmark.inputs` options hash

data/Gemfile

@@ -1,4 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in benchmark-inputs.gemspec
 gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.27"

data/README.md

@@ -18,8 +18,8 @@ require "benchmark/ips" ### USING benchmark-ips (NOT benchmark-inputs)
 
 STRINGS = ["abc", "aaa", "xyz", ""]
 Benchmark.ips do |job|
-  job.report("String#tr"){ STRINGS.each{|s| s.tr("a", "A") } }
-  job.report("String#gsub"){ STRINGS.each{|s| s.gsub(/a/, "A") } }
+  job.report("String#tr"){ STRINGS.each{|string| string.tr("a", "A") } }
+  job.report("String#gsub"){ STRINGS.each{|string| string.gsub(/a/, "A") } }
   job.compare!
 end
 ```
@@ -33,33 +33,36 @@ each value individually, but that is more verbose and more error-prone:
 ```ruby
 require "benchmark/ips" ### USING benchmark-ips (NOT benchmark-inputs)
 
-s1, s2, s3, s4 = ["abc", "aaa", "xyz", ""]
+string1, string2, string3, string4 = ["abc", "aaa", "xyz", ""]
 Benchmark.ips do |job|
   job.report("String#tr") do
-    s1.tr("a", "A")
-    s2.tr("a", "A")
-    s3.tr("a", "A")
-    s4.tr("a", "A")
+    string1.tr("a", "A")
+    string2.tr("a", "A")
+    string3.tr("a", "A")
+    string4.tr("a", "A")
   end
   job.report("String#gsub") do
-    s1.gsub(/a/, "A")
-    s2.gsub(/a/, "A")
-    s3.gsub(/a/, "A")
-    s4.gsub(/a/, "A")
+    string1.gsub(/a/, "A")
+    string2.gsub(/a/, "A")
+    string3.gsub(/a/, "A")
+    string4.gsub(/a/, "A")
   end
   job.compare!
 end
 ```
 
+
+## Usage
+
 *Enter benchmark-inputs*.  Here is how the same benchmark looks using
-this gem: <a name="example1"></a>
+this gem:
 
 ```ruby
 require "benchmark/inputs" ### USING benchmark-inputs
 
 Benchmark.inputs(["abc", "aaa", "xyz", ""]) do |job|
-  job.report("String#tr"){|s| s.tr("a", "A") }
-  job.report("String#gsub"){|s| s.gsub(/a/, "A") }
+  job.report("String#tr"){|string| string.tr("a", "A") }
+  job.report("String#gsub"){|string| string.gsub(/a/, "A") }
   job.compare!
 end
 ```
@@ -93,8 +96,8 @@ behind the scenes.  To enable this, use the `dup_inputs` option:
 require "benchmark/inputs"
 
 Benchmark.inputs(["abc", "aaa", "xyz", ""], dup_inputs: true) do |job|
-  job.report("String#tr!"){|s| s.tr!("a", "A") }
-  job.report("String#gsub!"){|s| s.gsub!(/a/, "A") }
+  job.report("String#tr!"){|string| string.tr!("a", "A") }
+  job.report("String#gsub!"){|string| string.gsub!(/a/, "A") }
   job.compare!
 end
 ```
@@ -112,13 +115,18 @@ Comparison:
   String#gsub!:    281588.6 i/s - 6.37x slower
 ```
 
-That shows a slightly larger performance gap than the previous
+The above shows a slightly larger performance gap than the previous
 benchmark.  This makes sense because the overhead of allocating new
 strings -- previously via a non-bang method, but now via `dup` -- is now
 excluded from the timings.  Thus, the speed of `tr!` relative to `gsub!`
 is further emphasized.
 
 
+## API
+
+See the [API documentation](https://www.rubydoc.info/gems/benchmark-inputs).
+
+
 ## Limitations
 
 `Benchmark.inputs` generates code based on the array of input values it
@@ -126,26 +134,18 @@ is given.  Each input value becomes a local variable.  While there is
 theoretically no limit to the number of local variables that can be
 generated, more than a few hundred may slow down the benchmark.  But,
 because input values are used to represent different scenarios rather
-than control the number of invocations, this limitation shouldn't pose a
-problem.
+than control the number of invocations, this limitation should not pose
+a problem.
 
 
 ## Installation
 
-```bash
-$ gem install benchmark-inputs
-```
-
-
-## Usage
-
-See the [example above](#example1), or check out the
-[API documentation](http://www.rubydoc.info/gems/benchmark-inputs).
+Install the [`benchmark-inputs` gem](https://rubygems.org/gems/benchmark-inputs).
 
 
 ## License
 
-[MIT License](http://opensource.org/licenses/MIT)
+[MIT License](LICENSE.txt)
 
 
 

data/Rakefile

@@ -1,18 +1,5 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
-require "yard"
-
-
-desc 'Launch IRB with this gem pre-loaded'
-task :irb do
-  require "benchmark/inputs"
-  require "irb"
-  ARGV.clear
-  IRB.start
-end
-
-YARD::Rake::YardocTask.new(:doc) do |t|
-end
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"

data/benchmark-inputs.gemspec

@@ -1,25 +1,25 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'benchmark/inputs/version'
+require_relative "lib/benchmark/inputs/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "benchmark-inputs"
   spec.version       = Benchmark::Inputs::VERSION
   spec.authors       = ["Jonathan Hefner"]
-  spec.email         = ["jonathan.hefner@gmail.com"]
+  spec.email         = ["jonathan@hefner.pro"]
 
   spec.summary       = %q{Input-focused benchmarking}
   spec.homepage      = "https://github.com/jonathanhefner/benchmark-inputs"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.4"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.metadata["source_code_uri"] + "/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| f.start_with?("test/", ".git") }
+  end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", ">= 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "yard", "~> 0.9"
 end

data/lib/benchmark/inputs/version.rb

@@ -1,5 +1,5 @@
 module Benchmark
   module Inputs
-    VERSION = "1.1.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/benchmark/inputs.rb

@@ -2,44 +2,41 @@ require "benchmark/inputs/version"
 
 module Benchmark
 
-  # Initializes a benchmark job with the given inputs and yields that
-  # job to the given block.
+  # Initializes a benchmark Job, and yields the Job to the given block.
   #
   # @example Benchmarking non-destructive operations
   #   Benchmark.inputs(["abc", "aaa", "xyz", ""]) do |job|
-  #     job.report("String#tr"){|s| s.tr("a", "A") }
-  #     job.report("String#gsub"){|s| s.gsub(/a/, "A") }
+  #     job.report("String#tr"){|string| string.tr("a", "A") }
+  #     job.report("String#gsub"){|string| string.gsub(/a/, "A") }
   #     job.compare!
   #   end
   #
   # @example Benchmarking destructive operations
   #   Benchmark.inputs(["abc", "aaa", "xyz", ""], dup_inputs: true) do |job|
-  #     job.report("String#tr!"){|s| s.tr!("a", "A") }
-  #     job.report("String#gsub!"){|s| s.gsub!(/a/, "A") }
+  #     job.report("String#tr!"){|string| string.tr!("a", "A") }
+  #     job.report("String#gsub!"){|string| string.gsub!(/a/, "A") }
   #     job.compare!
   #   end
   #
   # @param values [Array]
-  #   input values to yield to each benchmark action
+  #   Input values to be individually yielded to all {Inputs::Job#report
+  #   +report+} blocks
   # @param options [Hash]
-  # @option options :dup_inputs [Boolean]
-  #   whether input values will be +dup+-ed before they are passed to a
-  #   {Inputs::Job#report} block
-  # @option options :sample_n [Integer]
-  #   number of samples to take when benchmarking
-  # @option options :sample_dt [Integer]
-  #   approximate duration of time (in nanoseconds) each sample should
-  #   take when benchmarking
-  # @yield [job]
-  #   configures job and runs benchmarks
+  # @option options :dup_inputs [Boolean] (false)
+  #   Whether each of +values+ should be +dup+'d before being yielded to
+  #   a {Inputs::Job#report +report+} block.  This should be set to true
+  #   if any +report+ block destructively modifies its input.
+  # @option options :sample_n [Integer] (10)
+  #   Number of samples to take when benchmarking
+  # @option options :sample_dt [Integer] (200,000 ns)
+  #   Approximate duration of time each sample should take when
+  #   benchmarking, in nanoseconds
   # @yieldparam job [Benchmark::Inputs::Job]
-  #   benchmark runner
   # @return [Benchmark::Inputs::Job]
-  #   benchmark runner
   # @raise [ArgumentError]
   #   if +values+ is empty
   def self.inputs(values, **options)
-    job = Inputs::Job.new(values, options)
+    job = Inputs::Job.new(values, **options)
     yield job
     job
   end
@@ -47,23 +44,14 @@ module Benchmark
 
   module Inputs
 
+    # @!visibility private
     NS_PER_S = 1_000_000_000
+    # @!visibility private
     NS_PER_MS = NS_PER_S / 1_000
 
     class Job
 
-      # @param inputs [Array]
-      #   input values to yield to each benchmark action
-      # @param dup_inputs [Boolean]
-      #   whether input values will be +dup+-ed before they are passed
-      #   to a {report} block
-      # @param sample_n [Integer]
-      #   number of samples to take when benchmarking
-      # @param sample_dt [Integer]
-      #   approximate duration of time (in nanoseconds) each sample
-      #   should take when benchmarking
-      # @raise [ArgumentError]
-      #   if +inputs+ is empty
+      # @!visibility private
       def initialize(inputs, dup_inputs: false, sample_n: 10, sample_dt: NS_PER_MS * 200)
         raise ArgumentError, "No inputs specified" if inputs.empty?
 
@@ -75,16 +63,9 @@ module Benchmark
         def_bench!
       end
 
-      # Indicates whether input values will be +dup+-ed before they are
-      # passed to a {report} block.  Defaults to +false+.  This should
-      # be set to +true+ if {report} blocks destructively modify their
-      # arguments.
-      #
       # @return [Boolean]
       attr_reader :dup_inputs
 
-      # See {dup_inputs}.
-      #
       # @param flag [Boolean]
       # @return [Boolean]
       def dup_inputs=(flag)
@@ -93,14 +74,9 @@ module Benchmark
         @dup_inputs
       end
 
-      # The number of samples to take when benchmarking.  Defaults to 10.
-      #
       # @return [Integer]
       attr_accessor :sample_n
 
-      # The approximate duration of time (in nanoseconds) each sample
-      # should take when benchmarking.  Defaults to 200,000 nanoseconds.
-      #
       # @return [Integer]
       attr_accessor :sample_dt
 
@@ -110,21 +86,19 @@ module Benchmark
       # @return [Array<Benchmark::Inputs::Report>]
       attr_reader :reports
 
-      # Benchmarks the given block using the previously provided input
-      # values.  If {dup_inputs} is set to true, each input value is
-      # +dup+'d before being passed to the block.  The block's
-      # iterations per second (i/s) is printed to +$stdout+, and a
-      # {Report} is added to {reports}.
+      # Benchmarks the given block using each of the Job's input values.
+      # If {dup_inputs} is true, each input value is +dup+'d before
+      # being yielded to the block.  Prints the block's estimated speed
+      # (in invocations per second) to +$stdout+, and adds a {Report} to
+      # {reports}.
       #
       # @param label [String]
-      #   label for the benchmark
-      # @yield [input]
-      #   action to benchmark
+      #   Label for the report
       # @yieldparam input [Object]
-      #   one of the initially provided input values
+      #   One of the Job's input values
       # @return [void]
       def report(label)
-        # estimate repititions
+        # estimate repetitions
         reps = 1
         reps_time = 0
         while reps_time < @sample_dt
@@ -148,7 +122,7 @@ module Benchmark
       end
 
       # Prints the relative speeds (from fastest to slowest) of all
-      # {report}-ed benchmarks to +$stdout+.
+      # {reports} to +$stdout+.
       #
       # @return [void]
       def compare!
@@ -210,9 +184,11 @@ module Benchmark
       # @return [String]
       attr_reader :label
 
-      # The ratio of iterations per second for this report compared to
-      # the fastest report.  Will be +nil+ if the difference between the
-      # two falls within the combined measurement error.
+      # The ratio of the speed from the fastest report compared to the
+      # speed from this report.  In other words, the "slower than
+      # fastest by" multiplier for this report.  Will be +nil+ if the
+      # absolute difference in speed between the two reports falls
+      # within the combined measurement error.
       #
       # This value is set by {Benchmark::Inputs::Job#compare!}.
       #
@@ -243,14 +219,14 @@ module Benchmark
         @stddev = nil
       end
 
-      # The estimated iterations per second for the report.
+      # The estimated speed for the report, in invocations per second.
       #
       # @return [Float]
       def ips
         @mean
       end
 
-      # The {ips} standard deviation.
+      # The standard deviation of the estimated speed for the report.
       #
       # @return [Float]
       def stddev

metadata

@@ -1,80 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-inputs
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonathan Hefner
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-25 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-description: 
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
 email:
-- jonathan.hefner@gmail.com
+- jonathan@hefner.pro
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -86,8 +26,9 @@ files:
 homepage: https://github.com/jonathanhefner/benchmark-inputs
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/jonathanhefner/benchmark-inputs
+  changelog_uri: https://github.com/jonathanhefner/benchmark-inputs/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -95,15 +36,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Input-focused benchmarking
 test_files: []

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.gem

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2.4
-before_install: gem install bundler -v 1.12.5