pry-auto_benching.rb 2.9.1 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13ec7e124f4696f88724706d64bf1a72099ea484aa1b7aa269a381fc84eb1f9f
-  data.tar.gz: b9e3c61b0b99d18686e3ab0c44848a0ab066e73309420a8fb130932e4def3138
+  metadata.gz: 2be7a623c19ec705b54bd6e0f47ebd01861c5d97706e81f116585214217ec64e
+  data.tar.gz: ec602812de40fde4c93f0f10da7eb9c138946dd88e021fd18e9cd142033467de
 SHA512:
-  metadata.gz: 30f653774322435fc6f17758f81dcb25f72d23802beaddf221c2d90caf459af1697f67cfd704df1aee8c35a961290b82295441a353170d9ad026df4b46d192fc
-  data.tar.gz: 7b0a124e1b42c7c81953345b8cad4840774c0426cb796da5716fd00e9b1881c965aadab99cbe678b757dc1100e38f70bc119d4c5d393c9eef863ee299320b64b
+  metadata.gz: 6f621e493069445c89cd78ced4684419d3eaddc42939487793ce32fec8717d8bf41a38da7b860ea46f088068db5af62a71489c24019392ebbc1d8e46a28f5b63
+  data.tar.gz: a394d268ae3eaeb41858fb6d53862167d963978531bf94c5c6f716cb93c036ac3e96b05984800aaa67ee5a0b3cf6e4d7932002a09834f1ec634614cf4d937a56

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v2.10.0
+
+* Add 'none' as a possible target display.
+  When chosen benchmark results are not written to a display but are still
+  recorded and can be viewed on demand by running `auto-benching --past`.
+  
 ## v2.9.1
 
 * Fix a bug where `MomentList` would not cycle oldest entries first.

data/README.md

@@ -1,6 +1,6 @@
 # pry-auto_benching.rb
 
-pry-auto_benching.rb automatically benchmarks input entered into Pry.
+pry-auto_benching.rb automates benchmarking in Pry.
 
 ## Configuration (optional)
 
@@ -20,9 +20,18 @@ Pry.configure do |config|
   # See https://www.rubydoc.info/stdlib/core/Process:clock_gettime
   config.auto_benching.clock_type = Process::CLOCK_REALTIME
 
-  # Configure where benchmark results should be displayed, either
-  # in the prompt or written to `_pry_.output`. Default is :prompt.
-  config.auto_benching.target_display =  ':prompt | :output'
+  # Configure where benchmark results will be displayed.
+  # Valid options are:
+  # * prompt
+  #   The default, results are written to the prompt.
+  #
+  # * output
+  #   Results are written directly to `_pry_.output`
+  #
+  # * none
+  #   Results are not displayed but are still recorded and can be viewed on
+  #   demand by running 'auto-benching --past'.
+  config.auto_benching.target_display =  ':prompt | :output | :none'
 
   # Benchmark results are printed or not depending on the return value
   # of this lambda, by default results are printed when duration >= 0.01.
@@ -54,20 +63,13 @@ Show help by running `auto-benching -h`:
 
         -v, --version             Display version.
         -p, --past                Display past benchmark results.
-        -t, --target-display      Choose the target display for results. Valid options are: stdout, prompt
+        -t, --target-display      Choose the target display for results. Valid options are: stdout, prompt, none
         -h, --help                Show this message.
 
 __2.__
 
-Disable auto benchmarking by running `auto-benching disable`:
-
-    [5] pry(main)> auto-benching disable
-    pry-auto_benching.rb: stopped benchmarking.
-    [6] pry(main)>
-
-__3.__
-
-An example showing the prompt being updated with benchmark results.
+An example showing the prompt being updated with benchmark results. <br>
+This is the default.
 
     [7] pry(main)> sleep 0.2
     => 0
@@ -77,9 +79,9 @@ An example showing the prompt being updated with benchmark results.
     => #<Net::HTTPOK 200 OK readbody=true>
     [10] 1.53s (main)>
 
-__4.__
+__3.__
 
-An example with `:output` set as the `target_display`.
+An example showing `:output` set as the `target_display`.
 
     [6] pry(main)> auto-benching --target-display output
     Display changed to 'output'
@@ -93,9 +95,10 @@ An example with `:output` set as the `target_display`.
     pry-auto_benching.rb: 0.31s
     => #<Net::HTTPOK 200 OK readbody=true>
 
-__5.__
+__4.__
 
-Display a history of benchmark results for the current Pry session using `auto-benching --past`:
+Displaying a history of benchmark results for the current Pry session using
+`auto-benching --past`:
 
     [6] 0.5s (main)> auto-benching --past
     1. Net::HTTP.get_response URI.parse('https://github.com') (0.88s)
@@ -104,6 +107,15 @@ Display a history of benchmark results for the current Pry session using `auto-b
     4. sleep 0.5 (0.5s)
     [7] pry(main)>
 
+__5.__
+
+Disable auto benchmarking for the current Pry session by running
+`auto-benching disable`:
+
+    [5] pry(main)> auto-benching disable
+    pry-auto_benching.rb: stopped benchmarking.
+    [6] pry(main)>
+
 ## Accuracy
 
 pry-auto_benching.rb can measure down to 10 milliseconds (0.01 = 10 milliseconds). <br>
@@ -115,12 +127,12 @@ Benchmarking `sleep 0.01` shows no overhead in the results:
 
 But it is possible results can be reported inaccurately since the measurement
 includes a **very** small number of method calls to Pry internals, and it could
-include time spent by other Pry plugins. I have seen inaccuracies of up to
+include time spent by other Pry plugins as well. I have seen inaccuracies of
 10ms (0.01) but not all the time.
 
-The overhead should be minimal and skew results by a margin that could be considered
-negligible, although other Pry plugins running before/after eval hooks
-and spending a lot of time doing so could skew results more than is expected.
+The overhead could be considered negligible, although other Pry plugins running
+before/after eval hooks and spending a lot of time doing that could skew results
+more than is expected.
 
 ## Integration with custom prompts
 

data/lib/pry-auto_benching/pry_command.rb

@@ -3,7 +3,7 @@ Pry::Commands.add_command Class.new(Pry::ClassCommand) {
   match 'auto-benching'
   command_options argument_required: true
   group 'pry-auto_benching.rb'
-  description 'Enable or disable benchmarking.'
+  description 'For enabling and disabling benchmarking and other related features.'
   banner <<-CMDBANNER
   Usage: auto-benching [options] [enable|disable]
 
@@ -16,14 +16,19 @@ Pry::Commands.add_command Class.new(Pry::ClassCommand) {
     o.on :p, :past, 'Display past benchmark results.'
     o.on :t,
          :'target-display',
-         'Choose the target display for results. Valid options are: stdout, prompt',
+         'Choose the target display for results. Valid options are: stdout, prompt, none',
          argument: :required
   end
 
   def process(command)
     case
     when opts.version?
-      _pry_.output.puts "pry-auto_benching.rb v#{Pry::AutoBenching::VERSION}"
+      page <<-VERSION
+#{bold('pry-auto_benching.rb')} #{bold("v#{Pry::AutoBenching::VERSION}")}
+--
+If you found a bug, have a suggestion or an improvement to make please open an
+issue / pull request at https://github.com/r-obert/pry-auto_benching.rb
+VERSION
     when opts.t?
       change_target_display(opts[:t])
     when opts.past?
@@ -31,10 +36,10 @@ Pry::Commands.add_command Class.new(Pry::ClassCommand) {
     else
       if command == 'enable'
         Pry::AutoBenching.enable(_pry_)
-        _pry_.pager.page('pry-auto_benching.rb: benchmarking.')
+        page('pry-auto_benching.rb: benchmarking.')
       elsif command == 'disable'
         Pry::AutoBenching.disable(_pry_)
-        _pry_.pager.page('pry-auto_benching.rb: stopped benchmarking.')
+        page('pry-auto_benching.rb: stopped benchmarking.')
       else
         raise Pry::CommandError, "'#{command}' is not implemented by this command, try -h for help."
       end
@@ -57,7 +62,7 @@ Pry::Commands.add_command Class.new(Pry::ClassCommand) {
   end
 
   def change_target_display(target_display)
-    if %w(prompt output).include?(target_display)
+    if %w[prompt output none].include?(target_display)
       _pry_.config.auto_benching.target_display = target_display
       page "Display changed to '#{target_display}'"
     else
@@ -68,4 +73,4 @@ Pry::Commands.add_command Class.new(Pry::ClassCommand) {
   def page(str)
     _pry_.pager.page str
   end
-}
+}

data/lib/pry-auto_benching/version.rb

@@ -1,5 +1,5 @@
 class Pry
   module AutoBenching
-    VERSION = "2.9.1"
+    VERSION = "2.10.0"
   end
 end

data/lib/pry-auto_benching.rb

@@ -59,6 +59,8 @@ module Pry::AutoBenching
     elsif target_display == 'output'
       pry.config.forget(:prompt_name)
       pry.pager.page auto_benching.output_string.call(pry, duration)
+    elsif target_display == 'none'
+      pry.config.forget(:prompt_name)
     else
       pry.config.forget(:prompt_name)
       pry.output.warn "_pry_.config.auto_benching.target_display has an invalid value " \

data/pry-auto_benching.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.version = Pry::AutoBenching::VERSION
   spec.authors = ["Robert Gleeson"]
   spec.email = "trebor.g@protonmail.com"
-  spec.summary = "Pry plugin that automatically benchmarks input given to Pry."
+  spec.summary = "Automates benchmarking in Pry"
   spec.description = spec.summary
   spec.homepage = "https://github.com/r-obert/pry-auto_benching.rb"
   spec.licenses = ["MIT"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-auto_benching.rb
 version: !ruby/object:Gem::Version
-  version: 2.9.1
+  version: 2.10.0
 platform: ruby
 authors:
 - Robert Gleeson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-20 00:00:00.000000000 Z
+date: 2018-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
-description: Pry plugin that automatically benchmarks input given to Pry.
+description: Automates benchmarking in Pry
 email: trebor.g@protonmail.com
 executables: []
 extensions: []
@@ -60,5 +60,5 @@ rubyforge_project:
 rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: Pry plugin that automatically benchmarks input given to Pry.
+summary: Automates benchmarking in Pry
 test_files: []