rubbycop 0.49.0

data/lib/rubbycop/cop/message_annotator.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    # Message Annotator class annotates a basic offense message
+    # based on params passed into initializer.
+    #
+    # @see #initialize
+    #
+    # @example
+    #   RubbyCop::Cop::MessageAnnotator.new(
+    #     config, cop_config, @options
+    #   ).annotate('message', 'Cop/CopName')
+    #  #=> 'Cop/CopName: message (http://example.org/styleguide)'
+    class MessageAnnotator
+      attr_reader :options, :config, :cop_config
+
+      @style_guide_urls = {}
+
+      class << self
+        attr_reader :style_guide_urls
+      end
+
+      # @param config [RubbyCop::Config] Check configs for all cops
+      #   @note Message Annotator specifically checks the
+      #     following config options for_all_cops
+      #     :StyleGuideBaseURL [String] URL for styleguide
+      #     :DisplayStyleGuide [Boolean] Include styleguide and reference URLs
+      #     :ExtraDetails [Boolean] Include cop details
+      #     :DisplayCopNames [Boolean] Include cop name
+      #
+      # @param [Hash] cop_config configs for specific cop, from config#for_cop
+      # @option cop_config [String] :StyleGuide Extension of base styleguide URL
+      # @option cop_config [String] :Reference Full reference URL
+      # @option cop_config [String] :Details
+      #
+      # @param [Hash, nil] options optional
+      # @option options [Boolean] :display_style_guide
+      #   Include style guide and reference URLs
+      # @option options [Boolean] :extra_details
+      #   Include cop specific details
+      # @option options [Boolean] :debug
+      #   Include debug output
+      # @option options [Boolean] :display_cop_names
+      #   Include cop name
+      def initialize(config, cop_config, options)
+        @config = config
+        @cop_config = cop_config || {}
+        @options = options
+      end
+
+      # Returns the annotated message,
+      # based on params passed into initializer
+      #
+      # @return [String] annotated message
+      def annotate(message, name)
+        message = "#{name}: #{message}" if display_cop_names?
+        message += " #{details}" if extra_details? && details
+        if display_style_guide?
+          links = urls.join(', ')
+          message = "#{message} (#{links})"
+        end
+        message
+      end
+
+      def urls
+        [style_guide_url, reference_url].compact
+      end
+
+      private
+
+      def style_guide_url
+        url = cop_config['StyleGuide']
+        return nil if url.nil? || url.empty?
+
+        self.class.style_guide_urls[url] ||= begin
+          base_url = config.for_all_cops['StyleGuideBaseURL']
+          if base_url.nil? || base_url.empty?
+            url
+          else
+            URI.join(base_url, url).to_s
+          end
+        end
+      end
+
+      def display_style_guide?
+        (options[:display_style_guide] ||
+         config.for_all_cops['DisplayStyleGuide']) &&
+          !urls.empty?
+      end
+
+      def reference_url
+        url = cop_config['Reference']
+        url.nil? || url.empty? ? nil : url
+      end
+
+      def extra_details?
+        options[:extra_details] || config.for_all_cops['ExtraDetails']
+      end
+
+      def debug?
+        options[:debug]
+      end
+
+      def display_cop_names?
+        debug? || options[:display_cop_names] ||
+          config.for_all_cops['DisplayCopNames']
+      end
+
+      def details
+        details = cop_config && cop_config['Details']
+        details.nil? || details.empty? ? nil : details
+      end
+    end
+  end
+end

data/lib/rubbycop/cop/metrics/abc_size.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Metrics
+      # This cop checks that the ABC size of methods is not higher than the
+      # configured maximum. The ABC size is based on assignments, branches
+      # (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric
+      class AbcSize < Cop
+        include MethodComplexity
+
+        MSG = 'Assignment Branch Condition size for %s is too high. ' \
+              '[%.4g/%.4g]'.freeze
+        BRANCH_NODES = %i[send csend].freeze
+        CONDITION_NODES = CyclomaticComplexity::COUNTED_NODES.freeze
+
+        private
+
+        def complexity(node)
+          assignment = 0
+          branch = 0
+          condition = 0
+
+          node.each_node do |child|
+            if child.assignment?
+              assignment += 1
+            elsif BRANCH_NODES.include?(child.type)
+              branch += 1
+            elsif CONDITION_NODES.include?(child.type)
+              condition += 1
+            end
+          end
+
+          Math.sqrt(assignment**2 + branch**2 + condition**2).round(2)
+        end
+      end
+    end
+  end
+end

data/lib/rubbycop/cop/metrics/block_length.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Metrics
+      # This cop checks if the length of a block exceeds some maximum value.
+      # Comment lines can optionally be ignored.
+      # The maximum allowed length is configurable.
+      # The cop can be configured to ignore blocks passed to certain methods.
+      class BlockLength < Cop
+        include TooManyLines
+
+        LABEL = 'Block'.freeze
+
+        def on_block(node)
+          return if excluded_methods.include?(node.method_name.to_s)
+          check_code_length(node)
+        end
+
+        private
+
+        def excluded_methods
+          cop_config['ExcludedMethods'] || []
+        end
+
+        def cop_label
+          LABEL
+        end
+      end
+    end
+  end
+end

data/lib/rubbycop/cop/metrics/block_nesting.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Metrics
+      # This cop checks for excessive nesting of conditional and looping
+      # constructs.
+      #
+      # You can configure if blocks are considered using the `CountBlocks`
+      # option. When set to `false` (the default) blocks are not counted
+      # towards the nesting level. Set to `true` to count blocks as well.
+      #
+      # The maximum level of nesting allowed is configurable.
+      class BlockNesting < Cop
+        include ConfigurableMax
+
+        NESTING_BLOCKS = %i[
+          case if while while_post
+          until until_post for resbody
+        ].freeze
+
+        def investigate(processed_source)
+          return unless processed_source.ast
+          max = cop_config['Max']
+          check_nesting_level(processed_source.ast, max, 0)
+        end
+
+        private
+
+        def check_nesting_level(node, max, current_level)
+          if consider_node?(node)
+            current_level += 1 unless node.if_type? && node.elsif?
+            if current_level > max
+              self.max = current_level
+              unless part_of_ignored_node?(node)
+                add_offense(node, :expression, message(max)) do
+                  ignore_node(node)
+                end
+              end
+            end
+          end
+
+          node.each_child_node do |child_node|
+            check_nesting_level(child_node, max, current_level)
+          end
+        end
+
+        def consider_node?(node)
+          return true if NESTING_BLOCKS.include?(node.type)
+
+          count_blocks? && node.block_type?
+        end
+
+        def message(max)
+          "Avoid more than #{max} levels of block nesting."
+        end
+
+        def count_blocks?
+          cop_config['CountBlocks']
+        end
+      end
+    end
+  end
+end

data/lib/rubbycop/cop/metrics/class_length.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Metrics
+      # This cop checks if the length a class exceeds some maximum value.
+      # Comment lines can optionally be ignored.
+      # The maximum allowed length is configurable.
+      class ClassLength < Cop
+        include ClassishLength
+
+        def on_class(node)
+          check_code_length(node)
+        end
+
+        private
+
+        def message(length, max_length)
+          format('Class has too many lines. [%d/%d]', length, max_length)
+        end
+      end
+    end
+  end
+end

data/lib/rubbycop/cop/metrics/cyclomatic_complexity.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Metrics
+      # This cop checks that the cyclomatic complexity of methods is not higher
+      # than the configured maximum. The cyclomatic complexity is the number of
+      # linearly independent paths through a method. The algorithm counts
+      # decision points and adds one.
+      #
+      # An if statement (or unless or ?:) increases the complexity by one. An
+      # else branch does not, since it doesn't add a decision point. The &&
+      # operator (or keyword and) can be converted to a nested if statement,
+      # and ||/or is shorthand for a sequence of ifs, so they also add one.
+      # Loops can be said to have an exit condition, so they add one.
+      class CyclomaticComplexity < Cop
+        include MethodComplexity
+
+        MSG = 'Cyclomatic complexity for %s is too high. [%d/%d]'.freeze
+        COUNTED_NODES = %i[if while until for
+                           rescue when and or].freeze
+
+        private
+
+        def complexity_score_for(_node)
+          1
+        end
+      end
+    end
+  end
+end

data/lib/rubbycop/cop/metrics/line_length.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module RubbyCop
+  module Cop
+    module Metrics
+      # This cop checks the length of lines in the source code.
+      # The maximum length is configurable.
+      class LineLength < Cop
+        include ConfigurableMax
+        include IgnoredPattern
+
+        MSG = 'Line is too long. [%d/%d]'.freeze
+
+        def investigate(processed_source)
+          heredocs = extract_heredocs(processed_source.ast) if allow_heredoc?
+          processed_source.lines.each_with_index do |line, index|
+            check_line(line, index, heredocs)
+          end
+        end
+
+        private
+
+        def check_line(line, index, heredocs)
+          return if line.length <= max
+          return if ignored_line?(line, index, heredocs)
+
+          if ignore_cop_directives? && directive_on_source_line?(index)
+            return check_directive_line(line, index)
+          end
+          return check_uri_line(line, index) if allow_uri?
+
+          register_offense(
+            source_range(processed_source.buffer, index + 1, 0...line.length),
+            line
+          )
+        end
+
+        def ignored_line?(line, index, heredocs)
+          matches_ignored_pattern?(line) ||
+            heredocs && line_in_whitelisted_heredoc?(heredocs, index.succ)
+        end
+
+        def register_offense(loc, line)
+          message = format(MSG, line.length, max)
+          add_offense(nil, loc, message) { self.max = line.length }
+        end
+
+        def excess_range(uri_range, line, index)
+          excessive_position = if uri_range && uri_range.begin < max
+                                 uri_range.end
+                               else
+                                 max
+                               end
+
+          source_range(processed_source.buffer, index + 1,
+                       excessive_position...(line.length))
+        end
+
+        def max
+          cop_config['Max']
+        end
+
+        def allow_heredoc?
+          allowed_heredoc
+        end
+
+        def allowed_heredoc
+          cop_config['AllowHeredoc']
+        end
+
+        def extract_heredocs(ast)
+          return [] unless ast
+          ast.each_node.with_object([]) do |node, heredocs|
+            next unless node.location.is_a?(Parser::Source::Map::Heredoc)
+            body = node.location.heredoc_body
+            delimiter = node.location.heredoc_end.source.strip
+            heredocs << [body.first_line...body.last_line, delimiter]
+          end
+        end
+
+        def line_in_whitelisted_heredoc?(heredocs, line_number)
+          heredocs.any? do |range, delimiter|
+            range.cover?(line_number) &&
+              (allowed_heredoc == true || allowed_heredoc.include?(delimiter))
+          end
+        end
+
+        def allow_uri?
+          cop_config['AllowURI']
+        end
+
+        def ignore_cop_directives?
+          cop_config['IgnoreCopDirectives']
+        end
+
+        def allowed_uri_position?(line, uri_range)
+          uri_range.begin < max && uri_range.end == line.length
+        end
+
+        def find_excessive_uri_range(line)
+          last_uri_match = match_uris(line).last
+          return nil unless last_uri_match
+          begin_position, end_position = last_uri_match.offset(0)
+          return nil if begin_position < max && end_position < max
+          begin_position...end_position
+        end
+
+        def match_uris(string)
+          matches = []
+          string.scan(uri_regexp) do
+            matches << $LAST_MATCH_INFO if valid_uri?($LAST_MATCH_INFO[0])
+          end
+          matches
+        end
+
+        def valid_uri?(uri_ish_string)
+          URI.parse(uri_ish_string)
+          true
+        rescue
+          false
+        end
+
+        def uri_regexp
+          @regexp ||= URI::Parser.new.make_regexp(cop_config['URISchemes'])
+        end
+
+        def check_directive_line(line, index)
+          return if line_length_without_directive(line) <= max
+
+          range = max..(line_length_without_directive(line) - 1)
+          register_offense(
+            source_range(
+              processed_source.buffer,
+              index + 1,
+              range
+            ),
+            line
+          )
+        end
+
+        def directive_on_source_line?(index)
+          source_line_number = index + processed_source.buffer.first_line
+          comment =
+            processed_source
+            .comments
+            .detect { |e| e.location.line == source_line_number }
+
+          return false unless comment
+          comment.text.match(CommentConfig::COMMENT_DIRECTIVE_REGEXP)
+        end
+
+        def line_length_without_directive(line)
+          before_comment, = line.split(CommentConfig::COMMENT_DIRECTIVE_REGEXP)
+          before_comment.rstrip.length
+        end
+
+        def check_uri_line(line, index)
+          uri_range = find_excessive_uri_range(line)
+          return if uri_range && allowed_uri_position?(line, uri_range)
+
+          register_offense(excess_range(uri_range, line, index), line)
+        end
+      end
+    end
+  end
+end