twiglet 3.1.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cace8decdc47857c5ce0bec8ae85b92fe93f866521bc6872371db38999b25c3
-  data.tar.gz: dc9bf4d673968a4c718af21c117584f7770a3f2d50cc704ff5d39da1bec26626
+  metadata.gz: 6970a1b98fbd77737c3742429691e3c03c7966e894e2f6a523824df785941858
+  data.tar.gz: 3a878416f432a4c9e38b0299afb6204fd2202168646d028298d40ab2c6cc7746
 SHA512:
-  metadata.gz: 12c4455ae13471d0ebf0899966c9dbd32bf17841c468beaddb0a912a234033921a1694c2007d6a9d1732bdb69dbabc21f88cf98a195b9eea9a9be52d51cc07db
-  data.tar.gz: 91fab7466ae13a05de15fe66c2b8e4b78b28e2ee31220cd0f427d3928bfd59b15dbec2facc444f5c3a10a29bade3ee568e369fb921360fd6ddbb4c76f80bafd0
+  metadata.gz: 8a2e0c5bd321f495f4cf2c5d69a8caaff889e352305c5a900c1c7415e8637d0127729c91bd030353c1dd3b56e9c5623880f46849d3ff3eac1d502c3df8752c54
+  data.tar.gz: 0076c02f4070de277e488278f9f858d529b0ab39d8f8c07bc59a9d583c40421f0231b769a7ffb6a6ad1b422ed17f22ee4cd2a7eb68e436dc3b2b6c70c0246c8e

data/lib/twiglet/logger.rb

@@ -13,28 +13,29 @@ module Twiglet
 
     def initialize(
       service_name,
-      default_properties: {},
-      now: -> { Time.now.utc },
-      output: $stdout,
-      level: Logger::DEBUG
+      **args
     )
       @service_name = service_name
-      @now = now
-      @output = output
-      @level = level
+      default_properties = args.delete(:default_properties) || {}
+      @args = args
+
+      now = args.fetch(:now, -> { Time.now.utc })
+      output = args.fetch(:output, $stdout)
+      level = args.fetch(:level, Logger::DEBUG)
+      validation_schema = args.fetch(:validation_schema, File.read("#{__dir__}/validation_schema.json"))
 
       raise 'Service name is mandatory' \
         unless service_name.is_a?(String) && !service_name.strip.empty?
 
-      @validator = Validator.from_file("#{__dir__}/validation_schema.json")
+      @validator = Validator.new(validation_schema)
 
-      @formatter = Twiglet::Formatter.new(
+      formatter = Twiglet::Formatter.new(
         service_name,
         default_properties: default_properties,
         now: now,
         validator: @validator
       )
-      super(output, formatter: @formatter, level: level)
+      super(output, formatter: formatter, level: level)
     end
 
     def configure_validation_error_response(&block)
@@ -59,10 +60,7 @@ module Twiglet
     def with(default_properties)
       Logger.new(
         @service_name,
-        default_properties: default_properties,
-        now: @now,
-        output: @output,
-        level: @level
+        **@args.merge(default_properties: default_properties)
       )
     end
 

data/lib/twiglet/validator.rb

@@ -8,14 +8,10 @@ module Twiglet
     attr_accessor :custom_error_handler
 
     def initialize(schema)
-      @schema = schema
+      @schema = JSON.parse(schema)
       @custom_error_handler = ->(e) { raise e }
     end
 
-    def self.from_file(file_path)
-      new(JSON.parse(File.read(file_path)))
-    end
-
     def validate(message)
       JSON::Validator.validate!(@schema, message)
     rescue JSON::Schema::ValidationError => e

data/lib/twiglet/version.rb

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

data/test/formatter_test.rb

@@ -8,7 +8,7 @@ require_relative '../lib/twiglet/validator'
 describe Twiglet::Formatter do
   before do
     @now = -> { Time.utc(2020, 5, 11, 15, 1, 1) }
-    @formatter = Twiglet::Formatter.new('petshop', now: @now, validator: Twiglet::Validator.new({}))
+    @formatter = Twiglet::Formatter.new('petshop', now: @now, validator: Twiglet::Validator.new({}.to_json))
   end
 
   it 'initializes an instance of a Ruby Logger Formatter' do

data/test/logger_test.rb

@@ -380,6 +380,61 @@ describe Twiglet::Logger do
     end
   end
 
+  describe 'validation schema' do
+    before 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,
+        validation_schema: validation_schema
+      )
+    end
+
+    it 'allows for the configuration of custom validation rules' do
+      @logger.debug(
+        {
+          pet: { name: 'Davis', best_boy_or_girl?: true, species: 'dog' }
+        }
+      )
+      log = read_json(@buffer)
+
+      assert_equal true, log[:pet][:best_boy_or_girl?]
+    end
+
+    it 'raises when custom validation rules are broken' do
+      nonconformant = {
+        pet: { name: 'Davis' }
+      }
+
+      assert_raises JSON::Schema::ValidationError,
+                    "The property '#/pet' did not contain a required property of 'best_boy_or_girl?'" do
+        @logger.debug(nonconformant)
+      end
+    end
+  end
+
   private
 
   def read_json(buffer)

data/test/validator_test.rb

@@ -17,7 +17,7 @@ describe Twiglet::Validator do
       }
     }
 
-    @validator = Twiglet::Validator.new(schema)
+    @validator = Twiglet::Validator.new(schema.to_json)
   end
 
   it 'does not raise when validation passes' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0
 platform: ruby
 authors:
 - Simply Business