cabin 0.6.1 → 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23a9c344930f27313647006b4a9a445a8d49f852
+  data.tar.gz: 42ac4012db8a1f4acfd9a5a49ffd0f4800b91ac1
+SHA512:
+  metadata.gz: 2ee17db0377d6fcf16088b3896f81f65edf0b3cfbad2b229a2d0331ba9f6069ef2d385e7cb5ead49ec3f1d24c39ee06b60d542d1d2a0261a88f4290ea477ea66
+  data.tar.gz: 55f18ad6421077a8ee9b76aad0f17857156e55925ea5112b6ff948aa94b6bb83063c824c19a1c02d329efa45e3828a2bf456b9fed2fa31e4b86d835da9992370

data/lib/cabin/channel.rb

@@ -2,6 +2,7 @@ require "cabin/mixins/logger"
 require "cabin/mixins/pipe"
 require "cabin/mixins/timestamp"
 require "cabin/mixins/timer"
+require "cabin/mixins/terminal"
 require "cabin/namespace"
 require "cabin/context"
 require "cabin/outputs/stdlib-logger"
@@ -91,6 +92,7 @@ class Cabin::Channel
   include Cabin::Mixins::Logger
   include Cabin::Mixins::Pipe
   include Cabin::Mixins::Timer
+  include Cabin::Mixins::Terminal
 
   # All channels come with a metrics provider.
   attr_accessor :metrics
@@ -155,7 +157,7 @@ class Cabin::Channel
   #
   # A special key :timestamp is set at the time of this method call. The value
   # is a string ISO8601 timestamp with microsecond precision.
-  def publish(data)
+  def publish(data, &block)
     event = {}
     self.class.filters.each do |filter|
       filter.call(event)
@@ -170,7 +172,8 @@ class Cabin::Channel
 
     @subscriber_lock.synchronize do
       @subscribers.each do |id, output|
-        output << event
+        append =  block_given? ? block.call(output, event) : true
+        output << event if append
       end
     end
   end # def publish

data/lib/cabin/mixins/logger.rb

@@ -119,7 +119,7 @@ module Cabin::Mixins::Logger
     
     data[:file] = file
     data[:line] = line
-    data[:method] = method if data[:method]
+    data[:method] = method
   end # def debugharder
 
   public(:log)

data/lib/cabin/mixins/pipe.rb

@@ -28,7 +28,7 @@ module Cabin::Mixins::Pipe
   #     write(1, "Fri Jan 11 22:49:42 PST 2013\n", 29) = 29 {"level":"error"}
   #     Fri Jan 11 22:49:42 PST 2013 {"level":"info"}
   #     +++ exited with 0 +++ {"level":"error"}
-  def pipe(io_to_method_map)
+  def pipe(io_to_method_map, &block)
     fds = io_to_method_map.keys
 
     while !fds.empty?
@@ -43,6 +43,7 @@ module Cabin::Mixins::Pipe
         end
 
         method_name = io_to_method_map[fd]
+        block.call(line, method_name) if block_given?
         send(method_name, line)
       end # readers.each
     end # while !fds.empty?

data/lib/cabin/mixins/terminal.rb

@@ -0,0 +1,11 @@
+require "cabin/namespace"
+
+module Cabin::Mixins::Terminal
+
+  def terminal(message)
+    publish(message) do |output, event|
+      output.respond_to?(:tty?) && output.tty?
+    end
+  end
+
+end

data/lib/cabin/outputs/io.rb

@@ -48,7 +48,7 @@ class Cabin::Outputs::IO
   # Receive an event
   def <<(event)
     @lock.synchronize do
-      if !@io.tty?
+      if !tty?
         @io.puts(event.inspect)
       else
         tty_write(event)
@@ -56,6 +56,9 @@ class Cabin::Outputs::IO
     end
   end # def <<
 
+  def tty?
+    @io.tty?
+  end
   private
   def tty_write(event)
     # The io is attached to a tty, so make pretty colors.

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

@@ -1,7 +1,7 @@
 require "cabin"
 
 # Wrap Ruby stdlib's logger. This allows you to output to a normal ruby logger
-# with Cabin. Since Ruby's Logger has a love for strings alone, this 
+# with Cabin. Since Ruby's Logger has a love for strings alone, this
 # wrapper will convert the data/event to ruby inspect format before sending it
 # to Logger.
 class Cabin::Outputs::StdlibLogger
@@ -17,7 +17,11 @@ class Cabin::Outputs::StdlibLogger
     if !event.include?(:level)
       event[:level] = :info
     end
-    method = event[:level].downcase.to_sym || :info
+    if event[:level].is_a?(Symbol)
+      method = event[:level]
+    else
+      method = event[:level].downcase.to_sym || :info
+    end
     event.delete(:level)
 
     data = event.clone

data/test/test_logging.rb

@@ -27,6 +27,12 @@ describe Cabin::Channel do
     end
   end # class Receiver
 
+  class TtyReceiver < Receiver
+    def tty?
+      true
+    end
+  end
+
   before do
     @logger = Cabin::Channel.new
     @target = Receiver.new
@@ -105,6 +111,19 @@ describe Cabin::Channel do
     end
   end
 
+  test "standard use case, 'terminal' logging when there is no tty" do
+    @logger.terminal('Hello world')
+    assert_equal(true, @target.data.empty?)
+  end
+
+  test "standard use case, 'terminal' logging when there is a tty" do
+    tty_target = TtyReceiver.new
+    id   = @logger.subscribe(tty_target)
+    @logger.terminal('Hello world')
+    assert_equal('Hello world', tty_target.data[0][:message])
+    @logger.unsubscribe(id)
+  end
+
   test "extra debugging data" do 
     @logger.level = :debug
     @logger.info("Hello world")

data/test/test_pipe.rb

@@ -0,0 +1,84 @@
+$: << File.dirname(__FILE__)
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'minitest-patch'
+require 'cabin'
+require 'stringio'
+require 'minitest/autorun' if __FILE__ == $0
+
+describe Cabin::Channel do
+  class Receiver
+    attr_accessor :data
+
+    public
+    def initialize
+      @data = []
+    end
+
+    def <<(data)
+      @data << data
+    end
+  end # class Receiver
+
+  before do
+    @logger = Cabin::Channel.new
+    @target = Receiver.new
+    @logger.subscribe(@target)
+
+    @info_reader,  @info_writer  = IO.pipe
+    @error_reader, @error_writer = IO.pipe
+  end
+
+  after do
+    @logger.unsubscribe(@target.object_id)
+    [ @info_reader, @info_writer,
+      @error_reader, @error_writer ].each do |io|
+      io.close unless io.closed?
+    end
+  end
+
+  test 'Piping one IO' do
+    @info_writer.puts 'Hello world'
+    @info_writer.close
+
+    @logger.pipe(@info_reader => :info)
+    assert_equal(1, @target.data.length)
+    assert_equal('Hello world', @target.data[0][:message])
+  end
+
+  test 'Piping multiple IOs' do
+    @info_writer.puts 'Hello world'
+    @info_writer.close
+
+    @error_writer.puts 'Goodbye world'
+    @error_writer.close
+
+    @logger.pipe(@info_reader => :info, @error_reader => :error)
+    assert_equal(2, @target.data.length)
+    assert_equal('Hello world',   @target.data[0][:message])
+    assert_equal(:info,           @target.data[0][:level])
+    assert_equal('Goodbye world', @target.data[1][:message])
+    assert_equal(:error,          @target.data[1][:level])
+  end
+
+  test 'Piping with a block' do
+    @info_writer.puts 'Hello world'
+    @info_writer.close
+
+    @error_writer.puts 'Goodbye world'
+    @error_writer.close
+
+    info  = StringIO.new
+    error = StringIO.new
+
+    @logger.pipe(@info_reader => :info, @error_reader => :error) do |message, level|
+      info  << message if level == :info
+      error << message if level == :error
+    end
+
+    assert_equal('Hello world',   info.string)
+    assert_equal('Goodbye world', error.string)
+  end
+end
+

metadata

@@ -1,106 +1,88 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cabin
-version: !ruby/object:Gem::Version 
-  hash: 5
-  prerelease: 
-  segments: 
-  - 0
-  - 6
-  - 1
-  version: 0.6.1
+version: !ruby/object:Gem::Version
+  version: 0.7.1
 platform: ruby
-authors: 
+authors:
 - Jordan Sissel
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-06-18 00:00:00 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies: []
-
-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. Metrics, too!
-email: 
+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.
+  Metrics, too!
+email:
 - jls@semicomplete.com
-executables: 
+executables:
 - rubygems-cabin-test
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/cabin/metrics/timer.rb
-- lib/cabin/metrics/meter.rb
-- lib/cabin/metrics/histogram.rb
-- lib/cabin/metrics/gauge.rb
-- lib/cabin/metrics/counter.rb
-- lib/cabin/outputs/stdlib-logger.rb
-- lib/cabin/outputs/em/stdlib-logger.rb
-- lib/cabin/outputs/io.rb
-- lib/cabin/outputs/zeromq.rb
-- lib/cabin/metric.rb
+files:
+- CHANGELIST
+- LICENSE
+- bin/rubygems-cabin-test
+- examples/fibonacci-timing.rb
+- examples/metrics.rb
+- examples/pipe.rb
+- examples/sample.rb
+- examples/sinatra-logging.rb
+- lib/cabin.rb
+- lib/cabin/channel.rb
 - lib/cabin/context.rb
-- lib/cabin/timer.rb
 - lib/cabin/inspectable.rb
-- lib/cabin/publisher.rb
-- lib/cabin/mixins/logger.rb
-- lib/cabin/mixins/timer.rb
+- lib/cabin/metric.rb
+- lib/cabin/metrics.rb
+- lib/cabin/metrics/counter.rb
+- lib/cabin/metrics/gauge.rb
+- lib/cabin/metrics/histogram.rb
+- lib/cabin/metrics/meter.rb
+- lib/cabin/metrics/timer.rb
+- lib/cabin/mixins/CAPSLOCK.rb
 - lib/cabin/mixins/colors.rb
 - lib/cabin/mixins/dragons.rb
-- lib/cabin/mixins/timestamp.rb
-- lib/cabin/mixins/CAPSLOCK.rb
+- lib/cabin/mixins/logger.rb
 - lib/cabin/mixins/pipe.rb
+- lib/cabin/mixins/terminal.rb
+- lib/cabin/mixins/timer.rb
+- lib/cabin/mixins/timestamp.rb
 - lib/cabin/namespace.rb
-- lib/cabin/metrics.rb
-- lib/cabin/channel.rb
-- lib/cabin.rb
-- examples/sinatra-logging.rb
-- examples/fibonacci-timing.rb
-- examples/sample.rb
-- examples/pipe-spoon.rb
-- examples/metrics.rb
-- examples/pipe.rb
+- lib/cabin/outputs/em/stdlib-logger.rb
+- lib/cabin/outputs/io.rb
+- lib/cabin/outputs/stdlib-logger.rb
+- lib/cabin/outputs/zeromq.rb
+- lib/cabin/publisher.rb
+- lib/cabin/timer.rb
 - test/all.rb
 - test/minitest-patch.rb
+- test/test_logging.rb
 - test/test_metrics.rb
+- test/test_pipe.rb
 - test/test_zeromq.rb
-- test/test_logging.rb
-- LICENSE
-- CHANGELIST
-- bin/rubygems-cabin-test
 homepage: https://github.com/jordansissel/ruby-cabin
-licenses: 
+licenses:
 - Apache License (2.0)
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Experiments in structured and contextual logging
 test_files: []
-
-has_rdoc: 

data/examples/pipe-spoon.rb

@@ -1,25 +0,0 @@
-require "cabin"
-require "spoon"
-
-
-logger = Cabin::Channel.get
-logger.subscribe(STDOUT)
-logger.level = :info
-
-fileactions = Spoon::FileActions.new
-fileactions.close(0)
-cor, cow = IO.pipe # child stdout 
-cer, cew = IO.pipe # child stderr
-fileactions.dup2(cow.fileno, 1)
-fileactions.dup2(cew.fileno, 2)
-
-spawn_attr = Spoon::SpawnAttributes.new
-pid = Spoon.posix_spawn("/bin/sh", fileactions, spawn_attr, ["sh", "-c"] + ARGV)
-puts pid
-cow.close
-cew.close
-
-logger.pipe(cor => :info, cer => :error)
-pid, status = Process.waitpid2(pid)
-
-puts status.inspect