method_meter 0.1.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dfae0d180c684c345b21ad7c7c7a130ec2af9d5a
-  data.tar.gz: 6844bd7f03f96d13c228fe28d11f5d7b783eeb16
+SHA256:
+  metadata.gz: 3a5ff992ee06f786d08c62136e9c793d3c0810ce19b70feefadf298004d83d58
+  data.tar.gz: 36882deddbc956bcfc5baa29326f03a713c27de09cd00f833d88da6acf722ae4
 SHA512:
-  metadata.gz: daaeb86102d7554627447f06d5fff8b076db1cc6be1a79026dc05d454f8c87d829d9d165c56eedf0f78b4ea988a9e9099ffff5bcd74be61674ccafced068c2e7
-  data.tar.gz: f7cddc1da6977de3551e7fc4dd466b6bf5bf0466afcfdc188796b7448413b8bddee97a296eb4ba310f7b5a423b92d8f2888c9d07c967fd91ac384f78349b8133
+  metadata.gz: bb17a7e2982862a37acdadaf2adc7f981b06be55b57188a6e1ecb31cdcb1301ba9ad70f01fb21e06ca764931c4a3305bf7a01e88ba5897c9750b7dad2ffe2ccf
+  data.tar.gz: 41c3ed52140bbe3260f12152385261ac6360f8de87479674277277c146e81ea3589162b1cc35cddf1c442fd946fa05496ec670a09282f217f82076b0ab430686

data/.semaphore/semaphore.yml

@@ -0,0 +1,18 @@
+version: v1.0
+name: Initial Pipeline
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+blocks:
+  - name: Test
+    task:
+      jobs:
+        - name: rspec
+          commands:
+            - checkout
+            - sem-version ruby 2.6.5
+            - cache restore
+            - bundle install --path vendor/bundle
+            - cache store
+            - bundle exec rspec

data/Gemfile

@@ -1,10 +1,4 @@
 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'
+gemspec

data/README.md

@@ -1,6 +1,6 @@
-# MethodMeter
+# MethodMeter [![Build Status](https://wnuqui.semaphoreci.com/badges/method_meter/branches/master.svg?style=shields)](https://wnuqui.semaphoreci.com/projects/method_meter)
 
-`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`.
+`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 also NOT from parent objects. By object, it means either a `class` or `module`.
 
 ## Installation
 
@@ -41,6 +41,10 @@ ap MethodMeter.measurement
 
 More examples found here: https://github.com/wnuqui/method_meter/tree/master/examples
 
+## In action
+
+![method_meter in action](1-basic-rb.gif)
+
 ## 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.
@@ -49,7 +53,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/wnuqui/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
 

data/bin/console

@@ -2,6 +2,7 @@
 
 require 'bundler/setup'
 require 'method_meter'
+require 'awesome_print'
 
 # 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.

data/examples/5-excepted-methods.rb

@@ -0,0 +1,21 @@
+require_relative 'helper'
+
+# values set will not be profiled/instrumented
+MethodMeter.exceptions = [:perform_addition]
+
+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/lib/method_meter.rb

@@ -1,85 +1,110 @@
 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
+  mattr_accessor :metered_methods, :subscribers, :data, :exceptions
 
   class << self
-    def observe(object=Arithmeter)
-      self.events = [] if self.events.blank?
+    def observe(object, excepted_methods=[])
+      init excepted_methods
 
       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]
+            MethodMeter.define_metering_method(group[:object], method, group[:private], group[:protected], group[:singleton])
           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)
+      data[key] = {}
+
+      metered_methods.each do |metered_method|
+        subscribers << ActiveSupport::Notifications.subscribe(metered_method) do |_, started_at, finished_at, _, _|
+          data[key][metered_method] = [] unless data[key].has_key?(metered_method)
+          data[key][metered_method] << (finished_at - started_at)
         end
       end
 
       yield
 
-      self.subscribers.each do |subscriber|
+      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
+      measurement = {}
+
+      data.each 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
+
+        measurement[key] = _measurement
+      end
 
-          { key => _measurement }
+      measurement
+    end
+
+    def profiling_method_names(method)
+      method_with_profiling     = method.to_s + '_with_profiling'
+      method_without_profiling  = method.to_s + '_without_profiling'
+      [method_with_profiling, method_without_profiling]
+    end
+
+    def meter_method?(method_name)
+      object_name, method = method_name.split('#')
+      object_name, method = method_name.split('.') if method.nil?
+      !exceptions.include?(method.to_sym) && !metered_methods.include?(method_name) && (method_name =~ /_profiling/).nil?
+    end
+
+    def define_metering_method(object, method, is_private, is_protected, is_singleton)
+      object.module_eval do
+        method_with_profiling, method_without_profiling = MethodMeter.profiling_method_names(method)
+        object_name = is_singleton ? object.to_s.split(':').last.gsub('>', '') : object.to_s
+        method_name = DefinedMethods.fqmn(object_name, method, is_singleton)
+
+        return unless MethodMeter.meter_method?(method_name)
+
+        MethodMeter.metered_methods << method_name
+
+        define_method(method_with_profiling) do |*args, &block|
+          ActiveSupport::Notifications.instrument(method_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 is_private
+        protected method_with_profiling if is_protected
       end
     end
+
+    private
+
+    def init(excepted_methods)
+      self.metered_methods = [] if metered_methods.nil?
+      self.exceptions      = [] if exceptions.nil?
+      self.exceptions     |= excepted_methods
+      self.subscribers     = []
+      self.data            = {} if data.blank?
+    end
   end
 end

data/lib/method_meter/version.rb

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

data/method_meter.gemspec

@@ -19,9 +19,12 @@ Gem::Specification.new do |spec|
 
   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_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'awesome_print'
+  spec.add_runtime_dependency 'defined_methods'
 
-  spec.add_development_dependency 'byebug', '~> 9.1.0' # can be put in Gemfile
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
 end

metadata

@@ -1,43 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: method_meter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Wilfrido T. Nuqui Jr.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-18 00:00:00.000000000 Z
+date: 2021-02-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: defined_methods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 9.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 9.1.0
+        version: '0'
 description: MethodMeter is a library module that instruments methods defined in a
   given object.
 email:
@@ -76,6 +118,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".semaphore/semaphore.yml"
+- 1-basic-rb.gif
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -87,6 +131,7 @@ files:
 - examples/2-serial-measurement-using-keys.rb
 - examples/3-observe-multiple-times.rb
 - examples/4-more-measurement.rb
+- examples/5-excepted-methods.rb
 - examples/helper.rb
 - examples/src/arithmeter.rb
 - examples/src/raiser.rb
@@ -112,8 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: MethodMeter is a library module that instruments methods defined in a given