opal-connect-rspec 0.5.0

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

@@ -0,0 +1,2 @@
+require_relative 'stdlib/pp'
+require_relative 'stdlib/set'

data/opal/opal/rspec/fixes/opal/stdlib/pp.rb

@@ -0,0 +1,23 @@
+# https://github.com/opal/opal/pull/1104, fixed in Opal 0.9
+# Opal hasn't been using $stdout as a default value
+unless Opal::RSpec::Compatibility.pp_uses_stdout_default?
+  class PP
+    class << self
+      if `(typeof(console) === "undefined" || typeof(console.log) === "undefined")`
+        def pp(obj, out=$stdout, width=79)
+          p(*args)
+        end
+      else
+        def pp(obj, out=$stdout, width=79)
+          if String === out
+            out + obj.inspect + "\n"
+          else
+            out << obj.inspect + "\n"
+          end
+        end
+      end
+
+      alias :singleline_pp :pp
+    end
+  end
+end

data/opal/opal/rspec/fixes/opal/stdlib/set.rb

@@ -0,0 +1,36 @@
+# https://github.com/opal/opal/pull/1152
+unless Opal::RSpec::Compatibility.set_has_superset?
+  class Set
+    def superset?(set)
+      set.is_a?(Set) or raise ArgumentError, "value must be a set"
+      return false if size < set.size
+      set.all? { |o| include?(o) }
+    end
+
+    alias >= superset?
+
+    def proper_superset?(set)
+      set.is_a?(Set) or raise ArgumentError, "value must be a set"
+      return false if size <= set.size
+      set.all? { |o| include?(o) }
+    end
+
+    alias > proper_superset?
+
+    def subset?(set)
+      set.is_a?(Set) or raise ArgumentError, "value must be a set"
+      return false if set.size < size
+      all? { |o| set.include?(o) }
+    end
+
+    alias <= subset?
+
+    def proper_subset?(set)
+      set.is_a?(Set) or raise ArgumentError, "value must be a set"
+      return false if set.size <= size
+      all? { |o| set.include?(o) }
+    end
+
+    alias < proper_subset?
+  end
+end

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

@@ -0,0 +1,7 @@
+require_relative 'rspec/core'
+require_relative 'rspec/support'
+require_relative 'rspec/expectations'
+require_relative 'rspec/matchers'
+require_relative 'rspec/mocks'
+require_relative 'rspec/caller_filter'
+require_relative 'rspec/example_groups'

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

@@ -0,0 +1,6 @@
+# This breaks on 2.0.0, so it is here ready for when opal bumps to 2.0.0
+class RSpec::CallerFilter
+  def self.first_non_rspec_line
+    ""
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative 'core/example_group'
+require_relative 'core/example'
+require_relative 'core/reporter'
+require_relative 'core/formatters'
+require_relative 'core/notifications'
+require_relative 'core/ordering'
+require_relative 'core/metadata'
+require_relative 'core/configuration'
+require_relative 'core/warnings'

data/opal/opal/rspec/fixes/rspec/core/configuration.rb

@@ -0,0 +1,11 @@
+class ::RSpec::Core::Configuration
+  # This needs to be implemented if/when we allow the Opal side to decide what files to run
+  def files_or_directories_to_run=(*files)
+    @files_or_directories_to_run = []
+    @files_to_run = nil
+  end
+
+  def requires=(paths)
+    # can't change requires @ this stage, this method calls RubyProject which will crash on Opal
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/example.rb

@@ -0,0 +1,20 @@
+class RSpec::Core::Example
+  # more mutable strings
+  def assign_generated_description
+    if metadata[:description].empty? && (description = RSpec::Matchers.generated_description)
+      metadata[:description] = description
+      metadata[:full_description] = metadata[:full_description] + description # mutable string fix
+    end
+  rescue Exception => e
+    set_exception(e, "while assigning the example description")
+  ensure
+    RSpec::Matchers.clear_generated_description
+  end
+
+  # https://github.com/opal/opal/issues/1126
+  # Hash.public_instance_methods - Object.public_instance_methods, which is a part of metadata.rb/HashImitatable (included by ExecutionResult), returns the initialize method, which gets marked as deprecated. The intent of the issue_deprecation method though is to shift people away from using this as a hash. Initialize obviously is not indicative of hash usage (any new object will trip this up, and that should not happen).
+  class ExecutionResult
+    # There is no real constructor to preserve in example.rb's ExecutionResult class, so can eliminate the issue_deprecation call this way
+    def initialize; end
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/example_group.rb

@@ -0,0 +1,9 @@
+unless Opal::RSpec::Compatibility.class_descendant_of_self_fixed?
+  class ::RSpec::Core::ExampleGroup
+    def self.parent_groups
+      # https://github.com/opal/opal/issues/1077, fixed in Opal 0.9
+      # @parent_groups ||= ancestors.select { |a| a < RSpec::Core::ExampleGroup }
+      @parent_groups ||= ancestors.select { |a| a < RSpec::Core::ExampleGroup and a != RSpec::Core::ExampleGroup }
+    end
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/formatters.rb

@@ -0,0 +1,6 @@
+require_relative 'formatters/backtrace_formatter'
+require_relative 'formatters/deprecation_formatter'
+require_relative 'formatters/generated_deprecation_message'
+require_relative 'formatters/console_codes'
+require_relative 'formatters/loader'
+require_relative 'formatters/json_formatter'

data/opal/opal/rspec/fixes/rspec/core/formatters/backtrace_formatter.rb

@@ -0,0 +1,20 @@
+class ::RSpec::Core::BacktraceFormatter
+  def backtrace_line(line)
+    # don't have the Metadata class in Opal
+    #Metadata.relative_path(line) unless exclude?(line)
+    nil
+  end
+
+  alias_method :original_format_backtrace, :format_backtrace
+
+  def format_backtrace(backtrace, options={})
+    # Javascript stack traces include the message on the first few lines, but we already have that in the message
+    # have several blank lines as well
+    original_format_backtrace clean_js_backtrace(backtrace), options
+  end
+
+  def clean_js_backtrace(backtrace)
+    valid_line = /\s*at.*/
+    backtrace.select { |line| valid_line.match line }
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/formatters/console_codes.rb

@@ -0,0 +1,11 @@
+module ::RSpec::Core::Formatters::ConsoleCodes
+  def wrap(text, code_or_symbol)
+    if RSpec.configuration.color_enabled?
+      # Need to escape the \e differently in JS and can't use string interpolation
+      #"\e[#{console_code_for(code_or_symbol)}m#{text}\e[0m"
+      "\033" + "[#{console_code_for(code_or_symbol)}m#{text}" +"\033" + '[0m'
+    else
+      text
+    end
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/formatters/deprecation_formatter.rb

@@ -0,0 +1,20 @@
+class RSpec::Core::Formatters::DeprecationFormatter
+
+  # SpecifiedDeprecationMessage is a Struct
+  SpecifiedDeprecationMessage.class_eval do
+    def too_many_warnings_message
+      # mutable strings not supported
+      "Too many similar deprecation messages reported, disregarding further reports. " + DEPRECATION_STREAM_NOTICE
+    end
+  end
+
+  # GeneratedDeprecationMessage is a Struct
+  GeneratedDeprecationMessage.class_eval do
+    def to_s
+      msg = "#{@data.deprecated} is deprecated."
+      msg = msg + " Use #{@data.replacement} instead." if @data.replacement
+      msg = msg + " Called from #{@data.call_site}." if @data.call_site
+      msg
+    end
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/formatters/generated_deprecation_message.rb

@@ -0,0 +1,15 @@
+RSpec::Core::Formatters::DeprecationFormatter::GeneratedDeprecationMessage.class_eval do
+  # string mutations
+  def to_s
+    msg = "#{@data.deprecated} is deprecated."
+    msg += " Use #{@data.replacement} instead." if @data.replacement
+    msg += " Called from #{@data.call_site}." if @data.call_site
+    msg
+  end
+
+  def too_many_warnings_message
+    msg = "Too many uses of deprecated '#{type}'. "
+    msg += RSpec::Core::Formatters::DeprecationFormatter::DEPRECATION_STREAM_NOTICE
+    msg
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/formatters/json_formatter.rb

@@ -0,0 +1,10 @@
+class ::RSpec::Core::Formatters::JsonFormatter
+  def close(_notification)
+    output.write @output_hash.to_json
+    # JSON formatter does not look @ closed? and we need it to, otherwise Phantom freezes
+    return unless IO === output
+    return if output.closed? || output == $stdout
+
+    output.close
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/formatters/loader.rb

@@ -0,0 +1,38 @@
+class ::RSpec::Core::Formatters::Loader
+  def string_const?(str)
+    # Incompatible regex (\A flag and \z flag)
+    # str.is_a?(String) && /\A[A-Z][a-zA-Z0-9_:]*\z/ =~ str
+    str.is_a?(String) && /^[A-Z][a-zA-Z0-9_:]*$/ =~ str
+  end
+
+  def underscore(camel_cased_word)
+    # string mutation
+    word = camel_cased_word.to_s.dup
+    word = word.gsub(/::/, '/')
+    word = word.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+    word = word.gsub(/([a-z\d])([A-Z])/, '\1_\2')
+    word = word.tr("-", "_")
+    word.downcase
+  end
+
+  def custom_formatter(formatter_ref)
+    if Class === formatter_ref
+      formatter_ref
+    elsif string_const?(formatter_ref)
+      # retry not supported on opal
+      # begin
+      #   formatter_ref.gsub(/^::/, '').split('::').inject(Object) { |a, e| a.const_get e }
+      # rescue NameError
+      #   require(path_for(formatter_ref)) ? retry : raise
+      # end
+      while true
+        begin
+          return formatter_ref.gsub(/^::/, '').split('::').inject(Object) { |a, e| a.const_get e }
+        rescue NameError
+          raise unless require(path_for(formatter_ref))
+        end
+      end
+    end
+  end
+end
+

data/opal/opal/rspec/fixes/rspec/core/metadata.rb

@@ -0,0 +1,39 @@
+module ::RSpec::Core::Metadata
+  # https://github.com/opal/opal/issues/1090, fixed in Opal 0.9
+  unless ::Opal::RSpec::Compatibility.and_works_with_lhs_nil?
+    class ExampleGroupHash
+      def described_class
+        candidate = metadata[:description_args].first
+        return candidate unless NilClass === candidate || String === candidate
+        parent_group = metadata[:parent_example_group]
+        # https://github.com/opal/opal/issues/1090, fixed in Opal 0.9
+        # parent_group && parent_group[:described_class]
+        if parent_group
+          parent_group[:described_class]
+        else
+          nil
+        end
+      end
+    end
+  end
+
+  class HashPopulator
+    def populate_location_attributes
+      backtrace = user_metadata.delete(:caller)
+
+      file_path, line_number = if backtrace
+                                 file_path_and_line_number_from(backtrace)
+                                 # Opal 0.9 has a stub for this but it does not return anything
+                               # elsif block.respond_to?(:source_location)
+                               #   block.source_location
+                               else
+                                 file_path_and_line_number_from(caller)
+                               end
+
+      file_path = Metadata.relative_path(file_path)
+      metadata[:file_path] = file_path
+      metadata[:line_number] = line_number.to_i
+      metadata[:location] = "#{file_path}:#{line_number}"
+    end
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/notifications.rb

@@ -0,0 +1,3 @@
+require_relative 'notifications/examples_notification'
+require_relative 'notifications/failed_example_notification'
+require_relative 'notifications/summary_notification'

data/opal/opal/rspec/fixes/rspec/core/notifications/examples_notification.rb

@@ -0,0 +1,30 @@
+module ::RSpec::Core::Notifications
+  class ExamplesNotification
+    def fully_formatted_failed_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+      formatted = "\nFailures:\n"
+
+      failure_notifications.each_with_index do |failure, index|
+        # string mutation
+        formatted = formatted + failure.fully_formatted(index.next, colorizer)
+      end
+
+      formatted
+    end
+    
+    def fully_formatted_pending_examples(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+      formatted = "\nPending:\n"
+
+      pending_examples.each do |example|
+        formatted_caller = RSpec.configuration.backtrace_formatter.backtrace_line(example.location)
+
+        # string mutation
+        formatted = formatted +
+          "  #{colorizer.wrap(example.full_description, :pending)}\n" \
+          "    # #{colorizer.wrap(example.execution_result.pending_message, :detail)}\n" \
+          "    # #{colorizer.wrap(formatted_caller, :detail)}\n"
+      end
+
+      formatted
+    end
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/notifications/failed_example_notification.rb

@@ -0,0 +1,20 @@
+module ::RSpec::Core::Notifications
+  class FailedExampleNotification
+    def fully_formatted(failure_number, colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+      formatted = "\n  #{failure_number}) #{description}\n"
+
+      colorized_message_lines(colorizer).each do |line|
+        # formatted << RSpec::Support::EncodedString.new("     #{line}\n", encoding_of(formatted))
+        # string mutation
+        formatted = formatted + RSpec::Support::EncodedString.new("     #{line}\n", encoding_of(formatted))
+      end
+
+      colorized_formatted_backtrace(colorizer).each do |line|
+        # formatted << RSpec::Support::EncodedString.new("     #{line}\n", encoding_of(formatted))
+        # string mutation
+        formatted = formatted + RSpec::Support::EncodedString.new("     #{line}\n", encoding_of(formatted))
+      end
+      formatted
+    end
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/notifications/summary_notification.rb

@@ -0,0 +1,26 @@
+module ::RSpec::Core::Notifications
+  # SummaryNotification is a Struct
+  SummaryNotification.class_eval do
+    def totals_line
+      summary = Formatters::Helpers.pluralize(example_count, "example")
+      # 2 string mutations
+      summary = summary + ", " + Formatters::Helpers.pluralize(failure_count, "failure")
+      # string mutation
+      summary = summary + ", #{pending_count} pending" if pending_count > 0
+      summary
+    end
+
+    def fully_formatted(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+      formatted = "\nFinished in #{formatted_duration} " \
+                  "(files took #{formatted_load_time} to load)\n" \
+                  "#{colorized_totals_line(colorizer)}\n"
+
+      unless failed_examples.empty?
+        # 2 string mutations
+        formatted = formatted + colorized_rerun_commands(colorizer) + "\n"
+      end
+
+      formatted
+    end
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/ordering.rb

@@ -0,0 +1 @@
+require_relative 'ordering/random'

data/opal/opal/rspec/fixes/rspec/core/ordering/random.rb

@@ -0,0 +1,13 @@
+# Random causes problems that can lock up a browser (see README)
+class ::RSpec::Core::Ordering::Random
+  HIDE_RANDOM_WARNINGS = false
+
+  def initialize(configuration)
+    `console.warn("Random order is not currently supported by opal-rspec, using default order.")` unless HIDE_RANDOM_WARNINGS
+  end
+
+  # Identity is usually the default, so borrowing its implementation, this forces 'accidental' random usage down that path
+  def order(items)
+    items
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/reporter.rb

@@ -0,0 +1,14 @@
+unless Opal::RSpec::Compatibility.is_set_coerced_to_array?
+  class RSpec::Core::Reporter
+    # https://github.com/opal/opal/issues/858, fixed in Opal 0.9
+    # The problem is not directly related to the Reporter class (it has more to do with Formatter's call in add using a splat in the args list and right now, Opal does not run a to_a on a set that can be an array in the splat before the callee method takes over)
+    def register_listener(listener, *notifications)
+      # Without this, we won't flatten out each notification properly (e.g. example_started, finished, etc.)
+      notifications = notifications[0].to_a if notifications[0].is_a? Set
+      notifications.each do |notification|
+        @listeners[notification.to_sym] << listener
+      end
+      true
+    end
+  end
+end

data/opal/opal/rspec/fixes/rspec/core/warnings.rb

@@ -0,0 +1,18 @@
+# not 100% sure this compat check fixes this, but it's pretty close
+unless Opal::RSpec::Compatibility.multiple_module_include_super_works_right?
+  module ::RSpec::Core::Warnings
+    def warn_with(message, options={})
+      if options[:use_spec_location_as_call_site]
+        message += "." unless message.end_with?(".")
+
+        if RSpec.current_example
+          message += " Warning generated from spec at `#{RSpec.current_example.location}`."
+        end
+      end
+
+      # super won't find this
+      # super(message, options)
+      support_warn_with message, options
+    end
+  end
+end