log_switch 0.2.0 → 0.3.0

data/History.rdoc

@@ -1,3 +1,13 @@
+=== 0.3.0 / 2012-02-03
+
+* Improvements:
+  * gh-2[https://github.com/turboladen/log_switch/issues/2]: Added ability to
+    mix in {LogSwitch::Mixin} to classes to allow calling +#log+ in your class
+    and have it delegate to your singleton logger.
+* Bug fixes:
+  * gh-3[https://github.com/turboladen/log_switch/issues/3]: Fixed warning on
+    +@before_block+.
+
 === 0.2.0 / 2011-12-05
 
 * Added ability to pass a block to +.log+ to have code executed before logging.

data/README.rdoc

@@ -44,7 +44,7 @@ Get your app logging with a single point of logging:
   MyThing.log = false
   MyThing.log "You're my favorite." # => No logging occurs!
 
-By default, LogSwitch sets the log level to :debug.  You can change the default
+By default, LogSwitch sets the log level to +:debug+.  You can change the default
 log level as you go:
 
   MyThing.log_level = :warn
@@ -99,6 +99,39 @@ Here's the above example, using the one-timer:
   # No block gets called here (assuming the +#before+ hook from above hasn't been defined)
   MyThing.log "I'm hungry..."
 
+=== Mixin for lazy people like me
+
+All that stuff above describes how you can extend some class of yours to make it
+a singleton logger (well, not that you can't have it do other stuff too...).  If
+you're using this in a sizeable project, however, it can get tiresome typing out
+<tt>MyThing.log "message"</tt> over and over again; for me, it's usually more
+like <tt>MyThing::Logger.log "message"</tt>.  The {LogSwitch::Mixin} mixin
+lets you shorten things up.
+
+If you've extended {LogSwitch} into a class...
+
+  class MyThing
+    class Logger
+      extend LogSwitch
+    end
+  end
+
+...then you can mix in {LogSwitch::Mixin} to your other classes that you want to
+use +MyThing::Logger.log+:
+
+  class MyThing
+    class WidgetMaker
+      include LogSwitch::Mixin
+
+      def make_widget
+        log "Making widget...", :info    # This will delegate to MyThing::Logger.log
+      end
+    end
+  end
+
+This lets you still use a single logger throughout your classes, but shortens
+the amount of typing you have to do.
+
 == REQUIREMENTS
 
 * Rubies (tested):

data/Rakefile

@@ -11,7 +11,9 @@ YARD::Rake::YardocTask.new do |t|
   t.options += %w(--main README.rdoc)
 end
 
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = %w(-w)
+end
 
 # Alias for rubygems-test
 task :test => :spec

data/lib/log_switch.rb

@@ -1,11 +1,27 @@
-require File.expand_path(File.dirname(__FILE__) + '/log_switch/version')
 require "logger"
+require File.expand_path(File.dirname(__FILE__) + '/log_switch/version')
+require File.expand_path(File.dirname(__FILE__) + '/log_switch/mixin')
 
 # LogSwitch allows for extending a class/module with a logger and, most
 # importantly, allows for turning off logging programmatically.  See the
 # +README.rdoc+ for more info.
 module LogSwitch
 
+  # Saves the name of the class that extended itself with this module.  Used
+  # by {LogSwitch::Mixin} to know which class to include itself to.
+  def self.extend_object(base)
+    @extender = base
+    super(base)
+  end
+
+  # Simply returns the name of the class that extended itself with this module.
+  # It's set by {.extend_object}.
+  #
+  # @return [Class] The class that extended itself with LogSwitch.
+  def self.extender
+    @extender
+  end
+
   # Use to turn logging on or off.
   attr_writer :log
 
@@ -30,15 +46,15 @@ module LogSwitch
     @log_level ||= :debug
   end
 
-  # +#log+ calls the block given to this method before it logs every time.
+  # {#log} calls the block given to this method before it logs every time.
   # This, thus, acts as a hook in the case where you want to make sure some
   # code gets executed before you log a message.  Useful for making sure a file
   # exists before logging to it.
   #
   # @param [Proc] block The block of code to execute before logging a message
-  #   with +#log+.
+  #   with {#log}.
   def before(&block)
-    @before_block = block
+    @before_block ||= block
   end
 
   # Logs a message using the level provided.  If no level provided, use
@@ -47,7 +63,7 @@ module LogSwitch
   # @param [String] message The message to log.
   # @param [Symbol] level The log level to send to your Logger.
   def log(message, level=log_level)
-    @before_block.call unless @before_block.nil?
+    before.call unless before.nil?
     yield if block_given?
 
     if log?

data/lib/log_switch/mixin.rb

@@ -0,0 +1,20 @@
+module LogSwitch
+  module Mixin
+
+    # When this module is included, this method gets called and defines a +#log+
+    # method on the including class.
+    #
+    # @param [Class] klass The class that's including this module.
+    # @raise [RuntimeError] If {LogSwitch.extender} isn't set (which gets set
+    #    when you +extend+ your class with {LogSwitch}).
+    def self.included(klass)
+      if LogSwitch.extender
+        klass.send :define_method, :log do |*args|
+          LogSwitch.extender.log *args
+        end
+      else
+        raise "No class has been extended by LogSwitch yet."
+      end
+    end
+  end
+end

data/lib/log_switch/version.rb

@@ -1,3 +1,3 @@
 module LogSwitch
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/log_switch/mixin_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'log_switch/mixin'
+
+
+class Tester
+end
+
+
+describe LogSwitch::Mixin do
+  describe "::included" do
+    context "LogSwitch.extender is set" do
+      let(:logger_class) do
+        double "LogSwitch.logger"
+      end
+
+      before { LogSwitch.stub(:extender).and_return logger_class }
+
+      it "takes a class and defines the #log method on it" do
+        Tester.should_receive(:send).with(:define_method, :log)
+
+        class Tester
+          include LogSwitch::Mixin
+        end
+
+        LogSwitch.unstub(:extender)
+      end
+
+      it "results in an object with a #log message" do
+        class Tester
+          include LogSwitch::Mixin
+        end
+
+        Tester.new.methods.should include(:log)
+      end
+    end
+
+    context "LogSwitch.extender is not set" do
+      before { LogSwitch.stub(:extender).and_return nil }
+
+      it "raises a RuntimeError" do
+        expect {
+          class Tester
+            include LogSwitch::Mixin
+          end
+        }.to raise_error RuntimeError
+      end
+    end
+  end
+end

data/spec/log_switch_spec.rb

@@ -23,7 +23,7 @@ describe "LogSwitch" do
     MyClass.reset_config!
   end
 
-  it { LogSwitch::VERSION.should == '0.2.0' }
+  it { LogSwitch::VERSION.should == '0.3.0' }
 
   describe ".log" do
     it "should default to true" do
@@ -47,6 +47,8 @@ describe "LogSwitch" do
       object.should_receive(:test_in_block)
 
       MyClass.log('hi') { object.test_in_block }
+
+      object.unstub :test_in_block
     end
 
     context "with .before" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log_switch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-06 00:00:00.000000000 Z
+date: 2012-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70123558624780 !ruby/object:Gem::Requirement
+  requirement: &70277189408400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70123558624780
+  version_requirements: *70277189408400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70123558624300 !ruby/object:Gem::Requirement
+  requirement: &70277189407920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70123558624300
+  version_requirements: *70277189407920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70123558623820 !ruby/object:Gem::Requirement
+  requirement: &70277189407440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70123558623820
+  version_requirements: *70277189407440
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70123558623320 !ruby/object:Gem::Requirement
+  requirement: &70277189406900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70123558623320
+  version_requirements: *70277189406900
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70123558622840 !ruby/object:Gem::Requirement
+  requirement: &70277189406420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *70123558622840
+  version_requirements: *70277189406420
 description: Extends a class for singleton style logging that can easily be turned
   on and off.
 email:
@@ -74,8 +74,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/log_switch/mixin.rb
 - lib/log_switch/version.rb
 - lib/log_switch.rb
+- spec/log_switch/mixin_spec.rb
 - spec/log_switch_spec.rb
 - spec/spec_helper.rb
 - History.rdoc
@@ -110,6 +112,7 @@ specification_version: 3
 summary: Extends a class for singleton style logging that can easily be turned on
   and off.
 test_files:
+- spec/log_switch/mixin_spec.rb
 - spec/log_switch_spec.rb
 - spec/spec_helper.rb
 has_rdoc: