pry-measure 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd7ecb4b9be0aa50ba6a782798a7e3ff54f817ef
-  data.tar.gz: 2b502507be3cf9d891545f7bdf091d4846467d87
+  metadata.gz: 959aa87524437b65174dcdf0ff71d8abfee98d84
+  data.tar.gz: ccfb73a9008584d6bb65d0b74a9973e9d7c89a44
 SHA512:
-  metadata.gz: 8605ad7da9656de67b56754d7941359ce38046b7e779f6f4a6c71919f13c1881d7b7686e5c2c40adc7be050dd6cccdd9c9f60a9666273eb8784a0da42cbbd5f5
-  data.tar.gz: 1a97ada99ecb026394c4a9128b795acf467d265b66651cdd069030d0477adc6151f4e502adf4637adc3df6dafd214f25be2415887e07e377498c813f7fc62233
+  metadata.gz: e72bfb2139336dc712f4a0674f4b8dc0ecc6b98b6cf2ad17f92b2f3c483c9b2b103c08dd3d60e5d7c096a7c985faf4d3bc26ab20fdb4f01c6809d89ef9616351
+  data.tar.gz: 6b78f70b00467d499ba4101e647657ace3dde60c23cde7ec89ee3f5dc992135c711276d6626db152b128ccc3245e088ebae9870b08fa4324a88febe86121fbdb

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Version 0.1.0
+
+## 2015.06.13
+
+### New
+
+- Add helper methods (remove pry-realtime command)
+
+### Improvements
+
+- Refactor pry-measure command, eventually will be removed in favor of only using the helper methods.

data/README.md

@@ -14,6 +14,27 @@ or added to the Gemfile:
   gem 'pry-measure'
   ```
 
+## Helper methods
+
+A `pry_measure` helper method is added which takes arguments for number of times to execute and number of times to run (defaults to 1 and 10, respectively):
+
+  ```ruby
+  pry(main)> pry_measure(2, 200000) do
+  pry(main)*   10.times do |time|; 1000*1000*1000*1000; end
+  pry(main)* end
+         user     system      total        real
+     0.230000   0.000000   0.230000 (  0.234847)
+     0.230000   0.000000   0.230000 (  0.228060)
+  => [#<Benchmark::Tms:0x007fd992bd2b30 ...>, #<Benchmark::Tms:0x007fd992bd2220 ...>]
+  ```
+
+Additionally, `time_method` is added:
+
+  ```ruby
+  pry(main)> time_method String, 'new', 'FooBar'
+  Time elapsed 0.004 milliseconds
+  ```
+
 ## Usage
 
   ```bash
@@ -35,5 +56,3 @@ The above passes the interpolated code to [Benchmark.measure](http://www.ruby-do
   pry-realtime #{`curl http://google.com`}
   => 0.6405
   ```
-
-

data/lib/pry-measure.rb

@@ -6,7 +6,9 @@ module PryMeasure
   Commands = Pry::CommandSet.new
 end
 
+require 'benchmark'
+require "pry-measure/marker"
 require "pry-measure/measure_command"
-require "pry-measure/realtime_command"
+require "pry-measure/helper_methods"
 
 Pry.commands.import PryMeasure::Commands

data/lib/pry-measure/helper_methods.rb

@@ -0,0 +1,22 @@
+# Helper methods
+
+# Credit for `time_method`: http://www.skorks.com/2010/03/timing-ruby-code-it-is-easy-with-benchmark/
+
+def time_method(object, method, *args)
+  beginning_time = Time.now
+  object.send(method, *args)
+  end_time = Time.now
+  puts "Time elapsed #{(end_time - beginning_time)*1000} milliseconds"
+end
+
+def pry_measure(test_times = 10, exec_times = 1, &b)
+  Benchmark.bm do |x|
+    test_times.times do
+      x.report do
+        exec_times.times do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/pry-measure/marker.rb

@@ -1,32 +1,13 @@
 module PryMeasure
   class Marker
-    def self.measure(execution_times, arg_string, command, realtime=false, show_output=false, results=[])
-      execution_times.times do
-        results << Benchmark.measure do
-          begin
-            command.interpolate_string arg_string
-          rescue Pry::RescuableException => ex
-            raise Pry::CommandError, ex
+    def self.measure(execution_times, test_times, code)
+      Benchmark.bm do |x|
+        test_times.times do
+          x.report do
+            execution_times.times { Kernel.eval code }
           end
         end
       end
-
-      if show_output == true
-        unless realtime
-          puts "    user     system      total        real"
-        end
-        puts results
-      end
-
-      average = average_results(results, execution_times)
-      realtime ? average[:real] : average
-    end
-
-    def self.average_results(results, execution_times, response={})
-      [:real, :utime, :stime, :total].each do |key|
-        response.merge!(key =>(results.map(&key).inject(&:+) / execution_times.to_i).round(4))
-      end
-      response
     end
   end
-end
+end

data/lib/pry-measure/measure_command.rb

@@ -1,12 +1,17 @@
-require "pry-measure/marker"
-
 PryMeasure::Commands.create_command "pry-measure" do
   description "Measure a block of code using Ruby's benchmark module"
 
+  TEST_TIMES_DESC = 'Times to execute test code (default: 10)'
+  EXEC_TIMES_DESC = 'Times to run benchmark (n times -t)'
+
   banner <<-BANNER
-    Usage: measure [ -t <times> -s ] <block>
+    Usage: pry-measure [ -t <times> -c <times> ] <test code>
 
-    Calls the block for the given amount of times (default 500) and returns benchmark results.
+    -t   #{TEST_TIMES_DESC}
+    -c   #{EXEC_TIMES_DESC}
+
+    Executes the code for the given amount of -t times (or default 10) 
+    and returns benchmark results.
   BANNER
 
   command_options(
@@ -16,26 +21,33 @@ PryMeasure::Commands.create_command "pry-measure" do
   )
 
   def setup
-    @times = 500
+    @test_times = 10
+    @exec_times = 1
   end
 
   def options(opt)
-    opt.on :s, :show, "Shows default benchmark output"
-    opt.on :t, :times, "Times to call block (default: 500)", optional: true, argument: true
+    opt.on :c, :count, EXEC_TIMES_DESC, optional: true, argument: true
+    opt.on :t, :times, TEST_TIMES_DESC, optional: true, argument: true
   end
 
-  def process
-    if opts[:times]
-      @times = opts[:times]
-      raise Pry::CommandError, "-t should be an integer" unless times_is_int?
+  def validate(option)
+    unless is_int?(option)
+      raise Pry::CommandError, "#{option} isn't an integer"
     end
 
-    output = !opts[:show].nil?
+    option.to_i
+  end
+
+  def process
+    @test_times = validate(opts[:count]) if opts[:count]
+    @exec_times = validate(opts[:times]) if opts[:times]
+
+    code = args.join(' ')
 
-    PryMeasure::Marker.measure @times.to_i, arg_string, self, false, output
+    PryMeasure::Marker.measure @exec_times, @test_times, code
   end
 
-  def times_is_int?
-    !!(@times =~ /^[-+]?[0-9]+$/)
+  def is_int?(candidate)
+    !!(candidate =~ /^[-+]?[0-9]+$/)
   end
-end
+end

data/lib/pry-measure/version.rb

@@ -1,3 +1,3 @@
 module PryMeasure
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,71 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: pry-measure
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Matthew Dodds
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2015-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.10
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '10.4'
+description: Provides benchmark helper methods for easier measuring
 email:
 - matthewrusselldodds@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/pry-measure.rb
+- lib/pry-measure/helper_methods.rb
 - lib/pry-measure/marker.rb
 - lib/pry-measure/measure_command.rb
-- lib/pry-measure/realtime_command.rb
 - lib/pry-measure/version.rb
-- lib/pry-measure.rb
-- LICENSE
-- README.md
 homepage: http://github.com/matthewrdodds/pry-measure
 licenses:
 - MIT
@@ -76,17 +77,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Adds simple benchmark tool to pry

data/lib/pry-measure/realtime_command.rb

@@ -1,21 +0,0 @@
-require "pry-measure/marker"
-
-PryMeasure::Commands.create_command "pry-realtime" do
-  description "Measure the execution time of code using Ruby's Benchmark.realtime"
-
-  banner <<-BANNER
-    Usage: pry-realtime <code>
-
-    Evaluates code using Benchmark.realtime
-  BANNER
-
-  command_options(
-    shellwords: false,
-    keep_retval: true,
-    interpolate: false
-  )
-
-  def process
-    PryMeasure::Marker.measure 1, arg_string, self, true
-  end
-end