party_foul 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f80dcba58cf47603afe74982f963afc9e5bc188
-  data.tar.gz: b44e5e15e8288f829b85835e3c33ea5ca27a6f03
+  metadata.gz: aa0cf12a33de9ac49934ecfe1d6b738f50e2e927
+  data.tar.gz: 633450be535b01dabf7ab095c3ea72722759b930
 SHA512:
-  metadata.gz: 28bd2e96700f5e2932b85671579830ad9ed28f9fd6c04ab62f16a528ed46ce044a8b485dd8c39c65bfa5c2ffb9140439f6ea7e1d08f95efae4a9ba05bc5e6b09
-  data.tar.gz: 5f6527076d22d9c696d7a6c44e0e887bdf40493d9fe5b85fb8b4a62addf63aa097938362dd55f721d22e69837907070a83645155f4d4d9f422eea0d95296bc7a
+  metadata.gz: 4ab9b33bbe4914667ba0da42d38d67d6eace05c0c7fef1376c6d2a7f21caa2e3a9bf19665b968670cfd1c3851f461805726cddc25fe9d8025305b7f06ebd9ccf
+  data.tar.gz: 30959491d47671b49baa742e8a06c53cfc00c7d8cc7640d1d8c05b78ad591ef8f2570ab86d0aff730ae98106c5146f2f410732a713b03e3c4d05e2ca423fece1

data/README.md

@@ -92,6 +92,10 @@ PartyFoul.configure do |config|
 
   # The branch for your deployed code
   # config.branch               = 'master'
+
+  # Setting your title prefix can help with 
+  # distinguising the issue between environments
+  # config.title_prefix         = Rails.env
 end
 ```
 

data/lib/generators/party_foul/install_generator.rb

@@ -14,7 +14,7 @@ module PartyFoul
       @web_url      = ask_with_default 'Web URL:', 'https://github.com'
 
       begin
-        octokit      = Octokit.new :login => login, :password => password, :api_endpoint => @api_endpoint
+        octokit      = Octokit::Client.new :login => login, :password => password, :api_endpoint => @api_endpoint
         @oauth_token = octokit.create_authorization(scopes: ['repo'], note: "PartyFoul #{@owner}/#{@repo}", note_url: "#{@web_url}/#{@owner}/#{@repo}").token
         template 'party_foul.rb', 'config/initializers/party_foul.rb'
       rescue Octokit::Unauthorized

data/lib/generators/party_foul/templates/party_foul.rb

@@ -32,4 +32,8 @@ PartyFoul.configure do |config|
 
   # Limit the number of comments per issue
   # config.comment_limit        = 10
+
+  # Setting your title prefix can help with 
+  # distinguising the issue between environments
+  # config.title_prefix         = Rails.env
 end

data/lib/party_foul.rb

@@ -2,7 +2,7 @@ require 'octokit'
 
 module PartyFoul
   class << self
-    attr_accessor :github, :oauth_token, :api_endpoint, :owner, :repo, :blacklisted_exceptions, :processor, :web_url, :branch, :whitelisted_rack_variables, :additional_labels, :comment_limit
+    attr_accessor :github, :oauth_token, :api_endpoint, :owner, :repo, :blacklisted_exceptions, :processor, :web_url, :branch, :whitelisted_rack_variables, :additional_labels, :comment_limit, :title_prefix
   end
 
   # The git branch that is used for linking in the stack trace

data/lib/party_foul/issue_renderers/base.rb

@@ -16,7 +16,11 @@ class PartyFoul::IssueRenderers::Base
   #
   # @return [String]
   def title
-    raw_title.gsub(/0x(\w+)/, "0xXXXXXX")
+    if PartyFoul.title_prefix
+      "[#{PartyFoul.title_prefix}] #{masked_title}"
+    else
+      masked_title
+    end
   end
 
   # Renders the issue body
@@ -53,7 +57,9 @@ BODY
   # @return [String]
   def stack_trace
     exception.backtrace.map do |line|
-      if (matches = extract_file_name_and_line_number(line))
+      if from_bundler?(line)
+        format_line(line)
+      elsif (matches = extract_file_name_and_line_number(line))
         "<a href='#{PartyFoul.repo_url}/blob/#{sha}/#{matches[2]}#L#{matches[3]}'>#{format_line(line)}</a>"
       else
         format_line(line)
@@ -152,20 +158,29 @@ BODY
     Bundler.bundle_path.to_s if defined?(Bundler)
   end
 
-  def extract_file_name_and_line_number(backtrace_line)
-    backtrace_line.match(/#{app_root}\/((.+?):(\d+))/)
+  def from_bundler?(line)
+    if bundle_root
+      line.match(bundle_root)
+    end
+  end
+
+  def extract_file_name_and_line_number(line)
+    line.match(/#{app_root}\/((.+?):(\d+))/)
   end
 
   def raw_title
     raise NotImplementedError
   end
 
+  def masked_title
+    raw_title.gsub(/0x(\w+)/, "0xXXXXXX")
+  end
+
   def format_line(line)
-    if bundle_root
-      line.sub(app_root, '[app]...').sub(bundle_root, '[bundle]...')
+    if from_bundler?(line)
+      line.sub(bundle_root, '[bundle]...')
     else
       line.sub(app_root, '[app]...')
     end
   end
-
 end

data/lib/party_foul/issue_renderers/rails.rb

@@ -15,6 +15,14 @@ class PartyFoul::IssueRenderers::Rails < PartyFoul::IssueRenderers::Rack
     parameter_filter.filter(env['rack.session'] || { } )
   end
 
+  # The timestamp when the exception occurred. Will use Time.current when available to record
+  # the time with the proper timezone
+  #
+  # @return [String]
+  def occurred_at
+    @occurred_at ||= Time.current.strftime('%B %d, %Y %H:%M:%S %z')
+  end
+
   private
 
   def app_root

data/lib/party_foul/version.rb

@@ -1,3 +1,3 @@
 module PartyFoul
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/test/generator_test.rb

@@ -9,9 +9,9 @@ class PartyFoul::GeneratorTest < Rails::Generators::TestCase
   test 'it copies the initializer' do
     owner = 'test_owner'
     repo  = 'test_repo'
-    octokit = mock('Octokit')
+    octokit = mock('Octokit::Client')
     octokit.expects(:create_authorization).with(scopes: ['repo'], note: 'PartyFoul test_owner/test_repo', note_url: 'http://example.com/test_owner/test_repo').returns(sawyer_resource({token: 'test_token'}))
-    Octokit.stubs(:new).with(:login => 'test_login', :password => 'test_password', :api_endpoint => 'http://api.example.com').returns(octokit)
+    Octokit::Client.stubs(:new).with(:login => 'test_login', :password => 'test_password', :api_endpoint => 'http://api.example.com').returns(octokit)
     $stdin.stubs(:gets).returns('test_login').then.returns('test_password').then.returns(owner).then.returns(repo).then.returns('http://api.example.com').then.returns('http://example.com').then.returns('')
     run_generator
 

data/test/party_foul/issue_renderers/base_test.rb

@@ -117,21 +117,48 @@ Fingerprint: `abcdefg1234567890`
       rendered_issue.stubs(:raw_title).returns('Error for #<#<ClassName:0x007fbddbdcd340>:0x007fbddf6be0a0>')
       rendered_issue.title.must_equal 'Error for #<#<ClassName:0xXXXXXX>:0xXXXXXX>'
     end
-  end
 
-  describe '#stack_trace' do
-    it 'returns the stack trace' do
-      exception = mock do
-        stubs backtrace: ['/path/to/gems/gem-name/lib/some/file.rb:123 in `method`']
+    context 'when a custom title prefix is configured' do
+      before do
+        PartyFoul.configure do |config|
+          config.title_prefix = 'PRODUCTION'
+        end
+      end
+
+      it 'adds a custom prefix' do
+        rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+        rendered_issue.stubs(:raw_title).returns('Error')
+        rendered_issue.title.must_equal '[PRODUCTION] Error'
+      end
+
+      it 'generated unique fingerprints' do
+        rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+        rendered_issue.stubs(:raw_title).returns('Error')
+        fingerprint = rendered_issue.fingerprint
+
+        PartyFoul.configure do |config|
+          config.title_prefix = 'STAGING'
+        end
+
+        fingerprint.wont_equal rendered_issue.fingerprint
       end
-      rendered_issue = PartyFoul::IssueRenderers::Base.new(exception, nil)
-      rendered_issue.stack_trace.must_equal exception.backtrace.first
     end
+  end
+
+  describe '#stack_trace' do
+    # it 'returns the stack trace' do
+      # exception = mock do
+        # stubs backtrace: ['/path/to/gems/gem-name/lib/some/file.rb:123 in `method`']
+      # end
+      # rendered_issue = PartyFoul::IssueRenderers::Base.new(exception, nil)
+      # rendered_issue.stack_trace.must_equal exception.backtrace.first
+    # end
 
     it 'formats the stack trace with shortened bundle paths' do
       exception = mock do
         stubs backtrace: ["#{Bundler.bundle_path}/some_gem/lib/some/file.rb:123 in `method`"]
       end
+
       rendered_issue = PartyFoul::IssueRenderers::Base.new(exception, nil)
       rendered_issue.stack_trace.must_equal '[bundle].../some_gem/lib/some/file.rb:123 in `method`'
     end
@@ -142,9 +169,19 @@ Fingerprint: `abcdefg1234567890`
       end
       rendered_issue = PartyFoul::IssueRenderers::Base.new(exception, nil)
       rendered_issue.stubs app_root: '/path/to/app'
-      rendered_issue.stack_trace.must_match "<a href='https://github.com/"
-      rendered_issue.stack_trace.must_match ">[app].../lib/some/file.rb:123 in `method`</a>"
+      rendered_issue.stack_trace.must_match "<a href='https://github.com///blob//lib/some/file.rb#L123'>[app].../lib/some/file.rb:123 in `method`</a>"
     end
-  end
 
+    it 'does not link to bundled resources on Heroku' do
+      Bundler.stub(:bundle_path, '/app/vendor/bundle/ruby/2.0.0') do
+        exception = mock do
+          stubs backtrace: ["#{Bundler.bundle_path}/some_gem/lib/some/file.rb:123 in `method`"]
+        end
+
+        rendered_issue = PartyFoul::IssueRenderers::Base.new(exception, nil)
+        rendered_issue.stubs app_root: '/app'
+        rendered_issue.stack_trace.must_equal '[bundle].../some_gem/lib/some/file.rb:123 in `method`'
+      end
+    end
+  end
 end

data/test/party_foul/issue_renderers/rails_test.rb

@@ -12,6 +12,17 @@ describe 'Rails Issue Renderer' do
     end
   end
 
+  describe '#occurred_at' do
+    it 'uses current when possible' do
+      Time.stubs(:now).returns(Time.new(1970, 1, 1, 0, 0, 1, '-08:00'))
+      Time.stubs(:current).returns(Time.new(1970, 1, 1, 0, 0, 1, '-05:00'))
+      current_as_string = Time.current.strftime('%B %d, %Y %H:%M:%S %z')
+      rendered_issue = PartyFoul::IssueRenderers::Rails.new(nil, nil)
+      expected = rendered_issue.occurred_at
+      rendered_issue.occurred_at.must_equal current_as_string
+    end
+  end
+
   describe '#session' do
     let(:params) { {'action_dispatch.parameter_filter' => ['password'], 'rack.session' => { 'status' => 'ok', 'password' => 'test' }, 'QUERY_STRING' => { 'status' => 'fail' } } }
 

data/test/tmp/config/initializers/party_foul.rb

@@ -32,4 +32,8 @@ PartyFoul.configure do |config|
 
   # Limit the number of comments per issue
   # config.comment_limit        = 10
+
+  # Setting your title prefix can help with 
+  # distinguising the issue between environments
+  # config.title_prefix         = Rails.env
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: party_foul
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Brian Cardarella
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-05 00:00:00.000000000 Z
+date: 2013-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: 2.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -196,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Auto-submit Rails exceptions as new issues on GitHub