log_jam 0.0.1 → 0.0.2

data/log_jam.rb

@@ -3,13 +3,20 @@ module LogJam
 
   @@logs = []
 
+  def setup_logger(logger, level)
+    @@default_logger = logger
+    @@default_level = level
+  end
+
   def priorities(*list)
     @@priorities = list
   end
 
   def puts(msg)
     @@logs << msg
-    Rails.logger.info(msg)
+    if defined? @@default_logger
+      @@default_logger.send(@@default_level, msg)
+    end
   end
 
   def write_to_disk

data/log_jam_test.rb

@@ -21,6 +21,14 @@ class InvoiceLog < Log; end
 
 class LogJamTest < MiniTest::Unit::TestCase
 
+  def test_setup_default_logger
+    log_msg = "invoice=123 account=123"
+    LogJam.setup_logger(Rails.logger, :info)
+    LogJam.priorities(:invoice, :account)
+    LogJam.puts(log_msg)
+    LogJam.drain
+  end
+
   def test_write_to_disk
     log_msg = "invoice=123 account=123"
     LogJam.priorities(:invoice, :account)

data/readme.md

@@ -1,10 +1,41 @@
-# LogJam
+# log_jam
 
 A proxy that persists log messages to a database.
 
+## Requirements
+
+log_jam also will call ActiveRecord like classes. `AccountLog.create({})`
+
+## Install
+
+```bash
+$ gem install log_jam
+```
+
 ## Usage
 
 ```ruby
+  # log_jam will pass along log messages in real time. log_jam will not wait for
+  # you to call drain before it sends messages to the default logger.
+  LogJam.setup_logger(Rails.logger, :info)
+
+  # the order of our priorities determines which table the log will be stored in.
+  LogJam.priorities(:invoice, :account)
+
+  # log_jam will also pass this message to Rails.logger.info
   LogJam.puts("account=123 invoice=456  invoice created")
-  LogJam.puts("account=123 page=true core services off-line")
+
+  # This message drains the logs and figures out how to write to the database.
+  # Since we defined our first priority as :invoice, LogJam will ask the kernel
+  # for the InvoiceLog class. It will then send the create message to the class
+  # with parameters that look like this: {:invoice_id => 456, :message => "account=123 invoice=456  invoice created"}
+  LogJam.write_to_disk
+```
+
+## Hacking on log_jam
+
+I think this lib is feature complete; however, if you find a bug please add a test. To run the tests:
+
+```bash
+$ ruby log_jam_test.rb
 ```

metadata

@@ -2,7 +2,7 @@
 name: log_jam
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ryan Smith