rubbycop 0.49.0

data/lib/rubbycop/cop/style/mixin_grouping.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Style
+      # This cop checks for grouping of mixins in `class` and `module` bodies.
+      # By default it enforces mixins to be placed in separate declarations,
+      # but it can be configured to enforce grouping them in one declaration.
+      #
+      # @example
+      #
+      #   EnforcedStyle: separated (default)
+      #
+      #   @bad
+      #   class Foo
+      #     include Bar, Qox
+      #   end
+      #
+      #   @good
+      #   class Foo
+      #     include Qox
+      #     include Bar
+      #   end
+      #
+      #   EnforcedStyle: grouped
+      #
+      #   @bad
+      #   class Foo
+      #     extend Bar
+      #     extend Qox
+      #   end
+      #
+      #   @good
+      #   class Foo
+      #     extend Qox, Bar
+      #   end
+      class MixinGrouping < Cop
+        include ConfigurableEnforcedStyle
+
+        MIXIN_METHODS = %i[extend include prepend].freeze
+        MSG = 'Put `%s` mixins in %s.'.freeze
+
+        def on_send(node)
+          return unless node.macro? && MIXIN_METHODS.include?(node.method_name)
+
+          check(node)
+        end
+
+        def autocorrect(node)
+          if separated_style?
+            range = node.loc.expression
+            correction = separate_mixins(node)
+          else
+            mixins = sibling_mixins(node)
+            mixins.unshift(node)
+
+            range = node.loc.expression.join(mixins.last.loc.expression)
+            correction = group_mixins(node, mixins)
+          end
+
+          ->(corrector) { corrector.replace(range, correction) }
+        end
+
+        private
+
+        def check(send_node)
+          if separated_style?
+            check_separated_style(send_node)
+          else
+            check_grouped_style(send_node)
+          end
+        end
+
+        def check_grouped_style(send_node)
+          return if sibling_mixins(send_node).empty?
+
+          add_offense(send_node, :expression)
+        end
+
+        def check_separated_style(send_node)
+          return if send_node.arguments.one?
+
+          add_offense(send_node, :expression)
+        end
+
+        def sibling_mixins(send_node)
+          siblings = send_node.parent.each_child_node(:send)
+                              .reject { |sibling| sibling == send_node }
+
+          siblings.select do |sibling_node|
+            sibling_node.method_name == send_node.method_name
+          end
+        end
+
+        def message(send_node)
+          suffix =
+            separated_style? ? 'separate statements' : 'a single statement'
+
+          format(MSG, send_node.method_name, suffix)
+        end
+
+        def grouped_style?
+          style == :grouped
+        end
+
+        def separated_style?
+          style == :separated
+        end
+
+        def separate_mixins(node)
+          _receiver, mixin, *args = *node
+          args.reverse!
+          first_mixin = String.new("#{mixin} #{args.first.source}")
+
+          args[1..-1].inject(first_mixin) do |replacement, arg|
+            replacement << "\n#{indent(node)}#{mixin} #{arg.source}"
+          end
+        end
+
+        def group_mixins(node, mixins)
+          _receiver, mixin, *_args = *node
+          all_mixin_arguments = mixins.reverse.flat_map do |m|
+            m.arguments.map(&:source)
+          end
+
+          "#{mixin} #{all_mixin_arguments.join(', ')}"
+        end
+
+        def indent(node)
+          ' ' * node.loc.column
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Style
+      # This cops checks for use of `extend self` or `module_function` in a
+      # module.
+      #
+      # Supported styles are: module_function, extend_self.
+      #
+      # @example
+      #
+      #   # Good if EnforcedStyle is module_function
+      #   module Test
+      #     module_function
+      #     ...
+      #   end
+      #
+      #   # Good if EnforcedStyle is extend_self
+      #   module Test
+      #     extend self
+      #     ...
+      #   end
+      #
+      # These offenses are not auto-corrected since there are different
+      # implications to each approach.
+      class ModuleFunction < Cop
+        include ConfigurableEnforcedStyle
+
+        MODULE_FUNCTION_MSG =
+          'Use `module_function` instead of `extend self`.'.freeze
+        EXTEND_SELF_MSG =
+          'Use `extend self` instead of `module_function`.'.freeze
+
+        def_node_matcher :module_function_node?, '(send nil :module_function)'
+        def_node_matcher :extend_self_node?, '(send nil :extend self)'
+
+        def on_module(node)
+          _name, body = *node
+          return unless body && body.begin_type?
+
+          each_wrong_style(body.children) do |child_node, msg|
+            add_offense(child_node, :expression, msg)
+          end
+        end
+
+        private
+
+        def each_wrong_style(nodes)
+          case style
+          when :module_function
+            nodes.each do |node|
+              yield node, MODULE_FUNCTION_MSG if extend_self_node?(node)
+            end
+          when :extend_self
+            nodes.each do |node|
+              yield node, EXTEND_SELF_MSG if module_function_node?(node)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Style
+      # This cop checks for chaining of a block after another block that spans
+      # multiple lines.
+      #
+      # @example
+      #
+      #   Thread.list.find_all do |t|
+      #     t.alive?
+      #   end.map do |t|
+      #     t.object_id
+      #   end
+      class MultilineBlockChain < Cop
+        MSG = 'Avoid multi-line chains of blocks.'.freeze
+
+        def on_block(node)
+          method, _args, _body = *node
+          method.each_node(:send) do |send_node|
+            receiver, _method_name, *_args = *send_node
+            next unless receiver && receiver.block_type?
+
+            # The begin and end could also be braces, but we call the
+            # variables do... and end...
+            do_kw_loc = receiver.loc.begin
+            end_kw_loc = receiver.loc.end
+            next if do_kw_loc.line == end_kw_loc.line
+
+            range = range_between(end_kw_loc.begin_pos,
+                                  method.source_range.end_pos)
+            add_offense(nil, 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/rubbycop/cop/style/multiline_if_modifier.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  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 AutocorrectAlignment
+
+        MSG = 'Favor a normal %s-statement over a modifier' \
+              ' clause in a multiline statement.'.freeze
+
+        def on_if(node)
+          return unless node.modifier_form? && node.body.multiline?
+
+          add_offense(node, :expression, format(MSG, node.keyword))
+        end
+
+        private
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.source_range, to_normal_if(node))
+          end
+        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/rubbycop/cop/style/multiline_if_then.rb

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

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  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`.'.freeze
+
+        def on_or_asgn(node)
+          _lhs, rhs = *node
+
+          return unless bad_rhs?(rhs)
+
+          add_offense(rhs, node.source_range, MSG)
+        end
+
+        private
+
+        def autocorrect(node)
+          lambda do |corrector|
+            if style == :keyword
+              corrector.replace(node.loc.begin, 'begin')
+              corrector.replace(node.loc.end, 'end')
+            else
+              corrector.replace(node.loc.begin, '(')
+              corrector.replace(node.loc.end, ')')
+            end
+          end
+        end
+
+        def bad_rhs?(rhs)
+          return false unless rhs.multiline?
+          if style == :keyword
+            rhs.begin_type?
+          else
+            rhs.kwbegin_type?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubbycop/cop/style/multiline_ternary_operator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RubbyCop
+  module Cop
+    module Style
+      # This cop checks for multi-line ternary op expressions.
+      class MultilineTernaryOperator < Cop
+        MSG = 'Avoid multi-line ternary operators, ' \
+              'use `if` or `unless` instead.'.freeze
+
+        def on_if(node)
+          return unless node.ternary? && node.multiline?
+
+          add_offense(node, :expression)
+        end
+      end
+    end
+  end
+end