opal-rspec 0.4.0.beta3 → 0.4.0.beta4

data/vendor_lib/rspec/core/metadata.rb

@@ -0,0 +1,313 @@
+module RSpec
+  module Core
+    # Each ExampleGroup class and Example instance owns an instance of
+    # Metadata, which is Hash extended to support lazy evaluation of values
+    # associated with keys that may or may not be used by any example or group.
+    #
+    # In addition to metadata that is used internally, this also stores
+    # user-supplied metadata, e.g.
+    #
+    #     describe Something, :type => :ui do
+    #       it "does something", :slow => true do
+    #         # ...
+    #       end
+    #     end
+    #
+    # `:type => :ui` is stored in the Metadata owned by the example group, and
+    # `:slow => true` is stored in the Metadata owned by the example. These can
+    # then be used to select which examples are run using the `--tag` option on
+    # the command line, or several methods on `Configuration` used to filter a
+    # run (e.g. `filter_run_including`, `filter_run_excluding`, etc).
+    #
+    # @see Example#metadata
+    # @see ExampleGroup.metadata
+    # @see FilterManager
+    # @see Configuration#filter_run_including
+    # @see Configuration#filter_run_excluding
+    class Metadata < Hash
+
+      def self.relative_path(line)
+        line = line.sub(File.expand_path("."), ".")
+        line = line.sub(/\A([^:]+:\d+)$/, '\\1')
+        return nil if line == '-e:1'
+        line
+      rescue SecurityError
+        nil
+      end
+
+      # @private
+      # Used internally to build a hash from an args array.
+      # Symbols are converted into hash keys with a value of `true`.
+      # This is done to support simple tagging using a symbol, rather
+      # than needing to do `:symbol => true`.
+      def self.build_hash_from(args)
+        hash = args.last.is_a?(Hash) ? args.pop : {}
+
+        while args.last.is_a?(Symbol)
+          hash[args.pop] = true
+        end
+
+        hash
+      end
+
+      module MetadataHash
+
+        # @private
+        # Supports lazy evaluation of some values. Extended by
+        # ExampleMetadataHash and GroupMetadataHash, which get mixed in to
+        # Metadata for ExampleGroups and Examples (respectively).
+        def [](key)
+          store_computed(key) unless has_key?(key)
+          super
+        end
+
+        def fetch(key, *args)
+          store_computed(key) unless has_key?(key)
+          super
+        end
+
+        private
+
+        def store_computed(key)
+          case key
+          when :location
+            store(:location, location)
+          when :file_path, :line_number
+            file_path, line_number = file_and_line_number
+            store(:file_path, file_path)
+            store(:line_number, line_number)
+          when :execution_result
+            store(:execution_result, {})
+          when :describes, :described_class
+            klass = described_class
+            store(:described_class, klass)
+            # TODO (2011-11-07 DC) deprecate :describes as a key
+            store(:describes, klass)
+          when :full_description
+            store(:full_description, full_description)
+          when :description
+            store(:description, build_description_from(*self[:description_args]))
+          when :description_args
+            store(:description_args, [])
+          end
+        end
+
+        def location
+          "#{self[:file_path]}:#{self[:line_number]}"
+        end
+
+        def file_and_line_number
+          first_caller_from_outside_rspec =~ /(.+?):(\d+)(|:\d+)/
+          return [Metadata::relative_path($1), $2.to_i]
+        end
+
+        def first_caller_from_outside_rspec
+          self[:caller].detect {|l| l !~ /\/lib\/rspec\/core/}
+        end
+
+        def method_description_after_module?(parent_part, child_part)
+          return false unless parent_part.is_a?(Module)
+          child_part =~ /^(#|::|\.)/
+        end
+
+        def build_description_from(first_part = '', *parts)
+          description, _ = parts.inject([first_part.to_s, first_part]) do |(desc, last_part), this_part|
+            this_part = this_part.to_s
+            this_part = (' ' + this_part) unless method_description_after_module?(last_part, this_part)
+            [(desc + this_part), this_part]
+          end
+
+          description
+        end
+      end
+
+      # Mixed in to Metadata for an Example (extends MetadataHash) to support
+      # lazy evaluation of some values.
+      module ExampleMetadataHash
+        include MetadataHash
+
+        def described_class
+          self[:example_group].described_class
+        end
+
+        def full_description
+          build_description_from(self[:example_group][:full_description], *self[:description_args])
+        end
+      end
+
+      # Mixed in to Metadata for an ExampleGroup (extends MetadataHash) to
+      # support lazy evaluation of some values.
+      module GroupMetadataHash
+        include MetadataHash
+
+        def described_class
+          container_stack.each do |g|
+            [:described_class, :describes].each do |key|
+              if g.has_key?(key)
+                value = g[key]
+                return value unless value.nil?
+              end
+            end
+          end
+
+          container_stack.reverse.each do |g|
+            candidate = g[:description_args].first
+            return candidate unless String === candidate || Symbol === candidate
+          end
+
+          nil
+        end
+
+        def full_description
+          build_description_from(*FlatMap.flat_map(container_stack.reverse) {|a| a[:description_args]})
+        end
+
+        def container_stack
+          @container_stack ||= begin
+                                 groups = [group = self]
+                                 while group.has_key?(:example_group)
+                                   groups << group[:example_group]
+                                   group = group[:example_group]
+                                 end
+                                 groups
+                               end
+        end
+      end
+
+      def initialize(parent_group_metadata=nil)
+        if parent_group_metadata
+          update(parent_group_metadata)
+          store(:example_group, {:example_group => parent_group_metadata[:example_group].extend(GroupMetadataHash)}.extend(GroupMetadataHash))
+        else
+          store(:example_group, {}.extend(GroupMetadataHash))
+        end
+
+        yield self if block_given?
+      end
+
+      # @private
+      def process(*args)
+        user_metadata = args.last.is_a?(Hash) ? args.pop : {}
+        ensure_valid_keys(user_metadata)
+
+        self[:example_group].store(:description_args, args)
+        self[:example_group].store(:caller, user_metadata.delete(:caller) || caller)
+
+        update(user_metadata)
+      end
+
+      # @private
+      def for_example(description, user_metadata)
+        dup.extend(ExampleMetadataHash).configure_for_example(description, user_metadata)
+      end
+
+      # @private
+      def any_apply?(filters)
+        filters.any? {|k,v| filter_applies?(k,v)}
+      end
+
+      # @private
+      def all_apply?(filters)
+        filters.all? {|k,v| filter_applies?(k,v)}
+      end
+
+      # @private
+      def filter_applies?(key, value, metadata=self)
+        return metadata.filter_applies_to_any_value?(key, value) if Array === metadata[key] && !(Proc === value)
+        return metadata.line_number_filter_applies?(value)       if key == :line_numbers
+        return metadata.location_filter_applies?(value)          if key == :locations
+        return metadata.filters_apply?(key, value)               if Hash === value
+
+        return false unless metadata.has_key?(key)
+
+        case value
+        when Regexp
+          metadata[key] =~ value
+        when Proc
+          case value.arity
+          when 0 then value.call
+          when 2 then value.call(metadata[key], metadata)
+          else value.call(metadata[key])
+          end
+        else
+          metadata[key].to_s == value.to_s
+        end
+      end
+
+      # @private
+      def filters_apply?(key, value)
+        value.all? {|k, v| filter_applies?(k, v, self[key])}
+      end
+
+      # @private
+      def filter_applies_to_any_value?(key, value)
+        self[key].any? {|v| filter_applies?(key, v, {key => value})}
+      end
+
+      # @private
+      def location_filter_applies?(locations)
+        # it ignores location filters for other files
+        line_number = example_group_declaration_line(locations)
+        line_number ? line_number_filter_applies?(line_number) : true
+      end
+
+      # @private
+      def line_number_filter_applies?(line_numbers)
+        preceding_declaration_lines = line_numbers.map {|n| RSpec.world.preceding_declaration_line(n)}
+        !(relevant_line_numbers & preceding_declaration_lines).empty?
+      end
+
+      protected
+
+      def configure_for_example(description, user_metadata)
+        store(:description_args, [description]) if description
+        store(:caller, user_metadata.delete(:caller) || caller)
+        update(user_metadata)
+      end
+
+      private
+
+      RESERVED_KEYS = [
+        :description,
+        :example_group,
+        :execution_result,
+        :file_path,
+        :full_description,
+        :line_number,
+        :location
+      ]
+
+      def ensure_valid_keys(user_metadata)
+        RESERVED_KEYS.each do |key|
+          if user_metadata.has_key?(key)
+            raise <<-EOM
+            #{"*"*50}
+:#{key} is not allowed
+
+RSpec reserves some hash keys for its own internal use,
+including :#{key}, which is used on:
+
+            #{CallerFilter.first_non_rspec_line}.
+
+Here are all of RSpec's reserved hash keys:
+
+            #{RESERVED_KEYS.join("\n  ")}
+            #{"*"*50}
+            EOM
+          end
+        end
+      end
+
+      def example_group_declaration_line(locations)
+        locations[File.expand_path(self[:example_group][:file_path])] if self[:example_group]
+      end
+
+      # TODO - make this a method on metadata - the problem is
+      # metadata[:example_group] is not always a kind of GroupMetadataHash.
+      def relevant_line_numbers(metadata=self)
+        [metadata[:line_number]] + (metadata[:example_group] ? relevant_line_numbers(metadata[:example_group]) : [])
+      end
+
+    end
+  end
+end

data/vendor_lib/rspec/core/mocking/with_absolutely_nothing.rb

@@ -0,0 +1,11 @@
+module RSpec
+  module Core
+    module MockFrameworkAdapter
+
+      def setup_mocks_for_rspec; end
+      def verify_mocks_for_rspec; end
+      def teardown_mocks_for_rspec; end
+
+    end
+  end
+end

data/vendor_lib/rspec/core/mocking/with_flexmock.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+#
+#  Created by Jim Weirich on 2007-04-10.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'flexmock/rspec'
+
+module RSpec
+  module Core
+    module MockFrameworkAdapter
+
+      def self.framework_name; :flexmock end
+
+      include FlexMock::MockContainer
+      def setup_mocks_for_rspec
+        # No setup required
+      end
+      def verify_mocks_for_rspec
+        flexmock_verify
+      end
+      def teardown_mocks_for_rspec
+        flexmock_close
+      end
+
+    end
+  end
+end

data/vendor_lib/rspec/core/mocking/with_mocha.rb

@@ -0,0 +1,52 @@
+# In order to support all versions of mocha, we have to jump through some
+# hoops here.
+#
+# mocha >= '0.13.0':
+#   require 'mocha/api' is required
+#   require 'mocha/object' raises a LoadError b/c the file no longer exists
+# mocha < '0.13.0', >= '0.9.7'
+#   require 'mocha/api' is required
+#   require 'mocha/object' is required
+# mocha < '0.9.7':
+#   require 'mocha/api' raises a LoadError b/c the file does not yet exist
+#   require 'mocha/standalone' is required
+#   require 'mocha/object' is required
+begin
+  require 'mocha/api'
+
+  begin
+    require 'mocha/object'
+  rescue LoadError
+    # Mocha >= 0.13.0 no longer contains this file nor needs it to be loaded
+  end
+rescue LoadError
+  require 'mocha/standalone'
+  require 'mocha/object'
+end
+
+module RSpec
+  module Core
+    module MockFrameworkAdapter
+      def self.framework_name; :mocha end
+
+      # Mocha::Standalone was deprecated as of Mocha 0.9.7.
+      begin
+        include Mocha::API
+      rescue NameError
+        include Mocha::Standalone
+      end
+
+      def setup_mocks_for_rspec
+        mocha_setup
+      end
+
+      def verify_mocks_for_rspec
+        mocha_verify
+      end
+
+      def teardown_mocks_for_rspec
+        mocha_teardown
+      end
+    end
+  end
+end

data/vendor_lib/rspec/core/mocking/with_rr.rb

@@ -0,0 +1,27 @@
+require 'rr'
+
+RSpec.configuration.backtrace_exclusion_patterns.push(RR::Errors::BACKTRACE_IDENTIFIER)
+
+module RSpec
+  module Core
+    module MockFrameworkAdapter
+
+      def self.framework_name; :rr end
+
+      include RR::Extensions::InstanceMethods
+
+      def setup_mocks_for_rspec
+        RR::Space.instance.reset
+      end
+
+      def verify_mocks_for_rspec
+        RR::Space.instance.verify_doubles
+      end
+
+      def teardown_mocks_for_rspec
+        RR::Space.instance.reset
+      end
+
+    end
+  end
+end

data/vendor_lib/rspec/core/mocking/with_rspec.rb

@@ -0,0 +1,27 @@
+require 'rspec/mocks'
+
+module RSpec
+  module Core
+    module MockFrameworkAdapter
+
+      def self.framework_name; :rspec end
+
+      def self.configuration
+        RSpec::Mocks.configuration
+      end
+
+      def setup_mocks_for_rspec
+        RSpec::Mocks::setup(self)
+      end
+
+      def verify_mocks_for_rspec
+        RSpec::Mocks::verify
+      end
+
+      def teardown_mocks_for_rspec
+        RSpec::Mocks::teardown
+      end
+
+    end
+  end
+end

data/vendor_lib/rspec/core/option_parser.rb

@@ -0,0 +1,234 @@
+# http://www.ruby-doc.org/stdlib/libdoc/optparse/rdoc/classes/OptionParser.html
+require 'optparse'
+
+module RSpec::Core
+  class Parser
+    def self.parse!(args)
+      new.parse!(args)
+    end
+
+    class << self
+      alias_method :parse, :parse!
+    end
+
+    def parse!(args)
+      return {} if args.empty?
+
+      convert_deprecated_args(args)
+
+      options = args.delete('--tty') ? {:tty => true} : {}
+      begin
+        parser(options).parse!(args)
+      rescue OptionParser::InvalidOption => e
+        abort "#{e.message}\n\nPlease use --help for a listing of valid options"
+      end
+
+      options
+    end
+
+    def convert_deprecated_args(args)
+      args.map! { |arg|
+        case arg
+        when "--formatter"
+          RSpec.deprecate("the --formatter option", :replacement => "-f or --format")
+          "--format"
+        when "--default_path"
+          "--default-path"
+        when "--line_number"
+          "--line-number"
+        else
+          arg
+        end
+      }
+    end
+
+    alias_method :parse, :parse!
+
+    def parser(options)
+      OptionParser.new do |parser|
+        parser.banner = "Usage: rspec [options] [files or directories]\n\n"
+
+        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|
+          options[:requires] ||= []
+          options[:requires] << path
+        end
+
+        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[:SEED]', 'Run examples by the specified order type.',
+                  '  [defined] examples and groups are run in the order they are defined',
+                  '  [rand]    randomize the order of groups and examples',
+                  '  [random]  alias for rand',
+                  '  [random:SEED] e.g. --order random:123') do |o|
+          options[:order] = o
+        end
+
+        parser.on('--seed SEED', Integer, 'Equivalent of --order rand:SEED.') do |seed|
+          options[:order] = "rand:#{seed}"
+        end
+
+        parser.on('--fail-fast', 'Abort the run on first failure.') do |o|
+          options[:fail_fast] = true
+        end
+
+        parser.on('--no-fail-fast', 'Do not abort the run on first failure.') do |o|
+          options[:fail_fast] = false
+        end
+
+        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('--dry-run', 'Print the formatter output of your suite without',
+                  '  running any examples or hooks') do |o|
+          options[:dry_run] = true
+        end
+
+        parser.on('-X', '--[no-]drb', 'Run examples via DRb.') do |o|
+          options[:drb] = o
+        end
+
+        parser.on('--drb-port PORT', 'Port to connect to the DRb server.') do |o|
+          options[:drb_port] = o.to_i
+        end
+
+        parser.on('--init', 'Initialize your project with RSpec.') do |cmd|
+          require 'rspec/core/project_initializer'
+          ProjectInitializer.new(cmd).run
+          exit
+        end
+
+        parser.on('--configure', 'Deprecated. Use --init instead.') do |cmd|
+          RSpec.warning "--configure is deprecated with no effect. Use --init instead.", :call_site => nil
+          exit
+        end
+
+        parser.separator("\n  **** Output ****\n\n")
+
+        parser.on('-f', '--format FORMATTER', 'Choose a formatter.',
+                '  [p]rogress (default - dots)',
+                '  [d]ocumentation (group and example names)',
+                '  [h]tml',
+                '  [j]son',
+                '  custom formatter class name') do |o|
+          options[:formatters] ||= []
+          options[:formatters] << [o]
+        end
+
+        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.'
+                 ) do |o|
+          options[:formatters] ||= [['progress']]
+          options[:formatters].last << o
+        end
+
+        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|
+          options[:color] = o
+        end
+
+        parser.on('-p', '--[no-]profile [COUNT]', 'Enable profiling of examples and list the slowest examples (default: 10).') do |argument|
+          options[:profile_examples] = if argument.nil?
+                                         true
+                                       elsif argument == false
+                                         false
+                                       else
+                                         begin
+                                           Integer(argument)
+                                         rescue ArgumentError
+                                           RSpec.warning "Non integer specified as profile count, seperate " +
+                                                       "your path from options with -- e.g. " +
+                                                       "`rspec --profile -- #{argument}`",
+                                                       :call_site => nil
+                                           true
+                                         end
+                                       end
+        end
+
+        parser.on('-w', '--warnings', 'Enable ruby warnings') do
+          options[:warnings] = true
+        end
+
+        parser.separator <<-FILTERING
+
+  **** 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
+    the filename:
+
+      rspec path/to/a_spec.rb:37
+
+FILTERING
+
+        parser.on('-P', '--pattern PATTERN', 'Load files matching pattern (default: "spec/**/*_spec.rb").') do |o|
+          options[:pattern] = o
+        end
+
+        parser.on('-e', '--example STRING', "Run examples whose full nested names include STRING (may be",
+                                            "  used more than once)") do |o|
+          (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',
+                                              '  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 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(':',2)
+          name = name.to_sym
+
+          options[filter_type] ||= {}
+          options[filter_type][name] = case value
+                                         when  nil        then true # The default value for tags is true
+                                         when 'true'      then true
+                                         when 'false'     then false
+                                         when 'nil'       then nil
+                                         when /^:/        then value[1..-1].to_sym
+                                         when /^\d+$/     then Integer(value)
+                                         when /^\d+.\d+$/ then Float(value)
+                                       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[:default_path] = path
+        end
+
+        parser.separator("\n  **** Utility ****\n\n")
+
+        parser.on('-v', '--version', 'Display the version.') do
+          puts RSpec::Core::Version::STRING
+          exit
+        end
+
+        parser.on_tail('-h', '--help', "You're looking at it.") do
+          puts parser
+          exit
+        end
+
+      end
+    end
+  end
+end