yeti_logger 3.0.0

data/spec/lib/yeti_logger/wrapped_logger_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'yeti_logger/test_helper'
+
+class NakedLogger
+  include YetiLogger
+end
+
+describe YetiLogger::WrappedLogger do
+  include YetiLogger::TestHelper
+
+  let(:instance) { NakedLogger.new }
+  let(:logger) { instance.as_logger }
+
+  YetiLogger::LEVELS.each do |level|
+    describe "##{level}" do
+      it "forwards #{level} to the instance" do
+        expect(instance).to receive("log_#{level}").with('foo')
+        logger.send(level, 'foo')
+      end
+
+      it "forwards #{level} with a block to the instance" do
+        expect(instance).to receive("log_#{level}").and_call_original
+        should_log(level).with("NakedLogger: from block")
+        logger.send(level) { 'from block' }
+      end
+    end
+  end
+end

data/spec/lib/yeti_logger_spec.rb

@@ -0,0 +1,218 @@
+require 'spec_helper'
+require 'yeti_logger/test_helper'
+
+# Class used for class and instance level testing
+module Yucatan
+  class YellinYeti
+    include YetiLogger
+  end
+end
+
+# Used for testing via module and also by inclusion into rspecs.
+module ModularLog
+  include YetiLogger
+
+  def invoke_logger
+    log_warn "invoke via include"
+  end
+end
+
+# Class used for class and instance level testing
+module Yucatan
+  class YellinYeti
+    include YetiLogger
+  end
+end
+
+# Used for testing via module and also by inclusion into rspecs.
+module ModularLog
+  include YetiLogger
+
+  def invoke_logger
+    log_warn "invoke via include"
+  end
+end
+
+describe YetiLogger do
+
+  include YetiLogger::TestHelper
+
+  include ModularLog
+
+  let(:instance) { Yucatan::YellinYeti.new }
+  let(:data) do
+    {
+        "pet" => "dog",
+        "color" => "brown"
+    }
+  end
+
+  let(:ex) do
+    e = nil
+    begin
+      raise Exception.new("breakin!")
+    rescue Exception => exception
+      e = exception
+    end
+    e
+  end
+  let(:runtime) do
+    e = nil
+    begin
+      raise "fail!"
+    rescue Exception => ex
+      e = ex
+    end
+    e
+  end
+
+  it 'has a version number' do
+    expect(YetiLogger::VERSION).to_not be_nil
+  end
+
+  it "can be used by rspec code that includes modules that use it" do
+    should_log(:warn).with(/.*invoke via include/)
+    invoke_logger
+  end
+
+  [ Yucatan::YellinYeti, Yucatan::YellinYeti.new, ModularLog ].each do |target|
+    class_name = "Yucatan::YellinYeti"
+    target_type = "instance"
+    if target.class == Class
+      target_type = "class"
+    elsif target.class == Module
+      class_name = "ModularLog"
+      target_type = "module"
+    end
+
+    context "when used with a #{target_type}" do
+
+      # Debug tested separately below.
+      %w{ info warn error fatal }.each do |level|
+
+        it "has #{target_type} methods for level '#{level}'" do
+          should_log(level).with("#{class_name}: #{target_type}-stuffs")
+          target.send("log_#{level}", "#{target_type}-stuffs")
+        end
+
+      end
+
+      # There is a lot of debug output, so we can't verify it like we do the other
+      # levels. For now, just validate the method is there.
+      it "can call a #{target_type} debug method" do
+        target.log_debug("#{target_type} debuggin")
+      end
+
+      it "can log key value pairs at #{target_type} level" do
+        should_log(:info).with("#{class_name}: pet=dog color=brown")
+        target.log_info(data)
+      end
+
+      it "can log exceptions at #{target_type} level" do
+        should_log(:info) do |m|
+          m.start_with?("#{class_name}: breakin!").should == true
+          m.include?("/spec/lib/yeti_logger_spec.rb:").should == true
+        end
+        target.log_info(ex)
+      end
+
+      it "can log subclasses of exceptions at #{target_type} level" do
+        should_log(:info) do |m|
+          m.start_with?("#{class_name}: fail!").should == true
+          m.include?("/spec/lib/yeti_logger_spec.rb:").should == true
+        end
+        target.log_info(runtime)
+      end
+
+      it "can log messages and exceptions at #{target_type} level" do
+        re = /#{class_name}:\ssomething\sException:\sbreakin!\sError\sClass:\sException
+              .*\/spec\/lib\/yeti_logger_spec\.rb:.*/x
+        should_log(:info).with(re)
+        expect(ex.backtrace).to_not be_nil
+        target.log_info("something", ex)
+      end
+
+      it "will only log exception messages if it has no backtrace at #{target_type} level" do
+        should_log(:info).with("#{class_name}: blat!")
+        target.log_info(Exception.new("blat!"))
+      end
+
+      it "can be called without arguments" do
+        should_log(:info).with("#{class_name}: ")
+        target.log_info
+      end
+
+      it "can log string messages from block" do
+        should_log(:info).with("#{class_name}: from block")
+        target.log_info { "from block" }
+      end
+
+      it "can log hash messages from block" do
+        should_log(:info).with("#{class_name}: pet=dog color=brown")
+        target.log_info { data }
+      end
+
+      it "can log exceptions from block" do
+        should_log(:info) do |m|
+          m.start_with?("#{class_name}: breakin!").should == true
+          m.include?("/spec/lib/yeti_logger_spec.rb:").should == true
+        end
+        target.log_info { ex }
+      end
+
+      it "only logs the block and ignores the obj argument" do
+        should_log(:info).with("#{class_name}: and block")
+        target.log_info("argument") { "and block" }
+      end
+
+      it "only logs the block and ignores both obj and ex arguments" do
+        should_log(:info).with("#{class_name}: and block")
+        target.log_info("argument", ex) { "and block" }
+      end
+
+      it "will not evaluate block unless the log level is high enough" do
+        with_log_level(Logger::INFO) do
+          target.log_info do
+            @my_var = 2
+            "incremented at info"
+          end
+          expect(@my_var).to eq(2)
+          target.log_debug do
+            @my_var = 3
+            "incremented at debug?"
+          end
+          expect(@my_var).to eq(2)
+        end
+      end
+
+    end
+  end # Iterate over class & instance
+
+  describe '#log_time' do
+
+    it "logs time at the info level by default" do
+      should_log(:info)
+      instance.log_time("query_db") do
+        sleep 0.1
+      end
+    end
+
+    it "logs at the user-specified level when asked" do
+      should_log(:warn)
+      instance.log_time("query", :warn) do
+        sleep 0.01
+      end
+    end
+  end
+
+  describe '#as_logger' do
+    it 'returns a WrappedLogger' do
+      expect(instance.as_logger).to be_instance_of(YetiLogger::WrappedLogger)
+    end
+
+    it 'uses the current instance as the wrapped object' do
+      expect(instance.as_logger.instance_variable_get(:@obj)).to eql(instance)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# Start up coverage before anything else,
+# otherwise we only get coverage for rspecs.
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/" # ignore spec files
+end
+SimpleCov.minimum_coverage 100
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_support/log_subscriber/test_helper'
+
+require 'yeti_logger'
+require 'yeti_logger/test_helper'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include ActiveSupport::LogSubscriber::TestHelper
+
+  config.before do
+    YetiLogger.configure do |config|
+      config.logger = ActiveSupport::LogSubscriber::TestHelper::MockLogger.new
+    end
+  end
+
+end

data/yeti_logger.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yeti_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yeti_logger"
+  spec.version       = YetiLogger::VERSION
+  spec.authors       = ["Yesware, Inc"]
+  spec.email         = ["engineering@yesware.com"]
+  spec.description   = %q{Provides standardized logging}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activesupport'
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "kramdown"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: yeti_logger
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Yesware, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides standardized logging
+email:
+- engineering@yesware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/yeti_logger.rb
+- lib/yeti_logger/configuration.rb
+- lib/yeti_logger/constants.rb
+- lib/yeti_logger/message_formatters.rb
+- lib/yeti_logger/test_helper.rb
+- lib/yeti_logger/version.rb
+- lib/yeti_logger/wrapped_logger.rb
+- spec/lib/yeti_logger/message_formatters_spec.rb
+- spec/lib/yeti_logger/test_helper_spec.rb
+- spec/lib/yeti_logger/wrapped_logger_spec.rb
+- spec/lib/yeti_logger_spec.rb
+- spec/spec_helper.rb
+- yeti_logger.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Provides standardized logging
+test_files:
+- spec/lib/yeti_logger/message_formatters_spec.rb
+- spec/lib/yeti_logger/test_helper_spec.rb
+- spec/lib/yeti_logger/wrapped_logger_spec.rb
+- spec/lib/yeti_logger_spec.rb
+- spec/spec_helper.rb
+has_rdoc: