tty-logger 0.1.0 → 0.2.0

data/lib/tty/logger/version.rb

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

data/spec/perf/json_formatter_spec.rb

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,29 @@
+# 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/unit/config_spec.rb

@@ -55,13 +55,15 @@ RSpec.describe TTY::Logger::Config do
     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"
+      time_format: "%T.%3N",
+      types: {}
     })
   end
 

data/spec/unit/copy_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::Logger, "#copy" do
+  let(:output) { StringIO.new }
+  let(:styles) { TTY::Logger::Handlers::Console::STYLES }
+
+  it "copies ouptut, fields and configuration over to child logger" do
+    logger = TTY::Logger.new(output: output, 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")
+
+    expect(output.string).to eq([
+      "\e[32m#{styles[:info][:symbol]}\e[0m ",
+      "\e[32minfo\e[0m    ",
+      "Parent logging            ",
+      "\e[32mapp\e[0m=parent \e[32menv\e[0m=prod\n",
+      "\e[33m#{styles[:warn][:symbol]}\e[0m ",
+      "\e[33mwarning\e[0m ",
+      "Child [FILTERED]          ",
+      "\e[33mapp\e[0m=child \e[33menv\e[0m=prod\n"
+    ].join)
+  end
+end

data/spec/unit/filter_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::Logger, "filters" do
+  let(:output) { StringIO.new }
+  let(:styles) { TTY::Logger::Handlers::Console::STYLES }
+
+  it "filters a sensitive data from a message" do
+    logger = TTY::Logger.new(output: output) do |config|
+      config.filters = ["secret", "password"]
+    end
+
+    logger.info("Super secret info with password")
+
+    expect(output.string).to eq([
+      "\e[32m#{styles[:info][:symbol]}\e[0m ",
+      "\e[32minfo\e[0m    ",
+      "Super [FILTERED] info with [FILTERED]\n"].join)
+  end
+
+  it "filters a sensitive data from a message with custom placeholder" do
+    logger = TTY::Logger.new(output: output) do |config|
+      config.filters = { "secret" => "<SECRET>" }
+    end
+
+    logger.info("Super secret info")
+
+    expect(output.string).to eq([
+      "\e[32m#{styles[:info][:symbol]}\e[0m ",
+      "\e[32minfo\e[0m    ",
+      "Super <SECRET> info      \n"].join)
+  end
+end

data/spec/unit/log_at_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::Logger, "#log_at" do
+  let(:output) { StringIO.new }
+
+  it "logs temporarily at noisy level" do
+    logger = TTY::Logger.new(output: output) do |config|
+      config.handlers = [:stream]
+    end
+
+    logger.debug("not logged")
+
+    logger.log_at :debug do
+      logger.debug("logged")
+    end
+
+    logger.debug("not logged")
+
+    expect(output.string).to eq("level=debug message=logged\n")
+  end
+
+  it "logs temporarily at quiet level" do
+    logger = TTY::Logger.new(output: output) do |config|
+      config.handlers = [:stream]
+    end
+
+    logger.log_at TTY::Logger::ERROR_LEVEL do
+      logger.debug("not logged")
+      logger.error("logged")
+    end
+
+    expect(output.string).to eq("level=error message=logged\n")
+  end
+end

data/spec/unit/log_spec.rb

@@ -4,6 +4,20 @@ RSpec.describe TTY::Logger, "#log" do
   let(:output) { StringIO.new }
   let(:styles) { TTY::Logger::Handlers::Console::STYLES }
 
+  it "logs without a method name directly using level" do
+    logger = TTY::Logger.new(output: output) do |config|
+      config.level = :debug
+    end
+
+    logger.log(:debug, "Deploying...")
+
+    expect(output.string).to eq([
+      "\e[36m#{styles[:debug][:symbol]}\e[0m ",
+      "\e[36mdebug\e[0m   ",
+      "Deploying...             \n"
+    ].join)
+  end
+
   it "logs a message at debug level" do
     logger = TTY::Logger.new(output: output) do |config|
       config.level = :debug
@@ -84,9 +98,7 @@ RSpec.describe TTY::Logger, "#log" do
   end
 
   it "logs a message in a block" do
-    logger = TTY::Logger.new(output: output) do |config|
-      config.level = :debug
-    end
+    logger = TTY::Logger.new(output: output)
 
     logger.info { "Successfully deployed" }
 
@@ -96,6 +108,30 @@ RSpec.describe TTY::Logger, "#log" do
       "Successfully deployed    \n"].join)
   end
 
+  it "logs a message in a block as an array of elements" do
+    logger = TTY::Logger.new(output: output)
+
+    logger.info { ["Successfully", "deployed"] }
+
+    expect(output.string).to eq([
+      "\e[32m#{styles[:info][:symbol]}\e[0m ",
+      "\e[32minfo\e[0m    ",
+      "Successfully deployed    \n"].join)
+  end
+
+  it "logs a message in a block with metadata" do
+    logger = TTY::Logger.new(output: output)
+
+    logger.info { ["Successfully", "deployed", {app: "myapp", env: "prod"}] }
+
+    expect(output.string).to eq([
+      "\e[32m#{styles[:info][:symbol]}\e[0m ",
+      "\e[32minfo\e[0m    ",
+      "Successfully deployed     ",
+      "\e[32mapp\e[0m=myapp \e[32menv\e[0m=prod\n"
+    ].join)
+  end
+
   it "doesn't log when lower level" do
     logger = TTY::Logger.new(output: output) do |config|
       config.level = :warn
@@ -118,10 +154,10 @@ RSpec.describe TTY::Logger, "#log" do
       "\e[32mapp\e[0m=myapp \e[32menv\e[0m=prod\n"].join)
   end
 
-  it "logs message with fields" do
+  it "logs message with scoped fields" do
     logger = TTY::Logger.new(output: output)
 
-    logger.with(app: 'myapp', env: 'prod').info("Successfully deployed")
+    logger.info("Successfully deployed", app: 'myapp', env: 'prod')
 
     expect(output.string).to eq([
       "\e[32m#{styles[:info][:symbol]}\e[0m ",
@@ -130,15 +166,38 @@ RSpec.describe TTY::Logger, "#log" do
       "\e[32mapp\e[0m=myapp \e[32menv\e[0m=prod\n"].join)
   end
 
-  it "logs message with scoped fields" do
-    logger = TTY::Logger.new(output: output)
+  it "adds new custom log type" do
+    heart = "❤"
+    logger = TTY::Logger.new(output: output) do |config|
+      config.types = {thanks: {level: :info}}
+      config.handlers = [
+        [:console, {
+          styles: {
+            thanks: {
+              symbol: heart,
+              label: "thanks",
+              color: :red,
+              levelpad: 1
+            }
+          }
+        }]
+      ]
+    end
 
-    logger.info("Successfully deployed", app: 'myapp', env: 'prod')
+    logger.thanks("Great work!", app: "myapp", env: "prod")
 
     expect(output.string).to eq([
-      "\e[32m#{styles[:info][:symbol]}\e[0m ",
-      "\e[32minfo\e[0m    ",
-      "Successfully deployed     ",
-      "\e[32mapp\e[0m=myapp \e[32menv\e[0m=prod\n"].join)
+      "\e[31m#{heart}\e[0m ",
+      "\e[31mthanks\e[0m  ",
+      "Great work!               ",
+      "\e[31mapp\e[0m=myapp \e[31menv\e[0m=prod\n"].join)
+  end
+
+  it "fails to add already defined log type" do
+    expect {
+      TTY::Logger.new do |config|
+        config.types = {success: {level: :info}}
+      end
+    }.to raise_error(TTY::Logger::Error, "Already defined log type :success")
   end
 end

data/tasks/spec.rake

@@ -1,22 +1,27 @@
 # frozen_string_literal: true
 
 begin
-  require 'rspec/core/rake_task'
+  require "rspec/core/rake_task"
 
-  desc 'Run all specs'
+  desc "Run all specs"
   RSpec::Core::RakeTask.new(:spec) do |task|
-    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+    task.pattern = "spec/{unit,integration}{,/*/**}/*_spec.rb"
   end
 
   namespace :spec do
-    desc 'Run unit specs'
+    desc "Run unit specs"
     RSpec::Core::RakeTask.new(:unit) do |task|
-      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+      task.pattern = "spec/unit{,/*/**}/*_spec.rb"
     end
 
-    desc 'Run integration specs'
+    desc "Run integration specs"
     RSpec::Core::RakeTask.new(:integration) do |task|
-      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+      task.pattern = "spec/integration{,/*/**}/*_spec.rb"
+    end
+
+    desc "Run integration specs"
+    RSpec::Core::RakeTask.new(:perf) do |task|
+      task.pattern = "spec/perf{,/*/**}/*_spec.rb"
     end
   end
 

data/tty-logger.gemspec

@@ -32,4 +32,7 @@ Gem::Specification.new do |spec|
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-21 00:00:00.000000000 Z
+date: 2019-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -77,9 +77,12 @@ files:
 - 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
@@ -95,11 +98,16 @@ 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
@@ -108,6 +116,7 @@ files:
 - 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