dvla-herodotus 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44f213f7b551a5dedbe3caaca66eafc7471b539eac4ec2271b3687e0be26d934
-  data.tar.gz: 21b3bf02e8ddf43b4eb8accadd47a607a25013943869e8b3b03587e3157568fd
+  metadata.gz: e438adf38dbfed19a683688cbd116e9df9cd2381c64142ce1334eeea84ae681c
+  data.tar.gz: 6c4fc10b6f03e57261971d56fb86570283020c48217bdb4cdbb7ed6920a2a894
 SHA512:
-  metadata.gz: 22fed7800687b7acaf63195afd9c93fcab67914b6456ad8928f2cd4345b256f92ff91b7c22239e2c9bb65853b1dd976f6835647f25431c42e1335af8c541c6e3
-  data.tar.gz: 72177da622343e613def838c5e195e0da15c8fccaf8dadcb3bf84ce164eab7b1c481e45c898ca5b7ad99004634ad4e58bd339a6788aca1780786121852ada22b
+  metadata.gz: c4942f36ded7e851ba5e9a43254dd02ec02a3e2bf1df3580103502873fe16d2f28787960c0277417c415103411f17d8396fe4947f5feeead0ac408cbf928756c
+  data.tar.gz: '095addb8fe673dcf789bec32357bad374aec2ffc6fc58e7331fbf20070dc22680630ca386ea5dc6b5a4fa2114e6ed701787747cd988d171788cf1a444bddf8c8'

data/.github/workflows/gem-build.yml

@@ -0,0 +1,39 @@
+name: Ruby Build
+
+on:
+  schedule:
+    - cron: '0 7 * * 1'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ '3.0', '3.1', '3.2' ]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      
+      - name: Run checks
+        run: |
+          gem install bundler-audit
+          bundle-audit check --update
+          bundle exec rspec
+      
+      - name: Report test failure
+        if: ${{ failure() }}
+        run:  |
+          COMMIT_MESSAGE=$(git log -1 --pretty=%B)
+          COMMIT_AUTHOR=$(git log -1 --pretty=format:'%an')
+          curl -H 'Content-Type: application/json' -d "{\"title\": \"${REPO_NAME} GitHub build failed.\",\"text\": \"Build **${BUILD_NUMBER}** on the main branch by ${COMMIT_AUTHOR}  [GitHub Action](${ACTION_LINK}) | [Repo Branch](${BRANCH_LINK})  **Commit Message** ${COMMIT_MESSAGE}\",\"themeColor\": \"EA4300\"}" -s ${WEBHOOK_URL}
+        env:
+          REPO_NAME: "${{ github.event.repository.name }}"
+          BUILD_NUMBER: "${{ github.run_number }}"
+          ACTION_LINK: "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+          BRANCH_LINK: "${{ github.server_url }}/${{ github.repository }}"
+          WEBHOOK_URL: "${{ secrets.WEBHOOK_URL }}"

data/.rubocop.yml

@@ -0,0 +1,3 @@
+---
+inherit_gem:
+  dvla-lint: ".rubocop.yml"

data/README.md

