benchmark-ips 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10d2721496232fa66554efc54374e96a44bb8b46
-  data.tar.gz: 0eaef49055af4e91846cf61ccd8eafb4c2c779cc
+  metadata.gz: ac378dafa55fa25f223374c352d9fce265a73a1d
+  data.tar.gz: edcbad0a3ed40b69793e18b52b40b4d2d73b72fd
 SHA512:
-  metadata.gz: 5a6eb4ecc46877f3b73836d2b1999b1ed895bc553a5a6baf2470ad3225343b44bc58574eaae6446f3ae658ec383ec7cf61059283df1d08d1cf1395ba64d9895f
-  data.tar.gz: ccf501ab18c3243bcafc36fc891d8d9cb1b083a317f9743ae6863cc0f956cde0c3f01cadd1ad73430a59a17d642acb6be0c25827ad12b398b0677f46b311e375
+  metadata.gz: 427e884910dc92a0e50ceb825ff36770b70c0dcee9088f56d3e090867986f6c8d12d176c7a671d7b964f15c12c2ae6edd4c87b532c6c68bdd351c0508c03fd90
+  data.tar.gz: 3db5f1f4445eb0b2c4985633a197abf58be95f9a2bb01282bda329c2880916e1c25c5cd0ec94b2a17adbdc667e3e8829dd46fa428ef13dc41cf3327136564d89

data/History.txt

@@ -1,3 +1,17 @@
+=== 2.3.0 / 2015-07-20
+
+* 2 minor features:
+  * Support keyword arguments
+  * Allow any datatype for labels (use #to_s conversion)
+
+* 1 doc/test changes:
+  * Newer Travis for 1.8.7, ree, and 2.2.2
+
+* 3 PRs merged:
+  * Merge pull request #41 from kbrock/kwargs-support
+  * Merge pull request #42 from kbrock/newer_travis
+  * Merge pull request #43 from kbrock/non_to_s_labels
+
 === 2.2.0 / 2015-05-09
 
 * 1 minor features:

data/lib/benchmark/compare.rb

@@ -53,7 +53,7 @@ module Benchmark
       end
 
       sorted.each do |report|
-        name = report.label
+        name = report.label.to_s
 
         if iter
           x = (best.ips.to_f / report.ips.to_f)

data/lib/benchmark/ips.rb

@@ -11,17 +11,23 @@ module Benchmark
   module IPS
 
     # Benchmark-ips Gem version.
-    VERSION = "2.2.0"
+    VERSION = "2.3.0"
 
     # CODENAME of current version.
-    CODENAME = "Springtime Hummingbird Dance"
+    CODENAME = "Monsoon BBQ"
 
     # Measure code in block, each code's benchmarked result will display in
     # iteration per second with standard deviation in given time.
     # @param time [Integer] Specify how long should benchmark your code in seconds.
     # @param warmup [Integer] Specify how long should Warmup time run in seconds.
     # @return [Report]
-    def ips(time=nil, warmup=nil, quiet=false)
+    def ips(*args)
+      if args[0].is_a?(Hash)
+        time, warmup, quiet = args[0].values_at(:time, :warmup, :quiet)
+      else
+        time, warmup, quiet = args
+      end
+
       suite = nil
 
       sync, $stdout.sync = $stdout.sync, true

data/lib/benchmark/ips/job.rb

@@ -17,7 +17,7 @@ module Benchmark
         # @param action [String, Proc] Code to be benchmarked.
         # @raise [ArgumentError] Raises when action is not String or not responding to +call+.
         def initialize(label, action)
-          @label = label.to_s
+          @label = label
 
           if action.kind_of? String
             compile action
@@ -41,7 +41,7 @@ module Benchmark
         end
 
         # The label of benchmarking action.
-        # @return [String] Label of action.
+        # @return [#to_s] Label of action.
         attr_reader :label
 
         # The benchmarking action.
@@ -52,10 +52,11 @@ module Benchmark
         # Otherwise add a new line and 20 whitespaces.
         # @return [String] Right justified label.
         def label_rjust
-          if @label.size > 20
-            "#{@label}\n#{' ' * 20}"
+          label = @label.to_s
+          if label.size > 20
+            "#{label}\n#{' ' * 20}"
           else
-            @label.rjust(20)
+            label.rjust(20)
           end
         end
 

data/lib/benchmark/ips/report.rb

@@ -17,7 +17,7 @@ module Benchmark
         # @param [Float] ips_sd Standard deviation of iterations per second.
         # @param [Integer] cycles Number of Cycles.
         def initialize(label, us, iters, ips, ips_sd, cycles)
-          @label = label.to_s
+          @label = label
           @microseconds = us
           @iterations = iters
           @ips = ips
@@ -100,7 +100,7 @@ module Benchmark
         # Return header with padding if +@label+ is < length of 20.
         # @return [String] Right justified header (+@label+).
         def header
-          @label.rjust(20)
+          @label.to_s.rjust(20)
         end
 
         # Return string repesentation of Entry object.
@@ -149,9 +149,9 @@ module Benchmark
       def data
         @data ||= @entries.collect do |entry|
           {
-            name: entry.label,
-            ips: entry.ips,
-            stddev: entry.ips_sd
+            :name => entry.label,
+            :ips =>  entry.ips,
+            :stddev => entry.ips_sd
           }
         end
       end

data/test/test_benchmark_ips.rb

@@ -12,6 +12,14 @@ class TestBenchmarkIPS < Minitest::Test
     $stdout = @old_stdout
   end
 
+  def test_kwargs
+    Benchmark.ips(:time => 1, :warmup => 1, :quiet => false) do |x|
+      x.report("sleep 0.25") { sleep(0.25) }
+    end
+
+    assert $stdout.string.size > 0
+  end
+
   def test_output
     Benchmark.ips(1) do |x|
       x.report("operation") { 100 * 100 }
@@ -26,6 +34,12 @@ class TestBenchmarkIPS < Minitest::Test
     end
 
     assert $stdout.string.size.zero?
+
+    Benchmark.ips(:quiet => true) do |x|
+      x.report("operation") { 100 * 100 }
+    end
+
+    assert $stdout.string.size.zero?
   end
 
   def test_ips
@@ -108,7 +122,7 @@ class TestBenchmarkIPS < Minitest::Test
 
     rep = report.entries.first
 
-    assert_equal "sleep_a_quarter_second", rep.label
+    assert_equal :sleep_a_quarter_second, rep.label
     assert_equal 4*5, rep.iterations
     assert_in_delta 4.0, rep.ips, 0.2
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-ips
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-09 00:00:00.000000000 Z
+date: 2015-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.6'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement