pry-auto_benching.rb 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ebc6bc90dcaae0756aca8ffe6156a7a51080df77d30c8b8df0d8a36eccb4a64
-  data.tar.gz: 88886722771cff694fa7c1703567a3833b6b0e7ebb89ecd9424881bfdb913157
+  metadata.gz: 237980bf9d213d1a40df42c9fa3b78a7920ad90f6bf0e2115ea7fc27e47a1c7e
+  data.tar.gz: 93206785da40f07e91cead03bd5c75fb90969e65ddce7131ed5f73525fe8c9f3
 SHA512:
-  metadata.gz: c672e7e8572c7f1380ee5dc20cf97b15de73fea7ac4c5739a24c7a92108b5b98c91fcae715bc1ade13cdc41c181e70f93efdec699b094d907ee1c50e2ec61321
-  data.tar.gz: 8154a6a1bf2d71c172839b953b9edce185602dc56806b7587717f15a9460cfdf57c82c723f613826d1b42efdfa7203a645865c37c4fea8f41bbdd155179d7cfb
+  metadata.gz: 5484e2012f9ebb124ae4954022f174fc537ead567a31fd71cc29ce04e2abff6b9b820c5992106434c5e7575be53dab5b6e17b58d0ecf0d6532a6901dab645060
+  data.tar.gz: de3c42d2facb770932b0cbde3d588ef494135d035ae66cbee97329085041e195760394599d8b87a48311ba7ddb21d97189f2a54930d310a0f33b9d6fd4edb8cf

data/README.md

@@ -4,17 +4,17 @@ pry-auto_benching.rb automatically benchmarks input entered into Pry.
 
 ## Configuration (optional)
 
