Sha256: cbc376f42814244f8bcc979a6bc559e14fadf9c1fb93bf544ac56cebc03b14de

Contents?: true

Size: 1.47 KB

Versions: 25

Compression:

Stored size: 1.47 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Metrics
      # 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 < Base
        include CodeLength

        def on_module(node)
          check_code_length(node)
        end

        def on_casgn(node)
          module_definition?(node) { check_code_length(node) }
        end

        private

        # @!method module_definition?(node)
        def_node_matcher :module_definition?, <<~PATTERN
          (casgn nil? _ ({block numblock} (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

25 entries across 21 versions & 3 rubygems

Version Path
cm-admin-1.5.22 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/metrics/module_length.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/metrics/module_length.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/metrics/module_length.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.31.2/lib/rubocop/cop/metrics/module_length.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.35.1/lib/rubocop/cop/metrics/module_length.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.36.0/lib/rubocop/cop/metrics/module_length.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.31.2/lib/rubocop/cop/metrics/module_length.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.35.1/lib/rubocop/cop/metrics/module_length.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.36.0/lib/rubocop/cop/metrics/module_length.rb
rubocop-1.39.0 lib/rubocop/cop/metrics/module_length.rb
rubocop-1.38.0 lib/rubocop/cop/metrics/module_length.rb
rubocop-1.37.1 lib/rubocop/cop/metrics/module_length.rb
rubocop-1.37.0 lib/rubocop/cop/metrics/module_length.rb
rubocop-1.36.0 lib/rubocop/cop/metrics/module_length.rb
rubocop-1.35.1 lib/rubocop/cop/metrics/module_length.rb
rubocop-1.35.0 lib/rubocop/cop/metrics/module_length.rb
rubocop-1.34.1 lib/rubocop/cop/metrics/module_length.rb
rubocop-1.34.0 lib/rubocop/cop/metrics/module_length.rb
rubocop-1.33.0 lib/rubocop/cop/metrics/module_length.rb
rubocop-1.32.0 lib/rubocop/cop/metrics/module_length.rb