benchmeth 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06caf16f70d677e519ca32bb7c1074fd691435c0
+  data.tar.gz: d2008e32f84b5027d3cccc740928aee6e1fdc333
+SHA512:
+  metadata.gz: a2f7f3bf7f8d966ccb45814e77b8576fe308e96ff5e7b27e2e9de95ab17976a14b8b02631e6ed23673bd51a3a8d80225d33ea08f1ee5e196011f13ec38a26f3b
+  data.tar.gz: 5f686662e3d458cf66e46d4345e2f1f8939755484086611544922c6e66d48373f2039e04b67ea4badb3a019da5616b1ddc8c3c54c1efd74d1a5d7d8bc73e7393

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.1
+
+- Added `use_notifications` option
+
+## 0.1.0
+
+- First release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 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,24 +1,40 @@
 # 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.
+Works with class methods, too
 
 ```ruby
-def compute
-  sleep(1)
+class Person
+  def self.compute
+    # yolo
+  end
+  class << self
+    benchmark :compute
+  end
 end
+```
 
-benchmark :compute
+## Installation
 
-compute
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'benchmeth'
 ```
 
-By default, benchmark data is written to STDOUT
+## How to Use
+
+By default, benchmark data is written to `stdout` in the following format:
 
 ```
 compute : 1000 ms
@@ -27,71 +43,35 @@ compute : 1000 ms
 but you can easily do whatever you want with it.
 
 ```ruby
-Benchmeth.on_benchmark do |method, realtime|
-  logger.info "#{method} took #{realtime} seconds!"
-  # The default is:
-  # puts "%s : %d ms" % [method, realtime * 1000]
+Benchmeth.on_benchmark do |method_name, seconds|
+  puts "#{method_name} took #{seconds} seconds!"
 end
 ```
 
-To call a method without benchmarking, use:
+To call a method without benchmarking, append `_without_benchmark` to the name.
 
-```ruby
-compute_without_benchmark
-```
+## ActiveSupport Notifications
 
-## Instance Methods
+You can switch to ActiveSupport notifications with:
 
 ```ruby
-class Person
-
-  def work(seconds)
-    puts "Working for #{seconds} seconds"
-    sleep(seconds)
-  end
-
-  def play
-    puts "Time to play!"
-    sleep(rand * 4)
-  end
-
-  # This must come after the methods are defined.
-  benchmark :work, :play
-
-end
-
-person = Person.new
-person.work(1)
-person.play
+Benchmeth.use_notifications = true
 ```
 
-Like rdoc, instance methods are denoted with a pound sign (#).
-
-```
-Person#work : 1000 ms
-Person#play : 500 ms
-```
-
-## Class Methods
+And subscribe with:
 
 ```ruby
-class Person
-
-  def self.find(id)
-    puts "Found person #{id}!"
-  end
-
-  class << self
-    benchmark :find
-  end
-
+ActiveSupport::Notifications.subscribe "benchmark.benchmeth" do |*args|
+  event = ActiveSupport::Notifications::Event.new(*args)
+  puts "%s : %d ms" % [event.payload[:name], event.duration]
 end
-
-Person.find(1)
 ```
 
-Like rdoc, class methods are denoted with a dot (.).
+## Contributing
 
-```
-Person.find : 0 ms
-```
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [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

data/Rakefile

@@ -1,2 +1,8 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/benchmeth.gemspec

@@ -1,17 +1,25 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/benchmeth/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "benchmeth/version"
 
-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::Specification.new do |spec|
+  spec.name          = "benchmeth"
+  spec.version       = Benchmeth::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = "The super easy way to benchmark methods"
+  spec.description   = "The super easy way to benchmark methods"
+  spec.homepage      = "https://github.com/ankane/benchmeth"
+  spec.license       = "MIT"
 
-  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
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "activesupport"
 end

data/lib/benchmeth.rb

@@ -1,17 +1,16 @@
 require "benchmeth/version"
-require "benchmark"
 
 # :( Global
 $benchmeth_main = self
 
 module Benchmeth
-  DEFAULT_BLOCK = lambda do |method, realtime|
-    puts "%s : %d ms" % [method, realtime * 1000]
+  class << self
+    attr_accessor :use_notifications
   end
+  self.use_notifications = false
 
-  def self.included(base)
-    base.send :extend, ClassMethods
-    base.send :include, InstanceMethods
+  DEFAULT_BLOCK = lambda do |method, realtime|
+    puts "%s : %d ms" % [method, realtime * 1000]
   end
 
   def self.on_benchmark(&block)
@@ -23,42 +22,46 @@ module Benchmeth
   end
 
   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
-          method_prefix = nil
-          realtime = Benchmark.realtime do
-            result = self.send(:"#{method_name}_without_benchmark", *args)
-            method_prefix =
+        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
-              "#{self.name}."
+              "#{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 = Time.now
+            result = send(:"#{method_name}_without_benchmark", *args, &block)
+            realtime = Time.now - start_time
+            Benchmeth.on_benchmark.call("#{method_prefix}#{method_name}", realtime)
+            result
           end
-          Benchmeth.on_benchmark.call("#{method_prefix}#{method_name}", realtime)
-          result
         end
       end
     end
-
   end
 
   module InstanceMethods
-
     def benchmark(*method_names, &block)
       self.class.benchmark(*method_names, &block)
     end
-
   end
-
 end
 
-Object.send :include, Benchmeth
+Object.extend Benchmeth::ClassMethods
+Object.send :include, Benchmeth::InstanceMethods

data/lib/benchmeth/version.rb

@@ -1,3 +1,3 @@
 module Benchmeth
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/benchmeth_test.rb

@@ -0,0 +1,12 @@
+require_relative "test_helper"
+
+class TestBenchmeth < Minitest::Test
+  def test_instance_method
+    car = Car.new
+    car.boom(60)
+  end
+
+  def test_class_method
+    Car.boom2
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+require "bundler/setup"
+Bundler.require(:default)
+require "minitest/autorun"
+require "minitest/pride"
+require "active_support"
+
+class Car
+  def start(speed)
+    sleep(1)
+  end
+  benchmark :start
+
+  def boom(speed)
+    sleep(1)
+  end
+  benchmark :boom #, payload: -> (speed) { speed * 10000000 }
+
+  def self.boom2
+    sleep(1)
+  end
+  class << self
+    benchmark :boom2
+  end
+end
+
+ActiveSupport::Notifications.subscribe "benchmark.benchmeth" do |*args|
+  event = ActiveSupport::Notifications::Event.new(*args)
+  puts "[AS] %s : %d ms" % [event.payload[:name], event.duration]
+end
+
+# Benchmeth.use_notifications = true

metadata

@@ -1,52 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: benchmeth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-14 00:00:00.000000000Z
-dependencies: []
+date: 2017-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The super easy way to benchmark methods
 email:
-- andrew@getformidable.com
+- andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - benchmeth.gemspec
 - lib/benchmeth.rb
 - lib/benchmeth/version.rb
+- test/benchmeth_test.rb
+- test/test_helper.rb
 homepage: https://github.com/ankane/benchmeth
-licenses: []
+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'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.6.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: The super easy way to benchmark methods
-test_files: []
+test_files:
+- test/benchmeth_test.rb
+- test/test_helper.rb