lumber 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c21e09e63cdd07d385285de3a1cff95010142484
-  data.tar.gz: 0d988057d2cd29655df47bd152ddcb895b210e7b
+  metadata.gz: 9045f2bfc4c8673b4b70cbe7d664defdcfd11343
+  data.tar.gz: 4a7dbe6eadb815f6418d962b27486813d5fdde47
 SHA512:
-  metadata.gz: 68b77ee858bade7f46862d63fa17a822b2f01f1bf9cc58aecb940da7dcae0ddbe53d2f39ed2ce2c80817a94a1b7a2c95418c84d1726c4a229e0c5ae79b353974
-  data.tar.gz: 82b265689f2115815cff45fabfd9d41eb03b35bcbf077877478ce2ef4d2a5aff4074f985d2fc7c20b80412066f806201bd5aa7514c269d3eb9d301da7170590d
+  metadata.gz: 6c9a7e416c58fc6a5487e905678b363376aea45e9115b83735f8a62be687b36253e4f07669b87321a79b29e1523a8ee18bff1acbcaf5e3ea2a1f47a45d1058fe
+  data.tar.gz: 367cea68835d61fc011c096f974b2f855f961a09f31ab80b45eda50037c583f5cdc1021fe50b22efbebd0b985ca164dd051958620411b4d514337cc4b5b5fd11

data/.travis.yml

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

data/CHANGELOG

@@ -1,3 +1,11 @@
+1.2.0 (03/03/2014)
+------------------
+
+Remove need for PreventRailsOverride by ensuring that lumber gets added after class is defined, and add lumber logger at singleton level Add a rails integration test to make sure common use case of lumber in rails is correct <d2364f5> [Matt Conway]
+add mri 2.1.0 to test targets <1acd50d> [Matt Conway]
+fix travis (ruby with psych on travis seems to not like leading whitespace for inline yml strings) <c635e98> [Matt Conway]
+test against 2.1.1 instead of 2.1.0 <2dcf586> [Matt Conway]
+
 1.1.3 (12/20/2013)
 ------------------
 

data/lib/lumber.rb

@@ -5,7 +5,6 @@ require "monitor"
 require "lumber/lumber"
 require "lumber/inheritance_registry"
 require "lumber/logger_support"
-require "lumber/prevent_rails_override"
 require "lumber/log4r"
 require "lumber/level_util"
 require "lumber/json_formatter"

data/lib/lumber/inheritance_registry.rb

@@ -67,7 +67,6 @@ module Lumber
               # is loaded after registering logger inheritance
               if Lumber::InheritanceRegistry[subclass.name]
                 subclass.send(:include, Lumber::LoggerSupport)
-                subclass.send(:include, Lumber::PreventRailsOverride)
               end
             end
 

data/lib/lumber/logger_support.rb

@@ -12,22 +12,30 @@ module Lumber
 
       delegate :logger, :to => "self.class"
 
-    end
-
-    module ClassMethods
-
-
-      def logger
-        # This should probably be synchronized, but don't want to
-        # incur the performance hit on such a heavily used method.
-        # I think the worst case is that it'll just get assigned
-        # multiple times, but it'll get the same reference because
-        # Lumber.logger has a lock
-        @lumber_logger ||= Lumber.logger_for(self)
-      end
-
-      def logger=(logger)
-        @lumber_logger = logger
+      # put logger on singleton class so it overrides any already there,
+      # and makes logger available from class, singleton_class and the
+      # instance (from the delegate call)
+      class << self
+
+        def lumber_logger
+          # This should probably be synchronized, but don't want to
+          # incur the performance hit on such a heavily used method.
+          # I think the worst case is that it'll just get assigned
+          # multiple times, but it'll get the same reference because
+          # Lumber.logger has a lock
+          @lumber_logger ||= Lumber.logger_for(self)
+        end
+
+        def lumber_logger=(logger)
+          @lumber_logger = logger
+        end
+
+        alias_method :logger, :lumber_logger
+
+        # prevent rails from setting logger (e.g. when initializing ActionController::Base)
+        def logger=(logger)
+          logger.debug "lumber preventing set of logger for #{self} to #{logger}, use #lumber_logger= if you really want it set"
+        end
       end
 
     end

data/lib/lumber/lumber.rb

@@ -141,15 +141,18 @@ module Lumber
   #
   def setup_logger_hierarchy(class_name, class_logger_fullname)
     Lumber::InheritanceRegistry.register_inheritance_handler
-    Lumber::InheritanceRegistry[class_name] = class_logger_fullname
 
     begin
       clazz = class_name.constantize
       clazz.send(:include, Lumber::LoggerSupport)
     rescue NameError
-      # The class hasn't been defined yet.  No problem, we've registered
-      # the logger for when the class is created.
+      # The class hasn't been defined yet.  No problem, we register
+      # the logger for when the class is created below
     end
+
+    # Don't register the class until after we see if it is already defined, that
+    # way LoggerSupport gets included _after_ class is defined and overrides logger
+    Lumber::InheritanceRegistry[class_name] = class_logger_fullname
   end
 
   # Helper to make it easier to log context through log4r.yml 

data/lib/lumber/railtie.rb

@@ -26,14 +26,16 @@ module Lumber
     end
 
     initializer "lumber.set_logger_level", :after => :initialize_logger do |app|
-      # Set the level on logger to workaround rails forcing level
-      # to a ::Logger constant in the :initialize_logger initializer
-      # https://github.com/rails/rails/issues/13421
-      config_level = app.config.log_level
-      level_str = config_level.to_s.upcase
-      level = Log4r::LNAMES.index(level_str)
-      raise "Invalid log level: #{config_level}" unless level
-      app.config.logger.level = level
+      if app.config.lumber.enabled
+        # Set the level on logger to workaround rails forcing level
+        # to a ::Logger constant in the :initialize_logger initializer
+        # https://github.com/rails/rails/issues/13421
+        config_level = app.config.log_level
+        level_str = config_level.to_s.upcase
+        level = Log4r::LNAMES.index(level_str)
+        raise "Invalid log level: #{config_level}" unless level
+        app.config.logger.level = level
+      end
     end
 
     initializer "lumber.initialize_cache", :after => :initialize_cache do |app|

data/lib/lumber/version.rb

@@ -1,3 +1,3 @@
 module Lumber
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end

data/lumber.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency("poltergeist")
   gem.add_development_dependency("awesome_print")
   gem.add_development_dependency("sinatra-contrib")
-
+  gem.add_development_dependency("rails", "~> 4.0.3")
 end

data/spec/inheritance_registry_spec.rb

@@ -95,7 +95,6 @@ describe Lumber::InheritanceRegistry do
       InheritanceRegistry.register_inheritance_handler
       class Foo; end
       Foo.ancestors.should_not include(Lumber::LoggerSupport)
-      Foo.ancestors.should_not include(Lumber::PreventRailsOverride)
     end
 
     it "adds logger support for classes that are registered" do
@@ -103,7 +102,6 @@ describe Lumber::InheritanceRegistry do
       InheritanceRegistry["Foo"] = "root::Foo"
       class Foo; end
       Foo.ancestors.should include(Lumber::LoggerSupport)
-      Foo.ancestors.should include(Lumber::PreventRailsOverride)
     end
 
   end

data/spec/json_formatter_spec.rb

@@ -21,7 +21,7 @@ describe Lumber::JsonFormatter do
       EOF
 
       cfg = Log4r::YamlConfigurator
-      cfg.load_yaml_string(yml)
+      cfg.load_yaml_string(clean_indent(yml))
       outputter = Log4r::Outputter['stdout']
       outputter.formatter.should_not be_nil
       outputter.formatter.should be_a_kind_of Lumber::JsonFormatter
@@ -47,7 +47,7 @@ describe Lumber::JsonFormatter do
       EOF
 
       cfg = Log4r::YamlConfigurator
-      cfg.load_yaml_string(yml)
+      cfg.load_yaml_string(clean_indent(yml))
       outputter = Log4r::Outputter['stdout']
       outputter.formatter.should_not be_nil
       outputter.formatter.should be_a_kind_of Lumber::JsonFormatter
@@ -74,7 +74,7 @@ describe Lumber::JsonFormatter do
       EOF
       yml.should include('#{1+1}')
       cfg = Log4r::YamlConfigurator
-      cfg.load_yaml_string(yml)
+      cfg.load_yaml_string(clean_indent(yml))
       outputter = Log4r::Outputter['stdout']
       outputter.formatter.should_not be_nil
       outputter.formatter.should be_a_kind_of Lumber::JsonFormatter
@@ -98,7 +98,7 @@ describe Lumber::JsonFormatter do
                 date_pattern: "%M"
       EOF
       cfg = Log4r::YamlConfigurator
-      cfg.load_yaml_string(yml)
+      cfg.load_yaml_string(clean_indent(yml))
       outputter = Log4r::Outputter['stdout']
       outputter.formatter.should_not be_nil
       outputter.formatter.should be_a_kind_of Lumber::JsonFormatter

data/spec/logger_support_spec.rb

@@ -53,7 +53,7 @@ describe Lumber::LoggerSupport do
     EOF
     
     cfg = Log4r::YamlConfigurator
-    cfg.load_yaml_string(yml)
+    cfg.load_yaml_string(clean_indent(yml))
     logger = Lumber.find_or_create_logger("rails::Foo")
     sio = StringIO.new 
     logger.outputters = [Log4r::IOOutputter.new("sbout", sio)]

data/spec/lumber_rails_template.rb

@@ -0,0 +1,13 @@
+Bundler.with_clean_env do
+
+  gem 'lumber', :path => File.expand_path("../..", __FILE__)
+  run "bundle install"
+
+  generate(:lumber)
+  environment 'config.lumber.enabled = true'
+  environment 'config.lumber.log_level = ""'
+
+  generate(:resource, "user", "name:string")
+  generate(:mailer, "user_mailer")
+
+end

data/spec/lumber_spec.rb

@@ -123,17 +123,6 @@ describe Lumber do
       assert_valid_logger('Foo2', "root::foo2")
     end
 
-    it "should prevent cattr_accessor for a class registered before the class is defined" do
-      defined?(Foo1).should be_false
-      Lumber.setup_logger_hierarchy("Foo1", "root::foo1")
-      new_class('Foo1')
-      Foo1.class_eval do
-        cattr_accessor :logger, :foo
-      end
-      defined?(Foo1.foo).should be_true
-      assert_valid_logger('Foo1', "root::foo1")
-    end
-
     it "should allow registering logger for a nested class before the class is defined" do
       defined?(Bar1::Foo1).should be_false
       Lumber.setup_logger_hierarchy("Bar1::Foo1", "root::foo1")

data/spec/rails_integration_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'active_support/time'
+
+describe "Rails Integration" do
+
+  class RailsRunner
+
+    def initialize(rails_root)
+      Bundler.with_clean_env do
+        @io = open("|#{rails_root}/bin/rails runner 'STDOUT.sync=STDERR.sync=true; loop { begin; puts eval gets.to_s; rescue => e; p e; end }'", "w+")
+        @pid = $?.pid
+      end
+    end
+
+    def execute(cmd)
+      @io.puts(cmd)
+      @io.gets.to_s.strip
+    end
+  end
+
+  before(:all) do
+    project_dir = File.expand_path("../..", __FILE__)
+    spec_dir = "#{project_dir}/spec"
+
+    @rails_root = "/tmp/lumber_test_rails_integration"
+    if ! File.exist?(@rails_root) || File.mtime(@rails_root) < 1.day.ago
+      FileUtils.rm_rf(@rails_root)
+      out = `cd #{project_dir} && bundle exec rails new #{@rails_root} -m #{spec_dir}/lumber_rails_template.rb`
+      fail(out) unless $?.success?
+    end
+
+    @runner = RailsRunner.new(@rails_root)
+  end
+
+  after(:all) do
+    @runner.execute('exit!')
+    #FileUtils.rm_rf(@rails_root)
+  end
+
+  it "has a rails logger" do
+    @runner.execute("Rails.logger.class").should == "Log4r::Logger"
+    @runner.execute("Rails.logger.fullname").should == "rails"
+  end
+
+  it "has a rails logger for models" do
+    @runner.execute("User.logger.class").should == "Log4r::Logger"
+    @runner.execute("User.logger.fullname").should == "rails::models::User"
+  end
+
+  it "has a rails logger for mailers" do
+    @runner.execute("UserMailer.logger.class").should == "Log4r::Logger"
+    @runner.execute("UserMailer.logger.fullname").should == "rails::mailers::UserMailer"
+  end
+
+  it "has a rails logger for controllers" do
+    @runner.execute("UsersController.logger.class").should == "Log4r::Logger"
+    @runner.execute("UsersController.logger.fullname").should == "rails::controllers::UsersController"
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -26,6 +26,22 @@ require 'capybara/rspec'
 require 'capybara/poltergeist'
 Capybara.javascript_driver = :poltergeist
 
+def clean_indent(str)
+  first_indent = nil
+  str.lines.collect do |line|
+    if line =~ /\S/ # line has at least one non-whitespace character
+      if first_indent.nil?
+        line =~ /^(\s*)/
+        first_indent = $1
+      end
+      line.slice!(0, first_indent.size)
+      line
+    else
+      ""
+    end
+  end.join()
+end
+
 def new_class(class_name, super_class=nil, super_module=nil)
   s = "class #{class_name}"
   s << " < #{super_class}" if super_class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lumber
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Matt Conway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-20 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
@@ -150,6 +150,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
 description: Lumber tries to make it easy to use the more robust log4r logging system
   within your rails application.  To do this it sets up log4r configuration from a
   yml file, and provides utility methods for adding a :logger accessor to classes
@@ -180,7 +194,6 @@ files:
 - lib/lumber/log4r.rb
 - lib/lumber/logger_support.rb
 - lib/lumber/lumber.rb
-- lib/lumber/prevent_rails_override.rb
 - lib/lumber/railtie.rb
 - lib/lumber/server.rb
 - lib/lumber/server/public/lib/bootstrap/css/bootstrap-responsive.css
@@ -201,8 +214,9 @@ files:
 - spec/json_formatter_spec.rb
 - spec/level_util_spec.rb
 - spec/logger_support_spec.rb
+- spec/lumber_rails_template.rb
 - spec/lumber_spec.rb
-- spec/prevent_rails_override_spec.rb
+- spec/rails_integration_spec.rb
 - spec/server_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -235,8 +249,9 @@ test_files:
 - spec/json_formatter_spec.rb
 - spec/level_util_spec.rb
 - spec/logger_support_spec.rb
+- spec/lumber_rails_template.rb
 - spec/lumber_spec.rb
-- spec/prevent_rails_override_spec.rb
+- spec/rails_integration_spec.rb
 - spec/server_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb

data/lib/lumber/prevent_rails_override.rb

@@ -1,44 +0,0 @@
-require 'active_support/concern'
-
-module Lumber
-
-  # Include this module to add a logger accessible from both class and instance methods.
-  # A logger hierarchy will be created if the class including this module is nested
-  module PreventRailsOverride
-    extend ActiveSupport::Concern
-
-    included do
-
-      class << self
-        # Prevent rails from overwriting our logger
-        def cattr_reader_with_lumber(*syms)
-          without_logger = syms.reject {|s| s == :logger}
-          cattr_reader_without_lumber(*without_logger)
-        end
-        alias_method_chain :cattr_reader, :lumber
-
-        def cattr_writer_with_lumber(*syms)
-          without_logger = syms.reject {|s| s == :logger}
-          cattr_writer_without_lumber(*without_logger)
-        end
-        alias_method_chain :cattr_writer, :lumber
-
-        def mattr_reader_with_lumber(*syms)
-          without_logger = syms.reject {|s| s == :logger}
-          mattr_reader_without_lumber(*without_logger)
-        end
-        alias_method_chain :mattr_reader, :lumber
-
-        def mattr_writer_with_lumber(*syms)
-          without_logger = syms.reject {|s| s == :logger}
-          mattr_writer_without_lumber(*without_logger)
-        end
-        alias_method_chain :mattr_writer, :lumber
-
-      end
-
-    end
-
-  end
-
-end

data/spec/prevent_rails_override_spec.rb

@@ -1,45 +0,0 @@
-require 'spec_helper'
-
-describe Lumber::PreventRailsOverride do
-
-  it "should prevent cattr_accessor for :logger" do
-    new_class('Foo1')
-    Foo1.send(:include, Lumber::PreventRailsOverride)
-    Foo1.class_eval do
-      cattr_accessor :logger
-    end
-    Foo1.method_defined?(:logger).should be_false
-    Foo1.method_defined?(:logger=).should be_false
-  end
-
-  it "should allow cattr_accessor for attrs other than :logger" do
-    new_class('Foo1')
-    Foo1.send(:include, Lumber::PreventRailsOverride)
-    Foo1.class_eval do
-      cattr_accessor :foo
-    end
-    Foo1.method_defined?(:foo).should be_true
-    Foo1.method_defined?(:foo=).should be_true
-  end
-
-  it "should prevent mattr_accessor for :logger" do
-    new_class('Foo1')
-    Foo1.send(:include, Lumber::PreventRailsOverride)
-    Foo1.class_eval do
-      mattr_accessor :logger
-    end
-    Foo1.method_defined?(:logger).should be_false
-    Foo1.method_defined?(:logger=).should be_false
-  end
-
-  it "should allow mattr_accessor for attrs other than :logger" do
-    new_class('Foo1')
-    Foo1.send(:include, Lumber::PreventRailsOverride)
-    Foo1.class_eval do
-      mattr_accessor :foo
-    end
-    Foo1.method_defined?(:foo).should be_true
-    Foo1.method_defined?(:foo=).should be_true
-  end
-
-end