pry-auto_benching.rb 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 237980bf9d213d1a40df42c9fa3b78a7920ad90f6bf0e2115ea7fc27e47a1c7e
-  data.tar.gz: 93206785da40f07e91cead03bd5c75fb90969e65ddce7131ed5f73525fe8c9f3
+  metadata.gz: '086d0b0371cbbff9c5cb93ac7ef4536fdf3bde5776dd44cd7cb6f0b404866b74'
+  data.tar.gz: 692d1991ab9d61b6c31a7c2fd26135b8fa03cc0a5902b46ef92da88125714ce1
 SHA512:
-  metadata.gz: 5484e2012f9ebb124ae4954022f174fc537ead567a31fd71cc29ce04e2abff6b9b820c5992106434c5e7575be53dab5b6e17b58d0ecf0d6532a6901dab645060
-  data.tar.gz: de3c42d2facb770932b0cbde3d588ef494135d035ae66cbee97329085041e195760394599d8b87a48311ba7ddb21d97189f2a54930d310a0f33b9d6fd4edb8cf
+  metadata.gz: 00d204f115402bd359a66ad6e005c3cb689010c5c9870bc1cdf917ed44888c9eca37c885ffadc0fb0698802bdce01b39f318462b86d6c5484abb7c905502abe8
+  data.tar.gz: f3f2a9461823ce515ce1bd1e3971ffc2d74d2889a4ac0c6daa8f4999b8d8c6df73c41ef87c2da67a27e0e4d7cb12f5f7fa060d604fddccd2918538f3323ffab0

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## v2.9.0
+
+* Add '--target-display' option (shorthand: '-t') to the `auto-benching` command.
+  The option is for changing where benchmark results are written to.
+
+* Accept 'output' and 'prompt' as valid values for `Pry.config.auto_benching.target_display`,
+  in addition to the already accepted values `:output` and `:prompt`.

data/README.md

@@ -47,15 +47,15 @@ __1.__
 
 Show help by running `auto-benching -h`:
 
-    [11] pry(main)> auto-benching -h
     Usage: auto-benching [options] [enable|disable]
 
     The auto-benching command can enable, disable, and
     provide other features related to pry-auto_benching.rb
 
-        -v, --version      Display version.
-        -p, --past         Display past benchmark results.
-        -h, --help         Show this message.
+        -v, --version             Display version.
+        -p, --past                Display past benchmark results.
+        -t, --target-display      Choose the target display for results. Valid options are: stdout, prompt
+        -h, --help                Show this message.
 
 __2.__
 
@@ -79,10 +79,10 @@ An example showing the prompt being updated with benchmark results.
 
 __4.__
 
-An example with `_pry_.config.auto_benching.target_display` set to `:output`.
+An example with `:output` set as the `target_display`.
 
-    [6] pry(main)> _pry_.config.auto_benching.target_display = :output
-    => :output
+    [6] pry(main)> auto-benching --target-display output
+    Display changed to 'output'
     [7] pry(main)> sleep 0.1
     pry-auto_benching.rb: 0.10s
     => 0
@@ -95,7 +95,7 @@ An example with `_pry_.config.auto_benching.target_display` set to `:output`.
 
 __5.__
 
-Display benchmark results from the current Pry session using `auto-benching --past`:
+Display 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)

data/lib/pry-auto_benching/pry_command.rb

@@ -14,12 +14,18 @@ Pry::Commands.add_command Class.new(Pry::ClassCommand) {
   def options(o)
     o.on :v, :version, 'Display version.'
     o.on :p, :past, 'Display past benchmark results.'
+    o.on :t,
+         :'target-display',
+         'Choose the target display for results. Valid options are: stdout, prompt',
+         argument: :required
   end
 
   def process(command)
     case
     when opts.version?
       _pry_.output.puts "pry-auto_benching.rb v#{Pry::AutoBenching::VERSION}"
+    when opts.t?
+      change_target_display(opts[:t])
     when opts.past?
       process_past
     else
@@ -39,9 +45,9 @@ Pry::Commands.add_command Class.new(Pry::ClassCommand) {
   def process_past
     moments = Pry::AutoBenching.moments[_pry_.hash]
     if moments.empty?
-      _pry_.pager.page "No benchmark results are currently stored for this session."
+      page "No benchmark results are currently stored for this session."
     else
-      _pry_.pager.page moments.map.with_index { |moment, i|
+      page moments.map.with_index { |moment, i|
         format "%{index}. %{code} (%{duration})",
           index: blue(i + 1),
           code: moment.input.chomp,
@@ -49,4 +55,17 @@ Pry::Commands.add_command Class.new(Pry::ClassCommand) {
       }.join("\n")
     end
   end
+
+  def change_target_display(target_display)
+    if %w(prompt output).include?(target_display)
+      _pry_.config.auto_benching.target_display = target_display
+      page "Display changed to '#{target_display}'"
+    else
+      raise Pry::CommandError, "'#{target_display}' is an invalid option, valid options are: prompt, output."
+    end
+  end
+
+  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.8.0"
+    VERSION = "2.9.0"
   end
 end

data/lib/pry-auto_benching.rb

@@ -49,9 +49,10 @@ module Pry::AutoBenching
 
   write_duration = -> (pry, duration) {
     auto_benching = pry.config.auto_benching
-    if auto_benching.target_display == :prompt
+    target_display = auto_benching.target_display.to_s
+    if target_display == 'prompt'
       pry.config.prompt_name = "#{Pry::Helpers::Text.send(auto_benching.prompt_color, duration.to_s + 's')} "
-    elsif auto_benching.target_display == :output
+    elsif target_display == 'output'
       pry.config.forget(:prompt_name)
       pry.pager.page auto_benching.output_string.call(pry, duration)
     else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-auto_benching.rb
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Robert Gleeson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-19 00:00:00.000000000 Z
+date: 2018-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -30,6 +30,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/pry-auto_benching.rb