loga 1.4.0 → 2.0.0

data/spec/unit/loga/service_version_strategies_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+RSpec.describe Loga::ServiceVersionStrategies do
+  describe '#call' do
+    context 'when GIT is available' do
+      before do
+        allow(described_class::SCM_GIT).to receive(:call).and_return("2776b9c\n")
+      end
+
+      it 'returns the git sha' do
+        expect(subject.call).to eql('2776b9c')
+      end
+    end
+
+    context 'when REVISION file is available' do
+      before do
+        allow(described_class::SCM_GIT).to receive(:call).and_return(nil)
+        allow(File).to receive(:read).with('REVISION').and_return("2776b9c\n")
+      end
+
+      it 'returns the file content' do
+        expect(subject.call).to eql('2776b9c')
+      end
+    end
+
+    context 'when both GIT and REVISION file are unavailable' do
+      before do
+        allow(described_class::SCM_GIT).to       receive(:call).and_return(nil)
+        allow(described_class::REVISION_FILE).to receive(:call).and_return(nil)
+      end
+
+      it 'returns a default value' do
+        expect(subject.call).to eql('unknown.sha')
+      end
+    end
+  end
+end

data/spec/unit/loga_spec.rb

@@ -3,39 +3,76 @@ require 'spec_helper'
 describe Loga do
   before { described_class.reset }
 
-  describe '.configuration' do
-    specify { expect(subject.configuration).to be_instance_of(Loga::Configuration) }
-
-    it 'memoizes the result' do
-      expect(subject.configuration).to equal(subject.configuration)
-    end
+  let(:config_missing_class) { described_class::ConfigurationError }
+  let(:config_missing_msg) do
+    'Loga has not been configured. Configure with Loga.configure(options)'
   end
+  let(:options)           { { service_name: 'hello_world_app' } }
+  let(:framework_options) { { format: 'gelf' } }
 
   describe '.configure' do
     it 'configures Loga' do
-      expect { |b| subject.configure(&b) }.to yield_with_args(subject.configuration)
+      expect(Loga::Configuration).to receive(:new).with(options, {}).and_call_original
+      subject.configure(options)
+    end
+
+    context 'when framework options provided' do
+      it 'configures Loga' do
+        expect(Loga::Configuration)
+          .to receive(:new).with(options, framework_options).and_call_original
+        subject.configure(options, framework_options)
+      end
+    end
+
+    context 'when configure twice' do
+      before { subject.configure(options) }
+
+      it 'raises an error' do
+        expect { subject.configure(options) }
+          .to raise_error(config_missing_class, 'Loga has already been configured')
+      end
     end
   end
 
-  describe '.initialize!' do
-    it 'initializes Loga' do
-      expect { subject.initialize! }.to_not raise_error
+  describe '.configuration' do
+    context 'when Loga is not configured' do
+      it 'raises an error' do
+        expect { subject.configuration }
+          .to raise_error(config_missing_class, config_missing_msg)
+      end
+    end
+
+    context 'when Loga is configured' do
+      before { subject.configure(options) }
+
+      it 'returns the configuration' do
+        expect(subject.configuration.service_name).to eql(options[:service_name])
+      end
     end
   end
 
   describe '.logger' do
-    context 'when Loga is not initialized' do
-      specify { expect(subject.logger).to be_nil }
+    context 'when Loga is not configured' do
+      it 'raises an error' do
+        expect { subject.logger }
+          .to raise_error(config_missing_class, config_missing_msg)
+      end
     end
-    context 'when Loga is initialized' do
-      before { Loga.initialize! }
+
+    context 'when Loga is configured' do
+      before { subject.configure(options) }
       specify { expect(subject.logger).to be_kind_of(Logger) }
     end
   end
 
   describe '.reset' do
+    before { subject.configure(options) }
+
     it 'resets the configuration' do
-      expect { subject.reset }.to change { subject.configuration.object_id }
+      expect do
+        subject.reset
+        subject.configure(options)
+      end.to change { subject.configuration.object_id }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loga
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Funding Circle
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
 description: Log aggregation through unified logging middleware, while respecting
   the original log format.
 email:
@@ -161,9 +203,11 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - Appraisals
+- CHANGELOG.md
 - Gemfile
+- Guardfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - circle.yml
@@ -184,7 +228,7 @@ files:
 - lib/loga/rack/request.rb
 - lib/loga/rack/request_id.rb
 - lib/loga/railtie.rb
-- lib/loga/revision_strategy.rb
+- lib/loga/service_version_strategies.rb
 - lib/loga/tagged_logging.rb
 - lib/loga/utilities.rb
 - lib/loga/version.rb
@@ -297,11 +341,12 @@ 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/service_version_strategies_spec.rb
 - spec/unit/loga/utilities_spec.rb
 - spec/unit/loga_spec.rb
 homepage: https://github.com/FundingCircle/loga
-licenses: []
+licenses:
+- BSD-3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -432,7 +477,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/service_version_strategies_spec.rb
 - spec/unit/loga/utilities_spec.rb
 - spec/unit/loga_spec.rb
 has_rdoc: 

data/.rubocop_todo.yml

@@ -1,33 +0,0 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-06-18 23:19:09 +0100 using RuboCop version 0.30.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 2
-Lint/HandleExceptions:
-  Enabled: false
-
-# Offense count: 2
-Lint/RescueException:
-  Enabled: false
-
-# Offense count: 4
-Metrics/AbcSize:
-  Max: 29
-
-# Offense count: 16
-# Configuration parameters: AllowURI, URISchemes.
-Metrics/LineLength:
-  Max: 93
-
-# Offense count: 8
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 22
-
-# Offense count: 14
-Style/Documentation:
-  Enabled: false
-

data/lib/loga/revision_strategy.rb

@@ -1,32 +0,0 @@
-# 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/spec/unit/loga/revision_strategy_spec.rb

@@ -1,41 +0,0 @@
-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