profiling 2.0.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 93ace3273f3436ce25c317fbad89c277548c9af4
-  data.tar.gz: 37ecc2ab961d454be1a4461af1728a815f830ea0
+SHA256:
+  metadata.gz: 741bfb137712d65a0280ccde370760c2f9993e07fc5f247ee7e796fa99913caa
+  data.tar.gz: 90bf533152d0f512c381cb79ef3cffb201c4905bfe59876e1e43ea27939f5b58
 SHA512:
-  metadata.gz: 9b820255232fea158d0d25184ae3597a4a73b664ce2df1a0b8bd520d5b28197c04134bd8a8d5eee0a8f6fe21b546a2c96821daf3e4f7e7ef0446865f49c7eab4
-  data.tar.gz: 7c5f38ac38441ff62a5f03a27d64cd04c662b67b00b98ba6928c8d52e8fe2ed56a3bba744da7b5d806dda475356a74e1c377ffcd41436d305701bb02809155dd
+  metadata.gz: e11902ff7667a4b38e19c9ee9e60a0f2301ad86d28d30807b1b7e8fa9c6aa201b15e7ef58585d16f39ff7487680a8a84a1b0a348aa3ce3b3a0ddc1c32eb6664c
+  data.tar.gz: 7ebb82d01f71104d1ba1be6671555db8bcd8319a06719f46b500809fe535b611444db4d8b167cb49971c4f6a57518199ffdc74581e4f94ead8327fa8e4f5a5a4

data/README.md

@@ -12,7 +12,7 @@ Non-discriminatory profiling for your MRI Ruby code. This gem is a small wrapper
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'profiling', "~> 1.2"
+gem 'profiling', "~> 4.0"
 ```
 
 And then execute:
@@ -31,15 +31,9 @@ Profile slow code from your friend or colleague like this:
 Profiler.run do
   # Slow code here...
 end
-
-# or
-
-Profiler.run("some-label") do
-  # Slow code here...
-end
 ```
 
-The next time you call the code it will be profiled and three files will be written into a directory `profiling`, and in the second example `profiling/some-label`.
+The next time you call the code it will be profiled and three files will be written into a directory called `profiling`.
 
 ### Files Generated
 
@@ -49,25 +43,36 @@ The next time you call the code it will be profiled and three files will be writ
 | `stack.html` | See the profiled code as a nested stack |
 | `flat.txt` | List of all functions called, the time spent in each and the number of calls made to that function |
 
-## Configuration
+### Is it Fast?
+
+No, no it's not. It's really slow. For especially gnarly, deeply nested code you will want to get up and get a coffee. This gem wraps [ruby-prof](https://github.com/ruby-prof/ruby-prof) which is partly written in C, so it's as fast as it can be.
+## Options
+
+Use the `configure` method to set some options:
 
 ```ruby
-Profiler.config = {
-  dir: 'profiling', # Directory the files will be created in (default is 'profiling')
-  exclude_gems: true, # Exclude ruby gems from the results (default is true)
-  exclude_standard_lib: false # Exclude ruby standard library from results (default is false)
-}
+Profiler.configure({
+  dir: '/tmp/my-dir',
+  exclude_gems: true,
+  exclude_standard_lib: true
+})
 ```
 
+| Option | Description | Default |
+| ------ | --------|------------ |
+| `dir` | Directory the files will be created in (can be relative or absolute) | `"profiling"` |
+| `exclude_gems` | Exclude ruby gems from the results | `false` |
+| `exclude_standard_lib` | Exclude ruby standard library from results | `false` |
+
 ## Rails Initializer
 
 This initializer is recommended if you're planning to profile in Rails:
 
 ```ruby
 # config/initializer/profiling.rb
-Profiler.config = {
+Profiler.configure({
   dir: Rails.root.join('tmp/profiling')
-}
+})
 ```
 
 ## Conditional Profiling
@@ -80,19 +85,29 @@ Profiler.run(if: user.is_admin?) do
 end
 ```
 
-## Preserving artefacts
+## Labels
+
+Labels translate to sub directories that the files will be generated in. This is handy for profiling multiple things at once, preserving files between runs, or grouping profiling results logically.
+
+```ruby
+Profiler.run("some-label") do
+  # Slow code here...
+end
+```
+
+### Preserving files between runs
 
-Every time code is profiled the previous files will be overwritten unless the label is dynamic. To keep old files, add the current time in the label so new files are generated with each run:
+Keep old files by adding the current time in the label so new files are generated with each run:
 
 ```ruby
-Profiler.run("my-label-#{Time.now.to_i}") do
+Profiler.run("some-label-#{Time.now.to_i}") do
   # Slow code here...
 end
 ```
 
-## Organizing artefacts
+### Organizing
 
-Labels translate to directories, so use `/` in your labels to group artefacts together:
+Use `/` in your labels to group profiling results together in directories:
 
 ```ruby
 Profiler.run("post/create") do
@@ -106,7 +121,7 @@ end
 
 ## Contributing
 
-Bug reports and pull requests are welcome.
+Bug reports and pull requests are welcome. Pull requests with passing tests are even better.
 
 To run the test suite:
 

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "profiling"
+require 'bundler/setup'
+require 'profiling'
 
 # 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.
@@ -10,5 +11,5 @@ require "profiling"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/profiling.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'ostruct'
 
-Dir[File.dirname(__FILE__) + '/profiling/*.rb'].each { |file| require file }
+Dir["#{File.dirname(__FILE__)}/profiling/*.rb"].each { |file| require file }
 
 class Profiler
   extend Configuration

data/lib/profiling/configuration.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 class Profiler
   module Configuration
-
     DEFAULT_CONFIG = {
       dir: 'profiling',
-      exclude_gems: true,
+      exclude_gems: false,
       exclude_standard_lib: false
-    }
+    }.freeze
 
     attr_accessor :config
 

data/lib/profiling/engine.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 class Profiler
   module Engine
-
-    def run(label=nil, options={})
-      enabled = options[:if].nil? ? true : !!options[:if]
+    def run(*args)
+      label = args.find { |a| a.is_a?(String) }
+      opts = args.find { |a| a.is_a?(Hash) }
+      enabled = opts.nil? ? true : opts[:if]
       return yield unless enabled
 
       # Create directory
@@ -22,48 +25,48 @@ class Profiler
 
       begin
         yield
-      rescue => e
+      rescue StandardError => e
         profile.stop
         raise e
       end
 
       @results = profile.stop
 
-      # Remove certain things from the profiling
-      unless @results.threads.empty?
-        exclude_paths = []
-
-        if config[:exclude_gems]
-          exclude_paths << /\/gems\//
-        end
-
-        unless exclude_paths.empty?
-          @results.threads.first.methods.each do |method|
-            if exclude_paths.any?{|regex| method.source_file.match(regex) }
-              method.eliminate!
-            end
-          end
+      # Optionally remove gems (and the remainder of any standard lib) from the results
+      if !@results.threads.empty? && exclusion_regex
+        @results.threads.each do |thread|
+          thread.methods.each { |m| m.eliminate! if m.source_file.match(exclusion_regex) }
         end
       end
 
-      out()
+      out
     end
 
     private
 
     def out
-      File.open(File.join(@dir, "graph.html"), 'w') do |file|
+      File.open(File.join(@dir, 'graph.html'), 'w') do |file|
         RubyProf::GraphHtmlPrinter.new(@results).print(file)
       end
 
-      File.open(File.join(@dir, "flat.txt"), 'w') do |file|
-        RubyProf::FlatPrinterWithLineNumbers.new(@results).print(file)
+      File.open(File.join(@dir, 'flat.txt'), 'w') do |file|
+        RubyProf::FlatPrinter.new(@results).print(file)
       end
 
-      File.open(File.join(@dir, "stack.html"), 'w') do |file|
+      File.open(File.join(@dir, 'stack.html'), 'w') do |file|
         RubyProf::CallStackPrinter.new(@results).print(file)
       end
     end
 
+    def exclusion_regex
+      root = '/lib/ruby/'
+      if config[:exclude_gems] && config[:exclude_standard_lib]
+        /#{root}/
+      elsif config[:exclude_gems]
+        %r{#{root}gems/}
+      elsif config[:exclude_standard_lib]
+        /#{root}[^g]/
+      end
+    end
   end
 end

data/lib/profiling/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Profiler
-  VERSION = "2.0.1"
+  VERSION = '4.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: profiling
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Luke Duncalfe
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,100 +16,100 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-description: 'Non-discriminatory Ruby code profiling: This gem is a small wrapper
-  around the ruby-prof gem to do simple but powerful profiling'
+        version: '1.4'
+description: Non-discriminatory profiler for Ruby MRI code. This gem is a small wrapper
+  around the ruby-prof gem to do simple but powerful profiling
 email:
 - lduncalfe@eml.cc
 executables: []
@@ -129,7 +129,7 @@ licenses:
 - MIT
 metadata:
   yard.run: yri
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,17 +137,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: 'Non-discriminatory Ruby code profiling: This gem is a small wrapper around
-  the ruby-prof gem to do simple but powerful profiling'
+summary: Non-discriminatory profiler for Ruby MRI code.
 test_files: []