rspec-stackprof 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b1ad7123082f5318dab44316eb3f20dddc21c47
+  data.tar.gz: 8c6a524925d10092467ac4d5cc11c6949279ac51
+SHA512:
+  metadata.gz: b1d615940d4a517670fcdf759818e0685be828f0652ff54752201770d3eb1fe292ec47674b456cde3676cf770886bc378734c6f98d0bbcb77d13f557034a9fb7
+  data.tar.gz: 017a37426f787d66e5f5a76391de2c6f43fa55b3aacf2e7b95746648b900a31b78f550988b4756d8d75f2684cc14a9363aafa6f9cb774de73c1fa0c13f55ef3b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/tags

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-stackprof.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Devinder Khroad
+
+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,128 @@
+# RSpec::StackProf
+
+Provides a convenient way to profile your specs using [stackprof](https://github.com/tmm1/stackprof) gem by
+integrating stackprof gem with your RSpec setup.
+
+Specs can be profiled at suite level or indvidually.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-stackprof'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-stackprof
+
+## Usage
+
+Profiling can be enabled by setting environment variable `RSPEC_STACKPROF` while running `rspec` command.
+1. To profile the whole test suite, set `RSPEC_STACKPROF` variable to `all` while running the command to 
+invoke `rspec`.
+
+  Example:
+
+  ```
+  RSPEC_STACKPROF=all rspec ...
+  ```
+  
+  profiled output is stored in `./tmp/stackprof_<pid>_<timestamp>.out`. 
+
+2. To profile each test individually, set `RSPEC_STACKPROF` environment variable to `each`
+
+  Example:
+
+  ```
+  RSPEC_STACKPROF=each rspec ..
+  ```
+  profiled output is stored individually for each rspec example. A unique filename is constructed 
+  by examining spec metadata. A sub directory is created for each 'describe' and 'context' block  
+
+  For example, given a spec like:
+
+  ```
+     describe "main context" do 
+       ..
+       context "primary context" do 
+       .. 
+         it "does something" do 
+         end
+       end 
+     end
+  ```
+  The profiled data will be stored at the following path:
+  ```
+  ./tmp/main_context/primary_context/does_something.<pid>.<timestamp>.out
+  ```
+
+### Configuration
+
+You can configure following parameters for this gem.
+
+* out_dir 
+
+  directory location where profile data will be stored. When using `RSPEC_STACKPROF=each` option,
+  subdirectories will be created under this dir
+
+* out_file
+
+  filename where profile results is stored when using `RSPEC_STACKPROF=all` option.
+
+
+In addition, you can configure all Stackprof parameters (`mode`, `interval`, 'agregate`, `raw`) as well. 
+
+Add a file `spec/support/rspec_stackprof.rb` and add/change configuration parameters. For example:
+
+``` 
+RSpec::StackProf.configure do |config|
+  config.out_dir = '/tmp/profiles'
+  config.mode = :wall 
+  config.interval = 500
+end
+```
+See [stackprof](https://github.com/tmm1/stackprof) readme to learn about stackprof usage.
+
+### Generating Flamegraphs
+
+Set the option `raw` to true
+
+```
+RSpec::StackProf.configure do |config|
+  config.raw = true
+end 
+```
+
+After profiling, run the following stackprof commands:
+
+```
+stackprof --stackcollapse tmp/stackprof.out > tmp/stackprof_collapsed.out
+stackprof-flamegraph.pl tmp/stackprof_collapsed.out > tmp/stackprof_collapsed.svg
+```
+
+Open the svg file in a browser to view the visual representation of your profiled data. 
+Flamegraphs are extremely useful. If you are unfamiliar with flamegraphs, checkout [Brendan Gregg's site](http://www.brendangregg.com/flamegraphs.html) to learn more about flamegraphs 
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec-stackprof. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/stackprof"
+
+# 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

data/bin/setup

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

data/lib/rspec/stackprof.rb

@@ -0,0 +1,38 @@
+require "rspec/stackprof/version"
+require 'ostruct'
+require 'fileutils'
+require 'stackprof'
+require 'rspec/stackprof/filename_helpers'
+require 'rspec/stackprof/rspec.rb'
+
+module RSpec
+  class StackProf 
+    extend FilenameHelpers
+
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configuration 
+      @configuration ||=  ::OpenStruct.new(
+        out_dir: 'tmp',
+        out_file: 'stackprof.out',
+      )
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.reset
+      @configuration = nil
+    end
+
+    def self.options 
+      create_missing_dirs
+      file=create_unique_file_name 
+      dirname = File.dirname(File.join(output_dir,output_file))
+      {out: File.join(dirname,file)}.merge(configuration.to_h)
+    end
+  end
+end

data/lib/rspec/stackprof/filename_helpers.rb

@@ -0,0 +1,61 @@
+module RSpec
+  class StackProf
+    module FilenameHelpers
+
+      def output_dir
+        RSpec::StackProf.configuration.out_dir
+      end
+
+      def output_file
+        RSpec::StackProf.configuration.out_file
+      end
+
+      def file_extension
+        ext = File.extname(RSpec::StackProf.configuration.out_file)
+        return  ".out" if ext.length == 0
+        return ext
+      end
+
+      def file_basename
+        File.basename(RSpec::StackProf.configuration.out_file,".*")
+      end
+
+      def file_dirname
+        File.dirname(RSpec::StackProf.configuration.out_file)
+      end
+
+      def path_for metadata
+        if metadata[:parent_example_group]
+          File.join(path_for(metadata[:parent_example_group]), metadata[:description])
+        else
+          metadata[:description]
+        end
+      end
+
+      def uniqueness 
+        "#{Process.pid}_#{Time.now.to_i}"
+      end
+
+      def create_missing_dirs
+        dirname = File.dirname(File.join(output_dir,output_file))
+        FileUtils.mkdir_p(dirname)
+      end
+
+      def create_unique_file_name 
+        "#{file_basename}_#{uniqueness}#{file_extension}"
+      end
+
+      def filename_for example
+        require 'pry'
+        raise "No example specified" if example.nil? 
+        path = path_for(example.metadata[:example_group])
+        line_number = example.metadata[:line_number].to_s
+        description = example.metadata[:description]
+        File.join(
+          path,
+          description
+        ).gsub(/\s+/, '_') + ":" + line_number 
+      end
+    end
+  end
+end

data/lib/rspec/stackprof/rspec.rb

@@ -0,0 +1,28 @@
+RSpec.configure do |config|
+  
+  config.before(:suite) do
+    unless ['all', 'each', ''].include?(ENV['RSPEC_STACKPROF'].to_s)
+      raise "ENV['RSPEC_STACKPROF'] should be blank, 'all' or 'each', but was '#{ENV['RSPEC_STACKPROF']}'"
+    end
+
+    if ENV['RSPEC_STACKPROF'] == 'all'
+      StackProf.start RSpec::StackProf.options
+    end
+  end
+
+  config.after(:suite) do
+    if ENV['RSPEC_STACKPROF'] == 'all'
+      StackProf.stop 
+      StackProf.results
+    end
+  end
+
+  config.around(:each) do |example|
+    if ENV['RSPEC_STACKPROF'] == 'each'
+      RSpec::StackProf.configuration.out_file = RSpec::StackProf::filename_for(example)
+      StackProf.run(RSpec::StackProf.options) { example.call }
+    else
+      example.call
+    end
+  end
+end

data/lib/rspec/stackprof/version.rb

@@ -0,0 +1,6 @@
+module RSpec
+  class StackProf
+    VERSION = "0.1.0"
+  end
+end
+

data/rspec-stackprof.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/stackprof/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-stackprof"
+  spec.version       = RSpec::StackProf::VERSION
+  spec.authors       = ["Devinder Khroad"]
+  spec.email         = ["dkhroad@gmail.com"]
+
+  spec.summary       = %q{Profile your RSpec examples using stackprof gem}
+  spec.description   = %q{Add profiling hooks to use stackprof gem in a RSpec suit}
+  spec.homepage      = "https://github.com/dkhroad/rspec-stackprof"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "pry-stack_explorer"
+  spec.add_runtime_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'stackprof'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: rspec-stackprof
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Devinder Khroad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: pry-byebug
+  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: pry-doc
+  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: pry-stack_explorer
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: stackprof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add profiling hooks to use stackprof gem in a RSpec suit
+email:
+- dkhroad@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/stackprof.rb
+- lib/rspec/stackprof/filename_helpers.rb
+- lib/rspec/stackprof/rspec.rb
+- lib/rspec/stackprof/version.rb
+- rspec-stackprof.gemspec
+homepage: https://github.com/dkhroad/rspec-stackprof
+licenses:
+- MIT
+metadata: {}
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Profile your RSpec examples using stackprof gem
+test_files: []
+has_rdoc: