rbhint 0.8.5.rc1

data/lib/rubocop/cop/layout/empty_lines_around_block_body.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks if empty lines around the bodies of blocks match
+      # the configuration.
+      #
+      # @example EnforcedStyle: empty_lines
+      #   # good
+      #
+      #   foo do |bar|
+      #
+      #     # ...
+      #
+      #   end
+      #
+      # @example EnforcedStyle: no_empty_lines (default)
+      #   # good
+      #
+      #   foo do |bar|
+      #     # ...
+      #   end
+      class EmptyLinesAroundBlockBody < Cop
+        include EmptyLinesAroundBody
+
+        KIND = 'block'
+
+        def on_block(node)
+          first_line = node.send_node.last_line
+
+          check(node, node.body, adjusted_first_line: first_line)
+        end
+
+        def autocorrect(node)
+          EmptyLineCorrector.correct(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/empty_lines_around_class_body.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks if empty lines around the bodies of classes match
+      # the configuration.
+      #
+      # @example EnforcedStyle: empty_lines
+      #   # good
+      #
+      #   class Foo
+      #
+      #     def bar
+      #       # ...
+      #     end
+      #
+      #   end
+      #
+      # @example EnforcedStyle: empty_lines_except_namespace
+      #   # good
+      #
+      #   class Foo
+      #     class Bar
+      #
+      #       # ...
+      #
+      #     end
+      #   end
+      #
+      # @example EnforcedStyle: empty_lines_special
+      #   # good
+      #   class Foo
+      #
+      #     def bar; end
+      #
+      #   end
+      #
+      # @example EnforcedStyle: beginning_only
+      #   # good
+      #
+      #   class Foo
+      #
+      #     def bar
+      #       # ...
+      #     end
+      #   end
+      #
+      # @example EnforcedStyle: ending_only
+      #   # good
+      #
+      #   class Foo
+      #     def bar
+      #       # ...
+      #     end
+      #
+      #   end
+      #
+      # @example EnforcedStyle: no_empty_lines (default)
+      #   # good
+      #
+      #   class Foo
+      #     def bar
+      #       # ...
+      #     end
+      #   end
+      class EmptyLinesAroundClassBody < Cop
+        include EmptyLinesAroundBody
+
+        KIND = 'class'
+
+        def on_class(node)
+          first_line = node.parent_class.first_line if node.parent_class
+
+          check(node, node.body, adjusted_first_line: first_line)
+        end
+
+        def on_sclass(node)
+          check(node, node.body)
+        end
+
+        def autocorrect(node)
+          EmptyLineCorrector.correct(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/empty_lines_around_exception_handling_keywords.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks if empty lines exist around the bodies of `begin`
+      # sections. This cop doesn't check empty lines at `begin` body
+      # beginning/end and around method definition body.
+      # `Style/EmptyLinesAroundBeginBody` or `Style/EmptyLinesAroundMethodBody`
+      # can be used for this purpose.
+      #
+      # @example
+      #
+      #   # good
+      #
+      #   begin
+      #     do_something
+      #   rescue
+      #     do_something2
+      #   else
+      #     do_something3
+      #   ensure
+      #     do_something4
+      #   end
+      #
+      #   # good
+      #
+      #   def foo
+      #     do_something
+      #   rescue
+      #     do_something2
+      #   end
+      #
+      #   # bad
+      #
+      #   begin
+      #     do_something
+      #
+      #   rescue
+      #
+      #     do_something2
+      #
+      #   else
+      #
+      #     do_something3
+      #
+      #   ensure
+      #
+      #     do_something4
+      #   end
+      #
+      #   # bad
+      #
+      #   def foo
+      #     do_something
+      #
+      #   rescue
+      #
+      #     do_something2
+      #   end
+      class EmptyLinesAroundExceptionHandlingKeywords < Cop
+        include EmptyLinesAroundBody
+
+        MSG = 'Extra empty line detected %<location>s the `%<keyword>s`.'
+
+        def on_def(node)
+          check_body(node.body)
+        end
+        alias on_defs on_def
+
+        def on_kwbegin(node)
+          body, = *node
+          check_body(body)
+        end
+
+        def autocorrect(node)
+          EmptyLineCorrector.correct(node)
+        end
+
+        private
+
+        def check_body(node)
+          locations = keyword_locations(node)
+          locations.each do |loc|
+            line = loc.line
+            keyword = loc.source
+            # below the keyword
+            check_line(style, line, message('after', keyword), &:empty?)
+            # above the keyword
+            check_line(style,
+                       line - 2,
+                       message('before', keyword),
+                       &:empty?)
+          end
+        end
+
+        def message(location, keyword)
+          format(MSG, location: location, keyword: keyword)
+        end
+
+        def style
+          :no_empty_lines
+        end
+
+        def keyword_locations(node)
+          return [] unless node
+
+          case node.type
+          when :rescue
+            keyword_locations_in_rescue(node)
+          when :ensure
+            keyword_locations_in_ensure(node)
+          else
+            []
+          end
+        end
+
+        def keyword_locations_in_rescue(node)
+          _begin_body, *resbodies, _else_body = *node
+          [
+            node.loc.else,
+            *resbodies.map { |body| body.loc.keyword }
+          ].compact
+        end
+
+        def keyword_locations_in_ensure(node)
+          ensure_body, = *node
+          [
+            node.loc.keyword,
+            *keyword_locations(ensure_body)
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/empty_lines_around_method_body.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks if empty lines exist around the bodies of methods.
+      #
+      # @example
+      #
+      #   # good
+      #
+      #   def foo
+      #     # ...
+      #   end
+      #
+      #   # bad
+      #
+      #   def bar
+      #
+      #     # ...
+      #
+      #   end
+      class EmptyLinesAroundMethodBody < Cop
+        include EmptyLinesAroundBody
+
+        KIND = 'method'
+
+        def on_def(node)
+          check(node, node.body)
+        end
+        alias on_defs on_def
+
+        def autocorrect(node)
+          EmptyLineCorrector.correct(node)
+        end
+
+        private
+
+        def style
+          :no_empty_lines
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/empty_lines_around_module_body.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks if empty lines around the bodies of modules match
+      # the configuration.
+      #
+      # @example EnforcedStyle: empty_lines
+      #   # good
+      #
+      #   module Foo
+      #
+      #     def bar
+      #       # ...
+      #     end
+      #
+      #   end
+      #
+      # @example EnforcedStyle: empty_lines_except_namespace
+      #   # good
+      #
+      #   module Foo
+      #     module Bar
+      #
+      #       # ...
+      #
+      #     end
+      #   end
+      #
+      # @example EnforcedStyle: empty_lines_special
+      #   # good
+      #   module Foo
+      #
+      #     def bar; end
+      #
+      #   end
+      #
+      # @example EnforcedStyle: no_empty_lines (default)
+      #   # good
+      #
+      #   module Foo
+      #     def bar
+      #       # ...
+      #     end
+      #   end
+      class EmptyLinesAroundModuleBody < Cop
+        include EmptyLinesAroundBody
+
+        KIND = 'module'
+
+        def on_module(node)
+          check(node, node.body)
+        end
+
+        def autocorrect(node)
+          EmptyLineCorrector.correct(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/layout/end_alignment.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Layout
+      # This cop checks whether the end keywords are aligned properly.
+      #
+      # Three modes are supported through the `EnforcedStyleAlignWith`
+      # configuration parameter:
+      #
+      # If it's set to `keyword` (which is the default), the `end`
+      # shall be aligned with the start of the keyword (if, class, etc.).
+      #
+      # If it's set to `variable` the `end` shall be aligned with the
+      # left-hand-side of the variable assignment, if there is one.
+      #
+      # If it's set to `start_of_line`, the `end` shall be aligned with the
+      # start of the line where the matching keyword appears.
+      #
+      # @example EnforcedStyleAlignWith: keyword (default)
+      #   # bad
+      #
+      #   variable = if true
+      #       end
+      #
+      #   # good
+      #
+      #   variable = if true
+      #              end
+      #
+      #   variable =
+      #     if true
+      #     end
+      #
+      # @example EnforcedStyleAlignWith: variable
+      #   # bad
+      #
+      #   variable = if true
+      #       end
+      #
+      #   # good
+      #
+      #   variable = if true
+      #   end
+      #
+      #   variable =
+      #     if true
+      #     end
+      #
+      # @example EnforcedStyleAlignWith: start_of_line
+      #   # bad
+      #
+      #   variable = if true
+      #       end
+      #
+      #   puts(if true
+      #        end)
+      #
+      #   # good
+      #
+      #   variable = if true
+      #   end
+      #
+      #   puts(if true
+      #   end)
+      #
+      #   variable =
+      #     if true
+      #     end
+      class EndAlignment < Cop
+        include CheckAssignment
+        include EndKeywordAlignment
+        include RangeHelp
+
+        def on_class(node)
+          check_other_alignment(node)
+        end
+
+        def on_module(node)
+          check_other_alignment(node)
+        end
+
+        def on_if(node)
+          check_other_alignment(node) unless node.ternary?
+        end
+
+        def on_while(node)
+          check_other_alignment(node)
+        end
+
+        def on_until(node)
+          check_other_alignment(node)
+        end
+
+        def on_case(node)
+          if node.argument?
+            check_asgn_alignment(node.parent, node)
+          else
+            check_other_alignment(node)
+          end
+        end
+
+        def autocorrect(node)
+          AlignmentCorrector.align_end(processed_source,
+                                       node,
+                                       alignment_node(node))
+        end
+
+        private
+
+        def check_assignment(node, rhs)
+          # If there are method calls chained to the right hand side of the
+          # assignment, we let rhs be the receiver of those method calls before
+          # we check if it's an if/unless/while/until.
+          return unless (rhs = first_part_of_call_chain(rhs))
+          return unless rhs.conditional?
+          return if rhs.if_type? && rhs.ternary?
+
+          check_asgn_alignment(node, rhs)
+        end
+
+        def check_asgn_alignment(outer_node, inner_node)
+          align_with = {
+            keyword: inner_node.loc.keyword,
+            start_of_line: start_line_range(inner_node),
+            variable: asgn_variable_align_with(outer_node, inner_node)
+          }
+
+          check_end_kw_alignment(inner_node, align_with)
+          ignore_node(inner_node)
+        end
+
+        def asgn_variable_align_with(outer_node, inner_node)
+          expr = outer_node.source_range
+
+          if !line_break_before_keyword?(expr, inner_node)
+            range_between(expr.begin_pos, inner_node.loc.keyword.end_pos)
+          else
+            inner_node.loc.keyword
+          end
+        end
+
+        def check_other_alignment(node)
+          align_with = {
+            keyword: node.loc.keyword,
+            variable: node.loc.keyword,
+            start_of_line: start_line_range(node)
+          }
+          check_end_kw_alignment(node, align_with)
+        end
+
+        def alignment_node(node)
+          if style == :keyword
+            node
+          elsif style == :variable
+            alignment_node_for_variable_style(node)
+          else
+            start_line_range(node)
+          end
+        end
+
+        def alignment_node_for_variable_style(node)
+          return node.parent if node.case_type? && node.argument?
+
+          assignment = node.ancestors.find(&:assignment_or_similar?)
+          if assignment && !line_break_before_keyword?(assignment.source_range,
+                                                       node)
+            assignment
+          else
+            # Fall back to 'keyword' style if this node is not on the RHS of an
+            # assignment, or if it is but there's a line break between LHS and
+            # RHS.
+            node
+          end
+        end
+
+        def start_line_range(node)
+          expr   = node.source_range
+          buffer = expr.source_buffer
+          source = buffer.source_line(expr.line)
+          range  = buffer.line_range(expr.line)
+
+          range_between(range.begin_pos + (source =~ /\S/),
+                        range.begin_pos + (source =~ /\s*\z/))
+        end
+      end
+    end
+  end
+end