@@ -1,3 +1,5 @@ +v0.2.0 Better log output of objects based on their type, very similiar to Logger/irb behavior; update to micronaut 0.1.0 + v0.1.5 Clean up specs and remove noise from spec run v0.1.4 Micronauts Unite! Test Suite now runs via Micronaut - http://github.com/spicycode/micronaut/ CHANGELOG @@ -1,8 +1,4 @@ CHANGELOG -LICENSE -Manifest -README.rdoc -Rakefile examples/example_helper.rb examples/log_buddy_example.rb examples/log_buddy_init_example.rb @@ -13,3 +9,8 @@ lib/log_buddy/mixin.rb lib/log_buddy/utils.rb lib/log_buddy/version.rb lib/log_buddy.rb +LICENSE +log_buddy.gemspec +Manifest +Rakefile +README.rdoc Manifest @@ -15,9 +15,17 @@ module Foo; end -d "hi" # logs "hi" (regular old logging) -d { a } # logs "a = 'foo'" -d { @a } # logs "@a = 'my var'" -d { @@bar } # logs "@@bar = 'class var!'" -d { bark } # logs "bark = woof!" -d { Foo::module_method } # logs Foo::module_method = 'hi!!' \ No newline at end of file +# LogBuddy calls and their output: + +d "hi" # hi +d { a } # a = "foo" +d { @a } # @a = "my var" +d { @@bar } # @@bar = "class var!" +d { bark } # bark = "woof!" +d { Foo::module_method } # Foo::module_method = "hi!!" + +hsh = {:foo => "bar", "key" => "value"} +array = [1,2,3,4,"5"] + +d { hsh } +d { array } \ No newline at end of file examples.rb @@ -1,6 +1,6 @@ require 'logger' require 'rubygems' -gem 'spicycode-micronaut', "= 0.0.4" +gem 'spicycode-micronaut', "~> 0.1.0" gem 'mocha' require "mocha" require 'micronaut' @@ -13,4 +13,8 @@ ensure $VERBOSE = old_verbose end +Micronaut.configure do |config| + config.mock_with :mocha +end + Micronaut::Runner.autorun \ No newline at end of file examples/example_helper.rb @@ -45,14 +45,14 @@ describe LogBuddy::Mixin, " behavior" do d {'hi man'} end - it "should log a plain arg" do - LogBuddy.expects(:debug).with('hey yo') + it "should log a plain method call as is, nothing fancy" do + LogBuddy.expects(:debug).with("hey yo") d 'hey yo' end - it "logs both if given an arg and a block" do - LogBuddy.expects(:debug).with('hi mom') - LogBuddy.expects(:debug).with(%[foo = 'foo'\n]) + it "logs both argument and resulting value if using block from" do + LogBuddy.expects(:debug).with("hi mom") + LogBuddy.expects(:debug).with(%[foo = "foo"\n]) foo = "foo" d("hi mom") { foo } end @@ -62,32 +62,32 @@ describe LogBuddy::Mixin, " behavior" do end it "should output only local vars in the block" do - LogBuddy.expects(:debug).with(%[a = 'foo'\n]) + LogBuddy.expects(:debug).with(%[a = "foo"\n]) b = "bad" a = "foo" d { a } end it "should output instance vars" do - LogBuddy.expects(:debug).with(%[@a = 'foo'\n]) + LogBuddy.expects(:debug).with(%[@a = "foo"\n]) @a = "foo" d { @a } end it "should output constants" do FOO_CONST = "yo!" - LogBuddy.expects(:debug).with(%[FOO_CONST = 'yo!'\n]) + LogBuddy.expects(:debug).with(%[FOO_CONST = "yo!"\n]) d { FOO_CONST } end it "should output class vars" do - LogBuddy.expects(:debug).with(%[@@class_var = 'hi'\n]) + LogBuddy.expects(:debug).with(%[@@class_var = "hi"\n]) @@class_var = "hi" d { @@class_var } end it "should output method calls" do - LogBuddy.expects(:debug).with(%[SomeModule.say_something("dude!!!!") = 'hello dude!!!!'\n]) + LogBuddy.expects(:debug).with(%[SomeModule.say_something("dude!!!!") = "hello dude!!!!"\n]) d { SomeModule.say_something("dude!!!!") } end @@ -95,9 +95,9 @@ describe LogBuddy::Mixin, " behavior" do local1 = '1' local2 = '2' @ivar1 = '1' - LogBuddy.expects(:debug).with(%[local1 = '1'\n]) - LogBuddy.expects(:debug).with(%[local2 = '2'\n]) - LogBuddy.expects(:debug).with(%[@ivar1 = '1'\n]) + LogBuddy.expects(:debug).with(%[local1 = "1"\n]) + LogBuddy.expects(:debug).with(%[local2 = "2"\n]) + LogBuddy.expects(:debug).with(%[@ivar1 = "1"\n]) d { local1; local2; @ivar1 } end @@ -106,6 +106,22 @@ describe LogBuddy::Mixin, " behavior" do d { SomeModule.raise_runtime_error } end + it "logs things okay with inline rdoc" do + LogBuddy.stubs(:debug) + hsh = {:foo=>"bar", "key"=>"value"} + d { hsh } # hsh = {:foo=>"bar", "key"=>"value"} + end + + it "logs inspected version of hashes and arrays" do + hsh = { :peanut_butter => "jelly", "awesome_numbers" => [3,7,22]} + different_hash_output_orders = [ + %[hsh = {"awesome_numbers"=>[3, 7, 22], :peanut_butter=>"jelly"}\n], + %[hsh = {:peanut_butter=>"jelly", "awesome_numbers"=>[3, 7, 22]}\n] + ] + LogBuddy.logger.expects(:debug).with(any_of(*different_hash_output_orders)) + d { hsh } + end + end describe "obj_to_string" do @@ -140,7 +156,7 @@ describe LogBuddy::Mixin, " behavior" do before { Logger.any_instance.stubs(:debug) } it "logs to stdout as well as the default logger" do LogBuddy.init :log_to_stdout => true - LogBuddy.expects(:stdout_puts).with(%["foo" = 'foo'\n]) + LogBuddy.expects(:stdout_puts).with(%["foo" = "foo"\n]) d { "foo" } end examples/log_example.rb @@ -17,8 +17,7 @@ module LogBuddy logged_line = LogBuddy.read_line(caller[0]) arguments = LogBuddy.parse_args(logged_line) arguments.each do |arg| - result = eval(arg, blk.binding) - LogBuddy.debug(%[#{arg} = '#{result}'\n]) + LogBuddy.arg_and_blk_debug(arg, blk) end rescue RuntimeError => e LogBuddy.debug "LogBuddy caught an exception: #{e.message}" lib/log_buddy/mixin.rb @@ -1,31 +1,26 @@ module LogBuddy module Utils - def obj_to_string(obj) - case obj - when ::String - obj - when ::Exception - "#{ obj.message } (#{ obj.class })\n" << - (obj.backtrace || []).join("\n") - else - obj.inspect - end - end - - def debug(str) + def debug(obj) + str = obj_to_string(obj) stdout_puts(str) if log_to_stdout? logger.debug(str) end + + def arg_and_blk_debug(arg, blk) + result = eval(arg, blk.binding) + result_str = obj_to_string(result, :quote_strings => true) + LogBuddy.debug(%[#{arg} = #{result_str}\n]) + end def stdout_puts(str) puts str end - + # Returns array of arguments in the block - # You must ues the brace form (ie d { "hi" }) and not do...end + # You must use the brace form (ie d { "hi" }) and not do...end def parse_args(logged_line) - block_contents = logged_line[/\{(.*)\}/, 1] + block_contents = logged_line[/\{(.*?)\}/, 1] args = block_contents.split(";").map {|arg| arg.strip } end @@ -37,5 +32,19 @@ module LogBuddy lines[line_number - 1] end + + def obj_to_string(obj, options = {}) + quote_strings = options.delete(:quote_strings) + case obj + when ::String + quote_strings ? %["#{obj}"] : obj + when ::Exception + "#{ obj.message } (#{ obj.class })\n" << + (obj.backtrace || []).join("\n") + else + obj.inspect + end + end + end end \ No newline at end of file lib/log_buddy/utils.rb @@ -1,8 +1,8 @@ module LogBuddy module VERSION #:nodoc: MAJOR = 0 - MINOR = 1 - TINY = 5 + MINOR = 2 + TINY = 0 STRING = [MAJOR, MINOR, TINY].join('.') end lib/log_buddy/version.rb @@ -2,11 +2,11 @@ Gem::Specification.new do |s| s.name = %q{log_buddy} - s.version = "0.1.5" + s.version = "0.2.0" s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version= s.authors = ["Rob Sanheim - Relevance"] - s.date = %q{2008-12-05} + s.date = %q{2008-12-09} s.description = %q{Log statements along with their name easily. Mixin a logger everywhere when you need it.} s.email = %q{opensource@thinkrelevance.com} s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/log_buddy/mixin.rb", "lib/log_buddy/utils.rb", "lib/log_buddy/version.rb", "lib/log_buddy.rb", "log_buddy.gemspec"] log_buddy.gemspec spec/mixin_spec.rb 81963708d2947d0316f988f497900f756b5873d5 Rob Sanheim rsanheim@gmail.com http://github.com/relevance/log_buddy/commit/7ac1d3c7aaaa9c68a1335592ac1ed92738f1b1ec 7ac1d3c7aaaa9c68a1335592ac1ed92738f1b1ec 2008-12-08T21:58:41-08:00 2008-12-08T21:58:41-08:00 release 0.2.0 - better logging output (use inspect when appropriate), better parsing when there is inline rdoc; update micronaut 7f9fb4670ebce2f1f25d66c550208392d619cc61 Rob Sanheim rsanheim@gmail.com