-Configuration isn't required unless you want to change a default.
-To change a default, open `~/.pryrc` and add code along the lines
-of:
+Configuration isn't required unless you want to change a default.<br>
+To change a default, open `~/.pryrc` and add code along the lines of:
 
 ```ruby
 Pry.configure do |config|
   # Start benchmarking as soon as Pry starts? default is true.
   config.auto_benching.enabled = false
 
-  # Benchmark Pry commands? Default is true
-  config.auto_benching.benchmark_commands = false
+  # The max number of previous benchmark results to store in memory,
+  # for use by `auto-benching --past`. The default is 70.
+  config.auto_benching.max_history_size = 120
 
   # The type of clock to use, default is Process::CLOCK_MONOTONIC.
   # See https://www.rubydoc.info/stdlib/core/Process:clock_gettime
@@ -47,12 +47,14 @@ __1.__
 
 Show help by running `auto-benching -h`:
 
-    [3] pry(main)> auto-benching -h-h
-    Usage: auto-benching [enable|disable]
+    [11] pry(main)> auto-benching -h
+    Usage: auto-benching [options] [enable|disable]
 
-    Enable or disable benchmarking code and Pry commands.
+    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.
 
 __2.__
@@ -66,7 +68,6 @@ Disable auto benchmarking by running `auto-benching disable`:
 __3.__
 
 An example showing the prompt being updated with benchmark results.
-`_pry_.config.auto_benching.target_display` is set to `:prompt` (the default).
 
     [7] pry(main)> sleep 0.2
     => 0
@@ -92,24 +93,36 @@ An example with `_pry_.config.auto_benching.target_display` set to `:output`.
     pry-auto_benching.rb: 0.31s
     => #<Net::HTTPOK 200 OK readbody=true>
 
+__5.__
+
+Display benchmark results from 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)
+    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)>
+
 ## Accuracy
 
-pry-auto_benching.rb can measure down to a tenth of a millisecond (0.01 represents 10 milliseconds),
-benchmarking `sleep 0.01` shows no overhead in the results:
+pry-auto_benching.rb can measure down to 10 milliseconds (0.01 = 10 milliseconds). <br>
+Benchmarking `sleep 0.01` shows no overhead in the results:
 
     [1] pry(main)> sleep 0.01
     => 0
     [2] 0.01s (main)>
 
-but it is possible results could be reported inaccurately since the measurement
+But it is possible results can be reported inaccurately since the measurement
 includes a **very** small number of method calls to Pry internals. The overhead should be
 minimal and skew results by a margin that could be considered negligible.
 
 ## Integration with custom prompts
 
-If you want a custom prompt to integrate with pry-auto_benching.rb, it's easy, simply use
+If you want a custom prompt to integrate with pry-auto_benching.rb, it's easy, just use
 `pry.config.prompt_name` (by default it is equal to 'pry') somewhere in the prompt and the
-duration of a benchmark will be inserted in its place.
+duration of a benchmark will be inserted in its place, as long as `auto_benching.target_display`
+is set to `:prompt`.
 
 Example:
 

data/lib/pry-auto_benching/pry_command.rb

@@ -5,27 +5,48 @@ Pry::Commands.add_command Class.new(Pry::ClassCommand) {
   group 'pry-auto_benching.rb'
   description 'Enable or disable benchmarking.'
   banner <<-CMDBANNER
-  Usage: auto-benching [enable|disable]
+  Usage: auto-benching [options] [enable|disable]
 
-  Enable or disable benchmarking code and Pry commands.
+  The auto-benching command can enable, disable, and
+  provide other features related to pry-auto_benching.rb
   CMDBANNER
 
   def options(o)
     o.on :v, :version, 'Display version.'
+    o.on :p, :past, 'Display past benchmark results.'
   end
 
   def process(command)
-    if opts.v?
-      return _pry_.output.puts "pry-auto_benching.rb v#{Pry::AutoBenching::VERSION}"
+    case
+    when opts.version?
+      _pry_.output.puts "pry-auto_benching.rb v#{Pry::AutoBenching::VERSION}"
+    when opts.past?
+      process_past
+    else
+      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
-    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.')
+  end
+
+  private
+  def process_past
+    moments = Pry::AutoBenching.moments[_pry_.hash]
+    if moments.empty?
+      _pry_.pager.page "No benchmark results are currently stored for this session."
     else
-      raise Pry::CommandError, "'#{command}' is not implemented by this command, try -h for help."
+      _pry_.pager.page moments.map.with_index { |moment, i|
+        format "%{index}. %{code} (%{duration})",
+          index: blue(i + 1),
+          code: moment.input.chomp,
+          duration: bold("#{moment.duration}s")
+      }.join("\n")
     end
   end
 }

data/lib/pry-auto_benching/version.rb

@@ -1,5 +1,5 @@
 class Pry
   module AutoBenching
-    VERSION = "2.7.0"
+    VERSION = "2.8.0"
   end
 end

data/lib/pry-auto_benching.rb

@@ -1,6 +1,52 @@
 module Pry::AutoBenching
   require 'pry-auto_benching/pry_command'
 
+  #
+  # MomentList is an Array-like object who cycles its contents
+  # when a max size is reached.
+  #
+  # @api private
+  #
+  MomentList = Class.new do
+    include Enumerable
+
+    def initialize(pry)
+      @pry = pry
+      @ary = []
+    end
+
+    def each
+      @ary.each do |moment|
+        yield moment
+      end
+    end
+
+    def [](index)
+      @ary[index]
+    end
+
+    def pop
+      @ary.pop
+    end
+
+    def empty?
+      @ary.empty?
+    end
+
+    def <<(other)
+      @ary.pop while @ary.size >= @pry.config.auto_benching.max_history_size
+      @ary << other
+    end
+  end
+
+  #
+  # @api private
+  #
+  Moment = Struct.new(:start_timestamp) do
+    attr_accessor :input
+    attr_accessor :duration
+  end
+
   write_duration = -> (pry, duration) {
     auto_benching = pry.config.auto_benching
     if auto_benching.target_display == :prompt
@@ -16,64 +62,95 @@ module Pry::AutoBenching
     end
   }
 
-  MEMORY = Hash.new{|h,k| h[k] = [] }
+  @moments = Hash.new do |h, pry|
+    h[pry.hash] = MomentList.new(pry)
+  end
 
-  BEFORE_EVAL = ->(_, pry) do
+  @before_eval = ->(_, pry) do
     clock_type = pry.config.auto_benching.clock_type
-    MEMORY[pry.hash].push Process.clock_gettime(clock_type)
+    k = @moments.key?(pry.hash) ? pry.hash : pry
+    @moments[k] << Moment.new(Process.clock_gettime(clock_type))
   end
 
-  AFTER_EVAL = ->(input, pry) do
+  @after_eval = ->(_, pry) do
     auto_benching = pry.config.auto_benching
-    duration = (sprintf "%.2f", Process.clock_gettime(auto_benching.clock_type) - MEMORY[pry.hash].pop).to_f
-    if (input != nil or auto_benching.benchmark_commands) and auto_benching.display_duration_if.call(pry, duration)
-      write_duration.call(pry, duration)
+    moment = @moments[pry.hash][-1]
+    moment.duration = (sprintf "%.2f", Process.clock_gettime(auto_benching.clock_type) - moment.start_timestamp).to_f
+    if auto_benching.display_duration_if.call(pry, moment.duration)
+      moment.input = pry.input_ring.to_a[-1]
+      write_duration.call(pry, moment.duration)
     else
+      @moments[pry.hash].pop
       pry.config.forget(:prompt_name)
     end
   end
 
-  BEFORE_SESSION = ->(_,_, pry) do
+  @before_session = ->(_, _, pry) do
     Pry::AutoBenching.enable(pry) if pry.config.auto_benching.enabled
   end
 
-  AFTER_SESSION = ->(_, _, pry) do
-    MEMORY.delete(pry.hash)
+  @after_session = ->(_, _, pry) do
+    @moments.delete(pry.hash)
   end
 
+  #
+  # Enables benchmarking for the param `pry`.
+  #
+  # @param [Pry] pry
+  #   An instance of Pry.
+  #
+  # @return [void]
+  #
   def self.enable(pry)
-    if not pry.config.hooks.hook_exists? :before_eval, BEFORE_EVAL.hash
-      pry.config.hooks.add_hook :before_eval, BEFORE_EVAL.hash, BEFORE_EVAL
-      pry.config.hooks.add_hook :after_eval,  AFTER_EVAL.hash , AFTER_EVAL
-      pry.config.hooks.add_hook :after_session, AFTER_SESSION.hash , AFTER_SESSION
+    if not pry.config.hooks.hook_exists? :before_eval, @before_eval.hash
+      pry.config.hooks.add_hook :before_eval, @before_eval.hash, @before_eval
+      pry.config.hooks.add_hook :after_eval,  @after_eval.hash , @after_eval
+      pry.config.hooks.add_hook :after_session, @after_session.hash , @after_session
     end
   end
 
+  #
+  # Disables benchmarking for the param `pry`.
+  #
+  # @param [Pry] pry
+  #   An instance of Pry.
+  #
+  # @return [void]
+  #
   def self.disable(pry)
-    pry.config.hooks.delete_hook :before_eval, BEFORE_EVAL.hash
-    pry.config.hooks.delete_hook :after_eval , AFTER_EVAL.hash
-    pry.config.hooks.delete_hook :after_session , AFTER_SESSION.hash
-    MEMORY[pry.hash].clear
+    pry.config.hooks.delete_hook :before_eval, @before_eval.hash
+    pry.config.hooks.delete_hook :after_eval , @after_eval.hash
+    pry.config.hooks.delete_hook :after_session , @after_session.hash
+    @moments.delete(pry.hash)
   end
-end
 
-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,
-    display_duration_if: ->(pry, duration) { duration >= 0.01 },
-    benchmark_commands: true,
-    output_string: ->(pry, duration) {
-      format("%{TextDesc} %{Duration}s", {
-        :TextDesc => pry.color ?
-                     Pry::Helpers::Text.green("pry-auto_benching.rb:") :
-                     "pry-auto_benching.rb:",
-        :Duration  => sprintf("%.2f", duration)
-      })
-    }
-  })
+  #
+  # @return [Pry::AutoBenching::MomentList]
+  #   An Array-like object.
+  #
+  # @api private
+  #
+  def self.moments
+    @moments
+  end
+
+  Pry.configure do |config|
+    config.hooks.add_hook :before_session, @before_session.hash, @before_session
+    config.auto_benching = Pry::Config.from_hash({
+      max_history_size: 70,
+      enabled: true,
+      target_display: :prompt,
+      prompt_color: :green,
+      clock_type: Process::CLOCK_MONOTONIC,
+      display_duration_if: ->(pry, duration) { duration >= 0.01 },
+      output_string: ->(pry, duration) {
+        format("%{TextDesc} %{Duration}s", {
+          :TextDesc => pry.color ?
+                       Pry::Helpers::Text.green("pry-auto_benching.rb:") :
+                       "pry-auto_benching.rb:",
+          :Duration  => sprintf("%.2f", duration)
+        })
+      }
+    })
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-auto_benching.rb
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Robert Gleeson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-18 00:00:00.000000000 Z
+date: 2018-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry