benchmark-ips 2.8.4 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 574d0cb84279e02316df55c8d96f396b2a10301b15639ede54198eb278fd6ba2
-  data.tar.gz: d4ddabd9c093fd2c9559870818543d105c6fb2bbf3d38ad397b3bdf0df691397
+  metadata.gz: e6c664c1e49fd7235ba573dc4a5bd92ce7446c0d4206c355a2c7b84320b26d5a
+  data.tar.gz: 72d1502418ff11b5e321825ad5d3d1c44889d170c7da0becbf8b6b9fd7c5f283
 SHA512:
-  metadata.gz: 701868e1d0e33101daaf7e5005245b327dbf3b3d02fb19a8e89eb39563540b5ca5b1ff91c4e3cd4bd9dd54f97537ca48e668608742ee0569a13336818ddfef23
-  data.tar.gz: a032682bd26691ad5d4a837ba956b9acf50e45c69036e07bdda347791f78bf388cb3339873fd6d5ca9cbf6edeec5090c15ae6fa56a712f6d0f0340729ce8e792
+  metadata.gz: '0956333ead3cb5307864b8d013828fff4f8dbec88c27142314d2742ba5378dbf0388f04706bf797cb24d2fd21a38576cdf04892d62664eb418d6cba38e5bfb33'
+  data.tar.gz: 0a953ca0e9270f4eac9c00c51117bc2bfcba6a06e51f3508152b3dcbfd8e03ae4e0cebbf79bc6dc51efcf200e459d9a5ee457d70f371f946e1da8a75c50f7462

data/History.txt

@@ -1,3 +1,14 @@
+=== 2.9.1 / 2021-05-24
+
+* Bug fix
+  * Include all files in gem
+
+=== 2.9.0 / 2021-05-21
+
+* Features
+  * Suite can now be set via an accessor
+  * Default SHARE_URL is now `ips.fastruby.io`, operated by Ombu Labs.
+
 === 2.8.4 / 2020-12-03
 
 * Bug fix
@@ -5,12 +16,12 @@
 
 === 2.8.3 / 2020-08-28
 
-* Bug fix 
+* Bug fix
   * Fixed inaccuracy caused by integer overflows.
 
 === 2.8.2 / 2020-05-04
 
-* Bug fix 
+* Bug fix
   * Fixed problems with Manifest.txt.
   * Empty interim results files are ignored.
 

data/Manifest.txt

@@ -7,7 +7,9 @@ lib/benchmark/compare.rb
 lib/benchmark/ips.rb
 lib/benchmark/ips/job.rb
 lib/benchmark/ips/job/entry.rb
+lib/benchmark/ips/job/noop_report.rb
 lib/benchmark/ips/job/stdout_report.rb
+lib/benchmark/ips/noop_suite.rb
 lib/benchmark/ips/report.rb
 lib/benchmark/ips/share.rb
 lib/benchmark/ips/stats/bootstrap.rb

data/README.md

@@ -186,11 +186,15 @@ end
 
 ### Online sharing
 
