lager 0.2.0.4 → 0.2.0.5

data/MANIFEST.txt

@@ -3,3 +3,6 @@ VERSION
 README.md
 rakefile.rb
 lib/lager.rb
+test/lager.rb
+examples/foo.rb
+examples/usage.rb

data/VERSION

@@ -1 +1 @@
-0.2.0.4
+0.2.0.5

data/examples/foo.rb

@@ -0,0 +1,36 @@
+require_relative '../lib/lager'
+
+class Foo
+  extend Lager
+
+  # set logging from within, useful for default behavior
+  #
+  log_to $stdout, :warn
+
+  def self.bar
+    @lager.debug { "inside Foo.bar" }
+  end
+
+  def initialize
+    # assign @lager at the instance layer if you want to use it
+    # @lager, here, is technically a different variable than used above
+    # though we are setting them to the same thing
+    #
+    @lager = self.class.lager
+    @lager.debug { "inside Foo#initialize" }
+  end
+end
+
+if __FILE__ == $0
+  Foo.bar
+  Foo.new
+
+  # set logging from outside
+  #
+  puts "Turning on debug logging"
+  Foo.log_to $stderr
+  Foo.log_level :debug
+
+  Foo.bar
+  Foo.new
+end

data/examples/usage.rb

@@ -0,0 +1,40 @@
+require_relative '../lib/lager'
+
+class Foo
+  extend Lager
+  log_to $stdout, :debug  # sets up @lager at the class layer
+
+  def self.bar(baz)
+    unless baz.is_a?(String)
+      @lager.debug { "baz #{baz} is a #{baz.class}, not a string" }
+    end
+  end
+
+  def initialize
+    # set the instance layer's @lager to the class layer's @lager
+    @lager = self.class.lager
+    # now both layers are using the same instance
+  end
+
+  def do_something_complicated
+    @lager.debug { "about to do something complicated" }
+    # ...
+    @lager.debug { "whew! we made it!" }
+  end
+end
+
+if __FILE__ == $0
+  puts "About to spew debug messages"
+  Foo.bar(15)
+  f = Foo.new
+  f.do_something_complicated
+
+  puts "Now updating Foo's log level"
+  Foo.log_level :warn
+  Foo.new.do_something_complicated
+
+  puts "Now the same calls as before"
+  Foo.bar(15)
+  f = Foo.new
+  f.do_something_complicated
+end

data/test/lager.rb

@@ -0,0 +1,68 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'tempfile'
+
+require_relative '../lib/lager'
+require_relative '../examples/foo' # useful Foo class
+
+describe Lager do
+  describe ".version" do
+    it "must return a string of numbers and dots" do
+      Lager.version.must_match %r{\A[0-9\.]+\z}
+    end
+  end
+
+  describe "#log_to" do
+    it "must have created a Logger" do
+      # note, the useful Foo class has already called log_to in the class def
+      Foo.lager.must_be_instance_of(Logger)
+    end
+
+    it "must return nil" do
+      Foo.log_to.must_be_nil
+    end
+
+    it "must use an existing Logger when provided" do
+      l = Logger.new($stderr)
+      Foo.log_to l
+      Foo.lager.must_equal l
+      Foo.log_level :info
+      Foo.bar # does debug logging, should be silent
+      Foo.lager.must_equal l
+    end
+
+    it "must handle a Tempfile when provided" do
+      t = Tempfile.new('lager')
+      Foo.log_to t
+      Foo.log_level :debug
+      Foo.bar # does debug logging
+      t.rewind
+      t.read.wont_be_empty
+      t.close
+      t.unlink
+    end
+
+    it "must handle a path to /tmp when provided" do
+      fname = '/tmp/lager.log'
+      Foo.log_to fname
+      Foo.log_level :debug
+      Foo.bar # does debug logging
+      Foo.log_to $stderr
+      File.exists?(fname).must_equal true
+      File.unlink fname
+    end
+  end
+
+  describe "#log_level" do
+    it "must accept :debug as Logger::DEBUG" do
+      Foo.log_level :debug
+      Foo.log_level.must_equal Logger::DEBUG
+    end
+
+    it "must accept Logger::INFO as Logger::INFO" do
+      Foo.log_level Logger::INFO
+      Foo.log_level.must_equal Logger::INFO
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lager
 version: !ruby/object:Gem::Version
-  version: 0.2.0.4
+  version: 0.2.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -54,6 +54,9 @@ files:
 - README.md
 - rakefile.rb
 - lib/lager.rb
+- test/lager.rb
+- examples/foo.rb
+- examples/usage.rb
 homepage: http://github.com/rickhull/lager
 licenses:
 - LGPL