party_foul 1.0.0 → 1.1.0

data/README.md

@@ -4,12 +4,12 @@
 [![Dependency Status](https://gemnasium.com/dockyard/party_foul.png?travis)](https://gemnasium.com/dockyard/party_foul)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/dockyard/party_foul)
 
-Rails exceptions automatically opened as issues on Github
+Rails exceptions automatically opened as issues on GitHub
 
 ## Looking for help? ##
 
 If it is a bug [please open an issue on
-Github](https://github.com/dockyard/party_foul/issues). If you need help using
+GitHub](https://github.com/dockyard/party_foul/issues). If you need help using
 the gem please ask the question on
 [Stack Overflow](http://stackoverflow.com). Be sure to tag the
 question with `DockYard` so we can find it.
@@ -19,7 +19,7 @@ question with `DockYard` so we can find it.
 `PartyFoul` captures exceptions in your application and does the
 following:
 
-1. Attempt to find a matching issue in your Github repo
+1. Attempt to find a matching issue in your GitHub repo
 2. If no matching issue is found an new issue is created with a
    unique title, session information, and stack trace. The issue is
 tagged as a `bug`. A new comment is added with relevant data on the
@@ -36,7 +36,7 @@ application state.
 
 ## Installation ##
 
-**Note** We highly recommend that you create a new Github account that is
+**Note** We highly recommend that you create a new GitHub account that is
 a collaborator on your repository. Use this new account's credentials
 for the installation below. If you use your own account you will
 not receive emails when issues are created, updated, reopened, etc...
@@ -55,7 +55,7 @@ If you are using Rails you can run the install generator.
 rails g party_foul:install
 ```
 
-This prompts you for the Github credentials of the account that is
+This prompts you for the GitHub credentials of the account that is
 opening the issues. The OAuth token for that account is stored
 in `config/initializers/party_foul.rb`. You may want to remove the token
 string and store in an environment variable. It is best not to store the
@@ -76,15 +76,15 @@ PartyFoul.configure do |config|
   # The constants here *must* be represented as strings
   config.blacklisted_exceptions = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
 
-  # The OAuth token for the account that is opening the issues on Github
+  # The OAuth token for the account that is opening the issues on GitHub
   config.oauth_token            = 'abcdefgh1234567890'
 
-  # The API endpoint for Github. Unless you are hosting a private
-  # instance of Enterprise Github you do not need to include this
+  # The API endpoint for GitHub. Unless you are hosting a private
+  # instance of Enterprise GitHub you do not need to include this
   config.endpoint               = 'https://api.github.com'
 
-  # The Web URL for Github. Unless you are hosting a private
-  # instance of Enterprise Github you do not need to include this
+  # The Web URL for GitHub. Unless you are hosting a private
+  # instance of Enterprise GitHub you do not need to include this
   config.web_url                = 'https://github.com'
 
   # The organization or user that owns the target repository
@@ -176,6 +176,17 @@ PartyFoul.configure do |config|
 end
 ```
 
+### Limiting Comments
+
+You can specify a limit on the number of comments added to each issue. The main issue will still be updated
+with a count and time for each occurrence, regardless of the limit.
+
+```ruby
+PartyFoul.configure do |config|
+  config.comment_limit = 10
+end
+```
+
 ## Tracking errors outside of an HTTP request
 
 You may want to track errors outside of a reqular HTTP stack. In that

data/lib/generators/party_foul/install_generator.rb

@@ -7,8 +7,8 @@ module PartyFoul
     source_root File.expand_path('../templates', __FILE__)
 
     def create_initializer_file
-      login     = ask 'Github login:'
-      password  = STDIN.noecho { ask 'Github password:' }
+      login     = ask 'GitHub login:'
+      password  = STDIN.noecho { ask 'GitHub password:' }
       @owner    = ask_with_default "\nRepository owner:", login
       @repo     = ask 'Repository name:'
       @endpoint = ask_with_default 'Api Endpoint:', 'https://api.github.com'
@@ -19,7 +19,7 @@ module PartyFoul
         @oauth_token = github.oauth.create(scopes: ['repo'], note: "PartyFoul #{@owner}/#{@repo}", note_url: "#{@web_url}/#{@owner}/#{@repo}").token
         template 'party_foul.rb', 'config/initializers/party_foul.rb'
       rescue Github::Error::Unauthorized
-        say 'There was an error retrieving your Github OAuth token'
+        say 'There was an error retrieving your GitHub OAuth token'
       end
     end
 

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

@@ -3,15 +3,15 @@ PartyFoul.configure do |config|
   # The constants here *must* be represented as strings
   config.blacklisted_exceptions = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
 
-  # The OAuth token for the account that is opening the issues on Github
+  # The OAuth token for the account that is opening the issues on GitHub
   config.oauth_token            = '<%= @oauth_token %>'
 
-  # The API endpoint for Github. Unless you are hosting a private
-  # instance of Enterprise Github you do not need to include this
+  # The API endpoint for GitHub. Unless you are hosting a private
+  # instance of Enterprise GitHub you do not need to include this
   config.endpoint               = '<%= @endpoint %>'
 
-  # The Web URL for Github. Unless you are hosting a private
-  # instance of Enterprise Github you do not need to include this
+  # The Web URL for GitHub. Unless you are hosting a private
+  # instance of Enterprise GitHub you do not need to include this
   config.web_url                = '<%= @web_url %>'
 
   # The organization or user that owns the target repository
@@ -29,4 +29,7 @@ PartyFoul.configure do |config|
   # config.additional_labels    = Proc.new do |exception, env|
   #   []
   # end
+
+  # Limit the number of comments per issue
+  # config.comment_limit        = 10
 end

data/lib/party_foul.rb

@@ -2,7 +2,7 @@ require 'github_api'
 
 module PartyFoul
   class << self
-    attr_accessor :github, :oauth_token, :endpoint, :owner, :repo, :blacklisted_exceptions, :processor, :web_url, :branch, :whitelisted_rack_variables, :additional_labels
+    attr_accessor :github, :oauth_token, :endpoint, :owner, :repo, :blacklisted_exceptions, :processor, :web_url, :branch, :whitelisted_rack_variables, :additional_labels, :comment_limit
   end
 
   def self.whitelisted_rack_variables
@@ -16,7 +16,7 @@ module PartyFoul
     @branch ||= 'master'
   end
 
-  # The web url for Github. This is only interesting for Enterprise
+  # The web url for GitHub. This is only interesting for Enterprise
   # users
   #
   # @return [String] Defaults to 'https://github.com' if not set
@@ -24,7 +24,7 @@ module PartyFoul
     @web_url ||= 'https://github.com'
   end
 
-  # The api endpoint for Github. This is only interesting for Enterprise
+  # The api endpoint for GitHub. This is only interesting for Enterprise
   # users
   #
   # @return [String] Defaults to 'https://api.github.com' if not set
@@ -71,7 +71,7 @@ module PartyFoul
   #       config.oauth_token = ENV['oauth_token']
   #     end
   #
-  # Will also setup for Github api connections
+  # Will also setup for GitHub api connections
   #
   # @param [Block]
   def self.configure(&block)

data/lib/party_foul/exception_handler.rb

@@ -24,7 +24,7 @@ class PartyFoul::ExceptionHandler
     self.rendered_issue = renderer_klass.new(exception, env)
   end
 
-  # Begins to process the exception for Github Issues. Makes an attempt
+  # Begins to process the exception for GitHub Issues. Makes an attempt
   # to find the issue. If found will update the issue. If not found will create a new issue.
   def run
     if issue = find_issue
@@ -34,7 +34,7 @@ class PartyFoul::ExceptionHandler
     end
   end
 
-  # Hits the Github API to find the matching issue using the fingerprint.
+  # Hits the GitHub API to find the matching issue using the fingerprint.
   def find_issue
     unless issue = PartyFoul.github.search.issues(owner: PartyFoul.owner, repo: PartyFoul.repo, state: 'open', keyword: fingerprint).issues.first
       issue = PartyFoul.github.search.issues(owner: PartyFoul.owner, repo: PartyFoul.repo, state: 'closed', keyword: fingerprint).issues.first
@@ -63,7 +63,9 @@ class PartyFoul::ExceptionHandler
 
       self.sha = PartyFoul.github.git_data.references.get(PartyFoul.owner, PartyFoul.repo, "heads/#{PartyFoul.branch}").object.sha
       PartyFoul.github.issues.edit(PartyFoul.owner, PartyFoul.repo, issue['number'], params)
-      PartyFoul.github.issues.comments.create(PartyFoul.owner, PartyFoul.repo, issue['number'], body: rendered_issue.comment)
+      unless comment_limit_met?(issue['body'])
+        PartyFoul.github.issues.comments.create(PartyFoul.owner, PartyFoul.repo, issue['number'], body: rendered_issue.comment)
+      end
     end
   end
 
@@ -80,4 +82,13 @@ class PartyFoul::ExceptionHandler
   def sha=(sha)
     rendered_issue.sha = sha
   end
+
+  def occurrence_count(body)
+    result = body.match(/<th>Count<\/th><td>(\d+)<\/td>/)
+    result.nil? ? 0 : result[1].to_i
+  end
+
+  def comment_limit_met?(body)
+    !!PartyFoul.comment_limit && PartyFoul.comment_limit <= occurrence_count(body)
+  end
 end

data/lib/party_foul/issue_renderers/base.rb

@@ -1,7 +1,10 @@
+require 'cgi'
+
 class PartyFoul::IssueRenderers::Base
   attr_accessor :exception, :env, :sha
+  attr_reader :body
 
-  # A new renderer instance for Githug issues
+  # A new renderer instance for GitHub issues
   #
   # @param [Exception, Hash]
   def initialize(exception, env)
@@ -9,11 +12,11 @@ class PartyFoul::IssueRenderers::Base
     self.env       = env
   end
 
-  # Derived title of the issue. Must be implemented by the adapter class
+  # Title of the issue with any object ids masked
   #
-  # @return [NotImplementedError]
+  # @return [String]
   def title
-    raise NotImplementedError
+    raw_title.gsub(/#<(\w+):0x\w+?>/, "#<\\1:0xXXXXXX>")
   end
 
   # Renders the issue body
@@ -22,7 +25,7 @@ class PartyFoul::IssueRenderers::Base
   #
   # @return [String]
   def body
-    <<-BODY
+    @body ||= <<-BODY
 #{build_table_from_hash(body_options)}
 
 ## Stack Trace
@@ -41,7 +44,7 @@ BODY
 
   # Compiles the stack trace for use in the issue body. Lines in the
   # stack trace that are part of the application will be rendered as
-  # links to the relative file and line on Github based upon
+  # links to the relative file and line on GitHub based upon
   # {PartyFoul.web_url}, {PartyFoul.owner}, {PartyFoul.repo}, and
   # {PartyFoul.branch}. The branch will be used at the time the
   # exception happens to grab the SHA for that branch at that time for
@@ -76,7 +79,7 @@ BODY
     begin
       current_count = old_body.match(/<th>Count<\/th><td>(\d+)<\/td>/)[1].to_i
       old_body.sub!("<th>Count</th><td>#{current_count}</td>", "<th>Count</th><td>#{current_count + 1}</td>")
-      old_body.sub!(/<th>Last Occurrence<\/th><td>.+<\/td>/, "<th>Last Occurrence</th><td>#{occurred_at}</td>")
+      old_body.sub!(/<th>Last Occurrence<\/th><td>.+?<\/td>/, "<th>Last Occurrence</th><td>#{occurred_at}</td>")
       old_body
     rescue
       self.body
@@ -87,7 +90,7 @@ BODY
   #
   # @return [String]
   def occurred_at
-    Time.now.strftime('%B %d, %Y %H:%M:%S %z')
+    @occurred_at ||= Time.now.strftime('%B %d, %Y %H:%M:%S %z')
   end
 
   # The hash used for building the table in issue body
@@ -122,6 +125,8 @@ BODY
       key, value = row
       if row[1].kind_of?(Hash)
         value = build_table_from_hash(row[1])
+      else
+        value = CGI.escapeHTML(value.to_s)
       end
       rows << "<tr><th>#{key}</th><td>#{value}</td></tr>"
     end
@@ -147,4 +152,8 @@ BODY
   def extract_file_name_and_line_number(backtrace_line)
     backtrace_line.match(/#{app_root}\/((.+?):(\d+))/)
   end
+
+  def raw_title
+    raise NotImplementedError
+  end
 end

data/lib/party_foul/issue_renderers/rack.rb

@@ -1,11 +1,4 @@
 class PartyFoul::IssueRenderers::Rack < PartyFoul::IssueRenderers::Base
-  # Title for the issue comprised of (exception) "message"
-  #
-  # @return [String]
-  def title
-    %{(#{exception.class}) "#{exception.message}"}
-  end
-
   def comment_options
     super.merge(URL: url, Params: params, Session: session, 'IP Address' => ip_address, 'HTTP Headers' => http_headers)
   end
@@ -42,4 +35,10 @@ class PartyFoul::IssueRenderers::Rack < PartyFoul::IssueRenderers::Base
   def http_headers
     { Version: env['HTTP_VERSION'], 'User Agent' => env['HTTP_USER_AGENT'], 'Accept Encoding' => env['HTTP_ACCEPT_ENCODING'], Accept: env['HTTP_ACCEPT'] }
   end
+
+  private
+
+  def raw_title
+    %{(#{exception.class}) "#{exception.message}"}
+  end
 end

data/lib/party_foul/issue_renderers/rackless.rb

@@ -13,14 +13,13 @@ class PartyFoul::IssueRenderers::Rackless < PartyFoul::IssueRenderers::Base
     env[:params]
   end
 
-  # Title for the issue comprised of Controller#action (exception) "message"
-  #
-  # @return [String]
-  def title
-    %{#{env[:class]}##{env[:method]} (#{exception.class}) "#{exception.message}"}
-  end
-
   def comment_options
     super.merge(Params: params)
   end
+
+  private
+
+  def raw_title
+    %{#{env[:class]}##{env[:method]} (#{exception.class}) "#{exception.message}"}
+  end
 end

data/lib/party_foul/issue_renderers/rails.rb

@@ -1,11 +1,4 @@
 class PartyFoul::IssueRenderers::Rails < PartyFoul::IssueRenderers::Rack
-  # Title for the issue comprised of Controller#action (exception) "message"
-  #
-  # @return [String]
-  def title
-    %{#{env['action_controller.instance'].class}##{env['action_dispatch.request.path_parameters']['action']} (#{exception.class}) "#{exception.message}"}
-  end
-
   # Rails params hash. Filtered parms are respected.
   #
   # @return [Hash]
@@ -27,4 +20,8 @@ class PartyFoul::IssueRenderers::Rails < PartyFoul::IssueRenderers::Rack
   def app_root
     Rails.root
   end
+
+  def raw_title
+    %{#{env['action_controller.instance'].class}##{env['action_dispatch.request.path_parameters']['action']} (#{exception.class}) "#{exception.message}"}
+  end
 end

data/lib/party_foul/version.rb

@@ -1,3 +1,3 @@
 module PartyFoul
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/test/party_foul/configure_test.rb

@@ -15,6 +15,7 @@ describe 'Party Foul Confg' do
       config.owner              = 'test_owner'
       config.repo               = 'test_repo'
       config.branch             = 'master'
+      config.comment_limit      = 10
     end
 
     PartyFoul.blacklisted_exceptions.must_equal ['StandardError']
@@ -25,6 +26,7 @@ describe 'Party Foul Confg' do
     PartyFoul.repo.must_equal 'test_repo'
     PartyFoul.repo_url.must_equal 'http://example.com/test_owner/test_repo'
     PartyFoul.branch.must_equal 'master'
+    PartyFoul.comment_limit.must_equal 10
   end
 
   it 'has default values' do

data/test/party_foul/exception_handler_test.rb

@@ -21,7 +21,7 @@ describe 'Party Foul Exception Handler' do
   end
 
   context 'when error is new' do
-    it 'will open a new error on Github' do
+    it 'will open a new error on GitHub' do
       PartyFoul::IssueRenderers::Rails.any_instance.stubs(:body).returns('Test Body')
       PartyFoul::IssueRenderers::Rails.any_instance.stubs(:comment).returns('Test Comment')
       PartyFoul.github.search.stubs(:issues).with(owner: 'test_owner', repo: 'test_repo', keyword: 'test_fingerprint', state: 'open').returns(Hashie::Mash.new(issues: []))
@@ -41,7 +41,7 @@ describe 'Party Foul Exception Handler' do
       after do
         clean_up_party
       end
-      it 'will open a new error on Github with the additional labels' do
+      it 'will open a new error on GitHub with the additional labels' do
         PartyFoul::IssueRenderers::Rails.any_instance.stubs(:body).returns('Test Body')
         PartyFoul::IssueRenderers::Rails.any_instance.stubs(:comment).returns('Test Comment')
         PartyFoul.github.search.stubs(:issues).with(owner: 'test_owner', repo: 'test_repo', keyword: 'test_fingerprint', state: 'open').returns(Hashie::Mash.new(issues: []))
@@ -75,17 +75,17 @@ describe 'Party Foul Exception Handler' do
         clean_up_party
       end
 
-      it 'will open a new error on Github with the default labels if no additional labels are returned from the proc' do
+      it 'will open a new error on GitHub with the default labels if no additional labels are returned from the proc' do
         PartyFoul.github.issues.expects(:create).with('test_owner', 'test_repo', title: 'Test Title', body: 'Test Body', :labels => ['bug']).returns(Hashie::Mash.new('number' => 1))
         PartyFoul::ExceptionHandler.new(stub(:message => ''), {}).run
       end
 
-      it 'will open a new error on Github with the additional labels based on the exception message' do
+      it 'will open a new error on GitHub with the additional labels based on the exception message' do
         PartyFoul.github.issues.expects(:create).with('test_owner', 'test_repo', title: 'Test Title', body: 'Test Body', :labels => ['bug', 'database_error']).returns(Hashie::Mash.new('number' => 1))
         PartyFoul::ExceptionHandler.new(stub(:message => 'Database'), {}).run
       end
 
-      it 'will open a new error on Github with the additional labels based on the env' do
+      it 'will open a new error on GitHub with the additional labels based on the env' do
         PartyFoul.github.issues.expects(:create).with('test_owner', 'test_repo', title: 'Test Title', body: 'Test Body', :labels => ['bug', 'beta']).returns(Hashie::Mash.new('number' => 1))
         PartyFoul::ExceptionHandler.new(stub(:message => ''), {:http_host => 'beta.example.com'}).run
       end
@@ -99,11 +99,24 @@ describe 'Party Foul Exception Handler' do
     end
 
     context 'and open' do
-      it 'will update the issue' do
+      before do
         PartyFoul.github.search.stubs(:issues).with(owner: 'test_owner', repo: 'test_repo', keyword: 'test_fingerprint', state: 'open').returns(Hashie::Mash.new(issues: [{title: 'Test Title', body: 'Test Body', state: 'open', number: 1}]))
         PartyFoul.github.issues.expects(:edit).with('test_owner', 'test_repo', 1, body: 'New Body', state: 'open')
         PartyFoul.github.issues.comments.expects(:create).with('test_owner', 'test_repo', 1, body: 'Test Comment')
         PartyFoul.github.git_data.references.expects(:get).with('test_owner', 'test_repo', 'heads/deploy').returns(Hashie::Mash.new(object: Hashie::Mash.new(sha: 'abcdefg1234567890')))
+      end
+
+      it 'will update the issue' do
+        PartyFoul::ExceptionHandler.new(nil, {}).run
+      end
+
+      it "doesn't post a comment if the limit has been met" do
+        PartyFoul.configure do |config|
+          config.comment_limit = 10
+        end
+        PartyFoul::ExceptionHandler.any_instance.expects(:occurrence_count).returns(10)
+        PartyFoul.github.issues.comments.unstub(:create) # Necessary for the `never` expectation to work.
+        PartyFoul.github.issues.comments.expects(:create).never
         PartyFoul::ExceptionHandler.new(nil, {}).run
       end
     end
@@ -132,4 +145,51 @@ describe 'Party Foul Exception Handler' do
       PartyFoul::ExceptionHandler.new(nil, {}).run
     end
   end
+
+  describe '#occurrence_count' do
+    before do
+      @handler = PartyFoul::ExceptionHandler.new(nil, {})
+    end
+
+    it "returns the count" do
+      @handler.send(:occurrence_count, "<th>Count</th><td>1</td>").must_equal 1
+    end
+
+    it "returns 0 if no count is found" do
+      @handler.send(:occurrence_count, "Unexpected Body").must_equal 0
+    end
+  end
+
+  describe '#comment_limit_met?' do
+    before do
+      @handler = PartyFoul::ExceptionHandler.new(nil, {})
+    end
+
+    context "with no limit" do
+      it "returns false when there is no limit" do
+        PartyFoul.configure do |config|
+          config.comment_limit = nil
+        end
+        @handler.send(:comment_limit_met?, "").must_equal false
+      end
+    end
+
+    context "with a limit" do
+      before do
+        PartyFoul.configure do |config|
+          config.comment_limit = 10
+        end
+      end
+
+      it "returns false when there is a limit that has not been hit" do
+        @handler.stubs(:occurrence_count).returns(1)
+        @handler.send(:comment_limit_met?, "").must_equal false
+      end
+
+      it "returns true if the limit has been hit" do
+        @handler.stubs(:occurrence_count).returns(10)
+        @handler.send(:comment_limit_met?, "").must_equal true
+      end
+    end
+  end
 end

data/test/party_foul/issue_renderers/base_test.rb

@@ -21,11 +21,11 @@ describe 'Party Foul Issue Renderer Base' do
       end
 
       it 'updates count and timestamp' do
-        body = <<-BODY
+        body = <<-BODY.gsub(/\n/, '')
 <table>
 <tr><th>Exception</th><td>Test Exception</td></tr>
-<tr><th>Count</th><td>1</td></tr>
 <tr><th>Last Occurrence</th><td>January 01, 1970 00:00:00 -0500</td></tr>
+<tr><th>Count</th><td>1</td></tr>
 </table>
 
 ## Stack Trace
@@ -35,11 +35,11 @@ Fingerprint: `abcdefg1234567890`
 
         Time.stubs(:now).returns(Time.new(1985, 10, 25, 1, 22, 0, '-05:00'))
 
-        expected_body = <<-BODY
+        expected_body = <<-BODY.gsub(/\n/, '')
 <table>
 <tr><th>Exception</th><td>Test Exception</td></tr>
-<tr><th>Count</th><td>2</td></tr>
 <tr><th>Last Occurrence</th><td>October 25, 1985 01:22:00 -0500</td></tr>
+<tr><th>Count</th><td>2</td></tr>
 </table>
 
 ## Stack Trace
@@ -79,6 +79,13 @@ Fingerprint: `abcdefg1234567890`
       expected = '<table><tr><th>Value 1</th><td>abc</td></tr><tr><th>Value 2</th><td><table><tr><th>Value A</th><td>123</td></tr><tr><th>Value B</th><td>456</td></tr></table></td></tr></table>'
       rendered_issue.build_table_from_hash(hash).must_equal expected
     end
+
+    it 'escapes HTML entities' do
+      rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+      hash = { 'Value 1' => 'Error in #<Foo>' }
+      expected = '<table><tr><th>Value 1</th><td>Error in #&lt;Foo&gt;</td></tr></table>'
+      rendered_issue.build_table_from_hash(hash).must_equal expected
+    end
   end
 
   describe '#fingerprint' do
@@ -88,4 +95,21 @@ Fingerprint: `abcdefg1234567890`
       rendered_issue.fingerprint.must_equal Digest::SHA1.hexdigest(rendered_issue.title)
     end
   end
+
+  describe '#occurred_at' do
+    it 'memoizes the time' do
+      rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+      expected = rendered_issue.occurred_at
+      Time.stubs(:now).returns(Time.new(1970, 1, 1, 0, 0, 1, '-05:00'))
+      rendered_issue.occurred_at.must_equal expected
+    end
+  end
+
+  describe '#title' do
+    it 'masks the object ids in the raw_title' do
+      rendered_issue = PartyFoul::IssueRenderers::Base.new(nil, nil)
+      rendered_issue.stubs(:raw_title).returns('Error for #<ClassName:0xabcdefg1234567>')
+      rendered_issue.title.must_equal 'Error for #<ClassName:0xXXXXXX>'
+    end
+  end
 end

data/test/party_foul/issue_renderers/rack_test.rb

@@ -11,14 +11,14 @@ describe 'Rack Issue Renderer' do
     end
   end
 
-  describe '#title' do
+  describe '#raw_title' do
     before do
       @exception = Exception.new('message')
     end
 
     it 'constructs the title with the class and instance method' do
       @rendered_issue = PartyFoul::IssueRenderers::Rack.new(@exception, {})
-      @rendered_issue.title.must_equal %{(Exception) "message"}
+      @rendered_issue.send(:raw_title).must_equal %{(Exception) "message"}
     end
   end
 end

data/test/party_foul/issue_renderers/rackless_test.rb

@@ -16,14 +16,14 @@ describe 'Rackless Issue Renderer' do
     end
   end
 
-  describe '#title' do
+  describe '#raw_title' do
     before do
       @exception = Exception.new('message')
       @rendered_issue = PartyFoul::IssueRenderers::Rackless.new(@exception, @env)
     end
 
     it 'constructs the title with the controller and action' do
-      @rendered_issue.title.must_equal %{Worker#perform (Exception) "message"}
+      @rendered_issue.send(:raw_title).must_equal %{Worker#perform (Exception) "message"}
     end
   end
 end

data/test/party_foul/issue_renderers/rails_test.rb

@@ -23,7 +23,7 @@ describe 'Rails Issue Renderer' do
     end
   end
 
-  describe '#title' do
+  describe '#raw_title' do
     before do
       @exception = Exception.new('message')
       controller_instance = mock('Controller')
@@ -36,7 +36,7 @@ describe 'Rails Issue Renderer' do
     end
 
     it 'constructs the title with the controller and action' do
-      @rendered_issue.title.must_equal %{LandingController#index (Exception) "message"}
+      @rendered_issue.send(:raw_title).must_equal %{LandingController#index (Exception) "message"}
     end
   end
 end

data/test/test_helper.rb

@@ -24,7 +24,7 @@ module MiniTest::Expectations
 end
 
 def clean_up_party
-  %w{github oauth_token endpoint owner repo blacklisted_exceptions processor web_url branch additional_labels}.each do |attr|
+  %w{github oauth_token endpoint owner repo blacklisted_exceptions processor web_url branch additional_labels comment_limit}.each do |attr|
     PartyFoul.send("#{attr}=", nil)
   end
 end

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

@@ -3,15 +3,15 @@ PartyFoul.configure do |config|
   # The constants here *must* be represented as strings
   config.blacklisted_exceptions = ['ActiveRecord::RecordNotFound', 'ActionController::RoutingError']
 
-  # The OAuth token for the account that is opening the issues on Github
+  # The OAuth token for the account that is opening the issues on GitHub
   config.oauth_token            = 'test_token'
 
-  # The API endpoint for Github. Unless you are hosting a private
-  # instance of Enterprise Github you do not need to include this
+  # The API endpoint for GitHub. Unless you are hosting a private
+  # instance of Enterprise GitHub you do not need to include this
   config.endpoint               = 'http://api.example.com'
 
-  # The Web URL for Github. Unless you are hosting a private
-  # instance of Enterprise Github you do not need to include this
+  # The Web URL for GitHub. Unless you are hosting a private
+  # instance of Enterprise GitHub you do not need to include this
   config.web_url                = 'http://example.com'
 
   # The organization or user that owns the target repository
@@ -29,4 +29,7 @@ PartyFoul.configure do |config|
   # config.additional_labels    = Proc.new do |exception, env|
   #   []
   # end
+
+  # Limit the number of comments per issue
+  # config.comment_limit        = 10
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: party_foul
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -172,7 +172,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Auto-submit Rails exceptions as new isues on Github
+description: Auto-submit Rails exceptions as new isues on GitHub
 email:
 - bcardarella@gmail.com
 - rubygems@danmcclain.net
@@ -225,7 +225,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 764634010609561347
+      hash: -627459678726509707
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -234,13 +234,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 764634010609561347
+      hash: -627459678726509707
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Auto-submit Rails exceptions as new isues on Github
+summary: Auto-submit Rails exceptions as new isues on GitHub
 test_files:
 - test/generator_test.rb
 - test/party_foul/configure_test.rb