console_logger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c67f834edbe2abdbdedf7025554a1332e90fdce
+  data.tar.gz: b6812fb4d4e666da4dc8d8eee294fa34dc254d39
+SHA512:
+  metadata.gz: aafb2b7f4aa38709f2da50c1b311f00756e033307c801d48f877619089b592fdd22c35f572cff8aa9ec9bbb10cd6c0991ec4eb27ece10897c4ac811f3919f8f7
+  data.tar.gz: 66405863d6dad1c994a3d507237542f79b43bb50fc47ddb81bd8725d3ee1a4ba653ceadf8e0e5ff128748baea27a5b0fbc1577a7a7cd559014ccbbfb0b1fd90f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mike Williams
+
+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,21 @@
+# ConsoleLogger
+
+Logging is great.  But sometimes, you just want to write to STDOUT/STDERR.
+
+ConsoleLogger provides a quick way to get a Logger optimised for console output.
+
+## Usage
+
+Use it like this:
+
+    require 'console_logger'
+
+    logger = ConsoleLogger.new($stderr)
+    logger.info("something is about to happen")
+    # => INFO: something is about to happen
+    logger.warn("something went wrong!")
+    # => WARN: something went wrong!
+
+## Contributing
+
+* It's on GitHub; you know the drill.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end
+
+task "default" => "test"

data/console_logger.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+
+  spec.name          = "console_logger"
+  spec.version       = "1.0.0"
+
+  spec.summary       = %q{A Logger customised for console output.}
+  spec.license       = "MIT"
+
+  spec.authors       = ["Mike Williams"]
+  spec.email         = ["mdub@dogbiscuit.org"]
+  spec.homepage      = "https://github.com/mdub/console_logger"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+end

data/lib/console_logger.rb

@@ -0,0 +1,27 @@
+require "logger"
+
+# Provides a Logger customised for console output.
+#
+module ConsoleLogger
+
+  # Returns a new Logger, customised for console output.
+  #
+  # dest - the IO stream to write to
+  # verbose - sets log-level to DEBUG, if true
+  #
+  def self.new(dest = $stderr, verbose = false)
+    ::Logger.new(dest).tap do |logger|
+      logger.formatter = Formatter.new
+      logger.level = verbose ? ::Logger::DEBUG : ::Logger::INFO
+    end
+  end
+
+  class Formatter < ::Logger::Formatter
+
+    def call(severity, time, progname, msg)
+      "#{severity}: #{msg.strip}\n"
+    end
+
+  end
+
+end

data/test/test_console_logger.rb

@@ -0,0 +1,48 @@
+require_relative "test_helper"
+
+require "console_logger"
+require "stringio"
+
+describe ConsoleLogger do
+
+  let(:output) { "" }
+  let(:output_stream) { StringIO.new(output) }
+
+  let(:logger) { ConsoleLogger.new(output_stream) }
+
+  %w(debug info warn error fatal).each do |level|
+
+    describe "##{level}" do
+
+      before do
+        logger.level = Logger::DEBUG
+      end
+
+      it "prepends #{level.upcase} to the message" do
+        logger.send(level, "message")
+        output.must_equal "#{level.upcase}: message\n"
+      end
+
+    end
+
+  end
+
+  describe "#level" do
+    it "defaults to INFO" do
+      logger.level.must_equal Logger::INFO
+    end
+  end
+
+  describe "verbose" do
+
+    let(:logger) { ConsoleLogger.new(output_stream, true) }
+
+    describe "#level" do
+      it "defaults to DEBUG" do
+        logger.level.must_equal Logger::DEBUG
+      end
+    end
+
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require "minitest/autorun"
+require "minitest/pride"
+
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: console_logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- mdub@dogbiscuit.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- console_logger.gemspec
+- lib/console_logger.rb
+- test/test_console_logger.rb
+- test/test_helper.rb
+homepage: https://github.com/mdub/console_logger
+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.2
+signing_key: 
+specification_version: 4
+summary: A Logger customised for console output.
+test_files:
+- test/test_console_logger.rb
+- test/test_helper.rb