Sha256: e6a875872fe4a704c5f5a9bac8a98a09278268fb5c978f61f22802a5f5ad6eba

Contents?: true

Size: 1.51 KB

Versions: 31

Compression:

Stored size: 1.51 KB

Contents

# frozen_string_literal: true

module Reek
  module Report
    module ProgressFormatter
      #
      # Base class for progress formatters.
      # Is responsible for formatting the progress emitted for each examiner
      #
      # @abstract Override {#header, #progress, #footer} to implement a progress formatter.
      class Base
        attr_reader :sources_count

        def initialize(sources_count)
          @sources_count = sources_count
        end

        def header
          raise NotImplementedError
        end

        def progress(_examiner)
          raise NotImplementedError
        end

        def footer
          raise NotImplementedError
        end
      end

      #
      # Shows the status of each source as either a dot (.) or an S
      #
      class Dots < Base
        NO_WARNINGS_COLOR = :green
        WARNINGS_COLOR = :red

        def header
          "Inspecting #{sources_count} file(s):\n"
        end

        def progress(examiner)
          examiner.smelly? ? display_smelly : display_clean
        end

        def footer
          "\n\n"
        end

        private

        def display_clean
          Rainbow('.').color(NO_WARNINGS_COLOR)
        end

        def display_smelly
          Rainbow('S').color(WARNINGS_COLOR)
        end
      end

      #
      # Does not show progress
      #
      class Quiet < Base
        def header
          ''
        end

        def progress(_examiner)
          ''
        end

        def footer
          ''
        end
      end
    end
  end
end

Version data entries

31 entries across 29 versions & 2 rubygems

Version Path
reek-5.3.1 lib/reek/report/progress_formatter.rb
reek-5.3.0 lib/reek/report/progress_formatter.rb
config_gems_initialization_aim-0.1.4 vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/lib/reek/report/progress_formatter.rb
config_gems_initialization_aim-0.1.4 vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/lib/reek/report/progress_formatter.rb
config_gems_initialization_aim-0.1.3 vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/lib/reek/report/progress_formatter.rb
config_gems_initialization_aim-0.1.3 vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/lib/reek/report/progress_formatter.rb
reek-5.2.0 lib/reek/report/progress_formatter.rb
reek-5.1.0 lib/reek/report/progress_formatter.rb
reek-5.0.2 lib/reek/report/progress_formatter.rb
reek-5.0.1 lib/reek/report/progress_formatter.rb
reek-5.0.0 lib/reek/report/progress_formatter.rb