pry-auto_benching.rb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0aefc25f86eed7cb38d19ae6128aa04d84e5318892566a69e6a5650e02f02eb3
+  data.tar.gz: 47aeb7d378f28fa24eb1d6cce8fef5e5ff56c74aaa35b80d654df45631d56538
+SHA512:
+  metadata.gz: 963a145aacc484144627e1f119e571f267505451dd7261c0d7d8fb06c0805cdfda228f63a261ec63cdad98994193d522b7d45a1239ae386a01341cb12cc8bb04
+  data.tar.gz: 3cf40ff58c699a02f7c2cee7c98ae2180dbadc3c7c7b876016d74d0eebdc9d94deb30661945a22d40c6958809d39b970c7c6dcdc3c79e7ee8b4cec4e3e3b37dc

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright 2017
+Robert Gleeson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# pry-auto_benching.rb
+
+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 up `~/.pryrc` and add something like:
+
+```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 false
+  config.auto_benching.benchmark_commands = true
+
+  # The type of clock to use, default is Process::CLOCK_MONOTONIC.
+  # See https://www.rubydoc.info/stdlib/core/Process:clock_gettime
+  config.auto_benching.clock_type = Process::CLOCK_REALTIME
+
+  # Benchmark results are printed depending on the return value
+  # of this lambda, by default results are printed if duration > 0.0.
+  config.auto_benching.speak_if = ->(pry, duration) {
+    duration > 0.5
+  }
+
+  # A lambda for presenting the benchmark results.
+  # Default is: "Benchmark: %.2fs".
+  config.auto_benching.speaker = ->(pry, duration) {
+    pry.pager.page sprintf("Elapsed time: %.2fs", duration)
+  }
+end
+```
+
+## Examples
+
+__1.__
+
+Show help by running `pry-auto_benching -h`:
+
+    [1] pry(main)> pry-auto_benching -h
+    Usage: pry-auto_benching [enable|disable]
+
+    Enable or disable benchmarking of input.
+
+        -h, --help      Show this message.
+
+__2.__
+
+Disable auto benchmarking by running `pry-auto_benching disable`:
+
+    [1] pry(main)> sleep 2
+    pry-auto_benching.rb: 2.00s
+    => 2
+    [2] pry(main)> pry-auto_benching disable
+    pry-auto_benching.rb: stopped benchmarking.
+    [3] pry(main)> sleep 2
+    => 2
+
+__3.__
+
+Last example just shows the benchmark of a method that sleeps for a random
+number of seconds:
+
+    [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
+
+## Install
+
+```ruby
+gem "pry-auto_benching.rb", github: "r-obert/pry-auto_benching.rb"
+```
+
+## License
+
+[MIT](./LICENSE.txt).

data/lib/pry-auto_benching/version.rb

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

data/lib/pry-auto_benching.rb

@@ -0,0 +1,87 @@
+module Pry::AutoBenching
+  MEMORY = Hash.new{|h,k| h[k] = [] }
+
+  BEFORE_EVAL = ->(_, pry) do
+    clock_type = pry.config.auto_benching.clock_type
+    MEMORY[pry.hash].push Process.clock_gettime(clock_type)
+  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)
+    else
+      pry.config.auto_benching.speak_if.call(pry, duration) and
+      pry.config.auto_benching.speaker.call(pry, duration)
+    end
+    MEMORY[pry.hash].clear
+  end
+
+  BEFORE_SESSION = ->(_,_, pry) do
+    Pry::AutoBenching.enable(pry) if pry.config.auto_benching.enabled
+  end
+
+  AFTER_SESSION = ->(_, _, pry) do
+    MEMORY.delete(pry.hash)
+  end
+
+  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
+    end
+  end
+
+  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
+  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]
+
+    Start 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
+    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({
+    enabled: true,
+    clock_type: Process::CLOCK_MONOTONIC,
+    benchmark_commands: false,
+    speak_if: ->(pry, duration) { duration > 0.0 },
+    speaker: ->(pry, duration) {
+      pry.pager.page format("%{AutoBenchingSays} %{WallTime}s", {
+        :AutoBenchingSays => pry.color ?
+                             Pry::Helpers::Text.green("pry-auto_benching.rb:") :
+                             "pry-auto_benching.rb:",
+        :WallTime  => sprintf("%.2f", duration)
+      })
+    }
+  }, nil)
+end

data/pry-auto_benching.gemspec

@@ -0,0 +1,14 @@
+require './lib/pry-auto_benching/version'
+Gem::Specification.new do |spec|
+  spec.name = "pry-auto_benching.rb"
+  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.description = spec.summary
+  spec.homepage = "https://github.com/r-obert/pry-auto_benching.rb"
+  spec.licenses = ["MIT"]
+  spec.require_paths = ["lib"]
+  spec.files = Dir["*.{md,txt,gemspec}", "lib/**/*.rb"]
+  spec.add_runtime_dependency "pry", "~> 0.11"
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: pry-auto_benching.rb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robert Gleeson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Pry plugin for automatically benchmarking input using wall clock time.
+email: trebor.g@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/pry-auto_benching.rb
+- lib/pry-auto_benching/version.rb
+- pry-auto_benching.gemspec
+homepage: https://github.com/r-obert/pry-auto_benching.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Pry plugin for automatically benchmarking input using wall clock time.
+test_files: []