profiling 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cfec5331ddecfe74e80d46d6f222741538e5874
-  data.tar.gz: 460a9384930e56eaa3f6d513a1b7ab650bb0f008
+  metadata.gz: dcebc905bbf17f65a9569c5c3517381ab8f976ae
+  data.tar.gz: 9156e9ccc5ae1f19772337cd53789d3e1bc421a3
 SHA512:
-  metadata.gz: ad10718ef797fef7522e6b8de5c8931e4bfdbbaaee48f79d74f679abe8d8fcd20fa926457ca9626dab7e0b4894855891b3ee61fea2497c84363588efc2260eda
-  data.tar.gz: ebe9c9f9d0b302f27c07a0b9cf9659f88f8e529901abdbf9f8f9a1a4fc0f940c2c82cb3ec032a36df9aceca6e1eecf71aaf6fbcbd308368c443957ba27bc7aca
+  metadata.gz: ce32170eb1c1776886d720bf7a0495c393bb7ab7bdc597a233d7c19f804294773acf9dcb5fb6ebecbc0645a99c3e03520a0a26a39615ff4595e17652dd5a8e5f
+  data.tar.gz: 1162eff56e9deaca226d8be89144d24e136426e44c1fe11135bbb0a15060f0a750a92fab53fbbef11ef99eafbabb6ce22d2504c4f2dfc5b639009e59444ca56a

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', "~> 2.1"
+gem 'profiling', "~> 2.2"
 ```
 
 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/lib/profiling/configuration.rb

@@ -3,7 +3,7 @@ class Profiler
 
     DEFAULT_CONFIG = {
       dir: 'profiling',
-      exclude_gems: true,
+      exclude_gems: false,
       exclude_standard_lib: false
     }
 

data/lib/profiling/engine.rb

@@ -1,8 +1,10 @@
 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
@@ -32,11 +34,7 @@ class Profiler
       # Optionally remove gems from the results
       if !@results.threads.empty? && config[:exclude_gems]
         @results.threads.each do |thread|
-          thread.methods.each do |method|
-            if method.source_file.match(/\/gems\//)
-              method.eliminate!
-            end
-          end
+          thread.methods.each { |m| m.eliminate! if m.source_file.match(/\/gems\//) }
         end
       end
 

data/lib/profiling/version.rb

@@ -1,3 +1,3 @@
 class Profiler
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: profiling
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Luke Duncalfe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2018-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: 'Non-discriminatory Ruby code profiling: This gem is a small wrapper around