Allow overriding the log path with environment variables

Author: chrisbarber86

README.md

@@ -46,6 +46,15 @@ Example.
 
 Start your rails server as normal in the set environment. Navigate to /logput e.g. [http://localhost:3000/logput](http://localhost:3000/logput)
 
+## Environment Variable Overrides
+
+It is possible to overide the location of the log files by using the following environment variables:
+
+* `LOG_NAME` - The name of the log file, e.g. `development` - `.log` will be appended to this. If unset logput will try to use `RAILS_ENV` or `RACK_ENV` as a fallback
+* `LOG_LOCATION_DIR` - The directory where the log file is located, e.g. `logs` - a `/` will be added when combined with the log name.
+
+The overrides will only be used if both are present (or the fallbacks in the case of the log name).
+
 ## Contributing
 
 1. Fork it

lib/logput/adapters/base.rb

@@ -29,6 +29,24 @@ def self.handles?(_logger)
       def path
         raise NotImplementedError
       end
+
+      # Enable overriding of the path with an environment variable
+      # @return [String] path
+      def path_override
+        return unless directory && filename
+
+        "#{directory}/#{filename}.log"
+      end
+
+      private
+
+      def filename
+        @filename ||= ENV['LOG_NAME'] || ENV['RAILS_ENV'] || ENV['RACK_ENV']
+      end
+
+      def directory
+        @directory ||= ENV['LOG_LOCATION_DIR']
+      end
     end
   end
 end

lib/logput/adapters/logger.rb

@@ -15,6 +15,7 @@ def self.handles?(logger)
 
       # @return [String] path
       def path
+        return path_override if path_override
         @logger.instance_variable_get(:@logdev).filename
       end
     end

lib/logput/adapters/tagged_logging.rb

@@ -15,6 +15,7 @@ def self.handles?(logger)
 
       # @return [String] path
       def path
+        return path_override if path_override
         @logger.instance_variable_get(:@logger).instance_variable_get(:@log_dest).path
       end
     end

spec/adapters/base_spec.rb

@@ -33,4 +33,25 @@ class UnRegisteredAdapter < Logput::Adapters::Base
       }.to raise_error(NotImplementedError)
     end
   end
+
+  describe '#path_override' do
+    subject { described_class.new(:foo) }
+
+    after :each do
+      ENV['LOG_NAME'] = nil
+      ENV['LOG_LOCATION_DIR'] = nil
+    end
+
+    it 'returns nil if environment variables are not set' do
+      expect(subject.path_override).to eq(nil)
+    end
+
+    it 'returns a path if the environment variables are set' do
+      ENV['LOG_NAME'] = 'development'
+      ENV['LOG_LOCATION_DIR'] = 'logs'
+      expect(subject.path_override).to eq('logs/development.log')
+    end
+
+
+  end
 end

spec/adapters/logger_spec.rb

@@ -26,5 +26,18 @@
     it 'returns the correct path' do
       expect(subject.path).to eq(path)
     end
+
+    context 'when environment variable overrides are present' do
+      after :each do
+        ENV['LOG_NAME'] = nil
+        ENV['LOG_LOCATION_DIR'] = nil
+      end
+
+      it 'returns the overridden path' do
+        ENV['LOG_NAME'] = 'development'
+        ENV['LOG_LOCATION_DIR'] = 'logs'
+        expect(subject.path).to eq('logs/development.log')
+      end
+    end
   end
 end

spec/adapters/tagged_logging_spec.rb

@@ -29,5 +29,18 @@
     it 'returns the correct path' do
       expect(subject.path).to eq(path)
     end
+
+    context 'when environment variable overrides are present' do
+      after :each do
+        ENV['LOG_NAME'] = nil
+        ENV['LOG_LOCATION_DIR'] = nil
+      end
+
+      it 'returns the overridden path' do
+        ENV['LOG_NAME'] = 'development'
+        ENV['LOG_LOCATION_DIR'] = 'logs'
+        expect(subject.path).to eq('logs/development.log')
+      end
+    end
   end
 end