loggability 0.0.1

data/spec/lib/helpers.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# vim: set nosta noet ts=4 sw=4:
+# encoding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
+}
+
+# SimpleCov test coverage reporting; enable this using the :coverage rake task
+if ENV['COVERAGE']
+	$stderr.puts "\n\n>>> Enabling coverage report.\n\n"
+	require 'simplecov'
+	SimpleCov.start do
+		add_filter 'spec'
+	end
+end
+
+
+require 'loggability' unless defined?( Loggability )
+
+#
+# Some helper functions for RSpec specifications
+#
+module Loggability::SpecHelpers
+
+	
+
+end # Loggability::SpecHelpers
+
+
+### Mock with RSpec
+RSpec.configure do |c|
+	c.mock_with( :rspec )
+
+	c.include( Loggability::SpecHelpers )
+end
+

data/spec/loggability/formatter/color_spec.rb

@@ -0,0 +1,38 @@
+# -*- rspec -*-
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname( __FILE__ ).dirname.parent.parent.parent
+	$LOAD_PATH.unshift( basedir.to_s ) unless $LOAD_PATH.include?( basedir.to_s )
+}
+
+require 'tempfile'
+require 'rspec'
+require 'spec/lib/helpers'
+require 'loggability/logger'
+require 'loggability/formatter'
+require 'loggability/formatter/color'
+
+
+describe Loggability::Formatter::Color do
+
+	before( :all ) do
+		@original_term = ENV['TERM']
+		ENV['TERM'] = 'xterm-color'
+	end
+
+	after( :all ) do
+		ENV['TERM'] = @original_term
+	end
+
+	before( :each ) do
+		@formatter = described_class.new
+	end
+
+	it "formats messages with ANSI color" do
+		@formatter.call( 'INFO', Time.at(1336286481), nil, "Foom." ).
+			should include( "-- \e[37mFoom.\e[0m\n" )
+	end
+
+end
+

data/spec/loggability/formatter/html_spec.rb

@@ -0,0 +1,45 @@
+# -*- rspec -*-
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname( __FILE__ ).dirname.parent.parent.parent
+	$LOAD_PATH.unshift( basedir.to_s ) unless $LOAD_PATH.include?( basedir.to_s )
+}
+
+require 'tempfile'
+require 'rspec'
+require 'spec/lib/helpers'
+require 'loggability/logger'
+require 'loggability/formatter'
+require 'loggability/formatter/html'
+
+
+describe Loggability::Formatter::HTML do
+
+	subject { described_class.new }
+
+	it "formats messages as HTML" do
+		subject.call( 'INFO', Time.at(1336286481), nil, "Foom." ).should =~
+			%r{<span class="log-message-text">Foom.</span>}i
+	end
+
+	it "formats exceptions into useful messages" do
+		msg = nil
+
+		begin
+			raise ArgumentError, "invalid argument"
+		rescue => err
+			msg = subject.call( 'INFO', Time.at(1336286481), nil, err )
+		end
+
+		msg.should =~ %r{<span class=\"log-exc\">ArgumentError</span>}i
+		msg.should =~ %r{<span class=\"log-exc-message\">invalid argument</span>}i
+		msg.should =~ %r{ from <span class=\"log-exc-firstframe\">}i
+	end
+
+	it "formats regular objects into useful messages" do
+		subject.call( 'INFO', Time.at(1336286481), nil, Object.new ).should =~
+			%r{<span class=\"log-message-text\">#&lt;Object:0x\p{XDigit}+&gt;</span>}
+	end
+end
+

data/spec/loggability/formatter_spec.rb

@@ -0,0 +1,50 @@
+# -*- rspec -*-
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname( __FILE__ ).dirname.parent.parent
+	$LOAD_PATH.unshift( basedir.to_s ) unless $LOAD_PATH.include?( basedir.to_s )
+}
+
+require 'tempfile'
+require 'rspec'
+require 'spec/lib/helpers'
+require 'loggability/logger'
+require 'loggability/formatter'
+require 'loggability/formatter/default'
+
+
+describe Loggability::Formatter do
+
+	it "loads plugins out of loggability/formatter" do
+		Loggability::Formatter.derivative_dirs.should == ['loggability/formatter']
+	end
+
+
+	it "formats messages with the pattern it's constructed with" do
+		formatter = Loggability::Formatter.new( '[%5$s] %7$s' )
+		formatter.call( 'INFO', Time.at(1336286481), nil, 'Foom.' ).should =~
+			/\[INFO\] Foom./
+	end
+
+	it "formats exceptions into useful messages" do
+		formatter = Loggability::Formatter.new( '[%5$s] %7$s' )
+		msg = nil
+
+		begin
+			raise ArgumentError, "invalid argument"
+		rescue => err
+			msg = formatter.call( 'INFO', Time.at(1336286481), nil, err )
+		end
+
+		msg.should =~ /\[INFO\] ArgumentError: invalid argument/i
+	end
+
+	it "formats regular objects into useful messages" do
+		formatter = Loggability::Formatter.new( '[%5$s] %7$s' )
+		formatter.call( 'INFO', Time.at(1336286481), nil, Object.new ).should =~
+			/\[INFO\] #<Object:0x\p{XDigit}+>/i
+	end
+
+end
+

data/spec/loggability/logger_spec.rb

@@ -0,0 +1,149 @@
+# -*- rspec -*-
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname( __FILE__ ).dirname.parent.parent
+	$LOAD_PATH.unshift( basedir.to_s ) unless $LOAD_PATH.include?( basedir.to_s )
+}
+
+require 'tempfile'
+require 'rspec'
+require 'spec/lib/helpers'
+require 'loggability/logger'
+require 'loggability/formatter'
+require 'loggability/formatter/default'
+
+
+describe Loggability::Logger do
+
+	before( :all ) do
+		@original_debug_level = $DEBUG
+		$DEBUG = false
+	end
+
+	after( :all ) do
+		$DEBUG = @original_debug_level
+	end
+
+
+	before( :each ) do
+		@logger = described_class.new
+	end
+
+
+	describe "severity level API" do
+
+		it "defaults to :warn level" do
+			@logger.level.should == :warn
+		end
+
+		it "defaults to :debug level when $DEBUG is true" do
+			begin
+				$DEBUG = true
+				described_class.new.level.should == :debug
+			ensure
+				$DEBUG = false
+			end
+		end
+
+		it "allows its levels to be set with integers like Logger" do
+			@logger.level = Logger::DEBUG
+			@logger.level.should == :debug
+		end
+
+		it "allows its levels to be set with Symbolic level names" do
+			@logger.level = :info
+			@logger.level.should == :info
+		end
+
+		it "allows its levels to be set with Stringish level names" do
+			@logger.level = 'fatal'
+			@logger.level.should == :fatal
+		end
+
+	end
+
+
+	describe "log device API" do
+
+		it "logs to STDERR by default" do
+			@logger.logdev.dev.should be( $stderr )
+		end
+
+		it "can be told to log to a file" do
+			tmpfile = Tempfile.new( 'loggability-device-spec' )
+			@logger.output_to( tmpfile.path )
+			@logger.logdev.dev.should be_a( File )
+		end
+
+		it "supports log-rotation arguments for logfiles" do
+			tmpfile = Tempfile.new( 'loggability-device-spec' )
+			@logger.output_to( tmpfile.path, 5, 125000 )
+			@logger.logdev.dev.should be_a( File )
+			@logger.logdev.filename.should == tmpfile.path
+			@logger.logdev.instance_variable_get( :@shift_age ).should == 5
+			@logger.logdev.instance_variable_get( :@shift_size ).should == 125000
+		end
+
+		it "can be told to log to an Array" do
+			logmessages = []
+			@logger.output_to( logmessages )
+			@logger.logdev.should be_a( Loggability::Logger::AppendingLogDevice )
+			@logger.level = :debug
+			@logger.info( "Something happened." )
+			logmessages.should have( 1 ).member
+			logmessages.first.should =~ /something happened/i
+		end
+
+	end
+
+
+	describe "formatter API" do
+
+		it "logs with the default formatter by default" do
+			@logger.formatter.should be_a( Loggability::Formatter::Default )
+		end
+
+		it "can be told to use the default formatter explicitly" do
+			@logger.format_as( :default )
+			@logger.formatter.should be_a( Loggability::Formatter::Default )
+		end
+
+		it "can be told to use a block as a formatter" do
+			@logger.format_with do |severity, datetime, progname, msg|
+				original_formatter.call(severity, datetime, progname, msg.dump)
+			end
+
+			@logger.formatter.should be_a( Proc )
+		end
+
+		it "can be told to use the HTML formatter" do
+			@logger.format_as( :html )
+			@logger.formatter.should be_a( Loggability::Formatter::HTML )
+		end
+
+	end
+
+
+	describe "progname proxy" do
+
+		it "can create a proxy object that will log with the argument object as the 'progname'" do
+			messages = []
+			@logger.output_to( messages )
+			@logger.level = :debug
+
+			obj = Object.new
+			proxy = @logger.proxy_for( obj )
+			proxy.debug( "A debug message." )
+			proxy.info( "An info message." )
+			proxy.warn( "A warn message." )
+			proxy.error( "An error message." )
+			proxy.fatal( "A fatal message." )
+
+			messages.first.should =~ /DEBUG \{Object:0x\p{XDigit}+\} -- A debug message.\n/
+		end
+
+	end
+
+end
+

data/spec/loggability_spec.rb

@@ -0,0 +1,84 @@
+# -*- rspec -*-
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname( __FILE__ ).dirname.parent
+	$LOAD_PATH.unshift( basedir.to_s ) unless $LOAD_PATH.include?( basedir.to_s )
+}
+
+require 'rspec'
+require 'spec/lib/helpers'
+require 'loggability'
+require 'loggability/logger'
+
+describe Loggability do
+
+	it "is itself a log host for the global logger" do
+		described_class.logger.should be_a( Loggability::Logger )
+		described_class.log_hosts.should include( Loggability::GLOBAL_KEY => Loggability )
+	end
+
+
+	describe "version methods" do
+		it "returns a version string if asked" do
+			described_class.version_string.should =~ /\w+ [\d.]+/
+		end
+
+		it "returns a version string with a build number if asked" do
+			described_class.version_string(true).should =~ /\w+ [\d.]+ \(build [[:xdigit:]]+\)/
+		end
+	end
+
+
+	context "installed in a class" do
+
+		before( :each ) do
+			@class = Class.new { extend Loggability }
+		end
+
+		after( :each ) do
+			Loggability.clear_loghosts
+		end
+
+
+		it "allows it to be designated as a log host" do
+			@class.log_as( :testing )
+			Loggability.log_hosts.should include( :testing => @class )
+			@class.logger.should be_a( Loggability::Logger )
+			@class.default_logger.should be( @class.logger )
+		end
+
+		it "allows it to designate itself as a logging client" do
+			origin = Class.new do
+				extend Loggability
+				log_as :testing
+			end
+			@class.log_to( :testing )
+			@class.log.logger.should be( origin.logger )
+
+			@class.new.log.logger.should be( origin.logger )
+		end
+
+	end
+
+
+	context "aggregate methods" do
+
+		it "propagate some setting methods to every Logger" do
+			origin = Class.new do
+				extend Loggability
+				log_as :testing
+			end
+			Loggability.level = :warn
+			Loggability.output_to( $stdout )
+			Loggability.format_with( :color )
+
+			Loggability[ origin ].level.should == :warn
+			Loggability[ origin ].logdev.dev.should be( $stdout )
+			Loggability[ origin ].formatter.class.should == Loggability::Formatter::Color
+		end
+
+	end
+
+end
+

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: loggability
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Granger
+autorequire: 
+bindir: bin
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURMRENDQWhTZ0F3SUJB
+  Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREE4TVF3d0NnWURWUVFEREFOblpX
+  UXgKRnpBVkJnb0praWFKay9Jc1pBRVpGZ2RmWVdWeWFXVmZNUk13RVFZS0Na
+  SW1pWlB5TEdRQkdSWURiM0puTUI0WApEVEV3TURreE5qRTBORGcxTVZvWERU
+  RXhNRGt4TmpFME5EZzFNVm93UERFTU1Bb0dBMVVFQXd3RFoyVmtNUmN3CkZR
+  WUtDWkltaVpQeUxHUUJHUllIWDJGbGNtbGxYekVUTUJFR0NnbVNKb21UOGl4
+  a0FSa1dBMjl5WnpDQ0FTSXcKRFFZSktvWklodmNOQVFFQkJRQURnZ0VQQURD
+  Q0FRb0NnZ0VCQUx5Ly9CRnhDMWYvY1BTbnd0SkJXb0ZpRnJpcgpoN1JpY0kr
+  am9xL29jVlhRcUk0VERXUHlGLzh0cWt2dCtyRDk5WDlxczJZZVI4Q1UvWWlJ
+  cExXclFPWVNUNzBKCnZEbjdVdmhiMm11RlZxcTYrdm9iZVRrSUxCRU82cGlv
+  bldERzhqU2JvM3FLbTFSaktKRHdnOXA0d05LaFB1dTgKS0d1ZS9CRmI2N0tm
+  bHF5QXBQbVBlYjNWZGQ5Y2xzcHpxZUZxcDdjVUJNRXBGUzZMV3h5NEdrK3F2
+  RkZKQkpMQgpCVUhFL0xaVkpNVnpmcEM1VXErUW1ZN0IrRkgvUXFObmRuM3RP
+  SGdzUGFkTFROaW11QjFzQ3VMMWE0ejNQZXBkClRlTEJFRm1FYW81RGszSy9R
+  OG84dmxiSUIvakJEVFV4NkRqYmd4dzc3OTA5eDZnSTlkb1U0TEQ1WE1jQ0F3
+  RUEKQWFNNU1EY3dDUVlEVlIwVEJBSXdBREFMQmdOVkhROEVCQU1DQkxBd0hR
+  WURWUjBPQkJZRUZKZW9Ha09yOWw0Qgorc2FNa1cvWlhUNFVlU3ZWTUEwR0NT
+  cUdTSWIzRFFFQkJRVUFBNElCQVFCRzJLT2J2WUkyZUh5eUJVSlNKM2pOCnZF
+  blUzZDYwem5BWGJyU2QycWIzcjFsWTFFUEREM2JjeTBNZ2dDZkdkZzNYdTU0
+  ejIxb3F5SWRrOHVHdFdCUEwKSElhOUVnZkZHU1VFZ3ZjSXZhWXFpTjRqVFV0
+  aWRmRUZ3K0x0anM4QVA5Z1dnU0lZUzZHcjM4VjBXR0ZGTnpJSAphT0Qyd211
+  OW9vL1JmZlc0aFMvOEd1dmZNemN3N0NRMzU1d0ZSNEtCL255emUrRXNaMVk1
+  RGVyQ0FhZ01WdURRClUwQkxtV0RGelBHR1dsUGVRQ3JZSENyK0FjSnorTlJu
+  YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
+  Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
+  cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
+date: 2012-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pluginfactory
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-mercurial
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: hoe-highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: hoe-deveiate
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ! "A composable logging system built on the standard Logger library.\n\nYou
+  can add Loggability to large libraries and systems, then hook everything\nup later
+  when you know where you want logs to be written, at what level of\nseverity, and
+  in which format.\n\nAn example:\n\n    # Load a bunch of libraries\n\trequire 'strelka'\n\trequire
+  'inversion'\n\trequire 'treequel'\n\trequire 'loggability'\n\n    # Now tell everything
+  that's using Loggability to log to an HTML\n\t# log file at INFO level\n\tLoggability.write_to(
+  '/usr/local/www/htdocs/log.html' )\n\tLoggability.format_as( :html )\n\tLoggability.level
+  = :info"
+email:
+- ged@FaerieMUD.org
+executables:
+- loggability
+extensions: []
+extra_rdoc_files:
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- ChangeLog
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/loggability
+- lib/loggability.rb
+- lib/loggability/constants.rb
+- lib/loggability/formatter.rb
+- lib/loggability/formatter/color.rb
+- lib/loggability/formatter/default.rb
+- lib/loggability/formatter/html.rb
+- lib/loggability/logger.rb
+- spec/lib/helpers.rb
+- spec/loggability/formatter/color_spec.rb
+- spec/loggability/formatter/html_spec.rb
+- spec/loggability/formatter_spec.rb
+- spec/loggability/logger_spec.rb
+- spec/loggability_spec.rb
+- .gemtest
+homepage: http://deveiate.org/projects/loggability
+licenses:
+- Ruby
+post_install_message: 
+rdoc_options:
+- -f
+- fivefish
+- -t
+- Loggability Toolkit
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: loggability
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A composable logging system built on the standard Logger library
+test_files: []