rubocop 0.49.0 → 0.49.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b593dc9fec24a2f53061b6e5579f49e6597e564
-  data.tar.gz: 72f662af431c19f0811db82ec40b6b461057b237
+  metadata.gz: 19d303a2e571971385e48eab0517fd03f0273c9c
+  data.tar.gz: 30129d935542762c11820ad7386ff213d4944cd2
 SHA512:
-  metadata.gz: 1a9d358a6e049e185056789b1b82c1fb5cdbe1f2358fb5138646f46df6376136e7819f3ea8edc4ae1b730ef2ca57a2a488449a40db2b5849625d974a8929ad2b
-  data.tar.gz: f8563e03d90a81c1f7f9cd587ec32e91838ce938b3cc936dd8f490c4c4756910350beef1a1de7c286f9c36bac7bab748b49018b413a02bcfa617eaf5093cb943
+  metadata.gz: 8725c2dc3d92496b06acd39cc8efc4fd25e45e5ea7b3e3e3f565cf923de82c46f5efec1e279b75151f3a81341b94b9c70c0c3c66af60c3ab2bd2b844963993b9
+  data.tar.gz: d51e988da1e14e4b9477a2f5bec04cbd9509bcc09bb8febfc3e8d2df9957e8c98bb5c94e90fa3bacf9b0d848d496427bf6c57206c48a9c7acc3490bfade5d7c6

data/README.md

@@ -51,7 +51,7 @@ haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you
 might want to use a conservative version locking in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 0.49.0', require: false
+gem 'rubocop', '~> 0.49.1', require: false
 ```
 
 ## Quickstart

data/lib/rubocop.rb

@@ -63,6 +63,7 @@ require 'rubocop/cop/commissioner'
 require 'rubocop/cop/corrector'
 require 'rubocop/cop/force'
 require 'rubocop/cop/severity'
+require 'rubocop/cop/generator'
 
 require 'rubocop/cop/variable_force'
 require 'rubocop/cop/variable_force/branch'

data/lib/rubocop/config_loader.rb

@@ -165,6 +165,12 @@ module RuboCop
       def handle_disabled_by_default(config, new_default_configuration)
         department_config = config.to_hash.reject { |cop| cop.include?('/') }
         department_config.each do |dept, dept_params|
+          # Rails is always disabled by default and the department's Enabled
+          # flag works like the --rails command line option, which is that when
+          # AllCops:DisabledByDefault is true, each Rails cop must still be
+          # explicitly mentioned in user configuration in order to be enabled.
+          next if dept == 'Rails'
+
           next unless dept_params['Enabled']
 
           new_default_configuration.each do |cop, params|

data/lib/rubocop/cop/generator.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Source and spec generator for new cops
+    #
+    # This generator will take a cop name and generate a source file
+    # and spec file when given a valid qualified cop name.
+    class Generator
+      SOURCE_TEMPLATE = <<-RUBY.strip_indent
+        # frozen_string_literal: true
+
+        # TODO: when finished, run `rake generate_cops_documentation` to update the docs
+        module RuboCop
+          module Cop
+            module %<department>s
+              # TODO: Write cop description and example of bad / good code.
+              #
+              # @example
+              #   # bad
+              #   bad_method()
+              #
+              #   # bad
+              #   bad_method(args)
+              #
+              #   # good
+              #   good_method()
+              #
+              #   # good
+              #   good_method(args)
+              class %<cop_name>s < Cop
+                # TODO: Implement the cop into here.
+                #
+                # In many cases, you can use a node matcher for matching node pattern.
+                # See. https://github.com/bbatsov/rubocop/blob/master/lib/rubocop/node_pattern.rb
+                #
+                # For example
+                MSG = 'Message of %<cop_name>s'.freeze
+
+                def_node_matcher :bad_method?, <<-PATTERN
+                  (send nil :bad_method ...)
+                PATTERN
+
+                def on_send(node)
+                  return unless bad_method?(node)
+                  add_offense(node, :expression)
+                end
+              end
+            end
+          end
+        end
+      RUBY
+
+      SPEC_TEMPLATE = <<-RUBY.strip_indent
+        # frozen_string_literal: true
+
+        describe RuboCop::Cop::%<department>s::%<cop_name>s do
+          let(:config) { RuboCop::Config.new }
+          subject(:cop) { described_class.new(config) }
+
+          # TODO: Write test code
+          #
+          # For example
+          it 'registers an offense for offending code' do
+            inspect_source(cop, 'bad_method')
+            expect(cop.offenses.size).to eq(1)
+            expect(cop.messages)
+              .to eq(['Message of %<cop_name>s'])
+          end
+
+          it 'accepts' do
+            inspect_source(cop, 'good_method')
+            expect(cop.offenses).to be_empty
+          end
+        end
+      RUBY
+
+      def initialize(name)
+        @badge = Badge.parse(name)
+
+        return if badge.qualified?
+
+        raise ArgumentError, 'Specify a cop name with Department/Name style'
+      end
+
+      def write_source
+        write_unless_file_exists(source_path, generated_source)
+      end
+
+      def write_spec
+        write_unless_file_exists(spec_path, generated_spec)
+      end
+
+      def todo
+        <<-TODO.strip_indent
+          created
+          - #{source_path}
+          - #{spec_path}
+
+          Do 4 steps
+          - Add an entry to `New feature` section in CHANGELOG.md
+            - e.g. Add new `#{badge.cop_name}` cop. ([@your_id][])
+          - Add `require '#{require_path}'` into lib/rubocop.rb
+          - Add an entry into config/enabled.yml or config/disabled.yml
+          - Implement a new cop to the generated file!
+        TODO
+      end
+
+      private
+
+      attr_reader :badge
+
+      def write_unless_file_exists(path, contents)
+        raise "#{path} already exists!" if File.exist?(path)
+
+        File.write(path, contents)
+      end
+
+      def generated_source
+        generate(SOURCE_TEMPLATE)
+      end
+
+      def generated_spec
+        generate(SPEC_TEMPLATE)
+      end
+
+      def generate(template)
+        format(template, department: badge.department, cop_name: badge.cop_name)
+      end
+
+      def require_path
+        source_path.sub('lib/', '').sub('.rb', '')
+      end
+
+      def spec_path
+        File.join(
+          'spec',
+          'rubocop',
+          'cop',
+          snake_case(badge.department.to_s),
+          "#{snake_case(badge.cop_name.to_s)}_spec.rb"
+        )
+      end
+
+      def source_path
+        File.join(
+          'lib',
+          'rubocop',
+          'cop',
+          snake_case(badge.department.to_s),
+          "#{snake_case(badge.cop_name.to_s)}.rb"
+        )
+      end
+
+      def snake_case(camel_case_string)
+        camel_case_string
+          .gsub(/([^A-Z])([A-Z]+)/, '\1_\2')
+          .gsub(/([A-Z])([A-Z][^A-Z\d]+)/, '\1_\2')
+          .downcase
+      end
+    end
+  end
+end

data/lib/rubocop/cop/internal_affairs.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'rubocop/cop/internal_affairs/node_type_predicate'
+require 'rubocop/cop/internal_affairs/useless_message_assertion'

data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # Checks that node types are checked using the predicate helpers.
+      #
+      # @example
+      #
+      #   # bad
+      #   node.type == :send
+      #
+      #   # good
+      #   node.send_type?
+      #
+      class NodeTypePredicate < Cop
+        MSG = 'Use `#%s_type?` to check node type.'.freeze
+
+        def_node_search :node_type_check, <<-PATTERN
+          (send (send _ :type) :== (sym $_))
+        PATTERN
+
+        def on_send(node)
+          node_type_check(node) do |node_type|
+            return unless Parser::Meta::NODE_TYPES.include?(node_type)
+
+            add_offense(node, :expression, format(MSG, node_type))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/internal_affairs/useless_message_assertion.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # Checks that cops are not tested using `described_class::MSG`.
+      #
+      # @example
+      #
+      #     # bad
+      #     expect(cop.messages).to eq([described_class::MSG])
+      #
+      #     # good
+      #     expect(cop.messages).to eq(['Do not write bad code like that.'])
+      #
+      class UselessMessageAssertion < Cop
+        MSG = 'Do not specify cop behavior using `described_class::MSG`.'.freeze
+
+        def_node_search :described_class_msg, <<-PATTERN
+          (const (send nil :described_class) :MSG)
+        PATTERN
+
+        def_node_matcher :rspec_expectation_on_msg?, <<-PATTERN
+          (send (send nil :expect #contains_described_class_msg?) :to ...)
+        PATTERN
+
+        def investigate(_processed_source)
+          assertions_using_described_class_msg.each do |node|
+            add_offense(node, :expression)
+          end
+        end
+
+        private
+
+        def contains_described_class_msg?(node)
+          described_class_msg(node).any?
+        end
+
+        def assertions_using_described_class_msg
+          described_class_msg(processed_source.ast).reject do |node|
+            node.ancestors.any?(&method(:rspec_expectation_on_msg?))
+          end
+        end
+
+        # Only process spec files
+        def relevant_file?(file)
+          file.end_with?('_spec.rb')
+        end
+      end
+    end
+  end
+end

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

@@ -7,11 +7,27 @@ module RuboCop
       #
       # @example
       #
+      #   # EnforcedStyleInsidePipes: no_space (default)
+      #
       #   # bad
       #   {}.each { | x,  y |puts x }
+      #   ->( x,  y ) { puts x }
       #
       #   # good
       #   {}.each { |x, y| puts x }
+      #   ->(x, y) { puts x }
+      #
+      # @example
+      #
+      #   # EnforcedStyleInsidePipes: space
+      #
+      #   # bad
+      #   {}.each { |x,  y| puts x }
+      #   ->(x,  y) { puts x }
+      #
+      #   # good
+      #   {}.each { | x, y | puts x }
+      #   ->( x, y ) { puts x }
       class SpaceAroundBlockParameters < Cop
         include ConfigurableEnforcedStyle
 
@@ -22,6 +38,7 @@ module RuboCop
 
           opening_pipe = args.loc.begin
           closing_pipe = args.loc.end
+          return if opening_pipe.nil? || closing_pipe.nil?
 
           check_inside_pipes(args.children, opening_pipe, closing_pipe)
 

data/lib/rubocop/cop/lint/format_parameter_mismatch.rb

@@ -136,7 +136,7 @@ module RuboCop
         def arguments_count(args)
           if args.empty?
             0
-          elsif args.last.type == :splat
+          elsif args.last.splat_type?
             -(args.count - 1)
           else
             args.count

data/lib/rubocop/cop/performance/regexp_match.rb

@@ -69,7 +69,7 @@ module RuboCop
         def_node_matcher :match_method?, <<-PATTERN
           {
             (send _recv :match _)
-            (send _recv :match _ (:int ...))
+            (send _recv :match _ (int ...))
           }
         PATTERN
 

data/lib/rubocop/cop/rails/file_path.rb

@@ -57,7 +57,7 @@ module RuboCop
         end
 
         def string_with_slash?(node)
-          node.type == :str && node.source =~ %r{/}
+          node.str_type? && node.source =~ %r{/}
         end
 
         def register_offense(node)

data/lib/rubocop/cop/rails/http_positional_arguments.rb

@@ -56,11 +56,11 @@ module RuboCop
         end
 
         def special_keyword_arg?(node)
-          KEYWORD_ARGS.include?(node.children.first) if node.type == :sym
+          KEYWORD_ARGS.include?(node.children.first) if node.sym_type?
         end
 
         def format_arg?(node)
-          node.children.first == :format if node.type == :sym
+          node.children.first == :format if node.sym_type?
         end
 
         def convert_hash_data(data, type)

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

@@ -301,6 +301,9 @@ module RuboCop
         def assignment_node(node)
           *_variable, assignment = *node
 
+          # ignore pseudo-assignments without rhs in for nodes
+          return if node.parent && node.parent.for_type?
+
           if assignment.begin_type? && assignment.children.one?
             assignment, = *assignment
           end

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

@@ -6,37 +6,42 @@ module RuboCop
       # This cop checks for the formatting of empty method definitions.
       # By default it enforces empty method definitions to go on a single
       # line (compact style), but it can be configured to enforce the `end`
-      # to go on its own line (expanded style.)
+      # to go on its own line (expanded style).
       #
       # Note: A method definition is not considered empty if it contains
       #       comments.
       #
       # @example
       #
-      #   EnforcedStyle: compact (default)
+      #   # EnforcedStyle: compact (default)
       #
       #   @bad
       #   def foo(bar)
       #   end
+      #
       #   def self.foo(bar)
       #   end
       #
       #   @good
       #   def foo(bar); end
+      #
       #   def foo(bar)
       #     # baz
       #   end
+      #
       #   def self.foo(bar); end
       #
-      #   EnforcedStyle: expanded
+      #   # EnforcedStyle: expanded
       #
       #   @bad
       #   def foo(bar); end
+      #
       #   def self.foo(bar); end
       #
       #   @good
       #   def foo(bar)
       #   end
+      #
       #   def self.foo(bar)
       #   end
       class EmptyMethod < Cop
@@ -70,9 +75,10 @@ module RuboCop
         def corrected(node)
           method_name, args, _body, scope = method_def_node_parts(node)
 
-          arguments = args.source unless args.children.empty?
-          joint = compact_style? ? '; ' : "\n"
-          scope = scope ? 'self.' : ''
+          arguments = !args.children.empty? ? args.source : ''
+          indent    = ' ' * node.loc.column
+          joint     = compact_style? ? '; ' : "\n#{indent}"
+          scope     = scope ? 'self.' : ''
 
           ["def #{scope}#{method_name}#{arguments}", 'end'].join(joint)
         end

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

@@ -15,7 +15,7 @@ module RuboCop
       #   a = 'a'
       #   foo if ['a', 'b', 'c'].include?(a)
       class MultipleComparison < Cop
-        MSG = 'Avoid comparing a variable with multiple items' \
+        MSG = 'Avoid comparing a variable with multiple items ' \
           'in a conditional, use `Array#include?` instead.'.freeze
 
         def on_if(node)

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

@@ -153,7 +153,7 @@ module RuboCop
         def end_range(node)
           source_buffer = node.source_range.source_buffer
           end_pos = node.loc.end.end_pos
-          begin_pos = node.loc.end.begin_pos - node.source_range.column
+          begin_pos = node.loc.end.begin_pos - node.loc.end.column
           begin_pos -= 1 if end_followed_by_whitespace_only?(source_buffer,
                                                              end_pos)
 

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

@@ -99,7 +99,7 @@ module RuboCop
         # If the condition is parenthesized we recurse and check for any
         # complex expressions within it.
         def complex_condition?(condition)
-          if condition.type == :begin
+          if condition.begin_type?
             condition.to_a.any? { |x| complex_condition?(x) }
           else
             non_complex_type?(condition) ? false : true

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

@@ -93,7 +93,8 @@ module RuboCop
         def complex_content?(strings)
           strings.any? do |s|
             string = s.str_content
-            !string.valid_encoding? || string !~ word_regex || string =~ / /
+            !string.dup.force_encoding(::Encoding::UTF_8).valid_encoding? ||
+              string !~ word_regex || string =~ / /
           end
         end
 

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

@@ -22,7 +22,7 @@ module RuboCop
       #   for <= 42
       class YodaCondition < Cop
         MSG = 'Reverse the order of the operands `%s`.'.freeze
-        WHITELIST_TYPES = %i[lvar ivar send const regexp begin].freeze
+
         REVERSE_COMPARISON = {
           '<' => '>',
           '<=' => '>=',
@@ -41,7 +41,7 @@ module RuboCop
         def yoda_condition?(node)
           return false unless comparison_operator?(node)
 
-          !WHITELIST_TYPES.include?(node.receiver.type)
+          node.receiver.literal? && !node.arguments.first.literal?
         end
 
         def comparison_operator?(node)

data/lib/rubocop/runner.rb

@@ -49,7 +49,7 @@ module RuboCop
     # Warms up the RuboCop cache by forking a suitable number of rubocop
     # instances that each inspects its alotted group of files.
     def warm_cache(target_files)
-      puts 'Running parallel inspection'
+      puts 'Running parallel inspection' if @options[:debug]
       Parallel.each(target_files, &method(:file_offenses))
     end
 

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.49.0'.freeze
+    STRING = '0.49.1'.freeze
 
     MSG = '%s (using Parser %s, running on %s %s %s)'.freeze
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.49.0
+  version: 0.49.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2017-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -191,7 +191,11 @@ files:
 - lib/rubocop/cop/cop.rb
 - lib/rubocop/cop/corrector.rb
 - lib/rubocop/cop/force.rb
+- lib/rubocop/cop/generator.rb
 - lib/rubocop/cop/ignored_node.rb
+- lib/rubocop/cop/internal_affairs.rb
+- lib/rubocop/cop/internal_affairs/node_type_predicate.rb
+- lib/rubocop/cop/internal_affairs/useless_message_assertion.rb
 - lib/rubocop/cop/layout/access_modifier_indentation.rb
 - lib/rubocop/cop/layout/align_array.rb
 - lib/rubocop/cop/layout/align_hash.rb