pry-auto_benching.rb 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c018cd4eeb0e2b222b7c8ecee196e667d1189a4e22700ff60c2f73e831550fcd
-  data.tar.gz: bac2c715f28098373093d0c358dc5ed1cea4113a73bbb6ce2468d0742310bf8f
+  metadata.gz: 045cf80b47b7e90cd9b0ce925106b37e9280ca87ef74f603a264cfa442718b19
+  data.tar.gz: ebaf1241f1974405a91b6e2255561c43ff0b9401083eb6eccbff6c92769cf486
 SHA512:
-  metadata.gz: aeedf31e5c738006c01766b53dffabeec79cfb5e1723f1db2217337081b4006f7fbf622272db1b8df69382bcc908ead3a260c580bbb46fff9667193ab5eb2293
-  data.tar.gz: 58629e77f790a806a60b4febb8bf1f34627f618a5a9770a360a3507a63ee79669b2dc5e6650a02d28623c9012b20d3a31ff76b080814a09d8b37de20bcb3957e
+  metadata.gz: 126752554d260b8e977e86478aad4d8b251598762e9a4ab74fbbe7ee6d0f5f9bb22e76817c71b91e2605aec5067c5f26de2ed5c52fd880b87a2838210f6e683c
+  data.tar.gz: e5c63c874fb755a6f1f63f2e041ac6c80bb1cb94dc991133e2e61bb0aae584aaa24530f3819a980420c995ff79d6518961ea7864de66dc854251874459a992c2

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## v3.1.0
+
+* Align the index, duration, and line of input in the output of
+ `auto-benching --past`.
+
+* Improve `auto-benching --past` by modifying its output.  
+
+* Fix a typo shown when choosing an invalid target display.
+
 ## v3.0.0
 
 * Remove `:output` as a target display, and the related code that supported    

data/README.md

@@ -97,11 +97,12 @@ __3.__
 
 `auto-benching --past` shows past benchmark results:
 
-    [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)
+    [1] 1.30s (main)> auto-benching -past
+     1 0.01 sleep 0.01
+     2 0.02 sleep 0.02
+     3 0.03 sleep 0.03
+     4 1.30 sleep 1.3
+     5 1.40 Net::HTTP.get_response(URI.parse('https://github.com'))
     [2] pry(main)>
 
 __4.__

data/lib/pry-auto_benching.rb

@@ -1,50 +1,9 @@
 module Pry::AutoBenching
   require 'pry'
   require 'pry-auto_benching/version'
+  require 'pry-auto_benching/moment_list'
   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.shift if @ary.size + 1 > max_size
-      @ary << other
-    end
-
-    def max_size
-      @pry.config.auto_benching.max_history_size
-    end
-  end
-
   #
   # @api private
   #
@@ -53,21 +12,6 @@ module Pry::AutoBenching
     attr_accessor :duration
   end
 
-  write_duration = -> (pry, duration) {
-    auto_benching = pry.config.auto_benching
-    target_display = auto_benching.target_display.to_s
-    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 == 'none'
-      # no op
-    else
-      pry.output.warn "_pry_.config.auto_benching.target_display has an invalid value " \
-                      "(#{auto_benching.target_display.inspect}). \n" \
-                      "It should be equal to ':output', ':prompt' or ':none'"
-    end
-  }
-
   @moments = Hash.new do |h, pry|
     h[pry.hash] = MomentList.new(pry)
   end
@@ -81,10 +25,10 @@ module Pry::AutoBenching
   @after_eval = ->(_, pry) do
     auto_benching = pry.config.auto_benching
     moment = @moments[pry.hash][-1]
-    moment.duration = (sprintf "%.2f", Process.clock_gettime(auto_benching.clock_type) - moment.start_timestamp).to_f
+    moment.duration = 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)
+      write_duration(pry, moment.duration)
     else
       @moments[pry.hash].pop
       pry.config.forget(:prompt_name)
@@ -140,6 +84,34 @@ module Pry::AutoBenching
     @moments
   end
 
+  #
+  # @api private
+  #
+  def self.write_duration(pry, duration)
+    auto_benching = pry.config.auto_benching
+    target = auto_benching.target_display.to_s
+    pry.config.forget(:prompt_name)
+    if target == 'prompt'
+      pry.config.prompt_name = Pry::Helpers::Text.send auto_benching.prompt_color,
+                                                       format_duration(duration)
+    elsif target == 'none'
+      # no op
+    else
+      pry.output.warn "_pry_.config.auto_benching.target_display has an invalid value: \n" \
+                      "#{auto_benching.target_display.inspect}\n" \
+                      "Valid values are: " \
+                      "#{Pry::AutoBenching::PryCommand::VALID_TARGET_DISPLAYS.join(', ')}"
+    end
+  end
+
+  #
+  # @api private
+  #
+  def self.format_duration(float)
+    duration = Kernel.sprintf("%.2f", float).ljust(4)
+    "#{duration}s "
+  end
+
   Pry.configure do |config|
     config.hooks.add_hook :before_session, @before_session.hash, @before_session
     config.auto_benching = Pry::Config.from_hash({
@@ -148,15 +120,7 @@ module Pry::AutoBenching
       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)
-        })
-      }
+      display_duration_if: ->(pry, duration) { duration >= 0.01 }
     })
   end
 end

data/lib/pry-auto_benching/moment_list.rb

@@ -0,0 +1,41 @@
+#
+# MomentList is an Array-like object who cycles its contents
+# when a max size is reached.
+#
+# @api private
+#
+class Pry::AutoBenching::MomentList
+  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.shift if @ary.size + 1 > max_size
+    @ary << other
+  end
+
+  def max_size
+    @pry.config.auto_benching.max_history_size
+  end
+end

data/lib/pry-auto_benching/pry_command.rb

@@ -30,12 +30,9 @@ class Pry::AutoBenching::PryCommand < Pry::ClassCommand
 
   def process(command)
     case
-    when opts.version?
-      page(VERSION_STRING)
-    when opts.present?('target-display')
-      change_target_display(opts[:'target-display'])
-    when opts.present?('past')
-      process_past
+    when opts.version? then page(VERSION_STRING)
+    when opts.present?('target-display') then change_target_display(opts[:'target-display'])
+    when opts.present?('past') then read_past_benchmarks
     else
       if command == 'enable'
         Pry::AutoBenching.enable(_pry_)
@@ -52,16 +49,18 @@ class Pry::AutoBenching::PryCommand < Pry::ClassCommand
 
   private
 
-  def process_past
+  def read_past_benchmarks
     moments = Pry::AutoBenching.moments[_pry_.hash]
     if moments.empty?
       page "No benchmark results are stored for this session."
     else
-      page moments.map.with_index { |moment, i|
-        format "%{index}. %{code} (%{duration})",
-          index: blue(i + 1),
+      page moments.map.with_index {|moment,i|
+        format "%{i} %{duration}%{code}",
+          i: bold(i+1),
           code: moment.input.chomp,
-          duration: bold("#{moment.duration}s")
+          duration: green(
+            Pry::AutoBenching.format_duration(moment.duration).sub('s', '')
+          )
       }.join("\n")
     end
   end
@@ -71,7 +70,7 @@ class Pry::AutoBenching::PryCommand < Pry::ClassCommand
       _pry_.config.auto_benching.target_display = target_display
       page "Display changed to '#{target_display}'"
     else
-      raise Pry::CommandError, "'#{target_display}' is an invalid, " \
+      raise Pry::CommandError, "'#{target_display}' is invalid, " \
                                "valid options are: #{VALID_TARGET_DISPLAYS.join(', ')}"
     end
   end

data/lib/pry-auto_benching/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-auto_benching.rb
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Robert Gleeson
@@ -34,6 +34,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/pry-auto_benching.rb
+- lib/pry-auto_benching/moment_list.rb
 - lib/pry-auto_benching/pry_command.rb
 - lib/pry-auto_benching/version.rb
 - pry-auto_benching.gemspec