rubocop 0.87.1

data/lib/rubocop/cop/style/mixin_usage.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks that `include`, `extend` and `prepend` statements appear
+      # inside classes and modules, not at the top level, so as to not affect
+      # the behavior of `Object`.
+      #
+      # @example
+      #   # bad
+      #   include M
+      #
+      #   class C
+      #   end
+      #
+      #   # bad
+      #   extend M
+      #
+      #   class C
+      #   end
+      #
+      #   # bad
+      #   prepend M
+      #
+      #   class C
+      #   end
+      #
+      #   # good
+      #   class C
+      #     include M
+      #   end
+      #
+      #   # good
+      #   class C
+      #     extend M
+      #   end
+      #
+      #   # good
+      #   class C
+      #     prepend M
+      #   end
+      class MixinUsage < Cop
+        MSG = '`%<statement>s` is used at the top level. Use inside `class` ' \
+              'or `module`.'
+
+        def_node_matcher :include_statement, <<~PATTERN
+          (send nil? ${:include :extend :prepend}
+            const)
+        PATTERN
+
+        def_node_matcher :wrapped_macro_scope?, <<~PATTERN
+          {({sclass class module block} ... ({begin if} ...))}
+        PATTERN
+
+        def on_send(node)
+          include_statement(node) do |statement|
+            return if node.argument? ||
+                      accepted_include?(node) ||
+                      belongs_to_class_or_module?(node)
+
+            add_offense(node, message: format(MSG, statement: statement))
+          end
+        end
+
+        private
+
+        def accepted_include?(node)
+          node.parent && (node.macro? || ascend_macro_scope?(node.parent))
+        end
+
+        def ascend_macro_scope?(ancestor)
+          return true if wrapped_macro_scope?(ancestor)
+
+          ancestor.parent && ascend_macro_scope?(ancestor.parent)
+        end
+
+        def belongs_to_class_or_module?(node)
+          if !node.parent
+            false
+          else
+            return true if node.parent.class_type? || node.parent.module_type?
+
+            belongs_to_class_or_module?(node.parent)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/module_function.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for use of `extend self` or `module_function` in a
+      # module.
+      #
+      # Supported styles are: module_function, extend_self, forbidden.
+      #
+      # @example EnforcedStyle: module_function (default)
+      #   # bad
+      #   module Test
+      #     extend self
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   module Test
+      #     module_function
+      #     # ...
+      #   end
+      #
+      # In case there are private methods, the cop won't be activated.
+      # Otherwise, it forces to change the flow of the default code.
+      #
+      # @example EnforcedStyle: module_function (default)
+      #   # good
+      #   module Test
+      #     extend self
+      #     # ...
+      #     private
+      #     # ...
+      #   end
+      #
+      # @example EnforcedStyle: extend_self
+      #   # bad
+      #   module Test
+      #     module_function
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   module Test
+      #     extend self
+      #     # ...
+      #   end
+      #
+      # The option `forbidden` prohibits the usage of both styles.
+      #
+      # @example EnforcedStyle: forbidden
+      #   # bad
+      #   module Test
+      #     module_function
+      #     # ...
+      #   end
+      #
+      #   # bad
+      #   module Test
+      #     extend self
+      #     # ...
+      #   end
+      #
+      #   # bad
+      #   module Test
+      #     extend self
+      #     # ...
+      #     private
+      #     # ...
+      #   end
+      #
+      # These offenses are not safe to auto-correct since there are different
+      # implications to each approach.
+      class ModuleFunction < Cop
+        include ConfigurableEnforcedStyle
+
+        MODULE_FUNCTION_MSG =
+          'Use `module_function` instead of `extend self`.'
+        EXTEND_SELF_MSG =
+          'Use `extend self` instead of `module_function`.'
+        FORBIDDEN_MSG =
+          'Do not use `module_function` or `extend self`.'
+
+        def_node_matcher :module_function_node?, '(send nil? :module_function)'
+        def_node_matcher :extend_self_node?, '(send nil? :extend self)'
+        def_node_matcher :private_directive?, '(send nil? :private ...)'
+
+        def on_module(node)
+          return unless node.body&.begin_type?
+
+          each_wrong_style(node.body.children) do |child_node|
+            add_offense(child_node)
+          end
+        end
+
+        def autocorrect(node)
+          return if style == :forbidden
+
+          lambda do |corrector|
+            if extend_self_node?(node)
+              corrector.replace(node, 'module_function')
+            else
+              corrector.replace(node, 'extend self')
+            end
+          end
+        end
+
+        private
+
+        def each_wrong_style(nodes, &block)
+          case style
+          when :module_function
+            check_module_function(nodes, &block)
+          when :extend_self
+            check_extend_self(nodes, &block)
+          when :forbidden
+            check_forbidden(nodes, &block)
+          end
+        end
+
+        def check_module_function(nodes)
+          private_directive = nodes.any? { |node| private_directive?(node) }
+
+          nodes.each do |node|
+            yield node if extend_self_node?(node) && !private_directive
+          end
+        end
+
+        def check_extend_self(nodes)
+          nodes.each do |node|
+            yield node if module_function_node?(node)
+          end
+        end
+
+        def check_forbidden(nodes)
+          nodes.each do |node|
+            yield node if extend_self_node?(node)
+            yield node if module_function_node?(node)
+          end
+        end
+
+        def message(_node)
+          return FORBIDDEN_MSG if style == :forbidden
+
+          style == :module_function ? MODULE_FUNCTION_MSG : EXTEND_SELF_MSG
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/multiline_block_chain.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for chaining of a block after another block that spans
+      # multiple lines.
+      #
+      # @example
+      #
+      #   # bad
+      #   Thread.list.select do |t|
+      #     t.alive?
+      #   end.map do |t|
+      #     t.object_id
+      #   end
+      #
+      #   # good
+      #   alive_threads = Thread.list.select do |t|
+      #     t.alive?
+      #   end
+      #   alive_threads.map do |t|
+      #     t.object_id
+      #   end
+      class MultilineBlockChain < Cop
+        include RangeHelp
+
+        MSG = 'Avoid multi-line chains of blocks.'
+
+        def on_block(node)
+          node.send_node.each_node(:send) do |send_node|
+            receiver = send_node.receiver
+
+            next unless receiver&.block_type? && receiver&.multiline?
+
+            range = range_between(receiver.loc.end.begin_pos,
+                                  node.send_node.source_range.end_pos)
+
+            add_offense(nil, location: range)
+
+            # Done. If there are more blocks in the chain, they will be
+            # found by subsequent calls to on_block.
+            break
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/multiline_if_modifier.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for uses of if/unless modifiers with multiple-lines bodies.
+      #
+      # @example
+      #
+      #   # bad
+      #   {
+      #     result: 'this should not happen'
+      #   } unless cond
+      #
+      #   # good
+      #   { result: 'ok' } if cond
+      class MultilineIfModifier < Cop
+        include StatementModifier
+        include Alignment
+
+        MSG = 'Favor a normal %<keyword>s-statement over a modifier' \
+              ' clause in a multiline statement.'
+
+        def on_if(node)
+          return unless node.modifier_form? && node.body.multiline?
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node, to_normal_if(node))
+          end
+        end
+
+        private
+
+        def message(node)
+          format(MSG, keyword: node.keyword)
+        end
+
+        def to_normal_if(node)
+          indented_body = indented_body(node.body, node)
+          condition = "#{node.keyword} #{node.condition.source}"
+          indented_end = "#{offset(node)}end"
+
+          [condition, indented_body, indented_end].join("\n")
+        end
+
+        def configured_indentation_width
+          super || 2
+        end
+
+        def indented_body(body, node)
+          body_source = "#{offset(node)}#{body.source}"
+          body_source.each_line.map do |line|
+            if line == "\n"
+              line
+            else
+              line.sub(/^\s{#{offset(node).length}}/, indentation(node))
+            end
+          end.join
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/multiline_if_then.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for uses of the `then` keyword in multi-line if statements.
+      #
+      # @example
+      #   # bad
+      #   # This is considered bad practice.
+      #   if cond then
+      #   end
+      #
+      #   # good
+      #   # If statements can contain `then` on the same line.
+      #   if cond then a
+      #   elsif cond then b
+      #   end
+      class MultilineIfThen < Cop
+        include OnNormalIfUnless
+        include RangeHelp
+
+        NON_MODIFIER_THEN = /then\s*(#.*)?$/.freeze
+
+        MSG = 'Do not use `then` for multi-line `%<keyword>s`.'
+
+        def on_normal_if_unless(node)
+          return unless non_modifier_then?(node)
+
+          add_offense(node, location: :begin,
+                            message: format(MSG, keyword: node.keyword))
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(
+              range_with_surrounding_space(range: node.loc.begin, side: :left)
+            )
+          end
+        end
+
+        private
+
+        def non_modifier_then?(node)
+          NON_MODIFIER_THEN.match?(node.loc.begin&.source_line)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/multiline_memoization.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks expressions wrapping styles for multiline memoization.
+      #
+      # @example EnforcedStyle: keyword (default)
+      #   # bad
+      #   foo ||= (
+      #     bar
+      #     baz
+      #   )
+      #
+      #   # good
+      #   foo ||= begin
+      #     bar
+      #     baz
+      #   end
+      #
+      # @example EnforcedStyle: braces
+      #   # bad
+      #   foo ||= begin
+      #     bar
+      #     baz
+      #   end
+      #
+      #   # good
+      #   foo ||= (
+      #     bar
+      #     baz
+      #   )
+      class MultilineMemoization < Cop
+        include ConfigurableEnforcedStyle
+
+        MSG = 'Wrap multiline memoization blocks in `begin` and `end`.'
+
+        def on_or_asgn(node)
+          _lhs, rhs = *node
+
+          return unless bad_rhs?(rhs)
+
+          add_offense(rhs, location: node.source_range)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            if style == :keyword
+              keyword_autocorrect(node, corrector)
+            else
+              corrector.replace(node.loc.begin, '(')
+              corrector.replace(node.loc.end, ')')
+            end
+          end
+        end
+
+        private
+
+        def bad_rhs?(rhs)
+          return false unless rhs.multiline?
+
+          if style == :keyword
+            rhs.begin_type?
+          else
+            rhs.kwbegin_type?
+          end
+        end
+
+        def keyword_autocorrect(node, corrector)
+          node_buf = node.source_range.source_buffer
+          corrector.replace(node.loc.begin, keyword_begin_str(node, node_buf))
+          corrector.replace(node.loc.end, keyword_end_str(node, node_buf))
+        end
+
+        def keyword_begin_str(node, node_buf)
+          indent = config.for_cop('Layout/IndentationWidth')['Width'] || 2
+          if node_buf.source[node.loc.begin.end_pos] == "\n"
+            'begin'
+          else
+            "begin\n" + (' ' * (node.loc.column + indent))
+          end
+        end
+
+        def keyword_end_str(node, node_buf)
+          if /[^\s)]/.match?(node_buf.source_line(node.loc.end.line))
+            "\n" + (' ' * node.loc.column) + 'end'
+          else
+            'end'
+          end
+        end
+      end
+    end
+  end
+end