benchmarked 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 326a4491d743fbd6cdf7ca3a06e86c9bcdd02b37
+  data.tar.gz: 373429695d4f81ebea8308d7c7e2c4d9a0437d96
+SHA512:
+  metadata.gz: ab51daf2d3f0e0f392781c26e59d4dae9450a05eda0d8b05e5e16477faf48f95b4fe60b02efdf30921bc04e7f10bbcaa00ea23ed9a923cc07e9ef4d322fd6f85
+  data.tar.gz: f789ad0f9aa7cb33581276a7f9369cad0cf7d12492486e7b7bf4c1e0f59815d81aaff7e3e5a13375f135c7bd6fb660617df9e5493da79226bdd2e0d076761b25

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/Gemfile.lock
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at santiago@snapsheet.me. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in benchmarked.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Santiago Herrera
+
+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,77 @@
+# Benchmarked
+
+This gem allows you to benchmark the running time of methods in ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'benchmarked'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install benchmarked
+```
+
+Create a notifier in your application
+```ruby
+class BenchmarkedNotifier
+  def self.benchmark_taken(measurement, obj, method_name, args, result)
+    # Log measurement to your logging service
+  end
+end
+```
+- `measurement`: The result of `Benchmark.measure`
+- `obj`: The object that received the `method_name` call
+- `method_name`: The name of the method executed on `obj`
+- `args`: The arguments passed to the method invocation
+- `result`: The return value of the method invocation
+
+
+Configure `Benchmarked` so that it uses the notifier. If you're using `rails`, this would live in `config/initializers/benchmarked.rb`
+```ruby
+Benchmarked.configure do |config|
+  config.notifier = BenchmarkedNotifier
+end
+```
+
+## Usage
+
+Add `handle_with_benchmark` after your method definitions so that every call to them triggers a call to `benchmark_taken` on the notifier configured in `Benchmarked`.
+
+For example, let's say that you have this class:
+```ruby
+class SomeBusinessClass
+  def business_method(arg1)
+    # perform business logic
+  end
+  handle_with_benchmark :business_method
+end
+```
+
+Because `handle_with_benchmark :business_method` is specified, a call like this:
+```ruby
+SomeBusinessClass.new.business_method
+```
+Will trigger a call to `BenchmarkedNotifier.benchmark_taken`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bodyshopbidsdotcom/benchmarked-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Benchmarked project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/benchmarked/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/benchmarked.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'benchmarked/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'benchmarked'
+  spec.version       = Benchmarked::VERSION
+  spec.authors       = ['Santiago Herrera']
+  spec.email         = ['santiago@snapsheet.me']
+
+  spec.summary       = 'Benchmarks methods'
+  spec.homepage      = 'https://github.com/bodyshopbidsdotcom/benchmarked-gem'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'benchmarked'
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/benchmarked.rb

@@ -0,0 +1,32 @@
+require 'benchmarked/version'
+require 'benchmarked/class_methods'
+require 'benchmark'
+
+module Benchmarked
+  class << self
+    attr_writer :notifier
+
+    def configure
+      yield(self)
+    end
+
+    def benchmark_and_notify(obj, method_name, args)
+      result = nil
+
+      if @notifier.nil?
+        result = yield
+      else
+        measurement = Benchmark.measure { result = yield }
+        @notifier.benchmark_taken(measurement, obj, method_name, args, result)
+      end
+
+      result
+    end
+
+    def clean_configuration
+      @notifier = nil
+    end
+  end
+end
+
+Module.send(:include, Benchmarked::ClassMethods)

data/lib/benchmarked/class_methods.rb

@@ -0,0 +1,33 @@
+module Benchmarked
+  module ClassMethods
+    def handle_with_benchmark(method_name)
+      # Inspired by
+      # https://github.com/collectiveidea/delayed_job/blob/73bd1b50e719b336b70fcbb8dc4a37ec9b2f6f35/lib/delayed/message_sending.rb#L34-L62
+      aliased_method_name = method_name.to_s.sub(/([?!=])$/, '')
+      punctuation = $1
+      with = "#{aliased_method_name}_with_benchmark#{punctuation}"
+      without = "#{aliased_method_name}_without_benchmark#{punctuation}"
+
+      define_method(with) do |*args, &block|
+        ret = nil
+
+        Benchmarked.benchmark_and_notify(self, method_name, args) do
+          ret = send(without, *args, &block)
+        end
+
+        ret
+      end
+
+      alias_method without, method_name
+      alias_method method_name, with
+
+      if public_method_defined?(without)
+        public with, method_name
+      elsif protected_method_defined?(without)
+        protected with, method_name
+      elsif private_method_defined?(without)
+        private with, method_name
+      end
+    end
+  end
+end

data/lib/benchmarked/version.rb

@@ -0,0 +1,3 @@
+module Benchmarked
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: benchmarked
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Santiago Herrera
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+description: 
+email:
+- santiago@snapsheet.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmarked.gemspec
+- bin/console
+- bin/setup
+- lib/benchmarked.rb
+- lib/benchmarked/class_methods.rb
+- lib/benchmarked/version.rb
+homepage: https://github.com/bodyshopbidsdotcom/benchmarked-gem
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Benchmarks methods
+test_files: []