cabin 0.1.1 → 0.1.2

data/CHANGELIST

@@ -0,0 +1,4 @@
+v0.1.2 (2011-10-12)
+  - Added file+line+method context if the logger level is debug
+
+!!date +\%Y-\%m-\%d

data/examples/{fib.rb → fibonacci-timing.rb}

@@ -2,6 +2,11 @@ require "rubygems"
 require "cabin"
 require "logger"
 
+def fib(n)
+  return 1 if n < 2
+  return fib(n - 1) + fib(n - 2)
+end
+
 # Logging::... is something I'm implemented and experimenting with.
 @logger = Cabin::Channel.new
 
@@ -15,10 +20,9 @@ require "logger"
 # You can store arbitrary key-value pairs in the logging channel. 
 # These are emitted with every event.
 
-n = 30
+n = 35
 @logger[:input] = n
 @logger.time("fibonacci latency") do
-  #fib(30)
-  sleep(rand*2)
+  fib(n)
 end
 

data/lib/cabin/logger.rb

@@ -1,5 +1,7 @@
 require "cabin/namespace"
 
+# This module implements methods that act somewhat like Ruby's Logger class
+# It is included in Cabin::Channel
 module Cabin::Logger
   attr_accessor :level
   LEVELS = {
@@ -10,20 +12,59 @@ module Cabin::Logger
     :debug => 4
   }
 
+  def level=(value)
+    @level = value.to_sym
+  end # def level
+
   # Define the usual log methods: info, fatal, etc.
   # Each level-based method accepts both a message and a hash data.
   %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={}|
-      next unless LEVELS[@level] >= LEVELS[level]
-      if message.is_a?(Hash)
-        data.merge!(message)
-      else
-        data[:message] = message
-      end
-      data[:level] = level
-      publish(data)
+      log(level, message, data) if send(predicate)
     end
+
+    # def info?, def warn? ...
+    # these methods return true if the loglevel allows that level of log.
+    define_method(predicate) do 
+      return LEVELS[@level] >= LEVELS[level]
+    end # def info?, def warn? ...
   end # end defining level-based log methods
+
+  private
+  def log(level, message, data={})
+    # Invoke 'info?' etc to ask if we should act.
+    if message.is_a?(Hash)
+      data.merge!(message)
+    else
+      data[:message] = message
+    end
+
+    # Add extra debugging bits (file, line, method) if level is debug.
+    debugharder(caller, data) if @level == :debug
+
+    data[:level] = level
+    publish(data)
+  end # def info, def warn ...
+
+  private
+  def debugharder(callstack, data)
+    path, line, method = callstack[1].split(/(?::in `|:|')/)
+    whence = $:.detect { |p| path.start_with?(p) }
+    if whence
+      # Remove the RUBYLIB path portion of the full file name 
+      file = path[whence.length + 1..-1]
+    else
+      # We get here if the path is not in $:
+      file = path
+    end
+    who = "#{file}:#{line}##{method}"
+    
+    data[:file] = file
+    data[:line] = line
+    data[:method] = method
+  end # def debugharder
 end # module Cabin::Logger

data/test/test_logging.rb

@@ -8,6 +8,11 @@ require "stringio"
 require "minitest/autorun" if __FILE__ == $0
 
 describe Cabin::Channel do
+
+  # Cabin::Channel is a subscription thing, so implement
+  # a simple receiver that just stores events in an array
+  # for later access - this lets us see exactly what is
+  # logged, in order.
   class Receiver
     attr_accessor :data
 
@@ -84,6 +89,8 @@ describe Cabin::Channel do
       @logger.level = level
       @logger.send(level, "Hello world")
       event = @target.data[0]
+      assert(@logger.send("#{level}?"),
+             "At level #{level}, Channel##{level}? should return true.")
       assert_equal("Hello world", event[:message])
       assert_equal(level, event[:level])
     end
@@ -98,4 +105,22 @@ describe Cabin::Channel do
       assert_equal(0, @target.data.length)
     end
   end
-end
+
+  test "extra debugging data" do 
+    @logger.level = :debug
+    @logger.info("Hello world")
+    event = @target.data[0]
+    assert(event.include?(:file), "At debug level, there should be a :file attribute")
+    assert(event.include?(:line), "At debug level, there should be a :line attribute")
+    assert(event.include?(:method), "At debug level, there should be a :method attribute")
+  end
+
+  test "extra debugging data absent if log level is not debug" do 
+    @logger.level = :info
+    @logger.info("Hello world")
+    event = @target.data[0]
+    assert(!event.include?(:file), "At non-debug level, there should not be a :file attribute")
+    assert(!event.include?(:line), "At non-debug level, there should not be a :line attribute")
+    assert(!event.include?(:method), "At non-debug level, there should not be a :method attribute")
+  end
+end # describe Cabin::Channel do

metadata

@@ -1,45 +1,35 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cabin
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jordan Sissel
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-11 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &19828200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-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: 
+  prerelease: false
+  version_requirements: *19828200
+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: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/cabin.rb
 - lib/cabin/outputs/stdlib-logger.rb
 - lib/cabin/channel.rb
@@ -47,44 +37,37 @@ files:
 - lib/cabin/timer.rb
 - lib/cabin/context.rb
 - lib/cabin/logger.rb
-- examples/fib.rb
+- examples/fibonacci-timing.rb
 - examples/sinatra-logging.rb
 - examples/sample.rb
 - test/minitest-patch.rb
 - test/test_logging.rb
 - LICENSE
-has_rdoc: true
+- CHANGELIST
 homepage: https://github.com/jordansissel/ruby-cabin
-licenses: 
+licenses:
 - Apache License (2.0)
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Experiments in structured and contextual logging
 test_files: []
-