flogger 0.1.2 → 0.2.0

data/.gitignore

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

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+*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
+* 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'

data/README.rdoc

@@ -1,61 +1,34 @@
 = FLogger
 
-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.
+FLogger (or File Logger (or FLogger)) is an extremely simple and easy-to-use logger that outputs to one or many files. It was created, originally, as a learning project for myself, but has also become a tool that I continue to develop and use.
 
+== Installation
 
-== Installing
-
-FLogger can be downloaded from source or installed as a gem with the command:
+The latest stable release of FLogger can be installed via RubyGems:
 
     gem install flogger
 
+Or you can check out the latest source code via Github:
 
-== Usage and Default
+    git clone https://github.com/aburdette/flogger.git
 
-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:
+== Usage and Defaults
 
-* *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
+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:
 
+    @log = FLogger::Log.new do |paths|
+        paths.debug = 'new/path/to/debug.log'
+        paths.default = 'new/path/to/default.log'
+    end
 
 == 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:
+There are a few more detailed examples in the examples directory. However, below is a simple example of using FLogger to output log messages:
 
     require 'flogger'
     
-    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/application.txt'
-
-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.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'
-
-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
+    @log = FLogger::Log.new
     
+    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.'

data/examples/clear_logs.rb

@@ -1,39 +1,30 @@
 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}"
+class LogFiller
+    def initialize
+        # initialize with default paths
+        @log = FLogger::Log.new
     end
     
-    # clear debug log
-    clear_logs 'debug'
+    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
     
-    # clear all logs
-    clear_logs
-  end
-  
-  def clear_logs(log_file = nil)
-    @log.clear log_file
-  end
+    def clear(type = :all)
+        @log.clear type
+    end
 end
 
-msg = MessageOutput.new
-msg.run_example
+# create and fill logs
+log_filler = LogFiller.new
+log_filler.fill
+
+# clear just the debug log
+log_filler.clear :debug
+
+# clear all logs
+log_filler.clear

data/examples/custom_output.rb

@@ -1,36 +1,24 @@
 require 'flogger'
 
-class MessageOutput
-  def initialize
-    @log = FLogger::Log.new
-    
-    # configure custom log paths
-    @log.configure do |c|
-      c.debug   = 'custom/logs/debug_log.txt'
-      c.error   = 'custom/logs/error_log.txt'
-      c.default = 'custom/logs/app_log.txt'
-    end
-  end
-  
-  def log_message(msg, type = nil)
-    case type
-      when 'debug'
-        @log.debug msg
-      when 'error'
-        @log.error msg
-      else
-        @log.puts msg
+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'
+        end
     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}"
+    
+    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
 end
 
-msg = MessageOutput.new
-msg.run_example
+# create and fill logs
+log_filler = LogFiller.new
+log_filler.fill

data/examples/default_output.rb

@@ -1,29 +1,20 @@
 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
+class LogFiller
+    def initialize
+        # initialize with default paths
+        @log = FLogger::Log.new
     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}"
+    
+    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
 end
 
-msg = MessageOutput.new
-msg.run_example
+# create and fill logs
+log_filler = LogFiller.new
+log_filler.fill

data/flogger.gemspec

@@ -1,21 +1,23 @@
-$:.push File.expand_path("../lib", __FILE__)
-
-require "flogger/version"
+$:.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.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"]
+    s.name        = 'flogger'
+    s.version     = FLogger::VERSION
+    s.summary     = %q{Simple Ruby-based logger with file output.}
+    s.description = %q{Simple Ruby-based logger that can output to one or several log files.}
+    
+    s.authors     = [ 'Andre Burdette' ]
+    s.email       = [ 'andre@nerdstack.com' ]
+    s.homepage    = 'https://github.com/aburdette/flogger'
+    
+    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' ]
+    
+    s.required_ruby_version = '~> 1.9.2'
+    s.add_development_dependency 'rspec'
 end

data/lib/flogger.rb

@@ -1,6 +1,11 @@
 require 'flogger/log'
 
 module FLogger
-  autoload :VERSION, 'flogger/version'
-  autoload :File, 'flogger/ext/file'
+    autoload :VERSION, 'flogger/version'
+    autoload :File, 'flogger/ext/file'
+    
+    # output a deprecation error message
+    def self.output_deprecation(version, method)
+        $stderr.puts "Deprecation: #{method} was marked as deprecated as of version #{version}."
+    end
 end

data/lib/flogger/ext/file.rb

@@ -1,22 +1,14 @@
 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
+    # 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
-  
-  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,108 +1,130 @@
 require 'ostruct'
 
 module FLogger
-  class Log
-    attr_reader :logs
-    
-    def initialize
-      @logs = OpenStruct.new(
-        :debug    => 'logs/debug.txt',
-        :error    => 'logs/error.txt',
-        :notice   => 'logs/notice.txt',
-        :warning  => 'logs/warning.txt',
-        :default  => 'logs/application.txt'
-      )
-    end
-    
-    def configure(&block)
-      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/application.txt
-    def puts(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."
+    class Log
+        attr_reader :logpaths
+        
+        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'
+            )
+            
+            # yield to custom log paths
+            yield @logpaths if block_given?
         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
-    
-    # access the needed log file
-    def open(log_file)
-      begin
-        File.open_or_create(log_file, 'a')
-      rescue Exception => e
-        $stdout.puts "ERROR: #{e.message}"
-      end
-    end
-    
-    # output message to log file
-    def output(log, msg)
-      if log
-        begin
-          log.puts "[#{Time.now.asctime}] #{msg}"
-          log.close
-        rescue Exception => e
-          $stdout.puts "ERROR: #{e.message}"
+        
+        # deprecated: use Log#new
+        # configure log file locations
+        def configure(&block)
+            FLogger.output_deprecation('0.2.0', 'Log#configure')
         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}"
+        
+        # deprecated: use Log#puts
+        # outputs to debug log
+        def debug(message)
+            FLogger.output_deprecation('0.2.0', 'Log#debug')
+        end
+        
+        # deprecated: use Log#puts
+        # outputs to error log
+        def error(message)
+            FLogger.output_deprecation('0.2.0', 'Log#error')
+        end
+        
+        # deprecated: use Log#puts
+        # outputs to warning log
+        def warning(message)
+            FLogger.output_deprecation('0.2.0', 'Log#warning')
+        end
+        
+        # deprecated: use Log#puts
+        # outputs to notice log
+        def notice(message)
+            FLogger.output_deprecation('0.2.0', 'Log#notice')
+        end
+        
+        # outputs to log file
+        # default: logs/application.txt
+        def puts(type = :default, message)
+            return if message.empty?
+            
+            case type
+                when :debug
+                    output_to_log(@logpaths.debug, message)
+                
+                when :error
+                    output_to_log(@logpaths.error, message)
+                
+                when :notice
+                    output_to_log(@logpaths.notice, message)
+                
+                when :warning
+                    output_to_log(@logpaths.warning, message)
+                
+                when :default
+                    output_to_log(@logpaths.default, message)
+                
+                else
+                    $stderr.puts "Log type not supported."
+            end
+        end
+        
+        def clear(type = :default)
+            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
+                
+                when :debug
+                    clear_log_contents @logpaths.debug
+                
+                when :error
+                    clear_log_contents @logpaths.error
+                
+                when :notice
+                    clear_log_contents @logpaths.notice
+                
+                when :warning
+                    clear_log_contents @logpaths.warning
+                
+                when :default
+                    clear_log_contents @logpaths.default
+                    
+                else
+                    $stderr.puts "Log type not supported."
+            end
+        end
+        
+        private
+        
+        def output_to_log(file, message)
+            return if message.empty?
+            
+            begin
+                log_file = File.open_or_create(file, 'a')
+                log_file.puts "[#{Time.now.asctime}] #{message}"
+                log_file.close
+            rescue Exception => e
+                $stderr.puts e.message
+            end
+        end
+        
+        def clear_log_contents(file)
+            if File.exists? file
+                f = File.open(file, 'w')
+                f.truncate(0)
+                f.close
+            else
+                $stderr.puts "Could not clear log, file does not exist: #{file}"
+            end
         end
-      end
     end
-  end
 end

data/lib/flogger/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flogger
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-21 00:00:00.000000000Z
-dependencies: []
-description: A simple Ruby-based message logger that can output to one or many log
-  files.
+date: 2011-09-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &84575300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *84575300
+description: Simple Ruby-based logger that can output to one or several log files.
 email:
 - andre@nerdstack.com
 executables: []
@@ -41,9 +51,9 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ~>
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -52,8 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: flogger
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A simple Ruby-based message logger.
+summary: Simple Ruby-based logger with file output.
 test_files: []