contextual_logger 0.11.0 → 0.12.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c5fcdf15e253eb8abb46dde530238633bd584f151e0282526dcfce923b4dc50
-  data.tar.gz: da4e10e4a778d244b2c36640ec4600bc76e4357fd4b0ddfbfef362c2276bbd5a
+  metadata.gz: c2ef105e4dfaf32e5e215d83e05ac6ba4f5c67a32cb11e214598a668b4afd34e
+  data.tar.gz: d8fa3b949bf2880a1992f6bce1fcfd6b6b59ec4aa46340d9752c8b27fc7dd6cc
 SHA512:
-  metadata.gz: c575941e59fe7196d27528ea0733bd841eb47e45914f8b74add858227fc55161c2cbc2837653033f80ddfea3c3768538c137392d0e3a2b9f64c344982fb281ff
-  data.tar.gz: 199b5c2446a3fe1e6730b352dd23e93c0f9a52e04fffc335b28c6b26e0a2f5e3fe658b9949f57f87b3adba952e2b27ebc493e05dc5a3b2944baefcea0203e099
+  metadata.gz: 3df6d16bf7ffc7cc36bb0f95103222f1791a228ee4e1034ef883261bdaa10ac5d16c57fafa6cdd58d524fee2ebec5c86fab5b2dcc3df05eaf2d35acea1f00eed
+  data.tar.gz: e1db9f65be3eb35690cea59ceee623188b40f03377b7a467d12d2644ed8a957246afb70a43eb736a639d541ecdf093d7832f909b0878d1e87c41d889e9be44ea

data/lib/contextual_logger.rb

@@ -5,6 +5,7 @@ require 'active_support/core_ext/module/delegation'
 require 'json'
 require_relative './contextual_logger/redactor'
 require_relative './contextual_logger/context/handler'
+require_relative './contextual_logger/context/registry'
 
 module ContextualLogger
   LOG_LEVEL_NAMES_TO_SEVERITY =
@@ -45,12 +46,22 @@ module ContextualLogger
   module LoggerMixin
     delegate :register_secret, to: :redactor
 
+    def register_context(&block)
+      block or raise ArgumentError, 'Block of context definitions was not passed'
+      @context_registry = Context::Registry.new(&block)
+    end
+
     def global_context=(context)
-      Context::Handler.new(context).set!
+      Context::Handler.new(context_registry.format(context)).set!
     end
 
     def with_context(context)
-      context_handler = Context::Handler.new(current_context_for_thread.deep_merge(context))
+      context_handler = Context::Handler.new(
+        current_context_for_thread.deep_merge(
+          context_registry.format(context)
+        )
+      )
+
       context_handler.set!
       if block_given?
         begin
@@ -117,7 +128,7 @@ module ContextualLogger
           message = arg1
           progname = arg2 || @progname
         end
-        write_entry_to_log(severity, Time.now, progname, message, context: current_context_for_thread.deep_merge(context))
+        write_entry_to_log(severity, Time.now, progname, message, context: current_context_for_thread.deep_merge(context_registry.format(context)))
       end
 
       true
@@ -133,6 +144,13 @@ module ContextualLogger
 
     private
 
+    def context_registry
+      @context_registry ||= Context::Registry.new do
+        strict false
+        raise_on_missing_definition false
+      end
+    end
+
     def redactor
       @redactor ||= Redactor.new
     end

data/lib/contextual_logger/context/handler.rb

@@ -7,8 +7,10 @@ module ContextualLogger
 
       attr_reader :previous_context, :context
 
-      def self.current_context
-        Thread.current[THREAD_CONTEXT_NAMESPACE] || {}
+      class << self
+        def current_context
+          Thread.current[THREAD_CONTEXT_NAMESPACE] || {}
+        end
       end
 
       def initialize(context, previous_context: nil)

data/lib/contextual_logger/context/registry.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'registry_types/string'
+require_relative 'registry_types/boolean'
+require_relative 'registry_types/number'
+require_relative 'registry_types/date'
+require_relative 'registry_types/hash'
+
+# This class is responsible for holding the registered context shape that will
+# be used by the LoggerMixin to make sure that the context matches the shape
+# defined
+
+# logger.configure_context do
+#   strict false
+#
+#   string test_string
+#   integer test_integer
+#   hash :test_hash do
+#     string :test_string_in_hash
+#     date :date_time_in_hash
+#   end
+# end
+
+module ContextualLogger
+  module Context
+    class Registry < RegistryTypes::Hash
+      class DuplicateDefinitionError < StandardError; end
+      class MissingDefinitionError < StandardError; end
+
+      def initialize(&definitions)
+        @strict                        = true
+        @raise_on_missing_definition = true
+
+        super
+      end
+
+      def strict?
+        @strict
+      end
+
+      def raise_on_missing_definition?
+        @raise_on_missing_definition
+      end
+
+      def format(context)
+        if strict?
+          super(context, raise_on_missing_definition?)
+        else
+          context
+        end
+      end
+
+      alias context_shape to_h
+
+      def to_h
+        {
+          strict: @strict,
+          context_shape: context_shape
+        }
+      end
+
+      private
+
+      def strict(value)
+        @strict = value
+      end
+
+      def raise_on_missing_definition(value)
+        @raise_on_missing_definition = value
+      end
+    end
+  end
+end

data/lib/contextual_logger/context/registry_types/boolean.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ContextualLogger
+  module Context
+    module RegistryTypes
+      class Boolean
+        attr_reader :formatter
+
+        def initialize(formatter: nil)
+          @formatter = formatter || ->(value) { value ? true : false }
+        end
+
+        def to_h
+          { type: :boolean, formatter: formatter }
+        end
+
+        def format(value)
+          case formatter
+          when Proc
+            formatter.call(value)
+          else
+            value.send(formatter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contextual_logger/context/registry_types/date.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ContextualLogger
+  module Context
+    module RegistryTypes
+      class Date
+        attr_reader :formatter
+
+        def initialize(formatter: nil)
+          @formatter = formatter || ->(value) { value.iso8601(6) }
+        end
+
+        def to_h
+          { type: :date, formatter: formatter }
+        end
+
+        def format(value)
+          case formatter
+          when Proc
+            formatter.call(value)
+          else
+            value.send(formatter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contextual_logger/context/registry_types/hash.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative 'string'
+require_relative 'boolean'
+require_relative 'number'
+require_relative 'date'
+
+module ContextualLogger
+  module Context
+    module RegistryTypes
+      class Hash
+        def initialize(&definitions)
+          @definitions = {}
+
+          run(&definitions)
+        end
+
+        def to_h
+          @definitions.reduce({}) do |shape_hash, (key, value)|
+            shape_hash.merge(key => value.to_h)
+          end
+        end
+
+        def format(context, raise_on_missing_definition)
+          context.reduce({}) do |formatted_context, (key, value)|
+            if (definition = @definitions[key])
+              formatted_context[key] = if definition.is_a?(RegistryTypes::Hash)
+                                         definition.format(value, raise_on_missing_definition)
+                                       else
+                                         definition.format(value)
+                                       end
+            elsif raise_on_missing_definition
+              raise Registry::MissingDefinitionError, "Attempting to apply context #{key} that is missing a definition in the registry"
+            end
+
+            formatted_context
+          end
+        end
+
+        private
+
+        def string(context_key, formatter: nil)
+          dedup(context_key, :string)
+          @definitions[context_key] = RegistryTypes::String.new(formatter: formatter)
+        end
+
+        def boolean(context_key, formatter: nil)
+          dedup(context_key, :boolean)
+          @definitions[context_key] = RegistryTypes::Boolean.new(formatter: formatter)
+        end
+
+        def number(context_key, formatter: nil)
+          dedup(context_key, :number)
+          @definitions[context_key] = RegistryTypes::Number.new(formatter: formatter)
+        end
+
+        def date(context_key, formatter: nil)
+          dedup(context_key, :date)
+          @definitions[context_key] = RegistryTypes::Date.new(formatter: formatter)
+        end
+
+        def hash(context_key, &definitions)
+          dedup(context_key, :hash)
+          @definitions[context_key] = RegistryTypes::Hash.new(&definitions)
+        end
+
+        def run(&definitions)
+          instance_eval(&definitions)
+        end
+
+        def dedup(key, type)
+          @definitions.include?(key) and
+            raise Registry::DuplicateDefinitionError, "Defining duplicate entry #{key} previously as #{@definitions[key]} and now as #{type}"
+        end
+      end
+    end
+  end
+end

data/lib/contextual_logger/context/registry_types/number.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ContextualLogger
+  module Context
+    module RegistryTypes
+      class Number
+        attr_reader :formatter
+
+        def initialize(formatter: nil)
+          @formatter = formatter || :to_i
+        end
+
+        def to_h
+          { type: :number, formatter: formatter }
+        end
+
+        def format(value)
+          case formatter
+          when Proc
+            formatter.call(value)
+          else
+            value.send(formatter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contextual_logger/context/registry_types/string.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ContextualLogger
+  module Context
+    module RegistryTypes
+      class String
+        attr_reader :formatter
+
+        def initialize(formatter: nil)
+          @formatter = formatter || :to_s
+        end
+
+        def to_h
+          { type: :string, formatter: formatter }
+        end
+
+        def format(value)
+          case formatter
+          when Proc
+            formatter.call(value)
+          else
+            value.send(formatter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contextual_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContextualLogger
-  VERSION = '0.11.0'
+  VERSION = '0.12.0.pre.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contextual_logger
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0.pre.1
 platform: ruby
 authors:
 - James Ebentier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -46,6 +46,12 @@ extra_rdoc_files: []
 files:
 - lib/contextual_logger.rb
 - lib/contextual_logger/context/handler.rb
+- lib/contextual_logger/context/registry.rb
+- lib/contextual_logger/context/registry_types/boolean.rb
+- lib/contextual_logger/context/registry_types/date.rb
+- lib/contextual_logger/context/registry_types/hash.rb
+- lib/contextual_logger/context/registry_types/number.rb
+- lib/contextual_logger/context/registry_types/string.rb
 - lib/contextual_logger/logger_with_context.rb
 - lib/contextual_logger/overrides/active_support/tagged_logging/formatter.rb
 - lib/contextual_logger/redactor.rb
@@ -67,9 +73,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: