opal-rspec 0.5.0.beta2 → 0.5.0.beta3

data/spec/rspec/core/filter/core/bugs/warnings_deprecations.txt

@@ -0,0 +1,3 @@
+# https://github.com/opal/opal/issues/568 - long standing issue that hasn't been fixed
+rspec warnings and deprecations #warn_with when :use_spec_location_as_call_site => true is passed adds the source location of spec
+rspec warnings and deprecations #warn_with when :use_spec_location_as_call_site => true is passed appends a period to the supplied message if one is not present

data/spec/rspec/core/filter/core/unsupported/core.txt

@@ -0,0 +1,5 @@
+# Launches a new Ruby process
+RSpec loads mocks and expectations when the constants are referenced
+
+# Can't do file paths in Opal
+RSpec::Core.path_to_executable.*

data/spec/rspec/core/filter/core/unsupported/example.txt

@@ -0,0 +1,7 @@
+# location/line number
+RSpec::Core::Example when there is no explicit description.*using the block
+RSpec::Core::Example when there is no explicit description.*uses the file and line number.*
+RSpec::Core::Example#pending in the example sets the backtrace to the example definition so it can be located by the user
+
+# set_backtrace not supported on Opal
+RSpec::Core::Example#run when the example raises an error leaves a raised exception unmodified.*

data/spec/rspec/core/filter/core/unsupported/example_group.txt

@@ -0,0 +1,13 @@
+# There is a carve out for Rubinius, but not for Opal, see opal alternates
+RSpec::Core::ExampleGroup constant naming disambiguates name collisions by appending a number
+
+# location, file path, line number
+RSpec::Core::ExampleGroup ordering when tagged with an unrecognized ordering prints a warning so users are notified of their mistake
+
+# File path, line number
+RSpec::Core::ExampleGroup#metadata adds the the file_path to metadata
+RSpec::Core::ExampleGroup#metadata has a reader for file_path
+RSpec::Core::ExampleGroup#metadata adds the line_number to metadata
+
+# Back trace, line number
+RSpec::Core::ExampleGroup.pending sets the backtrace to the example definition so it can be located by the user

data/spec/rspec/core/filter/core/unsupported/filter_manager.txt

@@ -0,0 +1,7 @@
+# location, file path, line number
+
+RSpec::Core::FilterManager#prune prefers location to exclusion filter.*
+
+# File I/O
+RSpec::Core::FilterManager#exclusions#description cleans up the description
+RSpec::Core::FilterManager#inclusions#description cleans up the description

data/spec/rspec/core/filter/core/unsupported/formatters.txt

@@ -0,0 +1,27 @@
+# Spec uses File I/O and opal-rspec customizes the IO class anyways (see NoCarriageReturnIO)
+RSpec::Core::Formatters::BaseTextFormatter when closing the formatter does not close an already closed output stream
+
+# Will trigger File I/O
+RSpec::Core::Formatters::DeprecationFormatter.* with a File deprecation_stream.*
+RSpec::Core::Formatters::Loader#add\(formatter\) when a duplicate formatter exists adds the formatter for different output targets
+RSpec::Core::Formatters::Loader#add\(formatter\) with a 2nd arg defining the output accepts Pathname objects for file paths
+RSpec::Core::Formatters::Loader#add\(formatter\) with a 2nd arg defining the output creates a file at that path and sets it as the output
+
+# Profiling within JSON formatter not supported either (profiling and Opal do not work yet)
+RSpec::Core::Formatters::JsonFormatter#dump_profile.*
+
+# location, file path, line number
+RSpec::Core::Formatters::BaseTextFormatter#dump_failures for #shared_examples outputs the name and location
+RSpec::Core::Formatters::BaseTextFormatter#dump_failures for #shared_examples that contains nested example groups outputs the name and location
+
+# backtrace, line_number related
+RSpec::Core::Formatters::BaseTextFormatter#dump_failures.*does not show the error class
+RSpec::Core::Formatters::BaseTextFormatter#dump_summary includes command to re-run each failed example
+RSpec::Core::Formatters::JsonFormatter outputs json \(brittle high level functional test\)
+
+# Encoding related
+RSpec::Core::Formatters::BaseTextFormatter#dump_failures with an exception that has a differently encoded message.*
+
+# option parser
+RSpec::Core::Formatters::DocumentationFormatter produces the expected full output
+RSpec::Core::Formatters::ProgressFormatter produces the expected full output

data/spec/rspec/core/filter/core/unsupported/hooks.txt

@@ -0,0 +1,2 @@
+# line number / back trace
+RSpec::Core::Hooks#around when it does not run the example indicates which around hook did not run the example in the pending message

