exception_search 0.1.0

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@exception_search

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    exception_search (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    columnize (0.3.6)
+    debugger (1.3.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.7)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.7)
+    diff-lcs (1.1.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  exception_search!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dan Rodriguez
+
+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,45 @@
+# ExceptionSearch
+
+We all do it. You get some weird exception and you're clueless. So what do you do? Well, copy-paste into Google of course!
+
+So the idea came to me to save a couple seconds by including a link right to Google and Stack Overflow from a backtrace. That's what this gem does.
+
+Currently the gem integrates with Rspec, but I'm planning on adding support for more third party libraries when it makes sense.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exception_search'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exception_search
+
+
+## Usage
+
+Just install the gem and everything should work. When you get a failure from some exception in your Rspec tests, it will output a couple links that lead
+directly to search results for your error message.
+
+In order for the link to open your browser, it depends on your terminal application.
+On the Mac OSX "Terminal" app, you can visit a link by cmd-clicking on the url.
+You may have to figure out how to make the link open your browser from other terminal applications.
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+I just started this gem on a whim, and obviously it's very basic so far.
+If you have any great ideas for it please try your hand at editing. It shouldn't be too hard given how young the project is.
+I think there's a lot of ways through configuration etc, that this can be improved.

data/Rakefile

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

data/exception_search.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exception_search/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "exception_search"
+  gem.version       = ExceptionSearch::VERSION
+  gem.authors       = ["Dan Rodriguez"]
+  gem.email         = ["dan@danrodriguez.me"]
+  gem.description   = %q{Stuck on a weird exception? Save a few seconds by linking right to the search results}
+  gem.summary       = %q{Stuck on a weird exception? Save a few seconds by linking right to the search results}
+  gem.homepage      = "https://github.com/operand/exception_search"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/exception_search/exception.rb

@@ -0,0 +1,12 @@
+require 'open-uri'
+
+# Extends the base exception class with methods to display links to search results
+class Exception
+  def to_google
+    "https://www.google.com/search?q=#{URI::encode(message)}"
+  end
+
+  def to_stackoverflow
+    "http://stackoverflow.com/search?q=#{URI::encode(message)}"
+  end
+end

data/lib/exception_search/rspec.rb

@@ -0,0 +1,36 @@
+module RSpec
+  module Core
+    module Formatters
+      class BaseTextFormatter < BaseFormatter
+
+        alias_method :dump_backtrace_original, :dump_backtrace
+
+        private
+        
+        def dump_backtrace(example)
+          output.puts format_links(example)
+
+          dump_backtrace_original(example)
+        end
+
+        def format_links(example)
+          exception = example.execution_result[:exception]
+          "
+          Search for this exception online: (#{link_instructions}) 
+          #{short_padding} google: \t#{exception.to_google}
+          #{short_padding} stackoverflow: \t#{exception.to_stackoverflow}
+          "
+        end
+
+        def link_instructions
+          if RUBY_PLATFORM =~ /darwin/i
+            "cmd-click to open results in your browser"
+          else
+            "right-click to open results in your browser"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/exception_search/version.rb

@@ -0,0 +1,3 @@
+module ExceptionSearch
+  VERSION = "0.1.0"
+end

data/lib/exception_search.rb

@@ -0,0 +1,3 @@
+require "exception_search/version"
+require "exception_search/exception"
+require "exception_search/rspec" if defined? RSpec

data/spec/lib/exception_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Exception do
+  subject { Exception.new }
+  describe "#to_google" do
+    it "should link to the google results" do
+      subject.to_google.should == "https://www.google.com/search?q=#{subject.message}"
+    end
+  end
+  describe "#to_stackoverflow" do
+    it "should link to the stackoverflow results" do
+      subject.to_stackoverflow.should == "http://stackoverflow.com/search?q=#{subject.message}"
+    end
+  end
+end

data/spec/lib/rspec_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe RSpec::Core::Formatters::BaseTextFormatter do
+  before do
+    @formatter = RSpec::Core::Formatters::BaseTextFormatter.new(nil)
+
+    exception = Exception.new("message")
+    exception.set_backtrace([])
+
+    @mock_example = mock(:example)
+    @mock_example.stub(:execution_result).and_return({:exception => exception})
+    @mock_example.stub(:metadata).and_return({})
+  end
+
+
+  describe "#dump_backtrace" do
+    it "should call format_links" do
+      @formatter.should_receive(:format_links)
+      me = @mock_example # seems like we need a closure here
+      @formatter.instance_eval{ dump_backtrace(me) }
+    end
+  end
+
+  describe "#format_links" do
+    it "should include the links when a backtrace is printed" do
+      me = @mock_example # seems like we need a closure here
+      result = @formatter.instance_eval{ format_links(me) }
+      result.should include("https://www.google.com/search?q=message")
+      result.should include("http://stackoverflow.com/search?q=message")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'exception_search'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: exception_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dan Rodriguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-04 00:00:00.000000000 Z
+dependencies: []
+description: Stuck on a weird exception? Save a few seconds by linking right to the
+  search results
+email:
+- dan@danrodriguez.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exception_search.gemspec
+- lib/exception_search.rb
+- lib/exception_search/exception.rb
+- lib/exception_search/rspec.rb
+- lib/exception_search/version.rb
+- spec/lib/exception_spec.rb
+- spec/lib/rspec_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/operand/exception_search
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Stuck on a weird exception? Save a few seconds by linking right to the search
+  results
+test_files:
+- spec/lib/exception_spec.rb
+- spec/lib/rspec_spec.rb
+- spec/spec_helper.rb