rspec-core 2.0.0.beta.17 → 2.0.0.beta.18

data/README.markdown

@@ -4,7 +4,7 @@ Behaviour Driven Development for Ruby
 
 ## Upgrading from rspec-1.x
 
-See Upgrade.markdown
+See [Upgrade.markdown](http://github.com/rspec/rspec-core/blob/master/Upgrade.markdown)
 
 ## Install
 
@@ -63,6 +63,10 @@ Use the documentation formatter to see the resulting spec:
     Finished in 0.000379 seconds
     1 example, 0 failures
 
+## Known issues
+
+See [http://github.com/rspec/rspec-core/issues](http://github.com/rspec/rspec-core/issues)
+
 ## Learn more
 
 While not comprehensive yet, you can learn quite a lot from the Cucumber

data/Rakefile

@@ -31,7 +31,10 @@ begin
 #{"*"*50}
 
   Thank you for installing #{gem.summary}
-  
+
+  Please be sure to look at Upgrade.markdown to see what might have changed
+  since the last release.
+
 #{"*"*50}
 EOM
   end

data/Upgrade.markdown

@@ -12,12 +12,20 @@ The command to run specs is now `rspec` instead of `spec`.
 
 RSpec-2 works with autotest as follows:
 
-    # in ./autotest/discover.rb
+    rspec --configure autotest
+
+This adds `./autotest/discover.rb` with:
+
     Autotest.add_discovery { "rspec2" }
 
-    # command line
+Now, on the command line just type:
+
     $ autotest
 
+Or, if you're using bundler:
+
+    $ bundle exec autotest
+
 The `autospec` command is a thing of the past. 
 
 ### RSpec
@@ -116,3 +124,21 @@ right version:
 In this case, we're using `exclusion_filter` instead of `filter_run` or
 `filter`, which indicate _inclusion_ filters. So each of those examples is
 excluded if we're _not_ running the version of Ruby they work with.
+
+### Shared example groups
+
+Shared example groups are now run in a nested group within the including group
+(they used to be run in the same group). Nested groups inherit `before`, `after`,
+`around`, and `let` hooks, as well as any methods that are defined in the parent
+group.
+
+This new approach provides better encapsulation, better output, and an
+opportunity to add contextual information to the shared group via a block
+passed to `it_should_behave_like`.
+
+See [features/example\_groups/shared\_example\_group.feature](http://github.com/rspec/rspec-core/blob/master/features/example_groups/shared_example_group.feature) for more information.
+
+NOTICE: The including example groups no longer have access to any of the
+methods, hooks, or state defined inside a shared group. This will break specs
+that were using shared example groups to extend the behavior of including
+groups in any way besides their intended purpose: to add examples to a group.

data/VERSION

@@ -1 +1 @@
-2.0.0.beta.17
+2.0.0.beta.18

data/autotest/discover.rb

@@ -1,2 +1,2 @@
 Autotest.add_discovery { "rspec2" }
- 
+

data/features/command_line/configure.feature

@@ -0,0 +1,19 @@
+Feature: configure
+
+  Use --configure to generate configuration files.
+
+  Currently, the only supported argument is "autotest", which creates
+  a autotest/discover.rb file in your project root directory.
+
+  Background:
+    Given a directory named "rspec_project"
+    And I cd to "rspec_project"
+
+  Scenario: generate autotest directory and discover file
+    When I run "rspec --configure autotest"
+    Then the following directories should exist:
+      | autotest |
+    And the following files should exist:
+      | autotest/discover.rb |
+    And the file "autotest/discover.rb" should contain "Autotest.add_discovery"
+    And the stdout should contain "autotest/discover.rb has been added"

data/features/example_groups/shared_example_group.feature

@@ -0,0 +1,125 @@
+Feature: Shared example group
+
+  As an RSpec user
+  I want to share my examples
+  In order to reduce duplication in my specs
+
+  Scenario: Using a shared example group
+    Given a file named "shared_example_group_spec.rb" with:
+    """
+    require "set"
+
+    shared_examples_for "a collection object" do
+      before(:each) do
+        @instance = described_class.new([7, 2, 4])
+      end
+
+      context "initialized with 3 items" do
+        it "has three items" do
+          @instance.size.should == 3
+        end
+      end
+
+      describe "#first" do
+        it "returns the first item" do
+          @instance.first.should == 7
+        end
+      end
+    end
+
+    describe Array do
+      it_should_behave_like "a collection object"
+    end
+
+    describe Set do
+      it_should_behave_like "a collection object"
+    end
+    """
+    When I run "rspec shared_example_group_spec.rb --format documentation"
+    Then the output should contain "4 examples, 0 failures"
+    And the output should contain:
+      """
+      Array
+        it should behave like a collection object
+          initialized with 3 items
+            has three items
+          #first
+            returns the first item
+
+      Set
+        it should behave like a collection object
+          initialized with 3 items
+            has three items
+          #first
+            returns the first item
+      """
+
+  Scenario: Using a shared example group with a block
+    Given a file named "shared_example_group_spec.rb" with:
+    """
+    require "set"
+
+    shared_examples_for "a collection object" do
+      describe "<<" do
+        it "adds objects to the end of the collection" do
+          collection << 1
+          collection << 2
+          collection.to_a.should eq([1,2])
+        end
+      end
+    end
+
+    describe Array do
+      it_should_behave_like "a collection object" do
+        let(:collection) { Array.new }
+      end
+    end
+
+    describe Set do
+      it_should_behave_like "a collection object" do
+        let(:collection) { Set.new }
+      end
+    end
+    """
+    When I run "rspec shared_example_group_spec.rb --format documentation"
+    Then the output should contain "2 examples, 0 failures"
+    And the output should contain:
+      """
+      Array
+        it should behave like a collection object
+          <<
+            adds objects to the end of the collection
+
+      Set
+        it should behave like a collection object
+          <<
+            adds objects to the end of the collection
+      """
+
+  Scenario: Aliasing "it_should_behave_like" to "it_has_behavior"
+    Given a file named "shared_example_group_spec.rb" with:
+      """
+      RSpec.configure do |c|
+        c.alias_it_should_behave_like_to :it_has_behavior, 'has behavior:'
+      end
+
+      shared_examples_for 'sortability' do
+        it 'responds to <==>' do
+          sortable.should respond_to(:<=>)
+        end
+      end
+
+      describe String do
+        it_has_behavior 'sortability' do
+          let(:sortable) { 'sample string' }
+        end
+      end
+      """
+    When I run "rspec shared_example_group_spec.rb --format documentation"
+    Then the output should contain "1 example, 0 failures"
+    And the output should contain:
+      """
+      String
+        has behavior: sortability
+          responds to <==>
+      """

data/features/hooks/around_hooks.feature

@@ -155,7 +155,12 @@ Feature: around hooks
       """
     When I run "rspec ./around_block_with_implicit_pending_example.rb"
     Then the output should contain "1 example, 0 failures, 1 pending"
-    And the output should contain "implicit pending example should be detected as Not Yet Implemented (Not Yet Implemented)"
+    And the output should contain:
+      """
+      Pending:
+        implicit pending example should be detected as Not Yet Implemented
+          # Not Yet Implemented
+      """
 
 
   Scenario: explicitly pending examples should be detected as pending
@@ -173,7 +178,11 @@ Feature: around hooks
       """
     When I run "rspec ./around_block_with_explicit_pending_example.rb"
     Then the output should contain "1 example, 0 failures, 1 pending"
-    And the output should contain "explicit pending example should be detected as pending (No reason given)"
+    And the output should contain:
+      """
+        explicit pending example should be detected as pending
+          # No reason given
+      """
 
   Scenario: multiple around hooks in the same scope are all run
     Given a file named "around_hooks_in_same_scope.rb" with:

data/features/pending/pending_examples.feature

@@ -28,9 +28,15 @@ Feature: pending examples
       """
     When I run "rspec ./pending_without_block_spec.rb"
     Then the exit status should be 0
-    And the output should contain "1 example, 0 failures, 1 pending"
-    And the output should contain "(something else getting finished)"
-    And the output should contain "pending_without_block_spec.rb:2"
+    And the output should contain:
+      """
+      1 example, 0 failures, 1 pending
+
+      Pending:
+        an example is implemented but waiting
+          # something else getting finished
+          # ./pending_without_block_spec.rb:2
+      """
 
   Scenario: pending any arbitary reason, with a block that fails
     Given a file named "pending_with_failing_block_spec.rb" with:
@@ -45,9 +51,15 @@ Feature: pending examples
       """
     When I run "rspec ./pending_with_failing_block_spec.rb"
     Then the exit status should be 0
-    And the output should contain "1 example, 0 failures, 1 pending"
-    And the output should contain "(something else getting finished)"
-    And the output should contain "pending_with_failing_block_spec.rb:2"
+    And the output should contain:
+      """
+      1 example, 0 failures, 1 pending
+
+      Pending:
+        an example is implemented but waiting
+          # something else getting finished
+          # ./pending_with_failing_block_spec.rb:2
+      """
 
   Scenario: pending any arbitary reason, with a block that passes
     Given a file named "pending_with_passing_block_spec.rb" with:

data/lib/autotest/rspec2.rb

@@ -17,7 +17,7 @@ end
 class RSpecCommandError < StandardError; end
 
 class Autotest::Rspec2 < Autotest
-  
+
   SPEC_PROGRAM = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'bin', 'rspec'))
 
   def initialize

data/lib/rspec/core.rb

@@ -13,6 +13,7 @@ require 'rspec/core/pending'
 require 'rspec/core/around_proxy'
 require 'rspec/core/world'
 require 'rspec/core/configuration'
+require 'rspec/core/command_line_configuration'
 require 'rspec/core/option_parser'
 require 'rspec/core/configuration_options'
 require 'rspec/core/command_line'

data/lib/rspec/core/command_line_configuration.rb

@@ -0,0 +1,62 @@
+module RSpec
+  module Core
+    class CommandLineConfiguration
+      attr_reader :command
+
+      def initialize(cmd)
+        @command = cmd
+      end
+
+      def run
+        case @command
+        when 'autotest' then Autotest.generate
+        else raise ArgumentError, <<-MESSAGE
+
+#{"*"*50}
+"#{@command}" is not valid a valid argument to "rspec --configure".
+Supported options are:
+
+  rspec --configure autotest # generates configuration to run autotest with rspec
+
+#{"*"*50}
+MESSAGE
+        end
+      end
+
+      class Autotest
+        class << self
+          def generate
+            create_autotest_directory
+            create_discover_file
+            puts "autotest/discover.rb has been added"
+          end
+
+          def create_autotest_directory
+            Dir.mkdir('autotest') unless File.exist?('autotest')
+          end
+
+          def create_discover_file
+            optionally_remove_discover_file if discover_file_exists?
+            File.open(discover_file_path, 'w') do |file|
+              file << 'Autotest.add_discovery { "rspec2" }'
+            end
+          end
+
+          def optionally_remove_discover_file
+            print "Discover file already exists, overwrite [y/N]? "
+            exit if gets !~ /y/i
+            FileUtils.rm_rf(discover_file_path)
+          end
+
+          def discover_file_exists?
+            File.exist?(discover_file_path)
+          end
+
+          def discover_file_path
+            File.join('autotest', 'discover.rb')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/configuration.rb

@@ -33,10 +33,10 @@ module RSpec
       add_setting :include_or_extend_modules, :default => []
       add_setting :formatter_class, :default => RSpec::Core::Formatters::ProgressFormatter
       add_setting :backtrace_clean_patterns, :default => [
-        /\/lib\/ruby\//, 
-        /bin\/rcov:/, 
-        /vendor\/rails/, 
-        /bin\/rspec/, 
+        /\/lib\/ruby\//,
+        /bin\/rcov:/,
+        /vendor\/rails/,
+        /bin\/rspec/,
         /bin\/spec/,
         /lib\/rspec\/(core|expectations|matchers|mocks)/
       ]
@@ -46,7 +46,7 @@ module RSpec
       #   add_setting(:name, :default => "default_value")
       #   add_setting(:name, :alias => :other_setting)
       #
-      # Use this to add custom settings to the RSpec.configuration object. 
+      # Use this to add custom settings to the RSpec.configuration object.
       #
       #   RSpec.configuration.add_setting :foo
       #
@@ -66,7 +66,7 @@ module RSpec
       #   end
       #
       # == Options
-      # 
+      #
       # +add_setting+ takes an optional hash that supports the following
       # keys:
       #
@@ -115,13 +115,15 @@ module RSpec
           'rspec/core/mocking/with_flexmock'
         else
           'rspec/core/mocking/with_absolutely_nothing'
-        end 
+        end
       end
 
       def full_backtrace=(bool)
         settings[:backtrace_clean_patterns] = []
       end
 
+      remove_method :color_enabled=
+
       def color_enabled=(bool)
         return unless bool
         settings[:color_enabled] = true
@@ -171,7 +173,7 @@ EOM
       def full_description=(description)
         filter_run :full_description => /#{description}/
       end
-      
+
       def formatter=(formatter_to_use)
         if string_const?(formatter_to_use) && (class_name = eval(formatter_to_use)).is_a?(Class)
           formatter_class = class_name
@@ -185,19 +187,19 @@ EOM
             RSpec::Core::Formatters::HtmlFormatter
           when 't', 'textmate'
             RSpec::Core::Formatters::TextMateFormatter
-          when 'progress' 
+          when 'p', 'progress'
             RSpec::Core::Formatters::ProgressFormatter
-          else 
+          else
             raise ArgumentError, "Formatter '#{formatter_to_use}' unknown - maybe you meant 'documentation' or 'progress'?."
           end
         end
         self.formatter_class = formatter_class
       end
-      
+
       def string_const?(str)
         str.is_a?(String) && /\A[A-Z][a-zA-Z0-9_:]*\z/ =~ str
       end
-      
+
       def formatter
         @formatter ||= formatter_class.new(output)
       end
@@ -227,6 +229,31 @@ EOM
         RSpec::Core::ExampleGroup.alias_example_to(new_name, extra_options)
       end
 
+      # Define an alias for it_should_behave_like that allows different
+      # language (like "it_has_behavior" or "it_behaves_like") to be
+      # employed when including shared examples.
+      #
+      # Example:
+      #
+      #     alias_it_should_behave_like_to(:it_has_behavior, 'has behavior:')
+      #
+      # allows the user to include a shared example group like:
+      #
+      #     describe Entity do
+      #       it_has_behavior 'sortability' do
+      #         let(:sortable) { Entity.new }
+      #       end
+      #     end
+      #
+      # which is reported in the output as:
+      #
+      #     Entity
+      #       has behavior: sortability
+      #         # sortability examples here
+      def alias_it_should_behave_like_to(new_name, report_label = '')
+        RSpec::Core::ExampleGroup.alias_it_should_behave_like_to(new_name, report_label)
+      end
+
       def filter_run_including(options={})
         # TODO (DC 2010-07-03) this should probably warn when the unless clause returns true
         self.filter = options unless filter and filter[:line_number] || filter[:full_description]