LogSimple 0.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+
+= 0.1
+Initial Release

data/INSTALL

@@ -0,0 +1,23 @@
+ 
+ = 1. RubyGems, network install
+ 
+ If you have RubyGems (http://www.rubygems.org/) and an access to the internet, you should be able
+ to install LogSimple directly from the internet. Simply run :
+   
+   gem install LogSimple
+ 
+ = 2. Rake + RubyGems, local install
+ 
+ If you have Rake (http://rake.rubyforge.org/) and RubyGems installed, cd in the base directory of
+ LogSimple (where this file is located) and run :
+   rake gem
+   gem install pkg/LogSimple.<version number>.gem
+   
+ You can uninstall at any point by doing :
+   gem uninstall LogSimple
+   
+ = 3. Manual install, local install
+ 
+ You can just copy the LogSimple directory to the place of your choice - and make sure 'lib' is in
+ your include path before using it.
+ 

data/LICENSE

@@ -0,0 +1,340 @@
+ GNU GENERAL PUBLIC LICENSE
+ 		       Version 2, June 1991
+ 
+  Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+  Everyone is permitted to copy and distribute verbatim copies
+  of this license document, but changing it is not allowed.
+ 
+ 			    Preamble
+ 
+   The licenses for most software are designed to take away your
+ freedom to share and change it.  By contrast, the GNU General Public
+ License is intended to guarantee your freedom to share and change free
+ software--to make sure the software is free for all its users.  This
+ General Public License applies to most of the Free Software
+ Foundation's software and to any other program whose authors commit to
+ using it.  (Some other Free Software Foundation software is covered by
+ the GNU Lesser General Public License instead.)  You can apply it to
+ your programs, too.
+ 
+   When we speak of free software, we are referring to freedom, not
+ price.  Our General Public Licenses are designed to make sure that you
+ have the freedom to distribute copies of free software (and charge for
+ this service if you wish), that you receive source code or can get it
+ if you want it, that you can change the software or use pieces of it
+ in new free programs; and that you know you can do these things.
+ 
+   To protect your rights, we need to make restrictions that forbid
+ anyone to deny you these rights or to ask you to surrender the rights.
+ These restrictions translate to certain responsibilities for you if you
+ distribute copies of the software, or if you modify it.
+ 
+   For example, if you distribute copies of such a program, whether
+ gratis or for a fee, you must give the recipients all the rights that
+ you have.  You must make sure that they, too, receive or can get the
+ source code.  And you must show them these terms so they know their
+ rights.
+ 
+   We protect your rights with two steps: (1) copyright the software, and
+ (2) offer you this license which gives you legal permission to copy,
+ distribute and/or modify the software.
+ 
+   Also, for each author's protection and ours, we want to make certain
+ that everyone understands that there is no warranty for this free
+ software.  If the software is modified by someone else and passed on, we
+ want its recipients to know that what they have is not the original, so
+ that any problems introduced by others will not reflect on the original
+ authors' reputations.
+ 
+   Finally, any free program is threatened constantly by software
+ patents.  We wish to avoid the danger that redistributors of a free
+ program will individually obtain patent licenses, in effect making the
+ program proprietary.  To prevent this, we have made it clear that any
+ patent must be licensed for everyone's free use or not licensed at all.
+ 
+   The precise terms and conditions for copying, distribution and
+ modification follow.
+ 
+ 		    GNU GENERAL PUBLIC LICENSE
+    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+ 
+   0. This License applies to any program or other work which contains
+ a notice placed by the copyright holder saying it may be distributed
+ under the terms of this General Public License.  The "Program", below,
+ refers to any such program or work, and a "work based on the Program"
+ means either the Program or any derivative work under copyright law:
+ that is to say, a work containing the Program or a portion of it,
+ either verbatim or with modifications and/or translated into another
+ language.  (Hereinafter, translation is included without limitation in
+ the term "modification".)  Each licensee is addressed as "you".
+ 
+ Activities other than copying, distribution and modification are not
+ covered by this License; they are outside its scope.  The act of
+ running the Program is not restricted, and the output from the Program
+ is covered only if its contents constitute a work based on the
+ Program (independent of having been made by running the Program).
+ Whether that is true depends on what the Program does.
+ 
+   1. You may copy and distribute verbatim copies of the Program's
+ source code as you receive it, in any medium, provided that you
+ conspicuously and appropriately publish on each copy an appropriate
+ copyright notice and disclaimer of warranty; keep intact all the
+ notices that refer to this License and to the absence of any warranty;
+ and give any other recipients of the Program a copy of this License
+ along with the Program.
+ 
+ You may charge a fee for the physical act of transferring a copy, and
+ you may at your option offer warranty protection in exchange for a fee.
+ 
+   2. You may modify your copy or copies of the Program or any portion
+ of it, thus forming a work based on the Program, and copy and
+ distribute such modifications or work under the terms of Section 1
+ above, provided that you also meet all of these conditions:
+ 
+     a) You must cause the modified files to carry prominent notices
+     stating that you changed the files and the date of any change.
+ 
+     b) You must cause any work that you distribute or publish, that in
+     whole or in part contains or is derived from the Program or any
+     part thereof, to be licensed as a whole at no charge to all third
+     parties under the terms of this License.
+ 
+     c) If the modified program normally reads commands interactively
+     when run, you must cause it, when started running for such
+     interactive use in the most ordinary way, to print or display an
+     announcement including an appropriate copyright notice and a
+     notice that there is no warranty (or else, saying that you provide
+     a warranty) and that users may redistribute the program under
+     these conditions, and telling the user how to view a copy of this
+     License.  (Exception: if the Program itself is interactive but
+     does not normally print such an announcement, your work based on
+     the Program is not required to print an announcement.)
+ 
+ These requirements apply to the modified work as a whole.  If
+ identifiable sections of that work are not derived from the Program,
+ and can be reasonably considered independent and separate works in
+ themselves, then this License, and its terms, do not apply to those
+ sections when you distribute them as separate works.  But when you
+ distribute the same sections as part of a whole which is a work based
+ on the Program, the distribution of the whole must be on the terms of
+ this License, whose permissions for other licensees extend to the
+ entire whole, and thus to each and every part regardless of who wrote it.
+ 
+ Thus, it is not the intent of this section to claim rights or contest
+ your rights to work written entirely by you; rather, the intent is to
+ exercise the right to control the distribution of derivative or
+ collective works based on the Program.
+ 
+ In addition, mere aggregation of another work not based on the Program
+ with the Program (or with a work based on the Program) on a volume of
+ a storage or distribution medium does not bring the other work under
+ the scope of this License.
+ 
+   3. You may copy and distribute the Program (or a work based on it,
+ under Section 2) in object code or executable form under the terms of
+ Sections 1 and 2 above provided that you also do one of the following:
+ 
+     a) Accompany it with the complete corresponding machine-readable
+     source code, which must be distributed under the terms of Sections
+     1 and 2 above on a medium customarily used for software interchange; or,
+ 
+     b) Accompany it with a written offer, valid for at least three
+     years, to give any third party, for a charge no more than your
+     cost of physically performing source distribution, a complete
+     machine-readable copy of the corresponding source code, to be
+     distributed under the terms of Sections 1 and 2 above on a medium
+     customarily used for software interchange; or,
+ 
+     c) Accompany it with the information you received as to the offer
+     to distribute corresponding source code.  (This alternative is
+     allowed only for noncommercial distribution and only if you
+     received the program in object code or executable form with such
+     an offer, in accord with Subsection b above.)
+ 
+ The source code for a work means the preferred form of the work for
+ making modifications to it.  For an executable work, complete source
+ code means all the source code for all modules it contains, plus any
+ associated interface definition files, plus the scripts used to
+ control compilation and installation of the executable.  However, as a
+ special exception, the source code distributed need not include
+ anything that is normally distributed (in either source or binary
+ form) with the major components (compiler, kernel, and so on) of the
+ operating system on which the executable runs, unless that component
+ itself accompanies the executable.
+ 
+ If distribution of executable or object code is made by offering
+ access to copy from a designated place, then offering equivalent
+ access to copy the source code from the same place counts as
+ distribution of the source code, even though third parties are not
+ compelled to copy the source along with the object code.
+ 
+   4. You may not copy, modify, sublicense, or distribute the Program
+ except as expressly provided under this License.  Any attempt
+ otherwise to copy, modify, sublicense or distribute the Program is
+ void, and will automatically terminate your rights under this License.
+ However, parties who have received copies, or rights, from you under
+ this License will not have their licenses terminated so long as such
+ parties remain in full compliance.
+ 
+   5. You are not required to accept this License, since you have not
+ signed it.  However, nothing else grants you permission to modify or
+ distribute the Program or its derivative works.  These actions are
+ prohibited by law if you do not accept this License.  Therefore, by
+ modifying or distributing the Program (or any work based on the
+ Program), you indicate your acceptance of this License to do so, and
+ all its terms and conditions for copying, distributing or modifying
+ the Program or works based on it.
+ 
+   6. Each time you redistribute the Program (or any work based on the
+ Program), the recipient automatically receives a license from the
+ original licensor to copy, distribute or modify the Program subject to
+ these terms and conditions.  You may not impose any further
+ restrictions on the recipients' exercise of the rights granted herein.
+ You are not responsible for enforcing compliance by third parties to
+ this License.
+ 
+   7. If, as a consequence of a court judgment or allegation of patent
+ infringement or for any other reason (not limited to patent issues),
+ conditions are imposed on you (whether by court order, agreement or
+ otherwise) that contradict the conditions of this License, they do not
+ excuse you from the conditions of this License.  If you cannot
+ distribute so as to satisfy simultaneously your obligations under this
+ License and any other pertinent obligations, then as a consequence you
+ may not distribute the Program at all.  For example, if a patent
+ license would not permit royalty-free redistribution of the Program by
+ all those who receive copies directly or indirectly through you, then
+ the only way you could satisfy both it and this License would be to
+ refrain entirely from distribution of the Program.
+ 
+ If any portion of this section is held invalid or unenforceable under
+ any particular circumstance, the balance of the section is intended to
+ apply and the section as a whole is intended to apply in other
+ circumstances.
+ 
+ It is not the purpose of this section to induce you to infringe any
+ patents or other property right claims or to contest validity of any
+ such claims; this section has the sole purpose of protecting the
+ integrity of the free software distribution system, which is
+ implemented by public license practices.  Many people have made
+ generous contributions to the wide range of software distributed
+ through that system in reliance on consistent application of that
+ system; it is up to the author/donor to decide if he or she is willing
+ to distribute software through any other system and a licensee cannot
+ impose that choice.
+ 
+ This section is intended to make thoroughly clear what is believed to
+ be a consequence of the rest of this License.
+ 
+   8. If the distribution and/or use of the Program is restricted in
+ certain countries either by patents or by copyrighted interfaces, the
+ original copyright holder who places the Program under this License
+ may add an explicit geographical distribution limitation excluding
+ those countries, so that distribution is permitted only in or among
+ countries not thus excluded.  In such case, this License incorporates
+ the limitation as if written in the body of this License.
+ 
+   9. The Free Software Foundation may publish revised and/or new versions
+ of the 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 Program
+ specifies a version number of this License which applies to it and "any
+ later version", you have the option of following the terms and conditions
+ either of that version or of any later version published by the Free
+ Software Foundation.  If the Program does not specify a version number of
+ this License, you may choose any version ever published by the Free Software
+ Foundation.
+ 
+   10. If you wish to incorporate parts of the Program into other free
+ programs whose distribution conditions are different, write to the author
+ to ask for permission.  For software which is copyrighted by the Free
+ Software Foundation, write to the Free Software Foundation; we sometimes
+ make exceptions for this.  Our decision will be guided by the two goals
+ of preserving the free status of all derivatives of our free software and
+ of promoting the sharing and reuse of software generally.
+ 
+ 			    NO WARRANTY
+ 
+   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+ REPAIR OR CORRECTION.
+ 
+   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGES.
+ 
+ 		     END OF TERMS AND CONDITIONS
+ 
+ 	    How to Apply These Terms to Your New Programs
+ 
+   If you develop a new program, and you want it to be of the greatest
+ possible use to the public, the best way to achieve this is to make it
+ free software which everyone can redistribute and change under these terms.
+ 
+   To do so, attach the following notices to the program.  It is safest
+ to attach them to the start of each source file to most effectively
+ convey the exclusion of warranty; and each file should have at least
+ the "copyright" line and a pointer to where the full notice is found.
+ 
+     <one line to give the program's name and a brief idea of what it does.>
+     Copyright (C) <year>  <name of author>
+ 
+     This program is free software; you can redistribute it and/or modify
+     it under the terms of the GNU General Public License as published by
+     the Free Software Foundation; either version 2 of the License, or
+     (at your option) any later version.
+ 
+     This program is distributed in the hope that it will be useful,
+     but WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     GNU General Public License for more details.
+ 
+     You should have received a copy of the GNU General Public License along
+     with this program; if not, write to the Free Software Foundation, Inc.,
+     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ 
+ Also add information on how to contact you by electronic and paper mail.
+ 
+ If the program is interactive, make it output a short notice like this
+ when it starts in an interactive mode:
+ 
+     Gnomovision version 69, Copyright (C) year name of author
+     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+     This is free software, and you are welcome to redistribute it
+     under certain conditions; type `show c' for details.
+ 
+ The hypothetical commands `show w' and `show c' should show the appropriate
+ parts of the General Public License.  Of course, the commands you use may
+ be called something other than `show w' and `show c'; they could even be
+ mouse-clicks or menu items--whatever suits your program.
+ 
+ You should also get your employer (if you work as a programmer) or your
+ school, if any, to sign a "copyright disclaimer" for the program, if
+ necessary.  Here is a sample; alter the names:
+ 
+   Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+   `Gnomovision' (which makes passes at compilers) written by James Hacker.
+ 
+   <signature of Ty Coon>, 1 April 1989
+   Ty Coon, President of Vice
+ 
+ This General Public License does not permit incorporating your program into
+ proprietary programs.  If your program is a subroutine library, you may
+ consider it more useful to permit linking proprietary applications with the
+ library.  If this is what you want to do, use the GNU Lesser General
+ Public License instead of this License.
+-

data/README

@@ -0,0 +1,168 @@
+
+ = LogSimple
+ 
+ LogSimple - a Ruby logging library. LogSimple logs messages differently according to their level. For instance an 'error' message will go to syslog, but a 'critical' message will get emailed to the administrator. Log levels, and the behaviour associated with a given level, can be defined dynamically
+ by the user. Behaviours include 'formatters' (to modify the message) and 'outputters' (to
+ output the message), and while a certain number of predefined behaviours are provided as part of the
+ library, users can create new ones.
+ 
+ Copyright (c) 2006 Netuxo
+ 
+ Author  : Netuxo (http://www.netuxo.co.uk) ; contact anselm at netuxo dot co dot uk
+ 
+ Licence : GPL V2 (See LICENSE[link:files/LICENSE.html])
+ 
+ Sponsor : War Resisters' International (http://www.wri-irg.org)
+  
+ Ruby Forge project page : http://rubyforge.org/projects/logsimple/
+ 
+ Similar projects : Logger[http://ruby-doc.org/stdlib/libdoc/logger/rdoc/classes/Logger.html], 
+ which is part of the Ruby standard library and Log4r[http://log4r.sourceforge.net/], inspired by the Apache Log4j
+ 
+ = Overview
+ == Outputters
+ Log levels are defined dynamically. Each level can be given any number of behaviours to apply when logging at that level. For
+ instance :
+ 
+   require 'logsimple.rb'
+   include LogSimple
+ 
+   Log.add_behaviour :debug, :log_stdout
+   Log.debug "message"
+
+ The line with the call to "add_behaviour" creates the log level "debug" (if it didn't already exist) and associates the behaviour "log_stdout". 
+ The following line logs the message "message" at the level debug - so it gets logged to stdout.
+ 
+ Further behaviours can be added :
+
+   Log.add_behaviour :debug, :log_syslog
+   Log.debug "second message"
+
+ Now "second message" will be logged to stdout and then to syslog.
+ 
+ Behaviours can also have parameters associated, for instance :
+
+   Log.add_behaviour :info, :log_file
+   Log.info "hello", {:filename => "mylog.txt"}
+
+ Will log the message "hello" to the file "mylog.txt". Behaviours can be given default parameters
+ to avoid specifying them every time :
+
+   Log.add_parameters :log_file, {:filename => "mylog.txt"}
+   Log.info "another hello"
+
+ Will log "another hello" to the file "mylog.txt". In this case the default parameter applies
+ to the behaviour ':log_file', so changing the parameter will affect any log level that
+ uses this behaviour. It is also possible to set a parameter for only a specific log level :
+
+   Log.add_parameters :log_file, {:filename => "mylog.txt"}
+   Log.add_level_parameters :info, :log_file, {:filename => "theotherlog.txt"}
+   Log.add_behaviour :info,  :log_file
+   Log.add_behaviour :debug, :log_file
+   Log.info  "info"
+   Log.debug "debug"
+
+ Here the message "debug" goes to the generic file - mylog.txt - while the "info" message goes
+ to theotherlog.txt
+ 
+ == Formatters
+ 
+ Some behaviours are used to modifiy the message. For instance :
+
+   Log.add_behaviour :error, :append_time, :log_stdout
+   Log.error "error"
+ 
+ The logged message will have the current time appended to it. Behaviours are called in the
+ order they are defined. So :
+
+  Log.add_behaviour :error, :log_stdout, :append_time, :log_file
+
+ Will cause errors to first be logged to stdout (without the time) then to a file, with the time.
+
+ = Default behaviours, and default log levels
+
+ The following behaviours are defined by default :
+
+ - :*null*,       which does not perform any action. The message is still sent to observers.
+ - :*log_stderr*, to log to stderr
+ - :*log_stdout*, to log to stdout
+ - :*log_file*,   to log to a file. Requires the :*file_name* parameter to be set.
+ 
+ - :*log_syslog*, to log to syslog (when available). Will use the optional parameters
+   :*name* and :*level*. :name represents the application name (will use $0 if not set) and 
+   :level represents the syslog error level. If not given, will log at syslog level 'err'.
+   The options are debug, info, notice, warning, err, alert, emerg and crit
+   
+ - :*log_email*   to send an email with the log (SMTP only). Requires :*smtp_server*, :*smtp_username*,
+   :*smtp_password*, :*from* and :*to* (may be an array) parameters to be set. If the optional
+   parameter :*subject* is set, then it is used for subject instead of $0 ; if the optional
+   parameter :*smtp_port* is set then it is used for port instead of 25 ; if the optional
+   parameter :*smtp_helo* is set then it is used for HELO message ; if the optional parameter
+   :*smpt_authtype* is set, then it is used to determine the type of authentification (:plain,
+   :login or :cram_md5). :plain is used by default.
+   
+ - :*log_exec*,    to call an executable with the log. Requires :*executable* parameter to be set
+ - :*raise*,       to raise an exception. Will use the optional :*class_name* parameter to raise the
+   execption (otherwise, raises a RuntimeError exception)
+ - :*exit*,        to terminate execution imediately
+ - :*append_level* Appends the log level at the begining of the message
+ - :*append_time*  Appends the date/time at the begining of the message
+
+ By default, the following two log levels are created :
+
+ - :*warning*,  for recovarable errors. Default behaviour is to append the level and log to stderr
+ - :*error*,    for unrecovarable errors. Default behaviour is to append the level and log to
+   stderr and raise.
+
+ = Adding your own behaviours
+
+ Any behaviour can be added at run time ; provided there is a class instance function do_#{behaviour} 
+ that takes the message string and a hash of parameters as parameters :
+
+   def Log.do_puts(message, p)
+     puts "Via puts : " + message
+   end
+
+   Log.add_behaviour :debug, :puts
+   Log.debug "bug"
+
+ Will output "Via puts : bug".
+ Behaviours that modify the message (such as :append_level) are defined by a class instance function
+ mod_#{behaviour} that takes the output level, the message string and a hash of parameters and
+ returns the modified string. For instance :
+
+  def Log.mod_append_prog(level, message, p)
+    "[" + $0.to_s + "] " + message
+  end
+
+ Will cause the program name to be appended at the begining of the message.
+
+
+ = Observers
+
+ Observers can be added as Proc objects. Those are called with the content of the message
+ before each message gets called :
+
+  last_log = nil
+  Log.add_observer {|m| last_log = m}
+
+ = Streams
+
+ It is possible to obtain stream objects linked to a particular log level which support the "<<"
+ operator. This is usefull to pass the logger as a generic stream to external classes. For instance:
+
+   o = Log.get_stream(:error)
+   o << "message"
+
+ The last line has the same effect as Log.error "message". Note that parameters cannot be passed to
+ stream objects. An extra string can be provided to a stream that gets appended at the begining
+ of every message :
+
+  o1 = Log.get_stream(:error, "[Module A] ")
+  o2 = Log.get_stream(:error, "[Module B] ")
+  o1 << "one"
+  o2 << "two"
+
+ Will log '[Module A] one' and '[Module B] two' to the error log.
+
+

data/lib/logsimple.rb

@@ -0,0 +1,254 @@
+#--
+# Copyright (c) 2006 Netuxo
+# Contact anselm@netuxo.co.uk
+#
+# This file is part of LogSimple.
+#
+# LogSimple is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# LogSimple is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Foobar; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+
+require 'syslog'
+require 'digest/md5'
+require 'net/smtp'
+
+# LogSimple is a namespace for the Log class, to avoid potential nameclashes. (though in practice
+# doing 'include LogSimple' is a plus, since otherwise every log command needs to be prefixed
+# with the name space)
+module LogSimple
+end
+
+# The Log class - a static class through which all the logging is done. See the
+# README[link:files/README.html] for usage instructions.
+class LogSimple::Log
+  @behaviour  = Hash.new
+  @parameters = Hash.new
+  @level_parameters = Hash.new
+  
+  class <<self
+    # Query all the possible behaviours, as defined by class instance methods do_#{behaviour}
+    def behaviours
+      res = Array.new
+      methods.each do |method|
+        if method =~ /^(do|mod)_(.+)$/ then res.push($2.to_sym) end
+      end
+      res
+    end
+    
+    # Query the behaviour for a given log level. Returns an array with the behaviour flags
+    # that apply.
+    def behaviour(level)
+      @behaviour[level]
+    end
+    
+    # Resets the behaviour for a given log level
+    def reset_behaviour(level)
+      @behaviour[level]  = Array.new
+      @parameters[level] = Hash.new
+    end
+    
+    # Adds a number of behaviours for the given level
+    def add_behaviour(level, *behaviours)
+      @behaviour[level] ||= Array.new
+      @behaviour[level].concat(behaviours)
+      
+      name = "#{level.to_s}"
+      if !method_defined?(name)
+        class_eval("class <<self
+                      def #{name}(message, inparams = Hash.new)
+                        log(message, \"#{level.to_s}\".to_sym, inparams)
+                      end
+                    end")
+      end
+    end
+    
+    # Sets the parameters for a given behaviour.
+    def add_parameters(behaviour, params)
+      @parameters[behaviour] ||= Hash.new
+      @parameters[behaviour].merge!(params)
+    end
+    
+    # Sets the parameters for a given behaviour for a given level. These overide the
+    # ones given for a given behaviour only.
+    def add_level_parameters(level, behaviour, params)
+      @level_parameters[level] ||= Hash.new
+      @level_parameters[level][behaviour] ||= Hash.new
+      @level_parameters[level][behaviour].merge!(params)
+    end
+    
+    # Removes all parameters associated with a given behaviour
+    def remove_parameters(behaviour)
+      @parameters.delete(behaviour)
+      @level_parameters.each_value do |h|
+        h.delete(behaviour)
+      end
+    end
+    
+    # Log a message with the given level, and parameters (as a hash). These parameters
+    # override the ones given per level or per behaviour.
+    def log(message, level = :error, inparams = Hash.new)
+      @observers ||= Array.new
+      @observers.each {|p| p.call(message)}
+      
+      @behaviour[level].each do |b|
+        params = Hash.new
+        params.merge!(@parameters[b]) if @parameters.has_key?(b)
+        params.merge!(@level_parameters[level][b]) if @level_parameters.has_key?(level) &&
+                                                       @level_parameters[level].has_key?(b)
+        params.merge!(inparams)
+        
+        if respond_to?("mod_#{b}".to_sym, true)
+          message = send("mod_#{b}".to_sym, level, message, params)
+        elsif respond_to?("do_#{b}".to_sym, true)
+          send("do_#{b}".to_sym, message, params)
+        end
+      end
+    end
+    
+    # Adds an observer to the class. Those are called with the message before the message gets
+    # logged
+    def add_observer(&obs)
+      @observers ||= Array.new
+      @observers.push(obs)
+    end
+    
+    # Gets a stream object for the given log level
+    def get_stream(level, pre = '')
+      o = Object.new
+      
+      # 'def' method courtesy of http://www.bigbold.com/snippets/posts/show/2316
+      # Allows us to dynamically add methods to an object with closures.
+      def o.def(name, &block)
+        (class << self; self end).send(:define_method, name, block)
+      end
+      o.def(:<<) do |s|
+        Log.log(pre.to_s + s.to_s, level)
+        self
+      end
+      o
+    end
+    
+    # :section: Behavious handlers
+    # The following are the individual predefined behaviour handlers
+    #
+    
+    # null handler
+    def do_null(message, p)
+    end
+    
+    # Logs a message to stderr
+    def do_log_stderr(message, p)
+      $stderr << message << "\n"
+    end
+
+    # Logs a message to stdout
+    def do_log_stdout(message, p)
+      $stdout << message << "\n"
+    end
+    
+    # Logs a message to file. Requires the :file_name parameter
+    def do_log_file(message, p)
+      File.open(p[:file_name], 'a+') do |f|
+        f << message << "\n"
+      end
+    end
+    
+    # Logs to syslog (when available). Will use the optional parameters :name and :level.
+    # :name represents the application name (will use $0 if not set) and :level represents
+    # the syslog error level. If not given, will log at syslog level 'error'. The options are
+    # debug, info, notice, warning, err, alert, emerg and crit
+    def do_log_syslog(message, p)
+      level = 'err'
+      app = $0
+      
+      level = p[:level] if p.has_key?(:level)
+      app = p[:name] if p.has_key?(:name)
+      
+      log = Syslog.open(app)
+      log.send(level.to_sym, message)
+      log.close
+    end
+    
+    # Sends an email with the log (SMTP only). Requires :smtp_server, :smtp_username, :smtp_password,
+    # :from and :to (may be an array) parameters to be set. If the optional parameter :subject is set,
+    # then it is used for subject instead of $0 ; if the optional parameter :smtp_port is set then it
+    # is used for port instead of 25 ; if the optional parameter :smtp_helo is set then it is used for
+    # HELO message ; if the optional parameter smpt_authtype is set, then it is used to determine the
+    # type of authentification (:plain, :login or :cram_md5). :plain is used by default.
+    def do_log_email(message, p)
+      port = 25
+      port = p[:smtp_port] if p.has_key?(:smtp_port)
+      helo = nil
+      helo = p[:smtp_helo] if p.has_key?(:smtp_helo)
+      authtype = :plain
+      authtype = p[:smtp_authtype] if p.has_key?(:smtp_authtype)
+      subject = $0
+      subject = p[:subject] if p.has_key?(:subject)
+      p[:from] = p[:from].joing(',') if (p[:from].kind_of? Array)
+      date_str = Time.now.strftime("%c")
+      mid = Digest::MD5.hexdigest(date_str + "-" + message).to_s
+      
+      msgstr = "
+      From: #{p[:from]}
+      To: #{p[:to]}
+      Subject: #{subject}
+      Date: #{date_str}
+      Message-Id: <#{mid}>
+      
+      #{message}
+
+      "
+
+      Net::SMTP.start(p[:smtp_server], port, helo, p[:smtp_username], p[:smtp_password], 
+                      authtype) do |smtp|
+        smtp.send_message(msgstr, p[:from], p[:to])
+      end
+    end
+    
+    # Runs an executable with the log. Requires :executable parameter to be set
+    def do_log_exec(message, p)
+      exec(p[:executable].to_s + " " +message) if fork.nil?
+    end
+    
+    # Raises an exception with the log. Will use the optional :class_name parameter to raise the
+    # execption (otherwise, raises a RuntimeError exception). #{:class_name}.new should take one string
+    # parameter (the log message)
+    def do_raise(message, p)
+      if (p.has_key?(:class_name))
+        raise Kernel.const_get(p[:class_name]).new(message)
+      end
+      
+      raise message
+    end
+    
+    # To terminate execution imediately
+    def do_exit(message, p)
+      exit
+    end
+    
+    # Adds the output level in front of the message
+    def mod_append_level(level, message, p)
+      "[" + level.to_s + "] " + message.to_s
+    end
+    
+    # Adds the date/time in front of the message
+    def mod_append_time(level, message, p)
+      "[" + Time.now.strftime("%H:%M:%S %d/%m/%y") + "] " + message.to_s
+    end
+
+  end
+end
+
+LogSimple::Log.add_behaviour :warning, :append_level, :log_stderr
+LogSimple::Log.add_behaviour :error,   :append_level, :log_stderr, :raise

data/test/unit/test_behaviours.rb

@@ -0,0 +1,242 @@
+#--
+# Copyright (c) 2006 Netuxo
+# Contact anselm@netuxo.co.uk
+#
+# This file is part of LogSimple.
+#
+# LogSimple is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# LogSimple is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Foobar; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+
+$:.unshift(File.dirname(__FILE__) + "/../../lib")
+
+require 'test/unit'
+require 'stringio'
+require 'logsimple.rb'
+include LogSimple
+
+# Set the File class to return canned data. Do this in a way that won't interfere with Test::Unit
+class File
+  class << self
+    alias :old_open :open
+    def open(name, mode)
+      if Kernel::caller[0] !~ /do_log_file/
+        old_open(name,mode)
+      else
+        $glob << "File " << name << " mode " << mode
+        yield $glob
+      end
+    end
+  end
+end
+
+# Set the syslog class to return canned data
+def Syslog.open(app)
+  $glob << app.to_s
+  o = Object.new
+  class <<o
+    def send(level, message)
+      $glob << level.to_s << message
+    end
+    def close
+    end
+  end
+  o
+end
+
+# Set the SMTP class to return canned data
+module Net
+  def SMTP.start(server, port, helo, username, password, authtype)
+    $glob << server << port << helo << username << password << authtype
+    o = Object.new
+    class <<o
+      def send_message(msg, from, to)
+        $glob << from << to << msg
+      end
+    end
+    yield o
+  end
+end
+
+# Set the Time class to return canned data. Do this so that it doesn't interfere with
+# Test::Unit
+class Time
+  class << self
+    alias :old_now :now
+    def now
+      if Kernel::caller[0] !~ /do_log_email|append_time/
+        old_now
+      else
+        o = Object.new
+        class <<o
+          def strftime(mode)
+            "strftime " + mode
+          end
+        end
+        o
+      end
+    end
+  end
+end
+
+# Set the 'exec' and 'fork' to behave as canned
+module Kernel
+  alias :old_fork :fork
+  alias :old_exec :exec
+  def fork
+    if Kernel::caller[0] !~ /do_log_exec/
+      old_fork
+    else
+      nil
+    end
+  end
+  def exec(str)
+    if Kernel::caller[0] !~ /do_log_exec/
+      old_exec(str)
+    else
+      $glob << str
+    end
+  end
+end
+
+# Set 'exit' to behave cannedely
+module Kernel
+  alias :old_exit :exit
+  def exit(c = 0)
+    if Kernel::caller[0] !~ /do_exit/
+      old_exit c
+    else
+      $glob << "Exit!"
+    end
+  end
+end
+
+# Add a custom behaviour to the Log class
+def Log.do_newb(m, p)
+  $glob << m << "-"
+  p.each {|n,v| $glob << n.to_s << ":" << v.to_s}
+end
+
+# This class tests the predefined behaviours of the Log class
+class TestTranslator < Test::Unit::TestCase
+  # Test stderr and stdout
+  def test_basic
+    $stdout = StringIO.new("", "w")
+    $stderr = StringIO.new("", "w")
+    
+    Log.reset_behaviour :test
+    Log.reset_behaviour :test2
+    Log.add_behaviour :test, :log_stdout
+    Log.add_behaviour :test2, :log_stderr
+    
+    Log.test "message 1"
+    Log.test2 "message 2"
+    
+    assert_equal("message 1\n", $stdout.string)
+    assert_equal("message 2\n", $stderr.string)
+    
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+  
+  # Test loggin to file
+  def test_file
+    $glob = StringIO.new("", "w")
+    Log.reset_behaviour :test
+    Log.add_behaviour :test, :log_file
+    
+    Log.test "message", {:file_name => 'test.txt'}
+    assert_equal("File test.txt mode a+message\n", $glob.string)
+  end
+
+  # Test logging to syslog
+  def test_syslog
+    $glob = StringIO.new("", "w")
+    Log.reset_behaviour :test
+    Log.add_behaviour :test, :log_syslog
+    
+    Log.test "message"
+    assert_equal($0 + "errmessage", $glob.string)
+  end
+  
+  # Test sending an email
+  def test_email
+    $glob = StringIO.new("", "w")
+    Log.reset_behaviour :test
+    Log.add_behaviour :test, :log_email
+    
+    Log.test "message", {:smtp_server => 'server', :smtp_username => 'username',
+                         :smtp_password => 'password', :from => 'from', :to => 'to',
+                         :subject => 'subject', :smtp_port => 'port', :smtp_helo => 'helo',
+                         :smtp_authtype => 'authtype'}
+    
+    assert_equal("serverporthelousernamepasswordauthtypefromto\n      From: from\n      To: to\n      Subject: subject\n      Date: strftime %c\n      Message-Id: <594f5e59481d8f72bb81aa1d55867f8d>\n      \n      message\n\n      ", $glob.string)
+  end
+
+  # Test the exec logger
+  def test_exec
+    $glob = StringIO.new("", "w")
+    Log.reset_behaviour :test
+    Log.add_behaviour :test, :log_exec
+    
+    Log.test "message", {:executable => 'hello'}
+    
+    assert_equal("hello message", $glob.string)
+  end
+  
+  # Test the raise 
+  def test_raise
+    Log.reset_behaviour :test
+    Log.add_behaviour :test, :raise
+    
+    assert_raise(RuntimeError) {
+      Log.test "hello"
+    }
+    
+    assert_raise(ArgumentError) {
+      Log.test "hello", {:class_name => 'ArgumentError'}
+    }
+  end
+  
+  # Test exit
+  def test_exit
+    $glob = StringIO.new("", "w")
+    Log.reset_behaviour :test
+    Log.add_behaviour :test, :exit
+    
+    Log.test "message"
+    assert_equal("Exit!", $glob.string)
+  end
+  
+  # Test append level
+  def test_appendlevel
+    $glob = StringIO.new("", "w")
+    Log.reset_behaviour :test
+    Log.add_behaviour :test, :append_level, :newb
+    
+    Log.test "hello"
+    assert_equal("[test] hello-", $glob.string)
+  end
+  
+  # Test append time
+  def test_appendtime
+    $glob = StringIO.new("", "w")
+    Log.reset_behaviour :test
+    Log.add_behaviour :test, :append_time, :newb
+    
+    Log.test "hello"
+    assert_equal("[strftime %H:%M:%S %d/%m/%y] hello-", $glob.string)
+  end
+end
+

data/test/unit/test_logsimple.rb

@@ -0,0 +1,152 @@
+#--
+# Copyright (c) 2006 Netuxo
+# Contact anselm@netuxo.co.uk
+#
+# This file is part of LogSimple.
+#
+# LogSimple is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# LogSimple is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Foobar; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+
+$:.unshift(File.dirname(__FILE__) + "/../../lib")
+
+require 'test/unit'
+require 'logsimple.rb'
+include LogSimple
+
+# Add a custom behaviour to the Log class
+$glob = ''
+def Log.do_newb(m, p)
+  $glob << m << "-"
+  p.each {|n,v| $glob << n.to_s << ":" << v.to_s}
+end
+def Log.mod_boink(l,m,p)
+  "boink! " + m
+end
+
+class TestTranslator < Test::Unit::TestCase
+  # Test querying behaviours, predefined behaviours, existence of default log levels,
+  # behaviours for default log levels.
+  # Test adding/removing behaviours to log levels, creating new log levels
+  def test_one
+    # Check all default behaviours (+ the 'newb' one we added)
+    assert_equal([:append_level, :append_time, :boink, :exit, :log_email, :log_exec, :log_file,
+                  :log_stderr, :log_stdout, :log_syslog, :newb, :null, :raise],
+                  Log.behaviours.sort {|a,b| a.to_s <=> b.to_s})
+    
+    # Check behaviours for default log levels (and test they are
+    # indeed defaults!)
+    assert_equal([:append_level, :log_stderr, :raise], 
+                 Log.behaviour(:error).sort {|a,b| a.to_s <=>b.to_s})
+    assert_equal([:append_level, :log_stderr], 
+                 Log.behaviour(:warning).sort {|a,b| a.to_s <=>b.to_s})
+
+    
+    # Check reseting behaviours
+    Log.reset_behaviour :error
+    assert_equal([], Log.behaviour(:error))
+    
+    # Check adding behaviours
+    Log.add_behaviour :newlevel, :log_stdout
+    assert_equal([:log_stdout], Log.behaviour(:newlevel))
+    Log.add_behaviour :newlevel, :raise, :exit
+    assert_equal([:log_stdout, :raise, :exit], Log.behaviour(:newlevel))
+  end
+  
+  # Test custom behaviour. Test logging. Test parameters (log parameters,
+  # level parameters and behaviour parameters)
+  def test_two
+    # Test basic login
+    $glob = ''
+    Log.add_behaviour :ll, :newb
+    Log.ll "hello"
+    assert_equal("hello-", $glob)
+    
+    # Test log parameters
+    $glob = ''
+    Log.ll "hello", {:bicycle => :good}
+    assert_equal("hello-bicycle:good", $glob)
+    
+    # Test behaviour parameters
+    $glob = ''
+    Log.add_parameters :newb, {:car => :bad}
+    Log.ll "hello"
+    assert_equal("hello-car:bad", $glob)
+    
+    # Test level parameters (and removing behaviour parameters)
+    $glob = ''
+    Log.remove_parameters :newb
+    Log.add_behaviour :mm, :newb
+    Log.add_behaviour :nn, :newb
+    Log.add_level_parameters :mm, :newb, {:airplane => :verybad}
+    Log.mm "hello"
+    Log.nn "boink"
+    assert_equal("hello-airplane:verybadboink-", $glob)
+    
+    # Test removing level parameters
+    $glob = ''
+    Log.remove_parameters :newb
+    Log.mm "hello"
+    assert_equal("hello-", $glob)
+  end
+  
+  # Test observers 
+  def test_three
+    $glob2 = ''
+    Log.add_observer {|m| $glob2 << m}
+    Log.add_behaviour :dummy, :null
+    
+    Log.dummy "hello"
+    assert_equal("hello", $glob2)
+  end
+  
+  # Test adding modifying behaviours
+  def test_four
+    # Test user defined modifying behaviour
+    $glob = ''
+    Log.reset_behaviour :blip
+    Log.add_behaviour :blip, :boink, :newb
+    Log.blip "hello"
+    assert_equal("boink! hello-", $glob)
+  end
+  
+  # Test stream objects
+  def test_five
+    $glob = ''
+    
+    Log.reset_behaviour :blip
+    Log.add_behaviour :blip, :append_level, :newb
+    
+    o = Log.get_stream :blip
+    o << "hello"
+    
+    assert_equal("[blip] hello-", $glob)
+    
+    # Make sure stream objects don't overlap each other (ie. they get the level right)
+    $glob = ''
+    Log.reset_behaviour :blop
+    Log.add_behaviour :blop, :append_level, :newb
+    (Log.get_stream :blip) << "blip"
+    (Log.get_stream :blop) << "blop"
+    assert_equal("[blip] blip-[blop] blop-", $glob)
+    
+    # Check they append strings correctly
+    $glob = ''
+    Log.reset_behaviour :blop
+    Log.add_behaviour :blop, :newb
+    (Log.get_stream :blop, "[something] ") << "hello"
+    assert_equal("[something] hello-", $glob)
+  end
+  
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: LogSimple
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2006-09-04 00:00:00 +01:00
+summary: LogSimple is a Ruby logging library
+require_paths: 
+- lib
+email: anselm@netuxo.co.uk
+homepage: logsimple.rubyforge.org
+rubyforge_project: logsimple
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Netuxo
+files: 
+- test/unit
+- test/unit/test_logsimple.rb
+- test/unit/test_behaviours.rb
+- lib/logsimple.rb
+- README
+- INSTALL
+- LICENSE
+- CHANGELOG
+test_files: 
+- test/unit/test_logsimple.rb
+rdoc_options: 
+- --main
+- README
+- --title
+- LogSimple
+extra_rdoc_files: 
+- README
+- INSTALL
+- LICENSE
+- CHANGELOG
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+