dvla-herodotus 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ef5bb32768faf3905e84a5aa343b4905d490dfda82fd8e350e985d10387a439
-  data.tar.gz: bf979b603e8cb1a2cfca96bb1ff837a313e0263910eef4c08b8902920bb1a462
+  metadata.gz: '08b398fb7ae7d18a9be9653b39e992d0ecd22b772fbeade85b9e139143b98576'
+  data.tar.gz: 93bd49a4c0f34d18f881dc74455ec190c35e44f15ab35df8e4085d38f2be1f08
 SHA512:
-  metadata.gz: 62168b57257f7d376c0ca807a61822cceeb612a8eb2744e6b29755ead02b80e934317eaa56667c267407d8131324261e69a41c6e75b0d78c1f1b3e0ef126bc67
-  data.tar.gz: b416dfe7ca587ef5ad83b04a748b7966b3c0da1336164f7cbea36330298ed8a5acc23e00ffda7b7e05075de595fee35116d6a58a4806e88bfec89e71130d2742
+  metadata.gz: a372da131b6e460d416be4e4787b3e9f4c3845cb7a40b41ccecf23d0908d19abbded195767df4b5d016639a7fda8ed241645df4edb0582eed2f75b7ae4b541f6
+  data.tar.gz: b27ed768a5f2bb9a69824ed1b5166839d84cd2b7eb96564c29bc854f40698edc6420dfaa4ec8f5a481d57164821e8e85fb50eeb75fea4438f0dbd168fdaf0dc7

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [2.4.0] - 2026-07-29
+- Added semantic logging methods: `.config`, `.step`, `.success`, `.warning`, `.data`
+- Semantic methods apply standard colours based on message type for consistent logging
+- Semantic colours can be configured in the main `DVLA::Herodotus.configure` block alongside logger options
+- Added `DVLA::Herodotus.reset_configuration!` to reset both logger options and semantic colours
+- `DVLA::Herodotus::SemanticColours.configure` and `.reset!` still available for standalone colour configuration
+
 ## [2.3.2] - 2025-12-23
 - Add 'spawn_child_logger' method to allow other processes to inherit the current logger's configuration
 

data/README.md

@@ -151,6 +151,59 @@ You can stack multiple method calls to add additional styling and use string int
 
 ---
 
+### Semantic Logging Methods
+
+Herodotus provides semantic methods that associate message types with standard colours. This promotes consistent colour usage across teams and makes logs easier to read.
+
+```ruby
+LOG.info { "Environment: #{env}".config }     # brown - configuration/environment
+LOG.info { "Checking image status".step }     # magenta - step execution/progress
+LOG.info { "Application completed".success }  # green - successful operations
+LOG.info { "Retrying request".warning }       # yellow - warnings/non-fatal issues
+LOG.info { "Response: #{payload}".data }      # blue - data values/payloads
+```
+
+#### Default Colours
+
+| Method    | Default Colour | Usage                              |
+|-----------|----------------|-------------------------------------|
+| `.config` | brown          | Configuration, environment settings |
+| `.step`   | magenta        | Method calls, checking, polling     |
+| `.success`| green          | Successful operations, completions  |
+| `.warning`| yellow         | Warnings, non-fatal issues          |
+| `.data`   | blue           | Data values, responses, payloads    |
+
+#### Custom Colour Configuration
+
+You can configure semantic colours alongside other logger options in a single configure block:
+
+```ruby
+DVLA::Herodotus.configure do |c|
+  c.display_pid = true
+  c.prefix_colour = { overall: :blue }
+  c.config = :cyan
+  c.step = :blue
+  c.success = :bright_green
+  c.warning = :red
+  c.data = :magenta
+end
+```
+
+To reset all configuration to defaults:
+
+```ruby
+DVLA::Herodotus.reset_configuration!
+```
+
+Semantic methods can be chained with other styles:
+
+```ruby
+LOG.info { "COMPLETED".success.bold }
+LOG.info { "ERROR: #{msg}".warning.bg_red }
+```
+
+---
+
 ## 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

data/lib/dvla/herodotus/config.rb

@@ -0,0 +1,23 @@
+module DVLA
+  module Herodotus
+    class Config
+      LOGGER_ATTRIBUTES = %i[display_pid main prefix_colour].freeze
+
+      attr_accessor(*LOGGER_ATTRIBUTES)
+
+      SemanticColours::DEFAULT_COLOURS.keys.each do |semantic_type|
+        define_method(semantic_type) do
+          SemanticColours.send(semantic_type)
+        end
+
+        define_method("#{semantic_type}=") do |colour|
+          SemanticColours.send("#{semantic_type}=", colour)
+        end
+      end
+
+      def reset_colours!
+        SemanticColours.reset!
+      end
+    end
+  end
+end

data/lib/dvla/herodotus/herodotus_logger.rb

@@ -13,9 +13,9 @@ module DVLA
         super(*args, **kwargs)
 
         @system_name = system_name
-        @main = config[:main]
-        @display_pid = config[:display_pid]
-        @prefix_colour = config[:prefix_colour] || {}
+        @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

data/lib/dvla/herodotus/semantic_colours.rb

@@ -0,0 +1,37 @@
+module DVLA
+  module Herodotus
+    module SemanticColours
+      DEFAULT_COLOURS = {
+        config: :brown,
+        step: :magenta,
+        success: :green,
+        warning: :yellow,
+        data: :blue
+      }.freeze
+
+      class << self
+        def colours
+          @colours ||= DEFAULT_COLOURS.dup
+        end
+
+        def configure
+          yield(self) if block_given?
+        end
+
+        def reset!
+          @colours = DEFAULT_COLOURS.dup
+        end
+
+        DEFAULT_COLOURS.keys.each do |semantic_type|
+          define_method(semantic_type) do
+            colours[semantic_type]
+          end
+
+          define_method("#{semantic_type}=") do |colour|
+            colours[semantic_type] = colour
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dvla/herodotus/string.rb

@@ -1,3 +1,5 @@
+require_relative 'semantic_colours'
+
 class String
   def colourise(code, reset_code = 39)
     # Making sure we align the correct reset codes
@@ -88,4 +90,25 @@ class String
   alias grey gray
   alias reverse_color reverse_colour
   alias strip_color strip_colour
+
+  # Semantic logging methods - apply colours based on message type
+  def config
+    send(DVLA::Herodotus::SemanticColours.config)
+  end
+
+  def step
+    send(DVLA::Herodotus::SemanticColours.step)
+  end
+
+  def success
+    send(DVLA::Herodotus::SemanticColours.success)
+  end
+
+  def warning
+    send(DVLA::Herodotus::SemanticColours.warning)
+  end
+
+  def data
+    send(DVLA::Herodotus::SemanticColours.data)
+  end
 end

data/lib/dvla/herodotus/version.rb

@@ -1,5 +1,5 @@
 module DVLA
   module Herodotus
-    VERSION = '2.3.2'.freeze
+    VERSION = '2.4.0'.freeze
   end
 end

data/lib/dvla/herodotus.rb

@@ -3,23 +3,37 @@ require 'fileutils'
 require_relative 'herodotus/herodotus_logger'
 require_relative 'herodotus/multi_writer'
 require_relative 'herodotus/proc_writer'
+require_relative 'herodotus/semantic_colours'
+require_relative 'herodotus/config'
 require_relative 'herodotus/string'
 
 module DVLA
   module Herodotus
     class << self
       attr_accessor :main_logger
-    end
 
-    CONFIG_ATTRIBUTES = %i[display_pid main prefix_colour].freeze
+      def configuration
+        @configuration ||= Config.new
+      end
+
+      def configure
+        yield(configuration) if block_given?
+        configuration
+      end
 
-    def self.config
-      config ||= Struct.new(*CONFIG_ATTRIBUTES, keyword_init: true).new
-      yield(config) if block_given?
-      config
+      def config
+        c = Config.new
+        yield(c) if block_given?
+        c
+      end
+
+      def reset_configuration!
+        @configuration = Config.new
+        SemanticColours.reset!
+      end
     end
 
-    def self.logger(system_name, config: self.config, output_path: nil)
+    def self.logger(system_name, config: self.configuration, output_path: nil)
       create_logger(system_name, config, output_path)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dvla-herodotus
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Driver and Vehicle Licensing Agency (DVLA)
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-22 00:00:00.000000000 Z
+date: 2026-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dvla-lint
@@ -59,9 +59,11 @@ files:
 - bin/console
 - dvla-herodotus.gemspec
 - lib/dvla/herodotus.rb
+- lib/dvla/herodotus/config.rb
 - lib/dvla/herodotus/herodotus_logger.rb
 - lib/dvla/herodotus/multi_writer.rb
 - lib/dvla/herodotus/proc_writer.rb
+- lib/dvla/herodotus/semantic_colours.rb
 - lib/dvla/herodotus/string.rb
 - lib/dvla/herodotus/version.rb
 homepage: https://github.com/dvla/herodotus