Sha256: b79a5d7f7a3f3d3ce269137e1e7398eeadfab03973d1b35f0c9999f5a403d050

Contents?: true

Size: 1.8 KB

Versions: 15

Compression:

Stored size: 1.8 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Metrics
      # Checks if the length of a class exceeds some maximum value.
      # Comment lines can optionally be ignored.
      # The maximum allowed length is configurable.
      #
      # You can set constructs you want to fold with `CountAsOne`.
      # Available are: 'array', 'hash', 'heredoc', and 'method_call'. Each construct
      # will be counted as one line regardless of its actual size.
      #
      # @example CountAsOne: ['array', 'heredoc', 'method_call']
      #
      #   class Foo
      #     ARRAY = [         # +1
      #       1,
      #       2
      #     ]
      #
      #     HASH = {          # +3
      #       key: 'value'
      #     }
      #
      #     MSG = <<~HEREDOC  # +1
      #       Heredoc
      #       content.
      #     HEREDOC
      #
      #     foo(              # +1
      #       1,
      #       2
      #     )
      #   end                 # 6 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

15 entries across 15 versions & 3 rubygems

Version Path
rubocop-1.49.0 lib/rubocop/cop/metrics/class_length.rb
call_your_name-0.1.0 vendor/bundle/ruby/3.1.0/gems/rubocop-1.48.1/lib/rubocop/cop/metrics/class_length.rb
rubocop-1.48.1 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.48.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.47.0 lib/rubocop/cop/metrics/class_length.rb
zilla-0.2.0 vendor/bundle/ruby/3.2.0/gems/rubocop-1.46.0/lib/rubocop/cop/metrics/class_length.rb
rubocop-1.46.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.45.1 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.45.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.44.1 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.44.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.43.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.42.0 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.41.1 lib/rubocop/cop/metrics/class_length.rb
rubocop-1.41.0 lib/rubocop/cop/metrics/class_length.rb