time_method 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f772b3b225ddfb7f9ea1139a0f5ee224473361d7
+  data.tar.gz: 077a6d1cb862368364e73d7a9e4fb18262b2d70e
+SHA512:
+  metadata.gz: 90d6af20d3084cd37f347bf9cee0ba96f8dc7d14d11e7b3590d21061894e4d48fe0cb16a789b3cbcb92fbb76dbe69cf36651ffb92dbfad97b2db5c5b6997c826
+  data.tar.gz: b9efdcceb0b84bf72079df9ca46de7cf01570df15c5275a8d0eeb6af0acc14ad60039c49aa2654818e52ca21fcdca9a84f450ff97ca7d177476f96aa442942ba

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.16.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,50 @@
+# TimeMethod
+
+
+TimeMethod is a gem that makes it easy to see the run-time of different methods within Terminal
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'time_method'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install time_method
+
+## Usage
+
+
+TimeMethod is built upon the excellent gem made here [here](https://github.com/Riskified/timeasure)
+
+You can visit the above page for more details on usage. This version has some functionality trimmed down
+and some functionality added. The focus is on development profiling of methods.
+
+It outputs two tables at the end of a request/test being run. 
+
+1) A list of methods sorted by total run time
+
+2) A list of methods sorted by total execution order
+
+![Table image 1](img_1.png)
+
+In order to show these tables, call 
+```StoreMeasurement.instance.print_all```
+at the end of your request.
+
+You can also create a middleware to do this.
+
+## 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).
+

data/Rakefile

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

data/lib/time_method.rb

@@ -0,0 +1,85 @@
+require_relative "lib/class_methods"
+require_relative "lib/configuration"
+require_relative "lib/measurement"
+
+module TimeMethod
+  class << self
+
+    def configure
+      yield(configuration)
+    end 
+
+    def measure(klass_name: nil, method_name: nil)
+      t0 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      StoreMeasurement.instance.add_to_stack(
+        "in",klass_name,method_name
+        )
+      block_return_value = yield if block_given?
+      StoreMeasurement.instance.add_to_stack(
+        "out", klass_name, method_name
+      )
+      t1 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      begin
+        measurement = TimeMethod::Measurement.new(
+          klass_name: klass_name.to_s, 
+          method_name: method_name.to_s,
+          t0: t0, 
+          t1: t1
+        )
+      rescue => e
+        puts  e,e.backtrace[0..3]
+      end
+
+      block_return_value
+    end
+
+    def print_all_run_times
+      StoreMeasurement.instance.print_all
+    end 
+
+    def configuration
+      @configuration ||= Configuration.new
+    end 
+
+    def included(base_class)
+      base_class.extend ClassMethods
+      # below creates two modules and then makes
+      # them accessible through a constant name
+      instance_interceptor = const_set(
+        instance_interceptor_name_for(base_class),
+        interceptor_module_for(base_class)
+      )
+      class_interceptor = const_set(
+        class_interceptor_name_for(base_class),
+        interceptor_module_for(base_class)
+      )
+
+      return unless should_run_and_time_methods?
+
+      base_class.prepend instance_interceptor
+      base_class.singleton_class.prepend class_interceptor
+    end 
+
+    def instance_interceptor_name_for(base_class)
+      "#{base_class.time_method_name}InstanceInterceptor"
+    end 
+
+    def class_interceptor_name_for(base_class)
+      "#{base_class.time_method_name}ClassInterceptor"
+    end 
+
+
+    def interceptor_module_for(base_class)
+      Module.new do 
+        @klass_name = base_class
+        def self.klass_name
+          @klass_name
+        end 
+      end
+    end 
+
+    def should_run_and_time_methods?
+      configuration.enable_time_method
+    end 
+  end 
+end 

data/lib/time_method/class_methods.rb

@@ -0,0 +1,52 @@
+load "#{Rails.root}/lib/time_method/store_measurement.rb"
+module TimeMethod
+  module ClassMethods
+
+    def time_method_name
+      name.gsub("::","_")
+    end 
+
+    def tracked_instance_methods(*method_names)
+      method_names.each do |method_name|
+        add_method_to_interceptor(instance_interceptor,method_name)
+      end 
+    end 
+
+    def tracked_class_methods(*method_names)
+      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| private_interceptor_method(instance_interceptor,method_name)}
+    end
+
+    def tracked_private_class_methods(*method_namess)
+      tracked_class_methods(*method_names)
+      method_names.each { |method_name| private_interceptor_method(class_interceptor,method_name)}
+    end
+
+    def privatize_interceptor_method(interceptor,method_name)
+      interceptor.class_eval {private method_name}
+    end 
+
+    def instance_interceptor
+      const_get("#{time_method_name}InstanceInterceptor")
+    end 
+
+    def class_interceptor
+      const_get("#{time_method_name}ClassInterceptor")
+    end 
+
+    def add_method_to_interceptor(interceptor,method_name)
+      interceptor.class_eval do
+        define_method method_name do |*args, &block|
+          TimeMethod.measure(klass_name:interceptor.klass_name.to_s,method_name:method_name.to_s) do
+            super(*args,&block)
+          end 
+        end 
+      end 
+    end 
+  end
+end 

data/lib/time_method/configuration.rb

@@ -0,0 +1,8 @@
+module TimeMethod
+  class Configuration
+    attr_accessor :enable_time_method
+    def initialize
+      @enable_time_method = true
+    end 
+  end 
+end 

data/lib/time_method/measurement.rb

@@ -0,0 +1,34 @@
+module TimeMethod
+  class Measurement
+    attr_accessor :klass_name, :method_name, :segment, :metadata, :t0, :t1,:time
+    def initialize(klass_name:, method_name:, t0:, t1:)
+      @klass_name  = klass_name
+      @method_name = method_name
+      @t0          = t0
+      @t1          = t1
+      # @time        = runtime_ms
+      @time        = runtime_seconds
+      store_measurement
+    end 
+
+    def store_measurement
+      StoreMeasurement.instance.store(klass_name:@klass_name,method_name:@method_name,time:@time)
+    end 
+
+    def output_stack
+      StoreMeasurement.instance.output_stack
+    end 
+
+    def runtime
+      @runtime_in_milliseconds ||= ((@t1 - @t0) * 1000).round(2)
+    end 
+
+    def runtime_ms
+      @runtime_in_milliseconds ||= ((@t1 - @t0) * 1000).round(2)
+    end 
+
+    def runtime_seconds
+      @runtime_in_seconds ||= (@t1 - @t0).round(2)
+    end 
+  end
+end

data/lib/time_method/store_measurement.rb

@@ -0,0 +1,93 @@
+module TimeMethod
+  class StoreMeasurement
+    include Singleton
+    def initialize
+      @time_for_method     = []
+      @methods_in_order    = []
+      @depth               = 0
+      @full_stack         = []
+    end   
+
+    def add_to_stack(in_or_out,klass_name,method_name)
+      @depth+=1 if in_or_out == "in"
+      @depth-=1 if in_or_out == "out"
+      mod_klass_name=klass_name.split("::").last
+      name="#{mod_klass_name}.#{method_name}"
+    end 
+    
+    # can add some logic here when/while storing as well
+    def store(klass_name:,method_name:,time:)
+      mod_klass_name=klass_name.split("::").last
+      name="#{mod_klass_name}.#{method_name}"
+      @time_for_method.push([name,time,@depth])
+    end 
+
+    def make_summary_arr(sort_by:)
+      updated_time_for_method = @time_for_method.map{|x| [x[0],(x[1].real*1000).round(2),"   "*x[2]]}
+      h=updated_time_for_method.group_by{|a| a[0]}
+      new_h={}
+      h.each do |k,v|
+        sum = 0
+        count=0
+        v.each do |el|
+          sum+=el[1]
+          count+=1
+        end   
+        avg = (sum/count)
+        tabs = v[0][2]
+        new_h[k]=[sum,count,avg,tabs]
+      end 
+      new_arr=[]    
+      new_h.each do |k,v|
+        k_with_tabs = v[3]+k
+        method_and_class_name=k_with_tabs.scan(/[a-zA-Z::_0-9\t ]+/)
+        new_arr.push([*method_and_class_name,*v])
+      end
+
+      if sort_by == "run_time"
+        new_arr.map! {|x| [x[0].gsub(" ",""),x[1],x[2].round(0),x[3].round(0),x[4].round(0)]}
+        new_arr.sort! {|a,b| b[2] <=> a[2]}
+        title = "Sorted List of Methods By Total Run Time"
+      elsif sort_by == "execution_order"
+        new_arr.map! {|x| [x[0],x[1],x[2].round(0),x[3].round(0),x[4].round(0)]}
+        new_arr = new_arr.reverse
+        title = "Sorted List of Methods By Total Execution Order"
+      end 
+      
+      headings=[ "Class Name", "Method Name", "Total Run Time (ms)","# of Calls","Average Time Per Call (ms)"] 
+      table = Terminal::Table.new :title => title ,:headings => headings do |t|
+        t.rows = new_arr
+      end 
+      return table
+    end 
+
+    def make_summary_arr_run_time
+      @summary_arr = make_summary_arr(sort_by:"run_time")
+    end 
+
+    def print_summary_arr_run_time
+      puts @summary_arr
+    end 
+    
+
+    def make_summary_arr_execution_order
+      @summary_arr_execution_order = make_summary_arr(sort_by:"execution_order")
+    end 
+
+    def print_summary_arr_execution_order
+      puts @summary_arr_execution_order
+    end 
+
+    def print_summary_arr
+      puts @summary_arr
+    end 
+
+    def print_all
+      make_summary_arr_run_time
+      make_summary_arr_execution_order
+      print_summary_arr_run_time
+      print_summary_arr_execution_order
+      @time_for_method=[]
+    end
+  end
+end

