dvla-herodotus 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: def32028eabb2e8b3320cd06f229d9b882c1a586dbf8b7cdeef6e69f4998fd9a
+  data.tar.gz: 0f9aadf85396b5585db242196f0f5562b9af755ac69901c967fd537a824e5f7c
+SHA512:
+  metadata.gz: 9bf48e9d451a7f9f42fdc44f6af3dcb1844ce36ac82cafc6c8bec0596bda2159d14ba2b9b6aad6ebfaf54b220e53bd66e762e36df68a938c4c6a04b95ccdd1c8
+  data.tar.gz: d6566b93fc7289175e97b989c4948040be0152eae81997920912c722f26d5d34c24286b01c37ac49b961d28637bface0883b14867f2069db598665ede9affe7b

data/.idea/.gitignore

@@ -0,0 +1,10 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+
+/.idea

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,104 @@
+# DVLA::Herodotus
+
+A Gem that produces loggers that are pre-formatted into an agreed log format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dvla-herodotus'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dvla-herodotus
+
+## Usage
+
+### Logger
+
+You can get a logger by calling the following once Herodotus is installed:
+
+```ruby
+logger = DVLA::Herodotus.logger
+```
+
+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`
+
+Additionally, you can configure Herodotus in the following way to add a System Name and the Process Id to the output:
+
+```ruby
+DVLA::Herodotus.configure do |config|
+  config.system_name = 'SystemName'
+  config.pid = true
+end
+```
+
+This would result in logs in the following format:
+
+`[SystemName CurrentDate CurrentTime CorrelationId PID] Level : -- Message`
+
+Additionally, if you wish to have different correlation ids based on the scenario that is being currently being run, you can pass a unique identifier for your scenario as part of the logging call, with each scenario having a unique correlation id.
+
+```ruby
+logger.info('String to log out', 'Scenario Id')
+```
+
+Alternatively, you can call `new_scenario` with the identifier just before each scenario to achieve the same result without having to pass the identifier around.
+
+```ruby
+logger.new_scenario('Scenario Id')
+```
+
+Finally, you can set Herodotus up to integrate with any other instances of Herodotus that are loaded indirectly into your application, for example within a gem you use. To take advantage of this, when configuring Herodotus within your project, ensure that you set its `merge` value to true, as below:
+
+```ruby
+DVLA::Herodotus.configure do |config|
+  config.merge = true
+end
+```
+
+This will cause your correlation ids to be shared out with all the loggers that exist outside of our direct control. The instance of the Herodotus that will take precedence will be the last one to be loaded, which should be the one you are creating with `DVLA::Herodotus.logger`. 
+
+### 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:
+
+```ruby
+example_string = 'Multicoloured String'.blue.bg_red.bold
+```
+
+| 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               |
+| 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              |
+
+## 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/dvla-herodotus.gemspec

@@ -0,0 +1,22 @@
+require_relative 'lib/dvla/herodotus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dvla-herodotus'
+  spec.version       = DVLA::Herodotus::VERSION
+  spec.authors       = ['Driver and Vehicle Licensing Agency (DVLA)', 'George Bell']
+  spec.email         = ['george.bell.contractor@dvla.gov.uk']
+
+  spec.summary       = 'Provides a lightweight logger with a common format'
+  spec.required_ruby_version = Gem::Requirement.new('>= 3')
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency 'rspec', '~> 3.8'
+end

data/lib/dvla/herodotus/herodotus_logger.rb

@@ -0,0 +1,65 @@
+require 'securerandom'
+
+module DVLA
+  module Herodotus
+    class HerodotusLogger < Logger
+      attr_accessor :system_name, :requires_pid, :merge, :correlation_ids
+
+      def register_default_correlation_id
+        @correlation_ids = { default: SecureRandom.uuid[0, 8] }
+        reset_format
+      end
+
+      def new_scenario(scenario_id)
+        update_format(scenario_id)
+        merge_correlation_ids(new_scenario: scenario_id) if @merge
+      end
+
+      def merge_correlation_ids(new_scenario: nil)
+        ObjectSpace.each_object(DVLA::Herodotus::HerodotusLogger) do |logger|
+          unless logger == self # This copies the correlation ids this logger has over to all other loggers and (assuming a new scenario has just been switched to) updates the those loggers to the current scenario
+            logger.merge = false if logger.merge #Stops the other logger from trying to propagate its correlation ids to all other loggers, otherwise this code ends up in an infinite loop
+            logger.correlation_ids = self.correlation_ids
+            logger.new_scenario(new_scenario) unless new_scenario.nil?
+          end
+        end
+      end
+
+      %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
+            super(progname, &block)
+          else
+            update_format(scenario_id)
+            super(progname, &block)
+            reset_format
+          end
+        end
+      end
+
+    private
+
+      def update_format(scenario_id)
+        @correlation_ids[scenario_id] = SecureRandom.uuid[0, 8] unless @correlation_ids.key?(scenario_id)
+
+        self.formatter = proc do |severity, _datetime, _progname, msg|
+          "[#{@system_name}" \
+            "#{Time.now.strftime('%Y-%m-%d %H:%M:%S')} " \
+            "#{@correlation_ids[scenario_id]}" \
+            "#{' '.concat(Process.pid.to_s) if requires_pid}] " \
+            "#{severity} -- : #{msg}\n"
+        end
+      end
+
+      def reset_format
+        self.formatter = proc do |severity, _datetime, _progname, msg|
+          "[#{@system_name}" \
+            "#{Time.now.strftime('%Y-%m-%d %H:%M:%S')} " \
+            "#{@correlation_ids[:default]}" \
+            "#{' '.concat(Process.pid.to_s) if requires_pid}] " \
+            "#{severity} -- : #{msg}\n"
+        end
+      end
+    end
+  end
+end

data/lib/dvla/herodotus/string.rb

@@ -0,0 +1,43 @@
+class String
+  def black = "\e[30m#{self}\e[0m"
+
+  def red = "\e[31m#{self}\e[0m"
+
+  def green = "\e[32m#{self}\e[0m"
+
+  def brown = "\e[33m#{self}\e[0m"
+
+  def blue = "\e[34m#{self}\e[0m"
+
+  def magenta = "\e[35m#{self}\e[0m"
+
+  def cyan = "\e[36m#{self}\e[0m"
+
+  def gray = "\e[37m#{self}\e[0m"
+
+  def bg_black = "\e[40m#{self}\e[0m"
+
+  def bg_red = "\e[41m#{self}\e[0m"
+
+  def bg_green = "\e[42m#{self}\e[0m"
+
+  def bg_brown = "\e[43m#{self}\e[0m"
+
+  def bg_blue = "\e[44m#{self}\e[0m"
+
+  def bg_magenta = "\e[45m#{self}\e[0m"
+
+  def bg_cyan = "\e[46m#{self}\e[0m"
+
+  def bg_gray = "\e[47m#{self}\e[0m"
+
+  def bold = "\e[1m#{self}\e[22m"
+
+  def italic = "\e[3m#{self}\e[23m"
+
+  def underline = "\e[4m#{self}\e[24m"
+
+  def blink = "\e[5m#{self}\e[25m"
+
+  def reverse_color = "\e[7m#{self}\e[27m"
+end

data/lib/dvla/herodotus/version.rb

@@ -0,0 +1,5 @@
+module DVLA
+  module Herodotus
+    VERSION = '1.0.0'.freeze
+  end
+end

data/lib/dvla/herodotus.rb

@@ -0,0 +1,29 @@
+require 'logger'
+require_relative 'herodotus/string'
+require_relative 'herodotus/herodotus_logger'
+
+module DVLA
+  module Herodotus
+    CONFIG_ATTRIBUTES = %i(system_name pid merge).freeze
+
+    def self.configure
+      @config ||= Struct.new(*CONFIG_ATTRIBUTES).new
+      yield(@config) if block_given?
+      @config
+    end
+
+    def self.config
+      @config || configure
+    end
+
+    def self.logger
+      logger = HerodotusLogger.new($stdout)
+      logger.system_name = "#{config.system_name} " unless config.system_name.nil?
+      logger.requires_pid = config.pid
+      logger.merge = config.merge
+      logger.register_default_correlation_id
+      logger.merge_correlation_ids if config.merge
+      logger
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: dvla-herodotus
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Driver and Vehicle Licensing Agency (DVLA)
+- George Bell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description:
+email:
+- george.bell.contractor@dvla.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- Gemfile
+- README.md
+- dvla-herodotus.gemspec
+- lib/dvla/herodotus.rb
+- lib/dvla/herodotus/herodotus_logger.rb
+- lib/dvla/herodotus/string.rb
+- lib/dvla/herodotus/version.rb
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Provides a lightweight logger with a common format
+test_files: []