opal-connect-rspec 0.5.0

data/rspec-core/lib/rspec/core/formatters/base_formatter.rb

@@ -0,0 +1,67 @@
+RSpec::Support.require_rspec_core "formatters/helpers"
+require 'stringio'
+
+module RSpec
+  module Core
+    module Formatters
+      # RSpec's built-in formatters are all subclasses of RSpec::Core::Formatters::BaseTextFormatter.
+      #
+      # @see RSpec::Core::Formatters::BaseTextFormatter
+      # @see RSpec::Core::Reporter
+      # @see RSpec::Core::Formatters::Protocol
+      class BaseFormatter
+        # all formatters inheriting from this formatter will receive these notifications
+        Formatters.register self, :start, :example_group_started, :close
+        attr_accessor :example_group
+        attr_reader :output
+
+        # @api public
+        # @param output [IO] the formatter output
+        # @see RSpec::Core::Formatters::Protocol#initialize
+        def initialize(output)
+          @output = output || StringIO.new
+          @example_group = nil
+        end
+
+        # @api public
+        #
+        # @param notification [StartNotification]
+        # @see RSpec::Core::Formatters::Protocol#start
+        def start(notification)
+          start_sync_output
+          @example_count = notification.count
+        end
+
+        # @api public
+        #
+        # @param notification [GroupNotification] containing example_group subclass of `RSpec::Core::ExampleGroup`
+        # @see RSpec::Core::Formatters::Protocol#example_group_started
+        def example_group_started(notification)
+          @example_group = notification.group
+        end
+
+        # @api public
+        #
+        # @param notification [NullNotification]
+        # @see RSpec::Core::Formatters::Protocol#close
+        def close(_notification)
+          restore_sync_output
+        end
+
+      private
+
+        def start_sync_output
+          @old_sync, output.sync = output.sync, true if output_supports_sync
+        end
+
+        def restore_sync_output
+          output.sync = @old_sync if output_supports_sync && !output.closed?
+        end
+
+        def output_supports_sync
+          output.respond_to?(:sync=)
+        end
+      end
+    end
+  end
+end

data/rspec-core/lib/rspec/core/formatters/base_text_formatter.rb

@@ -0,0 +1,76 @@
+RSpec::Support.require_rspec_core "formatters/base_formatter"
+RSpec::Support.require_rspec_core "formatters/console_codes"
+
+module RSpec
+  module Core
+    module Formatters
+      # Base for all of RSpec's built-in formatters. See RSpec::Core::Formatters::BaseFormatter
+      # to learn more about all of the methods called by the reporter.
+      #
+      # @see RSpec::Core::Formatters::BaseFormatter
+      # @see RSpec::Core::Reporter
+      class BaseTextFormatter < BaseFormatter
+        Formatters.register self,
+                            :message, :dump_summary, :dump_failures, :dump_pending, :seed
+
+        # @method message
+        # @api public
+        #
+        # Used by the reporter to send messages to the output stream.
+        #
+        # @param notification [MessageNotification] containing message
+        def message(notification)
+          output.puts notification.message
+        end
+
+        # @method dump_failures
+        # @api public
+        #
+        # Dumps detailed information about each example failure.
+        #
+        # @param notification [NullNotification]
+        def dump_failures(notification)
+          return if notification.failure_notifications.empty?
+          output.puts notification.fully_formatted_failed_examples
+        end
+
+        # @method dump_summary
+        # @api public
+        #
+        # This method is invoked after the dumping of examples and failures. Each parameter
+        # is assigned to a corresponding attribute.
+        #
+        # @param summary [SummaryNotification] containing duration, example_count,
+        #                                      failure_count and pending_count
+        def dump_summary(summary)
+          output.puts summary.fully_formatted
+        end
+
+        # @private
+        def dump_pending(notification)
+          return if notification.pending_examples.empty?
+          output.puts notification.fully_formatted_pending_examples
+        end
+
+        # @private
+        def seed(notification)
+          return unless notification.seed_used?
+          output.puts notification.fully_formatted
+        end
+
+        # @api public
+        #
+        # Invoked at the very end, `close` allows the formatter to clean
+        # up resources, e.g. open streams, etc.
+        #
+        # @param notification [NullNotification]
+        def close(_notification)
+          return unless IO === output
+          return if output.closed? || output == $stdout
+
+          output.close
+        end
+      end
+    end
+  end
+end

data/rspec-core/lib/rspec/core/formatters/console_codes.rb

@@ -0,0 +1,64 @@
+module RSpec
+  module Core
+    module Formatters
+      # ConsoleCodes provides helpers for formatting console output
+      # with ANSI codes, e.g. color's and bold.
+      module ConsoleCodes
+        # @private
+        VT100_CODES =
+          {
+            :black   => 30,
+            :red     => 31,
+            :green   => 32,
+            :yellow  => 33,
+            :blue    => 34,
+            :magenta => 35,
+            :cyan    => 36,
+            :white   => 37,
+            :bold    => 1,
+          }
+        # @private
+        VT100_CODE_VALUES = VT100_CODES.invert
+
+        module_function
+
+        # Fetches the correct code for the supplied symbol, or checks
+        # that a code is valid. Defaults to white (37).
+        #
+        # @param code_or_symbol [Symbol, Fixnum] Symbol or code to check
+        # @return [Fixnum] a console code
+        def console_code_for(code_or_symbol)
+          if RSpec.configuration.respond_to?(:"#{code_or_symbol}_color")
+            console_code_for configuration_color(code_or_symbol)
+          elsif VT100_CODE_VALUES.key?(code_or_symbol)
+            code_or_symbol
+          else
+            VT100_CODES.fetch(code_or_symbol) do
+              console_code_for(:white)
+            end
+          end
+        end
+
+        # Wraps a piece of text in ANSI codes with the supplied code. Will
+        # only apply the control code if `RSpec.configuration.color_enabled?`
+        # returns true.
+        #
+        # @param text [String] the text to wrap
+        # @param code_or_symbol [Symbol, Fixnum] the desired control code
+        # @return [String] the wrapped text
+        def wrap(text, code_or_symbol)
+          if RSpec.configuration.color_enabled?
+            "\e[#{console_code_for(code_or_symbol)}m#{text}\e[0m"
+          else
+            text
+          end
+        end
+
+        # @private
+        def configuration_color(code)
+          RSpec.configuration.__send__(:"#{code}_color")
+        end
+      end
+    end
+  end
+end

data/rspec-core/lib/rspec/core/formatters/deprecation_formatter.rb

@@ -0,0 +1,222 @@
+RSpec::Support.require_rspec_core "formatters/helpers"
+require 'set'
+
+module RSpec
+  module Core
+    module Formatters
+      # @private
+      class DeprecationFormatter
+        Formatters.register self, :deprecation, :deprecation_summary
+
+        attr_reader :count, :deprecation_stream, :summary_stream
+
+        def initialize(deprecation_stream, summary_stream)
+          @deprecation_stream = deprecation_stream
+          @summary_stream = summary_stream
+          @seen_deprecations = Set.new
+          @count = 0
+        end
+        alias :output :deprecation_stream
+
+        def printer
+          @printer ||= case deprecation_stream
+                       when File
+                         ImmediatePrinter.new(FileStream.new(deprecation_stream), summary_stream, self)
+                       when RaiseErrorStream
+                         ImmediatePrinter.new(deprecation_stream, summary_stream, self)
+                       else
+                         DelayedPrinter.new(deprecation_stream, summary_stream, self)
+                       end
+        end
+
+        def deprecation(notification)
+          return if @seen_deprecations.include? notification
+
+          @count += 1
+          printer.print_deprecation_message notification
+          @seen_deprecations << notification
+        end
+
+        def deprecation_summary(_notification)
+          printer.deprecation_summary
+        end
+
+        def deprecation_message_for(data)
+          if data.message
+            SpecifiedDeprecationMessage.new(data)
+          else
+            GeneratedDeprecationMessage.new(data)
+          end
+        end
+
+        RAISE_ERROR_CONFIG_NOTICE = <<-EOS.gsub(/^\s+\|/, '')
+          |
+          |If you need more of the backtrace for any of these deprecations to
+          |identify where to make the necessary changes, you can configure
+          |`config.raise_errors_for_deprecations!`, and it will turn the
+          |deprecation warnings into errors, giving you the full backtrace.
+        EOS
+
+        DEPRECATION_STREAM_NOTICE = "Pass `--deprecation-out` or set " \
+          "`config.deprecation_stream` to a file for full output."
+
+        SpecifiedDeprecationMessage = Struct.new(:type) do
+          def initialize(data)
+            @message = data.message
+            super deprecation_type_for(data)
+          end
+
+          def to_s
+            output_formatted @message
+          end
+
+          def too_many_warnings_message
+            msg = "Too many similar deprecation messages reported, disregarding further reports. "
+            msg << DEPRECATION_STREAM_NOTICE
+            msg
+          end
+
+          private
+
+          def output_formatted(str)
+            return str unless str.lines.count > 1
+            separator = "#{'-' * 80}"
+            "#{separator}\n#{str.chomp}\n#{separator}"
+          end
+
+          def deprecation_type_for(data)
+            data.message.gsub(/(\w+\/)+\w+\.rb:\d+/, '')
+          end
+        end
+
+        GeneratedDeprecationMessage = Struct.new(:type) do
+          def initialize(data)
+            @data = data
+            super data.deprecated
+          end
+
+          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 << DEPRECATION_STREAM_NOTICE
+            msg
+          end
+        end
+
+        # @private
+        class ImmediatePrinter
+          attr_reader :deprecation_stream, :summary_stream, :deprecation_formatter
+
+          def initialize(deprecation_stream, summary_stream, deprecation_formatter)
+            @deprecation_stream = deprecation_stream
+
+            @summary_stream = summary_stream
+            @deprecation_formatter = deprecation_formatter
+          end
+
+          def print_deprecation_message(data)
+            deprecation_message = deprecation_formatter.deprecation_message_for(data)
+            deprecation_stream.puts deprecation_message.to_s
+          end
+
+          def deprecation_summary
+            return if deprecation_formatter.count.zero?
+            deprecation_stream.summarize(summary_stream, deprecation_formatter.count)
+          end
+        end
+
+        # @private
+        class DelayedPrinter
+          TOO_MANY_USES_LIMIT = 4
+
+          attr_reader :deprecation_stream, :summary_stream, :deprecation_formatter
+
+          def initialize(deprecation_stream, summary_stream, deprecation_formatter)
+            @deprecation_stream = deprecation_stream
+            @summary_stream = summary_stream
+            @deprecation_formatter = deprecation_formatter
+            @seen_deprecations = Hash.new { 0 }
+            @deprecation_messages = Hash.new { |h, k| h[k] = [] }
+          end
+
+          def print_deprecation_message(data)
+            deprecation_message = deprecation_formatter.deprecation_message_for(data)
+            @seen_deprecations[deprecation_message] += 1
+
+            stash_deprecation_message(deprecation_message)
+          end
+
+          def stash_deprecation_message(deprecation_message)
+            if @seen_deprecations[deprecation_message] < TOO_MANY_USES_LIMIT
+              @deprecation_messages[deprecation_message] << deprecation_message.to_s
+            elsif @seen_deprecations[deprecation_message] == TOO_MANY_USES_LIMIT
+              @deprecation_messages[deprecation_message] << deprecation_message.too_many_warnings_message
+            end
+          end
+
+          def deprecation_summary
+            return unless @deprecation_messages.any?
+
+            print_deferred_deprecation_warnings
+            deprecation_stream.puts RAISE_ERROR_CONFIG_NOTICE
+
+            summary_stream.puts "\n#{Helpers.pluralize(deprecation_formatter.count, 'deprecation warning')} total"
+          end
+
+          def print_deferred_deprecation_warnings
+            deprecation_stream.puts "\nDeprecation Warnings:\n\n"
+            @deprecation_messages.keys.sort_by(&:type).each do |deprecation|
+              messages = @deprecation_messages[deprecation]
+              messages.each { |msg| deprecation_stream.puts msg }
+              deprecation_stream.puts
+            end
+          end
+        end
+
+        # @private
+        # Not really a stream, but is usable in place of one.
+        class RaiseErrorStream
+          def puts(message)
+            raise DeprecationError, message
+          end
+
+          def summarize(summary_stream, deprecation_count)
+            summary_stream.puts "\n#{Helpers.pluralize(deprecation_count, 'deprecation')} found."
+          end
+        end
+
+        # @private
+        # Wraps a File object and provides file-specific operations.
+        class FileStream
+          def initialize(file)
+            @file = file
+
+            # In one of my test suites, I got lots of duplicate output in the
+            # deprecation file (e.g. 200 of the same deprecation, even though
+            # the `puts` below was only called 6 times). Setting `sync = true`
+            # fixes this (but we really have no idea why!).
+            @file.sync = true
+          end
+
+          def puts(*args)
+            @file.puts(*args)
+          end
+
+          def summarize(summary_stream, deprecation_count)
+            summary_stream.puts "\n#{Helpers.pluralize(deprecation_count, 'deprecation')} logged to #{@file.path}"
+            puts RAISE_ERROR_CONFIG_NOTICE
+          end
+        end
+      end
+    end
+
+    # Deprecation Error
+    DeprecationError = Class.new(StandardError)
+  end
+end

data/rspec-core/lib/rspec/core/formatters/documentation_formatter.rb

@@ -0,0 +1,68 @@
+RSpec::Support.require_rspec_core "formatters/base_text_formatter"
+
+module RSpec
+  module Core
+    module Formatters
+      # @private
+      class DocumentationFormatter < BaseTextFormatter
+        Formatters.register self, :example_group_started, :example_group_finished,
+                            :example_passed, :example_pending, :example_failed
+
+        def initialize(output)
+          super
+          @group_level = 0
+        end
+
+        def example_group_started(notification)
+          output.puts if @group_level == 0
+          output.puts "#{current_indentation}#{notification.group.description.strip}"
+
+          @group_level += 1
+        end
+
+        def example_group_finished(_notification)
+          @group_level -= 1
+        end
+
+        def example_passed(passed)
+          output.puts passed_output(passed.example)
+        end
+
+        def example_pending(pending)
+          output.puts pending_output(pending.example, pending.example.execution_result.pending_message)
+        end
+
+        def example_failed(failure)
+          output.puts failure_output(failure.example, failure.example.execution_result.exception)
+        end
+
+      private
+
+        def passed_output(example)
+          ConsoleCodes.wrap("#{current_indentation}#{example.description.strip}", :success)
+        end
+
+        def pending_output(example, message)
+          ConsoleCodes.wrap("#{current_indentation}#{example.description.strip} (PENDING: #{message})", :pending)
+        end
+
+        def failure_output(example, _exception)
+          ConsoleCodes.wrap("#{current_indentation}#{example.description.strip} (FAILED - #{next_failure_index})", :failure)
+        end
+
+        def next_failure_index
+          @next_failure_index ||= 0
+          @next_failure_index += 1
+        end
+
+        def current_indentation
+          '  ' * @group_level
+        end
+
+        def example_group_chain
+          example_group.parent_groups.reverse
+        end
+      end
+    end
+  end
+end