profiling 1.2.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f20b2a353b190c5e2dd6dcdc5c9bd790ff1cb6b7
-  data.tar.gz: 947bd73fe763e35f8f90c57f164f6716e0bb2a8d
+  metadata.gz: 93ace3273f3436ce25c317fbad89c277548c9af4
+  data.tar.gz: 37ecc2ab961d454be1a4461af1728a815f830ea0
 SHA512:
-  metadata.gz: 1c687fe988cf9fc2a79a365e705aaaa7580fef6d1e4e8a7ef80f86b8659dc1f865dae48cae69522861406de6dee2ad5148cf2cb3e108340151c9594f3ec5617a
-  data.tar.gz: 36f8235155340ed56731adaff17fc70ee415c4a91c6b1bd76f52f8c1cb5d44a5d0ec233a0a5e6d4bed4cc76a7561bc1096e0727291e71d02803abdb67ee0c7b2
+  metadata.gz: 9b820255232fea158d0d25184ae3597a4a73b664ce2df1a0b8bd520d5b28197c04134bd8a8d5eee0a8f6fe21b546a2c96821daf3e4f7e7ef0446865f49c7eab4
+  data.tar.gz: 7c5f38ac38441ff62a5f03a27d64cd04c662b67b00b98ba6928c8d52e8fe2ed56a3bba744da7b5d806dda475356a74e1c377ffcd41436d305701bb02809155dd

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.1"
+gem 'profiling', "~> 1.2"
 ```
 
 And then execute:
@@ -51,15 +51,15 @@ The next time you call the code it will be profiled and three files will be writ
 
 ## Configuration
 
-Change the directory the files will be generated in:
-
 ```ruby
 Profiler.config = {
-  dir: '/tmp/my-dir'
+  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)
 }
 ```
 
-### Rails Initializer
+## Rails Initializer
 
 This initializer is recommended if you're planning to profile in Rails:
 
@@ -72,7 +72,7 @@ Profiler.config = {
 
 ## Conditional Profiling
 
-Pass an argument `if:` to enable or disable profiling:
+Pass an argument `if:` to enable or disable profiling at run time:
 
 ```ruby
 Profiler.run(if: user.is_admin?) do
@@ -82,7 +82,7 @@ end
 
 ## Preserving artefacts
 
-Every time code is profiled the previous files will be overwritten unless the label's dynamic. To keep old files, you could add the current time in the label so new files are generated with each run:
+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:
 
 ```ruby
 Profiler.run("my-label-#{Time.now.to_i}") do
@@ -90,9 +90,9 @@ Profiler.run("my-label-#{Time.now.to_i}") do
 end
 ```
 
-### Organizing artefacts
+## Organizing artefacts
 
-Labels translate to directories, so use `/` in your labels to group profiling together logically:
+Labels translate to directories, so use `/` in your labels to group artefacts together:
 
 ```ruby
 Profiler.run("post/create") do

data/lib/profiling/configuration.rb

@@ -2,7 +2,9 @@ class Profiler
   module Configuration
 
     DEFAULT_CONFIG = {
-      dir: 'profiling'
+      dir: 'profiling',
+      exclude_gems: true,
+      exclude_standard_lib: false
     }
 
     attr_accessor :config

data/lib/profiling/engine.rb

@@ -11,16 +11,41 @@ class Profiler
 
       require 'ruby-prof'
 
-      RubyProf.start
+      profile = RubyProf::Profile.new
+
+      profile.exclude_methods!(::Profiler::Engine, :run)
+      profile.exclude_common_methods! if config[:exclude_standard_lib]
+      # Note, we optionally exclude ruby gems after collecting the profile results
+      # instead of here as we can't exclude by a path any other way.
+
+      profile.start
 
       begin
         yield
       rescue => e
-        RubyProf.stop
+        profile.stop
         raise e
       end
 
-      @results = RubyProf.stop
+      @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
+        end
+      end
+
       out()
     end
 

data/lib/profiling/version.rb

@@ -1,3 +1,3 @@
 class Profiler
-  VERSION = "1.2.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: profiling
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Luke Duncalfe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2018-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        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'
 email: