benchmark_methods 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8900e5fcc95812b667857a13ad0e468a52a26c4
+  data.tar.gz: 9ab8178b3e2b04edecf9fc0057eee16625f3af44
+SHA512:
+  metadata.gz: da0d043053fa6e955933984285756a4e8922e6479db9bb975320bfc05fc46d72cfe56cc3cc7481545a8b3047546b313a5ed82dc5acf6c07b5e94abadb23a72a9
+  data.tar.gz: cb49af1a6d976363f058326d40e0d228f8d32bc3765eb456af21e8598a32b93be719388974c9294ea632b1953d6a38ec369996b0dcdaa6a84c564b6da86e95b9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.2"
+  - ruby-head
+
+before_install: "gem install bundler && gem install rspec"
+
+cache: bundler
+
+script: bundle exec rspec
+
+bundler_args: --without development --jobs=3 --retry=3 --path=../vendor/bundle

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in benchmark_methods.gemspec
+gemspec
+
+gem 'pry'
+gem 'rspec'
+gem 'rspec-core'
+gem 'sqlite3'
+gem 'activerecord'
+gem 'simplecov', :require => false, :group => :test

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Igor Kasyanchuk
+
+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,94 @@
+# BenchMarkMethods
+
+Measure and benchmark execution time of your ruby methods. Forgot about `Time.now - t` solution. Use `benchmark` to see how much time it takes to execute your method.
+
+[![Build Status](https://travis-ci.org/igorkasyanchuk/benchmark_methods.svg?branch=master)](https://travis-ci.org/igorkasyanchuk/benchmark_methods)
+
+Sample or usage:
+
+[![Sample](https://raw.githubusercontent.com/igorkasyanchuk/benchmark_methods/master/benchmark_methods.png)](https://raw.githubusercontent.com/igorkasyanchuk/benchmark_methods/master/benchmark_methods.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'benchmark_methods'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install benchmark_methods
+
+
+**Note: works only for Ruby 2+**
+
+## Usage
+
+Let's say you have sample model `User` with two methods:
+
+
+```ruby
+class User < ActiveRecord::Base
+  include BenchmarkMethods
+
+  benchmark :generate_report
+  cbenchmark :import_users
+
+  def generate_report
+    report = reports.create(name: 'My Report')
+    report.add_db_data
+    report.generate
+    report
+  end
+
+  def self.import_users(csv)
+    CSV.parse(csv) do |row|
+      process_import_user(row)
+    end
+  end
+end
+```
+
+**Sample Output:**
+
+```
+  --> User.create_user_and_comments
+      user     system      total        real
+  0.010000   0.000000   0.010000 (  0.006721)
+  --> User create_test_friend
+      user     system      total        real
+  0.000000   0.000000   0.000000 (  0.000681)
+```
+
+Gem allows to **benchmark ruby methods** (instance and class methods).
+
+### Functionality
+
+`include BenchmarkMethods` - put in your classes, models to add support for benchmarks
+
+`benchmark :method_name` - benchmark your insatance method.
+
+`cbenchmark :method_name` - benchmark your class method.
+
+## Plans
+
+* Add more Specs
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/benchmark_methods/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/benchmark_methods.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'benchmark_methods/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "benchmark_methods"
+  spec.version       = BenchmarkMethods::VERSION
+  spec.authors       = ["Igor Kasyanchuk"]
+  spec.email         = ["igorkasyanchuk@gmail.com"]
+
+  spec.summary       = %q{Measure and benchmark execution time of your ruby methods}
+  spec.description   = %q{Measure and benchmark execution time of your ruby methods. Forgot about `Time.now - t` solution. Use `benchmark` to see how much time it take sto execute your method.}
+  spec.homepage      = "https://github.com/igorkasyanchuk/benchmark_methods"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activerecord", "> 0"
+  spec.add_development_dependency "rspec", "> 0"
+  spec.add_development_dependency "pry", "> 0"
+  spec.add_development_dependency "simplecov", "> 0"
+  spec.add_development_dependency 'sqlite3', "> 0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "benchmark_methods"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/benchmark_methods.rb

@@ -0,0 +1,76 @@
+require 'securerandom'
+require 'benchmark'
+require 'benchmark_methods/version'
+
+module BenchmarkMethods
+
+  def self.included(base_klass)
+    base_klass.extend(ClassMethods)
+    interceptor = const_set("#{base_klass.name.demodulize}Interceptor", Module.new)
+    base_klass.send(:prepend, interceptor)
+  end
+
+  def self.log(report)
+    if Object.const_defined?("Rails")
+      Rails.logger.debug("  --> #{report.label}")
+      Rails.logger.debug(Benchmark::CAPTION)
+      Rails.logger.debug(report)
+    else
+      puts("  --> #{report.label}")
+      puts(Benchmark::CAPTION)
+      puts(report)
+    end
+  end
+
+  def self.measure(label, &block)
+    t0, r0 = Process.times, Time.now
+    result = yield
+    t1, r1 = Process.times, Time.now
+    report = Benchmark::Tms.new(t1.utime  - t0.utime,
+                       t1.stime  - t0.stime,
+                       t1.cutime - t0.cutime,
+                       t1.cstime - t0.cstime,
+                       r1 - r0,
+                       label)
+    BenchmarkMethods::log(report)
+    result
+  end
+
+  module ClassMethods
+
+    def cbenchmark(*cmethods)
+      interceptor = const_get("#{name.demodulize}Interceptor")
+      klass = const_get(name)
+      helper = const_set("BenchmarkMethods#{SecureRandom.hex}Helper", Module.new)
+      cmethods.each do |method_name|
+        interceptor.module_eval do
+          helper.send :define_singleton_method, :prepended do |base|
+            define_method(method_name) do |*args, &block|
+              BenchmarkMethods::measure("#{klass}.#{method_name}") do
+                super(*args, &block)
+              end
+            end
+          end
+          (class << klass; self; end).module_eval do
+            prepend(helper)
+          end
+        end
+      end
+    end
+
+    def benchmark(*cmethods)
+      interceptor = const_get("#{name.demodulize}Interceptor")
+      klass = const_get(name)
+      cmethods.each do |method_name|
+        interceptor.module_eval do
+          define_method(method_name) do |*args, &block|
+            BenchmarkMethods::measure("#{klass} #{method_name}") do
+              super(*args, &block)
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/benchmark_methods/version.rb

@@ -0,0 +1,3 @@
+module BenchmarkMethods
+  VERSION = "0.1"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: benchmark_methods
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Igor Kasyanchuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: rspec
+  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: pry
+  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: simplecov
+  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: sqlite3
+  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: Measure and benchmark execution time of your ruby methods. Forgot about
+  `Time.now - t` solution. Use `benchmark` to see how much time it take sto execute
+  your method.
+email:
+- igorkasyanchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark_methods.gemspec
+- benchmark_methods.png
+- bin/console
+- bin/setup
+- lib/benchmark_methods.rb
+- lib/benchmark_methods/version.rb
+homepage: https://github.com/igorkasyanchuk/benchmark_methods
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Measure and benchmark execution time of your ruby methods
+test_files: []