rspec-benchmark 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d86ffbdf2e75f6789264a4206e3caf39f32927f5ad751eb6f02b69fc72743dc
-  data.tar.gz: '096f74a7d6ac5b64b347c38f19757ddd7b870e9dc80996e2dcb09ad13bdacfe2'
+  metadata.gz: 907b4211a79dbed8db1edb3b2c6a694536302ef576111d6cab8e16ebe0c628f3
+  data.tar.gz: 1ed51ed22ab19a877fafb4c074161b2b4d5c9f2cfc87ac840c552a1b33046825
 SHA512:
-  metadata.gz: 673740a08e95e8d0790a9200e30400bb0f2fc0b1ec5f12a4665b709363f0687af9a35a767b336d24aba13d21b25fea334e68011d8572b8c2a0de9e90e845c3e3
-  data.tar.gz: e5a4fd2ffa45d39980edfd900d385f8df95083ef7d6741cea8fc1a885ce34008feec1d13ad602123861f07acb8a5b1fb1fe1f41f12b150cfe037c2d6aa2e5ffe
+  metadata.gz: e312397def220c32daa2a2b3f385560cf12852096722434c508279ffcb41d38b2110ca2ce8179c73a83c8d5abb1faeac3b20b4bc2a6af0cf83aed4781489cb61
+  data.tar.gz: a2a1a4f205ee93369b88b354edc6742651a5bd4d0cd8773993c33769227ef1b8e7e62053a05719f8818ef3db96da05af3b1c4ae8ce03ae9bdb8466f7ce68a334

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change log
 
+## [v0.6.0] - 2020-03-09
+
+### Added
+* Add Formatter#format_unit for making numbers more readable
+* Add :format configuration option
+
+### Changed
+* Change TimingMatcher to use new #cpu interface
+* Change IterationMatcher to use new #ips interface
+* Change IterationMatcher to format iterations with units
+* Change gemspec to add metadata, remove test artefacts
+* Change benchmark-perf, benchmark-trend & benchmark-malloc versions
+
+### Fixed
+* Fix Ruby 2.7 warnings converting hash into keywowrd arguments
+* Fix IterationMatcher to stop raising FloatDomainError
+
 ## [v0.5.1] - 2019-09-11
 
 ### Fixed
@@ -54,6 +71,7 @@
 
 Initial release
 
+[v0.6.0]: https://github.com/peter-murach/rspec-benchmark/compare/v0.5.1...v0.6.0
 [v0.5.1]: https://github.com/peter-murach/rspec-benchmark/compare/v0.5.0...v0.5.1
 [v0.5.0]: https://github.com/peter-murach/rspec-benchmark/compare/v0.4.0...v0.5.0
 [v0.4.0]: https://github.com/peter-murach/rspec-benchmark/compare/v0.3.0...v0.4.0

data/README.md

@@ -41,6 +41,7 @@ If you are new to performance testing you may find [Caveats](#5-caveats) section
   * [3.1 :disable_gc](#31-disable_gc)
   * [3.2 :run_in_subprocess](#32-run_in_subprocess)
   * [3.3 :samples](#33-samples)
+  * [3.4 :format](#34-format)
 * [4. Filtering](#4-filtering)
 * [5. Caveats](#5-caveats)
 
@@ -269,7 +270,9 @@ expect { |n, i|
 
 The `perform_allocation` matcher checks how much memory or objects have been allocated during a piece of Ruby code execution.
 
-By default the matcher verify the number of object allocations. You can also check for memory allocation using the `bytes` matcher.
+By default the matcher verifies the number of object allocations. The specified number serves as the _upper limit_ of allocations, so your tests won't become brittle as different Ruby versions change internally how many objects are allocated for some operations.
+
+Note that you can also check for memory allocation using the `bytes` matcher.
 
 To check number of objects allocated do:
 
@@ -356,6 +359,16 @@ RSpec::Benchmark.configure do |config|
 end
 ```
 
+### 3.4 `:format`
+
+The `perform_at_least` matcher uses the `:format` option to format the number of iterations when a failure message gets displayed. By default, the `:human` values is used to make numbers more readable. For example, the `12300 i/s` gets turned into `12.3k i/s`. If you rather have an exact numbers presented do:
+
+```ruby
+RSpec::Benchmark.configure do |config|
+  config.format = :raw
+end
+```
+
 ## 4. Filtering
 
 Usually performance tests are best left for CI or occasional runs that do not affect TDD/BDD cycle.

data/lib/rspec-benchmark.rb

@@ -1 +1 @@
-require_relative 'rspec/benchmark'
+require_relative "rspec/benchmark"

data/lib/rspec/benchmark.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'benchmark/configuration'
-require_relative 'benchmark/matchers'
-require_relative 'benchmark/version'
+require_relative "benchmark/configuration"
+require_relative "benchmark/matchers"
+require_relative "benchmark/version"
 
 module RSpec
   module Benchmark

data/lib/rspec/benchmark/allocation_matcher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'benchmark-malloc'
+require "benchmark-malloc"
 
 module RSpec
   module Benchmark
@@ -31,7 +31,7 @@ module RSpec
         # @api private
         def matches?(block)
           @block = block
-          alloc_stats = @bench.run(&block)
+          alloc_stats = @bench.trace(&block)
           @actual = nil
           @actual_retained = nil
 
@@ -150,10 +150,10 @@ module RSpec
 
         def objects_to_s(value)
           if value.respond_to?(:to_hash)
-            value.
-              sort_by { |k,v| k.to_s }.
-              map { |key, val| "#{val} #{key}" if @objects.keys.include?(key) }.
-              compact.join(" and ")
+            value
+              .sort_by { |k, v| k.to_s }
+              .map { |key, val| "#{val} #{key}" if @objects.keys.include?(key) }
+              .compact.join(" and ")
           else
             value
           end

data/lib/rspec/benchmark/comparison_matcher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'benchmark-perf'
+require "benchmark-perf"
 
 module RSpec
   module Benchmark
@@ -152,9 +152,9 @@ module RSpec
           return "was not a block" unless @actual.is_a?(Proc)
 
           if @ratio < 1
-            "performed slower by #{format('%.2f', (@ratio**-1))} times"
+            "performed slower by #{format("%.2f", (@ratio**-1))} times"
           elsif @ratio > 1
-            "performed faster by #{format('%.2f', @ratio)} times"
+            "performed faster by #{format("%.2f", @ratio)} times"
           else
             "performed by the same time"
           end
@@ -264,7 +264,7 @@ module RSpec
 
         def check_comparison(type)
           [:slower, :faster].include?(type) ||
-            (raise ArgumentError, 'comparison_type must be ' \
+            (raise ArgumentError, "comparison_type must be " \
                    ":faster or :slower, not `:#{type}`")
         end
       end # Matcher

data/lib/rspec/benchmark/configuration.rb

@@ -28,11 +28,19 @@ module RSpec
       # @api public
       attr_accessor :fit_quality
 
+      # The formatting for number of iterations
+      #
+      # @return [String]
+      #
+      # @api public
+      attr_accessor :format
+
       # @api private
       def initialize
         @disable_gc  = false
         @samples     = 1
         @fit_quality = 0.9
+        @format      = :human
         @run_in_subprocess = false
       end
     end # Configuration

data/lib/rspec/benchmark/formatter.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Benchmark
+    module Formatter
+      # Format time for easy matcher reporting
+      #
+      # @param [Float] time
+      #   the time to format
+      #
+      # @return [String]
+      #   the human readable time value
+      #
+      # @api public
+      def format_time(time)
+        if time >= 100.0
+          "%.0f sec" % [time]
+        elsif time >= 1.0
+          "%.3g sec" % [time]
+        elsif time >= 1e-3
+          "%.3g ms" % [time * 1e3]
+        elsif time >= 1e-6
+          "%.3g μs" % [time * 1e6]
+        else
+          "%.3g ns" % [time * 1e9]
+        end
+      end
+      module_function :format_time
+
+      UNITS = ([""] + %w[k M B T Q]).freeze
+
+      # Format large numbers and replace thousands with a unit
+      # for increased readability
+      #
+      # @param [Numeric] number
+      #   the number to format
+      #
+      # @return [String]
+      #
+      # @api pubic
+      def format_unit(number)
+        scale = (Math.log10(number) / 3).to_i
+        scale = 0 if scale > 5
+        suffix = UNITS[scale]
+
+        "%.3g#{suffix}" % [number.to_f / (1000 ** scale)]
+      end
+      module_function :format_unit
+    end
+  end # Benchmark
+end # RSpec

data/lib/rspec/benchmark/iteration_matcher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'benchmark-perf'
+require "benchmark-perf"
 
 module RSpec
   module Benchmark
@@ -13,7 +13,18 @@ module RSpec
           @iterations = iterations
           @time       = options.fetch(:time) { 0.2 }
           @warmup     = options.fetch(:warmup) { 0.1 }
-          @bench      = ::Benchmark::Perf::Iteration
+          @format     = options.fetch(:format) {
+                          RSpec::Benchmark.configuration.format }
+          @bench      = ::Benchmark::Perf
+        end
+
+        # Check if human format should be used
+        #
+        # @return [Boolean]
+        #
+        # @api private
+        def human_format?
+          @format == :human
         end
 
         # Indicates this matcher matches against a block
@@ -29,7 +40,7 @@ module RSpec
         #
         # @api private
         def matches?(block)
-          @average, @stddev, = @bench.run(time: @time, warmup: @warmup, &block)
+          @average, @stddev, = @bench.ips(time: @time, warmup: @warmup, &block)
           @iterations <= (@average + 3 * @stddev)
         end
 
@@ -70,11 +81,13 @@ module RSpec
         end
 
         def description
-          "perform at least #{@iterations} i/s"
+          iters = human_format? ? Formatter.format_unit(@iterations) : @iterations
+          "perform at least #{iters} i/s"
         end
 
         def actual
-          "%d (± %d%%) i/s" % [@average, (@stddev / @average.to_f) * 100]
+          avg = human_format? ? Formatter.format_unit(@average) : @average
+          "%s (± %d%%) i/s" % [avg, (@stddev / @average.to_f) * 100]
         end
 
         def positive_failure_reason

data/lib/rspec/benchmark/matchers.rb

@@ -1,10 +1,10 @@
-# frozen_string_literal
+# frozen_string_literal: true
 
-require_relative 'allocation_matcher'
-require_relative 'comparison_matcher'
-require_relative 'complexity_matcher'
-require_relative 'iteration_matcher'
-require_relative 'timing_matcher'
+require_relative "allocation_matcher"
+require_relative "comparison_matcher"
+require_relative "complexity_matcher"
+require_relative "iteration_matcher"
+require_relative "timing_matcher"
 
 module RSpec
   module Benchmark
@@ -35,7 +35,7 @@ module RSpec
       #
       # @api public
       def perform_allocation(objects, **options)
-        AllocationMatcher::Matcher.new(objects, options)
+        AllocationMatcher::Matcher.new(objects, **options)
       end
 
       # Passes if code block performs at least iterations
@@ -48,7 +48,7 @@ module RSpec
       #
       # @api public
       def perform_at_least(iterations, **options)
-        IterationMatcher::Matcher.new(iterations, options)
+        IterationMatcher::Matcher.new(iterations, **options)
       end
 
       # Passes if code block performs under threshold
@@ -62,7 +62,7 @@ module RSpec
       #
       # @api public
       def perform_under(threshold, **options)
-        TimingMatcher::Matcher.new(threshold, options)
+        TimingMatcher::Matcher.new(threshold, **options)
       end
 
       # Passes if code block performs faster than sample block
@@ -75,7 +75,7 @@ module RSpec
       #
       # @api public
       def perform_faster_than(**options, &sample)
-        ComparisonMatcher::Matcher.new(sample, :faster, options)
+        ComparisonMatcher::Matcher.new(sample, :faster, **options)
       end
 
       # Passes if code block performs slower than sample block
@@ -88,7 +88,7 @@ module RSpec
       #
       # @api public
       def perform_slower_than(**options, &sample)
-        ComparisonMatcher::Matcher.new(sample, :slower, options)
+        ComparisonMatcher::Matcher.new(sample, :slower, **options)
       end
 
       # Pass if code block performs constant
@@ -100,7 +100,7 @@ module RSpec
       #
       # @api public
       def perform_constant(**options)
-        ComplexityMatcher::Matcher.new(:constant, options)
+        ComplexityMatcher::Matcher.new(:constant, **options)
       end
 
       # Pass if code block performs logarithmic
@@ -113,7 +113,7 @@ module RSpec
       #
       # @api public
       def perform_logarithmic(**options)
-        ComplexityMatcher::Matcher.new(:logarithmic, options)
+        ComplexityMatcher::Matcher.new(:logarithmic, **options)
       end
       alias perform_log perform_logarithmic
 
@@ -126,7 +126,7 @@ module RSpec
       #
       # @api public
       def perform_linear(**options)
-        ComplexityMatcher::Matcher.new(:linear, options)
+        ComplexityMatcher::Matcher.new(:linear, **options)
       end
 
       # Pass if code block performs power
@@ -138,7 +138,7 @@ module RSpec
       #
       # @api public
       def perform_power(**options)
-        ComplexityMatcher::Matcher.new(:power, options)
+        ComplexityMatcher::Matcher.new(:power, **options)
       end
 
       # Pass if code block performs exponential
@@ -150,7 +150,7 @@ module RSpec
       #
       # @api public
       def perform_exponential(**options)
-        ComplexityMatcher::Matcher.new(:exponential, options)
+        ComplexityMatcher::Matcher.new(:exponential, **options)
       end
       alias perform_exp perform_exponential
 

data/lib/rspec/benchmark/timing_matcher.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'benchmark-perf'
+require "benchmark-perf"
 
-require_relative 'format_time'
+require_relative "formatter"
 
 module RSpec
   module Benchmark
@@ -18,13 +18,15 @@ module RSpec
         def initialize(threshold, **options)
           @threshold = threshold
           @samples   = options.fetch(:samples) {
-                         RSpec::Benchmark.configuration.samples }
+                         RSpec::Benchmark.configuration.samples
+                       }
           @warmup    = options.fetch(:warmup) { 1 }
           @subprocess = options.fetch(:subprocess) {
-                          RSpec::Benchmark.configuration.run_in_subprocess }
+                          RSpec::Benchmark.configuration.run_in_subprocess
+                        }
           @scale     = threshold.to_s.split(/\./).last.size
           @block     = nil
-          @bench     = ::Benchmark::Perf::ExecutionTime
+          @bench     = ::Benchmark::Perf
         end
 
         # Indicates this matcher matches against a block
@@ -42,10 +44,8 @@ module RSpec
         def matches?(block)
           @block = block
           return false unless block.is_a?(Proc)
-          @average, @stddev = @bench.run(repeat: @samples,
-                                         warmup: @warmup,
-                                         subprocess: @subprocess,
-                                         &block)
+          @average, @stddev = @bench.cpu(repeat: @samples, warmup: @warmup,
+                                         subprocess: @subprocess, &block)
           @average <= @threshold
         end
 
@@ -116,20 +116,20 @@ module RSpec
         end
 
         def description
-          "perform under #{format_time(@threshold)}"
+          "perform under #{Formatter.format_time(@threshold)}"
         end
 
         def actual
-          "#{format_time(@average)} (± #{format_time(@stddev)})"
+          "#{Formatter.format_time(@average)} (± #{Formatter.format_time(@stddev)})"
         end
 
         def positive_failure_reason
-          return 'was not a block' unless @block.is_a?(Proc)
+          return "was not a block" unless @block.is_a?(Proc)
           "performed above #{actual} "
         end
 
         def negative_failure_reason
-          return 'was not a block' unless @block.is_a?(Proc)
+          return "was not a block" unless @block.is_a?(Proc)
           "performed #{actual} under"
         end
       end # Matcher