tty-logger 0.1.0 → 0.6.0

data/lib/tty/logger/data_filter.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module TTY
+  class Logger
+    class DataFilter
+      FILTERED = "[FILTERED]"
+      DOT = "."
+
+      attr_reader :filters, :compiled_filters, :mask
+
+      # Create a data filter instance with filters.
+      #
+      # @example
+      #  TTY::Logger::DataFilter.new(%w[foo], mask: "<SECRET>")
+      #
+      # @param [String] mask
+      #   the mask to replace object with. Defaults to `"[FILTERED]"`
+      #
+      # @api private
+      def initialize(filters = [], mask: nil)
+        @mask = mask || FILTERED
+        @filters = filters
+        @compiled_filters = compile(filters)
+      end
+
+      # Filter object for keys matching provided filters.
+      #
+      # @example
+      #   data_filter = TTY::Logger::DataFilter.new(%w[foo])
+      #   data_filter.filter({"foo" => "bar"})
+      #   # => {"foo" => "[FILTERED]"}
+      #
+      # @param [Object] obj
+      #   the object to filter
+      #
+      # @api public
+      def filter(obj)
+        return obj if filters.empty?
+
+        obj.each_with_object({}) do |(k, v), acc|
+          acc[k] = filter_val(k, v)
+        end
+      end
+
+      private
+
+      def compile(filters)
+        compiled = {
+          regexps: [],
+          nested_regexps: [],
+          blocks: []
+        }
+        strings = []
+        nested_strings = []
+
+        filters.each do |filter|
+          case filter
+          when Proc
+            compiled[:blocks] << filter
+          when Regexp
+            if filter.to_s.include?(DOT)
+              compiled[:nested_regexps] << filter
+            else
+              compiled[:regexps] << filter
+            end
+          else
+            exp = Regexp.escape(filter)
+            if exp.include?(DOT)
+              nested_strings << exp
+            else
+              strings << exp
+            end
+          end
+        end
+
+        if !strings.empty?
+          compiled[:regexps] << /^(#{strings.join("|")})$/
+        end
+
+        if !nested_strings.empty?
+          compiled[:nested_regexps] << /^(#{nested_strings.join("|")})$/
+        end
+
+        compiled
+      end
+
+      def filter_val(key, val, composite = [])
+        return mask if filtered?(key, composite)
+
+        case val
+        when Hash then filter_obj(key, val, composite << key)
+        when Array then filter_arr(key, val, composite)
+        else val
+        end
+      end
+
+      def filtered?(key, composite)
+        composite_key = composite + [key]
+        joined_key = composite_key.join(DOT)
+        @compiled_filters[:regexps].any? { |reg| !!reg.match(key.to_s) } ||
+          @compiled_filters[:nested_regexps].any? { |reg| !!reg.match(joined_key) } ||
+          @compiled_filters[:blocks].any? { |block| block.(composite_key.dup) }
+      end
+
+      def filter_obj(_key, obj, composite)
+        obj.each_with_object({}) do |(k, v), acc|
+          acc[k] = filter_val(k, v, composite)
+        end
+      end
+
+      def filter_arr(key, obj, composite)
+        obj.reduce([]) do |acc, v|
+          acc << filter_val(key, v, composite)
+        end
+      end
+    end # DataFilter
+  end # Logger
+end # TTY

data/lib/tty/logger/event.rb

@@ -11,7 +11,7 @@ module TTY
 
       attr_reader :backtrace
 
-      def initialize(message, fields, metadata)
+      def initialize(message, fields = {}, metadata = {})
         @message = message
         @fields = fields
         @metadata = metadata
@@ -29,7 +29,7 @@ module TTY
         @message.each do |msg|
           case msg
           when Exception
-            @backtrace = msg.backtrace
+            @backtrace = msg.backtrace if msg.backtrace
           else
             msg
           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/base.rb

@@ -4,6 +4,19 @@ module TTY
   class Logger
     module Handlers
       module Base
+        # Change current log level for the duration of the block
+        #
+        # @param [String] tmp_level
+        #   the temporary log level
+        #
+        # @api public
+        def log_at(tmp_level)
+          old_level, @level = level, tmp_level
+          yield
+        ensure
+          @level = old_level
+        end
+
         # Coerce formatter name into constant
         #
         # @api private

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

@@ -55,23 +55,44 @@ module TTY
             color: :cyan,
             levelpad: 0
           }
-        }
+        }.freeze
 
+        TEXT_REGEXP = /([{}()\[\]])?(["']?)(\S+?)(["']?=)/.freeze
+        JSON_REGEXP = /\"([^,]+?)\"(?=:)/.freeze
+
+        COLOR_PATTERNS = {
+          text: [TEXT_REGEXP, ->(c) { "\\1\\2" + c.("\\3") + "\\4" }],
+          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: {}, enable_color: nil, message_format: "%-25s")
           @output = Array[output].flatten
           @formatter = coerce_formatter(formatter || config.formatter).new
+          @formatter_name = @formatter.class.name.split("::").last.downcase
+          @color_pattern = COLOR_PATTERNS[@formatter_name.to_sym]
           @config = config
           @styles = styles
           @level = level || @config.level
           @mutex = Mutex.new
-          @pastel = Pastel.new
+          @pastel = Pastel.new(enabled: enable_color)
+          @message_format = message_format
         end
 
         # Handle log event output in format
@@ -104,14 +125,16 @@ module TTY
             end
           end
           fmt << ARROW unless config.metadata.empty?
-          fmt << color.(style[:symbol])
-          fmt << color.(style[:label]) + (" " * style[:levelpad])
-          fmt << "%-25s" % event.message.join(" ")
+          unless style.empty?
+            fmt << color.(style[:symbol])
+            fmt << color.(style[:label]) + (" " * style[:levelpad])
+          end
+          fmt << message_format % event.message.join(" ")
           unless event.fields.empty?
+            pattern, replacement = *@color_pattern
             fmt << @formatter.dump(event.fields, max_bytes: config.max_bytes,
-                                   max_depth: config.max_depth).
-                                   gsub(/(\S+)(?=\=)/, color.("\\1")).
-                                   gsub(/\"([^,]+?)\"(?=:)/, "\"" + color.("\\1") + "\"")
+                                                 max_depth: config.max_depth)
+                             .gsub(pattern, replacement.(color))
           end
           unless event.backtrace.empty?
             fmt << "\n" + format_backtrace(event)
@@ -138,11 +161,11 @@ module TTY
         #
         # @api private
         def configure_styles(event)
-          style = STYLES[event.metadata[:name].to_sym].dup
-          (@styles[event.metadata[:name].to_sym] || {}).each do |k, v|
-            style[k] = v
-          end
-          style
+          return {} if event.metadata[:name].nil?
+
+          STYLES.fetch(event.metadata[:name].to_sym, {})
+                .dup
+                .merge!(@styles[event.metadata[:name].to_sym] || {})
         end
 
         def configure_color(style)

data/lib/tty/logger/levels.rb

@@ -10,41 +10,57 @@ module TTY
       FATAL_LEVEL = 4
 
       LEVEL_NAMES = {
-        DEBUG_LEVEL => :debug,
-        INFO_LEVEL => :info,
-        WARN_LEVEL => :warn,
-        ERROR_LEVEL => :error,
-        FATAL_LEVEL => :fatal
-      }
+        debug: DEBUG_LEVEL,
+        info: INFO_LEVEL,
+        warn: WARN_LEVEL,
+        error: ERROR_LEVEL,
+        fatal: FATAL_LEVEL
+      }.freeze
 
+      # All the default level names
+      #
+      # @return [Array[Symbol]]
+      #
+      # @api private
       def level_names
-        [:debug, :info, :warn, :error, :fatal]
+        LEVEL_NAMES.keys
       end
 
+      # Convert level name to level number
+      #
+      # @param [Symbol] level
+      #
+      # @return [Integer]
+      #
       # @api private
       def level_to_number(level)
-        case level.to_s.downcase
-        when "debug" then DEBUG_LEVEL
-        when "info"  then INFO_LEVEL
-        when "warn"  then WARN_LEVEL
-        when "error" then ERROR_LEVEL
-        when "fatal" then FATAL_LEVEL
-        else
-          raise ArgumentError, "Invalid level #{level.inspect}"
-        end
+        LEVEL_NAMES[level.to_s.downcase.to_sym] ||
+          raise(ArgumentError, "Invalid level #{level.inspect}")
       end
 
+      # Convert level number to level name
+      #
+      # @param [Integer] number
+      #
+      # @return [Symbol]
+      #
       # @api private
-      def number_to_level(level)
-        LEVEL_NAMES[level]
+      def number_to_level(number)
+        LEVEL_NAMES.key(number)
       end
 
+      # Compares two levels by name or number
+      #
+      # @return [Symbol]
+      #   either :lt, :gt or :eq
+      #
       # @api private
       def compare_levels(left, right)
         left = left.is_a?(Integer) ? left : level_to_number(left)
         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.1.0"
-  end
-end
+    VERSION = "0.6.0"
+  end # Logger
+end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-21 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,36 +42,33 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Readable, structured and beautiful terminal logging
 email:
-- me@piotrmurach.com
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- examples/console.rb
-- examples/error.rb
-- examples/handler.rb
-- examples/output.rb
-- examples/override.rb
-- examples/stream.rb
 - lib/tty-logger.rb
 - lib/tty/logger.rb
 - lib/tty/logger/config.rb
+- lib/tty/logger/data_filter.rb
 - lib/tty/logger/event.rb
 - lib/tty/logger/formatters/json.rb
 - lib/tty/logger/formatters/text.rb
@@ -95,27 +78,7 @@ files:
 - lib/tty/logger/handlers/stream.rb
 - lib/tty/logger/levels.rb
 - lib/tty/logger/version.rb
-- spec/spec_helper.rb
-- spec/unit/add_handler_spec.rb
-- spec/unit/config_spec.rb
-- spec/unit/event_spec.rb
-- spec/unit/exception_spec.rb
-- spec/unit/formatter_spec.rb
-- spec/unit/formatters/json_spec.rb
-- spec/unit/formatters/text_spec.rb
-- spec/unit/handler_spec.rb
-- spec/unit/handlers/custom_spec.rb
-- spec/unit/handlers/null_spec.rb
-- spec/unit/handlers/stream_spec.rb
-- spec/unit/levels_spec.rb
-- spec/unit/log_metadata_spec.rb
-- spec/unit/log_spec.rb
-- spec/unit/output_spec.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-logger.gemspec
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
 metadata:
@@ -123,7 +86,7 @@ metadata:
   bug_tracker_uri: https://github.com/piotrmurach/tty-logger/issues
   changelog_uri: https://github.com/piotrmurach/tty-logger/blob/master/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/tty-logger
-  homepage_uri: https://piotrmurach.github.io/tty
+  homepage_uri: https://ttytoolkit.org
   source_code_uri: https://github.com/piotrmurach/tty-logger
 post_install_message: 
 rdoc_options: []
@@ -140,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Readable, structured and beautiful terminal logging