tty-logger 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e4b31874b5d1ca9d091b11c0a5d6ca04c3b44a41f1d92c1f9d9b40fe2573c5c
-  data.tar.gz: 7f078cf57986ea70885db59ecab0bbd1da6afa93c272ea764208d3c88251b4f9
+  metadata.gz: '0594c7ef471a07571e5621e8535469fcb50edeeb10d7ffa58b194ef8fe4f8350'
+  data.tar.gz: 42a3b6c20b756754723c42c5b0ce85490b403978ffe566cb267dc6f18811f1c9
 SHA512:
-  metadata.gz: 1c255546632ba09a0aeac9b5e0395dd668576eb30a882342c18b9cf6a5fa525b0c6143e17a6bae3406fdbcb0306c17916c1a5016c62f2e5df816b5b70afeb040
-  data.tar.gz: ca12ab5f19b1037d50cc818a940b4e909521ebe7d4338fc552cb0901600eb61d713213f04d576713bfa146e971d050af9599d48d2eecea87013109aa190a39f8
+  metadata.gz: 5fb46bcc0515d4f4762dc9c601b65131a493153ed85e48e83ac64ae70b0b2060d0780d867560bfc8e50ed4c461ea62e1aeba5b4e1b6b55572656196e9958840b
+  data.tar.gz: 235421d689aa362a858a813fd369cef67673b0c6b13ccf50f6733a603746c3dfc00bde16fdd73fb1dd4358e9457c70d61c033c60d409e3f721eb0b34cc5c40bd

data/CHANGELOG.md

@@ -1,9 +1,19 @@
 # Change log
 
-## [v0.4.0] - 2020-07-29
+## [v0.5.0] - 2020-09-27
 
 ### Added
+* Add :message_format option to customize how messages are displayed in the console
+  by Josh Greenwood (@JoshTGreenwood)
+
+### Fixed
+* Fix to select event name from valid log types or current level
+  by Ryan Schlesinger (@ryansch)
+* Fix duplicate filters attribute definition in TTY::Logger::Config
 
+## [v0.4.0] - 2020-07-29
+
+### Added
 * Allow editing logger configuration at runtime ([#10](https://github.com/piotrmurach/tty-logger/pull/10))
 * Support for the `<<` streaming operator ([#9](https://github.com/piotrmurach/tty-logger/pull/9)))
 
@@ -40,6 +50,7 @@
 
 * Initial implementation and release
 
+[v0.5.0]: https://github.com/piotrmurach/tty-logger/compare/v0.4.0..v0.5.0
 [v0.4.0]: https://github.com/piotrmurach/tty-logger/compare/v0.3.0..v0.4.0
 [v0.3.0]: https://github.com/piotrmurach/tty-logger/compare/v0.2.0..v0.3.0
 [v0.2.0]: https://github.com/piotrmurach/tty-logger/compare/v0.1.0..v0.2.0

data/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <a href="https://piotrmurach.github.io/tty" target="_blank"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="tty logo" /></a>
+  <a href="https://ttytoolkit.org" target="_blank"><img width="130" src="https://github.com/piotrmurach/tty/raw/master/images/tty.png" alt="tty logo" /></a>
 </div>
 
 # TTY::Logger [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
@@ -42,7 +42,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'tty-logger'
+gem "tty-logger"
 ```
 
 And then execute:
@@ -62,7 +62,7 @@ Or install it yourself as:
     * [2.1.1 Exceptions](#211-exceptions)
     * [2.1.2 Types](#212-types)
   * [2.2 Levels](#22-levels)
-    * [2.2.1 Scoped Level](#22-scoped-levels)
+    * [2.2.1 Scoped Level](#22-scoped-level)
   * [2.3 Structured Data](#23-structured-data)
   * [2.4 Configuration](#24-configuration)
     * [2.4.1 Metadata](#241-metadata)
@@ -294,7 +294,7 @@ end
 # • debug   logged
 ```
 
-Or elevating level to error with a constant `ERROR_LEVEL`:
+Or elevate a level to an error with a constant `ERROR_LEVEL`:
 
 ```ruby
 logger.log_at TTY::Logger::ERROR_LEVEL do
@@ -346,6 +346,8 @@ All the configuration options can be changed globally via `configure` or per log
 * `:max_depth` - the maximum depth for nested structured data. Defaults to `3`.
 * `:metadata` - the meta info to display before the message, can be `:pid`, `:date`, `:time` or `:file`. Defaults to empty array `[]`, no metadata. Setting this to `:all` will print all the metadata.
 * `:types` - the new custom log types. Defaults to `{}`.
+* `:date_format` - uses `strftime` format to display dates. Defaults to `"%F"`.
+* `:time_format` - uses `strftime` format to display times. Defaults to `"%T.%3N"`.
 
 For example, to configure `:max_bytes`, `:level` and `:metadata` for all logger instances do:
 
@@ -549,6 +551,7 @@ The console handler prints log messages to the console. It supports the followin
 * `:styles` - a hash of styling options.
 * `:formatter` - the formatter for log messages. Defaults to `:text`
 * `:output` - the device to log error messages to. Defaults to `$stderr`
+* `:message_format` - uses `sprintf` format to display messages. Defaults to `"%-25s"`.
 
 The supported options in the `:styles` are:
 
@@ -604,6 +607,15 @@ styled_logger.error("Custom error")
 # ! Dooh    Custom error
 ```
 
+To increase message padding to a percentage of terminal width (depends on [tty-screen](https://github.com/piotrmurach/tty-screen/)):
+
+```ruby
+TTY::Logger.new do |config|
+  padding = (TTY::Screen.columns * 0.4).to_i
+  config.handlers = [[:console, { message_format: "%-#{padding}s" }]]
+end
+```
+
 #### 2.6.2 Stream handler
 
 To send log event data outside of console to another service or `IO` stream, you can use `:stream` handler.

data/lib/tty/logger.rb

@@ -104,6 +104,7 @@ module TTY
       @data_filter = DataFilter.new(@config.filters.data,
                                     mask: @config.filters.mask)
 
+      @types = LOG_TYPES.dup
       @config.types.each do |name, log_level|
         add_type(name, log_level)
       end
@@ -120,9 +121,11 @@ module TTY
     #
     # @api private
     def add_type(name, log_level)
-      if respond_to?(name)
+      if @types.include?(name)
         raise Error, "Already defined log type #{name.inspect}"
       end
+
+      @types[name.to_sym] = log_level
       self.class.define_level(name, log_level)
     end
 
@@ -226,8 +229,7 @@ module TTY
 
       self
     end
-
-    alias_method :<<, :write
+    alias << write
 
     # Log a message given the severtiy level
     #
@@ -254,7 +256,7 @@ module TTY
         level: current_level,
         time: Time.now,
         pid: Process.pid,
-        name: /<top\s+\(required\)>|<main>|<</ =~ label ? current_level : label,
+        name: @types.include?(label.to_sym) ? label : current_level,
         path: loc.path,
         lineno: loc.lineno,
         method: loc.base_label

data/lib/tty/logger/config.rb

@@ -7,15 +7,12 @@ module TTY
     class Config
       FILTERED = "[FILTERED]"
 
-      # The format used for date display
+      # The format used for date display. uses strftime format
       attr_accessor :date_format
 
-      # The format used for time display
+      # The format used for time display. uses strftime format
       attr_accessor :time_format
 
-      # The filters to hide sensitive data from the messages and data.
-      attr_accessor :filters
-
       # The format used for displaying structured data
       attr_accessor :formatter
 
@@ -28,7 +25,7 @@ module TTY
       # The maximum message size to be logged in bytes. Defaults to 8192
       attr_accessor :max_bytes
 
-      # The maximum depth for formattin array and hash objects. Defaults to 3
+      # The maximum depth for formatting array and hash objects. Defaults to 3
       attr_accessor :max_depth
 
       # The meta info to display, can be :date, :time, :file, :pid. Defaults to []
@@ -66,7 +63,7 @@ module TTY
         end
 
         def to_h
-          {message: @message, data: @data, mask: @mask}
+          { message: @message, data: @data, mask: @mask }
         end
 
         def to_s
@@ -92,6 +89,7 @@ module TTY
       def to_proc
         -> (config) {
           config.date_format = @date_format.dup
+          config.time_format = @time_format.dup
           config.filters = @filters.dup
           config.formatter = @formatter
           config.handlers = @handlers.dup
@@ -100,7 +98,6 @@ module TTY
           config.max_depth = @max_depth
           config.metadata = @metadata.dup
           config.output = @output.dup
-          config.time_format = @time_format.dup
           config.types = @types.dup
           config
         }

data/lib/tty/logger/data_filter.rb

@@ -37,11 +37,9 @@ module TTY
       def filter(obj)
         return obj if filters.empty?
 
-        hash = obj.reduce({}) do |acc, (k, v)|
+        obj.each_with_object({}) do |(k, v), acc|
           acc[k] = filter_val(k, v)
-          acc
         end
-        hash
       end
 
       private
@@ -50,7 +48,7 @@ module TTY
         compiled = {
           regexps: [],
           nested_regexps: [],
-          blocks: [],
+          blocks: []
         }
         strings = []
         nested_strings = []
@@ -105,9 +103,8 @@ module TTY
       end
 
       def filter_obj(_key, obj, composite)
-        obj.reduce({}) do |acc, (k, v)|
+        obj.each_with_object({}) do |(k, v), acc|
           acc[k] = filter_val(k, v, composite)
-          acc
         end
       end
 

data/lib/tty/logger/formatters/json.rb

@@ -20,7 +20,7 @@ module TTY
         def dump(obj, max_bytes: 2**12, max_depth: 3)
           bytesize = 0
 
-          hash = obj.reduce({}) do |acc, (k, v)|
+          hash = obj.each_with_object({}) do |(k, v), acc|
             str = (k.to_json + v.to_json)
             items = acc.keys.size - 1
 
@@ -31,7 +31,6 @@ module TTY
               bytesize += str.bytesize
               acc[k] = dump_val(v, max_depth)
             end
-            acc
           end
           ::JSON.generate(hash)
         end
@@ -50,13 +49,13 @@ module TTY
         def enc_obj(obj, depth)
           return ELLIPSIS if depth.zero?
 
-          obj.reduce({}) { |acc, (k, v)| acc[k] = dump_val(v, depth); acc }
+          obj.each_with_object({}) { |(k, v), acc| acc[k] = dump_val(v, depth) }
         end
 
         def enc_arr(obj, depth)
           return ELLIPSIS if depth.zero?
 
-          obj.reduce([]) { |acc, v| acc << dump_val(v, depth); acc }
+          obj.each_with_object([]) { |v, acc| acc << dump_val(v, depth) }
         end
       end # JSON
     end # Formatters

data/lib/tty/logger/formatters/text.rb

@@ -32,12 +32,13 @@ module TTY
         def dump(obj, max_bytes: 2**12, max_depth: 3)
           bytesize = 0
 
-          line = obj.reduce([]) do |acc, (k, v)|
+          line = obj.each_with_object([]) do |(k, v), acc|
             str = "#{dump_key(k)}=#{dump_val(v, max_depth)}"
             items = acc.size - 1
 
             if bytesize + str.bytesize + items > max_bytes
-              if bytesize + items + (acc[-1].bytesize - ELLIPSIS.bytesize) > max_bytes
+              if bytesize + items +
+                 (acc[-1].bytesize - ELLIPSIS.bytesize) > max_bytes
                 acc.pop
               end
               acc << ELLIPSIS
@@ -46,7 +47,6 @@ module TTY
               bytesize += str.bytesize
               acc << str
             end
-            acc
           end
           line.join(SPACE)
         end
@@ -86,8 +86,8 @@ module TTY
           return LBRACE + ELLIPSIS + RBRACE if depth.zero?
 
           LBRACE +
-            obj.map { |k, v| "#{dump_key(k)}=#{dump_val(v, depth)}" }.join(SPACE) +
-            RBRACE
+            obj.map { |k, v| "#{dump_key(k)}=#{dump_val(v, depth)}" }
+               .join(SPACE) + RBRACE
         end
 
         def enc_arr(array, depth)
@@ -113,7 +113,8 @@ module TTY
           case str
           when SINGLE_QUOTE_REGEX
             str.inspect
-          when ESCAPE_STR_REGEX, LITERAL_TRUE, LITERAL_FALSE, LITERAL_NIL, NUM_REGEX
+          when ESCAPE_STR_REGEX, LITERAL_TRUE, LITERAL_FALSE,
+               LITERAL_NIL, NUM_REGEX
             ESCAPE_DOUBLE_QUOTE + str.inspect[1..-2] + ESCAPE_DOUBLE_QUOTE
           else
             str

data/lib/tty/logger/handlers/console.rb

@@ -55,7 +55,7 @@ module TTY
             color: :cyan,
             levelpad: 0
           }
-        }
+        }.freeze
 
         TEXT_REGEXP = /([{}()\[\]])?(["']?)(\S+?)(["']?=)/.freeze
         JSON_REGEXP = /\"([^,]+?)\"(?=:)/.freeze
@@ -65,14 +65,24 @@ module TTY
           json: [JSON_REGEXP, ->(c) { "\"" + c.("\\1") + "\"" }]
         }.freeze
 
+        # The output stream
+        # @api private
         attr_reader :output
 
+        # The configuration options
+        # @api private
         attr_reader :config
 
+        # The logging level
+        # @api private
         attr_reader :level
 
+        # The format for the message
+        # @api private
+        attr_reader :message_format
+
         def initialize(output: $stderr, formatter: nil, config: nil, level: nil,
-                       styles: {})
+                       styles: {}, message_format: "%-25s")
           @output = Array[output].flatten
           @formatter = coerce_formatter(formatter || config.formatter).new
           @formatter_name = @formatter.class.name.split("::").last.downcase
@@ -82,6 +92,7 @@ module TTY
           @level = level || @config.level
           @mutex = Mutex.new
           @pastel = Pastel.new
+          @message_format = message_format
         end
 
         # Handle log event output in format
@@ -118,7 +129,7 @@ module TTY
             fmt << color.(style[:symbol])
             fmt << color.(style[:label]) + (" " * style[:levelpad])
           end
-          fmt << "%-25s" % event.message.join(" ")
+          fmt << message_format % event.message.join(" ")
           unless event.fields.empty?
             pattern, replacement = *@color_pattern
             fmt << @formatter.dump(event.fields, max_bytes: config.max_bytes,
@@ -150,11 +161,11 @@ module TTY
         #
         # @api private
         def configure_styles(event)
-          return {}  if event.metadata[:name].nil?
+          return {} if event.metadata[:name].nil?
 
           STYLES.fetch(event.metadata[:name].to_sym, {})
-            .dup
-            .merge!(@styles[event.metadata[:name].to_sym] || {})
+                .dup
+                .merge!(@styles[event.metadata[:name].to_sym] || {})
         end
 
         def configure_color(style)

data/lib/tty/logger/levels.rb

@@ -15,7 +15,7 @@ module TTY
         warn: WARN_LEVEL,
         error: ERROR_LEVEL,
         fatal: FATAL_LEVEL
-      }
+      }.freeze
 
       # All the default level names
       #
@@ -60,6 +60,7 @@ module TTY
         right = right.is_a?(Integer) ? right : level_to_number(right)
 
         return :eq if left == right
+
         left < right ? :lt : :gt
       end
     end # Levels

data/lib/tty/logger/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Logger
-    VERSION = "0.4.0"
-  end
-end
+    VERSION = "0.5.0"
+  end # Logger
+end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-logger
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel