tty-logger 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af3524110f6873609fc2086063371a728bd63d08d9f9160c8469cef4e5e50d94
-  data.tar.gz: 4991ed5e387b34fbe8c2e1887ba36ce53e5bc3bc120f957eda6a778202abcf35
+  metadata.gz: 1e4b31874b5d1ca9d091b11c0a5d6ca04c3b44a41f1d92c1f9d9b40fe2573c5c
+  data.tar.gz: 7f078cf57986ea70885db59ecab0bbd1da6afa93c272ea764208d3c88251b4f9
 SHA512:
-  metadata.gz: 66c6892da31f674bcdee76a92334976f19f4447e341cf61c5fce106d5ad7085035d5a580c80f614bc564f4f6567ae6a446aacfe17d7499fb7c65fd4e800d0003
-  data.tar.gz: 45ee01d044d21a79a85fe55933ef3da2c3aefd58cea31453d61f7007768687e9256447e214de0f90973dc4de136f35eba735e9619c0c17aa9d74b05a32d84090
+  metadata.gz: 1c255546632ba09a0aeac9b5e0395dd668576eb30a882342c18b9cf6a5fa525b0c6143e17a6bae3406fdbcb0306c17916c1a5016c62f2e5df816b5b70afeb040
+  data.tar.gz: ca12ab5f19b1037d50cc818a940b4e909521ebe7d4338fc552cb0901600eb61d713213f04d576713bfa146e971d050af9599d48d2eecea87013109aa190a39f8

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change log
 
+## [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)))
+
+### Changed
+* Change gemspec to update pastel version and restrict only to minor version
+
+### Fixed
+* Fix to filter sensitive information from exceptions
+
 ## [v0.3.0] - 2020-01-01
 
 ### Added
@@ -27,6 +40,7 @@
 
 * Initial implementation and release
 
+[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
 [v0.1.0]: https://github.com/piotrmurach/tty-logger/compare/v0.1.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://cdn.rawgit.com/piotrmurach/tty/master/images/tty.png" alt="tty logo" /></a>
+  <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>
 </div>
 
 # TTY::Logger [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
@@ -75,6 +75,8 @@ Or install it yourself as:
     * [2.6.4 Multiple Handlers](#264-multiple-handlers)
   * [2.7 Formatters](#27-formatters)
   * [2.8 Output streams](#28-output-streams)
+* [3. Community Extensions](#3-community-extensions)
+  * [3.1 Sentry Handler](#31-sentry-handler)
 
 ## 1. Usage
 
@@ -334,7 +336,7 @@ logger.wait { ["Ready to deploy", {app: "myapp", env: "prod"}] }
 
 ### 2.4 Configuration
 
-All the configuration options can be changed globally via `configure` or per logger instance via object initialization.
+All the configuration options can be changed globally via `configure` or per logger instance.
 
 * `:filters` - the storage of placeholders to filter sensitive data out from the logs. Defaults to `{}`.
 * `:formatter` - the formatter used to display structured data. Defaults to `:text`. See [Formatters](#27-formatters) for more details.
@@ -364,6 +366,14 @@ logger = TTY::Logger.new do |config|
 end
 ```
 
+You can also change the logger's configuration at runtime:
+
+```ruby
+logger.configure do |config|
+  config.level = :debug
+end
+```
+
 ### 2.4.1 Metadata
 
 The `:metdata` configuration option can include the following symbols:
@@ -735,6 +745,7 @@ TTY::Logger.new do |config|
   config.handlers = [:console, [:console, formatter: :json]]
 end
 ```
+
 ### 2.8 Output Streams
 
 By default all log events are output to `stderr`. You can change this using configuration `output` option. Any `IO`-like stream such as file, socket or console can be used. For example, to log all messages to a file do:
@@ -764,6 +775,12 @@ logger = TTY::Logger.new do |config|
 end
 ```
 
+## 3. Community Extensions
+
+### 3.1 Sentry Handler
+
+[tty-logger-raven](https://github.com/ianks/tty-logger-raven) provides an extension for Sentry.io.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/tty/logger.rb

@@ -69,6 +69,13 @@ module TTY
       yield config
     end
 
+    # Instance logger configuration
+    #
+    # @api public
+    def configure
+      yield @config
+    end
+
     # Create a logger instance
     #
     # @example
@@ -204,6 +211,24 @@ module TTY
       compare_levels(level, other_level) != :gt
     end
 
+    # Logs streaming output.
+    #
+    # @example
+    #   logger << "Example output"
+    #
+    # @api public
+    def write(*msg)
+      event = Event.new(filter(*msg))
+
+      @ready_handlers.each do |handler|
+        handler.(event)
+      end
+
+      self
+    end
+
+    alias_method :<<, :write
+
     # Log a message given the severtiy level
     #
     # @example
@@ -229,7 +254,7 @@ module TTY
         level: current_level,
         time: Time.now,
         pid: Process.pid,
-        name: /<top\s+\(required\)>|<main>/ =~ label ? current_level : label,
+        name: /<top\s+\(required\)>|<main>|<</ =~ label ? current_level : label,
         path: loc.path,
         lineno: loc.lineno,
         method: loc.base_label
@@ -265,21 +290,50 @@ module TTY
     # Filter message parts for any sensitive information and
     # replace with placeholder.
     #
-    # @param [Array[String]] messages
+    # @param [Array[Object]] objects
     #   the messages to filter
     #
     # @return [Array[String]]
     #   the filtered message
     #
     # @api private
-    def filter(*messages)
-      messages.reduce([]) do |acc, msg|
-        acc << msg.dup.tap do |msg_copy|
-          @config.filters.message.each do |text|
-            msg_copy.gsub!(text, @config.filters.mask)
-          end
+    def filter(*objects)
+      objects.map do |obj|
+        case obj
+        when Exception
+          backtrace = Array(obj.backtrace).map { |line| swap_filtered(line) }
+          copy_error(obj, swap_filtered(obj.message), backtrace)
+        else
+          swap_filtered(obj.to_s)
+        end
+      end
+    end
+
+    # Create a new error instance copy
+    #
+    # @param [Exception] error
+    # @param [String] message
+    # @param [Array,nil] backtrace
+    #
+    # @return [Exception]
+    #
+    # @api private
+    def copy_error(error, message, backtrace = nil)
+      new_error = error.exception(message)
+      new_error.set_backtrace(backtrace)
+      new_error
+    end
+
+    # Swap string content for filtered content
+    #
+    # @param [String] obj
+    #
+    # @api private
+    def swap_filtered(obj)
+      obj.dup.tap do |obj_copy|
+        @config.filters.message.each do |text|
+          obj_copy.gsub!(text, @config.filters.mask)
         end
-        acc
       end
     end
   end # Logger

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/handlers/console.rb

@@ -114,8 +114,10 @@ module TTY
             end
           end
           fmt << ARROW unless config.metadata.empty?
-          fmt << color.(style[:symbol])
-          fmt << color.(style[:label]) + (" " * style[:levelpad])
+          unless style.empty?
+            fmt << color.(style[:symbol])
+            fmt << color.(style[:label]) + (" " * style[:levelpad])
+          end
           fmt << "%-25s" % event.message.join(" ")
           unless event.fields.empty?
             pattern, replacement = *@color_pattern
@@ -148,11 +150,11 @@ module TTY
         #
         # @api private
         def configure_styles(event)
-          style = STYLES.fetch(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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-logger
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2020-07-29 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,22 +42,25 @@ 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
@@ -89,8 +78,7 @@ files:
 - lib/tty/logger/handlers/stream.rb
 - lib/tty/logger/levels.rb
 - lib/tty/logger/version.rb
-- tty-logger.gemspec
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
 metadata:
@@ -98,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: []

data/tty-logger.gemspec

@@ -1,36 +0,0 @@
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "tty/logger/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "tty-logger"
-  spec.version       = TTY::Logger::VERSION
-  spec.authors       = ["Piotr Murach"]
-  spec.email         = ["me@piotrmurach.com"]
-  spec.summary       = %q{Readable, structured and beautiful terminal logging}
-  spec.description   = %q{Readable, structured and beautiful terminal logging}
-  spec.homepage      = "https://piotrmurach.github.io/tty"
-  spec.license       = "MIT"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  spec.metadata["bug_tracker_uri"] = "https://github.com/piotrmurach/tty-logger/issues"
-  spec.metadata["changelog_uri"] = "https://github.com/piotrmurach/tty-logger/blob/master/CHANGELOG.md"
-  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/tty-logger"
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/piotrmurach/tty-logger"
-
-  spec.files         = Dir["lib/**/*.rb", "tty-logger.gemspec"]
-  spec.files        += Dir["README.md", "CHANGELOG.md", "LICENSE.txt"]
-  spec.executables   = []
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.0.0"
-
-  spec.add_dependency "pastel", "~> 0.7.0"
-
-  spec.add_development_dependency "bundler", ">= 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  if RUBY_VERSION.split(".")[1].to_i > 0
-    #spec.add_development_dependency "rspec-benchmark", "~> 0.5"
-  end
-end