Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Metrics
      # This hint checks if the length a module exceeds some maximum value.
      # Comment lines can optionally be ignored.
      # The maximum allowed length is configurable.
      #
      # You can set literals you want to fold with `CountAsOne`.
      # Available are: 'array', 'hash', and 'heredoc'. Each literal
      # will be counted as one line regardless of its actual size.
      #
      # @example CountAsOne: ['array', 'heredoc']
      #
      #   module M
      #     ARRAY = [         # +1
      #       1,
      #       2
      #     ]
      #
      #     HASH = {          # +3
      #       key: 'value'
      #     }
      #
      #     MSG = <<~HEREDOC  # +1
      #       Heredoc
      #       content.
      #     HEREDOC
      #   end                 # 5 points
      #
      class ModuleLength < Cop
        include TooManyLines

        def on_module(node)
          check_code_length(node)
        end

        def on_casgn(node)
          module_definition?(node) do
            check_code_length(node)
          end
        end

        private

        def_node_matcher :module_definition?, <<~PATTERN
          (casgn nil? _ (block (send (const {nil? cbase} :Module) :new) ...))
        PATTERN

        def message(length, max_length)
          format('Module has too many lines. [%<length>d/%<max>d]',
                 length: length,
                 max: max_length)
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rbhint-0.87.1.rc1	lib/rubocop/cop/metrics/module_length.rb