lumber 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b851ac9729e2f6429855786a0561d1980d8b061
-  data.tar.gz: 2d34268ac57fbe53cb0ee3d7911b4eda32a50cff
+  metadata.gz: af1ccbaa821fdc83ded7a553efcaeb418d6f4614
+  data.tar.gz: ab1025e6e0560a6b8cf7432a55ef497ac60fdfcf
 SHA512:
-  metadata.gz: 60beb8ea7f905311f5e3c978833a6d127e40b69457336ee14be84e8e53e718ba264ab5cb5c3e4d60f004f995c1ce8bc2129be8724558f9947884479a1ac162e6
-  data.tar.gz: 18e65b67e94b15be7405a5463b06fe66ec5ad3da7d87a8d6e62a196d67fc498e820dd317c201ba3d08b403683e124b576b668746aa3c7fe825a10fd284901de1
+  metadata.gz: 87932480d522328bca72bc535ef8ff0024756ba85ba4ee20425bd0dd654e68677150241eee817a137b66e7d982df89b74c2522b478646a05df5875901203c500
+  data.tar.gz: 5d8c600adb7541d9822ae8a7b3efec363d6bec494c7faec2675f6d1f89832a43f1ff37fb940154889b66d3691802d3e148cfda72542e8f0e35e568e41db93b2c

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1.2
   - jruby-19mode # JRuby in 1.9 mode
   - rbx
 before_script:

data/CHANGELOG

@@ -1,3 +1,10 @@
+1.2.2 (08/29/2014)
+------------------
+
+Pluggable logger concerns - pull request #11 from ANorwell/logger_concerns <03d0724> [Matt Conway]
+fix tests for newer rspec <033c3d6> [Matt Conway]
+test against 2.1.2 <8c40685> [Matt Conway]
+
 1.2.1 (03/13/2014)
 ------------------
 

data/README.md

@@ -19,7 +19,7 @@ To enable lumber in your rails project, add to your config/application.rb:
 
     # To expose custom variables in log4r.yml
     # config.lumber.some_option = "some_value
-    # you can set default_log_level here, config/environments/*.rb or in config/log4r.yml 
+    # you can set default_log_level here, config/environments/*.rb or in config/log4r.yml
     # config.log_level = :debug
     # enabling lumber sets config.logger to Log4r::Logger['rails']
     config.lumber.enabled = true
@@ -30,25 +30,44 @@ You should be able to use lumber in a non-rails project too, but you will have t
     #
     require 'lumber'
     Lumber.init(:root => "/my/project", :env => "development")
-  
+
     # Setup parent loggers for some known rails Base classes.  Classes that inherit
     # from these will have their logger as a parent so you can configure logging for
     # subtrees of classes in log4r.yml
     Lumber.setup_logger_hierarchy("ActiveRecord::Base", "rails::models")
     Lumber.setup_logger_hierarchy("ActionController::Base", "rails::controllers")
     Lumber.setup_logger_hierarchy("ActionMailer::Base", "rails::mailers")
-  
+
     # If you really want, you can make all classes have a logger
     # Lumber.setup_logger_hierarchy("Object", "root::object")
 
-Additionally, you can also add loggers to individual classes by including the LumberLoggerSupport module
+Additionally, you can also add loggers to individual classes by including the Lumber::LoggerSupport module
 
     class Foo
       include Lumber::LoggerSupport
     end
 
-and Foo.logger/Foo.new.logger will log to a logger named "rails::Foo".  This creates a heirarchy of loggers for classes
-nested within modules, so you can use the namespace to enable/disable loggers
+and Foo.logger/Foo.new.logger will log to a logger named "rails::Foo".  This creates a hierarchy of loggers for classes
+nested within modules, so you can use the namespace to enable/disable loggers.
+
+The logger concern used by Lumber is customizeable:
+
+    module MyLoggerConcern
+      extend ActiveSupport::Concern
+      include Lumber::LoggerSupport
+
+      # an example custom logging function
+      def log_error(error)
+        logger.error("ERROR: #{error}")
+      end
+    end
+
+This custom logger concern should be registered in an initializer so that it is available dynamically:
+
+    # before Rails::Initializer.run
+    #
+    require 'lumber'
+    Lumber.logger_concern = MyLoggerConcern
 
 If you want to change the log level for a different environment, you can do so in log4r.yml or by using the standard rails "config.log_level" setting in config/environments/<env>.rb
 

