profiling 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1c0b6ad469919343bcbb11bdb711f0096050ad2
+  data.tar.gz: 5b61bf891faa8172ea003dbdd8a77d9c47409c8c
+SHA512:
+  metadata.gz: df3dabf3d0884f20f400960d20cc3740499b67cb421bf249323c10befd11a5c519a63dd027787194c7ae127cea75490bd1657ad99ae7648f39e30a29f83c48a2
+  data.tar.gz: ec771cde630858097e2031f7d0bdba8b0eedf0324c874c36a131e3516c5e24b604803bc6e2a740bc97705427f48872dfacfec729baf8ad6fc98fbf7f9b172d99

data/LICENCE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Luke Duncalfe
+
+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,108 @@
+![alt ruby_silhouette](https://raw.githubusercontent.com/lukes/profiling/master/img/ruby.png)
+
+# Profiling
+
+Non-discriminatory profiling for your MRI Ruby code. This gem is a small wrapper around the [ruby-prof](https://github.com/ruby-prof/ruby-prof) gem, which is its only dependency. It lets you do simple but powerful profiling of your friend's bad code.
+
+[![Gem Version](https://badge.fury.io/rb/profiling.svg)](https://badge.fury.io/rb/profiling)
+[![CircleCI](https://circleci.com/gh/lukes/profiling/tree/master.svg?style=shield)](https://circleci.com/gh/lukes/profiling/tree/master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'profiling', "~> 1.1"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install profiling
+
+## Getting Started
+
+Profile slow code from your friend or colleague like this:
+
+```ruby
+Profiling.run do
+  # Slow code here...
+end
+
+# or
+
+Profiling.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`:
+
+| File | Description |
+| ------------- | ------------- |
+| `graph.html` | Drill down into the call tree to see where the time is spent |
+| `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
+
+Change the directory the files will be generated in:
+
+```ruby
+Profiling.config = {
+  dir: '/tmp/my-dir'
+}
+```
+
+## Conditional Profiling
+
+Pass an argument `if:` to enable or disable profiling:
+
+```ruby
+Profiling.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
+  # Slow code here...
+end
+```
+
+## Organizing artefacts
+
+Labels translate to directories, so use `/` in your labels if you want to group profiling together logically:
+
+```ruby
+# Files will be in `profiling/post/create`
+Profiling.run("post/create") do
+  # Slow code here...
+end
+
+# Files will be in `profiling/post/update`
+Profiling.run("post/update") do
+  # Slow code here...
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+To run the test suite:
+
+    bundle exec rspec
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/profiling/configuration.rb

@@ -0,0 +1,18 @@
+class Profiling
+  module Configuration
+
+    DEFAULT_CONFIG = {
+      dir: 'profiling'
+    }
+
+    attr_accessor :config
+
+    def self.extended(mod)
+      mod.config = DEFAULT_CONFIG
+    end
+
+    def configure(opts)
+      self.config = DEFAULT_CONFIG.merge(opts)
+    end
+  end
+end

data/lib/profiling/version.rb

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

data/lib/profiling.rb

@@ -0,0 +1,44 @@
+require 'fileutils'
+require 'ostruct'
+
+Dir[File.dirname(__FILE__) + '/profiling/*.rb'].each { |file| require file }
+
+class Profiling
+  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
+
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: profiling
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Luke Duncalfe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: 'Non-discriminatory Ruby code profiling: This gem is a small wrapper
+  around the ruby-prof gem to do simple but powerful profiling'
+email:
+- lduncalfe@eml.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENCE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/profiling.rb
+- lib/profiling/configuration.rb
+- lib/profiling/version.rb
+homepage: https://github.com/lukes/profiling
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+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.2.2
+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'
+test_files: []