logging 0.9.4 → 0.9.5

data/lib/logging/layout.rb

@@ -72,9 +72,6 @@ class Layout
   #
   def footer( ) '' end 
 
-
-  protected
-
   # call-seq:
   #    format_obj( obj )
   #

data/lib/logging/layouts/pattern.rb

@@ -56,6 +56,10 @@ module Layouts
   #       construction of the Layout until creation of the log event.
   #  [t]  Used to output the object ID of the thread that generated the
   #       log event.
+  #  [T]  Used to output the name of the thread that generated the log event.
+  #       Name can be specified using Thread.current[:name] notation. Output empty
+  #       string if name not specified. This options helps to create more human
+  #       readable output for multithread application log.
   #  [%]  The sequence '%%' outputs a single percent sign.
   #
   # The directives F, L, and M will only work if the Logger generating the
@@ -125,6 +129,7 @@ module Layouts
       'p' => 'Process.pid',
       'r' => 'Integer((Time.now-@created_at)*1000).to_s',
       't' => 'Thread.current.object_id.to_s',
+      'T' => 'Thread.current[:name]',
       '%' => :placeholder
     }
 

data/lib/logging/logger.rb

@@ -449,8 +449,8 @@ module Logging
         str << spacer
         str << '.' * (base - str.length)
       end
-      io.print(str.ljust(base))
-      io.print(spacer)
+      io.write(str.ljust(base))
+      io.write(spacer)
 
       level_str  = @level.nil? ? '' : '*'
       level_str << if level < ::Logging::LEVELS.length
@@ -460,24 +460,24 @@ module Logging
       end
       level_len = ::Logging::MAX_LEVEL_LENGTH + 1
 
-      io.print("%#{level_len}s" % level_str)
-      io.print(spacer)
+      io.write("%#{level_len}s" % level_str)
+      io.write(spacer)
 
       if self.respond_to?(:additive)
-        io.print(additive ? '+A' : '-A')
+        io.write(additive ? '+A' : '-A')
       else
-        io.print('  ')
+        io.write('  ')
       end
 
-      io.print(spacer)
-      io.print(trace ? '+T' : '-T')
-      io.print("\n")
+      io.write(spacer)
+      io.write(trace ? '+T' : '-T')
+      io.write("\n")
 
       @appenders.each do |appender|
-        io.print(indent_str)
-        io.print('- ')
-        io.print(appender.inspect)
-        io.print("\n")
+        io.write(indent_str)
+        io.write('- ')
+        io.write(appender.inspect)
+        io.write("\n")
       end
 
       return io

data/logging.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{logging}
+  s.version = "0.9.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Pease"]
+  s.date = %q{2009-01-25}
+  s.description = %q{Logging is a flexible logging library for use in Ruby programs based on the design of Java's log4j library. It features a hierarchical logging system, custom level names, multiple output destinations per log event, custom formatting, and more.}
+  s.email = %q{tim.pease@gmail.com}
+  s.extra_rdoc_files = ["History.txt", "README.rdoc"]
+  s.files = ["History.txt", "README.rdoc", "Rakefile", "data/bad_logging_1.rb", "data/bad_logging_2.rb", "data/logging.rb", "data/logging.yaml", "data/simple_logging.rb", "lib/logging.rb", "lib/logging/appender.rb", "lib/logging/appenders/buffering.rb", "lib/logging/appenders/console.rb", "lib/logging/appenders/email.rb", "lib/logging/appenders/file.rb", "lib/logging/appenders/growl.rb", "lib/logging/appenders/io.rb", "lib/logging/appenders/rolling_file.rb", "lib/logging/appenders/syslog.rb", "lib/logging/config/configurator.rb", "lib/logging/config/yaml_configurator.rb", "lib/logging/layout.rb", "lib/logging/layouts/basic.rb", "lib/logging/layouts/pattern.rb", "lib/logging/log_event.rb", "lib/logging/logger.rb", "lib/logging/repository.rb", "lib/logging/root_logger.rb", "lib/logging/stats.rb", "lib/logging/utils.rb", "test/appenders/test_buffered_io.rb", "test/appenders/test_console.rb", "test/appenders/test_email.rb", "test/appenders/test_file.rb", "test/appenders/test_growl.rb", "test/appenders/test_io.rb", "test/appenders/test_rolling_file.rb", "test/appenders/test_syslog.rb", "test/benchmark.rb", "test/config/test_configurator.rb", "test/config/test_yaml_configurator.rb", "test/layouts/test_basic.rb", "test/layouts/test_pattern.rb", "test/setup.rb", "test/test_appender.rb", "test/test_layout.rb", "test/test_log_event.rb", "test/test_logger.rb", "test/test_logging.rb", "test/test_repository.rb", "test/test_root_logger.rb", "test/test_stats.rb", "test/test_utils.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://logging.rubyforge.org/}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{logging}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A flexible and extendable logging library for Ruby}
+  s.test_files = ["test/appenders/test_buffered_io.rb", "test/appenders/test_console.rb", "test/appenders/test_email.rb", "test/appenders/test_file.rb", "test/appenders/test_growl.rb", "test/appenders/test_io.rb", "test/appenders/test_rolling_file.rb", "test/appenders/test_syslog.rb", "test/config/test_configurator.rb", "test/config/test_yaml_configurator.rb", "test/layouts/test_basic.rb", "test/layouts/test_pattern.rb", "test/test_appender.rb", "test/test_layout.rb", "test/test_log_event.rb", "test/test_logger.rb", "test/test_logging.rb", "test/test_repository.rb", "test/test_root_logger.rb", "test/test_stats.rb", "test/test_utils.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<flexmock>, [">= 0.8.2"])
+      s.add_runtime_dependency(%q<lockfile>, [">= 1.4.3"])
+      s.add_development_dependency(%q<bones>, [">= 2.3.0"])
+    else
+      s.add_dependency(%q<flexmock>, [">= 0.8.2"])
+      s.add_dependency(%q<lockfile>, [">= 1.4.3"])
+      s.add_dependency(%q<bones>, [">= 2.3.0"])
+    end
+  else
+    s.add_dependency(%q<flexmock>, [">= 0.8.2"])
+    s.add_dependency(%q<lockfile>, [">= 1.4.3"])
+    s.add_dependency(%q<bones>, [">= 2.3.0"])
+  end
+end

data/tasks/ann.rake

@@ -42,7 +42,7 @@ namespace :ann do
   desc "Send an email announcement"
   task :email => ['ann:prereqs', PROJ.ann.file] do
     ann = PROJ.ann
-    from = ann.email[:from] || PROJ.email
+    from = ann.email[:from] || Array(PROJ.authors).first || PROJ.email
     to   = Array(ann.email[:to])
 
     ### build a mail header for RFC 822

data/tasks/gem.rake

@@ -1,5 +1,94 @@
 
-require 'rake/gempackagetask'
+require 'find'
+require 'rake/packagetask'
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
+
+module Bones
+class GemPackageTask < Rake::PackageTask
+  # Ruby GEM spec containing the metadata for this package.  The
+  # name, version and package_files are automatically determined
+  # from the GEM spec and don't need to be explicitly provided.
+  #
+  attr_accessor :gem_spec
+
+  # Tasks from the Bones gem directory
+  attr_reader :bones_files
+
+  # Create a GEM Package task library.  Automatically define the gem
+  # if a block is given.  If no block is supplied, then +define+
+  # needs to be called to define the task.
+  #
+  def initialize(gem_spec)
+    init(gem_spec)
+    yield self if block_given?
+    define if block_given?
+  end
+
+  # Initialization tasks without the "yield self" or define
+  # operations.
+  #
+  def init(gem)
+    super(gem.name, gem.version)
+    @gem_spec = gem
+    @package_files += gem_spec.files if gem_spec.files
+    @bones_files = []
+
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+    if !test(?e, local_setup)
+      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
+    end
+  end
+
+  # Create the Rake tasks and actions specified by this
+  # GemPackageTask.  (+define+ is automatically called if a block is
+  # given to +new+).
+  #
+  def define
+    super
+    task :prereqs
+    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
+    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
+      when_writing("Creating GEM") {
+        chdir(package_dir_path) do
+          Gem::Builder.new(gem_spec).build
+          verbose(true) {
+            mv gem_file, "../#{gem_file}"
+          }
+        end
+      }
+    end
+
+    file package_dir_path => bones_files do
+      mkdir_p package_dir rescue nil
+
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+
+      bones_files.each do |fn|
+        base_fn = File.join('tasks', File.basename(fn))
+        f = File.join(package_dir_path, base_fn)
+        fdir = File.dirname(f)
+        mkdir_p(fdir) if !File.exist?(fdir)
+        if File.directory?(fn)
+          mkdir_p(f)
+        else
+          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
+          safe_ln(fn, f)
+        end
+      end
+    end
+  end
+  
+  def gem_file
+    if @gem_spec.platform == Gem::Platform::RUBY
+      "#{package_name}.gem"
+    else
+      "#{package_name}-#{@gem_spec.platform}.gem"
+    end
+  end
+end  # class GemPackageTask
+end  # module Bones
 
 namespace :gem do
 
@@ -18,6 +107,10 @@ namespace :gem do
       s.add_dependency(*dep)
     end
 
+    PROJ.gem.development_dependencies.each do |dep|
+      s.add_development_dependency(*dep)
+    end
+
     s.files = PROJ.gem.files
     s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
     s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
@@ -56,37 +149,21 @@ namespace :gem do
     end
   end  # Gem::Specification.new
 
-  # A prerequisites task that all other tasks depend upon
-  task :prereqs
+  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+  end
 
   desc 'Show information about the gem'
   task :debug => 'gem:prereqs' do
     puts PROJ.gem._spec.to_ruby
   end
 
-  pkg = Rake::PackageTask.new(PROJ.name, PROJ.version) do |pkg|
-    pkg.need_tar = PROJ.gem.need_tar
-    pkg.need_zip = PROJ.gem.need_zip
-    pkg.package_files += PROJ.gem._spec.files
-  end
-  Rake::Task['gem:package'].instance_variable_set(:@full_comment, nil)
-
-  gem_file = if PROJ.gem._spec.platform == Gem::Platform::RUBY
-      "#{pkg.package_name}.gem"
-    else
-      "#{pkg.package_name}-#{PROJ.gem._spec.platform}.gem"
+  desc 'Write the gemspec '
+  task :spec => 'gem:prereqs' do
+    File.open("#{PROJ.name}.gemspec", 'w') do |f|
+      f.write PROJ.gem._spec.to_ruby
     end
-
-  desc "Build the gem file #{gem_file}"
-  task :package => ['gem:prereqs', "#{pkg.package_dir}/#{gem_file}"]
-
-  file "#{pkg.package_dir}/#{gem_file}" => [pkg.package_dir] + PROJ.gem._spec.files do
-    when_writing("Creating GEM") {
-      Gem::Builder.new(PROJ.gem._spec).build
-      verbose(true) {
-        mv gem_file, "#{pkg.package_dir}/#{gem_file}"
-      }
-    }
   end
 
   desc 'Install the gem'
@@ -112,14 +189,13 @@ namespace :gem do
   task :cleanup do
     sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
   end
-
 end  # namespace :gem
 
+
 desc 'Alias to gem:package'
 task :gem => 'gem:package'
 
 task :clobber => 'gem:clobber_package'
-
-remove_desc_for_task %w(gem:clobber_package)
+remove_desc_for_task 'gem:clobber_package'
 
 # EOF

data/tasks/post_load.rake

@@ -2,14 +2,15 @@
 # This file does not define any rake tasks. It is used to load some project
 # settings if they are not defined by the user.
 
-PROJ.rdoc.exclude << "^#{Regexp.escape(PROJ.manifest_file)}$"
 PROJ.exclude << ["^#{Regexp.escape(PROJ.ann.file)}$",
+                 "^#{Regexp.escape(PROJ.ignore_file)}$",
                  "^#{Regexp.escape(PROJ.rdoc.dir)}/",
                  "^#{Regexp.escape(PROJ.rcov.dir)}/"]
 
 flatten_arrays = lambda do |this,os|
     os.instance_variable_get(:@table).each do |key,val|
-      next if key == :dependencies
+      next if key == :dependencies \
+           or key == :development_dependencies
       case val
       when Array; val.flatten!
       when OpenStruct; this.call(this,val)
@@ -24,12 +25,7 @@ PROJ.description ||= paragraphs_of(PROJ.readme_file, 'description').join("\n\n")
 
 PROJ.summary ||= PROJ.description.split('.').first
 
-PROJ.gem.files ||=
-  if test(?f, PROJ.manifest_file)
-    files = File.readlines(PROJ.manifest_file).map {|fn| fn.chomp.strip}
-    files.delete ''
-    files
-  else [] end
+PROJ.gem.files ||= manifest
 
 PROJ.gem.executables ||= PROJ.gem.files.find_all {|fn| fn =~ %r/^bin/}
 

data/tasks/rubyforge.rake

@@ -6,7 +6,7 @@ require 'rake/contrib/sshpublisher'
 
 namespace :gem do
   desc 'Package and upload to RubyForge'
-  task :release => [:clobber, 'gem:package'] do |t|
+  task :release => [:clobber, 'gem'] do |t|
     v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
     abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
     pkg = "pkg/#{PROJ.gem._spec.full_name}"
@@ -26,9 +26,7 @@ namespace :gem do
     c['release_changes'] = PROJ.changes if PROJ.changes
     c['preformatted'] = true
 
-    files = [(PROJ.gem.need_tar ? "#{pkg}.tgz" : nil),
-             (PROJ.gem.need_zip ? "#{pkg}.zip" : nil),
-             "#{pkg}.gem"].compact
+    files = Dir.glob("#{pkg}*.*")
 
     puts "Releasing #{PROJ.name} v. #{PROJ.version}"
     rf.add_release PROJ.rubyforge.name, PROJ.name, PROJ.version, *files

data/tasks/setup.rb

@@ -4,9 +4,13 @@ require 'rake'
 require 'rake/clean'
 require 'fileutils'
 require 'ostruct'
+require 'find'
 
 class OpenStruct; undef :gem; end
 
+# TODO: make my own openstruct type object that includes descriptions
+# TODO: use the descriptions to output help on the available bones options
+
 PROJ = OpenStruct.new(
   # Project Defaults
   :name => nil,
@@ -24,8 +28,8 @@ PROJ = OpenStruct.new(
   :ruby_opts => %w(-w),
   :libs => [],
   :history_file => 'History.txt',
-  :manifest_file => 'Manifest.txt',
   :readme_file => 'README.txt',
+  :ignore_file => '.bnsignore',
 
   # Announce
   :ann => OpenStruct.new(
@@ -47,6 +51,7 @@ PROJ = OpenStruct.new(
   # Gem Packaging
   :gem => OpenStruct.new(
     :dependencies => [],
+    :development_dependencies => [],
     :executables => nil,
     :extensions => FileList['ext/**/extconf.rb'],
     :files => nil,
@@ -58,7 +63,7 @@ PROJ = OpenStruct.new(
   # File Annotations
   :notes => OpenStruct.new(
     :exclude => %w(^tasks/setup\.rb$),
-    :extensions => %w(.txt .rb .erb) << '',
+    :extensions => %w(.txt .rb .erb .rdoc) << '',
     :tags => %w(FIXME OPTIMIZE TODO)
   ),
 
@@ -73,7 +78,7 @@ PROJ = OpenStruct.new(
   # Rdoc
   :rdoc => OpenStruct.new(
     :opts => [],
-    :include => %w(^lib/ ^bin/ ^ext/ \.txt$),
+    :include => %w(^lib/ ^bin/ ^ext/ \.txt$ \.rdoc$),
     :exclude => %w(extconf\.rb$),
     :main => nil,
     :dir => 'doc',
@@ -109,8 +114,10 @@ PROJ = OpenStruct.new(
 )
 
 # Load the other rake files in the tasks folder
-rakefiles = Dir.glob('tasks/*.rake').sort
-rakefiles.unshift(rakefiles.delete('tasks/post_load.rake')).compact!
+tasks_dir = File.expand_path(File.dirname(__FILE__))
+post_load_fn = File.join(tasks_dir, 'post_load.rake')
+rakefiles = Dir.glob(File.join(tasks_dir, '*.rake')).sort
+rakefiles.unshift(rakefiles.delete(post_load_fn)).compact!
 import(*rakefiles)
 
 # Setup the project libraries
@@ -161,6 +168,12 @@ HAVE_SVN = (Dir.entries(Dir.pwd).include?('.svn') and
 HAVE_GIT = (Dir.entries(Dir.pwd).include?('.git') and
             system("git --version 2>&1 > #{DEV_NULL}"))
 
+# Add bones as a development dependency
+#
+if HAVE_BONES
+  PROJ.gem.development_dependencies << ['bones', ">= #{Bones::VERSION}"]
+end
+
 # Reads a file at +path+ and spits out an array of the +paragraphs+
 # specified.
 #
@@ -242,9 +255,25 @@ end
 # Scans the current working directory and creates a list of files that are
 # candidates to be in the manifest.
 #
-def manifest_files
+def manifest
   files = []
-  exclude = Regexp.new(PROJ.exclude.join('|'))
+  exclude = PROJ.exclude.dup
+  comment = %r/^\s*#/
+ 
+  # process the ignore file and add the items there to the exclude list
+  if test(?f, PROJ.ignore_file)
+    ary = File.readlines(PROJ.ignore_file).map do |line|
+      next if line =~ comment
+      line.chomp.strip
+    end
+    ary.compact!
+    ary.delete ''
+    exclude.concat ary
+  end
+
+  # generate a regular expression from the exclude list
+  exclude = Regexp.new(exclude.join('|'))
+
   Find.find '.' do |path|
     path.sub! %r/^(\.\/|\/)/o, ''
     next unless test ?f, path