twiglet 3.17.2 → 3.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c24a6e2ae1cf373e4922af0528244828063bcea811068caf9e0b936881fafbfc
-  data.tar.gz: c1f067e514a0888b511a347203d2756061e362f710c0a1e32ebca98a24e804cf
+  metadata.gz: f374d2f2296590173140effe867843a31621087d0bfcaf5c25f5d739a7ba408e
+  data.tar.gz: 8c1e8460499e5b2d5e230e4446ef73fe1ca626d1ba09801b61550dff176dde82
 SHA512:
-  metadata.gz: cb1d1569a326bcfe0dceefb15cfd3bf0d073336368e5f22a7f4b745063a0c19af0fd8f385ae424c2260778ca5ae8d5ecc3acee64ac1a1922b113310f3faa4388
-  data.tar.gz: f983b678e912cbf317c1a5ddcc2d9559ecd5bcb97f090120609696db5b34331177cc6aed74b8ad41ef2cbe374312d51cd6acbf933dafddbd549fea10b01f4e56
+  metadata.gz: 505e1c1ed12eaae957d936ecfaca1cf6e85b33ca823eb9db3be9d6eab8144b25eade1b289604a2f86e7e274d1ec82fe740a64b87520bcff9507f09c7090f1a22
+  data.tar.gz: d4e203073bb3e9c832566194e319dd760e6b6f695d7c7a9d3f57b4e3a81d56f77b7269eefa900f19176d0eef601291b826126efe3f4e2b4a9750be506d77509c

data/lib/twiglet/version.rb

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

data/sig/hash_extensions.rbs

@@ -0,0 +1,9 @@
+module HashExtensions
+  def to_nested: () -> Hash[Symbol, untyped]
+  def deep_merge: (Hash[untyped, untyped] hash_to_merge) -> Hash[Symbol, untyped]
+
+  private
+
+  def contains_dotted_key?: () -> bool
+  def build_nested_object: (Symbol | String key, untyped val) -> Hash[Symbol, untyped]
+end

data/sig/json-schema.rbs

@@ -0,0 +1,12 @@
+# Ships to consumers: our signatures name these and json-schema has no RBS of its own.
+# Keep method-free - a method here is a hard error in the build of any consumer with their
+# own json-schema stubs.
+module JSON
+  class Validator
+  end
+
+  class Schema
+    class ValidationError < StandardError
+    end
+  end
+end

data/sig/manifest.yaml

@@ -0,0 +1,6 @@
+# D = Development Dependencies
+# S = Standard Library Dependencies
+dependencies:
+  - name: logger
+  - name: json
+  - name: time

data/sig/twiglet/error_serialiser.rbs

@@ -0,0 +1,9 @@
+module Twiglet
+  class ErrorSerialiser
+    def serialise_error: (Exception error) -> Hash[Symbol, untyped]
+
+    private
+
+    def add_stack_trace: (Hash[Symbol, untyped] hash_to_add_to, Exception error) -> Hash[Symbol, untyped]
+  end
+end

data/sig/twiglet/formatter.rbs

@@ -0,0 +1,24 @@
+module Twiglet
+  class Formatter < ::Logger::Formatter
+    @service_name: String
+    @now: ^() -> Time
+    @default_properties: Hash[Symbol, untyped]
+    @context_providers: Array[^() -> Hash[Symbol, untyped]]
+    @validator: Validator
+
+    def initialize: (
+      String service_name,
+      validator: Validator,
+      ?default_properties: Hash[Symbol, untyped],
+      ?context_provider: (^() -> Hash[Symbol, untyped])?,
+      ?context_providers: Array[^() -> Hash[Symbol, untyped]],
+      ?now: ^() -> Time
+    ) -> void
+
+    def call: (String severity, Time _time, String? _progname, String | Hash[untyped, untyped] | nil msg) -> String
+
+    private
+
+    def log: (level: String, message: Message) -> String
+  end
+end

data/sig/twiglet/logger.rbs

@@ -0,0 +1,39 @@
+module Twiglet
+  class Logger < ::Logger
+    DEFAULT_VALIDATION_SCHEMA: String
+
+    @service_name: String
+    @args: Hash[Symbol, untyped]
+    @validator: Validator
+
+    def initialize: (
+      String service_name,
+      ?now: ^() -> Time,
+      ?output: IO,
+      ?level: Integer,
+      ?validation_schema: String,
+      ?default_properties: Hash[Symbol, untyped],
+      ?context_provider: (^() -> Hash[Symbol, untyped])?,
+      ?context_providers: Array[^() -> Hash[Symbol, untyped]],
+      **untyped args
+    ) -> void
+
+    def configure_validation_error_response: () { (JSON::Schema::ValidationError) -> void } -> void
+
+    def debug: (?String | Hash[untyped, untyped] | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> true
+    def info: (?String | Hash[untyped, untyped] | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> true
+    def warn: (?String | Hash[untyped, untyped] | Exception | nil message_or_error) ?{ () -> (String | Hash[untyped, untyped]) } -> true
+    def error: (?String | Hash[untyped, untyped] | Exception | nil message_or_error, ?Exception? error) ?{ () -> (String | Hash[untyped, untyped]) } -> true
+
+    def with: (Hash[Symbol, untyped] default_properties) -> Logger
+    def validation_schema: (String validation_schema) -> Logger
+    def context_provider: () { () -> Hash[Symbol, untyped] } -> Logger
+
+    alias warning warn
+    alias critical fatal
+
+    private
+
+    def error_message: (Exception error, ?(String | Hash[untyped, untyped])? message) -> Message
+  end
+end

data/sig/twiglet/message.rbs

@@ -0,0 +1,5 @@
+module Twiglet
+  class Message < Hash[Symbol, untyped]
+    def initialize: (String | Hash[untyped, untyped] | nil msg) -> void
+  end
+end

data/sig/twiglet/validator.rbs

@@ -0,0 +1,11 @@
+module Twiglet
+  class Validator
+    attr_accessor custom_error_handler: ^(JSON::Schema::ValidationError) -> void
+
+    @schema: Hash[String, untyped]
+    @validator: JSON::Validator
+
+    def initialize: (String schema) -> void
+    def validate: (Message message) -> void
+  end
+end

data/sig/twiglet/version.rbs

@@ -0,0 +1,3 @@
+module Twiglet
+  VERSION: String
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.17.2
+  version: 3.18.1
 platform: ruby
 authors:
 - Simply Business
 bindir: bin
 cert_chain: []
-date: 2026-07-13 00:00:00.000000000 Z
+date: 2026-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -152,6 +152,15 @@ files:
 - lib/twiglet/validation_schema.json
 - lib/twiglet/validator.rb
 - lib/twiglet/version.rb
+- sig/hash_extensions.rbs
+- sig/json-schema.rbs
+- sig/manifest.yaml
+- sig/twiglet/error_serialiser.rbs
+- sig/twiglet/formatter.rbs
+- sig/twiglet/logger.rbs
+- sig/twiglet/message.rbs
+- sig/twiglet/validator.rbs
+- sig/twiglet/version.rbs
 homepage: https://github.com/simplybusiness/twiglet-ruby
 licenses:
 - MIT