tty-logger 0.2.0 → 0.3.0

data/lib/tty/logger/version.rb

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

data/tty-logger.gemspec

@@ -19,13 +19,11 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/piotrmurach/tty-logger"
 
-  spec.files         = Dir['{lib,spec,examples}/**/*.rb']
-  spec.files        += Dir['tasks/*', 'tty-logger.gemspec']
-  spec.files        += Dir['README.md', 'CHANGELOG.md', 'LICENSE.txt', 'Rakefile']
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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.required_ruby_version = ">= 2.0.0"
 
   spec.add_dependency "pastel", "~> 0.7.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-logger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-30 00:00:00.000000000 Z
+date: 2020-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -76,19 +76,10 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- examples/child.rb
-- examples/console.rb
-- examples/custom_type.rb
-- examples/error.rb
-- examples/handler.rb
-- examples/log.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
@@ -98,31 +89,6 @@ files:
 - lib/tty/logger/handlers/stream.rb
 - lib/tty/logger/levels.rb
 - lib/tty/logger/version.rb
-- spec/perf/json_formatter_spec.rb
-- spec/perf/log_spec.rb
-- spec/perf/text_formatter_spec.rb
-- spec/spec_helper.rb
-- spec/unit/add_handler_spec.rb
-- spec/unit/config_spec.rb
-- spec/unit/copy_spec.rb
-- spec/unit/event_spec.rb
-- spec/unit/exception_spec.rb
-- spec/unit/filter_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_at_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
 licenses:
@@ -149,7 +115,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

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-desc 'Run all specs'
-task ci: %w[ spec ]
-
-task default: :spec

data/examples/child.rb

@@ -1,9 +0,0 @@
-require_relative "../lib/tty/logger"
-
-logger = TTY::Logger.new(fields: {app: "parent", env: "prod"})
-child_logger = logger.copy(app: "child") do |config|
-  config.filters = ["logging"]
-end
-
-logger.info("Parent logging")
-child_logger.warn("Child logging")

data/examples/console.rb

@@ -1,22 +0,0 @@
-require_relative "../lib/tty/logger"
-
-TTY::Logger.configure do |config|
-  # config.max_bytes = 2**5
-  # config.metadata = [:all]
-  # config.handlers = [[:console, formatter: :text]]
-  config.level = :debug
-end
-
-logger = TTY::Logger.new(fields: {app: "myapp", env: "prod"})
-
-logger.copy(path: "/var/www/example.com").info("Deploying", "code")
-
-puts "Levels:"
-
-logger.debug("Debugging deployment")
-logger.info("Info about the deploy")
-logger.warn("Lack of resources")
-logger.error("Failed to deploy")
-logger.fatal("Terribly failed to deploy")
-logger.success("Deployed successfully")
-logger.wait("Ready to deploy")

data/examples/custom_type.rb

@@ -1,27 +0,0 @@
-require_relative "../lib/tty/logger"
-
-logger = TTY::Logger.new do |config|
-  config.types = {thanks: {level: :info}, done: {level: :info}}
-  config.handlers = [
-    [:console, {
-      styles: {
-        thanks: {
-          symbol: "❤️ ",
-          label: "thanks",
-          color: :magenta,
-          levelpad: 0
-        },
-        done: {
-          symbol: "!!",
-          label: "done",
-          color: :green,
-          levelpad: 2
-        }
-      }
-    }]
-  ]
-end
-
-logger.info("This is info!")
-logger.thanks("Great work!")
-logger.done("Work done!")

data/examples/error.rb

@@ -1,11 +0,0 @@
-require_relative "../lib/tty/logger"
-
-logger = TTY::Logger.new(fields: {app: "myapp", env: "prod"}) do |config|
-end
-
-begin
-  raise ArgumentError, "Wrong data"
-rescue => ex
-  error = ex
-  logger.fatal("Error:", error)
-end

data/examples/handler.rb

@@ -1,19 +0,0 @@
-require_relative "../lib/tty/logger"
-
-class MyHandler
-  def initialize(options = {})
-    @name = options[:name]
-  end
-
-  def call(event)
-    puts "(#{@name}) #{event.metadata[:name]} #{event.message}"
-  end
-end
-
-TTY::Logger.configure do |config|
-  config.handlers = [[MyHandler, {name: :hello}]]
-end
-
-logger = TTY::Logger.new
-
-logger.info("Custom logging")

data/examples/log.rb

@@ -1,9 +0,0 @@
-require_relative "../lib/tty/logger"
-
-logger = TTY::Logger.new do |config|
-  config.level = :debug
-end
-
-def success
-  logger.log(:debug, "Deploying...")
-end

data/examples/output.rb

@@ -1,15 +0,0 @@
-require_relative "../lib/tty/logger"
-
-file = File.open("errors.log", "a")
-
-TTY::Logger.configure do |config|
-  config.metadata = [:all]
-  config.handlers = [:stream]
-  config.output = file
-end
-
-logger = TTY::Logger.new(fields: {app: "myapp", env: "prod"})
-
-logger.error("Failed to deploy")
-
-file.close

data/examples/override.rb

@@ -1,29 +0,0 @@
-require_relative "../lib/tty/logger"
-
-logger = TTY::Logger.new
-
-logger.success("Default success")
-logger.error("Default error")
-
-puts
-
-new_style = TTY::Logger.new do |config|
-  config.handlers = [
-    [:console, {
-      styles: {
-        success: {
-          symbol: "+",
-          label: "Ohh yes"
-        },
-        error: {
-          symbol: "!",
-          label: "Dooh",
-          levelpad: 3
-        }
-      }
-    }]
-  ]
-end
-
-new_style.success("Custom success")
-new_style.error("Custom error")

data/examples/stream.rb

@@ -1,22 +0,0 @@
-require_relative "../lib/tty/logger"
-
-TTY::Logger.configure do |config|
-  config.max_bytes = 2**7
-  config.metadata = [:all]
-  config.handlers = [[:stream, formatter: :text]]
-  config.level = :debug
-end
-
-logger = TTY::Logger.new(fields: {app: "myapp", env: "prod"})
-
-logger.copy(path: "/var/www/example.com").info("Deploying", "code")
-
-puts "Levels:"
-
-logger.debug("Debugging deployment")
-logger.info("Info about the deploy")
-logger.warn("Lack of resources")
-logger.error("Failed to deploy")
-logger.fatal("Terribly failed to deploy")
-logger.success("Deployed successfully")
-logger.wait("Ready to deploy")

data/spec/perf/json_formatter_spec.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "rspec-benchmark"
-
-RSpec.describe TTY::Logger::Formatters::JSON do
-  include RSpec::Benchmark::Matchers
-
-  it "formats large hashes(2048 keys) 2x slower than the native JSON" do
-    large_data = Hash[Array.new(2048) { |i| [i + 1, "hey"] }]
-    formatter = described_class.new
-
-    expect {
-      formatter.dump(large_data)
-    }.to perform_slower_than {
-      ::JSON.dump(large_data)
-    }.at_least(2).times
-  end
-
-  it "formats large values 2x slower than the native JSON" do
-    large_data = { "foo" => "b#{'a'*2048}" }
-    formatter = described_class.new
-
-    expect {
-      formatter.dump(large_data)
-    }.to perform_slower_than {
-      ::JSON.dump(large_data)
-    }.at_least(2).times
-  end
-end

data/spec/perf/log_spec.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require "rspec-benchmark"
-require "logger"
-
-RSpec.describe TTY::Logger do
-  include RSpec::Benchmark::Matchers
-
-  let(:output) { StringIO.new }
-
-  it "performs 3x slower than native logger" do
-    native_logger = Logger.new(output)
-    logger = described_class.new(output: output)
-
-    expect {
-      logger.info("Deployment done!")
-    }.to perform_slower_than {
-      native_logger.info("Deployment done!")
-    }.at_least(3).times
-  end
-end

data/spec/perf/text_formatter_spec.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "rspec-benchmark"
-
-RSpec.describe TTY::Logger::Formatters::Text do
-  include RSpec::Benchmark::Matchers
-
-  it "formats large hashes(2048 keys) 1.25x slower than the native JSON" do
-    large_data = Hash[Array.new(2048) { |i| [i + 1, "hey"] }]
-    formatter = described_class.new
-
-    expect {
-      formatter.dump(large_data)
-    }.to perform_slower_than {
-      ::JSON.dump(large_data)
-    }.at_least(1.25).times
-  end
-
-  it "formats large values 4x slower than the native JSON" do
-    large_data = { "foo" => "b#{'a'*2048}" }
-    formatter = described_class.new
-
-    expect {
-      formatter.dump(large_data)
-    }.to perform_slower_than {
-      ::JSON.dump(large_data)
-    }.at_least(4).times
-  end
-end

data/spec/spec_helper.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-if ENV['COVERAGE'] || ENV['TRAVIS']
-  require 'simplecov'
-  require 'coveralls'
-
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ])
-
-  SimpleCov.start do
-    command_name 'spec'
-    add_filter 'spec'
-  end
-end
-
-require "bundler/setup"
-require "tty-logger"
-
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end

data/spec/unit/add_handler_spec.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Logger, "#add_handler" do
-  let(:output) { StringIO.new }
-  let(:styles) { TTY::Logger::Handlers::Console::STYLES }
-
-  it "dynamically adds and removes a handler object" do
-    logger = TTY::Logger.new(output: output) do |config|
-      config.handlers = []
-    end
-
-    logger.info("No handler")
-
-    logger.add_handler :console
-
-    logger.info("Console handler")
-
-    logger.remove_handler :console
-
-    expect(output.string).to eq([
-      "\e[32m#{styles[:info][:symbol]}\e[0m ",
-      "\e[32minfo\e[0m    ",
-      "Console handler          \n"].join)
-  end
-end

data/spec/unit/config_spec.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Logger::Config do
-  let(:output) { StringIO.new }
-  let(:styles) { TTY::Logger::Handlers::Console::STYLES }
-
-  it "defaults :max_bytes to 8192" do
-    config = described_class.new
-    expect(config.max_bytes).to eq(8192)
-  end
-
-  it "defaults :max_depth to 3" do
-    config = described_class.new
-    expect(config.max_depth).to eq(3)
-  end
-
-  it "defaults :level to :info" do
-    config = described_class.new
-    expect(config.level).to eq(:info)
-  end
-
-  it "sets :max_bytes" do
-    config = described_class.new
-    config.max_bytes = 2**8
-    expect(config.max_bytes).to eq(256)
-  end
-
-  it "defaults metadata to empty array" do
-    config = described_class.new
-    expect(config.metadata).to eq([])
-  end
-
-  it "defaults handlers to console" do
-    config = described_class.new
-    expect(config.handlers).to eq([:console])
-  end
-
-  it "defaults formatter to text" do
-    config = described_class.new
-    expect(config.formatter).to eq(:text)
-  end
-
-  it "defaults date format to %F" do
-    config = described_class.new
-    expect(config.date_format).to eq("%F")
-  end
-
-  it "defaults output to stderr" do
-    config = described_class.new
-    expect(config.output).to eq($stderr)
-  end
-
-  it "serializes data into hash" do
-    config = described_class.new
-    expect(config.to_h).to eq({
-      date_format: "%F",
-      formatter: :text,
-      filters: {},
-      handlers: [:console],
-      level: :info,
-      max_bytes: 8192,
-      max_depth: 3,
-      metadata: [],
-      output: $stderr,
-      time_format: "%T.%3N",
-      types: {}
-    })
-  end
-
-  it "yields configuration instance" do
-    config = double(:config)
-    allow(TTY::Logger).to receive(:config).and_return(config)
-    expect { |block|
-      TTY::Logger.configure(&block)
-    }.to yield_with_args(config)
-  end
-
-  it "configures output size" do
-    logger = TTY::Logger.new(output: output) do |config|
-      config.max_bytes = 2**4
-      config.level = :debug
-    end
-
-    logger.debug("Deploying", app: "myapp", env: "prod")
-
-    expect(output.string).to eq([
-      "\e[36m#{styles[:debug][:symbol]}\e[0m ",
-      "\e[36mdebug\e[0m   ",
-      "Deploying                 ",
-      "\e[36mapp\e[0m=myapp ...\n"
-    ].join)
-  end
-
-  it "configures maximum depth of structured data" do
-    logger = TTY::Logger.new(output: output) do |config|
-      config.max_depth = 1
-      config.level = :debug
-    end
-
-    logger.debug("Deploying", app: "myapp", env: { name: "prod" })
-
-    expect(output.string).to eq([
-      "\e[36m#{styles[:debug][:symbol]}\e[0m ",
-      "\e[36mdebug\e[0m   ",
-      "Deploying                 ",
-      "\e[36mapp\e[0m=myapp \e[36menv\e[0m={...}\n"
-    ].join)
-  end
-end