cogger 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 492646c716b64bbf80f9aa93bf0092220068b00ef8abe89bc8baaaef9f3464f7
-  data.tar.gz: 834d46200c376ffc6c538e229ae5f5ca4b44ba0beed3c2724e5585ebc8aca642
+  metadata.gz: 925679ac5f76d9dcd1d9dedde73857a6ca6f66b214321926d63b47a56b4eb857
+  data.tar.gz: db34b9122766c6f2b2f914435bd42c41a6b5b77a0b6be2b0352c0630f669c41f
 SHA512:
-  metadata.gz: cc80eb9f305539d61932c5c5a95e01dfeb18ee76dee502049aabac4073ab37ee33ef45dbd73e7df6637b23f5b4e623df0e144e01a64755c646513bfe3dd45e0c
-  data.tar.gz: 7c52fdfd07d8e2595f2f02e28b9546c4b7d389a9b7ae3f32feb686d8719a07533581f5b5ea28c0a0ab2684e457d7a3a8cc6e8b49ebfa0831deb6dbb1ffda5d95
+  metadata.gz: f404fed5aa1db3c8c118586976895c55a231883cbac4a8f386795729a58574103585637440597ea21939ecf6fd32530b616205884aea9bbd50f9f45e6139eeff
+  data.tar.gz: 623939be083087672ed80f20bc8a7641793ec19ded0191bb54f8eb3b72f0a535eeebdc1ae17c5072800198a19b49aef626bfd901264dfff4824a07466be777f0

data/README.adoc

@@ -115,6 +115,7 @@ When creating a new logger, you can configure behavior via the following attribu
 * `formatter`: The formatter to use for formatting your log output. Default: `Cogger::Formatter::Color`. See the _Formatters_ section for more info.
 * `tags`: The global tags used for all log entries. _Must_ be an array of objects you wish to use for tagging purposes. Default: `[]`.
 * `datetime_format`: The global date/time format used for all `Time`, `Date`, and/or `DateTime` values in your log entries. Default: `%Y-%m-%dT%H:%M:%S.%L%:z`.
+* `header`: Determines if your log files should start with a date/time header comment. Can be `true` or `false` and is identical to the `skip_header` functionality found in the {logger_link} class. Default: `true`. This is automatically disabled -- and can't be overwritten -- when using the JSON formatter since the JSON format doesn't support code comments.
 * `mode`: The binary mode which determines if your logs should be written in binary mode or not. Can be `true` or `false` and is identical to the `binmode` functionality found in the {logger_link} class. Default: `false`.
 * `age`: The rotation age of your log. This only applies when logging to a file. This is equivalent to the `shift_age` as found with the {logger_link} class. Default: `0`.
 * `size`: The rotation size of your log. This only applies when logging to a file. This is equivalent to the `shift_size` as found with the {logger_link} class. Default: `1,048,576` (i.e. 1 MB).
@@ -134,6 +135,7 @@ logger = Cogger.new id: :demo,
                     formatter: :json,
                     tags: %w[DEMO DB],
                     datetime_format: "%Y-%m-%d",
+                    header: false,
                     mode: false,
                     age: 5,
                     size: 1_000,
@@ -1183,8 +1185,9 @@ logger.inspect
 #                @formatter=Cogger::Formatters::Emoji,
 #                @datetime_format=\"%Y-%m-%dT%H:%M:%S.%L%:z\",
 #                @tags=[],
+#                @header=true,
 #                @mode=false,
-#                @age=0,
+#                @age=,
 #                @size=1048576,
 #                @suffix=\"%Y-%m-%d\",
 #                @entry=Cogger::Entry,

data/cogger.gemspec

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

data/lib/cogger/configuration.rb

@@ -13,6 +13,7 @@ module Cogger
     :formatter,
     :datetime_format,
     :tags,
+    :header,
     :mode,
     :age,
     :size,
@@ -29,6 +30,7 @@ module Cogger
                    formatter: Formatters::Emoji.new,
                    datetime_format: DATETIME_FORMAT,
                    tags: Core::EMPTY_ARRAY,
+                   header: true,
                    mode: false,
                    age: nil,
                    size: 1_048_576,
@@ -49,6 +51,7 @@ module Cogger
                  level:,
                  formatter:,
                  datetime_format:,
+                 skip_header: skip_header?,
                  binmode: mode,
                  shift_period_suffix: suffix
     end
@@ -56,8 +59,12 @@ module Cogger
     def inspect
       "#<#{self.class} @id=#{id}, @io=#{io.class}, @level=#{level}, " \
       "@formatter=#{formatter.class}, @datetime_format=#{datetime_format.inspect}, " \
-      "@tags=#{tags.inspect}, @mode=#{mode}, @age=#{age}, @size=#{size}, " \
+      "@tags=#{tags.inspect}, @header=#{header}, @mode=#{mode}, @age=#{age}, @size=#{size}, " \
       "@suffix=#{suffix.inspect}, @entry=#{entry}, @logger=#{logger}>"
     end
+
+    private
+
+    def skip_header? = formatter == :json || formatter.is_a?(Formatters::JSON) || !header
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cogger
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A customizable and feature rich logger.
 test_files: []