spicycode-micronaut 0.1.7.4 → 0.1.8.0

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake/gempackagetask'
 require 'rubygems/specification'
 
 GEM = "micronaut"
-GEM_VERSION = "0.1.7.4"
+GEM_VERSION = "0.1.8.0"
 AUTHOR = "Chad Humphries"
 EMAIL = "chad@spicycode.com"
 HOMEPAGE = "http://spicycode.com"

data/examples/lib/micronaut/configuration_example.rb

@@ -67,5 +67,44 @@ describe Micronaut::Configuration do
       config.run_all_when_everything_filtered?.should == false
     end
   end
+  
+  describe '#trace?' do
+    
+    it "is false by default" do
+      Micronaut::Configuration.new.trace?.should == false
+    end
+    
+    it "is true if configuration.trace is true", :full_backtrace => true do
+      config = Micronaut::Configuration.new
+      config.trace = true
+      config.trace?.should == true
+    end
+    
+  end
+  
+  describe '#trace' do
+    
+    it "requires a block" do
+      config = Micronaut::Configuration.new
+      config.trace = true
+      lambda { config.trace(true) }.should raise_error(ArgumentError)
+    end
+    
+    it "does nothing if trace is false" do
+      config = Micronaut::Configuration.new
+      config.trace = false
+      config.output.expects(:puts).never
+      config.trace { "my trace string is awesome" }
+    end
+    
+    it "allows overriding tracing an optional param" do
+      config = Micronaut::Configuration.new
+      config.trace = false
+      config.output.expects(:puts).with(includes("my trace string is awesome"))
+      config.trace(true) { "my trace string is awesome" }
+    end
+    
+    
+  end
 
 end

data/examples/lib/micronaut/formatters/base_formatter_example.rb

@@ -122,4 +122,16 @@ describe Micronaut::Formatters::BaseFormatter do
     
   end
   
+  describe '#trace' do
+
+    it "outputs trace message if behaviour metadata has :trace => true" do
+      Micronaut.configuration.output.expects(:puts).with(includes("Starting example: example"))
+      behaviour = Micronaut::Behaviour.describe("foo", :trace => true) {}
+      @formatter.behaviour = behaviour
+      @formatter.example_started("example")
+    end
+    
+  end
+  
+  
 end

data/examples/lib/micronaut/formatters/progress_formatter_example.rb

@@ -32,6 +32,7 @@ describe Micronaut::Formatters::ProgressFormatter do
    describe "when color is enabled" do
      
      before do
+       @formatter.stubs(:trace?).returns(false)
        @formatter.stubs(:color_enabled?).returns(true)
      end
    

data/lib/micronaut/behaviour.rb

@@ -92,11 +92,13 @@ module Micronaut
       @metadata.update(extra_metadata)
       
       Micronaut.configuration.find_modules(self).each do |include_or_extend, mod, opts|                                                                                                                                                                               
-        if include_or_extend == :extend                                                                                                                                                                                                                               
+        if include_or_extend == :extend
+          Micronaut.configuration.trace { "Extending module #{mod} on #{self}" }
           send(:extend, mod) unless extended_modules.include?(mod)                                                                                                                                                                                                    
-        else                                                                                                                                                                                                                                                          
-          send(:include, mod) unless included_modules.include?(mod)                                                                                                                                                                                                   
-        end                                                                                                                                                                                                                                                           
+        else
+          Micronaut.configuration.trace { "Including module #{mod} on #{self}" }
+          send(:include, mod) unless included_modules.include?(mod)
+        end
       end
     end
 

data/lib/micronaut/configuration.rb

@@ -19,12 +19,16 @@ module Micronaut
     # Enable profiling of example run - defaults to false
     attr_accessor :profile_examples
     
+    # Enable verbose interal logging of the framework - defaults to false
+    attr_accessor :trace
+    
     attr_reader :mock_framework
     
     def initialize
       @backtrace_clean_patterns = [/\/lib\/ruby\//, /bin\/rcov:/, /vendor\/rails/, /bin\/micronaut/, /#{::Micronaut::InstallDirectory}/]
-      @profile_examples = false
       @run_all_when_everything_filtered = true
+      @trace = false
+      @profile_examples = false
       @color_enabled = false
       @before_and_afters = { :before => { :each => [], :all => [] }, :after => { :each => [], :all => [] } }
       @include_or_extend_modules = []
@@ -96,6 +100,21 @@ module Micronaut
     def output
       $stdout
     end
+    
+    # Output some string for debugging/tracing assistance if trace is enabled
+    # The trace string should be sent as a block, which means it will only be interpolated if trace is actually enabled
+    # We allow an override here so that trace can be set at lower levels (such as the describe or example level)
+    def trace(override = false)
+      raise(ArgumentError, "Must yield a block with your string to trace.") unless block_given?
+      return unless trace? || override
+      Micronaut.configuration.output.puts("[TRACE] #{yield}")
+    end
+    
+    # If true, Micronaut will provide detailed trace output of its self as it runs.
+    # Can be turned on at the global (configuration) level or at the individual behaviour (describe) level.
+    def trace?
+      @trace == true
+    end
 
     # RJS I think we should rename include/extend so they don't conflict or confuse with the ruby builtin
     #  maybe register_include, setup_include, add_include, or just _include ?

data/lib/micronaut/formatters/base_formatter.rb

@@ -18,6 +18,15 @@ module Micronaut
         Micronaut.configuration.output
       end
       
+      def trace(&blk)
+        Micronaut.configuration.trace(trace_override_flag, &blk)
+      end
+      
+      # Allow setting trace at the behaviour level as well globally
+      def trace_override_flag
+        behaviour && behaviour.metadata[:trace]
+      end
+      
       def profile_examples?
         Micronaut.configuration.profile_examples
       end
@@ -58,11 +67,12 @@ module Micronaut
 
       # This method is invoked when an +example+ starts.
       def example_started(example)
-
+        trace { "Starting example: #{example}" }
       end
 
       # This method is invoked when an +example+ passes.
       def example_passed(example)
+        trace { "Example passed: #{example}" }
       end
 
       # This method is invoked when an +example+ fails, i.e. an exception occurred

data/lib/micronaut/formatters/base_text_formatter.rb

@@ -13,6 +13,7 @@ module Micronaut
       end
       
       def example_started(example)
+        super
         @start_time = Time.now
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spicycode-micronaut
 version: !ruby/object:Gem::Version 
-  version: 0.1.7.4
+  version: 0.1.8.0
 platform: ruby
 authors: 
 - Chad Humphries