rspec-core 2.8.0.rc1 → 2.8.0.rc2

data/lib/rspec/core/metadata_hash_builder.rb

@@ -1,6 +1,8 @@
 module RSpec
   module Core
+    # @private
     module MetadataHashBuilder
+      # @private
       module Common
         def build_metadata_hash_from(args)
           metadata = args.last.is_a?(Hash) ? args.pop : {}
@@ -29,6 +31,7 @@ module RSpec
           end
       end
 
+      # @private
       module WithConfigWarning
         include Common
 
@@ -57,6 +60,7 @@ NOTICE
           end
       end
 
+      # @private
       module WithDeprecationWarning
         include Common
 

data/lib/rspec/core/option_parser.rb

@@ -17,7 +17,7 @@ module RSpec::Core
         RSpec.deprecate("the --formatter option", "-f or --format")
         args[args.index("--formatter")] = "--format"
       end
-      options = {}
+      options = args.delete('--tty') ? {:tty => true} : {}
       parser(options).parse!(args)
       options
     end
@@ -28,63 +28,66 @@ module RSpec::Core
       OptionParser.new do |parser|
         parser.banner = "Usage: rspec [options] [files or directories]\n\n"
 
-        parser.on('-I DIRECTORY', 'specify $LOAD_PATH directory (may be used more than once)') do |dir|
+        parser.on('-I PATH', 'Specify PATH to add to $LOAD_PATH (may be used more than once).') do |dir|
           options[:libs] ||= []
           options[:libs] << dir
         end
 
-        parser.on('-r', '--require PATH', 'Require a file') do |path|
+        parser.on('-r', '--require PATH', 'Require a file.') do |path|
           options[:requires] ||= []
           options[:requires] << path
         end
 
-        parser.on('-O', '--options PATH', 'Specify the path to a custom options file') do |path|
+        parser.on('-O', '--options PATH', 'Specify the path to a custom options file.') do |path|
           options[:custom_options_file] = path
         end
 
-        parser.on('--order TYPE', 'Run examples by the specified order type',
-                  '  [rand] randomized',
-                  '  [random] alias for rand',
+        parser.on('--order TYPE[:SEED]', 'Run examples by the specified order type.',
+                  '  [default] files are ordered based on the underlying file',
+                  '            system\'s order',
+                  '  [rand]    randomize the order of files, groups and examples',
+                  '  [random]  alias for rand',
                   '  [random:SEED] e.g. --order random:123') do |o|
           options[:order] = o
         end
 
-        parser.on('--seed SEED', "Equivalent of --order rand:SEED") do |seed|
+        parser.on('--seed SEED', Integer, 'Equivalent of --order rand:SEED.') do |seed|
           options[:order] = "rand:#{seed}"
         end
 
-        parser.on('-d', '--debugger', 'Enable debugging') do |o|
+        parser.on('-d', '--debugger', 'Enable debugging.') do |o|
           options[:debug] = true
         end
 
-        parser.on('--fail-fast', 'Abort the run on first failure') do |o|
+        parser.on('--fail-fast', 'Abort the run on first failure.') do |o|
           options[:fail_fast] = true
         end
 
-        parser.on('--failure-exit-code CODE', 'Override the exit code used when there are failing specs') do |o|
-          options[:failure_exit_code] = o.to_i
+        parser.on('--failure-exit-code CODE', Integer, 'Override the exit code used when there are failing specs.') do |code|
+          options[:failure_exit_code] = code
         end
 
-        parser.on('-X', '--[no-]drb', 'Run examples via DRb') do |o|
+        parser.on('-X', '--[no-]drb', 'Run examples via DRb.') do |o|
           options[:drb] = o
         end
 
-        parser.on('--drb-port [PORT]', 'Port to connect to on the DRb server') do |o|
+        parser.on('--drb-port PORT', 'Port to connect to the DRb server.') do |o|
           options[:drb_port] = o.to_i
         end
 
-        parser.on('--configure COMMAND', 'Generate configuration files') do |cmd|
-          CommandLineConfiguration.new(cmd).run
+        parser.on('--init', 'Initialize your project with RSpec.') do |cmd|
+          ProjectInitializer.new(cmd).run
           exit
         end
 
-        parser.on("--tty", "Used internally by rspec when sending commands to other processes") do |o|
-          options[:tty] = true
+        parser.on('--configure', 'Deprecated. Use --init instead.') do |cmd|
+          warn "--configure is deprecated with no effect. Use --init instead."
+          exit
         end
 
-        parser.separator("\n  **** Output formatting ****\n\n")
+        parser.separator("\n  **** Output ****\n\n")
 
-        parser.on('-f', '--format FORMATTER', 'Choose a formatter',
+        parser.on('-f', '--format FORMATTER', 'Choose a formatter.',
                 '  [p]rogress (default - dots)',
                 '  [d]ocumentation (group and example names)',
                 '  [h]tml',
@@ -96,28 +99,28 @@ module RSpec::Core
 
         parser.on('-o', '--out FILE',
                   'Write output to a file instead of STDOUT. This option applies',
-                  'to the previously specified --format, or the default format if',
-                  'no format is specified.'
+                  '  to the previously specified --format, or the default format',
+                  '  if no format is specified.'
                  ) do |o|
           options[:formatters] ||= [['progress']]
           options[:formatters].last << o
         end
 
-        parser.on('-b', '--backtrace', 'Enable full backtrace') do |o|
+        parser.on('-b', '--backtrace', 'Enable full backtrace.') do |o|
           options[:full_backtrace] = true
         end
 
-        parser.on('-c', '--[no-]color', '--[no-]colour', 'Enable color in the output') do |o|
+        parser.on('-c', '--[no-]color', '--[no-]colour', 'Enable color in the output.') do |o|
           options[:color] = o
         end
 
-        parser.on('-p', '--profile', 'Enable profiling of examples with output of the top 10 slowest examples') do |o|
+        parser.on('-p', '--profile', 'Enable profiling of examples and list 10 slowest examples.') do |o|
           options[:profile_examples] = o
         end
 
         parser.separator <<-FILTERING
 
-  **** Filtering and tags ****
+  **** Filtering/tags ****
 
     In addition to the following options for selecting specific files, groups,
     or examples, you can select a single example by appending the line number to
@@ -127,7 +130,7 @@ module RSpec::Core
 
 FILTERING
 
-        parser.on('-P', '--pattern PATTERN', 'Load files matching pattern (default: "spec/**/*_spec.rb")') do |o|
+        parser.on('-P', '--pattern PATTERN', 'Load files matching pattern (default: "spec/**/*_spec.rb").') do |o|
           options[:pattern] = o
         end
 
@@ -135,38 +138,33 @@ FILTERING
           options[:full_description] = Regexp.compile(Regexp.escape(o))
         end
 
-        parser.on('-l', '--line_number LINE', 'Specify line number of an example or group (may be specified multiple times)') do |o|
+        parser.on('-l', '--line_number LINE', 'Specify line number of an example or group (may be',
+                                              '  used more than once).') do |o|
           (options[:line_numbers] ||= []) << o
         end
 
         parser.on('-t', '--tag TAG[:VALUE]',
-                  'Run examples with the specified tag, or exclude',
-                  'examples by ading ~ before the tag (e.g. ~slow)',
-                  '(TAG is always converted to a symbol)') do |tag|
+                  'Run examples with the specified tag, or exclude examples',
+                  'by adding ~ before the tag.',
+                  '  - e.g. ~slow',
+                  '  - TAG is always converted to a symbol') do |tag|
           filter_type = tag =~ /^~/ ? :exclusion_filter : :inclusion_filter
 
           name,value = tag.gsub(/^(~@|~|@)/, '').split(':')
           name = name.to_sym
 
           options[filter_type] ||= {}
-          options[filter_type][name] = case value
-                                       when /^(true|false|nil)$/
-                                         eval(value)
-                                       when nil
-                                         true
-                                       else
-                                         value
-                                       end
-        end
-
-        parser.on('--default_path PATH', 'Set the default path where RSpec looks for examples.',
-                                         'Can be a path to a file or a directory') do |path|
+          options[filter_type][name] = value.nil? ? true : eval(value) rescue value
+        end
+
+        parser.on('--default_path PATH', 'Set the default path where RSpec looks for examples (can',
+                                         '  be a path to a file or a directory).') do |path|
           options[:default_path] = path
         end
 
         parser.separator("\n  **** Utility ****\n\n")
 
-        parser.on('-v', '--version', 'Show version') do
+        parser.on('-v', '--version', 'Display the version.') do
           puts RSpec::Core::Version::STRING
           exit
         end

data/lib/rspec/core/pending.rb

@@ -3,7 +3,20 @@ module RSpec
     module Pending
       class PendingDeclaredInExample < StandardError; end
 
-      DEFAULT_MESSAGE = 'No reason given'
+      # If Test::Unit is loaed, we'll use its error as baseclass, so that Test::Unit
+      # will report unmet RSpec expectations as failures rather than errors.
+      begin
+        class PendingExampleFixedError < Test::Unit::AssertionFailedError; end
+      rescue
+        class PendingExampleFixedError < StandardError; end
+      end
+
+      class PendingExampleFixedError
+        def pending_fixed?; true; end
+      end
+
+      NO_REASON_GIVEN = 'No reason given'
+      NOT_YET_IMPLEMENTED = 'Not yet implemented'
 
       # @overload pending()
       # @overload pending(message)
@@ -46,11 +59,20 @@ module RSpec
       #         end
       #       end
       #     end
+      #
+      # @note `before(:each)` hooks are eval'd when you use the `pending`
+      #   method within an example. If you want to declare an example `pending`
+      #   and bypass the `before` hooks as well, you can pass `:pending => true`
+      #   to the `it` method:
+      #
+      #       it "does something", :pending => true do
+      #         # ...
+      #       end
       def pending(*args)
         return self.class.before(:each) { pending(*args) } unless example
 
         options = args.last.is_a?(Hash) ? args.pop : {}
-        message = args.first || DEFAULT_MESSAGE
+        message = args.first || NO_REASON_GIVEN
 
         if options[:unless] || (options.has_key?(:if) && !options[:if])
           return block_given? ? yield : nil
@@ -70,7 +92,7 @@ module RSpec
           ensure
             teardown_mocks_for_rspec
           end
-          raise RSpec::Core::PendingExampleFixedError.new if result
+          raise PendingExampleFixedError.new if result
         end
         raise PendingDeclaredInExample.new(message)
       end

data/lib/rspec/core/project_initializer.rb

@@ -0,0 +1,62 @@
+module RSpec
+  module Core
+    class ProjectInitializer
+      def initialize(arg=nil)
+        @arg = arg
+      end
+
+      def run
+        warn "The --configure option no longer needs any arguments, so #{@arg} was ignored." if @arg
+        create_spec_helper_file
+        create_dot_rspec_file
+        delete_if_confirmed("autotest/discover.rb", <<-MESSAGE)
+  RSpec registers its own discover.rb with Autotest, so autotest/discover.rb is
+  no longer needed.
+        MESSAGE
+
+        delete_if_confirmed("lib/tasks/rspec.rake", <<-MESSAGE)
+  If the file in lib/tasks/rspec.rake is the one generated by rspec-rails-1x,
+  you can get rid of it, as it is no longer needed with rspec-2.
+        MESSAGE
+      end
+
+      def create_dot_rspec_file
+        if File.exist?('.rspec')
+          report_exists('.rspec')
+        else
+          report_creating('.rspec')
+          FileUtils.touch('.rspec')
+        end
+      end
+
+      def create_spec_helper_file
+        if File.exist?('spec/spec_helper.rb')
+          report_exists("spec/spec_helper.rb")
+        else
+          report_creating("spec/spec_helper.rb")
+          FileUtils.mkdir('spec') unless File.exist?('spec') && File.directory?('spec')
+          FileUtils.touch('spec/spec_helper.rb')
+        end
+      end
+
+      def delete_if_confirmed(path, message)
+        if File.exist?(path)
+          puts
+          puts message
+          puts
+          puts "  delete   #{path}? [y/n]"
+          FileUtils.rm_rf(path) if gets =~ /y/i
+        end
+      end
+
+      def report_exists(file)
+        puts "   exist   #{file}"
+      end
+
+      def report_creating(file)
+        puts "  create   #{file}"
+      end
+
+    end
+  end
+end

data/lib/rspec/core/rake_task.rb

@@ -134,7 +134,7 @@ module RSpec
               rescue
                 puts failure_message if failure_message
               end
-              raise("ruby #{spec_command} failed") if fail_on_error unless success
+              raise("#{spec_command} failed") if fail_on_error unless success
             end
           end
         end
@@ -156,18 +156,12 @@ module RSpec
                             cmd_parts << RUBY
                             cmd_parts << ruby_opts
                             cmd_parts << "-w" if @warning
-                            cmd_parts << "-S"
-                            cmd_parts << runner
-                            if rcov
-                              cmd_parts << ["-Ispec:lib", rcov_opts]
-                            else
-                              cmd_parts << rspec_opts
-                            end
+                            cmd_parts << "-S" << runner
+                            cmd_parts << "-Ispec:lib" << rcov_opts if rcov
                             cmd_parts << files_to_run
-                            if rcov && rspec_opts
-                              cmd_parts << ["--",  rspec_opts]
-                            end
-                            cmd_parts.flatten.compact.reject(&blank).join(" ")
+                            cmd_parts << "--" if rcov && rspec_opts
+                            cmd_parts << rspec_opts
+                            cmd_parts.flatten.reject(&blank).join(" ")
                           end
       end
 
@@ -178,7 +172,7 @@ module RSpec
       end
 
       def blank
-        lambda {|s| s == ""}
+        lambda {|s| s.nil? || s == ""}
       end
     end
   end

data/lib/rspec/core/runner.rb

@@ -46,12 +46,12 @@ module RSpec
       # want files like spec_helper.rb to be reloaded, be sure to load `load`
       # instead of `require`.
       #
-      # ==== Parameters
+      # #### Parameters
       # * +args+ - an array of command-line-supported arguments
       # * +err+ - error stream (Default: $stderr)
       # * +out+ - output stream (Default: $stdout)
       #
-      # ==== Returns
+      # #### Returns
       # * +Fixnum+ - exit status code (0/1)
       def self.run(args, err=$stderr, out=$stdout)
         trap_interrupt

data/lib/rspec/core/shared_context.rb

@@ -20,7 +20,7 @@ module RSpec
     #     end
     module SharedContext
       include Hooks
-      include Let::ClassMethods
+      include Let::ExampleGroupMethods
 
       def included(group)
         [:before, :after].each do |type|

data/lib/rspec/core/shared_example_group.rb

@@ -2,7 +2,14 @@ module RSpec
   module Core
     module SharedExampleGroup
 
-      def shared_context(*args, &block)
+      # @overload shared_examples(name, &block)
+      # @overload shared_examples(name, tags, &block)
+      #
+      # Creates and stores (but does not evaluate) the block.
+      #
+      # @see ExampleGroup.include_examples
+      # @see ExampleGroup.include_context
+      def shared_examples(*args, &block)
         if [String, Symbol, Module].any? {|cls| cls === args.first }
           object = args.shift
           ensure_shared_example_group_name_not_taken(object)
@@ -18,9 +25,9 @@ module RSpec
         end
       end
 
-      alias :shared_examples     :shared_context
-      alias :share_examples_for  :shared_context
-      alias :shared_examples_for :shared_context
+      alias_method :shared_context,      :shared_examples
+      alias_method :share_examples_for,  :shared_examples
+      alias_method :shared_examples_for, :shared_examples
 
       def share_as(name, &block)
         if Object.const_defined?(name)
@@ -46,7 +53,6 @@ module RSpec
         RSpec.world.shared_example_groups[shared_const] = block
       end
 
-
     private
 
       def raise_name_error

data/lib/rspec/core/subject.rb

@@ -1,7 +1,7 @@
 module RSpec
   module Core
     module Subject
-      module InstanceMethods
+      module ExampleMethods
 
         # Returns the subject defined by the example group. The subject block is
         # only executed once per example, the result of which is cached and
@@ -69,7 +69,7 @@ module RSpec
         end
       end
 
-      module ClassMethods
+      module ExampleGroupMethods
         # Creates a nested example group named by the submitted +attribute+,
         # and then generates an example using the submitted block.
         #
@@ -165,7 +165,7 @@ module RSpec
         end
 
         def implicit_subject
-          described = describes || description
+          described = described_class || description
           Class === described ? proc { described.new } : proc { described }
         end
       end