log4r 1.0.6 → 1.1.0

data/INSTALL

@@ -0,0 +1,18 @@
+Log4r Installation Instructions
+-------------------------------
+
+Run 'ruby install.rb' or double-click on install.rb
+
+To reinstall, just do the same thing.
+
+
+For RubyGems Users
+------------------
+
+Log4r is available via the RubyGems online distribution network. To install
+log4r using this method,
+
+  gem --remote-install log4r
+
+The log4r.gemspec file is included with the release, allowing one to build the
+gem file by hand. For more info, see http://rubygems.rubyforge.org/wiki/wiki.pl

data/LICENSE

@@ -0,0 +1,90 @@
+
+This software has evolved through three maintainers and three
+copyright notices.  I am an employee of UC Berkeley, which
+therefore makes me an employee of the State of California.
+By law, all works that I create as part of my job are
+owned by the University of California Regents.  I am able
+to mark software as being under the Gnu General Lesser Public
+License v3 and have done so for my versions of the Log4r software.
+
+See the file LICENSE.LGPLv3 for more information.
+
+18 Sept 2009
+Colby Gutierrez-Kraybill
+colby@astro.berkeley.edu
+
+Copyright (c) 2009 University of California Regents, Gnu LGPLv3
+Copyright (c) 2007, 2008 Revolution Health
+Copyright (c) 2002-2004 Leon Torres
+
+---------------------------------------------------------------------
+Copyright (c) 2007, 2008 Revolution Health
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+----------------------------------------------------------------------
+
+--------------------------------------------------------------------------
+Copyright (c) 2002, 2004 Leon Torres <leon@ugcs.caltech.edu>
+Log4r is copyrighted free software
+You can redistribute it and/or modify it under either the terms of the GPL, 
+or the conditions below::
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).
+
+  5. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+---------------------------------------------------------------------------

data/LICENSE.LGPLv3

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README

@@ -0,0 +1,91 @@
+Log4r - A flexible logging library for Ruby
+
+
+This release:      1.1.0 alpha
+Release date:      2009/xx/xx
+License:           Ruby's 
+Maintainer:        Colby Gutierrez-Kraybill
+Contributors:      Leon Torres          Original Maintainer
+                   Martain Stannard     RollingFileOutputter
+                   Steve Lumos          SyslogOutputter
+                   Andreas Hund         YamlConfigurator
+                   Jamis Buck           log4r.gemspec
+Homepage:          http://rubyforge.org/projects/log4r/
+Download:          http://rubyforge.org/frs/?group_id=203
+
+Summary
+-------
+
+Log4r is a comprehensive and flexible logging library written in Ruby for use 
+in Ruby programs. It features a hierarchical logging system of any number of 
+levels, custom level names, logger inheritance, multiple output destinations 
+per log event, execution tracing, custom formatting, thread safteyness, XML 
+and YAML configuration, and more.
+
+
+Requirements
+------------
+
+* (required) Ruby >= 1.7.0 (use log4r 1.0.2 for Ruby 1.6)
+* (optional) RubyGems for installing Log4r as a gem
+* (optional) Ruby syslog library for SyslogOutputter
+* (optional) XML configuration requires REXML
+* (optional) Remote logging requires ROMP 
+
+
+More Info
+---------
+
+* Installation instructions are in the file INSTALL
+
+* Comprehensive examples are provided in examples/ and can be run right away
+
+* Log4r homepage: doc/index.html
+  Online: http://log4r.sourceforge.net/
+
+* Manual: doc/manual.html
+  Online: http://rubyforge.org/docman/?group_id=203
+  
+* RDoc API reference: doc/rdoc/index.html 
+  Online: http://rubyforge.org/docman/index.php?group_id=203
+  
+* The changelog
+
+* Log4r is hosted by RubyForge, which provides news, bug tracking and a forum
+
+* Feel free to bug the maintainer with any questions (listed at top of file)
+
+
+Usability
+---------
+
+Log4r works really well, so please take advantage of it right away! :)
+All versions since 0.9.2 have been stable and backward-compatible. The
+code is stable enough that updates are infrequent and usually only for
+adding features or keeping the code up to date with Ruby.
+
+
+Platform Issues
+---------------
+
+Log4r is known to work on Linux and WindowsXP. It's safe to assume that Log4r 
+will work on any Ruby-supported platform.
+
+
+When Trouble Strikes
+--------------------
+
+Log4r comes with an internal logger. To see its output, create a logger
+named 'log4r' before any others and give it a suitable outputter,
+
+  trouble = Logger.new['log4r']
+  trouble.add Outputter.stdout
+
+Try running the unit tests provided (run the file tests/runtest.rb). Let
+the maintainer know what's up and feel free to explore and fix the 
+code yourself. It's well documented and written in Ruby. :)
+
+Also, try out the bug/request tracking system at 
+http://rubyforge.org/tracker/?group_id=203
+
+Version: $Id: README,v 1.4 2009/09/23 05:14:35 colbygk Exp $

data/Rakefile

@@ -0,0 +1,70 @@
+
+# $Id: Rakefile,v 1.2 2009/09/23 05:14:41 colbygk Exp $
+
+# incorporated from Revolution Health version of log4r
+
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'fileutils'
+
+GEM = "log4r"
+GEM_VERSION = "1.1.0"
+AUTHOR = "Colby Gutierrez-Kraybill"
+EMAIL = "colby@astro.berkeley.edu"
+HOMEPAGE = %q{http://log4r.rubyforge.org}
+SUMMARY = "Log4r, logging framework for ruby"
+DESCRIPTION = "See also: http://logging.apache.org/log4j"
+
+spec = spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.rubyforge_project = s.name
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = DESCRIPTION
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+
+  s.require_path = 'src'
+  s.files = %w(LICENSE LICENSE.LGPLv3 README INSTALL Rakefile TODO) + Dir.glob("{src,examples,tests,doc,bin}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+require 'test/unit'
+
+# TODO: integrate unit tests
+#task :test do
+#  FileUtils.mkdir(File.join(File.dirname(__FILE__), %w[log])) if !File.exists?(File.join(File.dirname(__FILE__), %w[log]))
+#  FileUtils.rm(Dir.glob(File.join(File.dirname(__FILE__), %w[log *])))
+#  runner = Test::Unit::AutoRunner.new(true)
+#  runner.to_run << 'test'
+#  runner.pattern = [/_test.rb$/]
+#  exit if !runner.run
+#end
+
+task :default => [:test, :package] do
+end
+

data/TODO

@@ -0,0 +1,35 @@
+
+Modify syslogoutputter to abstract away from exposing the underlying syslog interface.
+
+Merge log4r project changes from github, including NDC and GDC
+From the github project README:
+  === NDC
+
+  NDCs are per thread, and can be set by:
+
+  Log4r::Logger::NDC.push('something')
+
+  Then in the configuration xml it can be used:
+
+  pattern="%x"
+
+  Which will output the top most diagnostic message on the NDC stack.
+
+  Based on the log4j NDC implementation:
+    http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/NDC.html
+
+  === GDC
+
+  We also added a Global Diagnostic Context for per application diagnostic messages.
+
+  Log4r::Logger.GDC = "app1"
+
+  Then in the configuration xml it can be used:
+
+  pattern="%g"
+
+  log4_logging.rb uses this to set the message to be the name of the rails application.  
+  This can be useful for sorting messages if logs for multiple applications are
+  aggregated at a single point, 
+  for example in something like Splunk.
+