cogger 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 206ff070eb7f86523ea8ce73f13b12ca5eaa8e13d81d8adf389e69d984193d7d
-  data.tar.gz: 5445cfff99f24c1af2fed78cc741ef0c469718c80fa54c5a4c1dff99069085f5
+  metadata.gz: 842b2f64a772746d63f841f53e74e644479a2df6ee539ad17b7f1695cd65930e
+  data.tar.gz: f12f15f27394bc984e32466101da2fbba972fb4f581d23a9c69cb9885b5c73e3
 SHA512:
-  metadata.gz: fbbae623ca9b520bbe356f9fa37f35b1e3520b66e4deebeae2bc4d8dc8700ffa08531efde1c7db5ac49a37a428544ea1430b032594e90eed44ac006c1016a111
-  data.tar.gz: 6c2a1e66c79d661e4131fb2a14d20984fcf945dac6746efd010043b7eaa4c62c69a1a451681cba7da531e8042639de0cc685ec46e92601820f2762c3f99585cd
+  metadata.gz: d4f48bc1845ac01851158ac17c027165335b617883e078e343a202d1e490d36fb4ab24fe4b238de6e4043213043d1be71b9b0b7d71eac958ae7b089d2de00d09
+  data.tar.gz: 3e6e608feec69ad5389176a02454e67521da40f8fb89112036c48aa78169a44edec3d3c0ef601524f195c0b22a9b14216a8e64631bd96ad72eba54f02995321c

data/README.adoc

@@ -10,7 +10,7 @@
 
 = Cogger
 
-Cogger is a portmanteau for custom logger (i.e. `[c]ustom + l[ogger] = cogger`) which enhances Ruby's native {logger_link} functionality with additional features such as dynamic emojis, colorized text, structured JSON, multiple outputs, and much more. 🚀
+Cogger is a portmanteau for custom logger (i.e. `[c]ustom + l[ogger] = cogger`) which enhances Ruby's native {logger_link} functionality with additional features such as dynamic emojis, colorized text, structured JSON, multiple streams, and much more. 🚀
 
 toc::[]
 
@@ -19,7 +19,7 @@ toc::[]
 * Enhances Ruby's default {logger_link} with additional functionality and firepower.
 * Provides dynamic/specific emoji output.
 * Provides dynamic/specific colorized output via the {tone_link} gem.
-* Provides customizable templates which leverage native {format_link}.
+* Provides customizable templates which leverage the {format_link}.
 * Provides customizable formatters for simple, color, emoji, JSON, and/or custom formats.
 * Provides multiple streams so you can log the same information to several outputs at once.
 * Provides global and individual log entry tagging.
@@ -28,7 +28,7 @@ toc::[]
 
 == Screenshots
 
-image::https://alchemists.io/images/projects/cogger/screenshots/demo.png[Rack,width=713,height=1110]
+image::https://alchemists.io/images/projects/cogger/screenshots/demo.png[Rack,width=724,height=1118]
 
 == Requirements
 
@@ -73,7 +73,7 @@ All behavior is provided by creating an instance of `Cogger`. Example:
 [source,ruby]
 ----
 logger = Cogger.new
-logger.info "Demo"  # "Demo"
+logger.info "Demo" # 🟢 [console] Demo
 ----
 
 If you set your logging level to `debug`, you can walk through each level:
@@ -213,10 +213,10 @@ Here's a detailed breakdown of the above:
 
 * *Universal*: Applies color universally to the _entire_ template and requires you to:
 ** Wrap your entire template in a  and start (`<dynamic>`) and end tag (`</dynamic>`) which works much like an HTML tag in this context.
-** Your tag names must either be `<dynamic></dynamic>`, any default color (example: `<green></green>`), or alias (i.e. `<your_alias></your_alias>`) as supported by the {tone_link} gem.
+** Your tag names must either be dynamic based on log level: `<dynamic></dynamic>`, a specific color: `<green></green>`, or an alias (example: `<your_alias></your_alias>`) as supported by the {tone_link} gem.
 * *Individual*: Individual templates allow you to apply color to _specific_ attributes and require you to:
-** Format your attributes as `attribute:directive`. The colon delimiter is required to separate your attribute for your color choice.
-** The color value (what follows after the colon) can be `dynamic`, any default color (example: `green`), or alias (i.e. `your_alias`) as supported by the {tone_link} gem.
+** Format your attributes as `%<attribute:directive>s`. The colon delimiter is required to separate your attribute for your color choice.
+** The color value (what follows after the colon) can be `dynamic`, any color (example: `green`), or an alias (i.e. `your_alias`) as supported by the {tone_link} gem.
 
 In addition to the general categorization of universal and individual tags, each support the following directives:
 
@@ -380,10 +380,17 @@ Symbols or strings can be used interchangeably when adding/getting formatters. A
 
 [source,ruby]
 ----
-Cogger::Formatters::Color::TEMPLATE   # "%<message:dynamic>s"
-Cogger::Formatters::Emoji::TEMPLATE   # "%<emoji:dynamic>s %<message:dynamic>s"
-Cogger::Formatters::JSON::TEMPLATE    # nil
-Cogger::Formatters::Simple::TEMPLATE  # "%<message>s"
+Cogger::Formatters::Color::TEMPLATE
+# "<dynamic>[</dynamic>%<id:dynamic>s<dynamic>]</dynamic> %<message:dynamic>s"
+
+Cogger::Formatters::Emoji::TEMPLATE
+# "%<emoji:dynamic>s <dynamic>[</dynamic>%<id:dynamic>s<dynamic>]</dynamic> %<message:dynamic>s"
+
+Cogger::Formatters::JSON::TEMPLATE
+# nil
+
+Cogger::Formatters::Simple::TEMPLATE
+# "[%<id>s] %<message>s"
 ----
 
 💡 When you find yourself customizing any of the default formatters, you can reduce typing by adding your custom configuration to the registry and then referring to it via it's associated key when initializing a new logger.
@@ -457,7 +464,7 @@ The emoji formatter is enabled by default and is the equivalent of initializing
 ----
 logger = Cogger.new
 logger = Cogger.new formatter: :emoji
-logger = Cogger.new formatter: Cogger::Formatters::Emoji.new("%<emoji:dynamic>s %<message:dynamic>s")
+logger = Cogger.new formatter: Cogger::Formatters::Emoji.new
 ----
 
 All of the above examples are identical so you can see how different formatters can be used and customized further. The default emojis are registered as follows:
@@ -1042,6 +1049,8 @@ bin/rake
 
 == link:https://alchemists.io/policies/contributions[Contributions]
 
+== link:https://alchemists.io/policies/developer_certificate_of_origin[Developer Certificate of Origin]
+
 == link:https://alchemists.io/projects/cogger/versions[Versions]
 
 == link:https://alchemists.io/community[Community]

data/cogger.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "cogger"
-  spec.version = "0.23.0"
+  spec.version = "0.24.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/cogger"

data/lib/cogger/formatters/color.rb

@@ -4,7 +4,7 @@ module Cogger
   module Formatters
     # Formats by color.
     class Color
-      TEMPLATE = "[%<id:dynamic>s] %<message:dynamic>s"
+      TEMPLATE = "<dynamic>[</dynamic>%<id:dynamic>s<dynamic>]</dynamic> %<message:dynamic>s"
 
       def initialize template = TEMPLATE, processor: Processors::Color.new
         @template = template

data/lib/cogger/formatters/emoji.rb

@@ -4,7 +4,8 @@ module Cogger
   module Formatters
     # Formats by emoji and color.
     class Emoji < Color
-      TEMPLATE = "%<emoji:dynamic>s [%<id:dynamic>s] %<message:dynamic>s"
+      TEMPLATE = "%<emoji:dynamic>s <dynamic>[</dynamic>%<id:dynamic>s<dynamic>]</dynamic> " \
+                 "%<message:dynamic>s"
 
       def initialize(template = TEMPLATE, ...)
         super

data/lib/cogger/formatters/json.rb

@@ -10,9 +10,9 @@ module Cogger
       TEMPLATE = nil
 
       def initialize template = TEMPLATE,
-                     parser: Parsers::Individual.new,
+                     parser: Parsers::KeyExtractor.new,
                      sanitizer: Kit::Sanitizer
-        @positions = template ? parser.call(template).last.keys : Core::EMPTY_ARRAY
+        @positions = template ? parser.call(template) : Core::EMPTY_ARRAY
         @sanitizer = sanitizer
       end
 

data/lib/cogger/formatters/parsers/abstract.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Cogger
+  module Formatters
+    module Parsers
+      # An abstrct class with default functionality.
+      class Abstract
+        def initialize registry: Cogger, colorizer: Kit::Colorizer, expressor: Regexp
+          @registry = registry
+          @colorizer = colorizer
+          @expressor = expressor
+        end
+
+        def call(_template, **)
+          fail NoMethodError,
+               "`#{self.class}##{__method__} #{method(__method__).parameters}` must be implemented."
+        end
+
+        protected
+
+        attr_reader :registry, :colorizer, :expressor
+      end
+    end
+  end
+end

data/lib/cogger/formatters/parsers/combined.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Cogger
+  module Formatters
+    module Parsers
+      # Parses template literals, emojis, and keys for specific and dynamic colors.
+      class Combined
+        STEPS = [Element.new, Emoji.new, Specific.new].freeze
+
+        def initialize steps: STEPS
+          @steps = steps
+        end
+
+        def call(template, **attributes)
+          steps.reduce(template.dup) { |modification, step| step.call modification, **attributes }
+        end
+
+        private
+
+        attr_reader :steps
+      end
+    end
+  end
+end

data/lib/cogger/formatters/parsers/element.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Cogger
+  module Formatters
+    module Parsers
+      # Parses template elements for specific and dynamic colors.
+      class Element < Abstract
+        PATTERN = %r(
+                    <                # Tag open start.
+                    (?<name>\w+)     # Tag open name.
+                    >                # Tag open end.
+                    (?<content>.+?)  # Content.
+                    </               # Tag close start.
+                    \w+              # Tag close.
+                    >                # Tag close end.
+                  )mx
+
+        def initialize pattern: PATTERN
+          super()
+          @pattern = pattern
+        end
+
+        def call(template, **)
+          template.gsub! pattern do
+            captures = expressor.last_match.named_captures
+            color = colorizer.call(captures["name"], **)
+            registry.color[captures["content"], color]
+          end
+
+          template
+        end
+
+        private
+
+        attr_reader :pattern
+      end
+    end
+  end
+end

data/lib/cogger/formatters/parsers/emoji.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Cogger
+  module Formatters
+    module Parsers
+      # Parses template emojis for specific and dynamic colors.
+      class Emoji < Abstract
+        PATTERN = /
+                    %<             # Start.
+                    emoji          # Name.
+                    :              # Delimiter.
+                    (?<color>\w+)  # Color.
+                    >s             # End.
+                  /x
+
+        def initialize pattern: PATTERN
+          super()
+          @pattern = pattern
+        end
+
+        def call(template, **)
+          template.gsub! pattern do
+            captures = expressor.last_match.named_captures
+            color = colorizer.call(captures["color"], **)
+
+            registry.get_emoji color
+          end
+
+          template
+        end
+
+        private
+
+        attr_reader :pattern
+      end
+    end
+  end
+end

data/lib/cogger/formatters/parsers/key_extractor.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Cogger
+  module Formatters
+    module Parsers
+      # Parses template and extracts keys.
+      class KeyExtractor
+        PATTERN = /
+                    %             # Start.
+                    ?             # Flag, width, or precision.
+                    <             # Reference start.
+                    (?<name>\w+)  # Name.
+                    (?::[\w]+)?   # Optional delimiter and or color.
+                    >             # Reference end.
+                    ?             # Specifier.
+                  /x
+
+        def initialize pattern: PATTERN
+          @pattern = pattern
+        end
+
+        def call(template) = template.scan(pattern).map { |match| match.first.to_sym }
+
+        private
+
+        attr_reader :pattern
+      end
+    end
+  end
+end

data/lib/cogger/formatters/parsers/specific.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "core"
+
+module Cogger
+  module Formatters
+    module Parsers
+      # Parses template for specific and dynamic string format specifiers.
+      class Specific < Abstract
+        PATTERN = /
+                    %                                   # Start.
+                    (?<flag>[\s#+-0*])?                 # Optional flag.
+                    (?<width>\d+)?                      # Optional width.
+                    \.?                                 # Optional precision delimiter.
+                    (?<precision>\d+)?                  # Optional precision value.
+                    <                                   # Reference start.
+                    (?<name>\w+)                        # Name.
+                    :                                   # Delimiter.
+                    (?<color>\w+)                       # Color.
+                    >                                   # Reference end.
+                    (?<specifier>[ABEGXabcdefgiopsux])  # Specifier.
+                  /x
+
+        def initialize pattern: PATTERN
+          super()
+          @pattern = pattern
+        end
+
+        # :reek:TooManyStatements
+        def call(template, **)
+          template.gsub! pattern do |match|
+            captures = expressor.last_match.named_captures
+            original_color = captures["color"]
+            color = colorizer.call(original_color, **)
+
+            match.sub! ":#{original_color}", Core::EMPTY_STRING
+            registry.color[match, color]
+          end
+
+          template
+        end
+
+        private
+
+        attr_reader :pattern
+      end
+    end
+  end
+end

data/lib/cogger/formatters/processors/color.rb

@@ -1,58 +1,23 @@
 # frozen_string_literal: true
 
-require "tone"
-
 module Cogger
   module Formatters
     module Processors
-      # Processes emojis and colors.
+      # Processes template with entry input using all template parsers.
       class Color
-        def initialize parser: Parsers::Dynamic.new,
-                       kit: {sanitizer: Kit::Sanitizer, colorizer: Kit::Colorizer},
-                       registry: Cogger
+        def initialize parser: Parsers::Combined.new, sanitizer: Kit::Sanitizer
           @parser = parser
-          @kit = kit
-          @registry = registry
+          @sanitizer = sanitizer
         end
 
         def call(template, *input)
           attributes = sanitizer.call(*input).tagged
-
-          case parser.call template
-            in [String => body, String => style] then universal body, style, **attributes
-            in [String => body, Hash => styles] then individual body, attributes, styles
-            # :nocov:
-          end
+          [parser.call(template, **attributes), attributes]
         end
 
         private
 
-        attr_reader :parser, :kit, :registry
-
-        def universal body, style, **attributes
-          [registry.color[body, colorizer.call(style, attributes)], attributes]
-        end
-
-        def individual body, attributes, styles
-          attributes = attributes.each.with_object({}) do |(key, value), collection|
-            collection[key] = registry.color[value, colorizer.call(styles[key], attributes)]
-          end
-
-          emojify attributes, styles
-          [body, attributes]
-        end
-
-        def emojify attributes, styles
-          style = styles[:emoji]
-
-          return unless style
-
-          attributes[:emoji] = registry.get_emoji colorizer.call(style, attributes)
-        end
-
-        def sanitizer = kit.fetch :sanitizer
-
-        def colorizer = kit.fetch :colorizer
+        attr_reader :parser, :sanitizer
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cogger
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-08-16 00:00:00.000000000 Z
+date: 2024-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: core
@@ -114,9 +114,12 @@ files:
 - lib/cogger/formatters/json.rb
 - lib/cogger/formatters/kit/colorizer.rb
 - lib/cogger/formatters/kit/sanitizer.rb
-- lib/cogger/formatters/parsers/dynamic.rb
-- lib/cogger/formatters/parsers/individual.rb
-- lib/cogger/formatters/parsers/universal.rb
+- lib/cogger/formatters/parsers/abstract.rb
+- lib/cogger/formatters/parsers/combined.rb
+- lib/cogger/formatters/parsers/element.rb
+- lib/cogger/formatters/parsers/emoji.rb
+- lib/cogger/formatters/parsers/key_extractor.rb
+- lib/cogger/formatters/parsers/specific.rb
 - lib/cogger/formatters/processors/color.rb
 - lib/cogger/formatters/simple.rb
 - lib/cogger/hub.rb

data/lib/cogger/formatters/parsers/dynamic.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Cogger
-  module Formatters
-    module Parsers
-      # Dynamically extracts the universal or individual template attributes for log entry parsing.
-      class Dynamic
-        # Order matters.
-        DELEGATES = [Universal.new, Individual.new].freeze
-
-        def initialize delegates: DELEGATES
-          @delegates = delegates
-        end
-
-        def call(template) = parse(template) || template
-
-        private
-
-        attr_reader :delegates
-
-        def parse template
-          delegates.find do |delegate|
-            result = delegate.call template
-            break result unless result == template
-          end
-        end
-      end
-    end
-  end
-end

data/lib/cogger/formatters/parsers/individual.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module Cogger
-  module Formatters
-    module Parsers
-      # Sanitizes and extracts individual directives from a template.
-      class Individual
-        # rubocop:todo Lint/MixedRegexpCaptureTypes
-        PATTERN = /
-                    %                                   # Strict reference syntax.
-                    (?<flag>[\s#+-0*])?                 # Optional flag.
-                    (?<width>\d+)?                      # Optional width.
-                    \.?                                 # Optional precision delimiter.
-                    (?<precision>\d+)?                  # Optional precision value.
-                    <                                   # Reference start.
-                    (                                   # Conditional start.
-                    (?<key>\w+)                         # Key.
-                    :                                   # Directive delimiter.
-                    (?<directive>\w+)                   # Value.
-                    |                                   # Conditional.
-                    (?<key>\w+)                         # Key.
-                    )                                   # Conditional end.
-                    >                                   # Reference end.
-                    (?<specifier>[ABEGXabcdefgiopsux])  # Specifier.
-                  /mx
-        # rubocop:enable Lint/MixedRegexpCaptureTypes
-
-        def initialize pattern: PATTERN
-          @pattern = pattern
-        end
-
-        def call template
-          attributes = {}
-
-          return [template, attributes] unless template.match? pattern
-
-          template = sanitize_and_extract template, attributes
-          [template, attributes]
-        end
-
-        private
-
-        attr_reader :pattern
-
-        # :reek:FeatureEnvy
-        # :reek:TooManyStatements
-        def sanitize_and_extract template, attributes
-          template.gsub pattern do
-            captures = Regexp.last_match.named_captures symbolize_names: true
-            attributes[captures[:key].to_sym] = captures[:directive]
-
-            captures.reduce(+"%") do |body, (key, value)|
-              next body if key == :directive
-
-              body.concat key == :key ? "<#{value}>" : value.to_s
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/cogger/formatters/parsers/universal.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require "core"
-
-module Cogger
-  module Formatters
-    module Parsers
-      # Sanitizes and extracts the universal directive a template.
-      class Universal
-        # rubocop:todo Lint/MixedRegexpCaptureTypes
-        PATTERN = %r(
-                    (                  # Conditional start.
-                    \A                 # Search start.
-                    <                  # Tag start.
-                    (?<directive>\w+)  # Directive.
-                    >                  # Tag end.
-                    |                  # Conditional pipe.
-                    <                  # Tag start.
-                    /                  # Tag close.
-                    (?<directive>\w+)  # Directive.
-                    >                  # Tag end.
-                    \Z                 # Search end.
-                    )                  # Conditional end.
-                  )mx
-        # rubocop:enable Lint/MixedRegexpCaptureTypes
-
-        KEY = "directive"
-
-        def initialize pattern: PATTERN, key: KEY
-          @pattern = pattern
-          @key = key
-        end
-
-        def call template
-          return template unless template.match? pattern
-
-          [template.gsub(pattern, Core::EMPTY_STRING), template.match(pattern)[key]]
-        end
-
-        private
-
-        attr_reader :pattern, :key
-      end
-    end
-  end
-end