opal-connect-rspec 0.5.0

data/lib/opal/rspec/sprockets_environment.rb

@@ -0,0 +1,37 @@
+require 'sprockets'
+require 'pathname'
+require 'opal/rspec/cached_environment'
+require 'opal/rspec/pre_rack_locator'
+require 'forwardable'
+
+module Opal
+  module RSpec
+    class SprocketsEnvironment < ::Sprockets::Environment
+      extend Forwardable
+      # this class accessible from config.ru and the rask task initializer
+
+      def_delegators :@locator,
+                     :spec_pattern=,
+                     :spec_pattern,
+                     :spec_exclude_pattern=,
+                     :spec_exclude_pattern,
+                     :spec_files=,
+                     :spec_files,
+                     :default_path=,
+                     :default_path
+
+      def initialize(spec_pattern=nil, spec_exclude_pattern=nil, spec_files=nil, default_path=nil)
+        @locator = RSpec::PreRackLocator.new spec_pattern, spec_exclude_pattern, spec_files, default_path
+        super()
+      end
+
+      def add_spec_paths_to_sprockets
+        @locator.get_spec_load_paths.each { |p| append_path p }
+      end
+
+      def cached
+        CachedEnvironment.new(self, @locator)
+      end
+    end
+  end
+end

data/lib/opal/rspec/version.rb

@@ -0,0 +1,5 @@
+module Opal
+  module RSpec
+    VERSION = '0.5.0'
+  end
+end