data/lib/lumber.rb

@@ -2,9 +2,9 @@ $:.unshift(File.dirname(__FILE__))
 
 # before config block
 require "monitor"
+require "lumber/logger_support"
 require "lumber/lumber"
 require "lumber/inheritance_registry"
-require "lumber/logger_support"
 require "lumber/log4r"
 require "lumber/level_util"
 require "lumber/json_formatter"

data/lib/lumber/inheritance_registry.rb

@@ -66,7 +66,7 @@ module Lumber
               # Also prevent rails from subsequently overriding our logger when rails
               # is loaded after registering logger inheritance
               if Lumber::InheritanceRegistry[subclass.name]
-                subclass.send(:include, Lumber::LoggerSupport)
+                subclass.send(:include, Lumber.logger_concern)
               end
             end
 
@@ -81,4 +81,4 @@ module Lumber
 
   end
 
-end
+end

data/lib/lumber/lumber.rb

@@ -28,6 +28,10 @@ module Lumber
   extend MonitorMixin
   extend self
 
+  # The logger concern (ActiveSupport::Concern) to include in each class.
+  attr_accessor :logger_concern
+  self.logger_concern = Lumber::LoggerSupport
+
   # Initializes log4r system.  Needs to happen in
   # config/environment.rb before Rails::Initializer.run
   #
@@ -40,6 +44,7 @@ module Lumber
   # * :monitor_enabled - defaults to true
   # * :monitor_interval - defaults to 60
   # * :monitor_store - defaults to Rails.cache if defined, memory otherwise, see Lumber::LevelUtil::MemoryCacheProvider for interface
+  # * :logger_concern - the logger concern to include, defaults to Lumber::LoggerConcern
   #
   # All config options get passed through to the log4r
   # configurator for use in defining outputters
@@ -51,7 +56,7 @@ module Lumber
     opts[:log_file] ||= "#{opts[:root]}/log/#{opts[:env]}.log"
     opts[:monitor_enabled] = true unless opts[:monitor_enabled] == false
     opts[:monitor_interval] ||= 60
-    
+
     raise "Lumber.init missing one of :root, :env" unless opts[:root] && opts[:env]
 
     cfg = Log4r::YamlConfigurator
@@ -62,6 +67,8 @@ module Lumber
 
     cfg.load_yaml_file(opts[:config_file])
 
+    self.logger_concern = opts[:logger_concern] if opts[:logger_concern]
+
     # Workaround for rails bug: http://dev.rubyonrails.org/ticket/8665
     if defined?(RAILS_DEFAULT_LOGGER)
       Object.send(:remove_const, :RAILS_DEFAULT_LOGGER)
@@ -123,7 +130,7 @@ module Lumber
       logger
     end
   end
-  
+
   # Makes :logger exist independently for subclasses and sets that logger
   # to one that inherits from base_class for each subclass as it is created.
   # This allows you to have a finer level of control over logging, for example,
@@ -144,7 +151,7 @@ module Lumber
 
     begin
       clazz = class_name.constantize
-      clazz.send(:include, Lumber::LoggerSupport)
+      clazz.send(:include, Lumber.logger_concern)
     rescue NameError
       # The class hasn't been defined yet.  No problem, we register
       # the logger for when the class is created below
@@ -155,7 +162,7 @@ module Lumber
     Lumber::InheritanceRegistry[class_name] = class_logger_fullname
   end
 
-  # Helper to make it easier to log context through log4r.yml 
+  # Helper to make it easier to log context through log4r.yml
   def format_mdc()
     ctx = Log4r::MDC.get_context.collect {|k, v| k.to_s + "=" + v.to_s }.join(" ")
     ctx.gsub!('%', '%%')

data/lib/lumber/version.rb

@@ -1,3 +1,3 @@
 module Lumber
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/spec/inheritance_registry_spec.rb

@@ -61,11 +61,11 @@ describe Lumber::InheritanceRegistry do
   describe "#remove_inheritance_handler" do
 
     it "should remove the handler" do
-      defined?(Object.inherited_with_lumber_registry).should be_false
+      defined?(Object.inherited_with_lumber_registry).should be_falsey
       InheritanceRegistry.register_inheritance_handler
-      defined?(Object.inherited_with_lumber_registry).should be_true
+      defined?(Object.inherited_with_lumber_registry).should be_truthy
       InheritanceRegistry.remove_inheritance_handler
-      defined?(Object.inherited_with_lumber_registry).should be_false
+      defined?(Object.inherited_with_lumber_registry).should be_falsey
     end
 
   end
@@ -77,18 +77,18 @@ describe Lumber::InheritanceRegistry do
     end
 
     it "adds an inheritance handler" do
-      defined?(Object.inherited_with_lumber_registry).should be_false
+      defined?(Object.inherited_with_lumber_registry).should be_falsey
       InheritanceRegistry.register_inheritance_handler
-      defined?(Object.inherited_with_lumber_registry).should be_true
+      defined?(Object.inherited_with_lumber_registry).should be_truthy
     end
 
     it "doesn't add an inheritance handler multiple times" do
       Object.singleton_class.should_receive(:alias_method_chain).once.and_call_original
-      defined?(Object.inherited_with_lumber_registry).should be_false
+      defined?(Object.inherited_with_lumber_registry).should be_falsey
       InheritanceRegistry.register_inheritance_handler
-      defined?(Object.inherited_with_lumber_registry).should be_true
+      defined?(Object.inherited_with_lumber_registry).should be_truthy
       InheritanceRegistry.register_inheritance_handler
-      defined?(Object.inherited_with_lumber_registry).should be_true
+      defined?(Object.inherited_with_lumber_registry).should be_truthy
     end
 
     it "doesn't change classes that aren't registered" do

data/spec/lumber_spec.rb

@@ -81,16 +81,16 @@ describe Lumber do
   describe "#setup_logger_hierarchy" do
 
     it "should allow registering logger for a class before the class is defined" do
-      defined?(Foo1).should be_false
+      defined?(Foo1).should be_falsey
       Lumber.setup_logger_hierarchy("Foo1", "root::foo1")
       new_class('Foo1')
       assert_valid_logger('Foo1', "root::foo1")
     end
 
     it "should not register new logger for subclasses of classes that delegate logger" do
-      defined?(Foo1).should be_false # ActionController::Base
-      defined?(Foo2).should be_false # ActionView::Base
-      defined?(Foo3).should be_false # Subclass of ActionView::Base
+      defined?(Foo1).should be_falsey # ActionController::Base
+      defined?(Foo2).should be_falsey # ActionView::Base
+      defined?(Foo3).should be_falsey # Subclass of ActionView::Base
       Lumber.setup_logger_hierarchy("Foo1", "root::foo1")
       eval "class ::Foo1; end"
       eval "class ::Foo2; delegate :logger, :to => Foo1; end"
@@ -101,20 +101,20 @@ describe Lumber do
     end
 
     it "should no logger when parent is via delegate class" do
-      defined?(Foo1).should be_false
-      defined?(Foo2).should be_false
-      defined?(Foo3).should be_false
+      defined?(Foo1).should be_falsey
+      defined?(Foo2).should be_falsey
+      defined?(Foo3).should be_falsey
       Lumber.setup_logger_hierarchy("Foo1", "root::foo1")
       eval "class ::Foo1; end"
       eval "class ::Foo2 < DelegateClass(Foo1); end"
       eval "class ::Foo3 < Foo2; end"
       assert_valid_logger('Foo1', "root::foo1")
-      defined?(Foo3.logger).should be_false
+      defined?(Foo3.logger).should be_falsey
     end
 
     it "should allow registering independent loggers for classes in a hierarchy" do
-      defined?(Foo1).should be_false
-      defined?(Foo2).should be_false
+      defined?(Foo1).should be_falsey
+      defined?(Foo2).should be_falsey
       Lumber.setup_logger_hierarchy("Foo1", "root::foo1")
       Lumber.setup_logger_hierarchy("Foo2", "root::foo2")
       new_class('Foo1')
@@ -124,38 +124,38 @@ describe Lumber do
     end
 
     it "should allow registering logger for a nested class before the class is defined" do
-      defined?(Bar1::Foo1).should be_false
+      defined?(Bar1::Foo1).should be_falsey
       Lumber.setup_logger_hierarchy("Bar1::Foo1", "root::foo1")
       new_class('Foo1', nil, 'Bar1')
       assert_valid_logger('Bar1::Foo1', "root::foo1")
     end
 
     it "should allow registering logger for a class after the class is defined" do
-      defined?(Foo1).should be_false
+      defined?(Foo1).should be_falsey
       new_class('Foo1')
-      defined?(Foo1).should be_true
+      defined?(Foo1).should be_truthy
 
       Lumber.setup_logger_hierarchy("Foo1", "root::Foo1")
       assert_valid_logger('Foo1', "root::Foo1")
     end
 
     it "should register loggers for subclasses of registered classes" do
-      defined?(Foo1).should be_false
-      defined?(Foo2).should be_false
-      defined?(Foo3).should be_false
+      defined?(Foo1).should be_falsey
+      defined?(Foo2).should be_falsey
+      defined?(Foo3).should be_falsey
       Lumber.setup_logger_hierarchy("Foo1", "root::Foo1")
       new_class('Foo1')
       new_class('Foo2', 'Foo1')
       new_class('Foo3')
       assert_valid_logger('Foo1', "root::Foo1")
       assert_valid_logger('Foo2', "root::Foo1::Foo2")
-      defined?(Foo3.logger).should be_false
+      defined?(Foo3.logger).should be_falsey
     end
 
     it "should register loggers for sub-subclasses of registered classes" do
-      defined?(Foo1).should be_false
-      defined?(Foo2).should be_false
-      defined?(Foo3).should be_false
+      defined?(Foo1).should be_falsey
+      defined?(Foo2).should be_falsey
+      defined?(Foo3).should be_falsey
       Lumber.setup_logger_hierarchy("Foo1", "root::Foo1")
       new_class('Foo1')
       new_class('Foo2', 'Foo1')
@@ -166,9 +166,9 @@ describe Lumber do
     end
 
     it "should register loggers for sub-subclasses of registered classes even when middle class not a logger" do
-      defined?(Foo1).should be_false
-      defined?(Foo2).should be_false
-      defined?(Foo3).should be_false
+      defined?(Foo1).should be_falsey
+      defined?(Foo2).should be_falsey
+      defined?(Foo3).should be_falsey
       new_class('Foo1')
       new_class('Foo2', 'Foo1')
       Lumber.setup_logger_hierarchy("Foo1", "root::Foo1")
@@ -181,26 +181,52 @@ describe Lumber do
   end
 
   context "formatted MDC context" do
-    
+
     before(:each) do
       Log4r::MDC.get_context.keys.each {|k| Log4r::MDC.remove(k) }
     end
-    
+
     it "is empty for no context" do
       Lumber.format_mdc.should == ""
     end
-    
+
     it "has context vars" do
       Log4r::MDC.put("baz", "boo")
       Log4r::MDC.put("foo", "bar")
       Lumber.format_mdc.should == "baz=boo foo=bar"
     end
-    
+
     it "escapes %" do
       Log4r::MDC.put("%foo", "%bar")
       Lumber.format_mdc.should == "%%foo=%%bar"
     end
-    
+
+  end
+
+  context "using other Logging Concerns" do
+
+    before(:each) do
+      Log4r::MDC.get_context.keys.each {|k| Log4r::MDC.remove(k) }
+    end
+
+    # An example extension to LoggerSupport
+    module TestLoggingConcern
+      extend ActiveSupport::Concern
+      include Lumber::LoggerSupport
+
+      def custom_log_context
+        Log4r::MDC.put("baz", "boo")
+      end
+    end
+
+    it "should allow the logger concern to be changed" do
+      Lumber.logger_concern = TestLoggingConcern
+      Lumber.setup_logger_hierarchy("Foo1", "root::foo1")
+      new_class('Foo1')
+
+      assert_valid_logger('Foo1', "root::foo1")
+      Foo1.new.custom_log_context
+      Lumber.format_mdc.should == "baz=boo"
+    end
   end
-  
 end

data/spec/spec_helper.rb

@@ -55,13 +55,19 @@ end
 def assert_valid_logger(class_name, logger_name)
   clazz = eval class_name
   clazz.should_not be_nil
-  clazz.respond_to?(:logger).should be_true
+  clazz.respond_to?(:logger).should be_truthy
   lgr = clazz.logger
   lgr.should be_an_instance_of(Log4r::Logger)
   lgr.fullname.should == logger_name
 end
 
 RSpec.configure do |config|
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
   config.before(:each) do
     Object.constants.grep(/^(Foo|Bar)/).each do |c|
       Object.send(:remove_const, c)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lumber
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Matt Conway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
@@ -255,4 +255,3 @@ test_files:
 - spec/server_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: