Sha256: f8dce18bbaf77fd67d49c24666751c3f5c3a96b4295653470a5666be5c4089b0

Contents?: true

Size: 1.68 KB

Versions: 25

Compression:

Stored size: 1.68 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Metrics
      # Checks if the length a class 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']
      #
      #   class Foo
      #     ARRAY = [         # +1
      #       1,
      #       2
      #     ]
      #
      #     HASH = {          # +3
      #       key: 'value'
      #     }
      #
      #     MSG = <<~HEREDOC  # +1
      #       Heredoc
      #       content.
      #     HEREDOC
      #   end                 # 5 points
      #
      #
      # NOTE: This cop also applies for `Struct` definitions.
      class ClassLength < Base
        include CodeLength

        def on_class(node)
          check_code_length(node)
        end

        def on_casgn(node)
          parent = node.parent

          if parent&.assignment?
            block_node = parent.children[1]
          elsif parent&.parent&.masgn_type?
            block_node = parent.parent.children[1]
          else
            _scope, _name, block_node = *node
          end

          return unless block_node.respond_to?(:class_definition?) && block_node.class_definition?

          check_code_length(block_node)
        end

        private

        def message(length, max_length)
          format('Class 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/class_length.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/metrics/class_length.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/metrics/class_length.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.31.2/lib/rubocop/cop/metrics/class_length.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.35.1/lib/rubocop/cop/metrics/class_length.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.36.0/lib/rubocop/cop/metrics/class_length.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.31.2/lib/rubocop/cop/metrics/class_length.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.35.1/lib/rubocop/cop/metrics/class_length.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.36.0/lib/rubocop/cop/metrics/class_length.rb
rubocop-1.39.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.38.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.37.1 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.37.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.36.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.35.1 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.35.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.34.1 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.34.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.33.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.32.0 lib/rubocop/cop/metrics/class_length.rb