data/opal-rspec.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require 'rake'
+require File.expand_path('../lib/opal/rspec/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'opal-connect-rspec'
+  s.version = Opal::RSpec::VERSION
+  s.author = 'Adam Beynon'
+  s.email = 'adam.beynon@gmail.com'
+  s.homepage = 'http://opalrb.org'
+  s.summary = 'RSpec for Opal'
+  s.description = 'Opal compatible rspec library'
+
+  s.files = `git ls-files`.split("\n") + FileList['rspec*/**/*.rb']
+
+  s.require_paths = ['lib']
+
+  s.add_dependency 'opal', ['>= 0.8.0', '< 0.11']
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'yard'
+end

data/opal/opal-rspec.rb

@@ -0,0 +1 @@
+require 'opal/rspec'

data/opal/opal/rspec.rb

@@ -0,0 +1,23 @@
+require 'opal/rspec/pre_require_fixes'
+require 'opal/rspec/requires'
+require 'opal/rspec/fixes'
+require 'opal/rspec/formatter/browser_formatter'
+require 'opal/rspec/runner'
+require 'opal/rspec/async'
+
+RSpec.configure do |config|
+  config.default_formatter = ::RSpec::Core::Runner.non_browser? ? ::RSpec::Core::Formatters::ProgressFormatter : ::Opal::RSpec::BrowserFormatter
+
+  # Have to do this in 2 places. This will ensure the default formatter gets the right IO, but need to do this here for custom formatters
+  # that will be constructed BEFORE Runner.autorun runs (see runner.rb)
+  _, stdout = ::RSpec::Core::Runner.get_opal_closed_tty_io
+  config.output_stream = stdout
+
+  # This shouldn't be in here, but RSPec uses undef to change this configuration and that doesn't work well enough yet
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+
+  # Legacy helpers
+  config.include Opal::RSpec::AsyncHelpers
+end

data/opal/opal/rspec/async.rb

@@ -0,0 +1,5 @@
+require 'opal/rspec/async/async_example'
+require 'opal/rspec/async/example_group'
+require 'opal/rspec/async/hooks'
+require 'opal/rspec/async/legacy'
+require 'opal/rspec/async/reporter'

data/opal/opal/rspec/async/async_example.rb

@@ -0,0 +1,96 @@
+class ::RSpec::Core::Example
+  def core_block_run
+    example_promise = Promise.value(@example_group_instance.instance_exec(self, &@example_block))
+    example_promise.then do |result|
+      result
+    end.rescue do |ex|
+      ex ||= Exception.new 'Async promise failed for unspecified reason'
+      ex = Exception.new ex unless ex.kind_of?(Exception)
+      ex
+    end
+  end
+
+  # TODO: Use subject! to create a before hook on the fly, might be cleaner than this
+  # Might be a better way to do this, but then you end up with promises around the expectation handlers, which could get ugly
+  def resolve_subject
+    begin
+      subj = example_group_instance.subject
+      if subj.is_a? Promise
+        return subj.then do |resolved_subject|
+          # This is a private method, but we're using Opal
+          example_group_instance.__memoized[:subject] = resolved_subject
+        end
+      end
+    rescue
+      # Exception occurred while checking the subject, might be that the example group had a described class, was not intending on using it as the subject,
+      # and the initializer for that described class failed
+    end
+    Promise.value
+  end
+
+  def run_after_example
+    @example_group_class.hooks.run(:after, :example, self).then do
+      verify_mocks
+      assign_generated_description if RSpec.configuration.expecting_with_rspec?
+    end.rescue do |e|
+      set_exception(e, "in an `after(:example)` hook")
+    end.ensure do
+      @example_group_instance.teardown_mocks_for_rspec
+    end
+  end
+
+  def run(example_group_instance, reporter)
+    @example_group_instance = example_group_instance
+    RSpec.current_example = self
+
+    start(reporter)
+    Pending.mark_pending!(self, pending) if pending?
+
+    Promise.value.then do
+      Promise.value.then do
+        if skipped?
+          Pending.mark_pending! self, skip
+        elsif !RSpec.configuration.dry_run?
+          with_around_example_hooks do
+            Promise.value.then do
+              run_before_example.then do
+                resolve_subject
+              end.then do
+                core_block_run
+              end.then do
+                if pending?
+                  Pending.mark_fixed! self
+
+                  raise Pending::PendingExampleFixedError,
+                        'Expected example to fail since it is pending, but it passed.',
+                        [location]
+                end
+              end
+            end.rescue do |e|
+              # no-op, required metadata has already been set by the `skip`
+              # method.
+              unless e.is_a? Pending::SkipDeclaredInExample
+                set_exception(e)
+              end
+            end.ensure do
+              run_after_example
+            end
+          end
+        end
+      end.rescue do |e|
+        set_exception(e)
+      end.ensure do
+        @example_group_instance.instance_variables.each do |ivar|
+          @example_group_instance.instance_variable_set(ivar, nil)
+        end
+        @example_group_instance = nil
+      end
+    end.then do
+      finish(reporter)
+    end.ensure do |result|
+      RSpec.current_example = nil
+      # promise always/ensure do not behave exactly like ensure, need to be explicit about value being returned
+      result
+    end
+  end
+end

data/opal/opal/rspec/async/example_group.rb

@@ -0,0 +1,96 @@
+require 'promise'
+
+class ::RSpec::Core::ExampleGroup
+  # @param duration [Integer, Float] time in seconds to wait
+  def delay(duration, &block)
+    `setTimeout(block, duration * 1000)`
+    self
+  end
+
+  def delay_with_promise(duration, &block)
+    result = Promise.new
+    delay(duration) { result.resolve }
+    result.then &block
+  end
+
+  def self.process_descendants(our_examples_result, reporter)
+    descendants = ordering_strategy.order(children)
+    return Promise.value our_examples_result if descendants.empty?
+
+    results_for_descendants = []
+    # Can use true for this because we're AND'ing everything anyways
+    seed = Promise.value(true)
+    latest_descendant = descendants.inject(seed) do |previous_promise, next_descendant|
+      previous_promise.then do |result|
+        results_for_descendants << result
+        next_descendant.run reporter
+      end
+    end
+    latest_descendant.then do |result|
+      results_for_descendants << result
+      our_examples_result && results_for_descendants.all?
+    end
+  end
+
+  # Promise oriented version
+  def self.run(reporter)
+    if RSpec.world.wants_to_quit
+      RSpec.world.clear_remaining_example_groups if top_level?
+      return
+    end
+
+    reporter.example_group_started(self)
+    Promise.value.then do
+      run_before_context_hooks(new)
+    end.then do
+      run_examples(reporter)
+    end.then do |our_examples_result|
+      process_descendants(our_examples_result, reporter)
+    end.rescue do |ex|
+      result = if ex.is_a? Pending::SkipDeclaredInExample
+        for_filtered_examples(reporter) { |example| example.skip_with_exception(reporter, ex) }
+      else
+        RSpec.world.wants_to_quit = true if fail_fast?
+        for_filtered_examples(reporter) { |example| example.fail_with_exception(reporter, ex) }
+      end
+      result
+    end.always do |result|
+      run_after_context_hooks(new)
+      before_context_ivars.clear
+      reporter.example_group_finished(self)
+      # promise always do not behave exactly like ensure, need to be explicit about value being returned
+      result
+    end
+  end
+
+  # Promise oriented version
+  def self.run_examples(reporter)
+    examples = ordering_strategy.order(filtered_examples)
+    return Promise.value true if examples.empty?
+
+    example_promise = lambda do |example|
+      next Promise.value(nil) if RSpec.world.wants_to_quit
+      instance = new
+      set_ivars(instance, before_context_ivars)
+      # Always returns a promise since we modified the Example class
+      example.run(instance, reporter)
+    end
+
+    results = []
+    # Can use true for this because we're AND'ing everything anyways
+    seed = Promise.value true
+    latest_promise = examples.inject(seed) do |previous_promise, next_example|
+      previous_promise.then do |succeeded|
+        RSpec.world.wants_to_quit = true if fail_fast? && !succeeded
+        results << succeeded
+        example_promise[next_example]
+      end
+    end
+
+    latest_promise.then do |succeeded|
+      RSpec.world.wants_to_quit = true if fail_fast? && !succeeded
+      results << succeeded
+      results.all?
+    end
+  end
+end

data/opal/opal/rspec/async/hooks.rb

@@ -0,0 +1,10 @@
+class RSpec::Core::Hooks::HookCollection
+  def run
+    hooks.inject(Promise.value) do |previous_hook_promise, next_hook|
+      previous_hook_promise.then do
+        result = next_hook.run @example
+        Promise.value result
+      end
+    end
+  end
+end

data/opal/opal/rspec/async/legacy.rb

@@ -0,0 +1,50 @@
+module Opal
+  module RSpec
+    module AsyncHelpers
+      module ClassMethods        
+        def async(desc, *args, &block)
+          options = ::RSpec::Core::Metadata.build_hash_from(args)
+          options.update(:skip => ::RSpec::Core::Pending::NOT_YET_IMPLEMENTED) unless block
+
+          examples << Opal::RSpec::LegacyAsyncExample.new(self, desc, options, block)
+          examples.last          
+        end
+      end
+      
+      attr_accessor :legacy_promise
+      
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      # Use {#async} instead.
+      #
+      # @deprecated
+      def run_async(&block)
+        async(&block)
+      end
+  
+      def async(&block)
+        begin
+          instance_eval &block
+          legacy_promise.resolve
+        rescue Exception => e
+          legacy_promise.reject e
+        end
+      end
+    end
+  end
+end
+
+class Opal::RSpec::LegacyAsyncExample < ::RSpec::Core::Example
+  def initialize(example_group_class, description, user_metadata, example_block=nil)
+    example = self
+    legacy_promise_ex_block = lambda do
+      self.legacy_promise = Promise.new
+      instance_exec(example, &example_block)
+      self.legacy_promise
+    end
+    
+    super example_group_class, description, user_metadata, legacy_promise_ex_block
+  end
+end

data/opal/opal/rspec/async/reporter.rb

@@ -0,0 +1,9 @@
+class ::RSpec::Core::Reporter
+  def report_async(expected_example_count)
+    start(expected_example_count)
+    yield(self).ensure do |result|
+      finish
+      result
+    end
+  end
+end

data/opal/opal/rspec/fixes.rb

@@ -0,0 +1,5 @@
+require 'encoding' unless Object.const_defined? :Encoding
+# Thread usage in core.rb
+require 'thread'
+require_relative 'fixes/rspec'
+require_relative 'fixes/opal'

data/opal/opal/rspec/fixes/opal.rb

@@ -0,0 +1,5 @@
+require_relative 'opal/compatibility'
+require_relative 'opal/kernel'
+require_relative 'opal/class'
+require_relative 'opal/stdlib'
+require_relative 'opal/corelib'

data/opal/opal/rspec/fixes/opal/class.rb

@@ -0,0 +1,8 @@
+# https://github.com/opal/opal/issues/1079, fixed in Opal 0.9
+unless Opal::RSpec::Compatibility.full_class_names?
+  class Class
+    def to_s
+      name || "#<#{`self.$$is_mod ? 'Module' : 'Class'`}:0x#{__id__.to_s(16)}>"
+    end
+  end
+end

data/opal/opal/rspec/fixes/opal/compatibility.rb

@@ -0,0 +1,228 @@
+module Opal
+  module RSpec
+    module Compatibility
+      # https://github.com/opal/opal/commit/78016aa11955e4cff3d6bbf06f1222d40b03a9e6, fixed in Opal 0.9
+      def self.clones_singleton_methods?
+        obj = Object.new
+
+        def obj.special()
+          :the_one
+        end
+
+        clone = obj.clone
+        clone.respond_to?(:special) && clone.special == :the_one
+      end
+
+      # https://github.com/opal/opal/pull/1104, fixed in Opal 0.9
+      def self.pp_uses_stdout_default?
+        require 'stringio'
+        require 'pp'
+
+        stdout = $stdout
+        $stdout = StringIO.new
+        msg = 'opal-rspec - checking pp/pretty print features'
+        PP.pp msg
+        $stdout.string == "\"#{msg}\"\n"
+      ensure
+        $stdout = stdout
+      end
+
+      # https://github.com/opal/opal/issues/1079, fixed in Opal 0.9
+      def self.full_class_names?
+        Opal::RSpec::Compatibility.to_s == 'Opal::RSpec::Compatibility'
+      end
+
+      # https://github.com/opal/opal/pull/1123, SHOULD be fixed in Opal 0.9
+      def self.is_struct_hash_correct?
+        s = Struct.new(:id)
+        s.new(1) == s.new(1)
+      end
+
+      # https://github.com/opal/opal/issues/1080, fixed in Opal 0.9
+      def self.is_constants_a_clone?
+        mod = Opal::RSpec::Compatibility
+        `#{mod.constants} !== #{mod.constants}`
+      end
+
+      # https://github.com/opal/opal/issues/1077, fixed in Opal 0.9
+      def self.class_descendant_of_self_fixed?
+        !(String < String)
+      end
+
+      # https://github.com/opal/opal/issues/1090, fixed in Opal 0.9
+      def self.and_works_with_lhs_nil?
+        value = nil
+        (value && nil) == nil
+      end
+
+      # https://github.com/opal/opal/issues/858
+      def self.is_set_coerced_to_array?
+        require 'set'
+
+        obj = Object.new
+
+        def obj.splat(*data)
+          return data[0]
+        end
+
+        obj.splat(*Set.new(Set.new([:foo, :bar]))) == :foo
+      end
+
+      # https://github.com/opal/opal/pull/1117, status pending
+      def self.fail_raise_matches_mri?
+        ex = nil
+        %x{
+          try {
+            #{fail}
+          }
+          catch(e) {
+            #{ex} = e;
+          }
+        }
+        ex.is_a? RuntimeError
+      end
+
+      TEST_CLASS = Class.new do
+        class ClassWithinClassNewWorks
+        end
+
+        def self.does_class_exist?
+          Compatibility.const_defined? :ClassWithinClassNewWorks
+        end
+      end
+
+      # https://github.com/opal/opal/issues/1110, fixed in Opal 0.9
+      def self.class_within_class_new_works?
+        TEST_CLASS.does_class_exist?
+      end
+
+      # Fixed in Opal 0.9
+      def self.undef_within_exec_works?
+        klass = Class.new do
+          def bar
+          end
+        end
+
+        klass.class_exec do
+          undef bar
+        end
+
+        !klass.new.respond_to? :bar
+      end
+
+      # https://github.com/opal/opal/pull/1129
+      def self.multiline_regex_works?
+        /foo.bar/m.match("foo\nbar").to_a == ["foo\nbar"]
+      end
+
+      # https://github.com/opal/opal/pull/1129
+      def self.empty_regex_works?
+        empty = //
+        begin
+          empty.options == 0 && empty.match('foo').to_s == ''
+        rescue
+          false
+        end
+      end
+
+      # https://github.com/opal/opal/pull/1129
+      def self.regex_case_compare_works?
+        begin
+          (/abc/ === nil) == false && (/abc/ === /abc/) == false
+        rescue
+          false
+        end
+      end
+
+      class ConstTest
+      end
+
+      module ModuleConstTest
+      end
+
+      # https://github.com/opal/opal/issues/1085
+      def self.constant_resolution_works_right?
+        begin
+          ModuleConstTest::ConstTest.new
+          false
+        rescue
+          true
+        end
+      end
+
+      # https://github.com/opal/opal/pull/1134
+      def self.exception_inspect_matches?
+        Exception.new.inspect == '#<Exception: Exception>'
+      end
+
+      # https://github.com/opal/opal/pull/1151, should be fixed in Opal 0.9
+      def self.exception_exception_method_works?
+        Exception.respond_to?(:exception) && Exception.exception.is_a?(Exception)
+      end
+
+      # https://github.com/opal/opal/pull/1135
+      def self.ostruct_works_right?
+        require 'ostruct'
+
+        s = OpenStruct.new(:exist? => true)
+        s.respond_to? :exist?
+      end
+
+      module ModuleCase
+      end
+
+      module ModuleCase2
+        include ModuleCase
+      end
+
+      class ModuleCase3
+        include ModuleCase2
+      end
+
+      def self.module_case_works_right?
+        instance = ModuleCase3.new
+        ModuleCase === instance && instance.kind_of?(ModuleCase)
+      end
+
+      module MultModSuper1
+        def stuff
+          :howdy
+        end
+      end
+
+      module MultModSuper2
+        def stuff
+          super
+        end
+      end
+
+      module MultModSuper3
+        include MultModSuper1
+        include MultModSuper2
+      end
+
+      class MultModSuperClass
+        include MultModSuper3
+      end
+
+      def self.multiple_module_include_super_works_right?
+        MultModSuperClass.new.stuff == :howdy
+      rescue
+        false
+      end
+
+      # https://github.com/opal/opal/pull/1152
+      def self.set_has_superset?
+        require 'set'
+        Set.new.respond_to?(:superset?)
+      end
+
+      # MRI does does, Opal does not yet
+      def self.lambda_zero_arg_throws_arg_error?
+        !(lambda { 3 } === lambda { 4 })
+      rescue
+        true
+      end
+    end
+  end
+end