paul_bunyan 1.0.0

data/spec/gemfiles/41.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'rails', '~> 4.1.0'

data/spec/gemfiles/41.gemfile.lock

@@ -0,0 +1,142 @@
+PATH
+  remote: ../../
+  specs:
+    logging (0.2.0)
+      request_store
+      term-ansicolor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.12)
+      actionpack (= 4.1.12)
+      actionview (= 4.1.12)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.12)
+      actionview (= 4.1.12)
+      activesupport (= 4.1.12)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.12)
+      activesupport (= 4.1.12)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.12)
+      activesupport (= 4.1.12)
+      builder (~> 3.1)
+    activerecord (4.1.12)
+      activemodel (= 4.1.12)
+      activesupport (= 4.1.12)
+      arel (~> 5.0.0)
+    activesupport (4.1.12)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    ffi (1.9.9)
+    formatador (0.2.5)
+    guard (2.12.7)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.6.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    listen (3.0.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.6.1)
+    minitest (5.7.0)
+    nenv (0.2.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.1.12)
+      actionmailer (= 4.1.12)
+      actionpack (= 4.1.12)
+      actionview (= 4.1.12)
+      activemodel (= 4.1.12)
+      activerecord (= 4.1.12)
+      activesupport (= 4.1.12)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.12)
+      sprockets-rails (~> 2.0)
+    railties (4.1.12)
+      actionpack (= 4.1.12)
+      activesupport (= 4.1.12)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.5)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    request_store (1.1.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    shellany (0.0.1)
+    slop (3.6.0)
+    sprockets (3.2.0)
+      rack (~> 1.0)
+    sprockets-rails (2.3.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.5.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    wwtd (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  guard-rspec
+  logging!
+  rails (~> 4.1.0)
+  rake
+  rspec
+  sqlite3
+  wwtd

data/spec/gemfiles/42.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'rails', '~> 4.2.0'

data/spec/gemfiles/42.gemfile.lock

@@ -0,0 +1,167 @@
+PATH
+  remote: ../../
+  specs:
+    logging (0.2.0)
+      request_store
+      term-ansicolor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.3)
+      actionview (= 4.2.3)
+      activesupport (= 4.2.3)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.3)
+      activesupport (= 4.2.3)
+      globalid (>= 0.3.0)
+    activemodel (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+    activerecord (4.2.3)
+      activemodel (= 4.2.3)
+      activesupport (= 4.2.3)
+      arel (~> 6.0)
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    builder (3.2.2)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    ffi (1.9.9)
+    formatador (0.2.5)
+    globalid (0.3.5)
+      activesupport (>= 4.1.0)
+    guard (2.12.7)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.6.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    listen (3.0.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    loofah (2.0.2)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.0.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    nenv (0.2.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.3)
+      actionmailer (= 4.2.3)
+      actionpack (= 4.2.3)
+      actionview (= 4.2.3)
+      activejob (= 4.2.3)
+      activemodel (= 4.2.3)
+      activerecord (= 4.2.3)
+      activesupport (= 4.2.3)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.3)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.3)
+      actionpack (= 4.2.3)
+      activesupport (= 4.2.3)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.5)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    request_store (1.1.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    shellany (0.0.1)
+    slop (3.6.0)
+    sprockets (3.2.0)
+      rack (~> 1.0)
+    sprockets-rails (2.3.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.5.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    wwtd (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  guard-rspec
+  logging!
+  rails (~> 4.2.0)
+  rake
+  rspec
+  sqlite3
+  wwtd

data/spec/lib/paul_bunyan/json_formatter_spec.rb

@@ -0,0 +1,237 @@
+require "spec_helper"
+require "time"
+
+module PaulBunyan
+  describe JSONFormatter do
+    let(:formatter) { JSONFormatter.new }
+    let(:time) { Time.new(2015, 2, 7, 13, 52, 3.141592) }
+
+    describe "#call(severity, time, progname, msg)" do
+      it "must return an object seralized as JSON" do
+        output = formatter.call('', time, '', '')
+        expect(JSON.parse(output)).to be_a Hash
+      end
+
+      it "must include the supplied severity string in the output" do
+        output = formatter.call('WARN', time, '', '')
+        object = JSON.parse(output)
+        expect(object['severity']).to eq 'WARN'
+      end
+
+      it "must include the supplied timestamp including miliseconds" do
+        output = formatter.call('', time, '', '')
+        object = JSON.parse(output)
+        expect(object['ts']).to eq time.strftime('%Y-%m-%dT%H:%M:%S.%3N')
+      end
+
+      it "must include a high resolution unix timestamp in as the unix_ts key" do
+        output = formatter.call('', time, '', '')
+        object = JSON.parse(output)
+        expect(object['unix_ts']).to eq time.to_f
+      end
+
+      it "must include the supplied progname argument as the program key" do
+        output = formatter.call('', time, 'FooBar', '')
+        object = JSON.parse(output)
+        expect(object['program']).to eq 'FooBar'
+      end
+
+      it "must include the current process id as the pid key" do
+        output = formatter.call('', time, '', '')
+        object = JSON.parse(output)
+        expect(object['pid']).to eq $$
+      end
+
+      it 'must not include the tags array when none are set' do
+        output = formatter.call('', time, '', 'This is my message, there are many like it.')
+        object = JSON.parse(output)
+        expect(object['tags']).to be_nil
+      end
+
+      it 'must include the tags array when some are set' do
+        formatter.tagged(%w{foo bar}) do
+          output = formatter.call('', time, '', 'This is my message, there are many like it.')
+          object = JSON.parse(output)
+          expect(object['tags']).to eq %w{foo bar}
+        end
+      end
+
+      context 'when supplied a string as the message' do
+        it 'must wrap the message in an object with a message key containing the key' do
+          output = formatter.call('', time, '', 'This is my message, there are many like it.')
+          object = JSON.parse(output)
+          expect(object['message']).to eq 'This is my message, there are many like it.'
+        end
+
+        it 'must remove leading whitespace' do
+          output = formatter.call('', time, '', '   this message has leading spaces')
+          object = JSON.parse(output)
+          expect(object['message']).to eq 'this message has leading spaces'
+        end
+
+        it 'must remove trailing whitespace' do
+          output = formatter.call('', time, '', 'this message has trailing spaces    ')
+          object = JSON.parse(output)
+          expect(object['message']).to eq 'this message has trailing spaces'
+        end
+
+        it 'must remove ANSI color codes' do
+          output = formatter.call('', time, '', "\e[36;46mcolored message!")
+          object = JSON.parse(output)
+          expect(object['message']).to eq 'colored message!'
+        end
+      end
+
+      context 'when supplied a Hash' do
+        let(:logged_hash) {
+          {
+            foo: 'bar',
+            ts: 'baz',
+          }
+        }
+
+        let(:output) { formatter.call('', time, '', logged_hash) }
+        let(:parsed_output) { JSON.parse(output) }
+
+        it "must merge the hash with the base information" do
+          expect(parsed_output['foo']).to eq 'bar'
+        end
+
+        it "must protect the base attributes by prefixing 'user' to supplied keys that collide" do
+          expect(parsed_output['user.ts']).to_not be nil
+        end
+      end
+
+      context "when supplied an exception object" do
+        let(:exception) {
+          begin raise StandardError, "This is my exception...."
+          rescue; exception = $!; end
+          exception
+        }
+        let(:output) { formatter.call('', time, '', exception) }
+        let(:parsed_output) { JSON.parse(output) }
+
+        it "must include the exception class" do
+          expect(parsed_output['exception.class']).to eq 'StandardError'
+        end
+
+        it "must include the exception's message" do
+          expect(parsed_output['exception.message']).to eq 'This is my exception....'
+        end
+
+        it "must include the exception's backtrace" do
+          expect(parsed_output['exception.backtrace']).to eq exception.backtrace
+        end
+      end
+    end
+
+    describe '#clear_tags!' do
+      it 'must not fail when no tags have been set' do
+        formatter.clear_tags!
+      end
+
+      it 'must remove all tags that have been set' do
+        formatter.current_tags << 'foo'
+        expect(formatter.current_tags).to_not be_empty
+        formatter.clear_tags!
+        expect(formatter.current_tags).to be_empty
+      end
+    end
+
+    describe '#pop_tags(count = 1)' do
+      before do
+        formatter.push_tags %w{foo bar baz qux}
+      end
+
+      after do
+        formatter.clear_tags!
+      end
+
+      it 'must default to removing the last tag added' do
+        formatter.pop_tags
+        expect(formatter.current_tags).to_not include 'qux'
+      end
+
+      it 'must pop the specified number of tags' do
+        formatter.pop_tags(3)
+        expect(formatter.current_tags).to eq %w{foo}
+      end
+    end
+
+    describe '#push_tags(*tags)' do
+      after do
+        formatter.clear_tags!
+      end
+
+      it 'must add a single tag to the tags array' do
+        formatter.push_tags('foo')
+        expect(formatter.current_tags).to include 'foo'
+      end
+
+      it 'must add multiple tags to the current tags array' do
+        formatter.push_tags 'foo', 'bar', :baz
+        expect(formatter.current_tags).to contain_exactly 'foo', 'bar', :baz
+      end
+
+      it 'must add an array of tags to the current tags array' do
+        formatter.push_tags %w{foo bar baz}
+        expect(formatter.current_tags).to contain_exactly 'foo', 'bar', 'baz'
+      end
+
+      it 'must reject any tags that are nil' do
+        formatter.push_tags('foo', 'bar', nil, 'qux')
+        expect(formatter.current_tags).to contain_exactly 'foo', 'bar', 'qux'
+      end
+
+      it 'must reject any tags that are empty strings' do
+        formatter.push_tags('foo', '', 'bar')
+        expect(formatter.current_tags).to contain_exactly 'foo', 'bar'
+      end
+    end
+
+    describe '#tagged(*tags)' do
+      after do
+        formatter.clear_tags!
+      end
+
+      it 'must yeild to the supplied block' do
+        block_called = false
+        formatter.tagged(%w{foo bar}) do
+          block_called = true
+        end
+        expect(block_called).to eq true
+      end
+
+      it 'must set add the passed tags to the current tags array' do
+        formatter.tagged(%w{bar baz}) do
+          expect(formatter.current_tags).to eq %w{bar baz}
+        end
+      end
+
+      it 'must remove the set tags after the block has executed' do
+        formatter.tagged(%w{bar baz}) do
+          # nop
+        end
+        expect(formatter.current_tags).to be_empty
+      end
+
+      it 'must not remove tags set before the call to tagged' do
+        formatter.push_tags(%w{foo bar})
+        formatter.tagged(%w{baz qux}) do
+          expect(formatter.current_tags).to eq %w{foo bar baz qux}
+        end
+        expect(formatter.current_tags).to eq %w{foo bar}
+      end
+
+      it 'must remove the added tags even when an exception is raised in the block' do
+        begin
+          formatter.tagged(%w{baz qux}) do
+            raise 'oh noes!'
+          end
+        rescue
+        end
+        expect(formatter.current_tags).to be_empty
+      end
+    end
+  end
+end