log_switch 0.1.4 → 0.2.0

data/History.rdoc

@@ -1,3 +1,12 @@
+=== 0.2.0 / 2011-12-05
+
+* Added ability to pass a block to +.log+ to have code executed before logging.
+* Added +before+ hook to allow code to be executed every time log gets called
+  (but before the message actually gets logged).
+* Bug fixes
+  * gh-1[https://github.com/turboladen/log_switch/issues/1]: Only log #each_line
+    when that method is supported on the object being logged.
+
 === 0.1.4 / 2011-10-10
 
 * Removed gemspec enforcement of >= 1.9.2

data/README.rdoc

@@ -27,6 +27,8 @@ Features:
 
 == SYNOPSIS
 
+=== Basic Use
+
 Get your app logging with a single point of logging:
 
   require 'log_switch'
@@ -61,14 +63,50 @@ If you have another Logger object you want to write to, no problem:
   File.open('log.txt', 'r').read    # => Logfile created on 2011-10-07 15:50:19 -0700 by logger.rb/25413
                                     #    D, [2011-10-07T15:51:16.385798 #34026] DEBUG -- : hi!
 
+=== Hooks
+
+You can also make sure code gets executed before each call to +.log+.  While
+this really only makes sense when you're logging from multiple places and/or
+you're not sure when the first call to your logger will occur (unlike this
+example), say you want to makes sure your log directory exists before trying
+to write the log file to it:
+
+  log_directory = File.expand_path('my_log_dir')
+
+  MyThing.before do
+    FileUtils.mkdir_p(full_directory) unless Dir.exists? log_directory
+  end
+
+  log_file = log_directory + "/sweet_log_bro.txt"
+  MyThing.logger = Logger.new(log_file)
+  MyThing.log "Thanks brah!"            # This calls the #before hook, thus
+                                        # creating the directory.
+  MyThing.log "I'm hungry..."           # This also calls the #before hook...
+
+You might just want want a one-time before hook--in that case, +.log+ will call
+a plain old block that you pass to it, right before writing to the log file.
+Here's the above example, using the one-timer:
+
+  log_directory = File.expand_path('my_log_dir')
+
+  log_file = log_directory + "/sweet_log_bro.txt"
+  MyThing.logger = Logger.new(log_file)
+
+  MyThing.log("Thanks brah!") do
+    FileUtils.mkdir_p(full_directory) unless Dir.exists? log_directory
+  end
+
+  # No block gets called here (assuming the +#before+ hook from above hasn't been defined)
+  MyThing.log "I'm hungry..."
+
 == REQUIREMENTS
 
 * Rubies (tested):
-  * MRI 1.9.3-rc1
+  * MRI 1.9.3
   * MRI 1.9.2
   * MRI 1.8.7
   * ree 1.8.7-2011.03
-  * JRuby 1.6.4
+  * JRuby 1.6.5
   * Rubinius 1.2.4
 * RubyGems:
   * None!

data/lib/log_switch/version.rb

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

data/lib/log_switch.rb

@@ -30,13 +30,33 @@ module LogSwitch
     @log_level ||= :debug
   end
 
+  # +#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+.
+  def before(&block)
+    @before_block = block
+  end
+
   # Logs a message using the level provided.  If no level provided, use
   # +@log_level+.
   #
   # @param [String] message The message to log.
   # @param [Symbol] level The log level to send to your Logger.
   def log(message, level=log_level)
-    message.each_line { |line| logger.send level, line.chomp if log? }
+    @before_block.call unless @before_block.nil?
+    yield if block_given?
+
+    if log?
+      if message.respond_to? :each_line
+        message.each_line { |line| logger.send level, line.chomp }
+      else
+        logger.send(level, message)
+      end
+    end
   end
 
   # Sets back to defaults.

data/log_switch.gemspec

@@ -11,9 +11,9 @@ Gem::Specification.new do |s|
   s.description = %q(Extends a class for singleton style logging that can easily be turned on and off.)
 
   s.required_rubygems_version = ">=1.8.0"
-  s.files = Dir.glob("{bin,features,lib,spec}/**/*") + Dir.glob("*.rdoc") +
+  s.files = Dir.glob("{lib,spec}/**/*") + Dir.glob("*.rdoc") +
     %w(.gemtest Gemfile log_switch.gemspec Rakefile)
-  s.test_files = Dir.glob("{features,spec}/**/*")
+  s.test_files = Dir.glob("{spec}/**/*")
   s.require_paths = ["lib"]
 
   s.add_development_dependency("bundler", [">= 0"])
@@ -21,7 +21,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rspec", ["~> 2.6.0"])
   if RUBY_VERSION > '1.9'
     s.add_development_dependency("simplecov", [">= 0"])
-    s.add_development_dependency("simplecov-rcov-text", [">= 0"])
   end
   s.add_development_dependency("yard", [">= 0.7.2"])
 end

data/spec/log_switch_spec.rb

@@ -23,9 +23,9 @@ describe "LogSwitch" do
     MyClass.reset_config!
   end
 
-  it { LogSwitch::VERSION.should == '0.1.3' }
+  it { LogSwitch::VERSION.should == '0.2.0' }
 
-  describe "log" do
+  describe ".log" do
     it "should default to true" do
       MyClass.log?.should be_true
     end
@@ -40,22 +40,52 @@ describe "LogSwitch" do
     it "raises when log_level isn't a Symbol" do
       expect { MyClass.log("stuff", "meow") }.to raise_error NoMethodError
     end
+
+    it "can take a block" do
+      object = Object.new
+      object.stub :test_in_block
+      object.should_receive(:test_in_block)
+
+      MyClass.log('hi') { object.test_in_block }
+    end
+
+    context "with .before" do
+      it "calls the @before_block if that's set" do
+        MyClass.before { puts "This is also before" }
+        MyClass.instance_variable_get(:@before_block).should_receive(:call).once
+        MyClass.log 'hi'
+      end
+    end
+
+    context "can log non-String objects" do
+      it "an Array of various object types" do
+        array = [1, 'stuff', { :two => 2 }]
+        MyClass.logger.should_receive(:send).with(:debug, array)
+        expect { MyClass.log array }.to_not raise_exception
+      end
+
+      it "an Exception" do
+        ex = StandardError.new("Test error.")
+        MyClass.logger.should_receive(:send).with(:debug, ex)
+        expect { MyClass.log ex }.to_not raise_exception
+      end
+    end
   end
 
-  describe "log=" do
+  describe ".log=" do
     it "allows to set logging to false" do
       MyClass.log = false
       MyClass.log?.should be_false
     end
   end
 
-  describe "logger" do
+  describe ".logger" do
     it "is a Logger by default" do
       MyClass.logger.should be_a Logger
     end
   end
 
-  describe "logger=" do
+  describe ".logger=" do
     it "allows to set to use another logger" do
       original_logger = MyClass.logger
       another_logger = Logger.new nil
@@ -64,13 +94,13 @@ describe "LogSwitch" do
     end
   end
 
-  describe "log_level" do
+  describe ".log_level" do
     it "defaults to :debug" do
       MyClass.log_level.should == :debug
     end
   end
 
-  describe "log_level=" do
+  describe ".log_level=" do
     it "changes the level that #log(msg, level=) uses" do
       MyClass.logger.should_receive(:debug)
       MyClass.log("testing...")
@@ -79,4 +109,11 @@ describe "LogSwitch" do
       MyClass.log("testing...")
     end
   end
+
+  describe ".before" do
+    it "assigns the given block to @before_block" do
+      MyClass.before { "I'm a block" }
+      MyClass.instance_variable_get(:@before_block).should be_a Proc
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,9 @@
 if RUBY_VERSION > '1.9'
   require 'simplecov'
-  require 'simplecov-rcov-text'
 
   class SimpleCov::Formatter::MergedFormatter
     def format(result)
       SimpleCov::Formatter::HTMLFormatter.new.format(result)
-      SimpleCov::Formatter::RcovTextFormatter.new.format(result)
     end
   end
 

metadata

@@ -1,92 +1,79 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: log_switch
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 4
-  version: 0.1.4
 platform: ruby
-authors: 
+authors:
 - Steve Loveless
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-10 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70123558624780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70123558624780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70123558624300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70123558624300
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70123558623820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 6
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.6.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70123558623820
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70123558623320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 7
-        - 2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70123558623320
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70123558622840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.7.2
   type: :development
-  version_requirements: *id004
-description: Extends a class for singleton style logging that can easily be turned on and off.
-email: 
+  prerelease: false
+  version_requirements: *70123558622840
+description: Extends a class for singleton style logging that can easily be turned
+  on and off.
+email:
 - steve.loveless@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/log_switch/version.rb
 - lib/log_switch.rb
 - spec/log_switch_spec.rb
@@ -99,39 +86,30 @@ files:
 - Rakefile
 homepage: http://github.com/turboladen/log_switch
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 55
-      segments: 
-      - 1
-      - 8
-      - 0
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.0
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Extends a class for singleton style logging that can easily be turned on and off.
-test_files: 
+summary: Extends a class for singleton style logging that can easily be turned on
+  and off.
+test_files:
 - spec/log_switch_spec.rb
 - spec/spec_helper.rb
+has_rdoc: