flogger 0.1.1 → 0.1.2

data/CHANGELOG.rdoc

@@ -1,4 +1,8 @@
-*0.1.1) August 21, 2011
+*0.1.2* August 21, 2011
+* added ability to clear contents of existing log files
+* changed default log file to 'logs/application.txt'
+
+*0.1.1* August 20, 2011
 * added error handling when accessing log files
 * changed default log directory from 'log' to 'logs'
 

data/README.rdoc

@@ -1,6 +1,7 @@
 = FLogger
 
-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.
+FLogger (or File Logger) 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.
+
 
 == Installing
 
@@ -8,15 +9,17 @@ FLogger can be downloaded from source or installed as a gem with the command:
 
     gem install flogger
 
+
 == Usage and Default
 
 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:
 
-* *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
+* *debug:* Default location is logs/debug.txt
+* *error:* Default location is logs/error.txt
+* *notice:* Default location is logs/notice.txt
+* *warning:* Default location is logs/warning.txt
+* *default:* Default location is logs/application.txt
+
 
 == Examples
 
@@ -28,18 +31,31 @@ More detailed examples of how to use FLogger can be found in the examples direct
     
     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'
+    log.puts  'This message will be stored in logs/application.txt'
 
-This example shows how easy it is to specify a location for FLogger to output log files:
+This example shows how easy it is to change the location FLogger outputs log files:
 
     log = FLogger::Log.new
     
+    # change a few log locations
     log.configure do |c|
-      c.debug = 'new/logs/debug_log.txt'
-      c.error = 'new/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'
+    log.puts  'This message will be stored in new/logs/default_log.txt'
+
+You can also clear the content of one or all log files:
+
+    log = FLogger::Log.new
+    
+    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'
+    
+    log.clear                   # clears all log files that exist
+    log.clear('debug')          # clears the debug log file
+    

data/examples/clear_logs.rb

@@ -0,0 +1,39 @@
+require 'flogger'
+
+class MessageOutput
+  def initialize
+    @log = FLogger::Log.new
+  end
+  
+  def log_message(msg, type = nil)
+    case type
+      when 'debug'
+        @log.debug msg
+      when 'error'
+        @log.error msg
+      else
+        @log.puts msg
+    end
+  end
+  
+  def run_example
+    50.times do |count|
+      log_message "This is logged as a debug message ##{count}", 'debug'
+      log_message "This is logged as an error message ##{count}", 'error'
+      log_message "This is logged as a generic message ##{count}"
+    end
+    
+    # clear debug log
+    clear_logs 'debug'
+    
+    # clear all logs
+    clear_logs
+  end
+  
+  def clear_logs(log_file = nil)
+    @log.clear log_file
+  end
+end
+
+msg = MessageOutput.new
+msg.run_example

data/examples/custom_output.rb

@@ -8,7 +8,7 @@ class MessageOutput
     @log.configure do |c|
       c.debug   = 'custom/logs/debug_log.txt'
       c.error   = 'custom/logs/error_log.txt'
-      c.default = 'custom/logs/logs.txt'
+      c.default = 'custom/logs/app_log.txt'
     end
   end
   
@@ -25,9 +25,9 @@ class MessageOutput
   
   def run_example
     50.times do |count|
-      log_message "Debug log message ##{count}", 'debug'
-      log_message "Error log message ##{count}", 'error'
-      log_message "Default log message ##{count}"
+      log_message "This is logged as a debug message ##{count}", 'debug'
+      log_message "This is logged as an error message ##{count}", 'error'
+      log_message "This is logged as a generic message ##{count}"
     end
   end
 end

data/examples/default_output.rb

@@ -18,9 +18,9 @@ class MessageOutput
   
   def run_example
     50.times do |count|
-      log_message "Debug log message ##{count}", 'debug'
-      log_message "Error log message ##{count}", 'error'
-      log_message "Default log message ##{count}"
+      log_message "This is logged as a debug message ##{count}", 'debug'
+      log_message "This is logged as an error message ##{count}", 'error'
+      log_message "This is logged as a generic message ##{count}"
     end
   end
 end

data/flogger.gemspec

@@ -1,24 +1,21 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
+
 require "flogger/version"
 
 Gem::Specification.new do |s|
   s.name        = "flogger"
   s.version     = FLogger::VERSION
+  s.summary     = %q{A simple Ruby-based message logger.}
+  s.description = %q{A simple Ruby-based message logger that can output to one or many log files.}
+
   s.authors     = ["Andre Burdette"]
   s.email       = ["andre@nerdstack.com"]
   s.homepage    = "https://github.com/aburdette/flogger"
-  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"
 
   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"]
-
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
 end

data/lib/flogger.rb

@@ -2,4 +2,5 @@ require 'flogger/log'
 
 module FLogger
   autoload :VERSION, 'flogger/version'
+  autoload :File, 'flogger/ext/file'
 end

data/lib/flogger/ext/file.rb

@@ -0,0 +1,22 @@
+require 'fileutils'
+
+class File
+  def self.open_or_create(file, access)
+    begin
+      path = self.dirname(file)
+      FileUtils.mkdir_p(path) unless self.exists?(file)
+      self.open(file, access)
+    rescue Exception => e
+      puts e.message
+    end
+  end
+  
+  def self.erase_contents(file)
+    if self.exists?(file)
+      f = File.open(file, 'w')
+      f.truncate(0)
+    else
+      puts "File does not exist: #{file}"
+    end
+  end
+end

data/lib/flogger/log.rb

@@ -1,5 +1,4 @@
 require 'ostruct'
-require 'fileutils'
 
 module FLogger
   class Log
@@ -9,9 +8,9 @@ module FLogger
       @logs = OpenStruct.new(
         :debug    => 'logs/debug.txt',
         :error    => 'logs/error.txt',
-        :warning  => 'logs/warning.txt',
         :notice   => 'logs/notice.txt',
-        :default  => 'logs/log.txt'
+        :warning  => 'logs/warning.txt',
+        :default  => 'logs/application.txt'
       )
     end
     
@@ -21,27 +20,55 @@ module FLogger
     
     # output to debug log, default: logs/debug.txt
     def debug(msg)
-      output open(@logs.debug), msg
+      output(open(@logs.debug), msg)
     end
     
     # output to error log, default: logs/error.txt
     def error(msg)
-      output open(@logs.error), msg
+      output(open(@logs.error), msg)
     end
     
     # output to warning log, default: logs/warning.txt
     def warning(msg)
-      output open(@logs.warning), msg
+      output(open(@logs.warning), msg)
     end
     
     # output to notice log, default: logs/notice.txt
     def notice(msg)
-      output open(@logs.notice), msg
+      output(open(@logs.notice), msg)
     end
     
-    # output to log, default: logs/log.txt
+    # output to log, default: logs/application.txt
     def puts(msg)
-      output open(@logs.default), msg
+      output(open(@logs.default), msg)
+    end
+    
+    # clears the contents of log files
+    def clear(log_type = nil)
+      if log_type
+        # clear a single log
+        case log_type
+          when 'debug'
+            clear_log(@logs.debug)
+          when 'error'
+            clear_log(@logs.error)
+          when 'notice'
+            clear_log(@logs.notice)
+          when 'warning'
+            clear_log(@logs.warning)
+          when 'default'
+            clear_log(@logs.default)
+          else
+            $stdout.puts "ERROR: '#{log_type}' is not a valid log type."
+        end
+      else
+        # clear all logs
+        clear_log(@logs.debug)
+        clear_log(@logs.error)
+        clear_log(@logs.notice)
+        clear_log(@logs.warning)
+        clear_log(@logs.default)
+      end
     end
     
     private
@@ -49,11 +76,9 @@ module FLogger
     # access the needed log file
     def open(log_file)
       begin
-        log_path = File.dirname(log_file)
-        FileUtils.mkdir_p(log_path) unless File.exists? log_file
-        File.open(log_file, 'a')
+        File.open_or_create(log_file, 'a')
       rescue Exception => e
-        print e.message << "\r\n"
+        $stdout.puts "ERROR: #{e.message}"
       end
     end
     
@@ -64,7 +89,18 @@ module FLogger
           log.puts "[#{Time.now.asctime}] #{msg}"
           log.close
         rescue Exception => e
-          print e.message << "\r\n"
+          $stdout.puts "ERROR: #{e.message}"
+        end
+      end
+    end
+    
+    # clears log file contents
+    def clear_log(log_file)
+      if File.exists?(log_file)
+        begin
+          File.erase_contents(log_file)
+        rescue Exception => e
+          $stdout.puts "ERROR: #{e.message}"
         end
       end
     end

data/lib/flogger/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flogger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-20 00:00:00.000000000Z
+date: 2011-08-21 00:00:00.000000000Z
 dependencies: []
-description: A simple Ruby-based message logging system that outputs to one or many
-  log files.
+description: A simple Ruby-based message logger that can output to one or many log
+  files.
 email:
 - andre@nerdstack.com
 executables: []
@@ -24,10 +24,12 @@ files:
 - Gemfile
 - README.rdoc
 - Rakefile
+- examples/clear_logs.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
 homepage: https://github.com/aburdette/flogger
@@ -50,8 +52,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: flogger
-rubygems_version: 1.8.8
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: A simple Ruby-based message logging system.
+summary: A simple Ruby-based message logger.
 test_files: []