cabin 0.1.5 → 0.1.6

data/CHANGELIST

@@ -1,3 +1,12 @@
+v0.1.6 (2011-11-07)
+  - Add 'Dragons' mixin for times when info/debug/fatal log levels don't cut it
+    and you'd rather deal in D&D alignments instead.
+  - Add Cabin::Outputs::EmStdlibLogger which wraps ruby's stdlib logger but in
+    a way smartly usable with EventMachine. (Contributed by Sean Porter)
+  - Moved mixins to Cabin::Mixins like Logger and the new Dragon mixin.
+
+v0.1.3 through v0.1.5 were not documented here. Sad.
+
 v0.1.2 (2011-10-12)
   - Added file+line+method context if the logger level is debug
 

data/lib/cabin/channel.rb

@@ -1,4 +1,4 @@
-require "cabin/logger"
+require "cabin/mixins/logger"
 require "cabin/namespace"
 require "cabin/timer"
 require "cabin/context"
@@ -43,7 +43,7 @@ require "logger"
 #     I, [2011-10-11T01:00:57.993575 #1209]  INFO -- : {:timestamp=>"2011-10-11T01:00:57.993517-0700", :message=>"Done in foo", :level=>:info}
 #
 class Cabin::Channel
-  include Cabin::Logger
+  include Cabin::Mixins::Logger
 
   # Create a new logging channel.
   # The default log level is 'info'

data/lib/cabin/mixins/dragons.rb

@@ -0,0 +1,34 @@
+require "cabin/namespace"
+
+# An experiment to use AD&D-style log levels, because why not? 'info' and
+# 'fatal' and other log levels are pretty lame anyway.
+#
+# Plus, now you can 'include Dragons' in your logger, which means it
+# has +2 against Knights and a special fire breathing attack..
+module Cabin::Mixins::Dragons
+  orders = %w(lawful ambivalent chaotic)
+  desires = %w(good neutral evil)
+
+  orders.each do |order|
+    desires.each do |desire|
+      # alignment will be like 'lawful_good' etc
+      alignment = "#{order} #{desire}"
+      define_method(alignment.gsub(" ", "_")) do |message, data={}|
+        log(alignment, message, data)
+      end
+    end # desires
+  end # orders
+
+  private
+  def log(alignment, message, data={})
+    # Invoke 'info?' etc to ask if we should act.
+    if message.is_a?(Hash)
+      data.merge!(message)
+    else
+      data[:message] = message
+    end
+
+    data[:alignment] = alignment
+    publish(data)
+  end # def log
+end # module Cabin::Dragons

data/lib/cabin/{logger.rb → mixins/logger.rb}

@@ -2,7 +2,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
+module Cabin::Mixins::Logger
   attr_accessor :level
   LEVELS = {
     :fatal => 0,
@@ -79,4 +79,4 @@ module Cabin::Logger
     data[:line] = line
     data[:method] = method
   end # def debugharder
-end # module Cabin::Logger
+end # module Cabin::Mixins::Logger

data/lib/cabin/namespace.rb

@@ -1,3 +1,4 @@
 module Cabin
   module Outputs; end
+  module Mixins; end
 end

data/lib/cabin/outputs/em-stdlib-logger.rb

@@ -0,0 +1,39 @@
+require "cabin"
+require "json"
+require "eventmachine"
+
+# Wrap Ruby stdlib's logger and make it EventMachine friendly. This
+# allows you to output to a normal ruby logger with Cabin. Since
+# Ruby's Logger has a love for strings alone, this wrapper will
+# convert the data/event to json before sending it to Logger.
+class Cabin::Outputs::EmStdlibLogger
+  public
+  def initialize(logger)
+    @logger_queue = EM::Queue.new
+    @logger = logger
+    consumer # Consume lines from a queue and send them with logger
+  end # def initialize
+
+  def consumer
+    line_sender = Proc.new do |line|
+      # This will call @logger.info(data) or something similar
+      @logger.send(line[:method], line[:message])
+      EM.next_tick do
+        # Do it again
+        @logger_queue.pop(&line_sender)
+      end
+    end
+    # Pop line off queue and send it with logger
+    @logger_queue.pop(&line_sender)
+  end
+
+  # Receive an event
+  public
+  def <<(data)
+    line = Hash.new
+    line[:method] = data[:level] || "info"
+    line[:message] = "#{data[:message]} #{data.to_json}"
+    # Push line onto queue for later sending
+    @logger_queue.push(line)
+  end # def <<
+end # class Cabin::Outputs::EmStdlibLogger

data/lib/test.rb

@@ -0,0 +1,8 @@
+require "cabin"
+require "cabin/mixins/dragons"
+
+logger = Cabin::Channel.new
+logger.subscribe(Logger.new(STDOUT))
+logger.extend(Cabin::Mixins::Dragons)
+
+logger.chaotic_evil("Some shit is whack")

metadata

@@ -1,75 +1,97 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: cabin
-version: !ruby/object:Gem::Version
-  version: 0.1.5
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 6
+  version: 0.1.6
 platform: ruby
-authors:
+authors: 
 - Jordan Sissel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-28 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-11-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &7463400 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  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:
+  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: 
 - jls@semicomplete.com
-executables:
+executables: 
 - rubygems-cabin-test
 extensions: []
+
 extra_rdoc_files: []
-files:
-- lib/cabin.rb
+
+files: 
+- lib/test.rb
+- lib/cabin/context.rb
+- lib/cabin/timer.rb
 - lib/cabin/outputs/stdlib-logger.rb
-- lib/cabin/channel.rb
+- lib/cabin/outputs/em-stdlib-logger.rb
+- lib/cabin/mixins/logger.rb
+- lib/cabin/mixins/dragons.rb
 - lib/cabin/namespace.rb
-- lib/cabin/timer.rb
-- lib/cabin/context.rb
-- lib/cabin/logger.rb
+- lib/cabin/channel.rb
+- lib/cabin.rb
 - examples/fibonacci-timing.rb
 - examples/sinatra-logging.rb
 - examples/sample.rb
-- test/minitest-patch.rb
 - test/test_logging.rb
+- test/minitest-patch.rb
 - LICENSE
 - CHANGELIST
 - bin/rubygems-cabin-test
 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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Experiments in structured and contextual logging
 test_files: []
+