benchmark-ips 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8acfa69c132c3a56ee713ef09c4d2fb1882bf4ab
-  data.tar.gz: 53529931e75cc105984b7a3b546450c7eb0a9f3f
+  metadata.gz: 10d2721496232fa66554efc54374e96a44bb8b46
+  data.tar.gz: 0eaef49055af4e91846cf61ccd8eafb4c2c779cc
 SHA512:
-  metadata.gz: aaef11c1b2f020783fe2b3bc8e7884e3a58849dfa1adcf7b4f28365f07b4ba960acfcb8b44490c8e70479f8328e7a2ac5e39b4fcbe381c52943ad63ff1763115
-  data.tar.gz: 2bfa31d9ea71e9af04a9aae4f72932c3de6a1b87ebaae97e0b0634740a00cdbfaf6fc796aac5793796877f4fb1bffe416cd7c065ac63558992b0e814fcc891c7
+  metadata.gz: 5a6eb4ecc46877f3b73836d2b1999b1ed895bc553a5a6baf2470ad3225343b44bc58574eaae6446f3ae658ec383ec7cf61059283df1d08d1cf1395ba64d9895f
+  data.tar.gz: ccf501ab18c3243bcafc36fc891d8d9cb1b083a317f9743ae6863cc0f956cde0c3f01cadd1ad73430a59a17d642acb6be0c25827ad12b398b0677f46b311e375

data/History.txt

@@ -1,3 +1,27 @@
+=== 2.2.0 / 2015-05-09
+
+* 1 minor features:
+  * Fix quiet mode
+  * Allow passing a custom suite via config
+  * Silent a job if a suite was passed and is quiet
+  * Export report to json file.
+  * Accept symbol as report's argument.
+
+* 2 doc fixes:
+  * Squish duplicate `to` in README
+  * Update copyright to 2015. [ci skip]
+
+* 9 PRs merged:
+  * Merge pull request #37 from splattael/patch-1
+  * Merge pull request #36 from kirs/quiet-mode
+  * Merge pull request #35 from JuanitoFatas/doc/suite
+  * Merge pull request #34 from splattael/config-suite
+  * Merge pull request #33 from splattael/suite-quiet
+  * Merge pull request #32 from O-I/remove-gemfile-lock
+  * Merge pull request #31 from JuanitoFatas/doc/bump-copyright-year
+  * Merge pull request #29 from JuanitoFatas/feature/json-export
+  * Merge pull request #26 from JuanitoFatas/feature/takes-symbol-as-report-parameter
+
 === 2.1.1 / 2015-01-12
 
 * 1 minor fix:

data/README.md

@@ -93,6 +93,49 @@ One benefit to using this method is benchmark-ips automatically determines the
 data points for testing our code, so we can focus on the results instead of
 guessing iteration counts as we do with the traditional Benchmark library.
 
+### Custom Suite
+
+Pass a custom suite to disable garbage collection during benchmark:
+
+```ruby
+require 'benchmark/ips'
+
+# Enable and start GC before each job run. Disable GC afterwards.
+#
+# Inspired by https://www.omniref.com/ruby/2.2.1/symbols/Benchmark/bm?#annotation=4095926&line=182
+class GCSuite
+  def warming(*)
+    run_gc
+  end
+
+  def running(*)
+    run_gc
+  end
+
+  def warmup_stats(*)
+  end
+
+  def add_report(*)
+  end
+
+  private
+
+  def run_gc
+    GC.enable
+    GC.start
+    GC.disable
+  end
+end
+
+suite = GCSuite.new
+
+Benchmark.ips do |x|
+  x.config(:suite => suite)
+  x.report("job1") { ... }
+  x.report("job2") { ... }
+end
+```
+
 ## REQUIREMENTS:
 
 * None!
@@ -114,7 +157,7 @@ and generate the RDoc.
 
 (The MIT License)
 
-Copyright (c) 2012 Evan Phoenix
+Copyright (c) 2015 Evan Phoenix
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -4,6 +4,7 @@ require 'rubygems'
 require 'hoe'
 
 Hoe.plugin :minitest
+Hoe.plugin :git
 
 hoe = Hoe.spec 'benchmark-ips' do
   developer('Evan Phoenix', 'evan@phx.io')

data/lib/benchmark/ips.rb

@@ -11,7 +11,7 @@ module Benchmark
   module IPS
 
     # Benchmark-ips Gem version.
-    VERSION = "2.1.1"
+    VERSION = "2.2.0"
 
     # CODENAME of current version.
     CODENAME = "Springtime Hummingbird Dance"
@@ -21,7 +21,7 @@ module Benchmark
     # @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)
+    def ips(time=nil, warmup=nil, quiet=false)
       suite = nil
 
       sync, $stdout.sync = $stdout.sync, true
@@ -30,7 +30,7 @@ module Benchmark
         suite = Benchmark::Suite.current
       end
 
-      quiet = suite && !suite.quiet?
+      quiet ||= (suite && suite.quiet?)
 
       job = Job.new({:suite => suite,
                      :quiet => quiet
@@ -58,6 +58,10 @@ module Benchmark
         job.run_comparison
       end
 
+      if job.json?
+        job.generate_json
+      end
+
       return job.full_report
     end
 

data/lib/benchmark/ips/job.rb

@@ -13,11 +13,11 @@ module Benchmark
       # Entries in Benchmark Jobs.
       class Entry
         # Instantiate the Benchmark::IPS::Job::Entry.
-        # @param label [String] Label of Benchmarked code.
+        # @param label [#to_s] Label of Benchmarked code.
         # @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
+          @label = label.to_s
 
           if action.kind_of? String
             compile action
@@ -126,6 +126,7 @@ module Benchmark
         @quiet = opts[:quiet] || false
         @list = []
         @compare = false
+        @json_path = false
 
         @timing = {}
         @full_report = Report.new
@@ -141,6 +142,7 @@ module Benchmark
       def config opts
         @warmup = opts[:warmup] if opts[:warmup]
         @time = opts[:time] if opts[:time]
+        @suite = opts[:suite] if opts[:suite]
       end
 
       # Return true if job needs to be compared.
@@ -154,6 +156,18 @@ module Benchmark
         @compare = true
       end
 
+
+      # Return true if job needs to generate json.
+      # @return [Boolean] Need to generate json?
+      def json?
+        !!@json_path
+      end
+
+      # Set @json_path to given path, defaults to "data.json".
+      def json!(path="data.json")
+        @json_path = path
+      end
+
       # Registers the given label and block pair in the job list.
       # @param label [String] Label of benchmarked code.
       # @param str [String] Code to be benchamrked.
@@ -302,6 +316,11 @@ module Benchmark
         @full_report.run_comparison
       end
 
+      # Generate json from +@full_report+.
+      def generate_json
+        @full_report.generate_json @json_path
+      end
+
       # Create report by add entry to +@full_report+.
       # @param item [Benchmark::IPS::Job::Entry] Report item.
       # @param measured_us [Integer] Measured time in microsecond.

data/lib/benchmark/ips/report.rb

@@ -10,14 +10,14 @@ module Benchmark
       # Represents benchmarking code data for Report.
       class Entry
         # Instantiate the Benchmark::IPS::Report::Entry.
-        # @param [String] label Label of entry.
+        # @param [#to_s] label Label of entry.
         # @param [Integer] us Measured time in microsecond.
         # @param [Integer] iters Iterations.
         # @param [Float] ips Iterations per second.
         # @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
+          @label = label.to_s
           @microseconds = us
           @iterations = iters
           @ips = ips
@@ -124,6 +124,7 @@ module Benchmark
       # Instantiate the Report.
       def initialize
         @entries = []
+        @data = nil
       end
 
       # Add entry to report.
@@ -139,10 +140,35 @@ module Benchmark
         @entries.last
       end
 
+      # Entries data in array for generate json.
+      # Each entry is a hash, consists of:
+      #   name:   Entry#label
+      #   ips:    Entry#ips
+      #   stddev: Entry#ips_sd
+      # @return [Array] Array of entries
+      def data
+        @data ||= @entries.collect do |entry|
+          {
+            name: entry.label,
+            ips: entry.ips,
+            stddev: entry.ips_sd
+          }
+        end
+      end
+
       # Run comparison of entries.
       def run_comparison
         Benchmark.compare(*@entries)
       end
+
+      # Generate json from Report#data to given path.
+      # @param path [String] path to generate json.
+      def generate_json(path)
+        File.open path, "w" do |f|
+          require "json"
+          f.write JSON.pretty_generate(data)
+        end
+      end
     end
   end
 end

data/test/test_benchmark_ips.rb

@@ -12,6 +12,22 @@ class TestBenchmarkIPS < Minitest::Test
     $stdout = @old_stdout
   end
 
+  def test_output
+    Benchmark.ips(1) do |x|
+      x.report("operation") { 100 * 100 }
+    end
+
+    assert $stdout.string.size > 0
+  end
+
+  def test_quiet
+    Benchmark.ips(1, nil, true) do |x|
+      x.report("operation") { 100 * 100 }
+    end
+
+    assert $stdout.string.size.zero?
+  end
+
   def test_ips
     report = Benchmark.ips do |x|
       x.config(:time => 1, :warmup => 1)
@@ -58,6 +74,21 @@ class TestBenchmarkIPS < Minitest::Test
     assert_in_delta 4.0, rep.ips, 0.2
   end
 
+  def test_ips_config_suite
+    suite = Struct.new(:calls) do
+      def method_missing(method, *args)
+        calls << method
+      end
+    end.new([])
+
+    Benchmark.ips(0.1, 0.1) do |x|
+      x.config(: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) }
@@ -69,4 +100,48 @@ class TestBenchmarkIPS < Minitest::Test
     assert_equal 4*5, rep.iterations
     assert_in_delta 4.0, rep.ips, 0.2
   end
+
+  def test_ips_report_using_symbol
+    report = Benchmark.ips do |x|
+      x.report(:sleep_a_quarter_second) { sleep(0.25) }
+    end
+
+    rep = report.entries.first
+
+    assert_equal "sleep_a_quarter_second", rep.label
+    assert_equal 4*5, rep.iterations
+    assert_in_delta 4.0, rep.ips, 0.2
+  end
+
+  def test_ips_default_data
+    report = Benchmark.ips do |x|
+      x.report("sleep 0.25") { sleep(0.25) }
+    end
+
+    all_data = report.data
+
+    assert all_data
+    assert_equal "sleep 0.25", all_data[0][:name]
+    assert all_data[0][:ips]
+    assert all_data[0][:stddev]
+  end
+
+  def test_json_output
+    json_file = Tempfile.new("data.json")
+
+    Benchmark.ips do |x|
+      x.report("sleep 0.25") { sleep(0.25) }
+      x.json! json_file.path
+    end
+
+    json_data = json_file.read
+    assert json_data
+
+    data = JSON.parse json_data
+    assert data
+    assert_equal 1, data.size
+    assert_equal "sleep 0.25", data[0]["name"]
+    assert data[0]["ips"]
+    assert data[0]["stddev"]
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark-ips
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2015-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.5'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -100,5 +100,4 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A iterations per second enhancement to Benchmark.
-test_files:
-- test/test_benchmark_ips.rb
+test_files: []