loga 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feb7e0fc4418e6763bb4cbe7cd0a381e8f0edf09
-  data.tar.gz: 7ee939ed4ba16283823ca2ca8f77bd9148e145b3
+  metadata.gz: a962ebefb507146c9e7e2586efb356fd9615db7d
+  data.tar.gz: d1cc277cb5364e6b017d1c2e8f5524da815d9f88
 SHA512:
-  metadata.gz: 71a379ec8c9659592d58dc1c0fae6096d00c6ed457368d26013970108ee4957141a5323620d931824768c2304ff04d95a1b707d90e893f3a2c0c3751054cb725
-  data.tar.gz: 3d71749a93556d196ea112fefa59cf26544a5b883dbda8044238ee759dde6dee71956ff74c4cbf1caaa06a088fd514de7f584ffdef6cc4699e7ae7984e661578
+  metadata.gz: cd8aa79bea6fc3f231a11da411e4157ba61b9c7ed26bd016cf6627a211ca74cc46e41577ee1a3480c046323d5cc9a936bcea175c3bdb9f52aef4a8af91bae60b
+  data.tar.gz: af8f9e6abb19c279a1b3ca59310e33a0123e6b9e7d618d6a4e8bdca14ba237f2c8f929377d3f95c03157e06add6e0b011ba0bfe111154da2eb4411191c0992c0

data/lib/loga.rb

@@ -5,6 +5,7 @@ require 'loga/utilities'
 require 'loga/event'
 require 'loga/formatter'
 require 'loga/parameter_filter'
+require 'loga/revision_strategy'
 require 'loga/rack/logger'
 require 'loga/rack/request'
 require 'loga/rack/request_id'

data/lib/loga/configuration.rb

@@ -1,7 +1,5 @@
 require 'logger'
 require 'socket'
-require 'active_support'
-require 'active_support/core_ext/object/blank'
 
 module Loga
   class Configuration
@@ -43,26 +41,8 @@ module Loga
 
     private
 
-    class GitRevisionStrategy
-      DEFAULT_REVISION = 'unknown.sha'.freeze
-
-      def self.call
-        revision = fetch_revision   if binary_available?
-        revision = DEFAULT_REVISION if revision.blank?
-        revision
-      end
-
-      def self.binary_available?
-        system 'which git'
-      end
-
-      def self.fetch_revision
-        `git rev-parse HEAD`.strip
-      end
-    end
-
     def compute_service_version
-      service_version == :git ? GitRevisionStrategy.call : service_version.strip
+      RevisionStrategy.call(service_version)
     end
 
     def initialize_logger

data/lib/loga/revision_strategy.rb

@@ -0,0 +1,32 @@
+# rubocop:disable Style/SpecialGlobalVars
+require 'active_support/core_ext/object/blank'
+
+module Loga
+  class RevisionStrategy
+    DEFAULT_REVISION = 'unknown.sha'.freeze
+
+    class << self
+      def call(service_version = :git)
+        if service_version == :git
+          fetch_from_git || read_from_file || DEFAULT_REVISION
+        elsif service_version.blank?
+          DEFAULT_REVISION
+        else
+          service_version.strip
+        end
+      end
+
+      def fetch_from_git
+        sha1_hash = `git rev-parse --short HEAD`
+        $?.exitstatus == 0 ? sha1_hash.strip : false
+      end
+
+      def read_from_file
+        File.read('REVISION').strip
+      rescue Errno::ENOENT
+        false
+      end
+    end
+  end
+end
+# rubocop:enable Style/SpecialGlobalVars

data/lib/loga/version.rb

@@ -1,3 +1,3 @@
 module Loga
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/unit/loga/configuration_spec.rb

@@ -44,14 +44,6 @@ describe Loga::Configuration do
       subject.initialize!
     end
 
-    context 'when service_version is :git' do
-      before { subject.service_version = :git }
-      it 'computes the service_version with git' do
-        subject.initialize!
-        expect(subject.service_version).to match(/\h+/)
-      end
-    end
-
     describe 'logger' do
       let(:logdev) { subject.logger.instance_variable_get(:@logdev) }
 

data/spec/unit/loga/revision_strategy_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Loga::RevisionStrategy do
+  describe '.call' do
+    it 'uses :git as default argument' do
+      expect(Loga::RevisionStrategy.call).to match(/\h+/)
+    end
+
+    it "returns 'unknown.sha' when argument is empty string" do
+      expect(Loga::RevisionStrategy.call('')).to eq('unknown.sha')
+    end
+
+    context 'called with :git argument' do
+      it 'fetches the service version from git' do
+        expect(Loga::RevisionStrategy.call(:git)).to match(/\h+/)
+      end
+
+      it 'reads the REVISION file when no git repo' do
+        allow(Loga::RevisionStrategy).to receive(:fetch_from_git) { false }
+        expect(File).to receive(:read).with('REVISION').and_return('sha1_hash')
+        expect(Loga::RevisionStrategy.call(:git)).to eq('sha1_hash')
+      end
+
+      it "returns 'unknown.sha' otherwise" do
+        allow(Loga::RevisionStrategy).to receive(:fetch_from_git) { false }
+        allow(Loga::RevisionStrategy).to receive(:read_from_file) { false }
+        expect(Loga::RevisionStrategy.call(:git)).to eq('unknown.sha')
+      end
+    end
+
+    context 'called with anything else' do
+      it 'returns the argument called with' do
+        expect(Loga::RevisionStrategy.call('foobar')).to eq('foobar')
+      end
+
+      it 'strips any leading and trailing whitespace' do
+        expect(Loga::RevisionStrategy.call("\t foobar\r\n ")).to eq('foobar')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loga
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Funding Circle
@@ -182,6 +182,7 @@ files:
 - lib/loga/rack/request.rb
 - lib/loga/rack/request_id.rb
 - lib/loga/railtie.rb
+- lib/loga/revision_strategy.rb
 - lib/loga/tagged_logging.rb
 - lib/loga/utilities.rb
 - lib/loga/version.rb
@@ -256,6 +257,7 @@ files:
 - spec/unit/loga/parameter_filter_spec.rb
 - spec/unit/loga/rack/logger_spec.rb
 - spec/unit/loga/rack/request_spec.rb
+- spec/unit/loga/revision_strategy_spec.rb
 - spec/unit/loga/utilities_spec.rb
 - spec/unit/loga_spec.rb
 homepage: https://github.com/FundingCircle/loga
@@ -352,6 +354,7 @@ test_files:
 - spec/unit/loga/parameter_filter_spec.rb
 - spec/unit/loga/rack/logger_spec.rb
 - spec/unit/loga/rack/request_spec.rb
+- spec/unit/loga/revision_strategy_spec.rb
 - spec/unit/loga/utilities_spec.rb
 - spec/unit/loga_spec.rb
 has_rdoc: