benchmeth 0.0.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02f90c97b8afdc34db17a600c5927231d4ca14cedb2680041952695789daa14c
+  data.tar.gz: 159e262d33720193f70d30cadb0d4ca6908894e87130ab4faeb70daa70c7b96e
+SHA512:
+  metadata.gz: b9ef7c3f9ade012da933b74ae7da18a696f7a6b9339191970ee43a78e295ee83563410c2e06bf6ea0d6b0b25727ff8fcbc85c9a1fcd9227b2c1325292703ac5e
+  data.tar.gz: c203a49b6235877692c839449d478838f25aaa6525d4f76fed4c22376d40fc674ec4dec720d7121e8883a15be77b2eba971b57cf32d377917556084884dfaa78

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.2.0 (2022-09-06)
+
+- Use monotonic time
+- Dropped support for Ruby < 2.7
+
+## 0.1.1 (2017-03-31)
+
+- Added `use_notifications` option
+
+## 0.1.0 (2011-10-14)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014-2022 Andrew Kane
+
+MIT License
+
+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

@@ -1,73 +1,86 @@
 # Benchmeth
 
-The super easy way to benchmark methods.
+The super easy way to benchmark methods in a live application
 
 ```ruby
-gem "benchmeth"
+class Person
+  def compute
+    # boom
+  end
+  benchmark :compute
+end
 ```
 
-Just say which methods to benchmark and what you'd like to do with the results.
+Works with class methods, too
 
 ```ruby
-def compute
-  puts "CRUNCH!!"
+class Person
+  def self.compute
+    # yolo
+  end
+  class << self
+    benchmark :compute
+  end
 end
+```
 
-benchmeth :compute do |method_name, realtime|
-  puts "%s : %.2f ms" % [method_name, realtime * 1000]
-  # Or log them.
-end
+## Installation
 
-compute
+Add this line to your application’s Gemfile:
 
-# Output:
-# CRUNCH!!
-# compute : 0.09 ms
+```ruby
+gem "benchmeth"
 ```
 
-To call a method without benchmarking, use:
+## How to Use
+
+By default, benchmark data is written to `stdout` in the following format:
 
-```ruby
-compute_without_benchmark
+```
+compute : 1000 ms
 ```
 
-## Instance Methods
+but you can easily do whatever you want with it.
 
 ```ruby
-class Person
+Benchmeth.on_benchmark do |method_name, seconds|
+  puts "#{method_name} took #{seconds} seconds!"
+end
+```
 
-  def work(seconds)
-    puts "Working for #{seconds} seconds"
-    sleep(seconds)
-  end
+To call a method without benchmarking, append `_without_benchmark` to the name.
 
-  def play
-    puts "Time to play!"
-    sleep(rand * 4)
-  end
+## Active Support Notifications
 
-  # This must come after the methods are defined.
-  benchmeth :work, :play do |method_name, realtime|
-    puts "%s : %.2f ms" % [method_name, realtime * 1000]
-  end
+You can switch to Active Support notifications with:
 
-end
+```ruby
+Benchmeth.use_notifications = true
 ```
 
-## Class Methods
+And subscribe with:
 
 ```ruby
-class Person
+ActiveSupport::Notifications.monotonic_subscribe "benchmark.benchmeth" do |*args|
+  event = ActiveSupport::Notifications::Event.new(*args)
+  puts "%s : %d ms" % [event.payload[:name], event.duration]
+end
+```
 
-  def self.count
-    2
-  end
+## Contributing
 
-  class << self
-    benchmeth :count do |method_name, realtime|
-      puts "%s : %.2f ms" % [method_name, realtime * 1000]
-    end
-  end
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
 
-end
+- [Report bugs](https://github.com/ankane/benchmeth/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/benchmeth/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/benchmeth.git
+cd benchmeth
+bundle install
+bundle exec rake test
 ```

data/lib/benchmeth/version.rb

@@ -1,3 +1,3 @@
 module Benchmeth
-  VERSION = "0.0.1"
+  VERSION = "0.2.0"
 end

data/lib/benchmeth.rb

@@ -1,38 +1,70 @@
 require "benchmeth/version"
-require "benchmark"
+
+# :( Global
+$benchmeth_main = self
 
 module Benchmeth
+  class << self
+    attr_accessor :use_notifications, :on_benchmark_block
+  end
+  self.use_notifications = false
+  self.on_benchmark_block = lambda do |method, realtime|
+    puts "%s : %d ms" % [method, realtime * 1000]
+  end
 
-  def self.included(base)
-    base.send :extend, ClassMethods
-    base.send :include, InstanceMethods
+  def self.on_benchmark(&block)
+    if block_given?
+      self.on_benchmark_block = block
+    else
+      self.on_benchmark_block
+    end
   end
 
-  module ClassMethods
+  def self.monotonic_time
+    Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  end
 
-    def benchmeth(*method_names, &block)
+  module ClassMethods
+    def benchmark(*method_names)
       method_names.each do |method_name|
         method_name = method_name.to_sym
-        self.send :alias_method, :"#{method_name}_without_benchmark", method_name
-        self.send :define_method, method_name do |*args|
-          result = nil
-          realtime = Benchmark.realtime { result = self.send(:"#{method_name}_without_benchmark", *args) }
-          block.call(method_name, realtime)
-          result
+        send :alias_method, :"#{method_name}_without_benchmark", method_name
+        send :define_method, method_name do |*args, &block|
+          method_prefix =
+            case self
+            when $benchmeth_main
+              ""
+            when Class
+              "#{name}."
+            else
+              "#{self.class.name}#"
+            end
+
+          if Benchmeth.use_notifications
+            payload = {
+              name: "#{method_prefix}#{method_name}"
+            }
+            ActiveSupport::Notifications.instrument "benchmark.benchmeth", payload do
+              send(:"#{method_name}_without_benchmark", *args, &block)
+            end
+          else
+            start_time = Benchmeth.monotonic_time
+            result = send(:"#{method_name}_without_benchmark", *args, &block)
+            realtime = Benchmeth.monotonic_time - start_time
+            Benchmeth.on_benchmark.call("#{method_prefix}#{method_name}", realtime)
+            result
+          end
         end
       end
     end
-
   end
 
   module InstanceMethods
-
-    def benchmeth(*method_names, &block)
-      self.class.benchmeth(*method_names, &block)
+    def benchmark(*method_names, &block)
+      self.class.benchmark(*method_names, &block)
     end
-
   end
-
 end
 
-Object.send :include, Benchmeth
+Object.extend Benchmeth::ClassMethods
+Object.include Benchmeth::InstanceMethods

metadata

@@ -1,52 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: benchmeth
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-10-14 00:00:00.000000000Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies: []
-description: The super easy way to benchmark methods
-email:
-- andrew@getformidable.com
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
+- CHANGELOG.md
+- LICENSE.txt
 - README.md
-- Rakefile
-- benchmeth.gemspec
 - lib/benchmeth.rb
 - lib/benchmeth/version.rb
 homepage: https://github.com/ankane/benchmeth
-licenses: []
-post_install_message: 
+licenses:
+- MIT
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.10
-signing_key: 
-specification_version: 3
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
 summary: The super easy way to benchmark methods
 test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Gemfile

@@ -1,4 +0,0 @@
-source 'http://rubygems.org'
-
-# Specify your gem's dependencies in benchmeth.gemspec
-gemspec

data/Rakefile

@@ -1,2 +0,0 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"

data/benchmeth.gemspec

@@ -1,17 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/benchmeth/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ["Andrew Kane"]
-  gem.email         = ["andrew@getformidable.com"]
-  gem.description   = %q{The super easy way to benchmark methods}
-  gem.summary       = %q{The super easy way to benchmark methods}
-  gem.homepage      = "https://github.com/ankane/benchmeth"
-
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.name          = "benchmeth"
-  gem.require_paths = ["lib"]
-  gem.version       = Benchmeth::VERSION
-end