logit 1.0.0

data/Manifest

@@ -0,0 +1,4 @@
+README.rdoc
+Rakefile
+lib/logit.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,88 @@
+= LogIt
+LogIt makes it easy to add custom logging to your Ruby or Rails
+application and has sensible formatting out of the box.
+
+
+= Usage
+
+=== Minimal configuration
+
+LogIt adds a class method to any including class to setup a logger method.
+For example:
+
+  require 'logit'
+
+  class Publisher
+    include Logit
+    
+    logs_to :publisher
+
+    def publish
+      logger.info("doing publish")
+      # do stuff...
+    end
+  end
+
+This will write logs to a publisher.log file in the current directory.
+
+=== More config options
+
+==== Writing to a specific directory
+
+  logs_to '/var/log/publishing/publisher.log'
+
+==== Adding a progname to log entries
+
+  logs_to :publisher, :progname => "Publisher #{Process.pid}"
+
+this will add something like 'Publisher 1234' to log entries.
+
+==== Configuring log rotation
+
+  logs_to :publisher, :shift_age => 5, :shift_size => 102400
+
+this will rotate logs up to a total of 5 files with max size of 102400
+bytes.
+  
+
+=== Running in Rails
+
+LogIt automatically detects if you're running in a Rails environment.  If
+so, it will write to the Rails log directory and appends the
+environment to the log file name.  For example:
+
+  RAILS_ROOT/log/publisher_development.log
+
+= Example log
+
+ 09-12-2010 10:27:10 INFO   [publisher 4607]: Publishing files to endpoint.
+ 09-12-2010 10:27:15 INFO   [publisher 4607]: Publishing completed.
+ 09-12-2010 10:27:56 INFO   [publisher 4621]: Publishing files to endpoint.
+ 09-12-2010 10:28:01 ERROR  [publisher 4621]: An exception occurred while publishing files: Connection reset by peer.
+ 09-12-2010 10:28:32 INFO   [publisher 4634]: Publishing files to endpoint.
+ 09-12-2010 10:28:32 WARN   [publisher 4634]: No files available to publish.
+
+= Installation
+
+== As a Gem
+
+ $ gem install logit
+
+== As a Rails plugin
+
+ $ script/plugin install git://github.com/ssayles/logit.git
+
+
+= TODO
+
+* Allow users to pass in a proc or a name of a method to call to handle formatting of log entries.
+* Add some tests?
+
+
+= Credits
+
+LogIt is written and maintained by {Scott Sayles}[mailto:ssayles@users.sourceforge.net].  
+
+= Copyright
+
+Copyright (c) 2010 Scott Sayles. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('logit', '1.0.0') do |p|
+    p.description       = 'Easily add custom logging abilities.'
+    p.url               = 'http://github.com/codemariner/logit'
+    p.author            = 'Scott Sayles'
+    p.email             = 'ssayles@users.sourceforge.net'
+    p.development_dependencies = []
+end
+
+#Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each {|ext| load ext}

data/lib/logit.rb

@@ -0,0 +1,133 @@
+module Logit
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    DEFAULT_OPTS = {:write_mode => 'a'}
+
+    begin
+      Module.const_get(:Logger)
+    rescue NameError
+      require 'logger'
+    end
+
+    # === Options
+    # * +:write_mode+ - mode used when opening the log file.  You'll ususually just want 'a' for append or 'w' for overwrite.  Defaults to 'a'.
+    # * +:shift_age+ - Number of old logs to keep or frequency of rotation.
+    # * +:shift_size+ - Maximum logfile size that only applies when <tt>:shift_age</tt> is a number.
+    # * +:progname+ - Logging program name.  The <tt>:progname</tt> value is used in the default logging format if defined.
+    #
+    # === Examples
+    # 
+    #  class Publisher
+    #    include Logit
+    #
+    #    logs_to "/tmp/publisher.log"
+    #
+    #    def do_it
+    #      logger.info("doing something")
+    #    end
+    #  end
+    # 
+    #
+    #  class Publisher2
+    #    include Logit
+    #
+    #    logs_to :publisher, :progname => "Publisher #{Process.pid}"
+    #                        :shift_age => 'daily'
+    #    def do_it
+    #      logger.info("doing something")
+    #    end
+    #  end
+    #  
+    def logs_to(name, opts={})
+      opts = DEFAULT_OPTS.merge(opts)
+      path = logit_log_name(name, opts)
+      self.send :define_method, :logger do
+        unless @logger
+          @logger =  Logit::Logger.new(path, opts)
+          if opts[:progname]
+            @logger.progname = opts[:progname]
+          end
+        end
+        @logger
+      end
+    end
+
+
+    # Tries to figure out what the fully qualified path name
+    # of the log file should be.
+    #
+    def logit_log_name(name, opts)
+      path = name.to_s.strip
+
+      #  if they are giving a path like '/var/log/foo.log'
+      #  then we shouldn't presume to stick it in the Rails log dir
+      unless (path =~ /\/+/) 
+        if (logit_in_rails?)
+          # take off any trailing .log so we can attach the environment
+          # name
+          path = logit_strip_dot_log(path)
+          path = File.join(RAILS_ROOT, 'log', "#{name}_#{Rails.env}.log")
+        end
+      end
+      # see if we need to append .log
+      # is this a bit presumptuous?
+      unless (path =~ /\.log$/)
+        path << ".log"
+      end
+    end
+
+    def logit_strip_dot_log(name)
+      if (name =~ /\.log$/)
+        name.slice(0, name =~ /\.log$/) 
+      else
+        name
+      end
+    end
+    def logit_in_rails?
+      begin
+        Module.const_get(:Rails)
+        return true
+      rescue NameError
+      end
+    end
+  end
+
+
+
+  # The actual logger.
+  #
+  # Example:
+  #
+  #   c = Logit::Logger.new('custom')
+  #
+  # such that the resulting log, for example, is
+  #
+  #   #{RAILS_ROOT}/log/custom_development.log
+  #
+  # when running under Rails.
+  #
+  # You can flush the log by calling logger.flush().
+  #
+  class Logger < Logger
+  
+    def initialize(log_path, opts = {:write_mode => 'a'})
+      @f = File.open(log_path, 'a')
+      super @f
+    end
+  
+    def format_message(severity, timestamp, progname, msg)
+  
+      name = (progname) ? " [#{progname}]" : ""
+  
+      "#{timestamp.strftime('%d-%m-%Y %H:%M:%S')} #{severity.ljust(6)}#{name}: #{msg}\n"
+    end
+  
+    def flush()
+      @f.flush()
+    end
+  end
+
+end

data/logit.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{logit}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Sayles"]
+  s.date = %q{2010-12-09}
+  s.description = %q{Easily add custom logging abilities.}
+  s.email = %q{ssayles@users.sourceforge.net}
+  s.extra_rdoc_files = ["README.rdoc", "lib/logit.rb"]
+  s.files = ["README.rdoc", "Rakefile", "lib/logit.rb", "Manifest", "logit.gemspec"]
+  s.homepage = %q{http://github.com/codemariner/logit}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Logit", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{logit}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Easily add custom logging abilities.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: logit
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Scott Sayles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-09 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Easily add custom logging abilities.
+email: ssayles@users.sourceforge.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/logit.rb
+files: 
+- README.rdoc
+- Rakefile
+- lib/logit.rb
+- Manifest
+- logit.gemspec
+has_rdoc: true
+homepage: http://github.com/codemariner/logit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Logit
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: logit
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easily add custom logging abilities.
+test_files: []
+