-If you want to share quickly your benchmark result with others. Run you benchmark
-with `SHARE=1` argument. I.e.: `SHARE=1 ruby my_benchmark.rb`.
-Result will be sent to [benchmark.fyi](https://benchmark.fyi/) and benchmark-ips
+If you want to quickly share your benchmark result with others, run you benchmark
+with `SHARE=1` argument. For example: `SHARE=1 ruby my_benchmark.rb`.
+
+Result will be sent to [benchmark.fyi](https://ips.fastruby.io/) and benchmark-ips
 will display the link to share the benchmark's result.
 
+If you want to run your own instance of [benchmark.fyi](https://github.com/evanphx/benchmark.fyi)
+and share it to that instance, you can do this: `SHARE_URL=https://ips.example.com ruby my_benchmark.rb`
+
 ### Advanced Statistics
 
 By default, the margin of error shown is plus-minus one standard deviation. If
@@ -227,7 +231,7 @@ Benchmark.ips do |x|
 
   x.stats = :bootstrap
   x.confidence = 95
-  
+
   # confidence is 95% by default, so it can be omitted
 
 end

data/lib/benchmark/ips/job/noop_report.rb

@@ -0,0 +1,27 @@
+module Benchmark
+  module IPS
+    class Job
+      class NoopReport
+        def start_warming
+        end
+
+        def start_running
+        end
+
+        def footer
+        end
+
+        def warming(a, b)
+        end
+
+        def warmup_stats(a, b)
+        end
+
+        def add_report(a, b)
+        end
+
+        alias_method :running, :warming
+      end
+    end
+  end
+end

data/lib/benchmark/ips/job.rb

@@ -51,16 +51,20 @@ module Benchmark
       # @return [Integer]
       attr_accessor :confidence
 
+      # Silence output
+      # @return [Boolean]
+      attr_reader :quiet
+
+      # Suite
+      # @return [Benchmark::IPS::NoopSuite]
+      attr_reader :suite
+
       # Instantiate the Benchmark::IPS::Job.
-      # @option opts [Benchmark::Suite] (nil) :suite Specify Benchmark::Suite.
-      # @option opts [Boolean] (false) :quiet Suppress the printing of information.
       def initialize opts={}
-        @suite = opts[:suite] || nil
-        @stdout = opts[:quiet] ? nil : StdoutReport.new
         @list = []
-        @compare = false
         @run_single = false
         @json_path = false
+        @compare = false
         @held_path = nil
         @held_results = nil
 
@@ -88,6 +92,20 @@ module Benchmark
         @iterations = opts[:iterations] if opts[:iterations]
         @stats = opts[:stats] if opts[:stats]
         @confidence = opts[:confidence] if opts[:confidence]
+        self.quiet = opts[:quiet]
+        self.suite = opts[:suite]
+      end
+
+      def quiet=(val)
+        @stdout = reporter(quiet: val)
+      end
+
+      def suite=(suite)
+        @suite = suite || Benchmark::IPS::NoopSuite.new
+      end
+
+      def reporter(quiet:)
+        quiet ? NoopReport.new : StdoutReport.new
       end
 
       # Return true if job needs to be compared.
@@ -223,19 +241,19 @@ module Benchmark
 
       def run
         if @warmup && @warmup != 0 then
-          @stdout.start_warming if @stdout
+          @stdout.start_warming
           @iterations.times do
             run_warmup
           end
         end
 
-        @stdout.start_running if @stdout
+        @stdout.start_running
 
         @iterations.times do |n|
           run_benchmark
         end
 
-        @stdout.footer if @stdout
+        @stdout.footer
       end
 
       # Run warmup.
@@ -243,8 +261,8 @@ module Benchmark
         @list.each do |item|
           next if run_single? && @held_results && @held_results.key?(item.label)
 
-          @suite.warming item.label, @warmup if @suite
-          @stdout.warming item.label, @warmup if @stdout
+          @suite.warming item.label, @warmup
+          @stdout.warming item.label, @warmup
 
           Timing.clean_env
 
@@ -280,8 +298,8 @@ module Benchmark
             item.call_times cycles
           end
 
-          @stdout.warmup_stats warmup_time_us, @timing[item] if @stdout
-          @suite.warmup_stats warmup_time_us, @timing[item] if @suite
+          @stdout.warmup_stats warmup_time_us, @timing[item]
+          @suite.warmup_stats warmup_time_us, @timing[item]
 
           break if run_single?
         end
@@ -292,8 +310,8 @@ module Benchmark
         @list.each do |item|
           next if run_single? && @held_results && @held_results.key?(item.label)
 
-          @suite.running item.label, @time if @suite
-          @stdout.running item.label, @time if @stdout
+          @suite.running item.label, @time
+          @stdout.running item.label, @time
 
           Timing.clean_env
 
@@ -334,8 +352,8 @@ module Benchmark
             rep.show_total_time!
           end
 
-          @stdout.add_report rep, caller(1).first if @stdout
-          @suite.add_report rep, caller(1).first if @suite
+          @stdout.add_report rep, caller(1).first
+          @suite.add_report rep, caller(1).first
 
           break if run_single?
         end

data/lib/benchmark/ips/noop_suite.rb

@@ -0,0 +1,25 @@
+module Benchmark
+  module IPS
+    class NoopSuite
+      def start_warming
+      end
+
+      def start_running
+      end
+
+      def footer
+      end
+
+      def warming(a, b)
+      end
+
+      def warmup_stats(a, b)
+      end
+
+      def add_report(a, b)
+      end
+
+      alias_method :running, :warming
+    end
+  end
+end

data/lib/benchmark/ips/share.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'net/https'
 require 'json'
@@ -5,7 +7,7 @@ require 'json'
 module Benchmark
   module IPS
     class Share
-      DEFAULT_URL = "https://benchmark.fyi"
+      DEFAULT_URL = "https://ips.fastruby.io"
       def initialize(report, job)
         @report = report
         @job = job

data/lib/benchmark/ips.rb

@@ -5,8 +5,10 @@ require 'benchmark/ips/stats/stats_metric'
 require 'benchmark/ips/stats/sd'
 require 'benchmark/ips/stats/bootstrap'
 require 'benchmark/ips/report'
+require 'benchmark/ips/noop_suite'
 require 'benchmark/ips/job/entry'
 require 'benchmark/ips/job/stdout_report'
+require 'benchmark/ips/job/noop_report'
 require 'benchmark/ips/job'
 
 # Performance benchmarking library
@@ -16,10 +18,10 @@ module Benchmark
   module IPS
 
     # Benchmark-ips Gem version.
-    VERSION = "2.8.4"
+    VERSION = "2.9.1"
 
     # CODENAME of current version.
-    CODENAME = "Tardy Turtle"
+    CODENAME = "Sleepy Sasquatch"
 
     # Measure code in block, each code's benchmarked result will display in
     # iteration per second with standard deviation in given time.
@@ -33,23 +35,14 @@ module Benchmark
         time, warmup, quiet = args
       end
 
-      suite = nil
-
       sync, $stdout.sync = $stdout.sync, true
 
-      if defined? Benchmark::Suite and Suite.current
-        suite = Benchmark::Suite.current
-      end
-
-      quiet ||= (suite && suite.quiet?)
-
-      job = Job.new({:suite => suite,
-                     :quiet => quiet
-      })
+      job = Job.new
 
       job_opts = {}
       job_opts[:time] = time unless time.nil?
       job_opts[:warmup] = warmup unless warmup.nil?
+      job_opts[:quiet] = quiet unless quiet.nil?
 
       job.config job_opts
 

data/test/test_benchmark_ips.rb

@@ -54,6 +54,13 @@ class TestBenchmarkIPS < Minitest::Test
     end
 
     assert $stdout.string.size.zero?
+
+    Benchmark.ips do |x|
+      x.quiet = true
+      x.report("operation") { 100 * 100 }
+    end
+
+    assert $stdout.string.size.zero?
   end
 
   def test_ips
@@ -117,6 +124,21 @@ class TestBenchmarkIPS < Minitest::Test
     assert_equal [:warming, :warmup_stats, :running, :add_report], suite.calls
   end
 
+  def test_ips_config_suite_by_accsr
+    suite = Struct.new(:calls) do
+      def method_missing(method, *args)
+        calls << method
+      end
+    end.new([])
+
+    Benchmark.ips(0.1, 0.1) do |x|
+      x.suite = suite
+      x.report("job") {}
+    end
+
+    assert_equal [:warming, :warmup_stats, :running, :add_report], suite.calls
+  end
+
   def test_ips_defaults
     report = Benchmark.ips do |x|
       x.report("sleep 0.25") { sleep(0.25) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-ips
 version: !ruby/object:Gem::Version
-  version: 2.8.4
+  version: 2.9.1
 platform: ruby
 authors:
 - Evan Phoenix
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -77,7 +77,9 @@ files:
 - lib/benchmark/ips.rb
 - lib/benchmark/ips/job.rb
 - lib/benchmark/ips/job/entry.rb
+- lib/benchmark/ips/job/noop_report.rb
 - lib/benchmark/ips/job/stdout_report.rb
+- lib/benchmark/ips/noop_suite.rb
 - lib/benchmark/ips/report.rb
 - lib/benchmark/ips/share.rb
 - lib/benchmark/ips/stats/bootstrap.rb
@@ -90,7 +92,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/evanphx/benchmark-ips
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--main"
 - README.md
@@ -107,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.2.9
+signing_key: 
 specification_version: 4
 summary: An iterations per second enhancement to Benchmark.
 test_files: []