flogger 0.1.0 → 0.1.1

data/.gitignore

@@ -4,5 +4,6 @@
 *.gem
 .bundle
 Gemfile.lock
+
 pkg/*
 logs/*

data/CHANGELOG.rdoc

@@ -1,2 +1,6 @@
+*0.1.1) August 21, 2011
+* added error handling when accessing log files
+* changed default log directory from 'log' to 'logs'
+
 *0.1.0* August 20, 2011
 * initial release

data/README.rdoc

@@ -1,34 +1,45 @@
-= FLOGGER
+= FLogger
 
-FLogger is a real simple Ruby-based logging system that outputs to one or many log files. It was created as a learning project for myself, but also something that I could continue to develop and use with future applications.
+FLogger is a really simple Ruby-based logging system that outputs to one or many log files. It was created as a learning project for myself, but also something that I could continue to develop and use with future applications.
 
-== Install
+== Installing
 
-FLogger can currently be installed as a gem by downloading the source from github and executing 'rake install' within its source directory.
+FLogger can be downloaded from source or installed as a gem with the command:
 
-== Usage
+    gem install flogger
 
-Some examples of using FLogger within a simple Ruby application are shown in the examples directory and below. Currently, FLogger can output to various predefined logs (and perhaps more in the future). I suggest checking out the docs directory for a list of methods.
+== Usage and Default
 
-== Example
+Some examples of using FLogger within a simple Ruby application are shown in the examples directory. Currently, FLogger can output to various predefined logs (and perhaps more in the future). By default, all logs are placed in the 'logs' directory within your current working directory. Currently, these are the log types available and their default location:
 
-Here is a simple example of how to use FLogger, but a more detailed example is shown in the examples directory:
+* *Debug:* Default location is logs/debug.txt
+* *Error:* Default location is logs/error.txt
+* *Warning:* Default location is logs/warning.txt
+* *Notice:* Default location is logs/notice.txt
+* *Default:* Default location is logs/log.txt
+
+== Examples
+
+More detailed examples of how to use FLogger can be found in the examples directory. Still, here is a simple example of how to use FLogger to output messages to default log files:
 
     require 'flogger'
     
     log = FLogger::Log.new
     
-    log.debug  'This message will be stored in the debug log.'
-    log.error 'This message will be stored in the error log.'
-    log.puts 'This message will be stored in the default log.'
+    log.debug 'This message will be stored in logs/debug.txt'
+    log.error 'This message will be stored in logs/error.txt'
+    log.puts 'This message will be stored in logs/log.txt'
 
-== Configure
-
-Here is an example that shows how easy it is to specify the location for FLogger to output log files. A more detailed example is shown in the examples directory:
+This example shows how easy it is to specify a location for FLogger to output log files:
 
     log = FLogger::Log.new
     
     log.configure do |c|
-      c.debug = 'logs/debug_log.txt'
-      c.error = 'logs/error_log.txt'
+      c.debug = 'new/logs/debug_log.txt'
+      c.error = 'new/logs/error_log.txt'
+      c.default = 'new/logs/default_log.txt'
     end
+    
+    log.debug 'This message will be stored in new/logs/debug_log.txt'
+    log.error 'This message will be stored in new/logs/error_log.txt'
+    log.puts 'This message will be stored in new/logs/default_log.txt'

data/flogger.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Andre Burdette"]
   s.email       = ["andre@nerdstack.com"]
   s.homepage    = "https://github.com/aburdette/flogger"
-  s.summary     = %q{Outputs log messages to one or many log files}
-  s.description = %q{A simple Ruby-base file logging system}
+  s.summary     = %q{A simple Ruby-based message logging system.}
+  s.description = %q{A simple Ruby-based message logging system that outputs to one or many log files.}
 
   s.rubyforge_project = "flogger"
 

data/lib/flogger/log.rb

@@ -7,11 +7,11 @@ module FLogger
     
     def initialize
       @logs = OpenStruct.new(
-        :debug    => 'log/debug.txt',
-        :error    => 'log/error.txt',
-        :warning  => 'log/warning.txt',
-        :notice   => 'log/notice.txt',
-        :default  => 'log/logs.txt'
+        :debug    => 'logs/debug.txt',
+        :error    => 'logs/error.txt',
+        :warning  => 'logs/warning.txt',
+        :notice   => 'logs/notice.txt',
+        :default  => 'logs/log.txt'
       )
     end
     
@@ -19,22 +19,27 @@ module FLogger
       block.call(@logs)
     end
     
+    # output to debug log, default: logs/debug.txt
     def debug(msg)
       output open(@logs.debug), msg
     end
     
+    # output to error log, default: logs/error.txt
     def error(msg)
       output open(@logs.error), msg
     end
     
+    # output to warning log, default: logs/warning.txt
     def warning(msg)
       output open(@logs.warning), msg
     end
     
+    # output to notice log, default: logs/notice.txt
     def notice(msg)
       output open(@logs.notice), msg
     end
     
+    # output to log, default: logs/log.txt
     def puts(msg)
       output open(@logs.default), msg
     end
@@ -43,15 +48,25 @@ module FLogger
     
     # access the needed log file
     def open(log_file)
-      log_path = File.dirname(log_file)
-      FileUtils.mkdir_p(log_path) unless File.exists? log_file
-      File.open(log_file, 'a')
+      begin
+        log_path = File.dirname(log_file)
+        FileUtils.mkdir_p(log_path) unless File.exists? log_file
+        File.open(log_file, 'a')
+      rescue Exception => e
+        print e.message << "\r\n"
+      end
     end
     
-    # output message into log file
+    # output message to log file
     def output(log, msg)
-      log.puts "[#{Time.now.asctime}] #{msg}"
-      log.close
+      if log
+        begin
+          log.puts "[#{Time.now.asctime}] #{msg}"
+          log.close
+        rescue Exception => e
+          print e.message << "\r\n"
+        end
+      end
     end
   end
 end

data/lib/flogger/version.rb

@@ -1,3 +1,3 @@
 module FLogger
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flogger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,8 @@ bindir: bin
 cert_chain: []
 date: 2011-08-20 00:00:00.000000000Z
 dependencies: []
-description: A simple Ruby-base file logging system
+description: A simple Ruby-based message logging system that outputs to one or many
+  log files.
 email:
 - andre@nerdstack.com
 executables: []
@@ -23,16 +24,6 @@ files:
 - Gemfile
 - README.rdoc
 - Rakefile
-- doc/CHANGELOG_rdoc.html
-- doc/FLogger.html
-- doc/FLogger/Log.html
-- doc/README_rdoc.html
-- doc/created.rid
-- doc/index.html
-- doc/lib/flogger/log_rb.html
-- doc/lib/flogger/version_rb.html
-- doc/lib/flogger_rb.html
-- doc/rdoc.css
 - examples/custom_output.rb
 - examples/default_output.rb
 - flogger.gemspec
@@ -62,5 +53,5 @@ rubyforge_project: flogger
 rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
-summary: Outputs log messages to one or many log files
+summary: A simple Ruby-based message logging system.
 test_files: []

data/doc/CHANGELOG_rdoc.html

@@ -1,97 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-	<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
-
-	<title>File: CHANGELOG.rdoc [RDoc Documentation]</title>
-
-	<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
-
-	<script src="./js/jquery.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="./js/thickbox-compressed.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="./js/quicksearch.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="./js/darkfish.js" type="text/javascript"
-		charset="utf-8"></script>
-</head>
-
-<body class="file">
-	<div id="metadata">
-		<div id="home-metadata">
-			<div id="home-section" class="section">
-        <h3 class="section-header">
-          <a href="./index.html">Home</a>
-          <a href="./index.html#classes">Classes</a>
-          <a href="./index.html#methods">Methods</a>
-        </h3>
-			</div>
-		</div>
-
-		<div id="project-metadata">
-			
-			
-			<div id="fileindex-section" class="section project-section">
-				<h3 class="section-header">Files</h3>
-				<ul>
-				
-					<li class="file"><a href="./CHANGELOG_rdoc.html">CHANGELOG.rdoc</a></li>
-				
-					<li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
-				
-				</ul>
-			</div>
-			
-
-			<div id="classindex-section" class="section project-section">
-				<h3 class="section-header">Class Index
-					<span class="search-toggle"><img src="./images/find.png"
-						height="16" width="16" alt="[+]"
-						title="show/hide quicksearch" /></span></h3>
-				<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
-				<fieldset>
-					<legend>Quicksearch</legend>
-					<input type="text" name="quicksearch" value=""
-						class="quicksearch-field" />
-				</fieldset>
-				</form>
-
-				<ul class="link-list">
-				
-					<li><a href="./FLogger.html">FLogger</a></li>
-				
-					<li><a href="./FLogger/Log.html">FLogger::Log</a></li>
-				
-				</ul>
-				<div id="no-class-search-results" style="display: none;">No matching classes.</div>
-			</div>
-
-			
-		</div>
-	</div>
-
-	<div id="documentation">
-		<p>
-<b>0.1.0</b> August 20, 2011
-</p>
-<ul>
-<li><p>
-initial release
-</p>
-</li>
-</ul>
-
-	</div>
-
-	<div id="validator-badges">
-		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
-			Rdoc Generator</a> 1.1.6</small>.</p>
-	</div>
-</body>
-</html>
-

data/doc/FLogger.html

@@ -1,168 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-	<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
-
-	<title>Module: FLogger</title>
-
-	<link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
-
-	<script src="./js/jquery.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="./js/thickbox-compressed.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="./js/quicksearch.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="./js/darkfish.js" type="text/javascript"
-		charset="utf-8"></script>
-
-</head>
-<body class="module">
-
-	<div id="metadata">
-		<div id="home-metadata">
-			<div id="home-section" class="section">
-        <h3 class="section-header">
-          <a href="./index.html">Home</a>
-          <a href="./index.html#classes">Classes</a>
-          <a href="./index.html#methods">Methods</a>
-        </h3>
-			</div>
-		</div>
-
-		<div id="file-metadata">
-			<div id="file-list-section" class="section">
-				<h3 class="section-header">In Files</h3>
-				<div class="section-body">
-					<ul>
-					
-						<li><a href="./lib/flogger/version_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
-							class="thickbox" title="lib/flogger/version.rb">lib/flogger/version.rb</a></li>
-					
-						<li><a href="./lib/flogger/log_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
-							class="thickbox" title="lib/flogger/log.rb">lib/flogger/log.rb</a></li>
-					
-						<li><a href="./lib/flogger_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
-							class="thickbox" title="lib/flogger.rb">lib/flogger.rb</a></li>
-					
-					</ul>
-				</div>
-			</div>
-
-			
-		</div>
-
-		<div id="class-metadata">
-
-			<!-- Parent Class -->
-			
-
-			<!-- Namespace Contents -->
-			
-			<div id="namespace-list-section" class="section">
-				<h3 class="section-header">Namespace</h3>
-				<ul class="link-list">
-					
-					<li><span class="type">CLASS</span> <a href="FLogger/Log.html">FLogger::Log</a></li>
-					
-				</ul>
-			</div>
-			
-
-			<!-- Method Quickref -->
-			
-
-			<!-- Included Modules -->
-			
-		</div>
-
-		<div id="project-metadata">
-			
-			
-			<div id="fileindex-section" class="section project-section">
-				<h3 class="section-header">Files</h3>
-				<ul>
-				
-					<li class="file"><a href="./CHANGELOG_rdoc.html">CHANGELOG.rdoc</a></li>
-				
-					<li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
-				
-				</ul>
-			</div>
-			
-
-			<div id="classindex-section" class="section project-section">
-				<h3 class="section-header">Class Index
-					<span class="search-toggle"><img src="./images/find.png"
-						height="16" width="16" alt="[+]"
-						title="show/hide quicksearch" /></span></h3>
-				<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
-				<fieldset>
-					<legend>Quicksearch</legend>
-					<input type="text" name="quicksearch" value=""
-						class="quicksearch-field" />
-				</fieldset>
-				</form>
-
-				<ul class="link-list">
-				
-					<li><a href="./FLogger.html">FLogger</a></li>
-				
-					<li><a href="./FLogger/Log.html">FLogger::Log</a></li>
-				
-				</ul>
-				<div id="no-class-search-results" style="display: none;">No matching classes.</div>
-			</div>
-
-			
-		</div>
-	</div>
-
-	<div id="documentation">
-		<h1 class="module">FLogger</h1>
-
-		<div id="description">
-			
-		</div>
-
-		<!-- Constants -->
-		
-		<div id="constants-list" class="section">
-			<h3 class="section-header">Constants</h3>
-			<dl>
-			
-				<dt><a name="VERSION">VERSION</a></dt>
-				
-				<dd class="description"></dd>
-				
-			
-			</dl>
-		</div>
-		
-
-		<!-- Attributes -->
-		
-
-		<!-- Methods -->
-		
-
-	</div>
-
-
-	<div id="rdoc-debugging-section-dump" class="debugging-section">
-	
-		<p>Disabled; run with --debug to generate this.</p>
-	
-	</div>
-
-	<div id="validator-badges">
-		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
-			Rdoc Generator</a> 1.1.6</small>.</p>
-	</div>
-
-</body>
-</html>
-