better-logger 0.0.1

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) 2012 Sam Rose
+
+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,119 @@
+# Better::Logger
+
+Better Logger is designed to be a replacement for the standard library logging
+gem. There are a couple of things about the standard library gem that I don't
+quite like:
+
+  - It puts errors in the same place as debug and info messages. I'd prefer my
+  logger to put errors in STDERR and everything else in STDOUT.
+
+  - Lots of people declare their loggers in different ways, there's no
+  convention around logging. I'd much prefer to be able to specify a
+  configuration block and then have a globally accessible logger.
+
+  - The default format of log output in the Ruby standard logger isn't very
+  useful in my opinion. I would prefer a default that has colours and
+  information about where in the code the log message came from.
+
+This gem attempts to address all of these things. You may prefer the standard
+Ruby implementation, and that's totally fine, I built this for me originally and
+wanted to share 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
+
+## Usage
+
+First thing you need to do is configure your logger:
+
+``` ruby
+require 'better-logger'
+
+Better::Logger.config do |conf|
+  conf.color     = true
+  conf.log_to    = STDOUT
+  conf.error_to  = STDERR
+  conf.log_level = :info
+end
+```
+
+After this configuration block you will have access to a `log` object from
+everywhere in your code. Its usage should be familiar:
+
+``` ruby
+# The following log methods are listed in order of their severity from least to
+# most severe.
+
+log.debug "This is a debug message. It goes to conf.log_to"
+log.info  "This is an info message. It goes to conf.log_to"
+log.warn  "This is a warn message. It goes to conf.log_to"
+log.error "This is an error message. It does to conf.error_to"
+log.fatal "This is also an error but more sever. It also goes to conf.error_to"
+```
+
+### Multiple logs
+
+It's possible to have multiple logs in the same piece of code by passing a
+symbol into the configure blocks:
+
+``` ruby
+require 'better-logger'
+
+Better::Logger.config :log1 do |conf|
+  conf.color     = true
+  conf.log_to    = STDOUT
+  conf.error_to  = STDERR
+  conf.log_level = :info
+end
+
+Better::Logger.config :log2 do |conf|
+  conf.color     = true
+  conf.log_to    = "log_output.log"
+  conf.error_to  = "log_error.log"
+  conf.log_level = :info
+end
+
+log1.info "Going to STDOUT."
+log2.info "Going to a file called 'log_output.log' in the current directory."
+```
+
+### Modifying logs after creation
+
+You can access and modify the configuration of a log after its creation simply
+by modifying its `config` object:
+
+``` ruby
+require 'better-logger'
+
+Better::Logger.config do |conf|
+  conf.color     = true
+  conf.log_to    = "log_output.log"
+  conf.error_to  = "log_error.log"
+  conf.log_level = :info
+end
+
+log.info "Logging to a file called 'log_output.log'"
+
+log.config.log_to = STDOUT
+
+log.info "Logging to STDOUT."
+```
+
+## 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,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default => [:test]
+
+desc "Run all tests"
+RSpec::Core::RakeTask.new(:test) do |t|
+    t.rspec_opts = '-cfs'
+end

data/better-logger.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'better-logger/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "better-logger"
+  gem.version       = Better::Logger::VERSION
+  gem.authors       = ["Sam Rose"]
+  gem.email         = ["samwho@lbak.co.uk"]
+  gem.description   = %q{A better logging default for Ruby.}
+  gem.summary       = %q{A little tired of unconventional logging techniques in projects, this gem aims to introduce a logging convention.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  # Dependencies
+  gem.add_development_dependency "rspec"
+  gem.add_dependency "colored"
+end

data/examples/config.rb

@@ -0,0 +1,22 @@
+require_relative '../lib/better-logger'
+
+Better::Logger.config do |conf|
+  conf.color = true
+  conf.log_to = STDOUT
+  conf.error_to = STDERR
+  conf.log_level = :debug
+end
+
+class Foo
+  def bar
+    log.debug "Yes"
+    log.info  "Np"
+    log.warn  "Oops!"
+    log.error "Test"
+    log.fatal "wat"
+  end
+end
+
+Foo.new.bar
+
+log.info "Done."

data/examples/include.rb

@@ -0,0 +1,11 @@
+class Foo
+  include Better::Logger
+
+  def initialize
+    debug "Initialize entered."
+  end
+
+  def bar
+    error "Oh noes! Something went wrong!"
+  end
+end

data/lib/better-logger.rb

@@ -0,0 +1,14 @@
+lib = File.dirname(__FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+def require_all path
+  Dir[File.join(File.dirname(__FILE__), path, '*.rb')].each { |f| require f }
+end
+
+require 'colored'
+
+require     'better-logger/base'
+require_all 'better-logger'
+
+# Make the logging methods available from everywhere
+include Better::Logger::Loggers

data/lib/better-logger/base.rb

@@ -0,0 +1,26 @@
+module Better
+  module Logger
+    LEVELS = {
+      debug:  0,
+      info:   1,
+      warn:   2,
+      error:  3,
+      fatal:  4,
+      silent: 100,
+    }
+
+    def self.config log_name = :log, &block
+      conf_object = Config.new
+      yield conf_object
+
+      # The "Loggers" module gets included into the main namespace when
+      # better-logger is required. By defining a method in it, we define a
+      # method in the main namespace. This allows the loggers to be accessed
+      # from anywhere.
+      Loggers._log_hash[log_name] = Logger.new(conf_object)
+      Loggers.send :define_method, log_name do
+        Loggers._log_hash[log_name]
+      end
+    end
+  end
+end

data/lib/better-logger/config.rb

@@ -0,0 +1,72 @@
+module Better
+  module Logger
+    class Config
+      attr_writer :color, :formatter, :datetime_format, :log_level, :time_format
+
+      def color
+        @color = true if @color.nil?
+        @color
+      end
+
+      def color?
+        color
+      end
+
+      def log_to
+        @log_to ||= STDOUT
+      end
+
+      def log_to= new_log_to
+        if new_log_to.is_a? String
+          @log_to = File.open(new_log_to, 'a')
+        else
+          @log_to = new_log_to
+        end
+      end
+
+      def error_to
+        @error_to ||= STDERR
+      end
+
+      def error_to= new_error_to
+        if new_error_to.is_a? String
+          @error_to = File.open(new_error_to, 'a')
+        else
+          @error_to = new_error_to
+        end
+      end
+
+      def log_level
+        @log_level ||= :info
+      end
+
+      def time_format
+        @time_format ||= "%Y/%m/%d %H:%M:%S"
+      end
+
+      def formatter
+        @formatter ||= lambda do |message, level|
+          _level = level.to_s.ljust(5)
+          _time  = Time.now.strftime(config.time_format)
+
+          if config.color?
+            case level
+            when :debug
+              _level = _level.magenta
+            when :info
+              _level = _level.cyan
+            when :warn
+              _level = _level.yellow
+            when :error
+              _level = _level.red
+            when :fatal
+              _level = _level.red
+            end
+          end
+
+          "[#{_time}][#{_level}][#{caller[3]}] #{message}"
+        end
+      end
+    end
+  end
+end

data/lib/better-logger/logger.rb

@@ -0,0 +1,37 @@
+module Better
+  module Logger
+    class Logger
+      attr_accessor :config
+
+      def initialize config
+        @config = config
+      end
+
+      def debug msg; _log config.log_to, __method__,   msg; end;
+      def info  msg; _log config.log_to, __method__,   msg; end;
+      def warn  msg; _log config.log_to, __method__,   msg; end;
+      def error msg; _log config.error_to, __method__, msg; end;
+      def fatal msg; _log config.error_to, __method__, msg; end;
+
+      # Pseudo-private methods
+
+      def _format msg, level = config.log_level
+        if config.formatter
+          instance_exec msg, level.to_sym, &config.formatter
+        else
+          msg
+        end
+      end
+
+      def _should_log? level
+        # :info <= :debug
+        # 1     <= 0
+        LEVELS[config.log_level] <= LEVELS[level.to_sym]
+      end
+
+      def _log io, level, msg
+        io.puts _format(msg, level) if _should_log? level
+      end
+    end
+  end
+end

data/lib/better-logger/loggers.rb

@@ -0,0 +1,9 @@
+module Better
+  module Logger
+    module Loggers
+      def self._log_hash
+        @@log_hash ||= {}
+      end
+    end
+  end
+end

data/lib/better-logger/version.rb

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

data/spec/logger_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+
+describe Better::Logger do
+  let(:fake_stdout)         { Tempfile.new 'fake_stdout' }
+  let(:fake_stderr)         { Tempfile.new 'fake_stderr' }
+  let(:fake_stdout_content) { fake_stdout.rewind; fake_stdout.read }
+  let(:fake_stderr_content) { fake_stderr.rewind; fake_stderr.read }
+
+  before :each do
+    Better::Logger.config :log do |conf|
+      conf.color     = false
+      conf.log_to    = fake_stdout
+      conf.error_to  = fake_stderr
+      conf.log_level = :debug
+    end
+  end
+
+  after :each do
+    fake_stdout.close; fake_stdout.unlink
+    fake_stderr.close; fake_stderr.unlink
+  end
+
+  describe "log#info" do
+    subject { fake_stdout_content }
+    before  { log.info "Testing!" }
+    it      { should include "Testing!" }
+    it      { should include "[info ]" }
+  end
+
+  describe "log#info multiple calls" do
+    subject { fake_stdout_content }
+
+    before do
+      log.info "Info test!"
+      log.info "Info test 2!"
+    end
+
+    it { should include "Info test!" }
+    it { should include "Info test 2!" }
+  end
+
+  describe "log#error" do
+    subject { fake_stderr_content }
+    before  { log.error "error test!" }
+    it      { should include "error test!" }
+    it      { should include "[error]" }
+  end
+
+  describe "log#error multiple calls" do
+    subject { fake_stderr_content }
+
+    before do
+      log.error "error test!"
+      log.error "error test 2!"
+    end
+
+    it { should include "error test!" }
+    it { should include "error test 2!" }
+  end
+
+  describe "log#debug" do
+    subject { fake_stdout_content }
+    before  { log.debug "debug test!" }
+    it      { should include "debug test!" }
+    it      { should include "[debug]" }
+  end
+
+  describe "log#debug multiple calls" do
+    subject { fake_stderr_content }
+
+    before do
+      log.error "debug test!"
+      log.error "debug test 2!"
+    end
+
+    it { should include "debug test!" }
+    it { should include "debug test 2!" }
+  end
+
+  describe "With color" do
+    before :each do
+      Better::Logger.config :log do |conf|
+        conf.color     = true
+        conf.log_to    = fake_stdout
+        conf.error_to  = fake_stderr
+        conf.log_level = :debug
+      end
+    end
+
+    describe "log#fatal" do
+      subject { fake_stderr_content }
+      before  { log.fatal "fatal test!" }
+      it      { should include "fatal test!" }
+      it      { should include "[#{"fatal".red}]" }
+    end
+  end
+
+  describe "With a different formatter" do
+    before :each do
+      Better::Logger.config :log do |conf|
+        conf.color     = true
+        conf.log_to    = fake_stdout
+        conf.error_to  = fake_stderr
+        conf.log_level = :debug
+
+        conf.formatter = lambda do |message, level|
+          "#{level.upcase} #{message.upcase}"
+        end
+      end
+    end
+
+    describe "log#warn" do
+      subject { fake_stdout_content }
+      before  { log.warn "warn test!" }
+      it      { should == "WARN WARN TEST!\n" }
+    end
+  end
+
+  describe "Non-default logging method" do
+    before :each do
+      Better::Logger.config :testlog do |conf|
+        conf.color     = true
+        conf.log_to    = fake_stdout
+        conf.error_to  = fake_stderr
+        conf.log_level = :debug
+      end
+    end
+
+    describe "testlog#info" do
+      subject { fake_stdout_content }
+      before  { testlog.info "testlog!" }
+      it      { should include "testlog!" }
+    end
+  end
+
+  describe "Slightly raised log level" do
+    before :each do
+      Better::Logger.config :testlog do |conf|
+        conf.color     = true
+        conf.log_to    = fake_stdout
+        conf.error_to  = fake_stderr
+        conf.log_level = :info
+      end
+    end
+
+    describe "log#debug" do
+      subject { fake_stdout_content }
+      before  { testlog.debug "I shouldn't be in the output." }
+      it      { should be_empty }
+    end
+  end
+
+  describe "Silent flag" do
+    before :each do
+      Better::Logger.config :log do |conf|
+        conf.color     = true
+        conf.log_to    = fake_stdout
+        conf.error_to  = fake_stderr
+        conf.log_level = :silent
+      end
+    end
+
+    describe "log#fatal" do
+      subject { fake_stderr_content }
+      before  { log.fatal "Should not be output." }
+      it      { should be_empty }
+    end
+  end
+
+  describe "Modifying log after creation" do
+    before :each do
+      Better::Logger.config :log do |conf|
+        conf.color     = true
+        conf.log_to    = fake_stdout
+        conf.error_to  = fake_stderr
+        conf.log_level = :info
+      end
+    end
+
+    describe "log#info after log_to changed to fake_stderr" do
+      subject { fake_stderr_content }
+
+      before do
+        log.config.log_to = fake_stderr
+        log.info "Testing!"
+      end
+
+      it { should include "Testing!" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require_relative '../lib/better-logger'
+require 'tempfile'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: better-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sam Rose
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A better logging default for Ruby.
+email:
+- samwho@lbak.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- better-logger.gemspec
+- examples/config.rb
+- examples/include.rb
+- lib/better-logger.rb
+- lib/better-logger/base.rb
+- lib/better-logger/config.rb
+- lib/better-logger/logger.rb
+- lib/better-logger/loggers.rb
+- lib/better-logger/version.rb
+- spec/logger_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A little tired of unconventional logging techniques in projects, this gem
+  aims to introduce a logging convention.
+test_files:
+- spec/logger_spec.rb
+- spec/spec_helper.rb
+has_rdoc: