timeasure 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98176f0d699b3c9ca5cd0e101021edafe375e77d
-  data.tar.gz: 7be9aa110d461fd15ebe5b449e307c5159df778d
+  metadata.gz: 646792d500a9a61b929dd067f9c1b48b9bf30b2d
+  data.tar.gz: 1c0b5af7065eb1a950e201521ca7ec2f5c644964
 SHA512:
-  metadata.gz: '03826e4210bf05d86005e3245f35c90e02aa75e4771195b850a3ba9744535404d799474e56e7db7312bb48ae89ef70a2c455bc661a9c48e3156fa2932dc8ec55'
-  data.tar.gz: 50bdd345a80bfc306eb3138f46c7a3f20493d8193d53ee73d0c538da92da86ffeca7eff5a3dc8d52e0890e8cfc014cd998e8f0efe3792947ad9829bb43c43762
+  metadata.gz: 81af656e98f415dddf152dbec13530c84d4506c64eac0fd13b6f217aad76598dd10251c18239de1c9b69eb8fabc18d732531ce45fe188a73a144453580be486a
+  data.tar.gz: b2062fb31932f6087a6ec43b7f8f7991a868f8b8ff4081e7579358fa9798a1438e377144a257cedc2d36aec0a6570ba772b3c07d8d2fc0bbc9d366b289cc7919

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2018-03-12
+### Added
+- New class macros for tracking private methods in both inline and scoped visibility declaration.
+
+### Changed
+- Start using `Process.clock_gettime(Process::CLOCK_MONOTONIC)` instead of `Time.now` for time tracking
+- Bumped up required Ruby version from 2.0 to 2.1
+
+## [0.1.1] - 2018-02-24
+### Added
+- Specs for describing the proper way to track private methods. 
+
+### Fixed
+- Minor performance issue in class macros
+
+## [0.1.0] - 2018-02-24
+### Added
+- Timeasure main code
+- Timeasure profiler
+
+[0.2.0]: https://github.com/Riskified/timeasure/compare/v0.1.1...v0.2.0
+[0.1.1]: https://github.com/Riskified/timeasure/compare/v0.1.0...v0.1.1

data/README.md

@@ -39,7 +39,7 @@ Timeasure is developed and maintained by [Eliav Lavi](http://www.eliavlavi.com)
 
 ## Requirements
 
-Ruby 2.0 or a later version is mandatory. (Timeasure uses `Module#prepend` introduced in Ruby 2.0.)
+Ruby 2.1 or a later version is mandatory. (Timeasure uses `Module#prepend` introduced in Ruby 2.0 and `Process::CLOCK_MONOTONIC` introduced in Ruby 2.1.)
 
 ## Installation
 
@@ -78,6 +78,70 @@ class Foo
   end
 end
 ```
+**An Important Note Regarding Private Methods**
+
+If you need to track any private methods - either class methods or instance methods - use the designated class macros for that:
+
+```ruby
+class Foo
+  include Timeasure
+  tracked_class_methods :a_class_method_that_calls_private_methods
+  tracked_private_class_methods :a_scoped_private_class_method, :an_inline_private_class_method
+  
+  class << self
+    def a_class_method_that_calls_private_methods
+      a_scoped_private_class_method
+      an_inline_private_class_method
+    end
+    
+    def a_scoped_private_class_method
+      # some private class-level stuff that can benefit from measuring runtime...
+    end
+  end
+  
+  def self.an_inline_private_class_method
+    # some other private class-level stuff that can benefit from measuring runtime...
+  end
+end
+```
+
+And the instance-level equivalent:
+
+```ruby
+class Foo
+  include Timeasure
+  tracked_instance_methods :a_instance_method_that_calls_private_methods
+  tracked_private_instance_methods :a_scoped_private_instance_method, :an_inline_private_instance_method
+  
+  class << self
+    def a_instance_method_that_calls_private_methods
+      a_scoped_private_instance_method
+      an_inline_private_instance_method
+    end
+    
+    def a_scoped_private_instance_method
+      # some private instance-level stuff that can benefit from measuring runtime...
+    end
+  end
+  
+  def self.an_inline_private_instance_method
+    # some other private instance-level stuff that can benefit from measuring runtime...
+  end
+end
+```
+
+**ATTENTION!**
+
+**Declaring the tracking of private methods with `tracked_class_methods` or `tracked_instance_methods` will end up in `NoMethodError` upon calling their triggering method!**
+
+Also, tracking your public methods with `tracked_private_class_methods` or `tracked_private_instance_methods` will make your class' interface inaccessible.
+The reason for these two is that since Timeasure is declared at the top of the class,
+it cannot know in advance which methods will be declared as private, so you need to specify this explicitly.
+
+As a side note, it could be claimed that as a rule of thumb, if you find yourself measuring private methods,
+this might be a good idea to invest in refactoring this area of code and [Extract Class](https://refactoring.guru/extract-class).
+However, this is not always possible, of course, especially when working on legacy code.
+Hence, this feature of Timeasure should be considered as somewhat of a last resort and be handled with care.   
 
 #### 2. Define the Boundaries of the Tracked Transaction
 **Preparing for Method Tracking**

data/lib/timeasure.rb

@@ -27,9 +27,9 @@ module Timeasure
     end
 
     def measure(klass_name: nil, method_name: nil, segment: nil, metadata: nil)
-      t0 = Time.now.utc
+      t0 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       block_return_value = yield if block_given?
-      t1 = Time.now.utc
+      t1 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
       begin
         measurement = Timeasure::Measurement.new(klass_name: klass_name.to_s, method_name: method_name.to_s,

data/lib/timeasure/class_methods.rb

@@ -1,19 +1,27 @@
 module Timeasure
   module ClassMethods
     def tracked_instance_methods(*method_names)
-      instance_interceptor = const_get("#{timeasure_name}InstanceInterceptor")
       method_names.each do |method_name|
         add_method_to_interceptor(instance_interceptor, method_name)
       end
     end
 
     def tracked_class_methods(*method_names)
-      class_interceptor = const_get("#{timeasure_name}ClassInterceptor")
       method_names.each do |method_name|
         add_method_to_interceptor(class_interceptor, method_name)
       end
     end
 
+    def tracked_private_instance_methods(*method_names)
+      tracked_instance_methods(*method_names)
+      method_names.each { |method_name| privatize_interceptor_method(instance_interceptor, method_name) }
+    end
+
+    def tracked_private_class_methods(*method_names)
+      tracked_class_methods(*method_names)
+      method_names.each { |method_name| privatize_interceptor_method(class_interceptor, method_name) }
+    end
+
     def timeasure_name
       name.gsub('::', '_')
     end
@@ -29,5 +37,17 @@ module Timeasure
         end
       end
     end
+
+    def privatize_interceptor_method(interceptor, method_name)
+      interceptor.class_eval { private method_name }
+    end
+
+    def instance_interceptor
+      const_get("#{timeasure_name}InstanceInterceptor")
+    end
+
+    def class_interceptor
+      const_get("#{timeasure_name}ClassInterceptor")
+    end
   end
 end

data/lib/timeasure/version.rb

@@ -1,3 +1,3 @@
 module Timeasure
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/timeasure.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ['lib', 'lib/timeasure', 'lib/timeasure/profiling']
 
-  spec.required_ruby_version = '>= 2.0'
+  spec.required_ruby_version = '>= 2.1'
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake', '~> 12.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timeasure
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Eliav Lavi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-24 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,6 +79,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -106,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="