dvla-herodotus 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: def32028eabb2e8b3320cd06f229d9b882c1a586dbf8b7cdeef6e69f4998fd9a
-  data.tar.gz: 0f9aadf85396b5585db242196f0f5562b9af755ac69901c967fd537a824e5f7c
+  metadata.gz: 26e2843c0b2fa7985bccb48c2d24d5e66cf19ff9a1008d27347d705605a979f1
+  data.tar.gz: 817acfe4641c6ad9a0bbcf607ce8b3968b2f2d5eccbe3586bfefae1a46236817
 SHA512:
-  metadata.gz: 9bf48e9d451a7f9f42fdc44f6af3dcb1844ce36ac82cafc6c8bec0596bda2159d14ba2b9b6aad6ebfaf54b220e53bd66e762e36df68a938c4c6a04b95ccdd1c8
-  data.tar.gz: d6566b93fc7289175e97b989c4948040be0152eae81997920912c722f26d5d34c24286b01c37ac49b961d28637bface0883b14867f2069db598665ede9affe7b
+  metadata.gz: afa99a580bb2f1082252c2dd44139b89d48d48625ee1223f7af6a93cc3ab68a1e65b7379e5646959ab37e772c2a72828b95eba75eb2c6cee75737dc42be85917
+  data.tar.gz: 1eab9992df8482e4218f59b3f926e2bfa8383f3c141f708f9fe5a0ef64576fc5eef2bc6eabcb7ef281ccf4e7e4e1eb2cc02e630919c744d0ac5330d16907479c

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

@@ -0,0 +1,48 @@
+name: Ruby Gem Publish
+
+on:
+  push:
+    branches: [ "main" ]
+
+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 tests
+        run: bundle exec rspec
+
+  deploy:
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 3.0.1
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.2
+          bundler-cache: true
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

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

@@ -0,0 +1,22 @@
+name: Ruby Test
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+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 tests
+        run: bundle exec rspec

data/{.idea/.gitignore → .gitignore}

@@ -8,3 +8,5 @@
 /dataSources.local.xml
 
 /.idea
+
+Gemfile.lock

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 HM Government (Driver and Vehicle Licensing Agency)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -28,6 +28,18 @@ You can get a logger by calling the following once Herodotus is installed:
 logger = DVLA::Herodotus.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

@@ -8,6 +8,9 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Provides a lightweight logger with a common format'
   spec.required_ruby_version = Gem::Requirement.new('>= 3')
+  spec.homepage      = 'https://github.com/dvla/herodotus'
+
+  spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

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 and @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

@@ -0,0 +1,21 @@
+module DVLA
+  module Herodotus
+    class MultiWriter
+      attr_reader :targets
+
+      def initialize(*targets)
+        @targets = *targets
+      end
+
+      def write(*args)
+        @targets.each { |t| t.write(*args) }
+      end
+
+      def close
+        @targets.each do |t|
+          t.close unless t.eql? $stdout
+        end
+      end
+    end
+  end
+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.0.0'.freeze
+    VERSION = '1.2.0'.freeze
   end
 end

data/lib/dvla/herodotus.rb

@@ -1,6 +1,8 @@
 require 'logger'
-require_relative 'herodotus/string'
 require_relative 'herodotus/herodotus_logger'
+require_relative 'herodotus/multi_writer'
+require_relative 'herodotus/proc_writer'
+require_relative 'herodotus/string'
 
 module DVLA
   module Herodotus
@@ -16,8 +18,8 @@ module DVLA
       @config || configure
     end
 
-    def self.logger
-      logger = HerodotusLogger.new($stdout)
+    def self.logger(output_path: nil)
+      logger = create_logger(output_path)
       logger.system_name = "#{config.system_name} " unless config.system_name.nil?
       logger.requires_pid = config.pid
       logger.merge = config.merge
@@ -25,5 +27,20 @@ module DVLA
       logger.merge_correlation_ids if config.merge
       logger
     end
+
+    private_class_method def self.create_logger(output_path)
+      if output_path
+        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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: dvla-herodotus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Driver and Vehicle Licensing Agency (DVLA)
 - George Bell
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -25,25 +25,31 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-description:
+description: 
 email:
 - george.bell.contractor@dvla.gov.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".idea/.gitignore"
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/gem-test.yml"
+- ".gitignore"
 - Gemfile
+- LICENSE
 - README.md
 - dvla-herodotus.gemspec
 - 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:
-licenses: []
+homepage: https://github.com/dvla/herodotus
+licenses:
+- MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -59,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Provides a lightweight logger with a common format
 test_files: []