rspec-given 2.4.5 → 3.0.0.beta.2

data/Rakefile

@@ -1,18 +1,18 @@
 #!/usr/bin/ruby -wKU
 
 require 'rake/clean'
-require './lib/rspec/given/version'
-require './lib/rspec/given/module_methods'
+require './lib/given/version'
+require './lib/given/module_methods'
 
 CLEAN.include("pkg/rspec-given-*").exclude("pkg/*.gem")
 CLOBBER.include("*.gemspec", "html", "README", "README.old")
 
 # README Formatting --------------------------------------------------
 
-task :default => :ex2
+task :default => :examples
 
 def version
-  RSpec::Given::VERSION
+  Given::VERSION
 end
 
 def tag_name
@@ -44,10 +44,10 @@ end
 # Running examples ---------------------------------------------------
 
 desc "Run all the examples"
-task :examples => [:specs, :examples1, :examples2]
+task :examples => [:specs, :rs_examples]
 
 desc "Run the RSpec 2 specs and examples"
-task :ex2 => [:specs, :examples2]
+task :examples => [:specs, :rs_examples, :mt_examples]
 
 desc "Run the specs"
 task :specs do
@@ -55,28 +55,34 @@ task :specs do
   sh "rspec spec"
 end
 
-desc "Run the examples in RSpec 1"
-task :examples1 => [:verify_rspec1] do
-  puts "Running examples (with RSpec2)"
-  sh "spec examples/stack/stack_spec1.rb"
-end
-
 EXAMPLES = FileList['examples/**/*_spec.rb'].
   exclude('examples/failing/*.rb').
   exclude('examples/integration/failing/*.rb')
 
-unless RSpec::Given::NATURAL_ASSERTIONS_SUPPORTED
+unless Given::NATURAL_ASSERTIONS_SUPPORTED
   EXAMPLES.exclude("examples/stack/*.rb")
 end
 
 FAILING_EXAMPLES = FileList['examples/failing/**/*_spec.rb']
 
+desc "Run the RSpec specs and examples"
+task :rs => [:specs, :rs_examples]
+
+desc "Run the Minitest tests and examples"
+task :mt => [:specs, :mt_examples]
+
 desc "Run the examples in RSpec 2"
-task :examples2 => [:verify_rspec2] do
+task :rs_examples => [:verify_rspec2] do
   puts "Running examples (with RSpec2)"
   sh "rspec #{EXAMPLES}"
 end
 
+desc "Run the examples in Minitest"
+task :mt_examples do
+  puts "Running examples (with Minitest)"
+  sh "ruby -Ilib:examples examples/loader.rb #{EXAMPLES}"
+end
+
 desc "Run failing examples"
 task :failing => [:verify_rspec2] do
   puts "Running failing examples (with RSpec2)"
@@ -114,7 +120,7 @@ task :readme => ["README.md"] do
 end
 
 desc "Generate an RDoc README"
-file "README.md" => ["examples/stack/stack_spec.rb", "lib/rspec/given/version.rb"] do
+file "README.md" => ["examples/stack/stack_spec.rb", "lib/given/version.rb"] do
   open("README.md") do |ins|
     open("README.tmp", "w") do |outs|
       state = :copy
