logput 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cbacb1dd5d03161a1b94546de8454b44fd66084
-  data.tar.gz: cbcc16f6c0207a1b9d47f6c2e51d9a166a9520c4
+  metadata.gz: 19a7457eddef652b545880acae4704d2b6f238da
+  data.tar.gz: b2a1859fcc2bdb935192a177ce82de6f1234ef46
 SHA512:
-  metadata.gz: 9f2af5f8a8eca97c8e94c465c558087467340feb61aaaa975102ee9949c611f4e7c15464d2ee370ed1e574bcb2167d1684aa10d6b4d0e40a6d4724146fc47962
-  data.tar.gz: 4d9ba7d77cecfcb8e4c52c6237a9dbf73de61a0d4b30b369bf9f4d1437b30bcb10f8cae10af233d7fbaa158a0e553c07a0a18da9176f61578fbd524b16f47076
+  metadata.gz: b910ed111410a841bcf269d45731b026cd75d0a8beb6c64b9ec087032a25f82bf810c57114982fb315893ce58460474f4c4d18fcf32a23a0e9cdf4304826422f
+  data.tar.gz: 06e122d67f32127abee46d988ddcb388c4ec761acf6873df197680b15c81cbfce814f6b404006f4cd05210ed12f9ffbecb7764c755bd1a511a895dfda2d30868

data/Fudgefile

@@ -15,7 +15,7 @@ task_group :duplication do
 end
 
 task_group :complexity do
-  task :flog, :exclude => '^\.\/spec\/', :max => 7.7, :average => 5.7, :methods => true
+  task :flog, :exclude => '^\.\/spec\/', :methods => true
 end
 
 build :default do

data/README.md

@@ -1,15 +1,20 @@
 # Logput
 
-[![Build Status](https://api.travis-ci.org/asmega/logput.svg)](https://travis-ci.org/asmega/logput)
+[![Build Status](https://api.travis-ci.org/asmega/logput.svg)](https://travis-ci.org/asmega/logput) [![Code Climate](https://codeclimate.com/github/asmega/logput/badges/gpa.svg)](https://codeclimate.com/github/asmega/logput) [![Dependency Status](https://gemnasium.com/asmega/logput.svg)](https://gemnasium.com/asmega/logput) [![Gem Version](https://badge.fury.io/rb/logput.svg)](https://badge.fury.io/rb/logput)
 
 Rack middleware to sit in a rails app to put put the current environments log to a webpage. eg /logput
 
 To be used in test and development environments to see logs without needing direct access to the box.
 
-This NOT to be used in production like environments.
+:warning: This is *NOT* to be used in production like environments.
 
 Supports Rails 3.x.x and 4.x.x
 
+## Credits
+
+* Phil Lee ([@asmega](https://github.com/asmega)) [Author]
+* Chris Barber ([@chrisbarber86](https://github.com/chrisbarber86))
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,14 +37,14 @@ Inside you rails app. Add the following line to config/development.rb and/or any
 
 The following configuration options are available.
 
-* :path_to_log_file => '/path/to/custom/log'. Defaults to current environments log file if in rails.
-* :lines_to_read => 1000. Defaults to 500.
+* `:path_to_log_file => '/path/to/custom/log'`. Defaults to current environments log file if in rails.
+* `:lines_to_read => 1000`. Defaults to 500.
 
 Example.
 
     config.middleware.use(Logput::Middleware, :lines_to_read => 300, :path_to_log_file => './log/delayed_job')
 
-Start you rails server as normal in the set environemnt. Navigate to /logput e.g. [http://localhost:3000/logput](http://localhost:3000/logput)
+Start your rails server as normal in the set environment. Navigate to /logput e.g. [http://localhost:3000/logput](http://localhost:3000/logput)
 
 ## Contributing
 

data/lib/logput/adapters/base.rb

@@ -0,0 +1,34 @@
+# Logput
+module Logput
+  # Logging Adapters
+  module Adapters
+    # Base class from which all adapters inherit
+    class Base
+      # Initialize
+      def initialize(logger)
+        @logger = logger
+      end
+
+      # Registers a new adapter
+      #
+      # @param [Symbol] adapter The name of the adapter
+      def self.register(adapter)
+        raise "Already Registered :#{adapter}" if Logput::Adapters.registered_adapters[adapter]
+        Logput::Adapters.registered_adapters[adapter] = self
+      end
+
+      # Placeholder for handles? method to be overridden when subclassed
+      # @param [Class] _logger
+      # @return [Boolean]
+      def self.handles?(_logger)
+        raise NotImplementedError
+      end
+
+      # Placeholder for path method to be overridden when subclassed
+      # @return [String] path
+      def path
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/logput/adapters/logger.rb

@@ -0,0 +1,22 @@
+# Logput
+module Logput
+  # Logging Adapters
+  module Adapters
+    # Logger Adapter
+    class Logger < Base
+      register :logger
+
+      # @param [Class] logger
+      # @return [Boolean]
+      def self.handles?(logger)
+        return false unless logger
+        logger.is_a? ::Logger
+      end
+
+      # @return [String] path
+      def path
+        @logger.instance_variable_get(:@logdev).filename
+      end
+    end
+  end
+end

data/lib/logput/adapters/tagged_logging.rb

@@ -0,0 +1,22 @@
+# Logput
+module Logput
+  # Logging Adapters
+  module Adapters
+    # Active Support Tagged Logging Adapter
+    class TaggedLogging < Base
+      register :tagged_logging
+
+      # @param [Class] logger
+      # @return [Boolean]
+      def self.handles?(logger)
+        return false unless logger
+        logger.is_a? ::ActiveSupport::TaggedLogging
+      end
+
+      # @return [String] path
+      def path
+        @logger.instance_variable_get(:@logger).instance_variable_get(:@log_dest).path
+      end
+    end
+  end
+end

data/lib/logput/adapters.rb

@@ -0,0 +1,23 @@
+# Logput
+module Logput
+  # Logging Adapters
+  module Adapters
+    # @return [Hash] Currently registered adapters
+    def self.registered_adapters
+      @registered_adapters ||= {}
+    end
+
+    # Find a registered adapter
+    # @return [Adapter] An instance of the adapter, or raise an exception
+    def self.obtain(logger)
+      registered_adapters.each do |_, adapter|
+        return adapter.new(logger) if adapter.handles?(logger)
+      end
+      raise "#{logger} is not supported."
+    end
+
+    require 'logput/adapters/base'
+    require 'logput/adapters/logger'
+    require 'logput/adapters/tagged_logging'
+  end
+end

data/lib/logput/middleware.rb

@@ -10,36 +10,48 @@ module Logput
 
     # Call
     def call(env)
-      @path_to_log_file ||= default_path_to_log_file(env)
+      @env = env
+      @path_to_log_file ||= default_path_to_log_file
 
-      raise 'Log file does not exist' unless File.exists? @path_to_log_file
+      ensure_log_file_exists!
 
-      if env['PATH_INFO'] == '/logput'
-        out = `tail -n #{@lines_to_read} #{@path_to_log_file}`
-        [200, {"Content-Type" => "text/html"}, ["<pre>", out, "</pre>"]]
+      if is_logput?
+        generate_output!
       else
-        @app.call(env)
+        @app.call(@env)
       end
     end
 
     private
 
-    def default_path_to_log_file(env)
+    def ensure_log_file_exists!
+      raise 'Log file does not exist' unless File.exist? @path_to_log_file
+    end
+
+    def is_logput?
+      @env['PATH_INFO'] == '/logput'
+    end
+
+    def generate_output!
+      out = `tail -n #{@lines_to_read} #{@path_to_log_file}`
+      [200, {"Content-Type" => "text/html"}, ["<pre>", out, "</pre>"]]
+    end
+
+    def default_path_to_log_file
       raise Exception, 'Must specify path to Rails log file' unless defined? Rails
-      path(logger(env)) || raise(Exception, "#{logger(env).class} not supported.")
+      path
     end
 
-    def logger(env)
-      env['action_dispatch.logger']
+    def logger
+      @env['action_dispatch.logger']
     end
 
-    def path(logger)
-      case logger
-        when ::ActiveSupport::TaggedLogging
-          logger.instance_variable_get(:@logger).instance_variable_get(:@log_dest).path
-        when ::Logger
-          logger.instance_variable_get(:@logdev).filename
-      end
+    def path
+      logger_adapter.path
+    end
+
+    def logger_adapter
+      @logger_adapter ||= Logput::Adapters.obtain(logger)
     end
   end
 end

data/lib/logput/version.rb

@@ -1,5 +1,5 @@
 # Logput
 module Logput
   # Gem version
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/logput.rb

@@ -4,4 +4,5 @@ require 'rack'
 # Logput
 module Logput
   autoload :Middleware, 'logput/middleware'
+  autoload :Adapters, 'logput/adapters'
 end

data/spec/adapters/base_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+class UnRegisteredAdapter < Logput::Adapters::Base
+end
+
+describe Logput::Adapters::Base do
+  describe '.register' do
+    after :each do
+      Logput::Adapters.registered_adapters.delete(:test)
+    end
+
+    it 'adds the current adapter to the registry' do
+      expect(Logput::Adapters.registered_adapters[:test]).to eq(nil)
+      UnRegisteredAdapter.register :test
+      expect(Logput::Adapters.registered_adapters[:test]).to eq(UnRegisteredAdapter)
+    end
+  end
+
+  describe '.handles?' do
+    it 'raises a NotImplementedError' do
+      expect {
+        described_class.handles?(double)
+      }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#path' do
+    subject { described_class.new(:foo) }
+
+    it 'raises a NotImplementedError' do
+      expect {
+        subject.path
+      }.to raise_error(NotImplementedError)
+    end
+  end
+end

data/spec/adapters/logger_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Logput::Adapters::Logger do
+  describe '.handles?' do
+    it 'returns true when passed a Logger instance' do
+      expect(described_class.handles?(::Logger.new)).to eq(true)
+    end
+
+    it 'returns false when passed anything else' do
+      expect(described_class.handles?(::ActiveSupport::TaggedLogging.new)).to eq(false)
+      expect(described_class.handles?(:foo)).to eq(false)
+    end
+  end
+
+  describe '#path' do
+    let(:path) { './spec/support/test.log' }
+    let(:logger) { ::Logger.new }
+    let(:logdev) { double(:filename => path) }
+
+    before :each do
+      allow(logger).to receive(:instance_variable_get).with(:@logdev).and_return(logdev)
+    end
+
+    subject { described_class.new(logger) }
+
+    it 'returns the correct path' do
+      expect(subject.path).to eq(path)
+    end
+  end
+end

data/spec/adapters/tagged_logging_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Logput::Adapters::TaggedLogging do
+  describe '.handles?' do
+    it 'returns true when passed an ActiveSupport::TaggedLogging instance' do
+      expect(described_class.handles?(::ActiveSupport::TaggedLogging.new)).to eq(true)
+    end
+
+    it 'returns false when passed anything else' do
+      expect(described_class.handles?(::Logger.new)).to eq(false)
+      expect(described_class.handles?(:foo)).to eq(false)
+    end
+  end
+
+  describe '#path' do
+    let(:path) { './spec/support/test.log' }
+    let(:logger) { ::ActiveSupport::TaggedLogging.new }
+    let(:logvar) { double }
+    let(:logdev) { double(:filename => path) }
+    let(:log_dest) { double(:path => path) }
+
+    before :each do
+      allow(logger).to receive(:instance_variable_get).with(:@logger).and_return(logvar)
+      allow(logvar).to receive(:instance_variable_get).with(:@log_dest).and_return(log_dest)
+    end
+
+    subject { described_class.new(logger) }
+
+    it 'returns the correct path' do
+      expect(subject.path).to eq(path)
+    end
+  end
+end

data/spec/adapters_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+class TestAdapter
+  def initialize(logger); end
+  def self.handles?(logger); false; end
+end
+
+describe Logput::Adapters do
+
+  describe '.registered_adapters' do
+    let(:expected) {{
+      logger: Logput::Adapters::Logger,
+      tagged_logging: Logput::Adapters::TaggedLogging
+    }}
+
+    it 'returns a hash of registered adapters' do
+      expect(described_class.registered_adapters).to eq(expected)
+    end
+  end
+
+  describe '.obtain' do
+    before :each do
+      Logput::Adapters.registered_adapters[:test] = TestAdapter
+    end
+
+    context 'when an adapter matches' do
+      it 'returns an instance of a matching adapter' do
+        allow(TestAdapter).to receive(:handles?).with(:bar).and_return(true)
+        expect(described_class.obtain(:bar)).to be_a(TestAdapter)
+      end
+    end
+
+    context 'when no adapter matches' do
+      it 'raises a logger not supported exception' do
+        expect {
+          described_class.obtain(:foo)
+        }.to raise_error
+      end
+    end
+  end
+end

data/spec/middleware_spec.rb

@@ -1,9 +1,5 @@
 require 'spec_helper'
 
-module ActiveSupport; class TaggedLogging; end; end
-class Logger; end
-class Rails; end
-
 describe Logput::Middleware do
   subject{ described_class.new(app, :path_to_log_file => './spec/support/test.log') }
 

data/spec/spec_helper.rb

@@ -22,3 +22,7 @@ RSpec.configure do |config|
 
   config.requires = ['logput']
 end
+
+module ActiveSupport; class TaggedLogging; end; end
+class Logger; end
+class Rails; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logput
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Philip Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2016-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -166,9 +166,17 @@ files:
 - README.md
 - Rakefile
 - lib/logput.rb
+- lib/logput/adapters.rb
+- lib/logput/adapters/base.rb
+- lib/logput/adapters/logger.rb
+- lib/logput/adapters/tagged_logging.rb
 - lib/logput/middleware.rb
 - lib/logput/version.rb
 - logput.gemspec
+- spec/adapters/base_spec.rb
+- spec/adapters/logger_spec.rb
+- spec/adapters/tagged_logging_spec.rb
+- spec/adapters_spec.rb
 - spec/middleware_spec.rb
 - spec/spec_helper.rb
 - spec/support/test.log
@@ -192,11 +200,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Rack middleware to output rails logs to a webpage
 test_files:
+- spec/adapters/base_spec.rb
+- spec/adapters/logger_spec.rb
+- spec/adapters/tagged_logging_spec.rb
+- spec/adapters_spec.rb
 - spec/middleware_spec.rb
 - spec/spec_helper.rb
 - spec/support/test.log