cabin 0.1.3 → 0.1.5

data/bin/rubygems-cabin-test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "minitest/autorun"
+test_dir = File.join(File.dirname(__FILE__), "..", "test")
+load File.join(test_dir, "test_logging.rb")

data/lib/cabin/context.rb

@@ -11,6 +11,11 @@ require "cabin/namespace"
 #     context.clear
 #     channel.info("Sample log 2") # context cleared, key "foo" removed.
 #
+# Essentially, a Cabin::Context acts as a transactional proxy on top of a
+# Cabin::Channel. Any changes you make in a context are passed through to
+# the channel while keeping an ordered record of the changes made so
+# you can unroll those changes when the context is no longer needed..
+# 
 class Cabin::Context
   def initialize(channel)
     @changes = []

data/lib/cabin/logger.rb

@@ -1,5 +1,4 @@
 require "cabin/namespace"
-require "ap"
 
 # This module implements methods that act somewhat like Ruby's Logger class
 # It is included in Cabin::Channel
@@ -19,11 +18,21 @@ module Cabin::Logger
 
   # Define the usual log methods: info, fatal, etc.
   # Each level-based method accepts both a message and a hash data.
+  #
+  # This will define methods such as 'fatal' and 'fatal?' for each
+  # of: fatal, error, warn, info, debug
+  #
+  # The first method type (ie Cabin::Channel#fatal) is what logs, and it takes a
+  # message and an optional Hash with context.
+  #
+  # The second method type (ie; Cabin::Channel#fatal?) returns true if
+  # fatal logs are being emitted, false otherwise.
   %w(fatal error warn info debug).each do |level|
     level = level.to_sym
     predicate = "#{level}?".to_sym
 
     # def info, def warn, etc...
+
     define_method(level) do |message, data={}|
       log(level, message, data) if send(predicate)
     end
@@ -50,8 +59,10 @@ module Cabin::Logger
 
     data[:level] = level
     publish(data)
-  end # def info, def warn ...
+  end # def log
 
+  # This method is used to pull useful information about the caller
+  # of the logging method such as the caller's file, method, and line number.
   private
   def debugharder(callstack, data)
     path, line, method = callstack[1].split(/(?::in `|:|')/)
@@ -63,7 +74,6 @@ module Cabin::Logger
       # We get here if the path is not in $:
       file = path
     end
-    who = "#{file}:#{line}##{method}"
     
     data[:file] = file
     data[:line] = line

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cabin
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-12 00:00:00.000000000Z
+date: 2011-10-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &22224480 !ruby/object:Gem::Requirement
+  requirement: &7463400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,12 +21,13 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22224480
+  version_requirements: *7463400
 description: This is an experiment to try and make logging more flexible and more
   consumable. Plain text logs are bullshit, let's emit structured and contextual logs.
 email:
 - jls@semicomplete.com
-executables: []
+executables:
+- rubygems-cabin-test
 extensions: []
 extra_rdoc_files: []
 files:
@@ -44,6 +45,7 @@ files:
 - test/test_logging.rb
 - LICENSE
 - CHANGELIST
+- bin/rubygems-cabin-test
 homepage: https://github.com/jordansissel/ruby-cabin
 licenses:
 - Apache License (2.0)