method_meter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfae0d180c684c345b21ad7c7c7a130ec2af9d5a
+  data.tar.gz: 6844bd7f03f96d13c228fe28d11f5d7b783eeb16
+SHA512:
+  metadata.gz: daaeb86102d7554627447f06d5fff8b076db1cc6be1a79026dc05d454f8c87d829d9d165c56eedf0f78b4ea988a9e9099ffff5bcd74be61674ccafced068c2e7
+  data.tar.gz: f7cddc1da6977de3551e7fc4dd466b6bf5bf0466afcfdc188796b7448413b8bddee97a296eb4ba310f7b5a423b92d8f2888c9d07c967fd91ac384f78349b8133

data/.gitignore

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

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 wilfrido.nuqui@promisepay.com. 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,10 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in method_meter.gemspec
+gemspec
+
+gem 'activesupport'
+gem 'awesome_print'
+gem 'defined_methods'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Wilfrido T. Nuqui Jr.
+
+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,64 @@
+# MethodMeter
+
+`MethodMeter` is a library module that instruments methods defined in a given object. These methods are not from included or extended modules. These methods are not also from parent objects. By object, it means either a `class` or `module`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'method_meter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install method_meter
+
+## Usage
+
+```ruby
+MethodMeter.observe Arithmeter
+
+MethodMeter.measure!('key-1') do
+  arithmeter = Arithmeter.new
+  arithmeter.add 1, 3
+
+  Arithmeter.sum 1, 3
+
+  arithmeter = Arithmeter.new
+  arithmeter.add 4, 3
+
+  Arithmeter.sum 4, 3
+end
+
+ap MethodMeter.data
+ap MethodMeter.measurement
+```
+
+More examples found here: https://github.com/wnuqui/method_meter/tree/master/examples
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/method_meter. 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 MethodMeter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/method_meter/blob/master/CODE_OF_CONDUCT.md).
+
+## Acknowledgement
+
+This library is based from https://github.com/change/method_profiler. This library is a bit more in terms of methods that it can observe. Also how it observe methods is completely different one than that of `method_profiler`. Please feel free to check the details in the code. :-)

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'method_meter'
+
+# 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/examples/1-basic.rb

@@ -0,0 +1,18 @@
+require_relative 'helper'
+
+MethodMeter.observe Arithmeter
+
+MethodMeter.measure!('key-1') do
+  arithmeter = Arithmeter.new
+  arithmeter.add 1, 3
+
+  Arithmeter.sum 1, 3
+
+  arithmeter = Arithmeter.new
+  arithmeter.add 4, 3
+
+  Arithmeter.sum 4, 3
+end
+
+ap MethodMeter.data
+ap MethodMeter.measurement

data/examples/2-serial-measurement-using-keys.rb

@@ -0,0 +1,30 @@
+require_relative 'helper'
+
+MethodMeter.observe Arithmeter
+
+MethodMeter.measure!('key-1') do
+  arithmeter = Arithmeter.new
+  arithmeter.add 1, 3
+
+  Arithmeter.sum 1, 3
+
+  arithmeter = Arithmeter.new
+  arithmeter.add 4, 3
+
+  Arithmeter.sum 4, 3
+end
+
+MethodMeter.measure!('key-2') do
+  arithmeter = Arithmeter.new
+  arithmeter.add 100, 3000
+
+  Arithmeter.sum 100, 3000
+
+  arithmeter = Arithmeter.new
+  arithmeter.add 400, 3000
+
+  Arithmeter.sum 400, 3000
+end
+
+ap MethodMeter.data
+ap MethodMeter.measurement

data/examples/3-observe-multiple-times.rb

@@ -0,0 +1,36 @@
+require_relative 'helper'
+
+MethodMeter.observe Arithmeter
+
+MethodMeter.measure!('key-1') do
+  arithmeter = Arithmeter.new
+  arithmeter.add 1, 3
+
+  Arithmeter.sum 1, 3
+
+  arithmeter = Arithmeter.new
+  arithmeter.add 4, 3
+
+  Arithmeter.sum 4, 3
+end
+
+MethodMeter.observe Arithmeter
+
+MethodMeter.observe Arithmeter
+
+MethodMeter.observe Arithmeter
+
+MethodMeter.measure!('key-2') do
+  arithmeter = Arithmeter.new
+  arithmeter.add 100, 3000
+
+  Arithmeter.sum 100, 3000
+
+  arithmeter = Arithmeter.new
+  arithmeter.add 400, 3000
+
+  Arithmeter.sum 400, 3000
+end
+
+ap MethodMeter.data
+ap MethodMeter.measurement

data/examples/4-more-measurement.rb

@@ -0,0 +1,22 @@
+require_relative 'helper'
+
+MethodMeter.observe Raiser
+
+MethodMeter.measure!('key-1') do
+  Raiser.do 1, 5
+
+  Raiser.do 5, 5
+
+  Raiser.do 5, 500
+end
+
+MethodMeter.measure!('key-2') do
+  Raiser.do 1, 5
+
+  Raiser.do 5, 5
+
+  Raiser.do 5, 500
+end
+
+ap MethodMeter.data
+ap MethodMeter.measurement

data/examples/helper.rb

@@ -0,0 +1,4 @@
+require 'awesome_print'
+require_relative '../lib/method_meter'
+require_relative 'src/arithmeter'
+require_relative 'src/raiser'

data/examples/src/arithmeter.rb

@@ -0,0 +1,24 @@
+class Arithmeter
+  def self.sum(a, b)
+    arithmeter = new
+    arithmeter.add a, b
+  end
+
+  def add(a, b)
+    do_add a, b
+  end
+
+  private
+
+  def do_add(a, b)
+    sleep 1/10.0
+    perform_addition a, b
+  end
+
+  protected
+
+  def perform_addition(a, b)
+    sleep 1/4.0
+    a + b
+  end
+end

data/examples/src/raiser.rb

@@ -0,0 +1,24 @@
+module Raiser
+  class << self
+    def do(number, exponent)
+      do_raise number, exponent
+    end
+
+    protected
+
+    def do_raise(number, exponent)
+      perform_raising number, exponent
+    end
+
+    private
+
+    def perform_raising(number, exponent)
+      sleep 0.5
+      product = number
+
+      1.upto(exponent - 1) do
+        product *= number
+      end
+    end
+  end
+end

data/lib/method_meter.rb

@@ -0,0 +1,85 @@
+require 'method_meter/version'
+
+require 'byebug'
+require 'active_support'
+require 'active_support/core_ext/string'
+require 'defined_methods'
+
+module MethodMeter
+  mattr_accessor :events, :subscribers, :data
+
+  class << self
+    def observe(object=Arithmeter)
+      self.events = [] if self.events.blank?
+
+      DefinedMethods.in(object).each do |group|
+        group[:object].module_eval do
+          group[:methods].each do |method|
+            method_with_profiling     = method.to_s + '_with_profiling'
+            method_without_profiling  = method.to_s + '_without_profiling'
+            event_name                = DefinedMethods.fqmn(group, method)
+
+            next if event_name =~ /_profiling/
+            next if MethodMeter.events.include?(event_name)
+
+            MethodMeter.events << event_name
+
+            define_method(method_with_profiling) do |*args, &block|
+              ActiveSupport::Notifications.instrument(event_name, args) do
+                send(method_without_profiling, *args, &block)
+              end
+            end
+
+            alias_method method_without_profiling, method
+            alias_method method, method_with_profiling
+
+            private method_with_profiling if group[:private]
+            protected method_with_profiling if group[:protected]
+          end
+        end
+      end
+    end
+
+    def measure!(key)
+      self.subscribers  = []
+      self.data         = {} if self.data.blank?
+      self.data[key]    = {}
+
+      self.events.each do |event|
+        self.subscribers << ActiveSupport::Notifications.subscribe(event) do |_, started_at, finished_at, _, _|
+          self.data[key][event] = [] unless self.data[key].has_key?(event)
+          self.data[key][event] << (finished_at - started_at)
+        end
+      end
+
+      yield
+
+      self.subscribers.each do |subscriber|
+        ActiveSupport::Notifications.unsubscribe(subscriber)
+      end
+    end
+
+    def measurement
+      @measurement ||= begin
+        self.data.collect do |key, measurement_records|
+          _measurement = measurement_records.collect do |method_name, records|
+            total_calls   = records.size
+            total_runtime = records.reduce(:+) * 1000
+            average       = total_runtime / total_calls
+
+            {
+              method: method_name,
+              min: records.min * 1000,
+              max: records.max * 1000,
+              average: average,
+              total_runtime: total_runtime,
+              total_calls: total_calls,
+            }
+          end
+
+          { key => _measurement }
+        end
+      end
+    end
+  end
+end

data/lib/method_meter/version.rb

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

data/method_meter.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'method_meter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'method_meter'
+  spec.version       = MethodMeter::VERSION
+  spec.authors       = ['Wilfrido T. Nuqui Jr.']
+  spec.email         = ['nuqui.dev@gmail.com']
+
+  spec.summary       = 'MethodMeter is a library module that instruments methods defined in a given object.'
+  spec.description   = 'MethodMeter is a library module that instruments methods defined in a given object.'
+  spec.homepage      = 'https://github.com/wnuqui/method_meter'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  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 'byebug', '~> 9.1.0' # can be put in Gemfile
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: method_meter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wilfrido T. Nuqui Jr.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-18 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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.1.0
+description: MethodMeter is a library module that instruments methods defined in a
+  given object.
+email:
+- nuqui.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/1-basic.rb
+- examples/2-serial-measurement-using-keys.rb
+- examples/3-observe-multiple-times.rb
+- examples/4-more-measurement.rb
+- examples/helper.rb
+- examples/src/arithmeter.rb
+- examples/src/raiser.rb
+- lib/method_meter.rb
+- lib/method_meter/version.rb
+- method_meter.gemspec
+homepage: https://github.com/wnuqui/method_meter
+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.6.13
+signing_key: 
+specification_version: 4
+summary: MethodMeter is a library module that instruments methods defined in a given
+  object.
+test_files: []