cabin 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d42c4bca378a65128dd011758c5ba0fc3427dbf
-  data.tar.gz: 9c2916616932b6e6a6b89aa9594f6c854075c95d
+  metadata.gz: a4915c746a3d520ad14afb1c7e0ca4ba6c7fa83d
+  data.tar.gz: 6d4ef30f8c4cd39fa68abb1999f9c02c7aa21ff2
 SHA512:
-  metadata.gz: 3a6e45ba8f188e20d3fc02fe7585aecfb8574907f414aba1b028c4e3ac0707e4794e11a11d4863c3ccd3a0db92fa50918394db70fe804eaa68f375bcfab835b4
-  data.tar.gz: bfc18231653001bef7f445e61d4dfe52b6aeab1baa1d04839efa22d3abd109d0826150bc59c78e548cebbfc9e8b60d6c24a356a40ff6a488d80c695faee762e7
+  metadata.gz: 0aa797866dca2939f349df4a898fa87e00d36c5adfcce1d213f894cda342a4df8751a2e3a3a655d3375108bb32d3a7e6400faa2ceb422bb6cfddf1b55173932c
+  data.tar.gz: 27e8f16b7893b2db64f582a28572d091c25578d26027a8f2d673cddb4264cd641a623e0286a6e9adbde6b8669d8385ecc0fe63cbe110b9ccaf6f73840ae12a07

data/lib/cabin/channel.rb

@@ -7,6 +7,7 @@ require "cabin/namespace"
 require "cabin/context"
 require "cabin/outputs/stdlib-logger"
 require "cabin/outputs/io"
+require "cabin/subscriber"
 require "cabin/metrics"
 require "logger" # stdlib
 require "thread"
@@ -75,16 +76,33 @@ class Cabin::Channel
       end
     end # def Cabin::Channel.each
 
-    # Get a list of filters included in this class.
-    def filters
-      @filters ||= []
-    end # def Cabin::Channel.filters
-    
-    # Register a new filter. The block is passed the event. It is expected to
+    # Get a list of actions included in this class.
+    def actions
+      @actions ||= []
+    end # def Cabin::Channel.actions
+    alias_method(:filters, :actions) # DEPRECATED
+
+    # Register a new action. The block is passed the event. It is expected to
     # modify that event or otherwise do nothing.
-    def filter(&block)
-      @filters ||= []
-      @filters << block
+    def action(&block)
+      actions << block
+    end
+    alias_method(:filter, :action) # DEPRECATED
+
+    # Get a list of conditions included in this class.
+    def conditions
+      @conditions ||= []
+    end
+
+    # Register a new condition. The block must expect an event and a subscription.
+    # It is expected to either return true (allow the event) or false (reject it).
+    def condition(&block)
+      conditions << block
+    end
+
+    # Decide to publish the event based on conditions and subscription options
+    def allow_event?(event, subscription)
+      conditions.all? { |condition| condition.call(event, subscription) }
     end
   end # class << self
 
@@ -115,7 +133,7 @@ class Cabin::Channel
   #   foo << event
   #
   # Returns a subscription id you can use later to unsubscribe
-  def subscribe(output)
+  def subscribe(output, options = {})
     # Wrap ruby stdlib Logger if given.
     if output.is_a?(::Logger)
       output = Cabin::Outputs::StdlibLogger.new(output)
@@ -123,7 +141,7 @@ class Cabin::Channel
       output = Cabin::Outputs::IO.new(output)
     end
     @subscriber_lock.synchronize do
-      @subscribers[output.object_id] = output
+      @subscribers[output.object_id] = Cabin::Subscriber.new(output, options)
     end
     return output.object_id
   end # def subscribe
@@ -159,8 +177,9 @@ class Cabin::Channel
   # is a string ISO8601 timestamp with microsecond precision.
   def publish(data, &block)
     event = {}
-    self.class.filters.each do |filter|
-      filter.call(event)
+
+    self.class.actions.each do |action|
+      action.call(event)
     end
 
     if data.is_a?(String)
@@ -171,9 +190,11 @@ class Cabin::Channel
     event.merge!(@data) # Merge any logger context
 
     @subscriber_lock.synchronize do
-      @subscribers.each do |id, output|
-        append =  block_given? ? block.call(output, event) : true
-        output << event if append
+      @subscribers.each do |_, subscriber|
+        append = block_given? ? block.call(subscriber, event) : true
+        if append && self.class.allow_event?(event, subscriber)
+          subscriber << event
+        end
       end
     end
   end # def publish

data/lib/cabin/mixins/logger.rb

@@ -3,6 +3,17 @@ require "cabin/namespace"
 # This module implements methods that act somewhat like Ruby's Logger class
 # It is included in Cabin::Channel
 module Cabin::Mixins::Logger
+
+  def self.included(klass)
+    klass.condition do |event, subscription|
+      if subscription.nil?
+        true
+      else
+        LEVELS[(subscription.options[:level] || :debug)] >= LEVELS[event[:level]].to_i
+      end
+    end
+  end
+
   attr_accessor :level
   LEVELS = {
     :fatal => 0,

data/lib/cabin/mixins/terminal.rb

@@ -3,7 +3,8 @@ require "cabin/namespace"
 module Cabin::Mixins::Terminal
 
   def terminal(message)
-    publish(message) do |output, event|
+    publish(message) do |subscriber, event|
+      output = subscriber.output
       output.respond_to?(:tty?) && output.tty?
     end
   end

data/lib/cabin/mixins/timestamp.rb

@@ -6,7 +6,7 @@ module Cabin::Mixins::Timestamp
     self.included(instance.class)
   end
   def self.included(klass)
-    klass.filter do |event|
+    klass.action do |event|
       event[:timestamp] = Time.now.strftime("%Y-%m-%dT%H:%M:%S.%6N%z")
     end
   end

data/lib/cabin/subscriber.rb

@@ -0,0 +1,11 @@
+class Cabin::Subscriber
+  attr :output, :options
+  def initialize(output, options = {})
+    @output = output
+    @options = options
+  end
+
+  def <<(data)
+    @output << data
+  end
+end

data/test/all.rb

@@ -1,13 +1,8 @@
-$: << File.join(File.dirname(__FILE__), "..", "lib")
+require "test_helper"
 
-require "rubygems"
-require "minitest/autorun"
-require "simplecov"
+base_dir = File.join(File.expand_path(File.dirname(__FILE__)), "cabin")
 
-SimpleCov.start
-
-dir = File.dirname(File.expand_path(__FILE__))
-Dir.glob(File.join(dir, "**", "test_*.rb")).each do |path|
+Dir.glob(File.join(base_dir, "test_*.rb")).each do |path|
   puts "Loading tests from #{path}"
   if path =~ /test_zeromq/
     puts "Skipping zeromq tests because they force ruby to exit if libzmq is not found"

data/test/{test_logging.rb → cabin/test_logging.rb}

@@ -1,11 +1,4 @@
-$: << File.dirname(__FILE__)
-$: << File.join(File.dirname(__FILE__), "..", "lib")
-
-require "rubygems"
-require "minitest-patch"
-require "cabin"
-require "stringio"
-require "minitest/autorun" if __FILE__ == $0
+require "test_helper"
 
 describe Cabin::Channel do
 
@@ -69,6 +62,19 @@ describe Cabin::Channel do
     assert_equal("Hello world", @target.data[0][:message])
   end 
 
+  test "subscribe with a level impacts log publishing" do
+    sub1 = Receiver.new
+    sub2 = Receiver.new
+    @logger.subscribe(sub1, :level => :info)
+    @logger.subscribe(sub2, :level => :error)
+    @logger.debug("test debug")
+    @logger.info("test info")
+    @logger.error("test error")
+
+    assert_equal("test info", sub1.data[0][:message])
+    assert_equal("test error", sub1.data[1][:message])
+    assert_equal("test error", sub2.data[0][:message])
+  end
   test "context values" do
     context = @logger.context
     context["foo"] = "hello"

data/test/{test_metrics.rb → cabin/test_metrics.rb}

@@ -1,11 +1,5 @@
-$: << File.dirname(__FILE__)
-$: << File.join(File.dirname(__FILE__), "..", "lib")
-
-require "rubygems"
-require "minitest-patch"
-require "cabin"
+require "test_helper"
 require "cabin/metrics"
-require "minitest/autorun" if __FILE__ == $0
 
 describe Cabin::Metrics do
   before do

data/test/{test_pipe.rb → cabin/test_pipe.rb}

@@ -1,11 +1,4 @@
-$: << File.dirname(__FILE__)
-$: << File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'rubygems'
-require 'minitest-patch'
-require 'cabin'
-require 'stringio'
-require 'minitest/autorun' if __FILE__ == $0
+require "test_helper"
 
 describe Cabin::Channel do
   class Receiver

data/test/{test_zeromq.rb → cabin/test_zeromq.rb}

@@ -1,10 +1,5 @@
-$: << File.dirname(__FILE__)
-$: << File.join(File.dirname(__FILE__), "..", "lib")
-
-require "rubygems"
-require "minitest-patch"
+require "test_helper"
 require "cabin/outputs/zeromq"
-require "minitest/autorun" if __FILE__ == $0
 
 describe Cabin::Outputs::ZeroMQ do
 

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require "rubygems"
+require "support/minitest-patch"
+require "minitest/autorun"
+require "cabin"
+require "stringio"
+require "simplecov"
+
+SimpleCov.start

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cabin
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Jordan Sissel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
-dependencies: []
+date: 2015-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
 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!
@@ -53,13 +67,15 @@ files:
 - lib/cabin/outputs/stdlib-logger.rb
 - lib/cabin/outputs/zeromq.rb
 - lib/cabin/publisher.rb
+- lib/cabin/subscriber.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/cabin/test_logging.rb
+- test/cabin/test_metrics.rb
+- test/cabin/test_pipe.rb
+- test/cabin/test_zeromq.rb
+- test/support/minitest-patch.rb
+- test/test_helper.rb
 homepage: https://github.com/jordansissel/ruby-cabin
 licenses:
 - Apache License (2.0)
@@ -86,4 +102,3 @@ signing_key:
 specification_version: 4
 summary: Experiments in structured and contextual logging
 test_files: []
-has_rdoc: