dvla-herodotus 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2eb770ebff3f1d698f1498ae9d09f6ce70735fe4a0b4e8fb48047db6fffa9497
-  data.tar.gz: 3b32cbac5261b3f04831b455f0bdc1e12d7579ba3006b32fedf7a0214b6c1219
+  metadata.gz: a7ab39a7a9de4f2f315d5ce951f3a65ad947c04a889d140c8ab70dbdc64e76b3
+  data.tar.gz: c722a9497a06673983412e4f02dacb6daf073c1461f9eedad0b1f6e80b9ea04d
 SHA512:
-  metadata.gz: e79ed58e9d0b3bbce41cc04c61ba6ffac86faee95ef257bc1be5f38c14cd9c2606c3452b13fb4f2aae5411137827aa29e70e4a2b038b8f8bf18f74dcc4f95793
-  data.tar.gz: 9fceaf98cfc77253cf2f772367698486a250ca3659d4b5d0399ab7d18b4b95274951c1e7cda5820e3f8019e8941f34f1554208bbc5d0fdda85bd3a5ffa085547
+  metadata.gz: 35163204de97ea6c7c44799e81bf45918dd9018de639f849a33bcdd5be83be246cf099f251b5588c9e8160c40f06448b6870819888d8cd6e997442b203f365bf
+  data.tar.gz: 5cee93b36fca277bae58494570f35250a29b9f2947c0c9cd794dfd20e38ea9850930fdb26a55cf324f6df1f14279cc4adc449e193c84b36b9cc1bfee9c28cb5b

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [2.3.0] - 2025-10-05
+- Config block can now accept prefix colour options. Can be applied to the whole prefix or configure individual components.
+
+## [2.2.1] - 2025-09-15
+- Fixed issue with ANSI exit codes breaking on string interpolation
+- Added strip_colour method to String which we now call when sending logs to file
+- Added colours/styles: yellow, bg_yellow, bg_white, bg_bright_red, bg_bright_green, bg_bright_blue, bg_bright_magenta, bg_bright_cyan, dim
+- Removed colours/styles: bright_black (that's just gray), bright_yellow (that's just yellow), blink (inconsistent/unsupported)
+- Added a changelog
+
+
+## [2.2.0] - 2025-09-08
+- Added colourise method to handle colour exist codes
+- Added alias for colour/color
+- Added alias for brown/yellow

data/README.md

@@ -29,7 +29,9 @@ You can get a logger by calling the following once Herodotus is installed:
 logger = DVLA::Herodotus.logger('<system-name>')
 ```
 
-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
+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.
+
+**Note:** Log messages are stripped of colour codes before being saved to file.
 
 ```ruby
 logger = DVLA::Herodotus.logger('<system-name>', output_path: 'logs.txt')
@@ -60,6 +62,26 @@ This would result in logs in the following format:
 
 `[SystemName CurrentDate CurrentTime CorrelationId PID] Level : -- Message`
 
+#### Prefix Colourisation
+You can colourise different parts of the log prefix by providing a hash to style each component. It accepts strings, symbols or arrays of either:
+
+```ruby
+config = DVLA::Herodotus.config do |config|
+  config.prefix_colour = {
+    system: %w[blue bold],
+    date: 'green',
+    time: :yellow,
+    correlation: %w[magenta italic],
+    pid: %w[cyan],
+    level: %i[red bold],
+    separator: %w[white],
+    overall: %w[underline]
+  }
+end
+```
+Each key is optional, and you can simply use the `overall` key to style the whole prefix.
+---
+
 ### Syncing logs
 
 Herodotus allows you to Sync correlation_ids between instantiated HerodotusLogger objects. 
@@ -80,47 +102,39 @@ You can call `new_scenario` with the identifier just before each scenario to cre
 logger.new_scenario('Scenario Id')
 ```
 
+---
 ### Strings
 
-Also included is a series of additional methods on `String` that allow you to modify the colour and style of logs. As these exist on `String`, you can call them on any string such as:
+Also included is a series of additional methods on `String` that allow you to modify the colour and style of logs.
+You can stack multiple method calls to add additional styling and use string interpolation to style different parts of the string
+
 
 ```ruby
-example_string = 'Multicoloured String'.blue.bg_red.bold
+  example_string = "#{'H'.red}#{'E'.bright_red}#{'R'.yellow}#{'O'.green}#{'D'.blue}#{'O'.bright_blue}#{'T'.magenta}#{'U'.bright_magenta}#{'S'.cyan}".bold.reverse_colour
 ```
 
-| Method        | Function                                         |
-|---------------|--------------------------------------------------|
-| blue          | Sets the string's colour to blue                 |
-| red           | Sets the string's colour to red                  |
-| green         | Sets the string's colour to green                |
-| brown         | Sets the string's colour to brown                |
-| blue          | Sets the string's colour to blue                 |
-| magenta       | Sets the string's colour to magenta              |
-| cyan          | Sets the string's colour to cyan                 |
-| gray          | Sets the string's colour to gray                 |
-| grey          | Sets the string's colour to grey (alias of gray) |
-| bright_blue   | Sets the string's colour to bright blue          |
-| bright_red    | Sets the string's colour to bright red           |
-| bright_green  | Sets the string's colour to bright green         |
-| bright_yellow | Sets the string's colour to bright yellow        |
-| bright_blue   | Sets the string's colour to bright blue          |
-| bright_magenta| Sets the string's colour to bright magenta       |
-| bright_cyan   | Sets the string's colour to bright cyan          |
-| white         | Sets the string's colour to white                |
-| bg_blue       | Sets the string's background colour to blue      |
-| bg_red        | Sets the string's background colour to red       |
-| bg_green      | Sets the string's background colour to green     |
-| bg_brown      | Sets the string's background colour to brown     |
-| bg_blue       | Sets the string's background colour to blue      |
-| bg_magenta    | Sets the string's background colour to magenta   |
-| bg_cyan       | Sets the string's background colour to cyan      |
-| bg_gray       | Sets the string's background colour to gray      |
-| bold          | Sets the string to be bold                       |
-| italic        | Sets the string to be italic                     |
-| underline     | Sets the string to be underline                  |
-| blink         | Sets the string to blink                         |
-| reverse_color | Reverses the colour of the string                |
+#### Available String Methods
+
+| Type                      | Examples |
+|---------------------------|----------|
+| Text Styles               | **bold** <span style="opacity:0.6">dim</span> *italic* <u>underline</u> |
+| Colours                   | <span style="color:black">black</span> <span style="color:red">red</span> <span style="color:green">green</span> <span style="color:#B8860B">brown</span> <span style="color:#ffff00">yellow</span> <span style="color:blue">blue</span> <span style="color:magenta">magenta</span> <span style="color:cyan">cyan</span> <span style="color:grey">gray</span> <span style="color:white">white</span> |
+| Bright Colours            | <span style="color:#ff5555">bright_red</span> <span style="color:#55ff55">bright_green</span> <span style="color:#5555ff">bright_blue</span> <span style="color:#ff55ff">bright_magenta</span> <span style="color:#55ffff">bright_cyan</span> |
+| Background Colours        | <span style="background:black;color:white">bg_black</span> <span style="background:red;color:white">bg_red</span> <span style="background:green;color:white">bg_green</span> <span style="background:#B8860B;color:white">bg_brown</span> <span style="background:#ffff00;color:black">bg_yellow</span> <span style="background:blue;color:white">bg_blue</span> <span style="background:magenta;color:white">bg_magenta</span> <span style="background:cyan;color:black">bg_cyan</span> <span style="background:grey;color:white">bg_gray</span> <span style="background:white;color:black">bg_white</span> |
+| Bright Background Colours | <span style="background:#ff5555;color:white">bg_bright_red</span> <span style="background:#55ff55;color:black">bg_bright_green</span> <span style="background:#5555ff;color:white">bg_bright_blue</span> <span style="background:#ff55ff;color:white">bg_bright_magenta</span> <span style="background:#55ffff;color:black">bg_bright_cyan</span> |
+| Utility                   | strip_colour reverse_colour |
+
+#### To handle differences in spelling the following methods have been given aliases:
+| Alias         | Original       |
+|---------------|----------------|
+| bg_grey       | bg_gray        |
+| colorize      | colourise      |
+| grey          | gray           |
+| reverse_color | reverse_colour |
+| strip_color   | strip_colour   |
+
+---
 
 ## Development
 
-Herodotus is very lightweight. Currently all code to generate a new logger can be found in `herodotus.rb` and the code for the logger is in `herodotus_logger.rb` so that is the best place to start with any modifications
+Herodotus is very lightweight. Currently, all code to generate a new logger can be found in `herodotus.rb` and the code for the logger is in `herodotus_logger.rb` so that is the best place to start with any modifications

data/lib/dvla/herodotus/herodotus_logger.rb

@@ -3,7 +3,7 @@ require 'securerandom'
 module DVLA
   module Herodotus
     class HerodotusLogger < Logger
-      attr_accessor :system_name, :correlation_id, :main, :display_pid, :scenario_id
+      attr_accessor :system_name, :correlation_id, :main, :display_pid, :scenario_id, :prefix_colour
 
       # Initializes the logger
       # Sets a default correlation_id and creates the formatter
@@ -15,7 +15,8 @@ module DVLA
         @system_name = system_name
         @main = config[:main]
         @display_pid = config[:display_pid]
-
+        @prefix_colour = config[:prefix_colour] || {}
+        validate_colour_config if @prefix_colour.any?
         @correlation_id = SecureRandom.uuid[0, 8]
         set_formatter
 
@@ -65,19 +66,75 @@ module DVLA
       end
 
       # Sets the format of the log.
-      # Needs to be called each time correlation_id is changed after initialization in-order for the changes to take affect.
+      # Needs to be called each time correlation_id is changed after initialization in-order for the changes to take effect.
       def set_formatter
         self.formatter = proc do |severity, _datetime, _progname, msg|
-          "[#{@system_name} " \
-            "#{Time.now.strftime('%Y-%m-%d %H:%M:%S')} " \
-            "#{@correlation_id}" \
-            "#{' '.concat(Process.pid.to_s) if @display_pid}] " \
-            "#{severity} -- : #{msg}\n"
+          now = Time.now
+          components = {
+            system: @system_name,
+            date: now.strftime('%Y-%m-%d'),
+            time: now.strftime('%H:%M:%S'),
+            correlation: @correlation_id,
+            pid: @display_pid ? Process.pid.to_s : nil,
+            level: severity,
+            separator: '-- :',
+          }
+
+          prefix = @prefix_colour.any? ? build_prefix_with_colour(components) : build_prefix(components)
+          "#{prefix}#{msg}\n"
         end
       end
 
     private
 
+      VALID_COLOUR_METHODS = %i[
+        white black red green brown yellow blue magenta cyan gray grey
+        bright_red bright_green bright_blue bright_magenta bright_cyan
+        bg_black bg_red bg_green bg_brown bg_yellow bg_blue bg_magenta bg_cyan bg_gray bg_grey bg_white
+        bg_bright_red bg_bright_green bg_bright_blue bg_bright_magenta bg_bright_cyan
+        bold dim italic underline reverse_colour reverse_color
+      ].freeze
+
+      VALID_PREFIX_KEYS = %i[system date time correlation pid level separator overall].freeze
+
+      def validate_colour_config
+        raise ArgumentError, 'Invalid prefix colour config' unless @prefix_colour.is_a?(Hash) && @prefix_colour.keys.all? { |key| VALID_PREFIX_KEYS.include?(key) }
+
+        @prefix_colour.each_value do |value|
+          raise ArgumentError, 'Colour values must be strings or symbols' unless valid_colour_type?(value)
+          raise ArgumentError, 'Invalid colours in prefix colour config' unless Array(value).map(&:to_sym).all? { |c| VALID_COLOUR_METHODS.include?(c) }
+        end
+      end
+
+      def valid_colour_type?(value)
+        value.is_a?(String) || value.is_a?(Symbol) || (value.is_a?(Array) && value.all? { |v| v.is_a?(String) || v.is_a?(Symbol) })
+      end
+
+      def apply_colours(text, colour_spec)
+        return text unless colour_spec
+
+        colour_spec.reduce(text) { |str, method| str.public_send(method) }
+      end
+
+      def build_prefix_with_colour(components)
+        system = apply_colours(components[:system], @prefix_colour[:system])
+        date = apply_colours(components[:date], @prefix_colour[:date])
+        time = apply_colours(components[:time], @prefix_colour[:time])
+        correlation = apply_colours(components[:correlation], @prefix_colour[:correlation])
+        pid = components[:pid] && apply_colours(components[:pid], @prefix_colour[:pid])
+        level = apply_colours(components[:level], @prefix_colour[:level])
+        separator = apply_colours(components[:separator], @prefix_colour[:separator])
+
+        bracket_content = [system, date, time, correlation, pid].compact.join(' ')
+        result = "[#{bracket_content}] #{level} #{separator} "
+        apply_colours(result, @prefix_colour[:overall]) || result
+      end
+
+      def build_prefix(components)
+        bracket_content = [components[:system], components[:date], components[:time], components[:correlation], components[:pid]].compact.join(' ')
+        "[#{bracket_content}] #{components[:level]} #{components[:separator]} "
+      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 }

data/lib/dvla/herodotus/multi_writer.rb

@@ -8,7 +8,14 @@ module DVLA
       end
 
       def write(*args)
-        @targets.each { |t| t.write(*args) }
+        @targets.each do |target|
+          # If we're writing to a file we remove the colour
+          if target != $stdout && args[0].respond_to?(:strip_colour)
+            target.write(args[0].strip_colour, *args[1..])
+          else
+            target.write(*args)
+          end
+        end
       end
 
       def close

data/lib/dvla/herodotus/string.rb

@@ -1,43 +1,91 @@
 class String
   def colourise(code, reset_code = 39)
-    "\e[#{code}m#{self}\e[#{reset_code}m"
+    # Making sure we align the correct reset codes
+    if self.include?("\e[#{reset_code}m")
+      result = self.gsub("\e[#{reset_code}m", "\e[#{reset_code}m\e[#{code}m")
+      "\e[#{code}m#{result}\e[#{reset_code}m"
+    else
+      "\e[#{code}m#{self}\e[#{reset_code}m"
+    end
   end
-  alias colorize colourise
+
+  def white = colourise(97)
 
   def black = colourise(30)
+
   def red = colourise(31)
+
   def green = colourise(32)
+
   def brown = colourise(33)
-  alias yellow brown
+
+  def yellow = colourise(93)
 
   def blue = colourise(34)
+
   def magenta = colourise(35)
+
   def cyan = colourise(36)
+
   def gray = colourise(37)
-  alias grey gray
 
-  def bright_black = colourise(90)
   def bright_red = colourise(91)
+
   def bright_green = colourise(92)
-  def bright_yellow = colourise(93)
+
   def bright_blue = colourise(94)
+
   def bright_magenta = colourise(95)
+
   def bright_cyan = colourise(96)
-  def white = colourise(97)
 
   def bg_black = colourise(40, 49)
+
   def bg_red = colourise(41, 49)
+
   def bg_green = colourise(42, 49)
+
   def bg_brown = colourise(43, 49)
+
+  def bg_yellow = colourise(103, 49)
+
   def bg_blue = colourise(44, 49)
+
   def bg_magenta = colourise(45, 49)
+
   def bg_cyan = colourise(46, 49)
+
   def bg_gray = colourise(47, 49)
 
+  def bg_white = colourise(107, 49)
+
+  def bg_bright_red = colourise(101, 49)
+
+  def bg_bright_green = colourise(102, 49)
+
+  def bg_bright_blue = colourise(104, 49)
+
+  def bg_bright_magenta = colourise(105, 49)
+
+  def bg_bright_cyan = colourise(106, 49)
+
   def bold = colourise(1, 22)
+
+  def dim = colourise(2, 22)
+
   def italic = colourise(3, 23)
+
   def underline = colourise(4, 24)
-  def blink = colourise(5, 25)
-  def reverse_color = colourise(7, 27)
-  alias reverse_colour reverse_color
+
+  def reverse_colour = colourise(7, 27)
+
+  def strip_colour
+    gsub(/\e\[[0-9;]*m/, '')
+  end
+
+  alias bg_grey bg_gray
+  alias colorize colourise
+  alias grey gray
+  alias reverse_color reverse_colour
+  alias strip_color strip_colour
 end

data/lib/dvla/herodotus/version.rb

@@ -1,5 +1,5 @@
 module DVLA
   module Herodotus
-    VERSION = '2.2.0'.freeze
+    VERSION = '2.3.0'.freeze
   end
 end

data/lib/dvla/herodotus.rb

@@ -10,7 +10,7 @@ module DVLA
       attr_accessor :main_logger
     end
 
-    CONFIG_ATTRIBUTES = %i[display_pid main].freeze
+    CONFIG_ATTRIBUTES = %i[display_pid main prefix_colour].freeze
 
     def self.config
       config ||= Struct.new(*CONFIG_ATTRIBUTES, keyword_init: true).new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dvla-herodotus
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Driver and Vehicle Licensing Agency (DVLA)
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-08 00:00:00.000000000 Z
+date: 2025-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dvla-lint
@@ -52,6 +52,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md