Sha256: 1c5e9c5e8bc8fe4de8dd900f5e7bdc7c40e132f55652f30cedeba842b12249d3

Contents?: true

Size: 1.18 KB

Versions: 8

Compression:

Stored size: 1.18 KB

Contents

# frozen_string_literal: true

module Reek
  module Report
    module Formatter
      #
      # Base class for heading formatters.
      # Is responsible for formatting the heading emitted for each examiner
      #
      # @abstract Override {#show_header?} to implement a heading formatter.
      class HeadingFormatterBase
        attr_reader :report_formatter

        def initialize(report_formatter)
          @report_formatter = report_formatter
        end

        # :reek:UtilityFunction
        def show_header?(_examiner)
          raise NotImplementedError
        end

        def header(examiner)
          if show_header?(examiner)
            report_formatter.header examiner
          else
            ''
          end
        end
      end

      #
      # Lists out each examiner, even if it has no smell
      #
      class VerboseHeadingFormatter < HeadingFormatterBase
        def show_header?(_examiner)
          true
        end
      end

      #
      # Lists only smelly examiners
      #
      class QuietHeadingFormatter < HeadingFormatterBase
        # :reek:UtilityFunction
        def show_header?(examiner)
          examiner.smelly?
        end
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
reek-4.8.2 lib/reek/report/formatter/heading_formatter.rb
reek-4.8.1 lib/reek/report/formatter/heading_formatter.rb
reek-4.8.0 lib/reek/report/formatter/heading_formatter.rb
reek-4.7.3 lib/reek/report/formatter/heading_formatter.rb
reek-4.7.2 lib/reek/report/formatter/heading_formatter.rb
reek-4.7.1 lib/reek/report/formatter/heading_formatter.rb
reek-4.7.0 lib/reek/report/formatter/heading_formatter.rb
reek-4.6.2 lib/reek/report/formatter/heading_formatter.rb