@@ -28,12 +28,18 @@ You can get a logger by calling the following once Herodotus is installed:
 logger = DVLA::Herodotus.logger
 ```
 
-You can also provide the path to an output file, which will be logged to simultaneously with standard console logger
+You can also log out to a file. If you want all the logs in a single file, provide a string of the path to that output file and it will be logged to simultaneously with standard console logger
 
 ```ruby
 logger = DVLA::Herodotus.logger(output_path: 'logs.txt')
 ```
 
+Alternatively, if you want each scenario to log out to a separate file based on the scenario name, pass in a lambda that returns a string that attempts to interpolate `@scenario`.
+
+```ruby
+logger = DVLA::Herodotus.logger(output_path: -> { "#{@scenario}_log.txt" })
+```
+
 This is a standard Ruby logger, so anything that would work on a logger acquired the traditional way will also work here, however it is formatted such that all logs will be output in the following format:
 
 `[CurrentDate CurrentTime CorrelationId] Level : -- Message`

data/dvla-herodotus.gemspec

@@ -21,5 +21,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
+  spec.add_development_dependency 'dvla-lint', '~> 1.7'
   spec.add_development_dependency 'rspec', '~> 3.8'
 end

data/lib/dvla/herodotus/herodotus_logger.rb

@@ -7,6 +7,7 @@ module DVLA
 
       def register_default_correlation_id
         @correlation_ids = { default: SecureRandom.uuid[0, 8] }
+        @current_scenario = :default
         reset_format
       end
 
@@ -28,9 +29,11 @@ module DVLA
       %i[debug info warn error fatal].each do |log_level|
         define_method log_level do |progname = nil, scenario_id = nil, &block|
           if scenario_id == nil
+            set_proc_writer_scenario
             super(progname, &block)
           else
             update_format(scenario_id)
+            set_proc_writer_scenario
             super(progname, &block)
             reset_format
           end
@@ -40,6 +43,7 @@ module DVLA
     private
 
       def update_format(scenario_id)
+        @current_scenario = scenario_id
         @correlation_ids[scenario_id] = SecureRandom.uuid[0, 8] unless @correlation_ids.key?(scenario_id)
 
         self.formatter = proc do |severity, _datetime, _progname, msg|
@@ -60,6 +64,15 @@ module DVLA
             "#{severity} -- : #{msg}\n"
         end
       end
+
+      def set_proc_writer_scenario
+        if @logdev.dev.is_a?(DVLA::Herodotus::MultiWriter) && @logdev.dev.targets.any?(DVLA::Herodotus::ProcWriter)
+          proc_writers = @logdev.dev.targets.select { |t| t.is_a? DVLA::Herodotus::ProcWriter }
+          proc_writers.each do |pr|
+            pr.scenario = @current_scenario
+          end
+        end
+      end
     end
   end
 end

data/lib/dvla/herodotus/multi_writer.rb

@@ -1,6 +1,8 @@
 module DVLA
   module Herodotus
     class MultiWriter
+      attr_reader :targets
+
       def initialize(*targets)
         @targets = *targets
       end

data/lib/dvla/herodotus/proc_writer.rb

@@ -0,0 +1,20 @@
+module DVLA
+  module Herodotus
+    class ProcWriter
+      attr_accessor :scenario
+      def initialize(proc)
+        @proc = proc
+      end
+
+      def write(*args)
+        output_file = File.open(self.instance_exec(&@proc), 'a')
+        output_file.write(args[0])
+        output_file.close
+      end
+
+      def close
+        # Nothing to close but we want to maintain consistency with other ways Herodotus can output
+      end
+    end
+  end
+end

data/lib/dvla/herodotus/version.rb

@@ -1,5 +1,5 @@
 module DVLA
   module Herodotus
-    VERSION = '1.1.0'.freeze
+    VERSION = '1.2.1'.freeze
   end
 end

data/lib/dvla/herodotus.rb

@@ -1,6 +1,7 @@
 require 'logger'
 require_relative 'herodotus/herodotus_logger'
 require_relative 'herodotus/multi_writer'
+require_relative 'herodotus/proc_writer'
 require_relative 'herodotus/string'
 
 module DVLA
@@ -29,11 +30,17 @@ module DVLA
 
     private_class_method def self.create_logger(output_path)
       if output_path
-        output_file = File.open(output_path, 'a+')
-        HerodotusLogger.new(MultiWriter.new(output_file, $stdout))
-      else
-        HerodotusLogger.new($stdout)
+        if output_path.is_a? String
+          output_file = File.open(output_path, 'a')
+          return HerodotusLogger.new(MultiWriter.new(output_file, $stdout))
+        elsif output_path.is_a? Proc
+          proc_writer = ProcWriter.new(output_path)
+          return HerodotusLogger.new(MultiWriter.new(proc_writer, $stdout))
+        else
+          raise ArgumentError.new 'Unexpected output_path provided. Expecting either a string or a proc'
+        end
       end
+      HerodotusLogger.new($stdout)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dvla-herodotus
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Driver and Vehicle Licensing Agency (DVLA)
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dvla-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -32,9 +46,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-build.yml"
 - ".github/workflows/gem-push.yml"
 - ".github/workflows/gem-test.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -42,6 +58,7 @@ files:
 - lib/dvla/herodotus.rb
 - lib/dvla/herodotus/herodotus_logger.rb
 - lib/dvla/herodotus/multi_writer.rb
+- lib/dvla/herodotus/proc_writer.rb
 - lib/dvla/herodotus/string.rb
 - lib/dvla/herodotus/version.rb
 homepage: https://github.com/dvla/herodotus