flogger 0.2.0 → 0.2.1

data/CHANGELOG.rdoc

@@ -1,15 +1,20 @@
+*0.2.1* September 3, 2011
+* method <tt>Log#clear</tt> now clears all logs by default
+* the output format of log messages can now be customized
+* <tt>logpaths</tt> is now <tt>config</tt> to prepare for future changes
+
 *0.2.0* September 3, 2011
-* all log output is now done though the Log#puts method
-* custom log paths are now applied during Log#new initialization
+* all log output is now done though the <tt>Log#puts</tt> method
+* custom log paths are now applied during <tt>Log#new</tt> initialization
 * most methods have been deprecated, please check the documentation[https://rubygems.org/gems/flogger]
 
 *0.1.2* August 21, 2011
-* added ability to clear contents of existing log files
-* changed default log file to 'logs/application.txt'
+* added <tt>Log#clear</tt> to clear contents of existing log files
+* changed default log file to <tt>logs/application.txt</tt>
 
 *0.1.1* August 20, 2011
-* added error handling when accessing log files
-* changed default log directory from 'log' to 'logs'
+* added basic error handling when accessing log files
+* changed default log directory from <tt>log</tt> to <tt>logs</tt>
 
 *0.1.0* August 20, 2011
 * initial release

data/README.rdoc

@@ -14,14 +14,20 @@ Or you can check out the latest source code via Github:
 
 == Usage and Defaults
 
-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. To change the default path, specify a different one during initialization:
+Currently, FLogger can output to various predefined logs (and perhaps more in the future). By default, all logs are placed in the <tt>logs</tt> directory within your current working directory. To change the default path, specify a different one during initialization:
 
-    @log = FLogger::Log.new do |paths|
-        paths.debug = 'new/path/to/debug.log'
-        paths.default = 'new/path/to/default.log'
+    @log = FLogger::Log.new do |c|
+        c.debug = 'new/path/to/debug.log'
+        c.default = 'new/path/to/default.log'
     end
 
-== Examples
+By default, FLogger outputs a message formatted with a preceding date/time slug. To customize the default format of messages, specify a different format during initialization (Note: <tt>%s</tt> will be replaced with the log message):
+
+    @log = FLogger::Log.new do |c|
+        c.format = "#> %s"
+    end
+
+== Example
 
 There are a few more detailed examples in the examples directory. However, below is a simple example of using FLogger to output log messages:
 
@@ -32,3 +38,13 @@ There are a few more detailed examples in the examples directory. However, below
     log.puts :debug, 'This message will output to logs/debug.txt by default.'
     log.puts :error, 'This message will output to logs/error.txt by default.'
     log.puts 'This message will output to logs/application.txt by default.'
+
+== Log Types
+
+Currently, there are 4 specific log types, and 1 generic:
+
+<b>debug</b>: General application debug messages - defaults to <tt>logs/debug.txt</tt>
+<b>error</b>: For general application error messages - defaults to <tt>logs/error.txt</tt>
+<b>notice</b>: For general notification messages - defaults to <tt>logs/notice.txt</tt>
+<b>warning</b>: For application warning messages - defaults to <tt>logs/warning.txt</tt>
+<b>default</b>: General purpose log file if no other is desired - defaults to <tt>logs/application.txt</tt>

data/examples/clear_logs.rb

@@ -2,7 +2,7 @@ require 'flogger'
 
 class LogFiller
     def initialize
-        # initialize with default paths
+        # initialize with defaults
         @log = FLogger::Log.new
     end
     
@@ -14,8 +14,14 @@ class LogFiller
         end
     end
     
-    def clear(type = :all)
-        @log.clear type
+    def clear
+        # clear specific logs
+        @log.clear :debug
+        @log.clear :error
+        @log.clear :default
+        
+        # or clear all logs
+        @log.clear
     end
 end
 
@@ -23,8 +29,5 @@ end
 log_filler = LogFiller.new
 log_filler.fill
 
-# clear just the debug log
-log_filler.clear :debug
-
-# clear all logs
+# clear logs
 log_filler.clear

data/examples/custom_format.rb

@@ -0,0 +1,22 @@
+require 'flogger'
+
+class LogFiller
+    def initialize
+        # initialize with custom log format
+        @log = FLogger::Log.new do |c|
+            c.format = "#> %s"
+        end
+    end
+    
+    def fill
+        100.times do |count|
+            @log.puts :debug, "#{count} - This is logged as a debug message."
+            @log.puts :error, "#{count} - This is logged as an error message."
+            @log.puts "#{count} - This is logged as an application message."
+        end
+    end
+end
+
+# create and fill logs
+log_filler = LogFiller.new
+log_filler.fill

data/examples/custom_output.rb

@@ -3,10 +3,10 @@ require 'flogger'
 class LogFiller
     def initialize
         # initialize with custom paths
-        @log = FLogger::Log.new do |paths|
-            paths.debug = 'custom/log/path/debug.log'
-            paths.error = 'custom/log/path/error.log'
-            paths.default = 'custom/log/path/application.log'
+        @log = FLogger::Log.new do |c|
+            c.debug = 'custom/log/path/debug.log'
+            c.error = 'custom/log/path/error.log'
+            c.default = 'custom/log/path/application.log'
         end
     end
     

data/examples/default_output.rb

@@ -2,7 +2,7 @@ require 'flogger'
 
 class LogFiller
     def initialize
-        # initialize with default paths
+        # initialize with defaults
         @log = FLogger::Log.new
     end
     

data/flogger.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |s|
     s.require_paths = [ 'lib' ]
     
     s.required_ruby_version = '~> 1.9.2'
-    s.add_development_dependency 'rspec'
+    s.add_development_dependency 'rspec', '~> 2.6.0'
 end

data/lib/flogger/log.rb

@@ -2,20 +2,23 @@ require 'ostruct'
 
 module FLogger
     class Log
-        attr_reader :logpaths
+        attr_reader :config
         
         def initialize
-            # set default log paths
-            @logpaths = OpenStruct.new(
-                :debug    => 'logs/debug.txt',
-                :error    => 'logs/error.txt',
-                :notice   => 'logs/notice.txt',
-                :warning  => 'logs/warning.txt',
-                :default  => 'logs/application.txt'
+            # set default configuration
+            @config = OpenStruct.new(
+                :debug => 'logs/debug.txt',
+                :error => 'logs/error.txt',
+                :notice => 'logs/notice.txt',
+                :warning => 'logs/warning.txt',
+                :default => 'logs/application.txt',
+                
+                # default format for log output
+                :format => "[#{Time.now.asctime}] %s"
             )
             
-            # yield to custom log paths
-            yield @logpaths if block_given?
+            # yield to custom configuration
+            yield @config if block_given?
         end
         
         # deprecated: use Log#new
@@ -55,48 +58,48 @@ module FLogger
             
             case type
                 when :debug
-                    output_to_log(@logpaths.debug, message)
+                    output_to_log(@config.debug, message)
                 
                 when :error
-                    output_to_log(@logpaths.error, message)
+                    output_to_log(@config.error, message)
                 
                 when :notice
-                    output_to_log(@logpaths.notice, message)
+                    output_to_log(@config.notice, message)
                 
                 when :warning
-                    output_to_log(@logpaths.warning, message)
+                    output_to_log(@config.warning, message)
                 
                 when :default
-                    output_to_log(@logpaths.default, message)
+                    output_to_log(@config.default, message)
                 
                 else
                     $stderr.puts "Log type not supported."
             end
         end
         
-        def clear(type = :default)
+        def clear(type = :all)
             case type
                 when :all
-                    clear_log_contents @logpaths.debug
-                    clear_log_contents @logpaths.error
-                    clear_log_contents @logpaths.notice
-                    clear_log_contents @logpaths.warning
-                    clear_log_contents @logpaths.default
+                    clear_log_contents @config.debug
+                    clear_log_contents @config.error
+                    clear_log_contents @config.notice
+                    clear_log_contents @config.warning
+                    clear_log_contents @config.default
                 
                 when :debug
-                    clear_log_contents @logpaths.debug
+                    clear_log_contents @config.debug
                 
                 when :error
-                    clear_log_contents @logpaths.error
+                    clear_log_contents @config.error
                 
                 when :notice
-                    clear_log_contents @logpaths.notice
+                    clear_log_contents @config.notice
                 
                 when :warning
-                    clear_log_contents @logpaths.warning
+                    clear_log_contents @config.warning
                 
                 when :default
-                    clear_log_contents @logpaths.default
+                    clear_log_contents @config.default
                     
                 else
                     $stderr.puts "Log type not supported."
@@ -110,7 +113,7 @@ module FLogger
             
             begin
                 log_file = File.open_or_create(file, 'a')
-                log_file.puts "[#{Time.now.asctime}] #{message}"
+                log_file.puts(@config.format % message)
                 log_file.close
             rescue Exception => e
                 $stderr.puts e.message

data/lib/flogger/version.rb

@@ -1,3 +1,3 @@
 module FLogger
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
 end

data/specs/log_spec.rb

@@ -0,0 +1,113 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'spec_helper'
+
+describe FLogger::Log do
+    before :all do
+        @log = FLogger::Log.new
+    end
+    
+    describe '#new' do
+        it 'returns a new log object' do
+            @log.should be_an_instance_of FLogger::Log
+        end
+        
+        it 'sets default configurations' do
+            @log.config.debug.should eql 'logs/debug.txt'
+            @log.config.error.should eql 'logs/error.txt'
+            @log.config.notice.should eql 'logs/notice.txt'
+            @log.config.warning.should eql 'logs/warning.txt'
+            @log.config.default.should eql 'logs/application.txt'
+            @log.config.format.should eql "[#{Time.now.asctime}] %s"
+        end
+        
+        it 'sets custom configurations' do
+            log = FLogger::Log.new do |c|
+                c.debug = 'custom debug log'
+                c.error = 'custom error log'
+                c.notice = 'custom notice log'
+                c.warning = 'custom warning log'
+                c.default = 'custom default log'
+                c.format = "#> %s"
+            end
+            
+            log.config.debug.should eql 'custom debug log'
+            log.config.error.should eql 'custom error log'
+            log.config.notice.should eql 'custom notice log'
+            log.config.warning.should eql 'custom warning log'
+            log.config.default.should eql 'custom default log'
+            log.config.format.should eql "#> %s"
+        end
+    end
+    
+    describe '#puts' do
+        it 'outputs to debug log' do
+            @log.should_receive(:output_to_log).with(@log.config.debug, 'debug message')
+            @log.puts :debug, "debug message"
+        end
+        
+        it 'outputs to error log' do
+            @log.should_receive(:output_to_log).with(@log.config.error, 'error message')
+            @log.puts :error, 'error message'
+        end
+        
+        it 'outputs to notice log' do
+            @log.should_receive(:output_to_log).with(@log.config.notice, 'notice message')
+            @log.puts :notice, 'notice message'
+        end
+        
+        it 'outputs to warning log' do
+            @log.should_receive(:output_to_log).with(@log.config.warning, 'warning message')
+            @log.puts :warning, 'warning message'
+        end
+        
+        it 'outputs to default log file' do
+            @log.should_receive(:output_to_log).with(@log.config.default, 'application message')
+            @log.puts 'application message'
+        end
+    end
+    
+    describe '#clear' do
+        it 'clears all logs by default' do
+            @log.should_receive(:clear_log_contents).with(@log.config.debug)
+            @log.should_receive(:clear_log_contents).with(@log.config.error)
+            @log.should_receive(:clear_log_contents).with(@log.config.notice)
+            @log.should_receive(:clear_log_contents).with(@log.config.warning)
+            @log.should_receive(:clear_log_contents).with(@log.config.default)
+            @log.clear
+        end
+        
+        it 'clears all logs' do
+            @log.should_receive(:clear_log_contents).with(@log.config.debug)
+            @log.should_receive(:clear_log_contents).with(@log.config.error)
+            @log.should_receive(:clear_log_contents).with(@log.config.notice)
+            @log.should_receive(:clear_log_contents).with(@log.config.warning)
+            @log.should_receive(:clear_log_contents).with(@log.config.default)
+            @log.clear :all
+        end
+        
+        it 'clears the debug log' do
+            @log.should_receive(:clear_log_contents).with(@log.config.debug)
+            @log.clear :debug
+        end
+        
+        it 'clears the error log' do
+            @log.should_receive(:clear_log_contents).with(@log.config.error)
+            @log.clear :error
+        end
+        
+        it 'clears the notice log' do
+            @log.should_receive(:clear_log_contents).with(@log.config.notice)
+            @log.clear :notice
+        end
+        
+        it 'clears the warning log' do
+            @log.should_receive(:clear_log_contents).with(@log.config.warning)
+            @log.clear :warning
+        end
+        
+        it 'clears the default log' do
+            @log.should_receive(:clear_log_contents).with(@log.config.default)
+            @log.clear :default
+        end
+    end
+end

data/specs/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'flogger/log'
+

metadata

@@ -1,40 +1,55 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: flogger
-version: !ruby/object:Gem::Version
-  version: 0.2.0
+version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
 platform: ruby
-authors:
+authors: 
 - Andre Burdette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-03 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-09-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &84575300 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
   type: :development
-  prerelease: false
-  version_requirements: *84575300
+  version_requirements: *id001
 description: Simple Ruby-based logger that can output to one or several log files.
-email:
+email: 
 - andre@nerdstack.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - CHANGELOG.rdoc
 - Gemfile
 - README.rdoc
 - Rakefile
 - examples/clear_logs.rb
+- examples/custom_format.rb
 - examples/custom_output.rb
 - examples/default_output.rb
 - flogger.gemspec
@@ -42,28 +57,42 @@ files:
 - lib/flogger/ext/file.rb
 - lib/flogger/log.rb
 - lib/flogger/version.rb
+- specs/log_spec.rb
+- specs/spec_helper.rb
 homepage: https://github.com/aburdette/flogger
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
+  requirements: 
   - - ~>
-    - !ruby/object:Gem::Version
+    - !ruby/object:Gem::Version 
+      hash: 55
+      segments: 
+      - 1
+      - 9
+      - 2
       version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: flogger
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Simple Ruby-based logger with file output.
 test_files: []
+