twiglet 3.12.0 → 3.13.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f7f408c7f0546be8ef926a307e70a58af7a7ff3427b1744bdbb4cfbc4653189
-  data.tar.gz: aaf5bce57110c3accb2353250c528a525b0948fbfda377f3b6fc6308e50030ba
+  metadata.gz: d45efd0e55e70aa841d869e74651ae6aa4e63e687cac76636259d73b14b3a004
+  data.tar.gz: 6a9c30a7e7e1b8ee44b40e7e39ccf7c531dee71771566bff485de87837a3f387
 SHA512:
-  metadata.gz: 830da1bdf6311f12b6a92cab29c8e25453d8ee0bd0007d3b41e211a628983ea20c3956dc6cab9b6d991901ebb7cfb718f0296b11b82e89c20deee187a4f6ae87
-  data.tar.gz: 140e91a61d0883769aea1e0828022ae0662750a571fc35531f3604d1708a24efbfc2b229624faef3855234d59048134c8f29700505d8ca674f7a9a830e5d1465
+  metadata.gz: e25f3123db091b89be3d0fa6802a322700ff3f13d0c564b6010adabe8c44a0a0d82d75b4fd9775fc959ce9963dffcae7afc194db1820d8bcd42969b8ee75e1bf
+  data.tar.gz: 18604a8d18ff0fb9d2da01afc0f3c4e2811bed972ed8a58105a5a997948f185a6012229e57a1aa99523e5f1069c5e2e1507a3f295c400cb15314c881f2ea4316

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

@@ -38,11 +38,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      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.
@@ -53,7 +53,7 @@ jobs:
     # 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@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -67,4 +67,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

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

@@ -13,7 +13,7 @@ jobs:
       BUNDLE_WITHOUT: "development:test"
     steps:
       - name: Chekcout action
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: 'simplybusiness/dobby'
           ref: 'v3.0.0'
@@ -22,7 +22,7 @@ jobs:
         with:
           bundler-cache: true
       - name: Bump version
-        uses: simplybusiness/dobby@v3.1.1
+        uses: simplybusiness/dobby@v3
         env:
           DOBBY_APP_ID: ${{ secrets.DOBBY_APP_ID }}
           DOBBY_PRIVATE_KEY: ${{ secrets.DOBBY_PRIVATE_KEY }}

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

@@ -12,7 +12,7 @@ jobs:
     name: Build and Publish
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -31,7 +31,7 @@ jobs:
         id: get-gem-version
         run: echo "GEM_VERSION=$(bundle exec ruby -e 'puts Twiglet::VERSION')" >> $GITHUB_OUTPUT
       - name: Create Release
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         env:
           GEM_VERSION: ${{ steps.get-gem-version.outputs.GEM_VERSION }}
         with:

data/.github/workflows/ruby.yml

@@ -18,10 +18,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [3.0, 3.1, 3.2]
+        ruby-version: [3.0, 3.1, 3.2, 3.3]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

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

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: simplybusiness/version-forget-me-not@v2.3.0
+      - uses: simplybusiness/version-forget-me-not@v2
         env:
           ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VERSION_FILE_PATH: "lib/twiglet/version.rb"

data/lib/twiglet/logger.rb

@@ -81,6 +81,13 @@ module Twiglet
       )
     end
 
+    def validation_schema(validation_schema)
+      self.class.new(
+        @service_name,
+        **@args.merge(validation_schema: validation_schema)
+      )
+    end
+
     def context_provider(&blk)
       new_context_providers = Array(@args[:context_providers])
       new_context_providers << blk

data/lib/twiglet/version.rb

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

data/test/logger_test.rb

@@ -681,11 +681,71 @@ describe Twiglet::Logger do
     end
   end
 
+  describe '#validation_schema' do
+    it 'allows for reconfiguring the validation_schema on new logger instances' do
+      validation_schema = <<-JSON
+        {
+          "type": "object",
+          "required": ["pet"],
+          "properties": {
+            "pet": {
+              "type": "object",
+              "required": ["name", "best_boy_or_girl?"],
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "best_boy_or_girl?": {
+                  "type": "boolean"
+                }
+              }
+            }
+          }
+        }
+      JSON
+
+      logger = Twiglet::Logger.new(
+        'petshop',
+        now: @now,
+        output: @buffer
+      )
+
+      message = { message: 'hi' }
+
+      pet_message = {
+        pet: { name: 'Davis', best_boy_or_girl?: true, species: 'dog' }
+      }
+
+      logger.info(message)
+      log = read_json(@buffer)
+      assert_equal 'hi', log[:message]
+
+      error = assert_raises JSON::Schema::ValidationError do
+        logger.info(pet_message)
+      end
+      assert_equal "The property '#/' did not contain a required property of 'message'", error.message
+
+      logger = logger.validation_schema(validation_schema)
+
+      error = assert_raises JSON::Schema::ValidationError do
+        logger.info(message)
+      end
+      assert_equal "The property '#/' did not contain a required property of 'pet'", error.message
+
+      logger.info(pet_message)
+      log = read_json(@buffer)
+      assert_equal 'Davis', log[:pet][:name]
+    end
+  end
+
   private
 
   def read_json(buffer)
     buffer.rewind
-    JSON.parse(buffer.read, symbolize_names: true)
+    string = buffer.read
+    buffer.rewind
+    JSON.parse(string, symbolize_names: true)
   end
 end
 # rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.12.0
+  version: 3.13.4
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -92,16 +92,13 @@ files:
 - ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/dobby-actions.yml"
 - ".github/workflows/gem-publish.yml"
-- ".github/workflows/project-board.yml"
 - ".github/workflows/ruby.yml"
 - ".github/workflows/version-forget-me-not.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
-- Dockerfile
 - Gemfile
 - LICENSE
-- Makefile
 - README.md
 - Rakefile
 - catalog-info.yaml
@@ -120,7 +117,6 @@ files:
 - lib/twiglet/validation_schema.json
 - lib/twiglet/validator.rb
 - lib/twiglet/version.rb
-- mkdocs.yml
 - test/error_serialiser_test.rb
 - test/formatter_test.rb
 - test/hash_extensions_test.rb

data/.github/workflows/project-board.yml

@@ -1,17 +0,0 @@
-name: Automatically add new Issues to Silversmith's GitHub project board
-# https://github.com/orgs/simplybusiness/projects/3
-# New issues in this repository will be added to the board.
-on:
-  issues:
-    types: [ opened, reopened ]
-
-jobs:
-  track_issues:
-    uses: simplybusiness/github-action-reusable-workflows/.github/workflows/project-board.yaml@master
-    with:
-      pr-id: ${{ github.event.issue.node_id }}
-      project-number: 3
-      org: simplybusiness
-      actor: ${{ github.actor }}
-    secrets:
-      github-token: ${{ secrets.SILVERSMITHS_PROJECT_MANAGEMENT }}

data/Dockerfile

@@ -1,7 +0,0 @@
-FROM ruby:2.6.5
-
-WORKDIR /var/app
-COPY Gemfile .
-RUN bundle install
-
-CMD ["bash"]

data/Makefile

@@ -1,21 +0,0 @@
-.PHONY: all build clean shell test
-
-all: clean build test
-
-build:
-	docker build -t simplybusiness/ruby-dev:2.6.5 .
-
-clean:
-	rm -f *~
-
-shell:
-	docker run -it \
-	-v `pwd`:/var/app \
-	simplybusiness/ruby-dev:2.6.5 \
-	bash
-
-test:
-	docker run -it \
-	-v `pwd`:/var/app \
-	simplybusiness/ruby-dev:2.6.5 \
-	bundle exec rake test

data/mkdocs.yml

@@ -1,8 +0,0 @@
-site_name: 'Twiglet Docs'
-nav:
-  - Home: index.md
-  - Code of Conduct: CODE_OF_CONDUCT.md
-  - "Why Twiglet?": RATIONALE.md
-
-plugins:
-  - techdocs-core