logger-better 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e0c09b94e167758c7a2321fdfd131fa4e41d24a
+  data.tar.gz: 0e69278c6e1dfab3f57419303763656588935776
+SHA512:
+  metadata.gz: c0b88a14912444091f9397d8f107060e8b2523471c3b9a9c6d94729d3cc45dbb5daa9039830a18593a3714accb6c91d3f655c789693dafd10798f5df1c6aad86
+  data.tar.gz: 44c566786298ffb598fa4ba546f52ba04692b907011942d64444da50ff63b467c82a65d925803d450c8bb2bacfdb6bc09e6692c642b8a0c5bd26842e92d006c1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in better_logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ahawkins
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# BetterLogger
+
+Simple monkey patch to stdlib's `Logger` to make it easier to use.
+
+I wrote this gem because I've done this same basic thing in many
+projects and got tired of it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'better_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install better_logger
+
+## Enhancements
+
+* Default log format is more readable: `2013-08-10T15:19:21Z [app#68530]  INFO: hi`
+* Set `logger.level` with symbols. `logger.level = :info`
+* Provide a `NullLogger` object to be used in cases where you need to
+  tell some code to shut up.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new :test do |t|
+  t.test_files = Dir['test/**/*_test.rb']
+end
+
+task default: :test

data/lib/logger-better.rb

@@ -0,0 +1,4 @@
+require "logger-better/version"
+
+require_relative 'logger/better'
+require_relative 'logger/null_logger'

data/lib/logger-better/version.rb

@@ -0,0 +1,5 @@
+class Logger
+  module Better
+    VERSION = "0.1.0"
+  end
+end

data/lib/logger/better.rb

@@ -0,0 +1,33 @@
+require 'logger'
+require 'time'
+
+class Logger
+  def level=(value)
+    if value.is_a? Symbol
+      @level = mapping.fetch(value, UNKNOWN)
+    else
+      @level = value
+    end
+  end
+
+  def mapping
+    {
+      debug: DEBUG,
+      info: INFO,
+      warn: WARN,
+      error: ERROR,
+      fatal: FATAL,
+      unknown: UNKNOWN
+    }
+  end
+
+  class Formatter
+    def call(severity, time, progname, msg)
+      format % [time.iso8601, progname, $$, severity, msg2str(msg)]
+    end
+
+    def format
+      "%s [%s#%d] %5s: %s\n"
+    end
+  end
+end

data/lib/logger/null_logger.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+class NullLogger < Logger
+  def initialize(*args)
+
+  end
+
+  # All other methods (debug/info) etc use add internally.
+  # It's the lowest level public interface.
+  def add(*args, &block)
+
+  end
+end

data/logger-better.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logger-better/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logger-better"
+  spec.version       = Logger::Better::VERSION
+  spec.authors       = ["ahawkins"]
+  spec.email         = ["adam@hawkins.io"]
+  spec.description   = %q{Simple monkey patch to stdlib's Logger to make it easier to use.}
+  spec.summary       = %q{Simple monkey patch to stdlib's Logger to make it easier to use.}
+  spec.homepage      = "https://github.com/ahawkins/logger-better"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/better_test.rb

@@ -0,0 +1,81 @@
+require_relative 'test_helper'
+require 'logger/better'
+require 'stringio'
+
+class BetterTest < MiniTest::Unit::TestCase
+  def test_uses_the_iso_8601_times
+    formatter = Logger::Formatter.new
+
+    time = Time.now
+    log = formatter.call 'info', time, 'app', 'hi'
+    assert_includes log, time.iso8601
+  end
+
+  def test_starts_with_the_time
+    formatter = Logger::Formatter.new
+
+    time = Time.now
+    log = formatter.call 'info', time, 'app', 'hi'
+    assert_equal 0, log.index(time.iso8601)
+  end
+
+  def test_progname_comes_after_time
+    formatter = Logger::Formatter.new
+
+    time = Time.now
+    log = formatter.call 'info', time, 'app', 'hi'
+    assert_before log, 'app', time.iso8601
+  end
+
+  def test_pid_comes_after_progname
+    formatter = Logger::Formatter.new
+
+    log = formatter.call 'info', Time.now, 'app', 'hi'
+    assert_before log, $$.to_s, 'app'
+  end
+
+  def test_level_comes_after_progname
+    formatter = Logger::Formatter.new
+
+    log = formatter.call 'info', Time.now, 'app', 'hi'
+    assert_before log, 'info',  $$.to_s
+  end
+
+  def test_message_comes_last
+    formatter = Logger::Formatter.new
+
+    log = formatter.call 'info', Time.now, 'app', 'hi'
+    assert_before log, 'hi', 'info'
+  end
+
+  def test_can_set_level_with_symbol
+    logger = Logger.new StringIO.new
+
+    logger.level = :debug
+    assert_equal Logger::DEBUG, logger.level
+    logger.level = :info
+    assert_equal Logger::INFO, logger.level
+    logger.level = :warn
+    assert_equal Logger::WARN, logger.level
+    logger.level = :error
+    assert_equal Logger::ERROR, logger.level
+    logger.level = :fatal
+    assert_equal Logger::FATAL, logger.level
+    logger.level = :unknown
+    assert_equal Logger::UNKNOWN, logger.level
+  end
+
+  def tests_sets_level_unkown_when_passing_an_unkown_symol
+    logger = Logger.new StringIO.new
+
+    logger.level = :foo
+    assert_equal Logger::UNKNOWN, logger.level
+  end
+
+  private
+  def assert_before(string, second, first)
+    assert_includes string, first
+    assert_includes string, second
+    assert string.index(first) < string.index(second)
+  end
+end

data/test/null_logger_test.rb

@@ -0,0 +1,9 @@
+require_relative 'test_helper'
+require 'logger/null_logger'
+
+class NullLoggerTest < MiniTest::Unit::TestCase
+  def test_add_does_nothing
+    logger = NullLogger.new
+    logger.add Logger::INFO, 'hi', 'tests'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+require 'logger-better'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: logger-better
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ahawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple monkey patch to stdlib's Logger to make it easier to use.
+email:
+- adam@hawkins.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logger-better.rb
+- lib/logger-better/version.rb
+- lib/logger/better.rb
+- lib/logger/null_logger.rb
+- logger-better.gemspec
+- test/better_test.rb
+- test/null_logger_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ahawkins/logger-better
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Simple monkey patch to stdlib's Logger to make it easier to use.
+test_files:
+- test/better_test.rb
+- test/null_logger_test.rb
+- test/test_helper.rb