profiling 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1c0b6ad469919343bcbb11bdb711f0096050ad2
-  data.tar.gz: 5b61bf891faa8172ea003dbdd8a77d9c47409c8c
+  metadata.gz: f20b2a353b190c5e2dd6dcdc5c9bd790ff1cb6b7
+  data.tar.gz: 947bd73fe763e35f8f90c57f164f6716e0bb2a8d
 SHA512:
-  metadata.gz: df3dabf3d0884f20f400960d20cc3740499b67cb421bf249323c10befd11a5c519a63dd027787194c7ae127cea75490bd1657ad99ae7648f39e30a29f83c48a2
-  data.tar.gz: ec771cde630858097e2031f7d0bdba8b0eedf0324c874c36a131e3516c5e24b604803bc6e2a740bc97705427f48872dfacfec729baf8ad6fc98fbf7f9b172d99
+  metadata.gz: 1c687fe988cf9fc2a79a365e705aaaa7580fef6d1e4e8a7ef80f86b8659dc1f865dae48cae69522861406de6dee2ad5148cf2cb3e108340151c9594f3ec5617a
+  data.tar.gz: 36f8235155340ed56731adaff17fc70ee415c4a91c6b1bd76f52f8c1cb5d44a5d0ec233a0a5e6d4bed4cc76a7561bc1096e0727291e71d02803abdb67ee0c7b2

data/README.md

@@ -28,18 +28,20 @@ Or install it yourself as:
 Profile slow code from your friend or colleague like this:
 
 ```ruby
-Profiling.run do
+Profiler.run do
   # Slow code here...
 end
 
 # or
 
-Profiling.run("some-label") do
+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 `profiling`, and in the second example `profiling/some-label`.
+
+### Files Generated
 
 | File | Description |
 | ------------- | ------------- |
@@ -52,45 +54,52 @@ The next time you call the code it will be profiled and three files will be writ
 Change the directory the files will be generated in:
 
 ```ruby
-Profiling.config = {
+Profiler.config = {
   dir: '/tmp/my-dir'
 }
 ```
 
+### Rails Initializer
+
+This initializer is recommended if you're planning to profile in Rails:
+
+```ruby
+# config/initializer/profiling.rb
+Profiler.config = {
+  dir: Rails.root.join('tmp/profiling')
+}
+```
+
 ## Conditional Profiling
 
 Pass an argument `if:` to enable or disable profiling:
 
 ```ruby
-Profiling.run(if: user.is_admin?) do
+Profiler.run(if: user.is_admin?) do
   # Slow code here...
 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:
 
 ```ruby
-# Files will be in `profiling/my-label-1524132842`
-Profiling.run("my-label-#{Time.now.to_i}") do
+Profiler.run("my-label-#{Time.now.to_i}") do
   # Slow code here...
 end
 ```
 
-## Organizing artefacts
+### Organizing artefacts
 
-Labels translate to directories, so use `/` in your labels if you want to group profiling together logically:
+Labels translate to directories, so use `/` in your labels to group profiling together logically:
 
 ```ruby
-# Files will be in `profiling/post/create`
-Profiling.run("post/create") do
+Profiler.run("post/create") do
   # Slow code here...
 end
 
-# Files will be in `profiling/post/update`
-Profiling.run("post/update") do
+Profiler.run("post/update") do
   # Slow code here...
 end
 ```

data/lib/profiling/configuration.rb

@@ -1,4 +1,4 @@
-class Profiling
+class Profiler
   module Configuration
 
     DEFAULT_CONFIG = {

data/lib/profiling/engine.rb

@@ -0,0 +1,44 @@
+class Profiler
+  module Engine
+
+    def run(label=nil, options={})
+      enabled = options[:if].nil? ? true : !!options[:if]
+      return yield unless enabled
+
+      # Create directory
+      @dir = File.join(config[:dir], label.to_s)
+      FileUtils.mkdir_p(@dir) unless File.exist?(@dir)
+
+      require 'ruby-prof'
+
+      RubyProf.start
+
+      begin
+        yield
+      rescue => e
+        RubyProf.stop
+        raise e
+      end
+
+      @results = RubyProf.stop
+      out()
+    end
+
+    private
+
+    def out
+      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)
+      end
+
+      File.open(File.join(@dir, "stack.html"), 'w') do |file|
+        RubyProf::CallStackPrinter.new(@results).print(file)
+      end
+    end
+
+  end
+end

data/lib/profiling/version.rb

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

data/lib/profiling.rb

@@ -3,42 +3,7 @@ require 'ostruct'
 
 Dir[File.dirname(__FILE__) + '/profiling/*.rb'].each { |file| require file }
 
-class Profiling
+class Profiler
   extend Configuration
-
-  def self.run(label='', options={})
-    enabled = options[:if].nil? ? true : !!options[:if]
-
-    return yield unless enabled
-
-    # Create directory
-    subdir = File.join(config[:dir], label)
-    FileUtils.mkdir_p subdir unless File.exist? subdir
-
-    require 'ruby-prof'
-
-    RubyProf.start
-
-    begin
-      yield
-    rescue => e
-      RubyProf.stop
-      raise e
-    end
-
-    results = RubyProf.stop
-
-    File.open(File.join(subdir, "graph.html"), 'w') do |file|
-      RubyProf::GraphHtmlPrinter.new(results).print(file)
-    end
-
-    File.open(File.join(subdir, "flat.txt"), 'w') do |file|
-      RubyProf::FlatPrinterWithLineNumbers.new(results).print(file)
-    end
-
-    File.open(File.join(subdir, "stack.html"), 'w') do |file|
-      RubyProf::CallStackPrinter.new(results).print(file)
-    end
-  end
-
+  extend Engine
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: profiling
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Luke Duncalfe
@@ -122,6 +122,7 @@ files:
 - bin/setup
 - lib/profiling.rb
 - lib/profiling/configuration.rb
+- lib/profiling/engine.rb
 - lib/profiling/version.rb
 homepage: https://github.com/lukes/profiling
 licenses:
@@ -136,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -144,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: 'Non-discriminatory Ruby code profiling: This gem is a small wrapper around