flogger 0.2.1 → 0.2.2

data/.gitignore

@@ -1,11 +1,7 @@
 *~
-.DS_Store
-Thumbs.db
-
 *.gem
+.rvmrc
 .bundle
 Gemfile.lock
-
-db/*
 pkg/*
 logs/*

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+*0.2.2* September 6, 2011
+* the old <tt>default</tt> is now renamed to <tt>application</tt>
+* the new <tt>default</tt> now points to a default log specified on <tt>Log#new</tt>
+* by default, <tt>Log#clear</tt> clears the log file pointed to by <tt>default</tt>
+
 *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

data/README.rdoc

@@ -18,12 +18,13 @@ Currently, FLogger can output to various predefined logs (and perhaps more in th
 
     @log = FLogger::Log.new do |c|
         c.debug = 'new/path/to/debug.log'
-        c.default = 'new/path/to/default.log'
+        c.warning = 'new/path/to/warning.log'
     end
 
-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):
+By default, FLogger outputs messages formatted with a preceding date/time to the application log file. To change these defaults, specify a your changes during initialization (Note: <tt>%s</tt> will be replaced with the log message):
 
     @log = FLogger::Log.new do |c|
+        c.default = :warning
         c.format = "#> %s"
     end
 
@@ -43,8 +44,8 @@ There are a few more detailed examples in the examples directory. However, below
 
 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>
+*debug*:: For general software debug messages - defaults to <tt>logs/debug.txt</tt>
+*error*:: For application error messages - defaults to <tt>logs/error.txt</tt>
+*notice*:: For general notification messages - defaults to <tt>logs/notice.txt</tt>
+*warning*:: For application warning messages - defaults to <tt>logs/warning.txt</tt>
+*application*:: General purpose application log messages - defaults to <tt>logs/application.txt</tt>

data/examples/clear_logs.rb

@@ -18,9 +18,8 @@ class LogFiller
         # clear specific logs
         @log.clear :debug
         @log.clear :error
-        @log.clear :default
         
-        # or clear all logs
+        # clear default log
         @log.clear
     end
 end

data/examples/custom_output.rb

@@ -2,11 +2,15 @@ require 'flogger'
 
 class LogFiller
     def initialize
-        # initialize with custom paths
         @log = FLogger::Log.new do |c|
+            # initialize with custom paths
             c.debug = 'custom/log/path/debug.log'
             c.error = 'custom/log/path/error.log'
-            c.default = 'custom/log/path/application.log'
+            c.warning = 'custom/log/path/warning.log'
+            
+            # initialize with custom settings
+            c.default = :warning
+            c.format = "#> %s"
         end
     end
     
@@ -14,7 +18,7 @@ class LogFiller
         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."
+            @log.puts "#{count} - This is logged as a warning message."
         end
     end
 end

data/flogger.gemspec

@@ -16,8 +16,10 @@ Gem::Specification.new do |s|
     s.files         = `git ls-files`.split("\n")
     s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
     s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+    
     s.require_paths = [ 'lib' ]
+    s.extra_rdoc_files = [ 'README.rdoc', 'CHANGELOG.rdoc' ]
     
-    s.required_ruby_version = '~> 1.9.2'
-    s.add_development_dependency 'rspec', '~> 2.6.0'
+    s.required_ruby_version = '>= 1.9.2'
+    s.add_development_dependency 'rspec', '>= 2.6.0'
 end

data/lib/flogger.rb

@@ -2,7 +2,6 @@ require 'flogger/log'
 
 module FLogger
     autoload :VERSION, 'flogger/version'
-    autoload :File, 'flogger/ext/file'
     
     # output a deprecation error message
     def self.output_deprecation(version, method)

data/lib/flogger/log.rb

@@ -1,19 +1,21 @@
 require 'ostruct'
+require 'fileutils'
 
 module FLogger
     class Log
         attr_reader :config
         
         def initialize
-            # set default configuration
             @config = OpenStruct.new(
+                # set default log paths
                 :debug => 'logs/debug.txt',
                 :error => 'logs/error.txt',
                 :notice => 'logs/notice.txt',
                 :warning => 'logs/warning.txt',
-                :default => 'logs/application.txt',
+                :application => 'logs/application.txt',
                 
-                # default format for log output
+                # set default log output settings
+                :default => :application,
                 :format => "[#{Time.now.asctime}] %s"
             )
             
@@ -53,7 +55,7 @@ module FLogger
         
         # outputs to log file
         # default: logs/application.txt
-        def puts(type = :default, message)
+        def puts(type = @config.default, message)
             return if message.empty?
             
             case type
@@ -69,22 +71,22 @@ module FLogger
                 when :warning
                     output_to_log(@config.warning, message)
                 
-                when :default
-                    output_to_log(@config.default, message)
+                when :application
+                    output_to_log(@config.application, message)
                 
                 else
                     $stderr.puts "Log type not supported."
             end
         end
         
-        def clear(type = :all)
+        def clear(type = @config.default)
             case type
                 when :all
                     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
+                    clear_log_contents @config.application
                 
                 when :debug
                     clear_log_contents @config.debug
@@ -98,8 +100,8 @@ module FLogger
                 when :warning
                     clear_log_contents @config.warning
                 
-                when :default
-                    clear_log_contents @config.default
+                when :application
+                    clear_log_contents @config.application
                     
                 else
                     $stderr.puts "Log type not supported."
@@ -112,7 +114,12 @@ module FLogger
             return if message.empty?
             
             begin
-                log_file = File.open_or_create(file, 'a')
+                unless File.exists?(file)
+                    path = File.dirname(file)
+                    FileUtils.mkdir_p(path)
+                end
+                
+                log_file = File.open(file, 'a')
                 log_file.puts(@config.format % message)
                 log_file.close
             rescue Exception => e

data/lib/flogger/version.rb

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

data/specs/log_spec.rb

@@ -1,5 +1,4 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'spec_helper'
+require './specs/spec_helper'
 
 describe FLogger::Log do
     before :all do
@@ -16,7 +15,8 @@ describe FLogger::Log do
             @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.application.should eql 'logs/application.txt'
+            @log.config.default.should eql :application
             @log.config.format.should eql "[#{Time.now.asctime}] %s"
         end
         
@@ -26,7 +26,8 @@ describe FLogger::Log do
                 c.error = 'custom error log'
                 c.notice = 'custom notice log'
                 c.warning = 'custom warning log'
-                c.default = 'custom default log'
+                c.application = 'custom application log'
+                c.default = :warning
                 c.format = "#> %s"
             end
             
@@ -34,7 +35,8 @@ describe FLogger::Log do
             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.application.should eql 'custom application log'
+            log.config.default.should eql :warning
             log.config.format.should eql "#> %s"
         end
     end
@@ -60,28 +62,24 @@ describe FLogger::Log do
             @log.puts :warning, 'warning message'
         end
         
+        it 'outputs to application log file' do
+            @log.should_receive(:output_to_log).with(@log.config.application, 'application message')
+            @log.puts :application, 'application 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'
+            @log.should_receive(:output_to_log).with(@log.config.application, 'default message')
+            @log.puts 'default 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.should_receive(:clear_log_contents).with(@log.config.application)
             @log.clear :all
         end
         
@@ -105,9 +103,14 @@ describe FLogger::Log do
             @log.clear :warning
         end
         
-        it 'clears the default log' do
-            @log.should_receive(:clear_log_contents).with(@log.config.default)
-            @log.clear :default
+        it 'clears the application log' do
+            @log.should_receive(:clear_log_contents).with(@log.config.application)
+            @log.clear :application
+        end
+        
+        it 'clears the default log with no parameter' do
+            @log.should_receive(:clear_log_contents).with(@log.config.application)
+            @log.clear
         end
     end
 end

metadata

@@ -1,98 +1,72 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: flogger
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 0.2.2
   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 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &11152440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.6.0
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *11152440
 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: 
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG.rdoc
+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
 - lib/flogger.rb
-- 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: 
-  - - ~>
-    - !ruby/object:Gem::Version 
-      hash: 55
-      segments: 
-      - 1
-      - 9
-      - 2
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: flogger
-rubygems_version: 1.8.10
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Simple Ruby-based logger with file output.
 test_files: []
-

data/examples/custom_format.rb

@@ -1,22 +0,0 @@
-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/lib/flogger/ext/file.rb

@@ -1,14 +0,0 @@
-require 'fileutils'
-
-class File
-    # create a file if it doesn't already exist
-    def self.open_or_create(file, access)
-        begin
-            path = File.dirname(file)
-            FileUtils.mkdir_p(path) unless File.exists?(file)
-            File.open(file, access)
-        rescue Exception => e
-            $stderr.puts e.message
-        end
-    end
-end