pry-auto_benching.rb 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aefc25f86eed7cb38d19ae6128aa04d84e5318892566a69e6a5650e02f02eb3
-  data.tar.gz: 47aeb7d378f28fa24eb1d6cce8fef5e5ff56c74aaa35b80d654df45631d56538
+  metadata.gz: a0612c1d96859e2c9d813bba4572dd26019406bea956909cf56fa3a9c7952b00
+  data.tar.gz: 622b628f5055fc504b97fa12a638a5c8344834d91c25bcbc5e417a85c659f7d8
 SHA512:
-  metadata.gz: 963a145aacc484144627e1f119e571f267505451dd7261c0d7d8fb06c0805cdfda228f63a261ec63cdad98994193d522b7d45a1239ae386a01341cb12cc8bb04
-  data.tar.gz: 3cf40ff58c699a02f7c2cee7c98ae2180dbadc3c7c7b876016d74d0eebdc9d94deb30661945a22d40c6958809d39b970c7c6dcdc3c79e7ee8b4cec4e3e3b37dc
+  metadata.gz: 42a4169779af83587da49fef60cc01e4b3f49425b61e783c1c12b4ad01db4875808a17f2cc93a2280f379648176a7b02e82ae8bef3c38e590a351d17e91ac1de
+  data.tar.gz: 57755f3a2d39f39ca0b585a8ec0283fc63f8d21bedf5904e17853873d7f4e4229229e0642886503e821a805f2ad6333ea621d7398b65ef2ac656899787daf038

data/README.md

@@ -19,14 +19,22 @@ 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 stdout. Default is :prompt.
+  config.auto_benching.target_display =  ':prompt | :stdout'
+
   # Benchmark results are printed depending on the return value
-  # of this lambda, by default results are printed if duration > 0.0.
+  # of this lambda, by default results are printed if duration >= 0.1s
   config.auto_benching.speak_if = ->(pry, duration) {
     duration > 0.5
   }
 
-  # A lambda for presenting the benchmark results.
-  # Default is: "Benchmark: %.2fs".
+  # The color to use for benchmark results when `target_display` is :prompt.
+  # The default is :green.
+  config.auto_benching.prompt_color = :red
+
+  # A lambda for presenting the benchmark results when `target_display`
+  # is :stdout. Default is: "Benchmark: %.2fs".
   config.auto_benching.speaker = ->(pry, duration) {
     pry.pager.page sprintf("Elapsed time: %.2fs", duration)
   }
@@ -37,10 +45,10 @@ end
 
 __1.__
 
-Show help by running `pry-auto_benching -h`:
+Show help by running `auto-benching -h`:
 
-    [1] pry(main)> pry-auto_benching -h
-    Usage: pry-auto_benching [enable|disable]
+    [1] pry(main)> auto-benching -h
+    Usage: auto-benching [enable|disable]
 
     Enable or disable benchmarking of input.
 
@@ -48,34 +56,34 @@ Show help by running `pry-auto_benching -h`:
 
 __2.__
 
-Disable auto benchmarking by running `pry-auto_benching disable`:
+Disable auto benchmarking by running `auto-benching disable`:
 
-    [1] pry(main)> sleep 2
-    pry-auto_benching.rb: 2.00s
-    => 2
-    [2] pry(main)> pry-auto_benching disable
+    [1] pry(main)> auto-benching disable
     pry-auto_benching.rb: stopped benchmarking.
-    [3] pry(main)> sleep 2
+    [2] pry(main)> sleep 2
     => 2
 
 __3.__
 
-Last example just shows the benchmark of a method that sleeps for a random
-number of seconds:
+A screenshot, using `:prompt` as the target_display.
+The prompt name (by default 'pry') is replaced with the benchmark results
+for the previous expression. This is the default since it is subtle, yet
+easy to spot in a sea of output.
+
+![s1](./s1.png)
 
-    [3] pry(main)> def sleep_rand
-    [3] pry(main)*   sleep rand(10)
-    [3] pry(main)* end
-    => :sleep_rand
-    [4] pry(main)> sleep_rand
-    pry-auto_benching.rb: 7.00s
-    => 7
+__4.__
+
+A screenshot, using `:stdout` as the target_display.
+To switch to using this display, run `_pry_.config.auto_benching.target_display = :stdout`
+inside the repl or set `Pry.config.auto_benching.target_display` from  your .pryrc for a
+permanent change.
+
+![s2](./s2.png)
 
 ## Install
 
-```ruby
-gem "pry-auto_benching.rb", github: "r-obert/pry-auto_benching.rb"
-```
+    gem install pry-auto_benching.rb
 
 ## License
 

data/lib/pry-auto_benching/version.rb

@@ -1,5 +1,5 @@
 class Pry
   module AutoBenching
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/lib/pry-auto_benching.rb

@@ -6,17 +6,36 @@ module Pry::AutoBenching
     MEMORY[pry.hash].push Process.clock_gettime(clock_type)
   end
 
+  write_result = ->(pry, duration) {
+    target_display = pry.config.auto_benching.target_display
+    if target_display == :prompt
+      prompt_color = pry.config.auto_benching.prompt_color
+      pry.config.prompt_name = Pry.lazy {
+        "#{Pry::Helpers::Text.send(prompt_color, duration.to_s + 's')} "
+      }
+    elsif target_display == :stdout
+      pry.config.auto_benching.speaker.call(pry, duration)
+    else
+      raise Pry::CommandError, "_pry_.config.auto_benching.target_display has an invalid value (#{target_display})"
+    end
+  }
+
   AFTER_EVAL = ->(input, pry) do
     clock_type = pry.config.auto_benching.clock_type
     duration = (sprintf "%.2f", Process.clock_gettime(clock_type) - MEMORY[pry.hash][-1]).to_f
     if input.nil? # Pry command
-      pry.config.auto_benching.benchmark_commands and
-      pry.config.auto_benching.speak_if.call(pry, duration) and
-      pry.config.auto_benching.speaker.call(pry, duration)
+      if pry.config.auto_benching.benchmark_commands and
+         pry.config.auto_benching.speak_if.call(pry, duration)
+        write_result.(pry, duration)
+      end
     else
-      pry.config.auto_benching.speak_if.call(pry, duration) and
-      pry.config.auto_benching.speaker.call(pry, duration)
+      if pry.config.auto_benching.speak_if.call(pry, duration)
+        write_result.(pry, duration)
+      else
+        pry.config.prompt_name = 'pry'
+      end
     end
+    pry.config.prompt_name = 'pry' if pry.config.auto_benching.target_display != :prompt
     MEMORY[pry.hash].clear
   end
 
@@ -42,45 +61,49 @@ module Pry::AutoBenching
     pry.config.hooks.delete_hook :after_session , AFTER_SESSION.hash
     MEMORY[pry.hash].clear
   end
+end
 
-  require 'pry' if not defined?(Pry::ClassCommand)
-  class AutoBenchingCommand < Pry::ClassCommand
-    match 'pry-auto_benching'
-    command_options argument_required: true
-    group 'pry-auto_benching.rb'
-    description 'Start or disable benchmarking.'
-    banner <<-CMDBANNER
-    Usage: pry-auto_benching [enable|disable]
+require 'pry' if not defined?(Pry::ClassCommand)
+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.'
+  banner <<-CMDBANNER
+  Usage: pry-auto_benching [enable|disable]
 
-    Start or disable benchmarking code (or Pry commands).
-    CMDBANNER
+  Enable or disable benchmarking code (or Pry commands).
+  CMDBANNER
 
-    def process(command)
-      if command == 'enable'
-        Pry::AutoBenching.enable(_pry_)
-        _pry_.pager.page('pry-auto_benching.rb: benchmarking.')
-      elsif command == 'disable'
-        Pry::AutoBenching.disable(_pry_)
-        _pry_.pager.page('pry-auto_benching.rb: stopped benchmarking.')
-      else
-        raise Pry::CommandError, "'#{command}' is not implemented by this command, try -h for help."
-      end
+  def process(command)
+    if command == 'enable'
+      Pry::AutoBenching.enable(_pry_)
+      _pry_.pager.page('pry-auto_benching.rb: benchmarking.')
+    elsif command == 'disable'
+      Pry::AutoBenching.disable(_pry_)
+      _pry_.pager.page('pry-auto_benching.rb: stopped benchmarking.')
+    else
+      raise Pry::CommandError, "'#{command}' is not implemented by this command, try -h for help."
     end
   end
+}
 
-  Pry::Commands.add_command(AutoBenchingCommand)
-  Pry.config.hooks.add_hook :before_session, BEFORE_SESSION.hash, BEFORE_SESSION
-  Pry.config.auto_benching = Pry::Config.from_hash({
+Pry.configure do |config|
+  config.hooks.add_hook :before_session, Pry::AutoBenching::BEFORE_SESSION.hash,
+                                         Pry::AutoBenching::BEFORE_SESSION
+  config.auto_benching = Pry::Config.from_hash({
     enabled: true,
+    target_display: :prompt,
+    prompt_color: :green,
     clock_type: Process::CLOCK_MONOTONIC,
     benchmark_commands: false,
-    speak_if: ->(pry, duration) { duration > 0.0 },
+    speak_if: ->(pry, duration) { duration >= 0.1 },
     speaker: ->(pry, duration) {
-      pry.pager.page format("%{AutoBenchingSays} %{WallTime}s", {
+      pry.pager.page format("%{AutoBenchingSays} %{Duration}s", {
         :AutoBenchingSays => pry.color ?
                              Pry::Helpers::Text.green("pry-auto_benching.rb:") :
                              "pry-auto_benching.rb:",
-        :WallTime  => sprintf("%.2f", duration)
+        :Duration  => sprintf("%.2f", duration)
       })
     }
   }, nil)

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 for automatically benchmarking input using wall clock time."
+  spec.summary = "Pry plugin that automatically benchmarks input given to 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: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Robert Gleeson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2018-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-description: Pry plugin for automatically benchmarking input using wall clock time.
+description: Pry plugin that automatically benchmarks input given to Pry.
 email: trebor.g@protonmail.com
 executables: []
 extensions: []
@@ -58,5 +58,5 @@ rubyforge_project:
 rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: Pry plugin for automatically benchmarking input using wall clock time.
+summary: Pry plugin that automatically benchmarks input given to Pry.
 test_files: []