Merge pull request #2080 from segiddins/remove-local-path-from-ticket-search-url

Try to detect and remove local paths from error messages when generating...

lib/cocoapods/user_interface/error_report.rb

@@ -45,7 +45,7 @@ Repositories : #{repo_information.join("\n               ")}
 #{'[!] Oh no, an error occurred.'.red}
 #{error_from_podfile(exception)}
 #{'Search for existing github issues similar to yours:'.yellow}
-#{"https://github.com/CocoaPods/CocoaPods/search?q=#{CGI.escape(exception.message)}&type=Issues"}
+#{issues_url(exception)}
 
 #{'If none exists, create a ticket, with the template displayed above, on:'.yellow}
 https://github.com/CocoaPods/CocoaPods/issues/new
@@ -57,6 +57,10 @@ EOS
 
         private
 
+        def pathless_exception_message(message)
+          message.gsub(/- \(.*\):/, '-')
+        end
+
         def markdown_podfile
           return '' unless Config.instance.podfile_path && Config.instance.podfile_path.exist?
           <<-EOS
@@ -75,6 +79,16 @@ EOS
           end
         end
 
+        def remove_color(string)
+          string.gsub(/\e\[(\d+)m/, '')
+        end
+
+        def issues_url(exception)
+          message = remove_color(pathless_exception_message(exception.message))
+          'https://github.com/CocoaPods/CocoaPods/search?q=' \
+          "#{CGI.escape(message)}&type=Issues"
+        end
+
         def host_information
           product, version, build =`sw_vers`.strip.split("\n").map { |line| line.split(":").last.strip }
           "#{product} #{version} (#{build})"

spec/unit/user_interface/error_report_spec.rb

+require File.expand_path('../../../spec_helper', __FILE__)
+
+module Pod
+  describe UserInterface::ErrorReport do
+    def remove_color(string)
+      string.gsub(/\e\[(\d+)m/, '')
+    end
+
+    describe 'In general' do
+      before do
+        @exception = Informative.exception('at - (~/code.rb):')
+        @exception.stubs(:backtrace).returns(['Line 1', 'Line 2'])
+        @report = UserInterface::ErrorReport
+      end
+
+      it 'returns a well-structured report' do
+        expected = <<-EOS
+
+――― MARKDOWN TEMPLATE ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
+
+### Report
+
+* What did you do?
+
+* What did you expect to happen?
+
+* What happened instead?
+
+
+### Stack
+
+```
+   CocoaPods : #{Pod::VERSION}
+        Ruby : #{RUBY_DESCRIPTION}
+    RubyGems : #{Gem::VERSION}
+        Host : :host_information
+       Xcode : :xcode_information
+Ruby lib dir : #{RbConfig::CONFIG['libdir']}
+Repositories : repo_1
+               repo_2
+```
+
+### Podfile
+
+```ruby
+
+```
+
+### Error
+
+```
+Pod::Informative - [!] at - (~/code.rb):
+Line 1
+Line 2
+```
+
+――― TEMPLATE END ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
+
+[!] Oh no, an error occurred.
+
+Search for existing github issues similar to yours:
+https://github.com/CocoaPods/CocoaPods/search?q=%5B%21%5D+at+-&type=Issues
+
+If none exists, create a ticket, with the template displayed above, on:
+https://github.com/CocoaPods/CocoaPods/issues/new
+
+Don't forget to anonymize any private data!
+
+EOS
+        @report.stubs(:markdown_podfile).returns <<-EOS
+
+### Podfile
+
+```ruby
+
+```
+EOS
+        @report.stubs(:host_information).returns(':host_information')
+        @report.stubs(:xcode_information).returns(':xcode_information')
+        @report.stubs(:repo_information).returns(['repo_1', 'repo_2'])
+        report = remove_color(@report.report(@exception))
+        report.should == expected
+      end
+
+      it 'strips the local path from the exception message' do
+        message = @report.send(:pathless_exception_message, @exception.message)
+        message = remove_color(message)
+        message.should == '[!] at -'
+      end
+    end
+
+  end
+end