data/spec/rspec/core/filter/core/unsupported/memoized_helpers.txt

@@ -0,0 +1,6 @@
+# Expected errors have line numbers in them, which is not supported on Opal right now
+.let raises an error when referenced from.*
+RSpec::Core::MemoizedHelpers.*raises an error when referenced from.*
+
+# No private methods in Opal
+Module#define_method is still a private method

data/spec/rspec/core/filter/core/unsupported/metadata.txt

@@ -0,0 +1,14 @@
+# Uses I/O
+RSpec::Core::Metadata :file_path.*
+
+# location, file path, line number
+RSpec::Core::Metadata for an example extracts .* caller
+RSpec::Core::Metadata backwards compatibility :example_group can access the parent example group attributes via.*
+RSpec::Core::Metadata backwards compatibility :example_group can still access the example group attributes via.*
+RSpec::Core::Metadata backwards compatibility :example_group can still be filtered via a nested key under.*
+
+# We can't figure this out in JS yet
+RSpec::Core::Metadata :line_number.*
+
+# symbols are strings in opal, so they won't be picked up as described classes
+RSpec::Core::Metadata :described_class in an outer group with a Symbol returns the symbol

data/spec/rspec/core/filter/core/unsupported/metadata_filter.txt

@@ -0,0 +1,2 @@
+# Opal doesn't do checking to see if args match arity
+RSpec::Core::MetadataFilter.filter_applies\? raises an error when the proc has an incorrect arity

data/spec/rspec/core/filter/core/unsupported/notifications.txt

@@ -0,0 +1,8 @@
+# Uses #{__FILE__}:#{__LINE__} and backtrace
+FailedExampleNotification #message_lines.*
+
+# Uses File IO to find the failed line
+FailedExampleNotification #read_failed_line.*
+
+# Need special Javascript console code work, so have an alternate spec for this
+RSpec::Core::Notifications::FailedExampleNotification uses the default color for the shared example backtrace line

data/spec/rspec/core/filter/core/unsupported/world.txt

@@ -0,0 +1,3 @@
+# line numbers
+RSpec::Core::World#preceding_declaration_line \(again\) with one example returns line number of an example that immediately precedes the argument line
+RSpec::Core::World#preceding_declaration_line \(again\) with one example returns the argument line number if an example starts on that line

data/spec/rspec/core/fixes/missing_constants.rb

@@ -0,0 +1,20 @@
+class ::Dir
+  def self.[](index)
+    []
+  end
+end
+
+module Aruba
+  module Api
+  end
+end
+
+# None of this is supported in Opal
+module RSpec::Support::ShellOut
+end
+
+module MathnIntegrationSupport
+  def with_mathn_loaded
+    yield
+  end
+end

data/spec/rspec/core/fixes/opal_itself.rb

@@ -0,0 +1,38 @@
+# RSpec::Core::ExampleGroup setting pending metadata in parent marks every example as pending
+# This opal-rspec test failure is happening because 'fail' in opal does not behave correctly
+# https://github.com/opal/opal/pull/1117, status pending
+unless Opal::RSpec::Compatibility.fail_raise_matches_mri?
+  module Kernel
+    def fail(message=nil)
+      if message
+        raise message
+      else
+        raise RuntimeError.new
+      end
+    end
+  end
+end
+
+# https://github.com/opal/opal/issues/1110, fixed in Opal 0.9
+unless Opal::RSpec::Compatibility.class_within_class_new_works?
+  class ::RSpec::Core::HooksHost
+    include Hooks
+
+    def parent_groups
+      []
+    end
+  end
+end
+
+# Fixed in Opal 0.9
+# https://github.com/opal/opal/commit/a6ec3164fcbb0f98ef46d385ea06bf0591828f23)
+unless Object.const_defined? :ZeroDivisionError
+  class ZeroDivisionError < StandardError
+  end
+end
+
+# https://github.com/opal/opal/commit/5a17a12de1d3af45e189d34994a047fb7c1b4c72
+unless Object.const_defined? :SecurityError
+  class SecurityError < Exception
+  end
+end

data/spec/rspec/core/fixes/shared_examples.rb

@@ -0,0 +1,3 @@
+# shell/file dependent
+RSpec.shared_examples_for "a library that issues no warnings when loaded" do |lib, *preamble_stmnts|
+end

data/spec/rspec/core/opal_alternates/rspec/core/example_group_spec.rb

@@ -0,0 +1,145 @@
+# encoding: utf-8
+require 'spec_helper'
+
+module RSpec::Core
+  RSpec.describe 'Opal ExampleGroup' do
+    describe "constant naming" do
+      around do |ex|
+        before_constants = RSpec::ExampleGroups.constants
+        ex.run
+        after_constants = RSpec::ExampleGroups.constants
+
+        (after_constants - before_constants).each do |name|
+          RSpec::ExampleGroups.send(:remove_const, name)
+        end
+      end
+
+      it 'disambiguates name collisions by appending a number', :unless => RUBY_VERSION == '1.9.2' do
+        groups = 10.times.map { ExampleGroup.describe("Collision") }
+        expect(groups[0]).to have_class_const("Collision")
+        expect(groups[1]).to have_class_const("Collision_2")
+        expect(groups[8]).to have_class_const("Collision_9")
+
+        if RUBY_VERSION.to_f > 1.8 && !(defined?(RUBY_ENGINE) && ['rbx', 'opal'].include?(RUBY_ENGINE))
+          # on 1.8.7, rbx "Collision_9".next => "Collisioo_0"
+          expect(groups[9]).to have_class_const("Collision_10")
+        end
+      end
+    end
+
+    describe "#before, after, and around hooks" do
+      it "treats an error in before(:each) as a failure" do
+        group = ExampleGroup.describe
+        group.before(:each) { raise "error in before each" }
+        example = group.example("equality") { expect(1).to eq(2) }
+        #expect(group.run).to be(false)
+        expect(group.run).to be_a Promise
+        expect(group.run.value).to be_falsey
+
+        expect(example.execution_result.exception.message).to eq("error in before each")
+      end
+
+      it "treats an error in before(:all) as a failure" do
+        group = ExampleGroup.describe
+        group.before(:all) { raise "error in before all" }
+        example = group.example("equality") { expect(1).to eq(2) }
+        #expect(group.run).to be_falsey
+        expect(group.run).to be_a Promise
+        expect(group.run.value).to be_falsey
+
+        expect(example.metadata).not_to be_nil
+        expect(example.execution_result.exception).not_to be_nil
+        expect(example.execution_result.exception.message).to eq("error in before all")
+      end
+    end
+
+    describe "#run_examples" do
+      let(:reporter) { double("reporter").as_null_object }
+
+      it "returns false if any of the examples fail" do
+        group = ExampleGroup.describe('group') do
+          example('ex 1') { expect(1).to eq(1) }
+          example('ex 2') { expect(1).to eq(2) }
+        end
+        allow(group).to receive(:filtered_examples) { group.examples }
+        # expect(group.run(reporter)).to be_falsey
+        # Promise
+        result = group.run(reporter)
+        expect(group.run(reporter).value).to be_falsey
+      end
+
+      it "runs all examples, regardless of any of them failing" do
+        group = ExampleGroup.describe('group') do
+          example('ex 1') { expect(1).to eq(2) }
+          example('ex 2') { expect(1).to eq(1) }
+        end
+        allow(group).to receive(:filtered_examples) { group.examples }
+        group.filtered_examples.each do |example|
+          expect(example).to receive(:run)
+        end
+        # expect(group.run(reporter)).to be_falsey
+        # Promise
+        expect(group.run(reporter).value).to be_falsey
+      end
+    end
+
+    describe "#run" do
+      let(:reporter) { double("reporter").as_null_object }
+
+      context "with fail_fast? => true" do
+        let(:group) do
+          group = RSpec::Core::ExampleGroup.describe
+          allow(group).to receive(:fail_fast?) { true }
+          group
+        end
+
+        it "sets RSpec.world.wants_to_quit flag if encountering an exception in before(:all)" do
+          group.before(:all) { raise "error in before all" }
+          group.example("equality") { expect(1).to eq(2) }
+          # This method returns a promise in Opal
+          #expect(group.run).to be_falsey
+          expect(group.run.value).to be_falsey
+          expect(RSpec.world.wants_to_quit).to be_truthy
+        end
+      end
+
+      context "with top level example failing" do
+        it "returns false" do
+          group = RSpec::Core::ExampleGroup.describe("something") do
+            it "does something (wrong - fail)" do
+              raise "fail"
+            end
+            describe "nested" do
+              it "does something else" do
+                # pass
+              end
+            end
+          end
+
+          #expect(group.run(reporter)).to be_falsey
+          # Promise
+          expect(group.run(reporter).value).to be_falsey
+        end
+      end
+
+      context "with nested example failing" do
+        it "returns true" do
+          group = RSpec::Core::ExampleGroup.describe("something") do
+            it "does something" do
+              # pass
+            end
+            describe "nested" do
+              it "does something else (wrong -fail)" do
+                raise "fail"
+              end
+            end
+          end
+
+          #expect(group.run(reporter)).to be_falsey
+          # Promise
+          expect(group.run(reporter).value).to be_falsey
+        end
+      end
+    end
+  end
+end

data/spec/rspec/core/opal_alternates/rspec/core/failed_example_notification_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+module RSpec::Core::Notifications
+  describe 'Opal FailedExampleNotification' do
+    before do
+      allow(RSpec.configuration).to receive(:color_enabled?).and_return(true)
+    end
+
+    it "uses the default color for the shared example backtrace line" do
+      example = nil
+      group = RSpec::Core::ExampleGroup.describe "testing" do
+        shared_examples_for "a" do
+          example = it "fails" do
+            expect(1).to eq(2)
+          end
+        end
+        it_behaves_like "a"
+      end
+      group.run
+      fne = FailedExampleNotification.new(example)
+      lines = fne.colorized_message_lines
+      #expect(lines).to include(match("\\e\\[37mShared Example Group:"))
+      # Javascript console code
+      matcher = /.*Shared Example Group.*/
+      line = lines.find { |l| matcher.match l }
+      escape = "\033"
+      # Have to string concat this for it to work properly
+      expect(line).to eq(escape +"[31m" + escape+"[37mShared Example Group: \"a\" called from "+escape+"[0m"+escape+"[0m")
+    end
+  end
+end

data/spec/rspec/core/opal_alternates/rspec/core/hooks_spec.rb

@@ -0,0 +1,113 @@
+require "spec_helper"
+
+module RSpec::Core
+  RSpec.describe 'Opal RSpec::Core::Hooks' do
+    context "when an error happens in `after(:suite)`" do
+      it 'allows the error to propagate to the user' do
+        RSpec.configuration.after(:suite) { 1 / 0 }
+
+        # expect {
+        #   RSpec.configuration.hooks.run(:after, :suite, SuiteHookContext.new)
+        # }.to raise_error(ZeroDivisionError)
+        # hooks returns a promise, have to wait for that
+        RSpec.configuration.hooks.run(:after, :suite, SuiteHookContext.new).then do
+          raise 'Expected ZeroDivisionError but got none'
+        end.rescue do |ex|
+          expect(ex).to be_a? ZeroDivisionError
+        end
+      end
+    end
+
+    context "when an error happens in `before(:suite)`" do
+      it 'allows the error to propagate to the user' do
+        RSpec.configuration.before(:suite) { 1 / 0 }
+
+        # expect {
+        #   RSpec.configuration.hooks.run(:before, :suite, SuiteHookContext.new)
+        # }.to raise_error(ZeroDivisionError)
+        # hooks return a promise
+        RSpec.configuration.hooks.run(:before, :suite, SuiteHookContext.new).then do
+          raise 'Expected ZeroDivisionError but got none'
+        end.rescue do |ex|
+          expect(ex).to be_a? ZeroDivisionError
+        end
+      end
+    end
+
+    describe '#around' do
+      context 'when it does not run the example' do
+        context 'for a hook declared in the group' do
+          it 'converts the example to a skipped example so the user is made aware of it' do
+            ex = nil
+            group = RSpec.describe do
+              around {}
+              ex = example("not run") {}
+            end
+
+            # promise
+            # group.run
+            # expect(ex.execution_result.status).to eq(:pending)
+            group.run.then do
+              expect(ex.execution_result.status).to eq(:pending)
+            end
+          end
+        end
+
+        context 'for a hook declared in config' do
+          it 'converts the example to a skipped example so the user is made aware of it' do
+            RSpec.configuration.around {}
+
+            ex = nil
+            group = RSpec.describe do
+              ex = example("not run") {}
+            end
+
+            # promise
+            # group.run
+            # expect(ex.execution_result.status).to eq(:pending)
+            group.run.then do
+              expect(ex.execution_result.status).to eq(:pending)
+            end
+          end
+        end
+      end
+
+      it 'considers the hook to have run when passed as a block to a method that yields' do
+        ex = nil
+        group = RSpec.describe do
+          def transactionally
+            yield
+          end
+
+          around { |e| transactionally(&e) }
+          ex = example("run") {}
+        end
+
+        # promise
+        # group.run
+        # expect(ex.execution_result.status).to eq(:passed)
+        group.run.then do
+          expect(ex.execution_result.status).to eq(:passed)
+        end
+      end
+
+      it 'does not consider the hook to have run when passed as a block to a method that does not yield' do
+        ex = nil
+        group = RSpec.describe do
+          def transactionally;
+          end
+
+          around { |e| transactionally(&e) }
+          ex = example("not run") {}
+        end
+
+        # promise
+        # group.run
+        # expect(ex.execution_result.status).to eq(:pending)
+        group.run.then do
+          expect(ex.execution_result.status).to eq(:pending)
+        end
+      end
+    end
+  end
+end