loggability 0.0.1 → 0.0.2

data/History.rdoc

@@ -1,4 +1,9 @@
-== v0.0.1 [2012-04-06] Michael Granger <ged@FaerieMUD.org>
+== v0.0.2 [2012-05-07] Michael Granger <ged@FaerieMUD.org>
+
+Fix escaping of the 'progname' in the HTML formatter.
+
+
+== v0.0.1 [2012-05-06] Michael Granger <ged@FaerieMUD.org>
 
 First release.
 

data/README.rdoc

@@ -16,17 +16,33 @@ severity, and in which format.
 
 An example:
 
-    # Load a bunch of libraries
-	require 'strelka'
-	require 'inversion'
-	require 'treequel'
-	require 'loggability'
-
+    # Load a bunch of libraries that use Loggability
+    require 'strelka'
+    require 'inversion'
+    require 'treequel'
+    require 'loggability'
+    
+    # Set up our own library
+    module MyProject
+        extend Loggability
+        log_as :my_project
+    
+        class Server
+            extend Loggability
+            log_to :my_project
+    
+            def initialize
+                self.log.debug "Listening."
+            end
+        end
+    
+    end
+    
     # Now tell everything that's using Loggability to log to an HTML
-	# log file at INFO level
-	Loggability.write_to( '/usr/local/www/htdocs/log.html' )
-	Loggability.format_as( :html )
-	Loggability.level = :info
+    # log file at INFO level
+    Loggability.write_to( '/usr/local/www/htdocs/log.html' )
+    Loggability.format_as( :html )
+    Loggability.level = :info
 
 
 == Prerequisites

data/lib/loggability/formatter/html.rb

@@ -39,6 +39,12 @@ class Loggability::Formatter::HTML < Loggability::Formatter
 	end
 
 
+	### Format the +message+; Overridden to escape the +progname+.
+	def call( severity, time, progname, message )
+		super( severity, time, escape_html(progname), message )
+	end
+
+
 	#########
 	protected
 	#########
@@ -66,6 +72,7 @@ class Loggability::Formatter::HTML < Loggability::Formatter
 
 	### Escape any HTML special characters in +string+.
 	def escape_html( string )
+		return string unless string.respond_to?( :gsub )
 		return string.
 			gsub( '&', '&amp;' ).
 			gsub( '<', '&lt;'  ).

data/lib/loggability.rb

@@ -10,10 +10,10 @@ require 'date'
 module Loggability
 
 	# Package version constant
-	VERSION = '0.0.1'
+	VERSION = '0.0.2'
 
 	# VCS revision
-	REVISION = %q$Revision: 7b3fcf97718a $
+	REVISION = %q$Revision: 1099204b229f $
 
 	# The key for the global logger (Loggability's own logger)
 	GLOBAL_KEY = :__global__

data/spec/lib/helpers.rb

@@ -28,8 +28,6 @@ require 'loggability' unless defined?( Loggability )
 #
 module Loggability::SpecHelpers
 
-	
-
 end # Loggability::SpecHelpers
 
 

data/spec/loggability/formatter/html_spec.rb

@@ -19,8 +19,8 @@ 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
+		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
@@ -38,8 +38,15 @@ describe Loggability::Formatter::HTML do
 	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>}
+		subject.call( 'INFO', Time.at(1336286481), nil, Object.new ).
+			should =~ %r{<span class=\"log-message-text\">#&lt;Object:0x\p{XDigit}+&gt;</span>}
 	end
+
+	it "escapes the 'progname' part of log messages" do
+		progname = "#<Class:0x007f9efa153d08>:0x7f9efa153c18"
+		subject.call( 'DEBUG', Time.at(1336286481), progname, Object.new ).
+			should =~ %r{#&lt;Class:0x0}
+	end
+
 end
 

data.tar.gz.sig

@@ -1,4 +1,2 @@
-���t̛AJ&ڷ��qIi5=Q�J5ء���	��Q�����47y�/�m�&	��GNŒQ�S
9�[�P��}
-��-���؃y��e}B�Z�n�s���tp�>����˗zE(���8�
����iG���Ibv�P=1v���ȴ�gt
-&̿�!�����]��� ��\3F�[�4���ݬ�m�7�;rw�{y� �Aӧ"��bNQ�]���
-:2T���av]'hu������&
+_���E��O���p7��.t�"�M0z�M�U���@��*WZJLI��#4-l[~�˩l�H(�u��:gP�n+��f��ۜ|�{M+�k��u��l����.��eʔ�lzX���B��.�<�ʳ�C<��h�Q�2g#
+��ss�Y�7

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggability
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-05-06 00:00:00.000000000 Z
+date: 2012-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pluginfactory
@@ -153,11 +153,15 @@ dependencies:
 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"
+  in which format.\n\nAn example:\n\n    # Load a bunch of libraries that use Loggability\n
+  \   require 'strelka'\n    require 'inversion'\n    require 'treequel'\n    require
+  'loggability'\n    \n    # Set up our own library\n    module MyProject\n        extend
+  Loggability\n        log_as :my_project\n    \n        class Server\n            extend
+  Loggability\n            log_to :my_project\n    \n            def initialize\n
+  \               self.log.debug \"Listening.\"\n            end\n        end\n    \n
+  \   end\n    \n    # Now tell everything that's using Loggability to log to an HTML\n
+  \   # log file at INFO level\n    Loggability.write_to( '/usr/local/www/htdocs/log.html'
+  )\n    Loggability.format_as( :html )\n    Loggability.level = :info"
 email:
 - ged@FaerieMUD.org
 executables: