stackprof-local 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f8fd54db60e2e426abf0db78d9608b3bdf585b6
+  data.tar.gz: 459fabb83878576063767797e3eebf6b9fd57967
+SHA512:
+  metadata.gz: 01f70ae8bc2a92e540e92250beca18b0d17f1d1b7b0f309bce2b542edd03dccb443826f1a275739e058edf70da61e0d3494c05d967b5f1bc8770113e4d8a7d6f
+  data.tar.gz: 548cc93a366b28c1e9e76e306c6c7e468af3f67135d624a1635a434605f9ef9c27145e335a2ea779c1b2372e3df30fb058c7a821d2b913e6004eeb7436f5a7fc

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Strech (Sergey Fedorov)
+
+MIT License
+
+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,102 @@
+# [stackprof](https://github.com/tmm1/stackprof)-local
+
+This gem inpired by two awesome gems:
+[stackprof](https://github.com/tmm1/stackprof) & [stackprof-remote](https://github.com/quirkey/stackprof-remote).
+
+Unfortunately it's not always comfortable to read dumps on production machine.
+And you want to copy dump on your local machine and read'em carefully in quiet place.
+
+So, what happend if you do so? Something like this:
+
+```bash
+$ stackprof --method Middleware::Runner#call tmp/stackprof/stackprof-wall-14962-1412161559.dump
+Middleware::Runner#call (/home/user/project/shared/bundle/ruby/2.1.0/gems/middleware-0.1.0/lib/middleware/runner.rb:27)
+  samples:     0 self (0.0%)  /   6123 total (70.7%)
+  callers:
+    6123  (  100.0%)  Middleware::Builder#call
+  callees (6123 total):
+    6089  (   99.4%)  ThinkingSphinx::Middlewares::StaleIdFilter#call
+      34  (    0.6%)  ThinkingSphinx::Middlewares::SphinxQL#call
+  code:
+/Users/me/.rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/stackprof-0.2.7/lib/stackprof/report.rb:347:in `readlines':
+No such file or directory @ rb_sysopen - /home/user/project/shared/bundle/ruby/2.1.0/gems/middleware-0.1.0/lib/middleware/runner.rb (Errno::ENOENT)
+	from /Users/me/.rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/stackprof-0.2.7/lib/stackprof/report.rb:347:in `source_display'
+	from /Users/me/.rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/stackprof-0.2.7/lib/stackprof/report.rb:265:in `block in print_method'
+	from /Users/me/.rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/stackprof-0.2.7/lib/stackprof/report.rb:238:in `each'
+	from /Users/me/.rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/stackprof-0.2.7/lib/stackprof/report.rb:238:in `print_method'
+	from /Users/me/.rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems/stackprof-0.2.7/bin/stackprof:62:in `<top (required)>'
+	from /Users/me/.rbenv/versions/2.1.2/bin/stackprof:23:in `load'
+	from /Users/me/.rbenv/versions/2.1.2/bin/stackprof:23:in `<main>'
+```
+
+Because dump was made on another machine with another gems path and project path.
+
+## Usage
+
+Project specific configuration options stored in project root folder in `.stackprof-local` file,
+and it's looks like `.rspec` configuration file
+
+```
+$ cat /path/to/project/.stackprof-local
+--remote-gems /home/user/project/shared/bundle/ruby/2.1.0/gems
+--remote-project /home/user/project/releases/20141001101534
+--local-gems /Users/me/.rbenv/versions/2.1.2/lib/ruby/gems/2.1.0/gems
+--local-project /Users/me/Development/project
+```
+
+stackprof-local provides an interactive pry-based [cli-utility](https://github.com/quirkey/stackprof-remote#cli)
+taken from stackprof-remote
+
+```
+$ stackprof-local-cli tmp/stackprof/stackprof-wall-14962-1412161559.dump
+stackprof> method Middleware::Runner#call
+Middleware::Runner#call (/home/user/project/shared/bundle/ruby/2.1.0/gems/middleware-0.1.0/lib/middleware/runner.rb:27)
+  samples:     0 self (0.0%)  /   6123 total (70.7%)
+  callers:
+    6123  (  100.0%)  Middleware::Builder#call
+  callees (6123 total):
+    6089  (   99.4%)  ThinkingSphinx::Middlewares::StaleIdFilter#call
+      34  (    0.6%)  ThinkingSphinx::Middlewares::SphinxQL#call
+  code:
+            |     1  | module Middleware
+            |     2  |   # This is a basic runner for middleware stacks. This runner does
+            |     3  |   # the default expected behavior of running the middleware stacks
+            |     4  |   # in order, then reversing the order.
+            |     5  |   class Runner
+            |     6  |     # A middleware which does nothing
+            |     7  |     EMPTY_MIDDLEWARE = lambda { |env| }
+            |     8  |
+            |     9  |     # Build a new middleware runner with the given middleware
+            |    10  |     # stack.
+  ...
+```
+
+All of configuration options are available as cli arguments and will override file defined options
+
+```
+$ stackprof-local-cli --remote-gems '/path/to/gems' tmp/stackprof/stackprof-wall-14962-1412161559.dump
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stackprof-local'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stackprof-local
+
+## Contributing
+
+1. Fork it ( https://github.com/Strech/stackprof-local/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/stackprof-local-cli

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "stackprof/cli"
+require "stackprof/local"
+
+StackProf::Local.configure(ARGV)
+StackProf::CLI.start(ARGV.shift)

data/lib/stackprof/local.rb

@@ -0,0 +1,33 @@
+require "stackprof/local/version"
+require "stackprof/local/configuration"
+require "stackprof/local/source_display"
+
+module StackProf
+  module Local
+    extend self
+
+    attr_reader :configuration
+
+    def configure(args)
+      @configuration = Configuration.new(args)
+    end
+
+    def localize(file)
+      if file.include?(configuration.remote_gems)
+        to_local_gems(file)
+      else
+        to_local_project(file)
+      end
+    end
+
+    private
+
+    def to_local_gems(file)
+      file.sub(configuration.remote_gems, configuration.local_gems)
+    end
+
+    def to_local_project(file)
+      file.sub(configuration.remote_project, configuration.local_project)
+    end
+  end
+end

data/lib/stackprof/local/configuration.rb

@@ -0,0 +1,40 @@
+require 'erb'
+require 'optparse'
+require 'shellwords'
+
+module StackProf
+  module Local
+    class Configuration
+      OPTIONS_FILE = ".stackprof-local".freeze
+      ERB_EOUTVAR = "-".freeze
+
+      attr_reader :local_gems, :local_project
+      attr_reader :remote_gems, :remote_project
+
+      def initialize(args)
+        parser.parse!(args_from_options_file)
+        parser.parse!(args)
+      end
+
+      private
+
+      def parser
+        OptionParser.new do |parser|
+          parser.on('--remote-gems PATH', String) { |path| @remote_gems = path }
+          parser.on('--remote-project PATH', String) { |path| @remote_project = path }
+          parser.on('--local-gems PATH', String) { |path| @local_gems = path }
+          parser.on('--local-project PATH', String) { |path| @local_project = path }
+        end
+      end
+
+      def args_from_options_file
+        return [] unless File.exist?(OPTIONS_FILE)
+        options_file_as_erb_string(OPTIONS_FILE).split(/\n+/).flat_map(&:shellsplit)
+      end
+
+      def options_file_as_erb_string(path)
+        ERB.new(File.read(path), nil, ERB_EOUTVAR).result(binding)
+      end
+    end
+  end
+end

data/lib/stackprof/local/source_display.rb

@@ -0,0 +1,13 @@
+require "stackprof/report"
+
+module StackProf
+  module Local
+    module SourceDisplay
+      def source_display(f, file, lines, range = nil)
+        super(f, Local.localize(file), lines, range = nil)
+      end
+    end
+  end
+end
+
+StackProf::Report.prepend(StackProf::Local::SourceDisplay)

data/lib/stackprof/local/version.rb

@@ -0,0 +1,5 @@
+module Stackprof
+  module Local
+    VERSION = "0.0.1".freeze
+  end
+end

data/stackprof-local.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stackprof/local/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stackprof-local"
+  spec.version       = Stackprof::Local::VERSION
+  spec.authors       = ["Strech (Sergey Fedorov)"]
+  spec.email         = ["strech_ftf@mail.ru"]
+  spec.summary       = "Read stackprof dumps localy"
+  spec.description   = "Allow read stackprof dump from remote machine on your local machine"
+  spec.homepage      = "https://github.com/Strech/stackprof-local"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "stackprof", "= 0.2.7"
+  spec.add_dependency "stackprof-remote", "~> 0.0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: stackprof-local
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Strech (Sergey Fedorov)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stackprof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.7
+- !ruby/object:Gem::Dependency
+  name: stackprof-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Allow read stackprof dump from remote machine on your local machine
+email:
+- strech_ftf@mail.ru
+executables:
+- stackprof-local-cli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/stackprof-local-cli
+- lib/stackprof/local.rb
+- lib/stackprof/local/configuration.rb
+- lib/stackprof/local/source_display.rb
+- lib/stackprof/local/version.rb
+- stackprof-local.gemspec
+homepage: https://github.com/Strech/stackprof-local
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Read stackprof dumps localy
+test_files: []