rubocop 0.11.1 → 0.12.0

data/lib/rubocop.rb

@@ -24,6 +24,7 @@ require 'rubocop/cop/lint/eval'
 require 'rubocop/cop/lint/handle_exceptions'
 require 'rubocop/cop/lint/literal_in_condition'
 require 'rubocop/cop/lint/loop'
+require 'rubocop/cop/lint/parentheses_as_grouped_expression'
 require 'rubocop/cop/lint/rescue_exception'
 require 'rubocop/cop/lint/shadowing_outer_local_variable'
 require 'rubocop/cop/lint/unreachable_code'
@@ -66,23 +67,26 @@ require 'rubocop/cop/style/empty_literal'
 require 'rubocop/cop/style/encoding'
 require 'rubocop/cop/style/end_block'
 require 'rubocop/cop/style/end_of_line'
+require 'rubocop/cop/style/even_odd'
 require 'rubocop/cop/style/favor_join'
 require 'rubocop/cop/style/favor_modifier'
 require 'rubocop/cop/style/favor_sprintf'
 require 'rubocop/cop/style/favor_unless_over_negated_if'
+require 'rubocop/cop/style/hash_methods'
 require 'rubocop/cop/style/hash_syntax'
 require 'rubocop/cop/style/if_then_else'
 require 'rubocop/cop/style/if_with_semicolon'
+require 'rubocop/cop/style/indentation_width'
 require 'rubocop/cop/style/multiline_if_then'
 require 'rubocop/cop/style/one_line_conditional'
 require 'rubocop/cop/style/lambda'
 require 'rubocop/cop/style/leading_comment_space'
-require 'rubocop/cop/style/line_continuation'
 require 'rubocop/cop/style/line_length'
 require 'rubocop/cop/style/method_and_variable_snake_case'
 require 'rubocop/cop/style/method_call_parentheses'
 require 'rubocop/cop/style/method_length'
 require 'rubocop/cop/style/module_function'
+require 'rubocop/cop/style/nil_comparison'
 require 'rubocop/cop/style/not'
 require 'rubocop/cop/style/numeric_literals'
 require 'rubocop/cop/style/op_method'
@@ -100,6 +104,7 @@ require 'rubocop/cop/style/signal_exception'
 require 'rubocop/cop/style/single_line_methods'
 require 'rubocop/cop/style/space_after_comma_etc'
 require 'rubocop/cop/style/space_after_control_keyword'
+require 'rubocop/cop/style/space_after_method_name'
 require 'rubocop/cop/style/string_literals'
 require 'rubocop/cop/style/surrounding_space'
 require 'rubocop/cop/style/symbol_array'
@@ -114,6 +119,8 @@ require 'rubocop/cop/style/when_then'
 require 'rubocop/cop/style/while_until_do'
 require 'rubocop/cop/style/word_array'
 
+require 'rubocop/cop/rails/has_and_belongs_to_many'
+require 'rubocop/cop/rails/read_attribute'
 require 'rubocop/cop/rails/validation'
 
 require 'rubocop/formatter/base_formatter'
@@ -124,6 +131,7 @@ require 'rubocop/formatter/clang_style_formatter'
 require 'rubocop/formatter/progress_formatter'
 require 'rubocop/formatter/json_formatter'
 require 'rubocop/formatter/file_list_formatter'
+require 'rubocop/formatter/offence_count_formatter'
 require 'rubocop/formatter/formatter_set'
 
 require 'rubocop/config'

data/lib/rubocop/cli.rb

@@ -62,7 +62,7 @@ module Rubocop
       formatter_set.finished(inspected_files.freeze)
       formatter_set.close_output_files
 
-      display_error_summary(@errors) unless @options[:silent]
+      display_error_summary(@errors)
 
       !any_failed && !wants_to_quit ? 0 : 1
     rescue => e
@@ -83,6 +83,27 @@ module Rubocop
       end
     end
 
+    def print_available_cops
+      puts "Available cops (#{@cops.length}) + config for #{Dir.pwd.to_s}: "
+      dirconf = @config_store.for(Dir.pwd.to_s)
+      @cops.types.sort!.each do |type|
+        coptypes = @cops.with_type(type).sort_by!(&:cop_name)
+        puts "Type '#{type.to_s.capitalize}' (#{coptypes.size}):"
+        coptypes.each do |cop|
+          name = cop.cop_name
+          puts " - #{name}"
+          cnf = dirconf.for_cop(name).dup
+          print_conf_option('Description',
+                            cnf.delete('Description') { 'None' })
+          cnf.each { |k, v| print_conf_option(k, v) }
+        end
+      end
+    end
+
+    def print_conf_option(option, value)
+      puts  "    - #{option}: #{value}"
+    end
+
     def inspect_file(file)
       begin
         processed_source = SourceParser.parse_file(file)
@@ -160,7 +181,8 @@ module Rubocop
 
     # rubocop:disable MethodLength
     def parse_options(args)
-      convert_deprecated_options!(args)
+      ignore_dropped_options(args)
+      convert_deprecated_options(args)
 
       OptionParser.new do |opts|
         opts.banner = 'Usage: rubocop [options] [file1, file2, ...]'
@@ -186,6 +208,12 @@ module Rubocop
           ]
           validate_auto_gen_config_option(args)
         end
+        opts.on('--show-cops',
+                'Shows cops and their config for the',
+                'current directory.') do
+          print_available_cops
+          exit(0)
+        end
         opts.on('-f', '--format FORMATTER',
                 'Choose an output formatter. This option',
                 'can be specified multiple times to enable',
@@ -196,6 +224,7 @@ module Rubocop
                 '  [e]macs',
                 '  [j]son',
                 '  [f]iles',
+                '  [o]ffences',
                 '  custom formatter class name') do |key|
           @options[:formatters] ||= []
           @options[:formatters] << [key]
@@ -220,9 +249,6 @@ module Rubocop
         opts.on('-a', '--auto-correct', 'Auto-correct offences.') do |a|
           @options[:autocorrect] = a
         end
-        opts.on('-s', '--silent', 'Silence summary.') do |s|
-          @options[:silent] = s
-        end
         opts.on('-n', '--no-color', 'Disable color output.') do |s|
           Sickill::Rainbow.enabled = false
         end
@@ -238,7 +264,17 @@ module Rubocop
     end
     # rubocop:enable MethodLength
 
-    def convert_deprecated_options!(args)
+    def ignore_dropped_options(args)
+      # Currently we don't make -s/--silent option raise error
+      # since those are mostly used by external tools.
+      rejected = args.reject! { |a| %w(-s --silent).include?(a) }
+      if rejected
+        warn '-s/--silent options is dropped. ' +
+             '`emacs` and `files` formatters no longer display summary.'
+      end
+    end
+
+    def convert_deprecated_options(args)
       args.map! do |arg|
         case arg
         when '-e', '--emacs'
@@ -262,12 +298,12 @@ module Rubocop
     def display_error_summary(errors)
       return if errors.empty?
       plural = errors.count > 1 ? 's' : ''
-      puts "\n#{errors.count} error#{plural} occurred:".color(:red)
-      errors.each { |error| puts error }
-      puts 'Errors are usually caused by RuboCop bugs.'
-      puts 'Please, report your problems to RuboCop\'s issue tracker.'
-      puts 'Mention the following information in the issue report:'
-      puts Rubocop::Version.version(true)
+      warn "\n#{errors.count} error#{plural} occurred:".color(:red)
+      errors.each { |error| warn error }
+      warn 'Errors are usually caused by RuboCop bugs.'
+      warn 'Please, report your problems to RuboCop\'s issue tracker.'
+      warn 'Mention the following information in the issue report:'
+      warn Rubocop::Version.version(true)
     end
 
     def autocorrect(buffer, cops)
@@ -295,7 +331,7 @@ module Rubocop
 
     def formatter_set
       @formatter_set ||= begin
-        set = Formatter::FormatterSet.new(!@options[:silent])
+        set = Formatter::FormatterSet.new
         pairs = @options[:formatters] || [[DEFAULT_FORMATTER]]
         pairs.each do |formatter_key, output_path|
           set.add_formatter(formatter_key, output_path)

data/lib/rubocop/config.rb

@@ -37,7 +37,7 @@ module Rubocop
           end
           base_config.each do |key, value|
             if value.is_a?(Hash)
-              hash[key] = hash.has_key?(key) ? merge(value, hash[key]) : value
+              hash[key] = hash.key?(key) ? merge(value, hash[key]) : value
             end
           end
           if base_config.loaded_path.include?(AUTO_GENERATED_FILE)
@@ -75,7 +75,7 @@ module Rubocop
       def merge(base_hash, derived_hash)
         result = {}
         base_hash.each do |key, value|
-          result[key] = if derived_hash.has_key?(key)
+          result[key] = if derived_hash.key?(key)
                           if value.is_a?(Hash)
                             value.merge(derived_hash[key])
                           else
@@ -86,7 +86,7 @@ module Rubocop
                         end
         end
         derived_hash.each do |key, value|
-          result[key] = value unless base_hash.has_key?(key)
+          result[key] = value unless base_hash.key?(key)
         end
         result
       end
@@ -200,7 +200,7 @@ module Rubocop
       default_config = self.class.default_configuration
 
       valid_cop_names, invalid_cop_names = @hash.keys.partition do |key|
-        default_config.has_key?(key)
+        default_config.key?(key)
       end
 
       invalid_cop_names.each do |name|
@@ -210,7 +210,7 @@ module Rubocop
 
       valid_cop_names.each do |name|
         @hash[name].each_key do |param|
-          unless default_config[name].has_key?(param)
+          unless default_config[name].key?(param)
             fail ValidationError,
                  "unrecognized parameter #{name}:#{param} found " +
                  "in #{loaded_path || self}"

data/lib/rubocop/cop/cop.rb

@@ -2,6 +2,21 @@
 
 module Rubocop
   module Cop
+    # Store for all cops with helper functions
+    class CopStore < ::Array
+
+      # @return [Array<String>] list of types for current cops.
+      def types
+        @types = map(&:cop_type).uniq! unless defined? @types
+        @types
+      end
+
+      # @return [Array<Cop>] Cops for that specific type.
+      def with_type(type)
+        select { |c| c.cop_type == type }
+      end
+    end
+
     # A scaffold for concrete cops.
     #
     # The Cop class is meant to be extended.
@@ -24,13 +39,20 @@ module Rubocop
     class Cop
       extend AST::Sexp
 
+      # http://phrogz.net/programmingruby/language.html#table_18.4
+      # Backtick is added last just to help editors parse this code.
+      OPERATOR_METHODS = %w(
+          | ^ & <=> == === =~ > >= < <= << >>
+          + - * / % ** ~ +@ -@ [] []= ! != !~
+        ).map(&:to_sym) + [:'`']
+
       attr_accessor :offences
       attr_accessor :debug
       attr_accessor :autocorrect
       attr_writer :disabled_lines
       attr_reader :corrections
 
-      @all = []
+      @all = CopStore.new
       @config = {}
 
       class << self
@@ -61,6 +83,17 @@ module Rubocop
         cop_type == :lint
       end
 
+      # Extracts the first line out of the description
+      def self.short_description
+        desc = full_description
+        desc ? desc.lines.first.strip : ''
+      end
+
+      # Gets the full description of the cop or nil if no description is set.
+      def self.full_description
+        config['Description']
+      end
+
       def self.rails?
         cop_type == :rails
       end

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

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module Lint
+      # Checks for space between a the name of a called method and a left
+      # parenthesis.
+      #
+      # @example
+      #
+      # puts (x + y)
+      class ParenthesesAsGroupedExpression < Cop
+        MSG = '(...) interpreted as grouped expression.'
+
+        def on_send(node)
+          receiver, method_name, args = *node
+          if OPERATOR_METHODS.include?(method_name) ||
+              method_name.to_s.end_with?('=')
+            return
+          end
+          if args && args.loc.expression.source.start_with?('(')
+            receiver_length = if receiver
+                                receiver.loc.expression.source.length
+                              else
+                                0
+                              end
+            without_receiver = node.loc.expression.source[receiver_length..-1]
+
+            # Escape question mark if any.
+            method_regexp = Regexp.escape(method_name)
+
+            if (match =
+                without_receiver.match(/^\s*\.?\s*#{method_regexp}(\s+)\(/))
+              expr = args.loc.expression
+              space_length = match.captures[0].length
+              space_range =
+                Parser::Source::Range.new(expr.source_buffer,
+                                          expr.begin_pos - space_length,
+                                          expr.begin_pos)
+              add_offence(:warning, space_range, MSG)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,10 +16,7 @@ module Rubocop
         end
 
         def targets_exception?(rescue_arg_node)
-          return false unless rescue_arg_node.type == :const
-          namespace, klass_name = *rescue_arg_node
-          return false unless namespace.nil? || namespace.type == :cbase
-          klass_name == :Exception
+          Util.const_name(rescue_arg_node) == 'Exception'
         end
       end
     end

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

@@ -20,20 +20,20 @@ module Rubocop
         MSG = 'Useless assignment to local variable %s.'
 
         def on_def(node)
-          _name, _args, body = *node
+          _name, args, body = *node
 
-          check_for_useless_assignment(body)
+          check_for_useless_assignment(body, args)
         end
 
         def on_defs(node)
-          _target, _name, _args, body = *node
+          _target, _name, args, body = *node
 
-          check_for_useless_assignment(body)
+          check_for_useless_assignment(body, args)
         end
 
         private
 
-        def check_for_useless_assignment(body)
+        def check_for_useless_assignment(body, args)
           return unless body
 
           if body.type == :begin
@@ -43,19 +43,47 @@ module Rubocop
           end
 
           last_expr = expression.is_a?(Array) ? expression.last : expression
+          return unless last_expr
 
-          if last_expr && last_expr.type == :lvasgn
+          case last_expr.type
+          when :lvasgn
             var_name, = *last_expr
             add_offence(:warning, last_expr.loc.name, MSG.format(var_name))
-          elsif last_expr && last_expr.type == :send
+          when :send
             receiver, method, _args = *last_expr
+            return unless receiver
+            return unless receiver.type == :lvar
+            return unless method =~ /\w=$/
 
-            if receiver && receiver.type == :lvar && method =~ /\w=$/
-              add_offence(:warning,
-                          receiver.loc.name,
-                          MSG.format(receiver.loc.name.source))
+            var_name, = *receiver
+            return if contains_object_passed_as_argument?(var_name, body, args)
+
+            add_offence(:warning,
+                        receiver.loc.name,
+                        MSG.format(receiver.loc.name.source))
+          end
+        end
+
+        def contains_object_passed_as_argument?(lvar_name, body, args)
+          variable_table = {}
+
+          args.children.each do |arg_node|
+            arg_name, = *arg_node
+            variable_table[arg_name] = true
+          end
+
+          on_node([:lvasgn, :ivasgn, :cvasgn, :gvasgn], body) do |asgn_node|
+            lhs_var_name, rhs_node = *asgn_node
+
+            if [:lvar, :ivar, :cvar, :gvar].include?(rhs_node.type)
+              rhs_var_name, = *rhs_node
+              variable_table[lhs_var_name] = variable_table[rhs_var_name]
+            else
+              variable_table[lhs_var_name] = false
             end
           end
+
+          variable_table[lvar_name]
         end
       end
     end

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

@@ -17,11 +17,9 @@ module Rubocop
           op = node.loc.selector.source
 
           if OPS.include?(op)
-            receiver, _method, selector = *node
+            receiver, _method, args = *node
 
-            if receiver == selector
-              add_offence(:warning, node.loc.selector, MSG)
-            end
+            add_offence(:warning, node.loc.selector, MSG) if receiver == args
           end
         end
       end

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

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module Rails
+      # This cop checks for the use of the has_and_belongs_to_many macro.
+      class HasAndBelongsToMany < Cop
+        MSG = 'Prefer has_many :through to has_and_belongs_to_many.'
+
+        def on_send(node)
+          receiver, method_name, *_args = *node
+
+          if receiver.nil? && method_name == :has_and_belongs_to_many
+            add_offence(:convention, node.loc.selector, MSG)
+          end
+        end
+      end
+    end
+  end
+end