data/lib/time_method/version.rb

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

data/license.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Eliav Lavi
+
+MIT License
+
+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/time_method.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "time_method/version.rb"
+
+Gem::Specification.new do |spec|
+  spec.name          = "time_method"
+  spec.version       = TimeMethod::VERSION
+  spec.authors       = ["Seyon Vasantharajan"]
+  spec.email         = ["seyon.vasantharajan@gmail.com"]
+
+  spec.summary       = %q{Easily set methods to profile and view run-times in terminal }
+  spec.description   = <<-DESCRIPTION
+                        Time Method allows easy setting of runtime without having to alter 
+                        the code of the methods and also allows
+                       DESCRIPTION
+  spec.homepage      = "https://github.com/seyonv/time_method"
+  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","lib/time_method"]
+
+  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 "terminal-table"
+end

data/time_method.rb

@@ -0,0 +1,85 @@
+require_relative "time_method/class_methods"
+require_relative "time_method/configuration"
+require_relative "time_method/measurement"
+
+module TimeMethod
+  class << self
+
+    def configure
+      yield(configuration)
+    end 
+
+    def measure(klass_name: nil, method_name: nil)
+      t0 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      StoreMeasurement.instance.add_to_stack(
+        "in",klass_name,method_name
+        )
+      block_return_value = yield if block_given?
+      StoreMeasurement.instance.add_to_stack(
+        "out", klass_name, method_name
+      )
+      t1 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      begin
+        measurement = TimeMethod::Measurement.new(
+          klass_name: klass_name.to_s, 
+          method_name: method_name.to_s,
+          t0: t0, 
+          t1: t1
+        )
+      rescue => e
+        puts  e,e.backtrace[0..3]
+      end
+
+      block_return_value
+    end
+
+    def print_all_run_times
+      StoreMeasurement.instance.print_all
+    end 
+
+    def configuration
+      @configuration ||= Configuration.new
+    end 
+
+    def included(base_class)
+      base_class.extend ClassMethods
+      # below creates two modules and then makes
+      # them accessible through a constant name
+      instance_interceptor = const_set(
+        instance_interceptor_name_for(base_class),
+        interceptor_module_for(base_class)
+      )
+      class_interceptor = const_set(
+        class_interceptor_name_for(base_class),
+        interceptor_module_for(base_class)
+      )
+
+      return unless should_run_and_time_methods?
+
+      base_class.prepend instance_interceptor
+      base_class.singleton_class.prepend class_interceptor
+    end 
+
+    def instance_interceptor_name_for(base_class)
+      "#{base_class.time_method_name}InstanceInterceptor"
+    end 
+
+    def class_interceptor_name_for(base_class)
+      "#{base_class.time_method_name}ClassInterceptor"
+    end 
+
+
+    def interceptor_module_for(base_class)
+      Module.new do 
+        @klass_name = base_class
+        def self.klass_name
+          @klass_name
+        end 
+      end
+    end 
+
+    def should_run_and_time_methods?
+      configuration.enable_time_method
+    end 
+  end 
+end 

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: time_method
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Seyon Vasantharajan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-13 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: terminal-table
+  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: "                        Time Method allows easy setting of runtime without
+  having to alter \n                        the code of the methods and also allows\n"
+email:
+- seyon.vasantharajan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- img_1.png
+- lib/time_method.rb
+- lib/time_method/class_methods.rb
+- lib/time_method/configuration.rb
+- lib/time_method/measurement.rb
+- lib/time_method/store_measurement.rb
+- lib/time_method/version.rb
+- license.txt
+- time_method.gemspec
+- time_method.rb
+homepage: https://github.com/seyonv/time_method
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/time_method
+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.10
+signing_key: 
+specification_version: 4
+summary: Easily set methods to profile and view run-times in terminal
+test_files: []