profile-tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ea7a642f74758aef7887554315fac1c6141058a668f9c42bd94cb90db90d0b8
+  data.tar.gz: 1d4f88fa199c5c6adf6162d39b221b41ed4fc9679b9d727e99b3c84950e0a3d4
+SHA512:
+  metadata.gz: 95b41c270ca78f611e60863f046d0a0141107bc620e2ca93c726ed806dae98b03c0a9143ed0356de794a8c6d047d151a98529d38e293444d38be4f49a4a5af7a
+  data.tar.gz: 415571c41e649b9548b1e4011245b90a1fd30328c90f5428469d6dea11ee7d00b775e19b8511bb914680187f2fcc8c40f1bad0c61c313bfbcadc65fd700b3ac1

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+*~
+*.yaml

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Naming/FileName:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120
+Metrics/ModuleLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 20
+AllCops:
+  Exclude:
+    - 'spec/spec_helper.rb'
+    - 'spec/**/*_spec.rb'
+    - 'spec/support/*.rb'
+    - 'script/test'

data/.ruby-gemset

@@ -0,0 +1 @@
+profile-tools

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gem 'activesupport'
+
+group :development do
+  gem 'rake'
+  gem 'rubocop'
+end
+
+group :spec do
+  gem 'rspec'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  rake
+  rspec
+  rubocop
+  simplecov
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 dougyouch
+
+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,2 @@
+# profile-tools
+Ruby profiling tools

data/lib/profile-tools.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+# ProfileTools is used to instrument specific methods.  Provides feedback about method execution
+#  time and number of objects created.
+class ProfileTools
+  autoload :Collector, 'profile_tools/collector'
+  autoload :LogSubscriber, 'profile_tools/log_subscriber'
+  autoload :Profiler, 'profile_tools/profiler'
+
+  EVENT = 'profile.profile_tools'
+
+  @profiled_methods = []
+  class << self
+    attr_reader :profiled_methods
+  end
+
+  def self.add_method(display_name)
+    profiled_methods << display_name
+  end
+
+  def self.delete_method(display_name)
+    profiled_methods.delete_if { |method| method == display_name }
+  end
+
+  def initialize
+    ObjectSpace.count_objects
+  end
+
+  def profile_instance_method(class_name, method_name)
+    profile_method(Object.const_get(class_name), method_name, "#{class_name}##{method_name}")
+  end
+
+  def profile_class_method(class_name, method_name)
+    profile_method(Object.const_get(class_name).singleton_class, method_name, "#{class_name}.#{method_name}")
+  end
+
+  def remove_profiled_instance_method(class_name, method_name)
+    remove_profiling(Object.const_get(class_name), method_name, "#{class_name}##{method_name}")
+  end
+
+  def remove_profiled_class_method(class_name, method_name)
+    remove_profiling(Object.const_get(class_name).singleton_class, method_name, "#{class_name}.#{method_name}")
+  end
+
+  def self.load(yaml_file)
+    require 'yaml'
+    profile(YAML.load_file(yaml_file))
+  end
+
+  def self.profile(classes)
+    profile_tools = new
+
+    classes.each do |class_name, methods|
+      methods.each do |method_name|
+        if method_name =~ /\A\./
+          profile_tools.profile_class_method(class_name, method_name[1, method_name.size])
+        else
+          profile_tools.profile_instance_method(class_name, method_name)
+        end
+      end
+    end
+
+    profile_tools
+  end
+
+  def self.stop_profiling(methods)
+    profile_tools = new
+
+    methods.each do |method|
+      if method =~ /#/
+        profile_tools.remove_profiled_instance_method(*method.split('#', 2))
+      elsif method =~ /\./
+        profile_tools.remove_profiled_class_method(*method.split('.', 2))
+      end
+    end
+  end
+
+  def self.stop_profiling!
+    stop_profiling(profiled_methods.dup)
+  end
+
+  def self.profiler
+    Thread.current[:profile_tools_profiler] ||= Profiler.new
+  end
+
+  def self.instrument
+    profiler.instrument do
+      yield
+    end
+  end
+
+  private
+
+  def profile_method(kls, method_name, display_name)
+    self.class.add_method(display_name)
+
+    method_name_without_profiling = generate_method_name(method_name.to_s, 'without_profiling')
+    method_name_with_profiling = generate_method_name(method_name.to_s, 'with_profiling')
+
+    kls.class_eval(
+<<-STR, __FILE__, __LINE__ + 1
+def #{method_name_with_profiling}(*args)
+  ::ProfileTools.profiler.instrument('#{display_name}') do
+    #{method_name_without_profiling}(*args)
+  end
+end
+STR
+    )
+
+    kls.alias_method(method_name_without_profiling, method_name)
+    kls.alias_method(method_name, method_name_with_profiling)
+  end
+
+  def generate_method_name(method_name, suffix)
+    punctuation =
+      if method_name =~ /(\?|!)$/
+        $1
+      end
+
+    method_name = method_name.sub(punctuation, '') if punctuation
+
+    "#{method_name}_#{suffix}#{punctuation}"
+  end
+
+  def remove_profiling(kls, method_name, display_name)
+    self.class.delete_method(display_name)
+
+    method_name_without_profiling = generate_method_name(method_name.to_s, 'without_profiling')
+    method_name_with_profiling = generate_method_name(method_name.to_s, 'with_profiling')
+
+    kls.alias_method(method_name, method_name_without_profiling)
+    kls.send(:remove_method, method_name_with_profiling)
+    kls.send(:remove_method, method_name_without_profiling)
+  end
+end

