rspec-instructure 1.3.3

data/License.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2005-2010 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.rdoc

@@ -0,0 +1,44 @@
+== RSpec
+
+Behaviour Driven Development for Ruby
+
+This is the repository for rspec-1.x. For more information, please
+see http://rspec.info.
+
+If you're looking for rspec-2 (and if you're not, what are you waiting for?),
+see:
+
+* http://relishapp.com/rspec
+* http://github.com/rspec/rspec
+
+== Install
+
+  gem install rspec
+
+== Synopsis
+
+  describe Account do
+    context "transfering money" do
+      it "deposits transfer amount to the other account" do
+        source = Account.new(50, :USD)
+        target = mock('target account')
+        target.should_receive(:deposit).with(Money.new(5, :USD))
+        source.transfer(5, :USD).to(target)
+      end
+
+      it "reduces its balance by the transfer amount" do
+        source = Account.new(50, :USD)
+        target = stub('target account')
+        source.transfer(5, :USD).to(target)
+        source.balance.should == Money.new(45, :USD)
+      end
+    end
+  end
+  
+  $ spec ./spec/account_spec.rb --format nested
+  Account
+    transfering money
+      deposits transfer amount to the other account
+      reduces its balance by the transfer amount
+    
+  2 examples, 0 failures

data/Rakefile

@@ -0,0 +1,110 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+$:.unshift 'lib'
+
+require 'spec/version'
+require 'spec/rake/spectask'
+require 'spec/ruby'
+
+# Some of the tasks are in separate files since they are also part of the website documentation
+load 'resources/rake/examples.rake'
+load 'resources/rake/examples_with_rcov.rake'
+load 'resources/rake/failing_examples_with_html.rake'
+load 'resources/rake/verify_rcov.rake'
+
+task :cleanup_rcov_files do
+  rm_rf 'coverage.data'
+end
+
+if RUBY_VERSION =~ /^1.8/
+  task :default => [:cleanup_rcov_files, :features, :verify_rcov]
+else
+  task :default => [:spec, :features]
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+end
+
+namespace :spec do
+  desc "Run all specs with rcov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--options', 'spec/spec.opts']
+    t.rcov = true
+    t.rcov_dir = 'coverage'
+    t.rcov_opts = ['--exclude', "features,kernel,load-diff-lcs\.rb,instance_exec\.rb,lib/spec.rb,lib/spec/runner.rb,^spec/*,bin/spec,examples,/gems,/Library/Ruby,\.autotest,#{ENV['GEM_HOME']}"]
+    t.rcov_opts << '--sort coverage --text-summary --aggregate coverage.data'
+  end
+  
+  desc "Run files listed in spec/spec_files.txt"
+  Spec::Rake::SpecTask.new(:focus) do |t|
+    if File.exists?('spec/spec_files.txt')
+      t.spec_files = File.readlines('spec/spec_files.txt').collect{|f| f.chomp}
+    end
+  end
+end
+
+begin
+  require 'cucumber/rake/task'
+  desc "Run Cucumber features"
+  if RUBY_VERSION =~ /^1.8/
+    Cucumber::Rake::Task.new :features do |t|
+      t.rcov = true
+      t.rcov_opts = ['--exclude', "features,kernel,load-diff-lcs\.rb,instance_exec\.rb,lib/spec.rb,lib/spec/runner.rb,^spec/*,bin/spec,examples,/gems,/Library/Ruby,\.autotest,#{ENV['GEM_HOME']}"]
+      t.rcov_opts << '--no-html --aggregate coverage.data'
+      t.cucumber_opts = %w{--format progress}
+    end
+  else
+    task :features do
+      sh 'cucumber --profile no_heckle'
+    end
+  end
+rescue LoadError
+  puts "You need cucumber installed to run cucumber tasks"
+end
+
+desc "Run failing examples (see failure output)"
+Spec::Rake::SpecTask.new('failing_examples') do |t|
+  t.spec_files = FileList['failing_examples/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+end
+
+def egrep(pattern)
+  Dir['**/*.rb'].each do |fn|
+    count = 0
+    open(fn) do |f|
+      while line = f.gets
+        count += 1
+        if line =~ pattern
+          puts "#{fn}:#{count}:#{line}"
+        end
+      end
+    end
+  end
+end
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  egrep /(FIXME|TODO|TBD)/
+end
+
+desc "Verifies that there is no uncommitted code"
+task :verify_committed do
+  IO.popen('git status') do |io|
+    io.each_line do |line|
+      raise "\n!!! Do a git commit first !!!\n\n" if line =~ /^#\s*modified:/
+    end
+  end
+end
+
+task :clobber => :clobber_tmp
+
+task :clobber_tmp do
+  cmd = %q[rm -r tmp]
+  puts cmd
+  system cmd if test ?d, 'tmp'
+end

data/Ruby1.9.rdoc

@@ -0,0 +1,31 @@
+= RSpec and Ruby 1.9
+
+RSpec runs on Ruby 1.9.1 with the following caveats.
+
+== Test::Unit
+
+RSpec/Test::Unit interop will run with the test-unit-1.2.3 gem, but you must install it.
+
+== Class Variables
+
+Due to changes in scoping rules, class variables within example groups are not
+supported in Ruby 1.9.
+
+    describe "a class variable" do
+      @@class_variable = "a class variable"
+  
+      it "can access class variables in examples in Ruby 1.8" do
+        with_ruby 1.8 do
+          @@class_variable.should == "a class variable"
+        end
+      end
+  
+      it "can NOT access class variables in examples in Ruby 1.9" do
+        with_ruby 1.9 do
+          lambda do
+            @@class_variable.should == "a class variable"
+          end.should raise_error(NameError)
+        end
+      end
+    end
+

data/TODO.txt

@@ -0,0 +1,17 @@
+== Refactoring
+
+** global predictate matchers should be stored in run_options
+* eliminate dependency on global options and configuration
+** the only place they should exist is in the Runner, which should manage them
+
+== Future
+
+* do SOMETHING with the website
+* separate the underlying framework from the DSL
+  * be able to do everything with classes and methods
+* tweak raise_error rdoc to show only one arg
+
+== rspec-2.0
+
+* rename top level namespace to Rspec and commands to 'rspec' and 'autorspec'
+  * continue to support Spec 'spec' and 'autospec' as aliases for a reasonable time

data/Upgrade.rdoc

@@ -0,0 +1,260 @@
+= Upgrade to 1.3.0
+
+== What's changed
+
+=== +be_true+ and +be_false+
+
+These methods now align with Ruby's conditional semantics:
+
+* +be_false+ passes for +false+ and +nil+
+* +be_true+ passes for everything else
+
+This is a change from the previous behaviour (which wasn't working correctly
+anyway), which was supposed to treat +be_true+ as <tt>equal(true)</tt>, and +be_false+ as
+<tt>equal(false)</tt>. 
+
+If the actual values +true+ and +false+ are meaningful to your examples, you'll
+want to change the to use <tt>equal(true)</tt> and <tt>equal(false)</tt> (or
+<tt>==(true)</tt> and <tt>==(false)</tt>).
+
+=== +raise_exception+
+
+We changed the +raise_error+ matcher to +raise_exception+, and aliased it with
++raise_error+. This maintains backward compatibility, and also gives you the
+option of being more precise in specs about what is expected.
+
+=== Matcher DSL
+
+==== +match+ rescues from +ExpectationNotMetErrror+ by default
+
+This allows you to wrap other expectations in the +match+ method. Consider
+this matcher:
+
+    Spec::Matchers.define :teach do |subject|
+      match do |teacher|
+        teacher.subjects.should include(subject)
+      end
+    end
+
+The block passed to +match+ is called internally by Rspec, and is expected to
+return a boolean value. In this case, if <tt>should include(subject)</tt>
+fails, it raises an +ExpectationNotMetError+.
+
+Beginning with rspec-1.3.0, when the match block raises an
++ExpectationNotMetError+, it is captured and the block returns +false+.
+Otherwise it returns +true+, so it works like any other matcher.
+
+==== match_unless_raises
+
+The new +match_unless_raises+ method allows you to wrap <tt>Test::Unit</tt>
+assertions by capturing +AssertionFailedError+ and returning false, just as the
++match+ method now does with +ExpectationNotMetError+.
+
+    Spec::Matchers.define :teach do |subject|
+      match_unless_raises Test::Unit::AssertionFailedError do |teacher|
+        assert teacher.subjects.include?(subject)
+      end
+    end
+
+= Upgrade to rspec-1.2.9
+
+== What's new
+
+=== spec/spec.opts
+
+If you have a spec/spec.opts file, the spec command will now use that
+automatically as long as you don't include any options on the command line.
+
+=== let()
+
+Writing specs tends to follow a regular pattern of using local variables,
+discovering duplication, and then having to convert to local variables to
+instance variables by adding an "@" symbol. The let() method assigns the result
+of a lazy eval'd block as the return value of an instance method using the same
+name. This way you can go from this:
+
+    describe Subscription do
+      it "does something" do
+        subscription = Subscription.create :limit => 1
+        subscription...
+      end
+
+      it "does something else" do
+        subscription = Subscription.create :limit => 1
+        subscription...
+      end
+    end
+
+to this:
+
+    describe Subscription do
+      let(:subscription) { Subscription.create :limit => 1 }
+
+      it "does something" do
+        subscription...
+      end
+
+      it "does something else" do
+        subscription...
+      end
+    end
+
+=== its()
+
+If you're in the habit of writing one-liners using implicit subject, this new
+its() feature is for you. Here's the basic idea:
+
+    describe Array do
+      its(:length) { should == 0 }
+    end
+
+= Upgrade to rspec-1.2.3-1.2.7
+
+== What's Changed
+
+=== Matcher DSL
+
+Use Spec::Matchers.define instead of Spec::Matchers.create (which is now
+deprecated).
+
+=== Explicit Predicate Matchers are deprecated
+
+With the addition of the new Matcher DSL the old, confusing, and
+almost-nobody-uses-it explicit predicate matcher functionality's days are now
+numbered.
+
+If you're not familiar with this feature, don't worry about it. If you have anything
+that looks like this:
+
+    predicate_matchers[:swim] = :can_swim?
+
+Or this
+
+    config.predicate_matchers[:swim] = :can_swim?
+
+Change it to this:
+
+    Spec::Matchers.define :swim do
+      match do |potential_swimmer|
+        potential_swimmer.can_swim?
+      end
+    end
+
+== Custom Formatters
+
+If you have an custom formatter, the <tt>add_example_group</tt> method has
+been changed to <tt>example_group_started</tt>, and kept as an alias so your
+formatters will still work. Though not yet, <tt>add_example_group</tt> will be
+deprecated in a future minor release, and removed in a future major release,
+so we recommend you make this change now.
+
+= Upgrade to rspec-1.2.2
+
+== What's Changed
+
+=== <tt>require 'rubygems' unless ENV['NO_RUBYGEMS']</tt>
+
+After minor public outcry and confusion, we restored necessary references to
+rubygems in rspec. If you use a different mechanism for managing gems, just
+set a <tt>NO_RUBYGEMS</tt> environment variable (to any non-nil value).
+
+=== Proxies and locations
+
+This is probably only interesting to you if you use custom formatters.
+
+Formatters now receive Spec::Example::ExampleGroupProxy and
+Spec::Example::ExampleGroup objects with cohesive APIs for reporting. See the
+RDoc for those classes and Spec::Runner::Formatter::BaseFormatter for more
+information.
+
+== What's new
+
+=== The new matcher DSL works with test/unit (without the rest of rspec)
+
+We'll be separating this out to its own gem for rspec 2.0, but for now, just install
+rspec >= 1.2.1 and add the following to your <tt>test_helper</tt> file:
+
+    require 'spec/expectations'
+    class Test::Unit::TestCase
+      include Spec::Matchers
+    end
+
+This will add <tt>should()</tt> and <tt>should_not()</tt> to your objects, make all of
+rspec's built-in matchers available to your tests, INCLUDING rspec's DSL for
+creating matchers (see below, under Upgrade to rspec-1.2.0)
+
+=== debugger
+
+If you have ruby-debug installed, you can set a breakpoint by adding <tt>debugger()</tt>
+in your code:
+
+    # some code .....
+    debugger
+    # some more code ....
+
+... and using the <tt>--debugger</tt> or <tt>-u</tt> command line option.
+
+    spec path/to/file.rb --debugger
+
+= Upgrade to rspec-1.2.0
+
+== What's Changed
+
+=== WARNINGS
+
+* If you use the ruby command to run specs instead of the spec command, you'll
+  need to require 'spec/autorun' or they won't run. This won't affect you if
+  you use the spec command or the Spec::Rake::SpecTask that ships with RSpec.
+
+* require 'spec/test/unit' to invoke test/unit interop if you're using
+  RSpec's core (this is handled implicitly with spec-rails)
+
+* setup and teardown are gone - use before and after instead
+
+  * you can still use setup and teardown if you're using
+    Test::Unit::TestCase as the base ExampleGroup class (which is implicit
+    in rspec-rails)
+
+* The matcher protocol has been improved. The old protocol is still supported,
+  but we added support for two new methods that speak a bit more clearly:
+
+    failure_message          => failure_message_for_should
+    negative_failure_message => failure_message_for_should_not
+
+* All references to rubygems have been removed from within rspec's code.
+
+  * See http://gist.github.com/54177 for rationale and suggestions on
+    alternative approaches to loading rubygems
+
+== What's New
+
+=== Ruby 1.9
+
+RSpec now works with Ruby 1.9.1. See http://wiki.github.com/dchelimsky/rspec/ruby-191
+for useful information.
+
+=== Improved heckle integration
+
+RSpec works with heckle again! Gotta use heckle >= 1.4.2 for this to work
+though, and it only works with ruby-1.8.6 and 1.8.7 (heckle doesn't support
+1.9.1 yet).
+
+    [sudo] gem install heckle --version ">=1.4.2"
+    spec spec/game/mastermind.rb --heckle Game::Mastermind
+
+=== New Matcher DSL
+
+We've added a new DSL for generating custom matchers very simply and cleanly.
+We'll still support the simple_matcher method, so never fear if you're using
+that, but we recommend that you start developing your new matchers with this
+new syntax.
+
+    Spec::Matchers.create :be_a_multiple_of do |smaller|
+      match do |bigger|
+        bigger % smaller == 0
+      end
+    end
+
+    9.should be_a_multiple_of(3)
+
+See <tt>features/matchers/define_matcher.feature</tt> for more examples