simplelog 0.1.1 → 0.1.2

data/lib/simplelog.rb

@@ -1,7 +1,16 @@
+# =Simplelog
+# Jon Egil Strand
+#
+# Simplelog is the simplest of loggers, built to log when your needs are simple.
+# To use, just require 'simplelog' and all your puts statements are saved to a 
+# LOG_.txt file as well as printed on screen. That's it and that's that.
+#
+# This makes it ideal for situations where you need simple logging, or when an 
+# existing application grows and you need to save output in a hurry.
 
 require 'date'
 
-
+# Here we redefine puts
 module Kernel
   alias old_puts puts
   def puts(text)
@@ -9,49 +18,60 @@ module Kernel
   end
 end
 
+#
+# All puts statements are logged to file and shown on screen. 
+#
+# To use: 
+#
+# require 'simplelog' 
+#
 class Simplelog
   @@dir = "."
-  @@name = ""
-  @@loggtext = ""
+  @@name = "LOG_"
+  @@logtext = ""
   
   def Simplelog.name
     @@name
   end
 
+  # The logs name defaults to LOG_. This can be redefined at wish.
   def Simplelog.name=(name)
     @@name = name  
   end
-
+  
   def Simplelog.dir
     @@dir
   end
-
+  
+  # Where will you save your log? Defaults to "."
   def Simplelog.dir=(dir)
     @@dir = dir.sub(/\\*$/, "")
   end
  
-  def Simplelog.loggtext
-    @@loggtext
+  def Simplelog.logtext
+    @@logtext
   end
 
+  # Allows you to clear your log if you so wish
   def Simplelog.clear
-    @loggtext = ""
+    @logtext = ""
   end
 
   def Simplelog.puts(text)
     old_puts text
-    @@loggtext << text << "\n"
+    @@logtext << text << "\n"
   end
   
+  # Directory and filename. Subsequent underscores are removed.
   def Simplelog.filename
-    "#@@dir\\LOG_#{@@name}_#{Date.today.to_s}.txt".sub("__", "_")
+    "#@@dir\\#{@@name}_#{Date.today.to_s}.txt".sub("__", "_")
   end
 
   def Simplelog.save
-    if !@@loggtext.empty?
+    if !@@logtext.empty?
       Dir::mkdir(@@dir) if !FileTest.directory?(@@dir)    
       File.open(filename, "w") do |f|
-        f.puts @@loggtext
+        f.puts @@logtext
       end
     end
   end

data/test/simplelogtest.rb

@@ -3,10 +3,6 @@ require 'lib/simplelog'
 
 class Simplelogtest < Test::Unit::TestCase
 
-  def test_naive
-    assert (2 < 3)
-  end
-  
   def setup
     @dirname = "testlogs-please_delete"
     @logname = "name_for_a_log" 
@@ -24,31 +20,38 @@ class Simplelogtest < Test::Unit::TestCase
     assert_equal(Simplelog.dir, @dirname)
   end  
   
-  def test_loggtext    
+  def test_puts    
     puts "Some more text for tests"
-    puts "We are still testing"    
-    assert_match(/testing\n$/, Simplelog.loggtext)    
+    puts "We are testing"    
+    assert_match(/testing\n$/, Simplelog.logtext)    
   end
   
+  def test_p
+    p "Don't log this"
+    assert_no_match(/Don't log this/, Simplelog.logtext)
+    puts "But log this"
+    assert_match(/But log this/, Simplelog.logtext)
+  end
+
+  #Make sure that file.puts works as it 
   def test_file_puts
-    output = "output.txt"
-    not_logged = "This should not be logged in the log"    
-    File.open(output, "w") do |file|
+    output_file = "output.txt"
+    File.open(output_file, "w") do |file|
       puts "This should be logged"
-      file.puts not_logged
+      file.puts "This should not be logged"
     end
-    assert_match(/should be logged\n/, Simplelog.loggtext)
-    assert_no_match(/output.txt/, Simplelog.loggtext)
-    assert(FileTest.file?(output))
-    File.open(output) do |file|
-      assert_equal(not_logged, file.readline.chomp)
+    assert_match(/should be logged\n/, Simplelog.logtext)
+    assert_no_match(/should not be logged/, Simplelog.logtext)
+    assert(FileTest.file?(output_file))
+    File.open(output_file) do |file|
+      assert_equal("This should not be logged", file.readline.chomp)
     end
-    File.delete(output)
-    assert(!FileTest.file?(output))
+    File.delete(output_file)
+    assert(!FileTest.file?(output_file))
   end
   
   def test_filename
-    fname = "#@dirname\\LOG_#{@logname}_#{Date.today.to_s}.txt"
+    fname = "#@dirname\\#{@logname}_#{Date.today.to_s}.txt"
     assert_equal(Simplelog.filename, fname)    
   end
   
@@ -59,7 +62,8 @@ class Simplelogtest < Test::Unit::TestCase
     assert(FileTest.file?(Simplelog.filename))
     File.delete(Simplelog.filename)
     Dir.delete(Simplelog.dir)    
+    Simplelog.dir
     assert(!FileTest.directory?(Simplelog.dir))    
     assert(!FileTest.file?(Simplelog.filename))
   end
-end
+end

metadata

@@ -3,9 +3,9 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: simplelog
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2006-07-19 00:00:00 +02:00
-summary: The simplest logger ever.
+  version: 0.1.2
+date: 2006-07-20 00:00:00 +02:00
+summary: The simplest logger ever. Just require 'simplelog' and all puts statements are logged to .txt as well as shown on screen.
 require_paths: 
 - lib
 email: jes@luretanker.no