data/lib/profile_tools/collector.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+
+class ProfileTools
+  # Collects stats around method calls
+  class Collector
+    attr_reader :methods,
+                :total_collection_calls
+
+    def initialize
+      @methods = {}
+      @total_collection_calls = 0
+      @sort_order = 0
+    end
+
+    def init_method(method)
+      @methods[method] = {
+        method: method,
+        duration: 0.0,
+        calls: 0,
+        count_objects: Hash.new(0),
+        num_collection_calls: 0,
+        sort_order: nil
+      }
+    end
+
+    def called_methods
+      @methods
+        .values
+        .reject { |info| info[:calls].zero? }
+        .sort { |a, b| a[:sort_order] <=> b[:sort_order] }
+    end
+
+    def instrument(method)
+      current_collection_calls = @total_collection_calls
+      result = nil
+      duration = nil
+      @methods[method][:sort_order] ||= (@sort_order += 1)
+      count_objects = count_objects_around do
+        started_at = now
+        result = yield
+        duration = now - started_at
+      end
+      add(
+        method,
+        duration * 1000.0,
+        count_objects,
+        @total_collection_calls - current_collection_calls
+      )
+      result
+    end
+
+    private
+
+    def add(method, duration, count_object_changes, num_collection_calls)
+      @total_collection_calls += 1
+      @methods[method][:calls] += 1
+      @methods[method][:duration] += duration
+      @methods[method][:num_collection_calls] = num_collection_calls
+      add_object_changes(@methods[method][:count_objects], count_object_changes)
+      adjust_count_objects(@methods[method][:count_objects], num_collection_calls)
+    end
+
+    def add_object_changes(current_objects, new_objects)
+      new_objects.each do |name, cnt|
+        current_objects[name] += cnt
+      end
+      current_objects
+    end
+
+    def adjust_count_objects(count_objects, num_collection_calls)
+      return if num_collection_calls.zero?
+
+      count_objects[:T_STRING] -= (1 * num_collection_calls)
+      count_objects[:T_ARRAY] -= (1 * num_collection_calls)
+      count_objects[:T_HASH] -= (2 * num_collection_calls)
+    end
+
+    def now
+      Concurrent.monotonic_time
+    end
+
+    def count_objects_changes(starting_objects, new_objects)
+      new_objects.each do |name, _|
+        new_objects[name] -= starting_objects[name]
+        new_objects[name] -= 1 if name == :T_HASH
+      end
+    end
+
+    def count_objects_around
+      starting_objects = ObjectSpace.count_objects
+      yield
+      count_objects_changes(starting_objects, ObjectSpace.count_objects)
+    end
+  end
+end

data/lib/profile_tools/log_subscriber.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class ProfileTools
+  # Logs the collector stats
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def profile(event)
+      event.payload[:collector].called_methods.each do |info|
+        duration = info[:duration].round(5)
+        count_objects = display_count_objects(info[:count_objects])
+        logger.info "method #{info[:method]} took #{duration}ms, called #{info[:calls]}, objects: #{count_objects}"
+      end
+    end
+
+    private
+
+    def display_count_objects(count_objects)
+      count_objects.reject! { |_, cnt| cnt.zero? }
+      count_objects.delete(:FREE)
+      count_objects.to_a.map { |k, v| "#{k}: #{v}" }.join(', ')
+    end
+  end
+end

