rbhint 0.8.5.rc1

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for uses of the case equality operator(===).
+      #
+      # @example
+      #   # bad
+      #   Array === something
+      #   (1..100) === 7
+      #   /something/ === some_string
+      #
+      #   # good
+      #   something.is_a?(Array)
+      #   (1..100).include?(7)
+      #   some_string =~ /something/
+      #
+      # @example AllowOnConstant
+      #   # Style/CaseEquality:
+      #   #   AllowOnConstant: true
+      #
+      #   # bad
+      #   (1..100) === 7
+      #   /something/ === some_string
+      #
+      #   # good
+      #   Array === something
+      #   (1..100).include?(7)
+      #   some_string =~ /something/
+      #
+      class CaseEquality < Cop
+        MSG = 'Avoid the use of the case equality operator `===`.'
+
+        def_node_matcher :case_equality?, '(send #const? :=== _)'
+
+        def on_send(node)
+          case_equality?(node) { add_offense(node, location: :selector) }
+        end
+
+        private
+
+        def const?(node)
+          if cop_config.fetch('AllowOnConstant', false)
+            !node&.const_type?
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for uses of the character literal ?x.
+      #
+      # @example
+      #   # bad
+      #   ?x
+      #
+      #   # good
+      #   'x'
+      #
+      #   # good
+      #   ?\C-\M-d
+      class CharacterLiteral < Cop
+        include StringHelp
+
+        MSG = 'Do not use the character literal - ' \
+              'use string literal instead.'
+
+        def offense?(node)
+          # we don't register an offense for things like ?\C-\M-d
+          node.loc.begin.is?('?') &&
+            node.source.size.between?(2, 3)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            string = node.source[1..-1]
+
+            # special character like \n
+            # or ' which needs to use "" or be escaped.
+            if string.length == 2 || string == "'"
+              corrector.replace(node, %("#{string}"))
+            elsif string.length == 1 # normal character
+              corrector.replace(node, "'#{string}'")
+            end
+          end
+        end
+
+        # Dummy implementation of method in ConfigurableEnforcedStyle that is
+        # called from StringHelp.
+        def opposite_style_detected; end
+
+        # Dummy implementation of method in ConfigurableEnforcedStyle that is
+        # called from StringHelp.
+        def correct_style_detected; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks the style of children definitions at classes and
+      # modules. Basically there are two different styles:
+      #
+      # @example EnforcedStyle: nested (default)
+      #   # good
+      #   # have each child on its own line
+      #   class Foo
+      #     class Bar
+      #     end
+      #   end
+      #
+      # @example EnforcedStyle: compact
+      #   # good
+      #   # combine definitions as much as possible
+      #   class Foo::Bar
+      #   end
+      #
+      # The compact style is only forced for classes/modules with one child.
+      class ClassAndModuleChildren < Cop
+        include ConfigurableEnforcedStyle
+        include RangeHelp
+
+        NESTED_MSG = 'Use nested module/class definitions instead of ' \
+                     'compact style.'
+        COMPACT_MSG = 'Use compact module/class definition instead of ' \
+                      'nested style.'
+
+        def on_class(node)
+          return if node.parent_class && style != :nested
+
+          check_style(node, node.body)
+        end
+
+        def on_module(node)
+          check_style(node, node.body)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            return if node.class_type? && node.parent_class && style != :nested
+
+            nest_or_compact(corrector, node)
+          end
+        end
+
+        private
+
+        def nest_or_compact(corrector, node)
+          if style == :nested
+            nest_definition(corrector, node)
+          else
+            compact_definition(corrector, node)
+          end
+        end
+
+        def nest_definition(corrector, node)
+          padding = ((' ' * indent_width) + leading_spaces(node)).to_s
+          padding_for_trailing_end = padding.sub(' ' * node.loc.end.column, '')
+
+          replace_keyword_with_module(corrector, node)
+          split_on_double_colon(corrector, node, padding)
+          add_trailing_end(corrector, node, padding_for_trailing_end)
+        end
+
+        def replace_keyword_with_module(corrector, node)
+          corrector.replace(node.loc.keyword, 'module')
+        end
+
+        def split_on_double_colon(corrector, node, padding)
+          children_definition = node.children.first
+          range = range_between(children_definition.loc.double_colon.begin_pos,
+                                children_definition.loc.double_colon.end_pos)
+          replacement = "\n#{padding}#{node.loc.keyword.source} "
+
+          corrector.replace(range, replacement)
+        end
+
+        def add_trailing_end(corrector, node, padding)
+          replacement = "#{padding}end\n#{leading_spaces(node)}end"
+          corrector.replace(node.loc.end, replacement)
+        end
+
+        def compact_definition(corrector, node)
+          compact_node(corrector, node)
+          remove_end(corrector, node.body)
+        end
+
+        def compact_node(corrector, node)
+          replacement = "#{node.body.type} #{compact_identifier_name(node)}"
+          range = range_between(node.loc.keyword.begin_pos,
+                                node.body.loc.name.end_pos)
+          corrector.replace(range, replacement)
+        end
+
+        def compact_identifier_name(node)
+          "#{node.identifier.const_name}::" \
+            "#{node.body.children.first.const_name}"
+        end
+
+        def remove_end(corrector, body)
+          range = range_between(
+            body.loc.end.begin_pos - leading_spaces(body).size,
+            body.loc.end.end_pos + 1
+          )
+          corrector.remove(range)
+        end
+
+        def leading_spaces(node)
+          node.source_range.source_line[/\A\s*/]
+        end
+
+        def indent_width
+          @config.for_cop('Layout/IndentationWidth')['Width'] || 2
+        end
+
+        def check_style(node, body)
+          if style == :nested
+            check_nested_style(node)
+          else
+            check_compact_style(node, body)
+          end
+        end
+
+        def check_nested_style(node)
+          return unless compact_node_name?(node)
+
+          add_offense(node, location: :name, message: NESTED_MSG)
+        end
+
+        def check_compact_style(node, body)
+          return unless one_child?(body) && !compact_node_name?(node)
+
+          add_offense(node, location: :name, message: COMPACT_MSG)
+        end
+
+        def one_child?(body)
+          body && %i[module class].include?(body.type)
+        end
+
+        def compact_node_name?(node)
+          node.loc.name.source =~ /::/
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop enforces consistent use of `Object#is_a?` or `Object#kind_of?`.
+      #
+      # @example EnforcedStyle: is_a? (default)
+      #   # bad
+      #   var.kind_of?(Date)
+      #   var.kind_of?(Integer)
+      #
+      #   # good
+      #   var.is_a?(Date)
+      #   var.is_a?(Integer)
+      #
+      # @example EnforcedStyle: kind_of?
+      #   # bad
+      #   var.is_a?(Time)
+      #   var.is_a?(String)
+      #
+      #   # good
+      #   var.kind_of?(Time)
+      #   var.kind_of?(String)
+      #
+      class ClassCheck < Cop
+        include ConfigurableEnforcedStyle
+
+        MSG = 'Prefer `Object#%<prefer>s` over `Object#%<current>s`.'
+
+        def_node_matcher :class_check?, '(send _ ${:is_a? :kind_of?} _)'
+
+        def on_send(node)
+          class_check?(node) do |method_name|
+            return if style == method_name
+
+            add_offense(node, location: :selector)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            replacement = node.method?(:is_a?) ? 'kind_of?' : 'is_a?'
+
+            corrector.replace(node.loc.selector, replacement)
+          end
+        end
+
+        def message(node)
+          if node.method?(:is_a?)
+            format(MSG, prefer: 'kind_of?', current: 'is_a?')
+          else
+            format(MSG, prefer: 'is_a?', current: 'kind_of?')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for uses of the class/module name instead of
+      # self, when defining class/module methods.
+      #
+      # @example
+      #   # bad
+      #   class SomeClass
+      #     def SomeClass.class_method
+      #       # ...
+      #     end
+      #   end
+      #
+      #   # good
+      #   class SomeClass
+      #     def self.class_method
+      #       # ...
+      #     end
+      #   end
+      class ClassMethods < Cop
+        MSG = 'Use `self.%<method>s` instead of `%<class>s.%<method>s`.'
+
+        def on_class(node)
+          return unless node.body
+
+          if node.body.defs_type?
+            check_defs(node.identifier, node.body)
+          elsif node.body.begin_type?
+            node.body.each_child_node(:defs) do |def_node|
+              check_defs(node.identifier, def_node)
+            end
+          end
+        end
+        alias on_module on_class
+
+        def autocorrect(node)
+          ->(corrector) { corrector.replace(node.loc.name, 'self') }
+        end
+
+        private
+
+        def check_defs(name, node)
+          # check if the class/module name matches the definee for the defs node
+          return unless name == node.receiver
+
+          add_offense(node.receiver, location: :name)
+        end
+
+        def message(node)
+          _, class_name = *node
+
+          format(MSG, method: node.parent.method_name, class: class_name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for uses of class variables. Offenses
+      # are signaled only on assignment to class variables to
+      # reduce the number of offenses that would be reported.
+      #
+      # You have to be careful when setting a value for a class
+      # variable; if a class has been inherited, changing the
+      # value of a class variable also affects the inheriting
+      # classes. This means that it's almost always better to
+      # use a class instance variable instead.
+      #
+      # @example
+      #   # bad
+      #   class A
+      #     @@test = 10
+      #   end
+      #
+      #   # good
+      #   class A
+      #     @test = 10
+      #   end
+      #
+      #   class A
+      #     def test
+      #       @@test # you can access class variable without offense
+      #     end
+      #   end
+      #
+      class ClassVars < Cop
+        MSG = 'Replace class var %<class_var>s with a class ' \
+              'instance var.'
+
+        def on_cvasgn(node)
+          add_offense(node, location: :name)
+        end
+
+        def message(node)
+          class_var, = *node
+          format(MSG, class_var: class_var)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop enforces the use of consistent method names
+      # from the Enumerable module.
+      #
+      # Unfortunately we cannot actually know if a method is from
+      # Enumerable or not (static analysis limitation), so this cop
+      # can yield some false positives.
+      #
+      # You can customize the mapping from undesired method to desired method.
+      #
+      # e.g. to use `detect` over `find`:
+      #
+      #   Style/CollectionMethods:
+      #     PreferredMethods:
+      #       find: detect
+      #
+      # The default mapping for `PreferredMethods` behaves as follows.
+      #
+      # @example
+      #   # bad
+      #   items.collect
+      #   items.collect!
+      #   items.inject
+      #   items.detect
+      #   items.find_all
+      #   items.member?
+      #
+      #   # good
+      #   items.map
+      #   items.map!
+      #   items.reduce
+      #   items.find
+      #   items.select
+      #   items.include?
+      #
+      class CollectionMethods < Cop
+        include MethodPreference
+
+        MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
+
+        def on_block(node)
+          check_method_node(node.send_node)
+        end
+
+        def on_send(node)
+          return unless node.arguments.one? &&
+                        node.first_argument.block_pass_type?
+
+          check_method_node(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.selector,
+                              preferred_method(node.loc.selector.source))
+          end
+        end
+
+        private
+
+        def message(node)
+          format(MSG,
+                 prefer: preferred_method(node.method_name),
+                 current: node.method_name)
+        end
+
+        def check_method_node(node)
+          return unless preferred_methods[node.method_name]
+
+          add_offense(node, location: :selector)
+        end
+      end
+    end
+  end
+end