heroku-request-id 0.0.1 → 0.0.2

data/README.md

@@ -18,7 +18,21 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+By default the gem will print a log line to the Heroku logs
+containing the request id and the elapsed time taken processing the
+request.  You can disable the log line by putting this in an
+initializer.
+
+```ruby
+  HerokuRequestId::Middleware.log_line = false
+```
+
+You can configure the gem to add a comment to the beginning of html
+requests by adding this to an initializer.
+
+```ruby
+  HerokuRequestId::Middleware.html_comment = true
+```
 
 ## Contributing
 

data/lib/heroku-request-id/middleware.rb

@@ -3,10 +3,9 @@ module HerokuRequestId
 
     def initialize(app)
         @app = app
-        html_comment = true
     end
 
-    @@html_comment = true
+    @@html_comment = false
 
     def self.html_comment
       @@html_comment
@@ -16,7 +15,7 @@ module HerokuRequestId
       @@html_comment = hc
     end
 
-    @@log_line = false
+    @@log_line = true
 
     def self.log_line
       @@log_line

data/lib/heroku-request-id/version.rb

@@ -1,3 +1,3 @@
 module HerokuRequestId
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/heroku-request-id/middleware_spec.rb

@@ -10,30 +10,30 @@ describe HerokuRequestId::Middleware do
 
   let(:app) { HerokuRequestId::Middleware.new(inner_app) }
 
-  it "prints the request id to stdout if log_line == true" do
-    HerokuRequestId::Middleware.log_line = true
+  it "prints the request id to stdout by default" do
     output = capture_stdout { get "/" }
     output.should match("heroku-request-id")
-    # reset html_comment so that random test order works
-    HerokuRequestId::Middleware.log_line = false
   end
 
-  it "does not print the request id to stdout by default" do
+  it "does not print the request id to stdout if log_line == false" do
+    HerokuRequestId::Middleware.log_line = false
     output = capture_stdout { get "/" }
     output.should_not match("heroku-request-id")
+    # reset html_comment so that random test order works
+    HerokuRequestId::Middleware.log_line = true
   end
 
-  it "adds a comment with the Heroku request id" do
+  it "does not add a comment with the Heroku request id by default" do
     capture_stdout { get "/" }
-    last_response.body.should match("Heroku request id")
+    last_response.body.should_not match("Heroku request id")
   end
 
-  it "does not add a comment with the Heroku request id if html_comment == false" do
-    HerokuRequestId::Middleware.html_comment = false
+  it "does add a comment with the Heroku request id if html_comment == true" do
+    HerokuRequestId::Middleware.html_comment = true
     capture_stdout { get "/" }
-    last_response.body.should_not match("Heroku request id")
+    last_response.body.should match("Heroku request id")
     # reset html_comment so that random test order works
-    HerokuRequestId::Middleware.html_comment = true
+    HerokuRequestId::Middleware.html_comment = false
   end
 
   it "makes no change to response status" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroku-request-id
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1702138710006759316
+      hash: 1047826155926526819
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1702138710006759316
+      hash: 1047826155926526819
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24