data/lib/profile_tools/profiler.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+class ProfileTools
+  # Aggregates profile stats into the collector
+  class Profiler
+    attr_reader :collector
+
+    def initialize
+      @call_depth = 0
+    end
+
+    def instrument(class_and_method_name = 'ProfileTools::Profiler#instrument')
+      result = nil
+      if increment_call_depth == 1
+        @collector = new_collector
+        @collector.init_method(class_and_method_name)
+        instrument_with_notifications(class_and_method_name) do
+          result = yield
+        end
+      else
+        instrument_with_collector(class_and_method_name) do
+          result = yield
+        end
+      end
+      decrement_call_depth
+      result
+    end
+
+    private
+
+    def instrument_with_notifications(class_and_method_name)
+      ActiveSupport::Notifications.instrument(EVENT, collector: @collector) do
+        instrument_with_collector(class_and_method_name) do
+          yield
+        end
+      end
+    end
+
+    def instrument_with_collector(class_and_method_name)
+      @collector.instrument(class_and_method_name) do
+        yield
+      end
+    end
+
+    def increment_call_depth
+      @call_depth += 1
+    end
+
+    def decrement_call_depth
+      @call_depth -= 1
+    end
+
+    def new_collector
+      ::ProfileTools::Collector.new.tap do |collector|
+        ::ProfileTools.profiled_methods.each { |display_name| collector.init_method(display_name) }
+      end
+    end
+  end
+end

data/profile-tools.gemspec

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'profile-tools'
+  s.version     = '0.1.0'
+  s.licenses    = ['MIT']
+  s.summary     = 'Profile tools'
+  s.description = 'Dynamically add method profiling to any class.  Collects method times and objects created.'
+  s.authors     = ['Doug Youch']
+  s.email       = 'dougyouch@gmail.com'
+  s.homepage    = 'https://github.com/dougyouch/profile-tools'
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples)/}) }
+end

data/script/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path('../lib', __dir__)
+
+require 'active_support/notifications'
+require 'active_support/log_subscriber'
+require 'logger'
+require 'concurrent'
+require 'profile-tools'
+require 'irb'
+
+ActiveSupport::LogSubscriber.logger = Logger.new($stdout)
+ProfileTools::LogSubscriber.attach_to :profile_tools
+
+IRB.start(__FILE__)

data/script/test

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path('../lib', __dir__)
+
+require 'active_support/notifications'
+require 'active_support/log_subscriber'
+require 'logger'
+require 'concurrent'
+require 'profile-tools'
+require 'irb'
+
+ActiveSupport::LogSubscriber.logger = Logger.new($stdout)
+ProfileTools::LogSubscriber.attach_to :profile_tools
+
+class Foo
+  def bar
+    bar2
+  end
+
+  def bar2
+    puts "HERE #{1} too"
+    bar3
+  end
+
+  def bar3
+    puts "HERE #{1}"
+  end
+
+  def bar4
+    bar2
+    5.times { bar3 }
+  end
+
+  def bar5
+    5.times { 1 }
+  end
+
+  def bar6
+    bar4
+  end
+end
+
+ProfileTools.new.tap do |t|
+  t.profile_instance_method(:Foo, :bar)
+  t.profile_instance_method(:Foo, :bar2)
+  t.profile_instance_method(:Foo, :bar3)
+  t.profile_instance_method(:Foo, :bar4)
+  t.profile_instance_method(:Foo, :bar5)
+  t.profile_instance_method(:Foo, :bar6)
+end
+
+IRB.start(__FILE__)

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: profile-tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Doug Youch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-30 00:00:00.000000000 Z
+dependencies: []
+description: Dynamically add method profiling to any class.  Collects method times
+  and objects created.
+email: dougyouch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/profile-tools.rb
+- lib/profile_tools/collector.rb
+- lib/profile_tools/log_subscriber.rb
+- lib/profile_tools/profiler.rb
+- profile-tools.gemspec
+- script/console
+- script/test
+homepage: https://github.com/dougyouch/profile-tools
+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.7.10
+signing_key: 
+specification_version: 4
+summary: Profile tools
+test_files: []