codeclimate-test-reporter 0.0.7 → 0.0.8

data/README.md

@@ -3,8 +3,6 @@
 Collects test coverage data from your Ruby test suite and sends it to Code
 Climate's hosted, automated code review service. Based on SimpleCov.
 
-**Note:** Code Climate's test coverage functionality is currently in private beta. If you are interested in volunteering for the beta, please contact us at hello@codeclimate.com .
-
 Code Climate - [https://codeclimate.com](https://codeclimate.com)
 
 ## Installation
@@ -30,9 +28,30 @@ Code Climate account if you are in the test coverage private beta.
 
 Please contact hello@codeclimate.com if you need any assistance setting this up.
 
+## Help! Your gem is raising a ...
+
+### VCR::Errors::UnhandledHTTPRequestError
+
+Add the following to your spec or test helper:
+
+        VCR.configure do |config|
+          # your existing configuration
+          config.ignore_hosts 'codeclimate.com'
+        end
+
+### WebMock::NetConnectNotAllowedError
+
+Add the following to your spec or test helper:
+
+        WebMock.disable_net_connect!(:allow => "codeclimate.com")
+
+### Other communication failures
+
+If you are using a web stubbing library similar to VCR or WebMock which prevent external requests during test runs, you will need configure these libraries to allow Code Climate to make external requests.
+
 ## Contributions
 
-Patches, bug fixed, feature requests, and pull requests are welcome on the
+Patches, bug fixes, feature requests, and pull requests are welcome on the
 GitHub page for this project: [https://github.com/codeclimate/ruby-test-reporter](https://github.com/codeclimate/ruby-test-reporter)
 
 This gem is maintained by Bryan Helmkamp (bryan@codeclimate.com).

data/lib/code_climate/test_reporter.rb

@@ -1,6 +1,6 @@
 module CodeClimate
   module TestReporter
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
 
     def self.start
       if run?

data/lib/code_climate/test_reporter/exception_message.rb

@@ -0,0 +1,72 @@
+module CodeClimate
+  module TestReporter
+
+    class WebMockMessage
+      def library_name
+        "WebMock"
+      end
+
+      def instructions
+      <<-STR
+  WebMock.disable_net_connect!(:allow => "codeclimate.com")
+STR
+      end
+    end
+
+    class VCRMessage
+      def library_name
+        "VCR"
+      end
+
+      def instructions
+      <<-STR
+  VCR.configure do |config|
+    # your existing configuration
+    config.ignore_hosts 'codeclimate.com'
+  end
+STR
+      end
+    end
+
+    class ExceptionMessage
+
+      HTTP_STUBBING_MESSAGES = {
+        "VCR::Errors::UnhandledHTTPRequestError" => VCRMessage,
+        "WebMock::NetConnectNotAllowedError"     => WebMockMessage
+      }
+
+      def initialize(exception)
+        @exception = exception
+      end
+
+      def message
+        parts = []
+        parts << "Code Climate encountered an exception: #{exception_class}"
+        if http_stubbing_exception
+          message = http_stubbing_exception.new
+          parts << "======"
+          parts << "Hey! Looks like you are using #{message.library_name}, which will prevent the codeclimate-test-reporter from reporting results to codeclimate.com.
+Add the following to your spec or test helper to ensure codeclimate-test-reporter can post coverage results:"
+          parts << "\n" + message.instructions + "\n"
+          parts << "======"
+        else
+          parts << @exception.message
+          @exception.backtrace.each do |line|
+            parts << line
+          end
+        end
+        parts.join("\n")
+      end
+
+    private
+
+      def exception_class
+        @exception.class.to_s
+      end
+
+      def http_stubbing_exception
+        HTTP_STUBBING_MESSAGES[exception_class]
+      end
+    end
+  end
+end

data/lib/code_climate/test_reporter/formatter.rb

@@ -3,6 +3,8 @@ require "securerandom"
 require "json"
 require "digest/sha1"
 
+require "code_climate/test_reporter/exception_message"
+
 module CodeClimate
   module TestReporter
     class Formatter
@@ -23,11 +25,7 @@ module CodeClimate
         puts "done."
         true
       rescue => ex
-        puts "\nCode Climate encountered an exception: #{ex.class}"
-        puts ex.message
-        ex.backtrace.each do |line|
-          puts line
-        end
+        puts ExceptionMessage.new(ex).message
         false
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate-test-reporter
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2013-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -84,6 +84,7 @@ files:
 - config/cacert.pem
 - lib/code_climate/test_reporter.rb
 - lib/code_climate/test_reporter/client.rb
+- lib/code_climate/test_reporter/exception_message.rb
 - lib/code_climate/test_reporter/formatter.rb
 - lib/codeclimate-test-reporter.rb
 - spec/spec_helper.rb
@@ -99,12 +100,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1626756073592550820
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1626756073592550820
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -113,4 +120,3 @@ specification_version: 3
 summary: Uploads Ruby test coverage data to Code Climate.
 test_files:
 - spec/spec_helper.rb
-has_rdoc: