tty-logger 0.1.0 → 0.6.0

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/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.with(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/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/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**5
-  config.metadata = [:all]
-  config.handlers = [[:stream, formatter: :text]]
-  config.level = :debug
-end
-
-logger = TTY::Logger.new(fields: {app: "myapp", env: "prod"})
-
-logger.with(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/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,107 +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,
-      handlers: [:console],
-      level: :info,
-      max_bytes: 8192,
-      max_depth: 3,
-      metadata: [],
-      output: $stderr,
-      time_format: "%T.%3N"
-    })
-  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

data/spec/unit/event_spec.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Logger::Event, "event" do
-  it "defaults backtrace to an empty array" do
-    event = described_class.new(["message"], {}, {})
-    expect(event.backtrace).to eq([])
-  end
-
-  it "extracts backtrace if message contains exception" do
-    event = nil
-    error = nil
-
-    begin
-      raise ArgumentError, "Wrong data"
-    rescue => ex
-      error = ex
-      event = described_class.new(["Error", ex], {}, {})
-    end
-
-    expect(event.backtrace.join).to eq(error.backtrace.join)
-  end
-end

data/spec/unit/exception_spec.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Logger, "exception logging" do
-  let(:output) { StringIO.new }
-  let(:styles) { TTY::Logger::Handlers::Console::STYLES }
-
-  it "handles exception type message when console" do
-    logger = TTY::Logger.new(output: output)
-    error = nil
-
-    begin
-      raise ArgumentError, "Wrong data"
-    rescue => ex
-      error = ex
-      logger.fatal("Error:", error)
-    end
-
-    expect(output.string).to eq([
-      "\e[31m#{styles[:fatal][:symbol]}\e[0m ",
-      "\e[31mfatal\e[0m   ",
-      "Error: Wrong data         \n",
-      "#{error.backtrace.map {|bktrace| bktrace.to_s.insert(0, " " * 4) }.join("\n")}\n"
-    ].join)
-  end
-
-  it "handles exception type message when stream" do
-    logger = TTY::Logger.new(output: output) do |config|
-      config.handlers = [:stream]
-    end
-
-    error = nil
-
-    begin
-      raise ArgumentError, "Wrong data"
-    rescue => ex
-      error = ex
-      logger.fatal("Error:", error)
-    end
-
-    expect(output.string).to eq([
-      "level=fatal message=\"Error: Wrong data\" backtrace=\"",
-      "#{error.backtrace.map {|bktrace| bktrace }.join(",")}\"\n"
-    ].join)
-  end
-end

data/spec/unit/formatter_spec.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Logger, "formatter" do 
-  let(:output) { StringIO.new }
-  let(:styles) { TTY::Logger::Handlers::Console::STYLES }
-
-  it "changes default formatter to JSON as class name" do
-    logger = TTY::Logger.new(output: output) do |config|
-      config.formatter = TTY::Logger::Formatters::JSON
-    end
-
-    logger.info("Logging", app: "myapp", env: "prod")
-
-    expect(output.string).to eq([
-      "\e[32m#{styles[:info][:symbol]}\e[0m ",
-      "\e[32minfo\e[0m    ",
-      "Logging                   ",
-      "{\"\e[32mapp\e[0m\":\"myapp\",\"\e[32menv\e[0m\":\"prod\"}\n"].join)
-  end
-
-  it "changes default formatter to JSON as name" do
-    logger = TTY::Logger.new(output: output) do |config|
-      config.formatter = :json
-    end
-
-    logger.info("Logging", app: "myapp", env: "prod")
-
-    expect(output.string).to eq([
-      "\e[32m#{styles[:info][:symbol]}\e[0m ",
-      "\e[32minfo\e[0m    ",
-      "Logging                   ",
-      "{\"\e[32mapp\e[0m\":\"myapp\",\"\e[32menv\e[0m\":\"prod\"}\n"].join)
-  end
-
-  it "changes default formatter for only one handler" do
-    logger = TTY::Logger.new(output: output) do |config|
-      config.handlers = [:console,
-                         [:console, {formatter: :JSON}]]
-    end
-
-    logger.info("Logging", app: "myapp", env: "prod")
-
-    expect(output.string).to eq([
-      "\e[32m#{styles[:info][:symbol]}\e[0m ",
-      "\e[32minfo\e[0m    ",
-      "Logging                   ",
-      "\e[32mapp\e[0m=myapp \e[32menv\e[0m=prod\n",
-      "\e[32m#{styles[:info][:symbol]}\e[0m ",
-      "\e[32minfo\e[0m    ",
-      "Logging                   ",
-      "{\"\e[32mapp\e[0m\":\"myapp\",\"\e[32menv\e[0m\":\"prod\"}\n"].join)
-  end
-
-  it "fails to recognize formatter object type" do
-    expect {
-      TTY::Logger.new(output: output) do |config|
-        config.formatter = true
-      end
-    }.to raise_error(TTY::Logger::Error, "Unrecognized formatter name 'true'")
-  end
-
-  it "fails to recognize formatter name" do
-
-    expect {
-      TTY::Logger.new(output: output) do |config|
-        config.formatter = :unknown
-      end
-    }.to raise_error(TTY::Logger::Error, "Unrecognized formatter name ':unknown'")
-  end
-end

data/spec/unit/formatters/json_spec.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Logger::Formatters::JSON, "#dump" do
-  it "dumps a log line" do
-    formatter = described_class.new
-    data = {
-      app: "myapp",
-      env: "prod",
-      sql: "SELECT * FROM admins",
-      at: Time.at(123456).utc
-    }
-
-    expect(formatter.dump(data)).to eq("{\"app\":\"myapp\",\"env\":\"prod\",\"sql\":\"SELECT * FROM admins\",\"at\":\"1970-01-02 10:17:36 UTC\"}")
-  end
-
-  [
-    {obj: {a: "aaaaa", b: "bbbbb", c: "ccccc"}, bytes: 3*12+2, want: "{\"a\":\"aaaaa\",\"b\":\"bbbbb\",\"c\":\"ccccc\"}"},
-    {obj: {a: "aaaaa", b: "bbbbb", c: "ccccc"}, bytes: 2*12+4, want: "{\"a\":\"aaaaa\",\"b\":\"bbbbb\",\"c\":\"...\"}"},
-    {obj: {a: "aaaaa", b: "bbbbb", c: "ccccc"}, bytes: 12+4, want: "{\"a\":\"aaaaa\",\"b\":\"...\"}"},
-    {obj: {a: "aaaaa", b: "bbbbb", c: "ccccc"}, bytes: 11, want: "{\"a\":\"...\"}"},
-  ].each do |data|
-    it "truncates #{data[:obj].inspect} to #{data[:want].inspect} of #{data[:bytes]} bytes" do
-      formatter = described_class.new
-      expect(formatter.dump(data[:obj], max_bytes: data[:bytes])).to eq(data[:want])
-    end
-  end
-
-  [
-    {obj: {a: {b: {c: "ccccc"}}}, depth: 1, want: "{\"a\":\"...\"}"},
-    {obj: {a: {b: {c: "ccccc"}}}, depth: 2, want: "{\"a\":{\"b\":\"...\"}}"},
-    {obj: {a: {b: {c: "ccccc"}}}, depth: 3, want: "{\"a\":{\"b\":{\"c\":\"ccccc\"}}}"},
-    {obj: {a: ["b", {c: "ccccc"}]}, depth: 1, want: "{\"a\":\"...\"}"},
-    {obj: {a: ["b", {c: "ccccc"}]}, depth: 2, want: "{\"a\":[\"b\",\"...\"]}"},
-    {obj: {a: ["b", {c: "ccccc"}]}, depth: 3, want: "{\"a\":[\"b\",{\"c\":\"ccccc\"}]}"},
-  ].each do |data|
-    it "truncates nested object #{data[:obj].inspect} to #{data[:want].inspect}" do
-      formatter = described_class.new
-      expect(formatter.dump(data[:obj], max_depth: data[:depth])).to eq(data[:want])
-    end
-  end
-end