lookout-rack-utils 4.0.0.44 → 5.0.0.49

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c8d885772670c69b20f26cad8eafdf9a09414556
-  data.tar.gz: 5dff0ce7ee50afd78f03766167f6983cb26984d7
+SHA256:
+  metadata.gz: 07ec222e8dfb77be261665631a968c43ec2f4a96e480ec7526315884a9c7518f
+  data.tar.gz: 5b8203b6bccc84e42275726154290f991e3fdbdcee903d8ee4e4d34a4be2f72c
 SHA512:
-  metadata.gz: e8ace2cb4663df9464a78ad5d34611f1c64ac2d26dfc162ebf5e0aa88a876d6bc914aac86dcb5cf1d7c3ceecb80fea6166078e8ce15c4d004305e7f454bc9c9f
-  data.tar.gz: 5ed83519a13bd1f937c0a46f7d5a470feeea95c4b120a825af32f1c17683df18841f3b1e9a76c26921b2abfc3dd07b79df89bf17128aa51accb8dfc3a6b50299
+  metadata.gz: b04ac7ce56b5b97da144db91eed4348b4282a670954e38f62bc47e8027de3c742b015a3c4ab0f3b1fb6fa9e1bd1aa62336ff759661a46f5cbb2cb01272fcd80c
+  data.tar.gz: 6dd0b2f45b7c1ccec1240b83eccbff9033114043bcb9f4060f94655032cd8254bf88da0865283220f3fa6c0d0334e9e23f2e928d5ece75eba7405679efbf8832

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
 - jruby
+- 2.5
 - 2.3
-- 1.9.3
 deploy:
   provider: rubygems
   api_key:

data/README.md

@@ -59,8 +59,17 @@ app:
   Note that we expect `t(*args)` to be called in the context of a request.
 
 ### Lookout::Rack::Utils::Log
-  You'll need configatron set up.  If `Lookout::Rack::Utils::Graphite` is
-present, it will increment those stats whenever a log is written.
+
+  The logger can be configured with
+
+  ```ruby
+  Lookout::Rack::Utils::Log.set_instance(my_logger)
+  ```
+
+  By default it will use a Lookout::Rack::Utils::LookoutLogger, which
+  wraps Log4R.  You'll need configatron set up.  If
+  `Lookout::Rack::Utils::Graphite` is present, it will increment those
+  stats whenever a log is written.
 
   ```ruby
   configatron.project_name = 'My project name'

data/lib/lookout/rack/utils/log.rb

@@ -1,90 +1,126 @@
 require 'rubygems'
 require 'log4r'
-require 'singleton'
 require 'time'
+require 'thread'
 require 'configatron'
 
 module Lookout::Rack::Utils
-  # Logging.  Logs to log/<project_name>.log with the format:
+  # Logging.  By default, logs to log/<project_name>.log with the format:
   #
   #   [Log Level]: [Timestamp (ISO-8601)]: [File:linenum]: [Log Message]
   #
   # Use through the helper:
   #   log.warn 'This is my log message'
   #
+  # Default logger may be replaced by calling
+  #
+  #    Log.set_instance(my_logger)
   class Log
-    include Singleton
-    include Log4r
+    @@instance = nil
 
-    # Formatter that include the filename and relative path, and line number in
-    # output of the caller.
-    #
-    # Since all callers go through the methods defined in this class to log, we
-    # look at the second line of the tracer output, removing everything but the
-    # directories after the project directory.
+    # Initialize singleton instance to be an instance of
+    # +Lookout::Rack::Utils::LookoutLogger+, with the given options
+    def self.create_instance
+      raise "Already initialized Log" if instance_set?
+      @@instance = LookoutLogger.new
+    end
+
+    # Explicitly set singleton instance. The instance must implement the
+    # same base API as +::Logger+
+    def self.set_instance(instance)
+      raise "Already initialized Log" if instance_set?
+      @@instance = instance
+    end
+
+    # Clear singleton instance, for use in testing ONLY
+    def self.clear_instance
+      @@instance = nil
+    end
+
+    # Check if the instance has been set
+    def self.instance_set?
+      defined?(@@instance) && !!@@instance
+    end
+
+    # Access singleton instance, which must have been initialized with
+    # .create_instance or .set_instance
+    def self.instance
+      create_instance if @@instance.nil?
+      @@instance
+    end
+  end
+
+  # Formatter that include the filename and relative path, and line number in
+  # output of the caller.
+  #
+  # Since all callers go through the methods defined in this class to log, we
+  # look at the second line of the tracer output, removing everything but the
+  # directories after the project directory.
+  #
+  class LookoutFormatter < Log4r::Formatter
+    # Return the project base directory for filtering to help with
+    # identifiying the filename and line number when formatting the log
+    # message
     #
-    class LookoutFormatter < Log4r::Formatter
-      # Return the project base directory for filtering to help with
-      # identifiying the filename and line number when formatting the log
-      # message
-      #
-      # @return [String] Base directory for the project
-      def basedir
-        @basedir ||= File.expand_path(File.join(File.dirname(__FILE__), ".."))
-      end
+    # @return [String] Base directory for the project
+    def basedir
+      @basedir ||= File.expand_path(File.join(File.dirname(__FILE__), ".."))
+    end
 
-      # Return the common base directory between this project and the
-      # given trace. If no common base directory is found, return
-      # basedir.
-      #
-      # This memoizes the result, which can be bad if the first log
-      # comes from an unusual place. However, in all current uses this
-      # is running from an unpacked jar/war and its vastly faster to
-      # memoize the result.
-      #
-      # @param [String] tracer A line from the LogEvent#tracer Array
-      # @return [String] Common base directory with the trace
-      def common_basedir(tracer)
-        return @common_basedir if @common_basedir
-
-        basedir_pieces = basedir.split(File::SEPARATOR)
-        trace_pieces = tracer.split(File::SEPARATOR)
-        i = 0
-        while basedir_pieces[i] == trace_pieces[i]
-          i += 1
-        end
-        # If there were no common directories (besides /), return our basedir
-        @common_basedir = (i <= 1) ? basedir : basedir_pieces[0...i].join(File::SEPARATOR)
+    # Return the common base directory between this project and the
+    # given trace. If no common base directory is found, return
+    # basedir.
+    #
+    # This memoizes the result, which can be bad if the first log
+    # comes from an unusual place. However, in all current uses this
+    # is running from an unpacked jar/war and its vastly faster to
+    # memoize the result.
+    #
+    # @param [String] tracer A line from the LogEvent#tracer Array
+    # @return [String] Common base directory with the trace
+    def common_basedir(tracer)
+      return @common_basedir if @common_basedir
+
+      basedir_pieces = basedir.split(File::SEPARATOR)
+      trace_pieces = tracer.split(File::SEPARATOR)
+      i = 0
+      while basedir_pieces[i] == trace_pieces[i]
+        i += 1
       end
+      # If there were no common directories (besides /), return our basedir
+      @common_basedir = (i <= 1) ? basedir : basedir_pieces[0...i].join(File::SEPARATOR)
+    end
 
-      # Return a trimmed version of the filename from where a LogEvent occurred
-      # @param [String] tracer A line from the LogEvent#tracer Array
-      # @return [String] Trimmed and parsed version of the file ane line number
-      def event_filename(tracer)
-        base = common_basedir(tracer)
-        parts = tracer.match(/#{base}\/(.*:[0-9]+).*:/)
-
-        # If we get no matches back, we're probably in a jar file in which case
-        # the format of the tracer is going to be abbreviated
-        if parts.nil?
-          parts = tracer.match(/(.*:[0-9]+).*:/)
-        end
-        return parts[-1] if parts
+    # Return a trimmed version of the filename from where a LogEvent occurred
+    # @param [String] tracer A line from the LogEvent#tracer Array
+    # @return [String] Trimmed and parsed version of the file and line number
+    def event_filename(tracer)
+      base = common_basedir(tracer)
+      parts = tracer.match(/#{base}\/(.*:[0-9]+).*:/)
+
+      # If we get no matches back, we're probably in a jar file in which case
+      # the format of the tracer is going to be abbreviated
+      if parts.nil?
+        parts = tracer.match(/(.*:[0-9]+).*:/)
       end
+      return parts[-1] if parts
+    end
 
-      # Receive the LogEvent and pull out the log message and format it for
-      # display in the logs
-      #
+    # Receive the LogEvent and pull out the log message and format it for
+    # display in the logs
+    #
       # @param [Log4r::LogEvent] event
-      # @return [String] Formatted log message
-      def format(event)
-        filename = event_filename(event.tracer[1])
-        # CCYY-MM-DDThh:mm:ss.sssTZD
-        time = Time.now.utc.iso8601 3
-        return "#{Log4r::LNAMES[event.level]}: #{time}: #{filename}: #{event.data}\n"
-      end
+    # @return [String] Formatted log message
+    def format(event)
+      filename = event_filename(event.tracer[1])
+      # CCYY-MM-DDThh:mm:ss.sssTZD
+      time = Time.now.utc.iso8601 3
+      return "#{Log4r::LNAMES[event.level]}: #{time}: #{filename}: #{event.data}\n"
     end
+  end
 
+  class LookoutLogger
+    include Log4r
 
     attr_reader :outputter
 

data/lib/lookout/rack/utils/version.rb

@@ -1,7 +1,7 @@
 module Lookout
   module Rack
     module Utils
-      VERSION = "4.0.0"
+      VERSION = "5.0.0"
     end
   end
 end

data/lookout-rack-utils.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "sinatra", '~> 2.0'
   spec.add_development_dependency "timecop"
 
   spec.add_runtime_dependency "i18n"

data/spec/log_spec.rb

@@ -4,7 +4,64 @@ require 'timecop'
 require 'configatron'
 
 describe Lookout::Rack::Utils::Log do
-  subject(:log) { described_class.instance }
+  before(:each) do
+    described_class.clear_instance
+  end
+
+  after(:each) do
+    described_class.clear_instance
+  end
+
+  describe '.create_instance' do
+    it 'creates an instance' do
+      described_class.create_instance
+      expect(described_class.instance).to be_a(Lookout::Rack::Utils::LookoutLogger)
+    end
+
+    context 'if an instance has been created' do
+      before :each do
+        described_class.create_instance
+      end
+      it 'raises if called twice' do
+        expect { described_class.create_instance }.to raise_error /Already initialized/
+      end
+    end
+  end
+
+  describe '.set_instance' do
+    let(:instance) { double('Logger') }
+
+    it 'sets instance' do
+      described_class.set_instance(instance)
+      expect(described_class.instance).to eq instance
+    end
+
+    context 'if an instance has been created' do
+      before :each do
+        described_class.set_instance(instance)
+      end
+      it 'raises if called twice' do
+        expect { described_class.set_instance(instance) }.to raise_error /Already initialized/
+      end
+    end
+  end
+
+  describe '.instance' do
+    let(:instance) { double('Logger') }
+
+    it 'creates default instance if not set' do
+      expect(described_class.instance).to be_a(Lookout::Rack::Utils::LookoutLogger)
+    end
+
+    it 'returns set instance if set' do
+      described_class.set_instance(instance)
+      expect(described_class.instance).to eq(instance)
+    end
+  end
+end
+
+describe Lookout::Rack::Utils::LookoutLogger do
+  subject(:log) { described_class.new }
   let(:log_message) { 'foo' }
   let(:filename) { "log" }
   let(:exclude_levels) { [] }
@@ -90,7 +147,7 @@ describe Lookout::Rack::Utils::Log do
   end
 end
 
-describe Lookout::Rack::Utils::Log::LookoutFormatter do
+describe Lookout::Rack::Utils::LookoutFormatter do
   subject(:formatter) { described_class.new }
   let(:logger) do
     logger = double('Mock Logger')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lookout-rack-utils
 version: !ruby/object:Gem::Version
-  version: 4.0.0.44
+  version: 5.0.0.49
 platform: ruby
 authors:
 - Ian Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2018-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,16 +84,16 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -241,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: ''