twiglet 3.14.2 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c030fe6480fd37510af2d221e39a3e873b95dbaba85d41ac326e1953020bedd5
-  data.tar.gz: d6bfe4e632fff03c510ac0dae3d28502129765c5fa2547e8fe77c66808c68a83
+  metadata.gz: af1f2d73faa76bd4b2a6e5726878e19214ac7d4c92ec682feafeb34a3bfa664a
+  data.tar.gz: c8b81cb3c2005235e0fce309bc5fadeba66b294e3f267d2bb4375915382021d0
 SHA512:
-  metadata.gz: 7394b7de15eb772fc1f6e87c2e2bbfd1cdbad502e04a35ff079e0d49162af1a21f540cf753baa6ac9f11db367603c3b45e55849c467cb88a03da01ceae1d8f90
-  data.tar.gz: 1a4852c899c2362bd5c7fd0e65e0e4f8ee1ce0422999c3d9a59f9db5950519887a953c5e02358307039734b5f03d4ccd03d94ecd0997cfe5616d2ee6ae5f6636
+  metadata.gz: 2bbffcae454c3e0328cd1cca5a5c15ad81cc8ecf07edf42e298f4e2086e38c3a4f6c58bee5fc3aa3fdafd602683a7f83e7c7e2280ceb09963815dde0af2b1d2b
+  data.tar.gz: d00d509ce376c3daae299f68d5b130c79ea432c6d97fd36ea5957c63ecb12930eddf4bc52aa8d1e7486abaeb3c414fa899c0619adc9757614644cacccbe55de1

data/lib/twiglet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Twiglet
-  VERSION = '3.14.2'
+  VERSION = '3.15.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.14.2
+  version: 3.15.0
 platform: ruby
 authors:
 - Simply Business
 bindir: bin
 cert_chain: []
-date: 2025-08-01 00:00:00.000000000 Z
+date: 2025-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -37,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -51,20 +65,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplycop
   requirement: !ruby/object:Gem::Requirement
@@ -81,33 +109,13 @@ dependencies:
         version: '0'
 description: Like a log, only smaller.
 email:
-- tech@simplybusiness.co.uk
+- opensourcetech+rubygems@simplybusiness.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".github/dependabot.yml"
-- ".github/workflows/codeql-analysis.yml"
-- ".github/workflows/dobby-actions.yml"
-- ".github/workflows/gem-publish.yml"
-- ".github/workflows/ruby.yml"
-- ".github/workflows/version-forget-me-not.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- ".ruby-version"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- catalog-info.yaml
-- docs/CODE_OF_CONDUCT.md
-- docs/RATIONALE.md
-- docs/index.md
-- example_app.rb
-- examples/rack/example_rack_app.rb
-- examples/rack/request_logger.rb
-- examples/rack/request_logger_test.rb
 - lib/hash_extensions.rb
 - lib/twiglet/error_serialiser.rb
 - lib/twiglet/formatter.rb
@@ -116,18 +124,14 @@ files:
 - lib/twiglet/validation_schema.json
 - lib/twiglet/validator.rb
 - lib/twiglet/version.rb
-- test/error_serialiser_test.rb
-- test/formatter_test.rb
-- test/hash_extensions_test.rb
-- test/logger_test.rb
-- test/message_test.rb
-- test/test_coverage.rb
-- test/validator_test.rb
-- twiglet.gemspec
 homepage: https://github.com/simplybusiness/twiglet-ruby
 licenses:
-- Copyright SimplyBusiness
-metadata: {}
+- MIT
+metadata:
+  source_code_uri: https://github.com/simplybusiness/twiglet-ruby
+  changelog_uri: https://github.com/simplybusiness/twiglet-ruby/releases
+  bug_tracker_uri: https://github.com/simplybusiness/twiglet-ruby/issues
+  documentation_uri: https://github.com/simplybusiness/twiglet-ruby
 rdoc_options: []
 require_paths:
 - lib
@@ -135,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
   - - "<"
     - !ruby/object:Gem::Version
       version: '3.5'

data/.github/CODEOWNERS

@@ -1,4 +0,0 @@
-# Add your project owners info here
-# More information: https://help.github.com/articles/about-codeowners/
-* @simplybusiness/silversmiths 
-

data/.github/dependabot.yml

@@ -1,22 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: bundler
-    directory: "/"
-    schedule:
-      interval: daily
-      time: "07:00"
-    open-pull-requests-limit: 99
-    labels:
-      - dependencies
-    ignore:
-      - dependency-name: simplecov
-        versions:
-          - ">= 0.18"
-  - package-ecosystem: github-actions
-    directory: "/"
-    schedule:
-      interval: daily
-      time: "07:00"
-    open-pull-requests-limit: 99
-    labels:
-      - dependencies

data/.github/workflows/codeql-analysis.yml

@@ -1,70 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ master ]
-  schedule:
-    - cron: '42 8 * * 0'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'ruby' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://git.io/codeql-language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3

data/.github/workflows/dobby-actions.yml

@@ -1,28 +0,0 @@
-name: "Dobby action"
-on:
-  issue_comment:
-    types: [created]
-permissions:
-  contents: read
-jobs:
-  pr_commented:
-    runs-on: ubuntu-latest
-    if: startsWith(github.event.comment.body, '/dobby')
-    env:
-      BUNDLE_WITHOUT: "development:test"
-    steps:
-      - name: Chekcout action
-        uses: actions/checkout@v4
-        with:
-          repository: 'simplybusiness/dobby'
-          ref: 'v4'
-      - name: Set up ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-      - name: Bump version
-        uses: simplybusiness/dobby@v4
-        env:
-          DOBBY_APP_ID: ${{ secrets.DOBBY_APP_ID }}
-          DOBBY_PRIVATE_KEY: ${{ secrets.DOBBY_PRIVATE_KEY }}
-          VERSION_FILE_PATH: lib/twiglet/version.rb

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

@@ -1,46 +0,0 @@
-name: Deploy Ruby Gem
-
-on:
-  push:
-    branches: [ master ]
-
-permissions:
-  contents: write
-
-jobs:
-  build:
-    name: Build and Publish
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          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_API_KEY}}
-      - name: Get Gem Version
-        id: get-gem-version
-        run: echo "GEM_VERSION=$(bundle exec ruby -e 'puts Twiglet::VERSION')" >> $GITHUB_OUTPUT
-      - name: Create Release
-        uses: actions/github-script@v7
-        env:
-          GEM_VERSION: ${{ steps.get-gem-version.outputs.GEM_VERSION }}
-        with:
-          result-encoding: string
-          script: |
-            const { GEM_VERSION } = process.env
-            github.rest.repos.createRelease({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              tag_name: GEM_VERSION,
-              generate_release_notes: true,
-            })

data/.github/workflows/ruby.yml

@@ -1,38 +0,0 @@
-name: Ruby CI
-
-on:
-  push:
-    branches:
-
-env:
-  CI: true
-permissions:
-  contents: read
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./
-
-    strategy:
-      matrix:
-        ruby-version: [3.1, 3.2, 3.3, 3.4]
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-    - name: Install dependencies
-      run: bundle install
-    - name: Rubocop Check
-      run: bundle exec rubocop
-    - name: Run all tests
-      run: bundle exec rake test
-      shell: bash
-    - name: Run example_app
-      run: bundle exec ruby example_app.rb
-      shell: bash

data/.github/workflows/version-forget-me-not.yml

@@ -1,19 +0,0 @@
-name: Check version
-
-on:
-  pull_request:
-    branches:
-      - master
-    types: [opened, synchronize]
-permissions:
-  contents: read
-  statuses: write
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: simplybusiness/version-forget-me-not@v2
-        env:
-          ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          VERSION_FILE_PATH: "lib/twiglet/version.rb"

data/.gitignore

@@ -1,58 +0,0 @@
-*~
-*.gem
-Gemfile.lock
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*

data/.rubocop.yml

@@ -1,14 +0,0 @@
-inherit_gem:
-  simplycop:
-    - .simplycop.yml
-    - .simplycop_performance.yml
-
-AllCops:
-  TargetRubyVersion: 3.1
-
-Metrics/BlockLength:
-  Max: 250
-Metrics/AbcSize:
-  Max: 20
-Metrics/MethodLength:
-  Max: 25

data/.ruby-version

@@ -1 +0,0 @@
-3.4.1

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec

data/Rakefile

@@ -1,7 +0,0 @@
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/test_coverage.rb', 'test/*_test.rb', 'examples/rack/request_logger_test.rb']
-  t.verbose = true
-end

data/catalog-info.yaml

@@ -1,15 +0,0 @@
-apiVersion: backstage.io/v1alpha1
-kind: Component
-metadata:
-  name: twiglet-ruby
-  title: Twiglet
-  description: simple logging
-  annotations:   
-    rubygems.org/name: "twiglet"
-spec:
-  type: library
-  lifecycle: production
-  owner: silversmiths
-  dependsOn:
-    - "Component:json-schema"
-    - "Component:simplycop"

data/docs/CODE_OF_CONDUCT.md

@@ -1,76 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at tech@simplybusiness.co.uk. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq

data/docs/RATIONALE.md

@@ -1,90 +0,0 @@
-# Twiglet
-
-Why Twiglet? Because it's a log, only micro-sized.
-
-This is a machine-readable first, human-readable second, JSON-based logging micro-library suitable for a wide variety of microservice uses.
-
-This logging library is available in a cornucopia of languages:
-* Ruby - here
-* Python - TBC
-* Node.js - [twiglet-node](https://github.com/simplybusiness/twiglet-node/)
-
-## Design considerations
-
-The design goals of this library are:
-
-- Write logs as JSON
-- One line per log entry
-- One JSON object per log entry
-- Each log entry contains a severity[1]
-- Each log entry contains an ISO8601 UTC timestamp
-- Each log entry contains the name of the service that wrote it
-- Each log entry pertains to an 'event'[2]
-- Each log entry either a) propagates an existing trace.id or b) creates a new trace.id as a correlation ID if one does not already exist[3]
-- Stack traces are written inside a single JSON log object rather than sprawling over several lines (TODO:)
-- Personally Identifiable Information. Don't log it.
-
-[1] It turns out that there isn't a single authoritative standard for severity levels, we chose to go with DEBUG, INFO, WARNING, ERROR and CRITICAL as our choices.
-[2] The ‘event’ here merely refers to the action that the customer (or employee, service, or other actor) is currently attempting. It does not refer specifically to Kafka, or CQRS, though that might be the case.
-[3] A correlation ID is a UUIDv4 string
-
-## Elastic Common Schema (ECS)
-https://www.elastic.co/blog/introducing-the-elastic-common-schema
-We have decided to standardise on the Elastic Common Schema for log attribute names. Whilst some attributes are expected for all logs, service owners should feel free to add relevant entries from the ECS schema if they are needed.
-All application specific information is embedded in the `message` attribute JSON payload.
-
-| Attribute name (mandatory) | Description                     |
-| -------------------------- | ------------------------------- |
-| log.level | text, one of DEBUG, INFO, WARNING, ERROR or CRITICAL. |
-| service.name               | text, the name of the service |
-| @timestamp                 | text, ISO8601 UTC |
-| message                    | text, human-readable summary  |
-
-| Attribute name (optional)  | Description                     |
-| -------------------------- | ------------------------------- |
-| error.stack_trace          | Stack trace, as JSON[4]         |
-| tags                       | Array, e.g. ["production"]      |
-| trace.id                   | text, UUIDv4 - a correlation ID |
-| (other examples)           | ...                             |
-
-[4] Helper method to be provided to allow stack trace objects to be represented cleanly as JSON.
-
-Errors should provide appropriate data using the fields from https://www.elastic.co/guide/en/ecs/current/ecs-error.html
-If any other fields are provided in a log then these should be from the ECS schema rather than in a custom format, if at all possible.
-
-## Example log output (prettified)
-```json
-{
-  "log": {
-    "level": "INFO"
-  },
-  "service": {
-    "name": "payments"
-  },
-  "@timestamp": "2020-05-07T11:51:33.976Z",
-  "event": {
-    "action": "customer-payment-accepted"
-  },
-  "trace": {
-    "id": "bf6f5ea3-614b-42f5-8e73-43deea2d1838"
-  },
-  "tags": ["staging"],
-  "message": "Pet cat Spot purchased",
-  "user": {
-    "email": "sleepyfox@gmail.com"
-  },
-  "pet": {
-    "type": "cat",
-    "name": "Spot",
-    "colour": "Ginger Tabby"
-  }
-}
-```
-
-# Code of conduct
-
-Please see the [code of conduct](CODE_OF_CONDUCT.md) for further info.
-
-# License
-
-This work is licensed under the MIT license - see the [LICENSE](../LICENSE) file for further details.