pry-auto_benching.rb 2.10.5 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7b0dc93c3c15661860a761a020191729d6e8f13df4d1c731b61fd1cdfc16fc0
-  data.tar.gz: 1b9f167f1539ef38333f5b8eaeb4f9917669f194cf1269032184349f785ae362
+  metadata.gz: c018cd4eeb0e2b222b7c8ecee196e667d1189a4e22700ff60c2f73e831550fcd
+  data.tar.gz: bac2c715f28098373093d0c358dc5ed1cea4113a73bbb6ce2468d0742310bf8f
 SHA512:
-  metadata.gz: ce5c18e18229ae2869e626aa8fc4365aee3e191a3ca7c83a4491ef9fa0d4c12a714ba43b1dfc6082b5f4f5e231cc420ec915e4b890f0e0a84bd91e81ac79f322
-  data.tar.gz: 43bc389c8483039f6272b9835d8cc6ad8a388682440fd2bc6ac9f33247febcdbb9120d8e70ae9b74ac48b224172dabef0e9e93b4445a0d191f4420876fd45bf7
+  metadata.gz: aeedf31e5c738006c01766b53dffabeec79cfb5e1723f1db2217337081b4006f7fbf622272db1b8df69382bcc908ead3a260c580bbb46fff9667193ab5eb2293
+  data.tar.gz: 58629e77f790a806a60b4febb8bf1f34627f618a5a9770a360a3507a63ee79669b2dc5e6650a02d28623c9012b20d3a31ff76b080814a09d8b37de20bcb3957e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v3.0.0
+
+* Remove `:output` as a target display, and the related code that supported    
+ `:output` as a target display.
+
 ## v2.10.5
 
 * Doc updates

data/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright 2017
+Copyright 2019
 Robert Gleeson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/README.md

@@ -9,18 +9,18 @@
 
 ## <a id='introduction'>Introduction</a>
 
-pry-auto_benching.rb automates benchmarking inside the Pry REPL.
+Automatic benchmarking inside the Pry REPL.
 
 ## <a id='configuration'>Configuration (optional)</a>
 
-Configuration can be skipped unless you want to change the defaults. <br>
+Configuration can be skipped unless you want to change the defaults.  
 To change the defaults, open `~/.pryrc` in your editor of choice and change  
 one or more of the following:  
 
 ```ruby
 Pry.configure do |config|
   #
-  # Start benchmarking as soon as Pry starts?
+  # Start benchmarking when Pry starts?
   # The default is true.
   #
   config.auto_benching.enabled = false
@@ -44,14 +44,11 @@ Pry.configure do |config|
   # * 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'
+  config.auto_benching.target_display =  ':prompt | :none'
 
   #
   # Define a Proc that decides whether or not to record or display benchmark
@@ -64,15 +61,6 @@ Pry.configure do |config|
   # The default is :green.
   #
   config.auto_benching.prompt_color = :red
-
-  #
-  # A lambda that returns a string for display on `_pry_.output` (usually $stdout).
-  # This lambda is used when `target_display` is equal to `:output`.
-  # Default is: "pry-auto_benching.rb: %.2fs".
-  #
-  config.auto_benching.output_string = ->(pry, duration) {
-    sprintf("elapsed time: %.2fs", duration)
-  }
 end
 ```
 
@@ -82,6 +70,7 @@ __1.__
 
 Get started by reading the help menu:
 
+    [1] pry(main)> auto-benching -h
     Usage: auto-benching [options] [enable|disable]
 
     The auto-benching command can enable, disable, and
@@ -89,57 +78,40 @@ Get started by reading the help menu:
 
         -v, --version             Display version.
         -p, --past                Display past benchmark results.
-        -t, --target-display      Choose the target display for results. Valid options are: stdout, prompt, none
+        -t, --target-display      Choose the target display for results. Valid options are: prompt, none
         -h, --help                Show this message.
 
 __2.__
 
-In this example, the prompt is updated with benchmark results.  
-This also happens to be the default behavior.
+The prompt is updated with benchmark results, this happens to be the default:
 
-    [7] pry(main)> sleep 0.2
-    => 0
-    [8] 0.2s (main)> Net::HTTP.get_response URI.parse('https://github.com')
-    => #<Net::HTTPOK 200 OK readbody=true>
-    [9] 1.34s (main)> Net::HTTP.get_response URI.parse('https://www.ruby-lang.org')
-    => #<Net::HTTPOK 200 OK readbody=true>
-    [10] 1.53s (main)>
+    [1] pry(main)> sleep 0.2
+     => 0
+    [2] 0.2s (main)> Net::HTTP.get_response URI.parse('https://github.com')
+     => #<Net::HTTPOK 200 OK readbody=true>
+    [3] 1.34s (main)> Net::HTTP.get_response URI.parse('https://www.ruby-lang.org')
+     => #<Net::HTTPOK 200 OK readbody=true>
+    [4] 1.53s (main)>
 
 __3.__
 
-In this example, `_pry_.output` is updated with benchmark results.
+`auto-benching --past` shows past benchmark results:
 
-    [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
-    [8] pry(main)> Net::HTTP.get_response URI.parse('https://github.com')
-    pry-auto_benching.rb: 0.85s
-    => #<Net::HTTPOK 200 OK readbody=true>
-    [9] pry(main)> Net::HTTP.get_response URI.parse('https://www.ruby-lang.org')
-    pry-auto_benching.rb: 0.31s
-    => #<Net::HTTPOK 200 OK readbody=true>
-
-__4.__
-
-In this example, `auto-benching --past` is used to view past benchmark  
-results.
-
-    [6] 0.5s (main)> auto-benching --past
+    [1] 0.5s (main)> auto-benching --past
     1. Net::HTTP.get_response URI.parse('https://github.com') (0.88s)
     2. Net::HTTP.get_response URI.parse('https://www.youtube.com') (2.18s)
     3. Net::HTTP.get_response URI.parse('https://www.github.com/ruby/ruby') (0.59s)
     4. sleep 0.5 (0.5s)
-    [7] pry(main)>
+    [2] pry(main)>
 
-__5.__
+__4.__
 
-In this example, benchmarking is disabled for the current Pry session:
+Benchmarking can be temporarily disabled then enabled again:
 
-    [5] pry(main)> auto-benching disable
+    [1] pry(main)> auto-benching disable
     pry-auto_benching.rb: stopped benchmarking.
-    [6] pry(main)>
+    [2] pry(main)> auto-benching enable
+    pry-auto_benching.rb: started benchmarking.
 
 ## <a id='accuracy'>Accuracy</a>
 

data/lib/pry-auto_benching/pry_command.rb

@@ -1,5 +1,13 @@
-require 'pry' if not defined?(Pry::ClassCommand)
-Pry::Commands.add_command Class.new(Pry::ClassCommand) {
+class Pry::AutoBenching::PryCommand < Pry::ClassCommand
+  extend Pry::Helpers::Text
+  VALID_TARGET_DISPLAYS = %w[prompt none]
+  VERSION_STRING = <<-VERSION.each_line.map(&:strip).join("\n")
+    #{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
+
   match 'auto-benching'
   command_options argument_required: true
   group 'pry-auto_benching.rb'
@@ -14,24 +22,19 @@ 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, none',
-         argument: :required
+    o.on :t=,
+         :'target-display=',
+         'Choose the target display for results. Valid options are: ' +
+         VALID_TARGET_DISPLAYS.join(', ')
   end
 
   def process(command)
     case
     when opts.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?
+      page(VERSION_STRING)
+    when opts.present?('target-display')
+      change_target_display(opts[:'target-display'])
+    when opts.present?('past')
       process_past
     else
       if command == 'enable'
@@ -41,16 +44,18 @@ VERSION
         Pry::AutoBenching.disable(_pry_)
         page('pry-auto_benching.rb: stopped benchmarking.')
       else
-        raise Pry::CommandError, "'#{command}' is not implemented by this command, try -h for help."
+        raise Pry::CommandError,
+              "'#{command}' is not implemented by this command, add -h for help."
       end
     end
   end
 
   private
+
   def process_past
     moments = Pry::AutoBenching.moments[_pry_.hash]
     if moments.empty?
-      page "No benchmark results are currently stored for this session."
+      page "No benchmark results are stored for this session."
     else
       page moments.map.with_index { |moment, i|
         format "%{index}. %{code} (%{duration})",
@@ -62,15 +67,18 @@ VERSION
   end
 
   def change_target_display(target_display)
-    if %w[prompt output none].include?(target_display)
+    if VALID_TARGET_DISPLAYS.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."
+      raise Pry::CommandError, "'#{target_display}' is an invalid, " \
+                               "valid options are: #{VALID_TARGET_DISPLAYS.join(', ')}"
     end
   end
 
   def page(str)
     _pry_.pager.page str
   end
-}
+
+  Pry.commands.add_command(self)
+end

data/lib/pry-auto_benching/version.rb

@@ -1,5 +1,5 @@
 class Pry
   module AutoBenching
-    VERSION = "2.10.5"
+    VERSION = "3.0.0"
   end
 end

data/lib/pry-auto_benching.rb

@@ -1,4 +1,5 @@
 module Pry::AutoBenching
+  require 'pry'
   require 'pry-auto_benching/version'
   require 'pry-auto_benching/pry_command'
 
@@ -58,8 +59,6 @@ module Pry::AutoBenching
     pry.config.forget(:prompt_name)
     if target_display == 'prompt'
       pry.config.prompt_name = "#{Pry::Helpers::Text.send(auto_benching.prompt_color, duration.to_s + 's')} "
-    elsif target_display == 'output'
-      pry.pager.page auto_benching.output_string.call(pry, duration)
     elsif target_display == 'none'
       # no op
     else

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 = "Automates benchmarking inside the Pry REPL"
+  spec.summary = "Automatic benchmarking inside the Pry REPL"
   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.10.5
+  version: 3.0.0
 platform: ruby
 authors:
 - Robert Gleeson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-25 00:00:00.000000000 Z
+date: 2019-01-15 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: Automates benchmarking inside the Pry REPL
+description: Automatic benchmarking inside the Pry REPL
 email: trebor.g@protonmail.com
 executables: []
 extensions: []
@@ -57,8 +57,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
-summary: Automates benchmarking inside the Pry REPL
+summary: Automatic benchmarking inside the Pry REPL
 test_files: []