avmnu-sng/rspec-tap-formatters

# frozen_string_literal: true

require 'rspec/core/formatters/base_formatter'
require_relative 'printer'
require_relative 'test_stats'

module RSpec
  module TAP
    module Formatters
      # Flat TAP formatter
      class Flat < RSpec::Core::Formatters::BaseFormatter
        # List of subscribed notifications
        NOTIFICATIONS = %i[
          seed
          start
          start_dump
          example_started
          example_passed
          example_failed
          example_pending
          message
          dump_failures
          dump_pending
          dump_summary
        ].freeze

        RSpec::Core::Formatters.register(self, *NOTIFICATIONS)

        # Constructor
        #
        # @param output [StringIO, File] output stream
        def initialize(output)
          super

          @printer = Printer.new(output)
          @seed = nil
          @example_number = 0
        end

        # Seed notification
        #
        # @param notification [SeedNotification]
        def seed(notification)
          @seed = notification.seed if notification.seed_used?
        end

        # Start notification
        #
        # @param notification [StartNotification]
        def start(notification)
          super

          @printer.start_output
        end

        # Execution finished notification
        #
        # @param _notification [NullNotification]
        def start_dump(_notification)
          @printer.example_progress_dump
        end

        # Example start notification
        #
        # @param _notification [ExampleNotification]
        def example_started(_notification)
          @example_number += 1
        end

        # Passing example notification
        #
        # @param notification [ExampleNotification]
        def example_passed(notification)
          @printer.example_progress_output(:success)
          @printer.success_output(
            notification.example.full_description.strip,
            @example_number,
            0
          )
        end

        # Failing example notification
        #
        # @param notification [FailedExampleNotification]
        def example_failed(notification)
          @printer.example_progress_output(:failure)
          @printer.failure_output(
            notification.example.full_description.strip,
            @example_number,
            0
          )
          @printer.failure_reason_output(notification, 1)
        end

        # Pending example notification
        #
        # @param notification [PendingExampleFailedAsExpectedNotification
        #   , SkippedExampleException]
        def example_pending(notification)
          @printer.example_progress_output(:pending)
          @printer.pending_output(
            notification,
            notification.example.full_description.strip,
            @example_number,
            0
          )
        end

        # Failure outside of example notification
        #
        # @param notification [MessageNotification]
        def message(notification)
          @printer.message_output(notification)
        end

        # Failure examples notification
        #
        # @param notification [ExamplesNotification]
        def dump_failures(notification)
          @printer.store_failed_examples_summary(notification)
        end

        # Pending examples notification
        #
        # @param notification [ExamplesNotification]
        def dump_pending(notification)
          @printer.store_pending_examples_summary(notification)
        end

        # Examples summary notification
        #
        # @param notification [SummaryNotification]
        def dump_summary(notification)
          @printer.summary_output(notification, @seed)
        end
      end
    end
  end
end