micronaut 0.2.9

data/History.txt

@@ -0,0 +1,15 @@
+0.0.8
+=======================
+- It turns out I'm horrible at updating history files
+- Added MockWith::AbsolutelyNothing as the default
+- Added the ability to setup before, after, include, and extend blocks using a extensible API
+
+0.0.6 
+=======================
+- MockWith::Mocha autoloads now
+- Beginnings of the configure block in example helper
+- Ability to search behaviour groups is in
+
+0.0.5
+=======================
+- Describes are working at any level, befores/afters correctly cascade

data/LICENSE

@@ -0,0 +1,45 @@
+Copyright (c) 2008 Chad Humphries
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+The matchers and expectations are licensed:
+(The MIT License)
+
+Copyright (c) 2005-2008 The RSpec Development Team
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,66 @@
+# Micronaut
+
+* [Codes - http://github.com/spicycode/micronaut](http://github.com/spicycode/micronaut)
+* [Examples - http://runcoderun.com/spicycode/micronaut](http://runcoderun.com/spicycode/micronaut)
+* [Rails - http://github.com/spicycode/micronaut-rails](http://github.com/spicycode/micronaut-rails)
+
+## DESCRIPTION:
+
+Micronaut is a light-weight BDD test framework.
+
+## FEATURES:
+
+* API compatible with RSpec (of course)
+
+* Slim and light, designed to be readable, compact, and fast.  Just over ~1600 LOC in /lib at last count.
+
+* Each example has its own metadata, and you can add filters or modules to run/disable/enhance examples based on that metadata at run time
+* A Real-world example of the power the metadata gives you:
+
+* "Focused examples".  Never drop out of Autotest again - just focus on the example(s) and ignore the rest:
+
+		Micronaut.configure do |c| # in your example_helper
+		  c.filter_run :focused => true
+		end	
+
+		describe Foo do
+			it "this example will run", :focused => true do
+			end
+			
+			# equivalent to:
+			focused "so will this one (this is an alias for :focused => true)" do
+			end
+			
+			it "this example will not run, until the focused ones are removed" do
+			end
+		end
+		
+* Add your own metadata options and customize Micronaut to your hearts content (pending specs are implemented as ':pending => true' metadata, for example)
+		
+* Designed to be formatter compatible with RSpec (though this needs some real-world testing)
+
+* Rake task for simple setup
+  
+   require 'rubygems'
+   require 'micronaut/rake_task'
+
+   desc "Run all micronaut examples"
+   Micronaut::RakeTask.new :examples do |t|
+     t.pattern = "examples/**/*_example.rb"
+   end
+
+   desc "Run all micronaut examples using rcov"
+   Micronaut::RakeTask.new :coverage do |t|
+     t.pattern = "examples/**/*_example.rb"
+     t.rcov = true
+     t.rcov_opts = "--exclude \"examples/*,gems/*,db/*,/Library/Ruby/*,config/*\" --text-summary  --sort coverage --no-validator-links" 
+   end
+## REQUIREMENTS:
+
++ Ruby 1.8.6+
+
+## CREDITS:
+
+* Mini/Unit for the great ideas and runner
+* RSpec for the great ideas, matchers, expectations and formatter ideas
+* Matchers are licensed under the MIT license, per RSpec (see RSPEC-LICENSE)

data/RSPEC-LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+ 
+Copyright (c) 2005-2008 The RSpec Development Team
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ 

data/Rakefile

@@ -0,0 +1,78 @@
+require 'lib/micronaut/rake_task'
+
+begin 
+  require 'jeweler' 
+  Jeweler::Tasks.new do |s| 
+    s.name = "micronaut" 
+    s.executables = "micronaut" 
+    s.summary = "An excellent replacement for the wheel..."
+    s.email = "chad@spicycode.com" 
+    s.homepage = "http://github.com/spicycode/micronaut" 
+    s.description = "An excellent replacement for the wheel..."
+    s.authors = ["Chad Humphries"] 
+    s.files =  FileList["[A-Z]*", "{bin,lib,examples}/**/*"] 
+    s.rubyforge_project = 'spicycode-depot' 
+  end 
+rescue => e
+  puts "Jeweler, or one of its dependencies blew right up. #{e}"
+rescue LoadError 
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com" 
+end
+
+# These are new tasks
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/the-perfect-gem/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end
+
+
+desc "List files that don't have examples"
+task :untested do
+  code = Dir["lib/**/*.rb"].map { |g| Dir.glob(g) }.flatten
+  examples = Dir["examples/**/*_example.rb"].map { |g| Dir.glob(g) }.flatten
+  examples.map! { |f| f =~ /examples\/(.*)_example/; "#{$1}.rb" }
+  puts "\nThe following files seem to be missing their examples:"
+  (code - examples).each do |missing|
+    puts "  #{missing}"
+  end
+end
+
+puts "Running in Ruby #{RUBY_VERSION}"
+desc "Run all micronaut examples"
+Micronaut::RakeTask.new :examples do |t|
+  t.pattern = "examples/**/*_example.rb"
+end
+
+namespace :examples do
+  
+  desc "Run all micronaut examples using rcov"
+  Micronaut::RakeTask.new :coverage do |t|
+    t.pattern = "examples/**/*_example.rb"
+    t.rcov = true
+    t.rcov_opts = %[--exclude "examples/*,gems/*,db/*,/Library/Ruby/*,config/*" --text-summary  --sort coverage]
+  end
+
+end
+
+task :default => 'examples:coverage'

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 9
+:major: 0
+:minor: 2

data/bin/micronaut

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+require 'micronaut'
+Micronaut.configuration.autorun!

data/examples/example_helper.rb

@@ -0,0 +1,54 @@
+lib_path = File.expand_path(File.dirname(__FILE__) + "/../lib")
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+
+require 'micronaut'
+require 'rubygems'
+
+def with_ruby(version)
+  yield if RUBY_PLATFORM =~ Regexp.compile("^#{version}")
+end
+
+with_ruby("1.8") { gem :mocha }
+
+require File.expand_path(File.dirname(__FILE__) + "/resources/example_classes")
+
+module Micronaut
+  module Matchers
+    def fail
+      raise_error(::Micronaut::Expectations::ExpectationNotMetError)
+    end
+
+    def fail_with(message)
+      raise_error(::Micronaut::Expectations::ExpectationNotMetError, message)
+    end
+  end
+end
+
+def remove_last_describe_from_world
+  Micronaut.world.behaviours.pop
+end
+
+def isolate_behaviour
+  if block_given?
+    yield
+    Micronaut.world.behaviours.pop
+  end
+end
+
+def use_formatter(new_formatter)
+  original_formatter = Micronaut.configuration.formatter
+  Micronaut.configuration.instance_variable_set(:@formatter, new_formatter)
+  yield
+ensure
+  Micronaut.configuration.instance_variable_set(:@formatter, original_formatter)
+end
+
+def not_in_editor?
+  !(ENV.has_key?('TM_MODE') || ENV.has_key?('EMACS') || ENV.has_key?('VIM'))
+end
+
+Micronaut.configure do |c|
+  c.mock_with :mocha
+  c.color_enabled = not_in_editor?
+  c.filter_run :focused => true
+end

data/examples/lib/micronaut/behaviour_example.rb

@@ -0,0 +1,351 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../example_helper")
+
+describe Micronaut::Behaviour do
+
+  def empty_behaviour_group
+    group = Micronaut::Behaviour.describe(Object, 'Empty Behaviour Group') { }
+    remove_last_describe_from_world
+  end
+
+  describe "describing behaviour with #describe" do
+    
+    example "an ArgumentError is raised if no type or description is given" do
+      lambda { Micronaut::Behaviour.describe() {} }.should raise_error(ArgumentError, "No arguments given.  You must a least supply a type or description")
+    end
+
+    example "an ArgumentError is raised if no block is given" do
+      lambda { Micronaut::Behaviour.describe('foo') }.should raise_error(ArgumentError, "You must supply a block when calling describe")
+    end
+
+    describe '#name' do
+
+      it "should expose the first parameter as name" do
+        isolate_behaviour do
+          Micronaut::Behaviour.describe("my favorite pony") { }.name.should == 'my favorite pony'
+        end
+      end
+
+      it "should call to_s on the first parameter in case it is a constant" do
+        isolate_behaviour do
+          Micronaut::Behaviour.describe(Object) { }.name.should == 'Object'
+        end
+      end
+
+      pending "should build a nested name correctly, including the module, and each nested description in the correct order" do
+        behaviour_to_test = nil
+
+        isolate_behaviour do
+          Micronaut::Behaviour.describe(Micronaut, "test") do
+            Micronaut::Behaviour.describe("nested one") do
+              behaviour_to_test = Micronaut::Behaviour.describe("nested two") { }
+            end
+          end
+        end
+        
+        behaviour_to_test.name.should == 'Micronaut - test - nested one - nested two'
+      end
+
+    end
+
+    describe '#describes' do
+
+      it "should be the first parameter when it is a constant" do
+        isolate_behaviour do
+          Micronaut::Behaviour.describe(Object) { }.describes.should == Object
+        end
+      end
+
+      it "should be nil when the first parameter is a string" do
+        isolate_behaviour do
+          Micronaut::Behaviour.describe("i'm a computer") { }.describes.should be_nil
+        end
+      end
+
+    end
+
+    describe '#description' do
+
+      it "should expose the second parameter as description" do
+        isolate_behaviour do
+          Micronaut::Behaviour.describe(Object, "my desc") { }.description.should == 'my desc'
+        end
+      end
+
+      it "should allow the second parameter to be nil" do
+        isolate_behaviour do
+          Micronaut::Behaviour.describe(Object, nil) { }.description.size.should == 0
+        end
+      end
+
+    end
+
+    describe '#metadata' do
+
+      it "should add the third parameter to the metadata" do
+        isolate_behaviour do
+          Micronaut::Behaviour.describe(Object, nil, 'foo' => 'bar') { }.metadata.should include({ "foo" => 'bar' })
+        end
+      end
+
+      it "should add the caller to metadata" do
+        isolate_behaviour do
+          Micronaut::Behaviour.describe(Object) { }.metadata[:behaviour][:caller][4].should =~ /#{__FILE__}:#{__LINE__}/
+        end
+      end
+
+      it "should add the the file_path to metadata" do
+        isolate_behaviour do
+          Micronaut::Behaviour.describe(Object) { }.metadata[:behaviour][:file_path].should == __FILE__
+        end
+      end
+
+      it "should have a reader for file_path" do
+        isolate_behaviour do
+          Micronaut::Behaviour.describe(Object) { }.file_path.should == __FILE__
+        end
+      end
+
+      it "should add the line_number to metadata" do
+        isolate_behaviour do
+          Micronaut::Behaviour.describe(Object) { }.metadata[:behaviour][:line_number].should == __LINE__
+        end
+      end
+
+      it "should add file path and line number metadata for arbitrarily nested describes" do
+        Micronaut::Behaviour.describe(Object) do
+          Micronaut::Behaviour.describe("foo") do
+            Micronaut::Behaviour.describe(Object) { }.metadata[:behaviour][:file_path].should == __FILE__
+            Micronaut::Behaviour.describe(Object) { }.metadata[:behaviour][:line_number].should == __LINE__
+          end
+        end
+
+        4.times { remove_last_describe_from_world }
+      end
+
+    end
+
+    describe "adding before and after hooks" do
+
+      it "should expose the before each blocks at before_eachs" do
+        group = empty_behaviour_group
+        group.before(:each) { 'foo' }
+        group.should have(1).before_eachs
+      end
+
+      it "should maintain the before each block order" do
+        group = empty_behaviour_group 
+        group.before(:each) { 15 }
+        group.before(:each) { 'A' }
+        group.before(:each) { 33.5 }
+
+        group.before_eachs[0].call.should == 15
+        group.before_eachs[1].call.should == 'A'
+        group.before_eachs[2].call.should == 33.5
+      end
+
+      it "should expose the before all blocks at before_alls" do
+        group = empty_behaviour_group
+        group.before(:all) { 'foo' }
+        group.should have(1).before_alls
+      end
+
+      it "should maintain the before all block order" do
+        group = empty_behaviour_group 
+        group.before(:all) { 15 }
+        group.before(:all) { 'A' }
+        group.before(:all) { 33.5 }
+
+        group.before_alls[0].call.should == 15
+        group.before_alls[1].call.should == 'A'
+        group.before_alls[2].call.should == 33.5
+      end
+
+      it "should expose the after each blocks at after_eachs" do
+        group = empty_behaviour_group
+        group.after(:each) { 'foo' }
+        group.should have(1).after_eachs
+      end
+
+      it "should maintain the after each block order" do
+        group = empty_behaviour_group 
+        group.after(:each) { 15 }
+        group.after(:each) { 'A' }
+        group.after(:each) { 33.5 }
+
+        group.after_eachs[0].call.should == 15
+        group.after_eachs[1].call.should == 'A'
+        group.after_eachs[2].call.should == 33.5
+      end
+
+      it "should expose the after all blocks at after_alls" do
+        group = empty_behaviour_group
+        group.after(:all) { 'foo' }
+        group.should have(1).after_alls
+      end
+
+      it "should maintain the after each block order" do
+        group = empty_behaviour_group 
+        group.after(:all) { 15 }
+        group.after(:all) { 'A' }
+        group.after(:all) { 33.5 }
+
+        group.after_alls[0].call.should == 15
+        group.after_alls[1].call.should == 'A'
+        group.after_alls[2].call.should == 33.5
+      end
+
+    end
+
+    describe "adding examples" do
+
+      it "should allow adding an example using 'it'" do
+        group = empty_behaviour_group
+        group.it("should do something") { }
+        group.examples.size.should == 1
+      end
+
+      it "should expose all examples at examples" do
+        group = empty_behaviour_group
+        group.it("should do something 1") { }
+        group.it("should do something 2") { }
+        group.it("should do something 3") { }
+        group.examples.size.should == 3
+      end
+
+      it "should maintain the example order" do
+        group = empty_behaviour_group
+        group.it("should 1") { }
+        group.it("should 2") { }
+        group.it("should 3") { }
+        group.examples[0].description.should == 'should 1'
+        group.examples[1].description.should == 'should 2'
+        group.examples[2].description.should == 'should 3'
+      end
+
+    end
+
+  end
+
+  describe Object, "describing nested behaviours", :little_less_nested => 'yep' do 
+
+    describe "A sample nested describe", :nested_describe => "yep" do
+
+      it "should set the described type to the constant Object" do
+        running_example.behaviour.describes.should == Object
+      end
+
+      it "should set the description to 'A sample nested describe'" do
+        running_example.behaviour.description.should == 'A sample nested describe'
+      end
+
+      it "should have top level metadata from the behaviour and its ancestors" do
+        running_example.behaviour.metadata.should include(:little_less_nested => 'yep', :nested_describe => 'yep')
+      end
+
+      it "should make the parent metadata available on the contained examples" do
+        running_example.metadata.should include(:little_less_nested => 'yep', :nested_describe => 'yep')
+      end
+
+    end
+
+  end
+
+  describe "#run_examples" do
+    
+    before do
+      @fake_formatter = Micronaut::Formatters::BaseFormatter.new
+    end
+
+    def stub_behaviour
+      stub_everything('behaviour', :metadata => { :behaviour => { :name => 'behaviour_name' }})
+    end
+
+    it "should return true if all examples pass" do
+      use_formatter(@fake_formatter) do
+        passing_example1 = Micronaut::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 1 }))
+        passing_example2 = Micronaut::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 1 }))
+        Micronaut::Behaviour.stubs(:examples_to_run).returns([passing_example1, passing_example2])
+
+        Micronaut::Behaviour.run_examples(stub_behaviour, stub_everything('reporter')).should be_true
+      end
+    end
+
+    it "should return false if any of the examples return false" do
+      use_formatter(@fake_formatter) do
+        failing_example = Micronaut::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 2 }))
+        passing_example = Micronaut::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 1 }))
+        Micronaut::Behaviour.stubs(:examples_to_run).returns([failing_example, passing_example])
+
+        Micronaut::Behaviour.run_examples(stub_behaviour, stub_everything('reporter')).should be_false
+      end
+    end
+
+    it "should run all examples, regardless of any of them failing" do
+      use_formatter(@fake_formatter) do
+        failing_example = Micronaut::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 2 }))
+        passing_example = Micronaut::Example.new(stub_behaviour, 'description', {}, (lambda { 1.should == 1 }))
+        Micronaut::Behaviour.stubs(:examples_to_run).returns([failing_example, passing_example])
+
+        passing_example.expects(:run)
+
+        Micronaut::Behaviour.run_examples(stub_behaviour, stub_everything('reporter'))
+      end
+    end
+
+  end
+  
+  describe "how instance variables inherit" do
+    
+    before(:all) do
+      @before_all_top_level = 'before_all_top_level'
+    end
+
+    before(:each) do
+      @before_each_top_level = 'before_each_top_level'
+    end
+    
+    it "should be able to access a before each ivar at the same level" do
+      @before_each_top_level.should == 'before_each_top_level'
+    end
+    
+    it "should be able to access a before all ivar at the same level" do
+      @before_all_top_level.should == 'before_all_top_level'
+    end
+
+
+    it "should be able to access the before all ivars in the before_all_ivars hash" do
+      with_ruby('1.8') do
+        running_example.behaviour.before_all_ivars.should include('@before_all_top_level' => 'before_all_top_level')
+      end
+      with_ruby('1.9') do
+        running_example.behaviour.before_all_ivars.should include(:@before_all_top_level => 'before_all_top_level')
+      end
+    end
+    
+    describe "but now I am nested" do
+      
+      it "should be able to access a parent behaviours before each ivar at a nested level" do
+        @before_each_top_level.should == 'before_each_top_level'
+      end
+      
+      it "should be able to access a parent behaviours before all ivar at a nested level" do
+        @before_all_top_level.should == "before_all_top_level"
+      end
+
+      it "changes to before all ivars from within an example do not persist outside the current describe" do
+        @before_all_top_level = "ive been changed"
+      end
+
+      describe "accessing a before_all ivar that was changed in a parent behaviour" do
+        
+        it "should have access to the modified version" do
+          @before_all_top_level.should == 'ive been changed'
+        end
+
+      end
+      
+    end
+    
+  end
+
+end