@@ -122,7 +128,7 @@ file "README.md" => ["examples/stack/stack_spec.rb", "lib/rspec/given/version.rb
         case state
         when :copy
           if line =~ /rspec-given, version +\d+(\.(\d+|beta))+/i
-            line.gsub!(/version +\d+(\.(\d+|beta))+/i, "version #{RSpec::Given::VERSION}")
+            line.gsub!(/version +\d+(\.(\d+|beta))+/i, "version #{Given::VERSION}")
             outs.puts line
           elsif line =~ /^<pre>/
             state = :insert
@@ -212,7 +218,7 @@ if RDOC_ENABLED
     rdoc.options = [
       '--line-numbers',
       '--main' , 'doc/main.rdoc',
-      '--title', 'RSpec::Given - Given/When/Then Extensions for RSpec'
+      '--title', 'Given - Given/When/Then Extensions for RSpec'
     ]
     rdoc.options << '-SHN' << '-f' << 'darkfish' if DARKFISH_ENABLED
 

data/TODO

@@ -0,0 +1,13 @@
+Things to do to improve the minitest integration
+
+TODO:
+
+* Make a separate gem for minitest (do we need one for given-core?)
+
+DONE:
+
+* Handle have_failed in minitest
+* General cleanup making sure files go where they need.
+* Implement assertion counting for minitest
+* Figure out why the minitest example count is so low.
+* Move stuff out of minitest_helper to appropriate file.

data/examples/example_helper.rb

@@ -1,3 +1,10 @@
 $LOAD_PATH << './examples/stack'
 
-require 'spec_helper'
+if defined?(RSpec)
+  require 'rspec/given'
+  require 'spec_helper'
+else
+  require 'minitest/autorun'
+  require 'minispec/given'
+  require 'minitest_helper'
+end

data/examples/integration/and_spec.rb

@@ -1,4 +1,3 @@
-require 'rspec/given'
 require 'example_helper'
 
 describe "And" do
@@ -6,30 +5,26 @@ describe "And" do
   Given(:info) { [] }
 
   describe "And is called after Then" do
-    Given(:m) { double("mock") }
-    Given { m.should_receive(:and_ran) }
     Then { info << "T" }
-    And {
-      info.should == ["T"]
-      m.and_ran
-    }
+    And { info << "A" }
+    And { given_assert_equal ["T", "A"], info }
   end
 
   describe "And is called only once with multiple Thens" do
     Then { info << "T" }
     Then { info << "T2" }
-    And { info.should == ["T"] }
+    And { given_assert(info == ["T"] || info == ["T2"]) }
   end
 
   describe "Inherited Ands are not run" do
     Then { info << "T-OUTER" }
     And { info << "A-OUTER" }
-    And { info.should == ["T-OUTER", "A-OUTER"] }
+    And { given_assert_equal ["T-OUTER", "A-OUTER"], info }
 
     context "inner" do
       Then { info << "T-INNER" }
       And { info << "A-INNER" }
-      And { info.should == ["T-INNER", "A-INNER"] }
+      And { given_assert_equal ["T-INNER", "A-INNER"], info }
     end
   end
 
@@ -42,7 +37,7 @@ describe "And" do
 
     it "should define a message" do
       message = self.class.instance_eval { @message }
-      message.should =~ /and.*without.*then/i
+      given_assert_match(/and.*without.*then/i, message)
     end
   end
 

data/examples/integration/focused_line_spec.rb

@@ -2,7 +2,8 @@ require 'example_helper'
 
 describe "Focused Line" do
   it "runs only a single test" do
+    ENV['FRAMEWORK'] = nil
     output = `rspec examples/other/line_example.rb:7`
-    output.should_not =~ /FIRST/
+    given_assert_not_match(/FIRST/, output)
   end
 end

data/examples/integration/given_spec.rb

@@ -1,4 +1,4 @@
-require 'rspec-given'
+require 'example_helper'
 
 describe "Running Givens before Whens" do
   Given(:info) { [] }
@@ -11,11 +11,19 @@ describe "Running Givens before Whens" do
     context "inner with When" do
       Given { info << "inner1" }
       Given { info << "inner2" }
-      Then { info.should == ["outer1", "outer2", "inner1", "inner2", "when"] }
+      Then { given_assert_equal ["outer1", "outer2", "inner1", "inner2", "when"], info }
 
       context "using a nested When" do
         When { info << "when2" }
-        Then { info.should == ["outer1", "outer2", "inner1", "inner2", "when", "when2"] }
+        Then { given_assert_equal ["outer1", "outer2", "inner1", "inner2", "when", "when2"], info}
+      end
+
+      context "using two nested When" do
+        When { info << "when2a" }
+        When { info << "when2b" }
+        Then {
+          given_assert_equal ["outer1", "outer2", "inner1", "inner2", "when", "when2a", "when2b"], info
+        }
       end
     end
   end
@@ -26,27 +34,29 @@ describe "Running Givens before Whens" do
     context "inner with when" do
       Given { info << "inner1" }
       Given { info << "inner2" }
-      Then { info.should == ["outer1", "outer2", "inner1", "inner2", "when"] }
+      Then { given_assert_equal ["outer1", "outer2", "inner1", "inner2", "when"], info }
     end
   end
 
   context "using no whens" do
     Given { info << "inner1" }
     Given { info << "inner2" }
-    Then { info.should == ["outer1", "outer2", "inner1", "inner2"] }
+    Then { given_assert_equal ["outer1", "outer2", "inner1", "inner2"], info }
   end
 end
 
 describe "Lazy Givens" do
-  Given(:bomb) { fail "SHOULD NEVER BE CALLED" }
+  Given(:bomb) { fail StandardError, "SHOULD NEVER BE CALLED" }
 
   context "when called" do
-    Then { lambda { bomb }.should raise_error(StandardError, /NEVER/) }
+    Then {
+      given_assert_raises(StandardError, /NEVER/) { bomb }
+    }
   end
 
   context "when not called" do
     Given(:value) { :ok }
-    Then { value.should == :ok }
+    Then { given_assert_equal :ok, value }
   end
 end
 
@@ -57,7 +67,7 @@ describe "Non-Lazy Givens" do
 
   context "inner" do
     Given!(:a) { info << :given; "A VALUE" }
-    Then { info.should == [:given, :when] }
+    Then { given_assert_equal [:given, :when], info }
   end
 
 end

data/examples/integration/invariant_spec.rb

@@ -1,23 +1,23 @@
-require 'rspec/given'
+require 'example_helper'
 
 describe "Invariants" do
   Given(:info) { [] }
 
   Invariant { info << "I1" }
 
-  Then { info.should == ["I1"] }
+  Then { given_assert_equal ["I1"], info }
 
   context "with nested invariants" do
     Invariant { info << "I2" }
 
-    Then { info.should == ["I1", "I2"] }
+    Then { given_assert_equal ["I1", "I2"], info }
   end
 
   context "with multiple invariants" do
     Invariant { info << "I2a" }
     Invariant { info << "I2b" }
 
-    Then { info.should == ["I1", "I2a", "I2b"] }
+    Then { given_assert_equal ["I1", "I2a", "I2b"], info }
   end
 
   context "with a when" do
@@ -25,7 +25,7 @@ describe "Invariants" do
 
     When(:when_info) { info.dup }
 
-    Then { info.should == ["I1", "I2"] }
-    Then { when_info.should == [] }
+    Then { given_assert_equal ["I1", "I2"], info }
+    Then { given_assert_equal [], when_info }
   end
 end

data/examples/integration/then_spec.rb

@@ -1,4 +1,3 @@
-require 'rspec/given'
 require 'example_helper'
 
 describe "Then" do

data/examples/loader.rb

@@ -0,0 +1,4 @@
+ARGV.each do |fn|
+  puts "Loading #{fn} ..."
+  load fn
+end

data/examples/minitest_helper.rb

@@ -0,0 +1,38 @@
+
+module GivenAssertions
+  def given_assert(cond)
+    assert cond
+  end
+
+  def given_assert_equal(expected, actual)
+    actual.must_equal(expected)
+  end
+
+  def given_assert_match(pattern, actual)
+    actual.must_match(pattern)
+  end
+
+  def given_assert_not_match(pattern, actual)
+    actual.wont_match(pattern)
+  end
+
+  def given_assert_raises(error, pattern=//, &block)
+    ex = assert_raises(error, &block)
+    ex.message.must_match(pattern)
+  end
+end
+
+module NaturalAssertionControl
+  def use_natural_assertions_if_supported(enabled=true)
+    if enabled && ! Given::NATURAL_ASSERTIONS_SUPPORTED
+      Given {
+        skip "Natural assertions are not supported in JRuby"
+      }
+    else
+      use_natural_assertions(enabled)
+    end
+  end
+end
+
+Minitest::Spec.send(:include, GivenAssertions)
+include NaturalAssertionControl

data/examples/stack/stack_spec.rb

@@ -1,8 +1,7 @@
-require 'rspec/given'
 require 'example_helper'
 require 'stack'
 
-RSpec::Given.use_natural_assertions
+Given.use_natural_assertions
 
 describe Stack do
   Given(:stack) { Stack.new }
@@ -24,7 +23,7 @@ describe Stack do
 
     context "when popping" do
       When(:result) { stack.pop }
-      Then { result.should have_failed(Stack::UnderflowError, /empty/) }
+      Then { result == Failure(Stack::UnderflowError, /empty/) }
     end
   end
 

data/lib/given.rb

@@ -0,0 +1,2 @@
+
+require 'given/core'

data/lib/rspec/given.rb

@@ -1,19 +1 @@
-module RSpec
-  module Given
-    def self.using_old_rspec?
-      defined?(Spec) &&
-        defined?(Spec::VERSION) &&
-        defined?(Spec::VERSION::SUMMARY) &&
-        Spec::VERSION::SUMMARY =~ /^rspec +1\./
-    end
-  end
-end
-
-if RSpec::Given.using_old_rspec?
-  require 'rspec/given/rspec1_given'
-else
-  require 'rspec/given/core'
-  require 'rspec/given/have_failed'
-  require 'rspec/given/configure'
-  require 'rspec/given/monkey'
-end
+require 'given/rspec/all'

data/rakelib/bundler_fix.rb

@@ -0,0 +1,17 @@
+module Rake
+  module DSL
+
+    # Define run so that it will run in a bundle clean environment.
+
+    if defined?(Bundler)
+      def nobundle
+        Bundler.with_clean_env { yield }
+      end
+    else
+      def nobundle
+        yield
+      end
+    end
+
+  end
+end

data/rakelib/gemspec.rake

@@ -0,0 +1,161 @@
+require 'rubygems/package_task'
+require './lib/given/version'
+
+if ! defined?(Gem)
+  puts "Package Target requires RubyGEMs"
+else
+  PKG_FILES = FileList[
+    '[A-Z]*',
+    'lib/*.rb',
+    'lib/**/*.rb',
+    'rakelib/**/*',
+    'test/**/*.rb',
+    'spec/**/*.rb',
+    'examples/**/*',
+    'doc/**/*',
+  ]
+  PKG_FILES.exclude('TAGS')
+  GIVEN_CORE_FILES = FileList[*PKG_FILES].
+    exclude("lib/*-given.rb").
+    exclude("lib/rspec/**/*").
+    exclude("lib/mini*/**/*").
+    exclude("spec/**/*").
+    exclude("examples/**/*")
+  RSPEC_GIVEN_FILES = FileList[*PKG_FILES].
+    exclude("lib/mini*/**/*").
+    exclude("lib/mini*-given.rb").
+    exclude("lib/given/**/*")
+  MINISPEC_GIVEN_FILES = FileList[*PKG_FILES].
+    exclude("spec/**/*").
+    exclude("lib/rspec-given.rb").
+    exclude("lib/rspec*/**/*").
+    exclude("lib/given/**/*")
+
+  RSPEC_GIVEN_SPEC = Gem::Specification.new do |s|
+    s.name = 'rspec-given'
+    s.version = Given::VERSION
+    s.summary = "Given/When/Then Specification Extensions for RSpec."
+    s.description = <<EOF
+Given is an RSpec extension that allows the use of Given/When/Then
+terminology when defining specifications.
+EOF
+    s.files = RSPEC_GIVEN_FILES.to_a
+    s.require_path = 'lib'                         # Use these for libraries.
+    s.rdoc_options = [
+      '--line-numbers', '--inline-source',
+      '--main' , 'doc/main.rdoc',
+      '--title', 'RSpec Given Extensions'
+    ]
+
+    s.add_dependency("given_core", "= #{Given::VERSION}")
+    s.add_dependency("rspec", ">= 2.12")
+
+    s.required_ruby_version = '>= 1.9.2'
+    s.license = "MIT"
+
+    s.author = "Jim Weirich"
+    s.email = "jim.weirich@gmail.com"
+    s.homepage = "http://github.com/jimweirich/rspec-given"
+    s.rubyforge_project = "given"
+  end
+
+  MINISPEC_GIVEN_SPEC = Gem::Specification.new do |s|
+    s.name = 'minispec-given'
+    s.version = Given::VERSION
+    s.summary = "Given/When/Then Specification Extensions for Minispec::Spec."
+    s.description = <<EOF
+Given is a Minitest::Spec extension that allows the use of Given/When/Then
+terminology when defining specifications.
+EOF
+    s.files = MINISPEC_GIVEN_FILES.to_a
+    s.require_path = 'lib'                         # Use these for libraries.
+    s.rdoc_options = [
+      '--line-numbers', '--inline-source',
+      '--main' , 'doc/main.rdoc',
+      '--title', 'Minitest::Spec Given Extensions'
+    ]
+
+    s.add_dependency("given_core", "= #{Given::VERSION}")
+    s.add_dependency("minitest", "> 4.3")
+
+    s.required_ruby_version = '>= 1.9.2'
+    s.license = "MIT"
+
+    s.author = "Jim Weirich"
+    s.email = "jim.weirich@gmail.com"
+    s.homepage = "http://github.com/jimweirich/rspec-given"
+    s.rubyforge_project = "given"
+  end
+
+  GIVEN_CORE_SPEC = Gem::Specification.new do |s|
+    s.name = 'given_core'
+    s.version = Given::VERSION
+    s.summary = "Core engine for RSpec::Given and Minitest::Given."
+    s.description = <<EOF
+Given_core is the basic functionality behind rspec-given and minispec-given,
+extensions that allow the use of Given/When/Then terminology when defining
+specifications.
+EOF
+    s.files = GIVEN_CORE_FILES.to_a
+    s.require_path = 'lib'                         # Use these for libraries.
+    s.rdoc_options = [
+      '--line-numbers', '--inline-source',
+      '--main' , 'doc/main.rdoc',
+      '--title', 'RSpec Given Extensions'
+    ]
+
+    s.add_dependency("sorcerer", ">= 0.3.7")
+
+    s.required_ruby_version = '>= 1.9.2'
+    s.license = "MIT"
+
+    s.author = "Jim Weirich"
+    s.email = "jim.weirich@gmail.com"
+    s.homepage = "http://github.com/jimweirich/rspec-given"
+    s.rubyforge_project = "given"
+  end
+
+  Gem::PackageTask.new(MINISPEC_GIVEN_SPEC) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+
+  Gem::PackageTask.new(RSPEC_GIVEN_SPEC) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+
+  Gem::PackageTask.new(GIVEN_CORE_SPEC) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+
+  file "rspec-given.gemspec" => ["rakelib/gemspec.rake"] do |t|
+    require 'yaml'
+    open(t.name, "w") { |f| f.puts RSPEC_GIVEN_SPEC.to_yaml }
+  end
+
+  file "minispec-given.gemspec" => ["rakelib/gemspec.rake"] do |t|
+    require 'yaml'
+    open(t.name, "w") { |f| f.puts MINISPEC_GIVEN_SPEC.to_yaml }
+  end
+
+  file "given_core.gemspec" => ["rakelib/gemspec.rake"] do |t|
+    require 'yaml'
+    open(t.name, "w") { |f| f.puts GIVEN_CORE_SPEC.to_yaml }
+  end
+
+  desc "Create a stand-alone gemspec"
+  task :gemspec => ["rspec-given.gemspec", "minispec-given.gemspec", "given_core.gemspec"]
+
+  desc "Check Filelists"
+  task :filelists do
+    puts "==============="
+    puts "GIVEN_CORE_FILES=#{GIVEN_CORE_FILES.inspect}"
+    puts "==============="
+    puts "RSPEC_GIVEN_FILES=#{RSPEC_GIVEN_FILES.inspect}"
+    puts "==============="
+    puts "MINISPEC_GIVEN_FILES=#{MINISPEC_GIVEN_FILES.inspect}"
+    puts "==============="
+  end
+end