rubocop 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98ac250f0e0bf154099056814a9ab3e479b18ca0
-  data.tar.gz: 889fe91593bb5d98857a87cdf54a0e103d289727
+  metadata.gz: ac71ab74e5b7b997ffbc58dec68eaf2946ecbe5a
+  data.tar.gz: 6d0cc8550c439423260381ac3fddd57150ccb2ef
 SHA512:
-  metadata.gz: 8808eb3774ea169915eaeafee503e01e94c54357c70c50154ecb2a40ccf00e743d2997e2ec5b0e6caf328180ef76f5e2d9136f0ea3ec47141c9eaab3780d5529
-  data.tar.gz: e47780e9359a3ea1c1215eaa418ce62ae01b895f12910624a2d931a4b7db009d21886edf298b42e54286f2f1abc8045460de4c5ff05a2104fa4407f8a32d5536
+  metadata.gz: a3b185443b7dd173d210470487fc30ac302a07678831a6db7072a52763e975f566cc1204a180925e59cff6437376f1bc8ce71da294dbf1f7f9a23e8545377aa4
+  data.tar.gz: b726196458275a3bb7d20270dac674c953b764bb0eb5f219b2b8540ff9cd579dd6c9adf573292828c73e6821710f0c65f49085764a51044f7d21834740154af4

data/.rubocop.yml

@@ -7,4 +7,4 @@ MethodLength:
   Max: 30
 
 ClassLength:
-  Max: 210
+  Max: 160

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 ## master (unreleased)
 
+## 0.14.1 (10/10/2013)
+
+### New features
+
+* [#551](https://github.com/bbatsov/rubocop/pull/551) - New cop `BracesAroundHashParameters` checks for braces in function calls with hash parameters.
+* New cop `SpaceAfterNot` tracks redundant space after the `!` operator.
+
+### Bugs fixed
+
+* Fix bug concerning table and separator alignment of multi-line hash with multiple keys on the same line.
+* Fix a bug where `ClassLength` counted lines of inner classes/modules
+* Fix a false positive for namespace class in `Documentation`
+* Fix "Parser::Source::Range spans more than one line" bug in clang formatter
+* [#552](https://github.com/bbatsov/rubocop/pull/552) - `RaiseArgs` allows exception constructor calls with more than one 1 argument.
+
 ## 0.14.0 (07/10/2013)
 
 ### New features

data/README.md

@@ -302,7 +302,7 @@ W:  4:  5: end at 4, 4 is not aligned with if at 2, 2
 1 file inspected, 3 offences detected
 ```
 
-### File List Formmater
+### File List Formatter
 
 Sometimes you might want to just open all files with offences in your
 favorite editor. This formatter outputs just the names of the files

data/config/default.yml

@@ -184,3 +184,7 @@ TrivialAccessors:
 VariableName:
   # Valid values are: snake_case, camelCase
   EnforcedStyle: snake_case
+
+BracesAroundHashParameters:
+  # Valid values are: braces, no_braces
+  EnforcedStyle: no_braces

data/config/enabled.yml

@@ -384,26 +384,30 @@ SpaceInsideBrackets:
   Description: 'No spaces after [ or before ].'
   Enabled: true
 
+SpaceAfterColon:
+  Description: 'Use spaces after colons.'
+  Enabled: true
+
 SpaceAfterComma:
   Description: 'Use spaces after commas.'
   Enabled: true
 
+SpaceAfterControlKeyword:
+  Description: 'Use spaces after if/elsif/unless/while/until/case/when.'
+  Enabled: true
+
 SpaceAfterMethodName:
   Description: >
                  Never put a space between a method name and the opening
                  parenthesis.
   Enabled: true
 
-SpaceAfterSemicolon:
-  Description: 'Use spaces after semicolons.'
-  Enabled: true
-
-SpaceAfterColon:
-  Description: 'Use spaces after colons.'
+SpaceAfterNot:
+  Description: Tracks redundant space after the ! operator.
   Enabled: true
 
-SpaceAfterControlKeyword:
-  Description: 'Use spaces after if/elsif/unless/while/until/case/when.'
+SpaceAfterSemicolon:
+  Description: 'Use spaces after semicolons.'
   Enabled: true
 
 SpaceAroundEqualsInParameterDefault:
@@ -482,6 +486,10 @@ WhileUntilDo:
   Description: 'Checks for redundant do after while or until.'
   Enabled: true
 
+BracesAroundHashParameters:
+  Description: 'Enforce braces style inside hash parameters.'
+  Enabled: true
+
 #################### Lint ################################
 ### Warnings
 

data/lib/rubocop.rb

@@ -125,6 +125,7 @@ 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/space_after_not'
 require 'rubocop/cop/style/special_global_vars'
 require 'rubocop/cop/style/space_before_modifier_keyword'
 require 'rubocop/cop/style/string_literals'
@@ -142,6 +143,7 @@ require 'rubocop/cop/style/variable_name'
 require 'rubocop/cop/style/when_then'
 require 'rubocop/cop/style/while_until_do'
 require 'rubocop/cop/style/word_array'
+require 'rubocop/cop/style/braces_around_hash_parameters'
 
 require 'rubocop/cop/rails/has_and_belongs_to_many'
 require 'rubocop/cop/rails/read_attribute'
@@ -159,6 +161,7 @@ require 'rubocop/formatter/offence_count_formatter'
 require 'rubocop/formatter/formatter_set'
 
 require 'rubocop/config'
+require 'rubocop/config_loader'
 require 'rubocop/config_store'
 require 'rubocop/target_finder'
 require 'rubocop/token'

data/lib/rubocop/cli.rb

@@ -26,7 +26,7 @@ module Rubocop
 
       @options, target_files = Options.new(@config_store).parse(args)
 
-      Config.debug = @options[:debug]
+      ConfigLoader.debug = @options[:debug]
 
       target_files.each(&:freeze).freeze
       inspected_files = []

data/lib/rubocop/config.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 require 'delegate'
-require 'yaml'
 require 'pathname'
 
 module Rubocop
@@ -13,165 +12,9 @@ module Rubocop
   class Config < DelegateClass(Hash)
     class ValidationError < StandardError; end
 
-    DOTFILE = '.rubocop.yml'
-    RUBOCOP_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
-    DEFAULT_FILE = File.join(RUBOCOP_HOME, 'config', 'default.yml')
-    AUTO_GENERATED_FILE = 'rubocop-todo.yml'
-
     attr_reader :loaded_path
     attr_accessor :contains_auto_generated_config
 
-    class << self
-      attr_accessor :debug
-      alias_method :debug?, :debug
-
-      def load_file(path)
-        path = File.absolute_path(path)
-        hash = YAML.load_file(path)
-        puts "configuration from #{path}" if debug?
-        contains_auto_generated_config = false
-
-        base_configs(path, hash['inherit_from']).reverse_each do |base_config|
-          if File.basename(base_config.loaded_path) == DOTFILE
-            make_excludes_absolute(base_config)
-          end
-          base_config.each do |key, value|
-            if value.is_a?(Hash)
-              hash[key] = hash.key?(key) ? merge(value, hash[key]) : value
-            end
-          end
-          if base_config.loaded_path.include?(AUTO_GENERATED_FILE)
-            contains_auto_generated_config = true
-          end
-        end
-
-        hash.delete('inherit_from')
-        config = new(hash, path)
-        config.warn_unless_valid
-        config.contains_auto_generated_config = contains_auto_generated_config
-        config
-      end
-
-      def make_excludes_absolute(config)
-        if config['AllCops'] && config['AllCops']['Excludes']
-          config['AllCops']['Excludes'].map! do |exclude_elem|
-            if exclude_elem.is_a?(String) && !exclude_elem.start_with?('/')
-              File.join(File.dirname(config.loaded_path), exclude_elem)
-            else
-              exclude_elem
-            end
-          end
-        end
-      end
-
-      def relative_path(path, base)
-        path_name = Pathname.new(File.expand_path(path))
-        path_name.relative_path_from(Pathname.new(base)).to_s
-      end
-
-      # Return an extended merge of two hashes. That is, a normal hash merge,
-      # with the addition that any value that is a hash, and occurs in both
-      # arguments (i.e., cop names), will also be merged.
-      def merge(base_hash, derived_hash)
-        result = {}
-        base_hash.each do |key, value|
-          result[key] = if derived_hash.key?(key)
-                          if value.is_a?(Hash)
-                            value.merge(derived_hash[key])
-                          else
-                            derived_hash[key]
-                          end
-                        else
-                          base_hash[key]
-                        end
-        end
-        derived_hash.each do |key, value|
-          result[key] = value unless base_hash.key?(key)
-        end
-        result
-      end
-
-      def base_configs(path, inherit_from)
-        base_files = case inherit_from
-                     when nil then []
-                     when String then [inherit_from]
-                     when Array then inherit_from
-                     end
-        base_files.map do |f|
-          f = File.join(File.dirname(path), f) unless f.start_with?('/')
-          print 'Inheriting ' if debug?
-          load_file(f)
-        end
-      end
-
-      # Returns the path of .rubocop.yml searching upwards in the
-      # directory structure starting at the given directory where the
-      # inspected file is. If no .rubocop.yml is found there, the
-      # user's home directory is checked. If there's no .rubocop.yml
-      # there either, the path to the default file is returned.
-      def configuration_file_for(target_dir)
-        config_files_in_path(target_dir).first || DEFAULT_FILE
-      end
-
-      def configuration_from_file(config_file)
-        config = load_file(config_file)
-        found_files = config_files_in_path(config_file)
-        if found_files.any? && found_files.last != config_file
-          print 'AllCops/Excludes ' if debug?
-          add_excludes_from_higher_level(config, load_file(found_files.last))
-        end
-        make_excludes_absolute(config)
-        merge_with_default(config, config_file)
-      end
-
-      def add_excludes_from_higher_level(config, highest_config)
-        if highest_config['AllCops'] && highest_config['AllCops']['Excludes']
-          config['AllCops'] ||= {}
-          config['AllCops']['Excludes'] ||= []
-          highest_config['AllCops']['Excludes'].each do |path|
-            unless path.is_a?(Regexp) || path.start_with?('/')
-              path = File.join(File.dirname(highest_config.loaded_path), path)
-            end
-            config['AllCops']['Excludes'] << path
-          end
-          config['AllCops']['Excludes'].uniq!
-        end
-      end
-
-      def default_configuration
-        @default_configuration ||= begin
-                                     print 'Default ' if debug?
-                                     load_file(DEFAULT_FILE)
-                                   end
-      end
-
-      def merge_with_default(config, config_file)
-        result = new(merge(default_configuration, config), config_file)
-        result.contains_auto_generated_config =
-          config.contains_auto_generated_config
-        result
-      end
-
-      private
-
-      def config_files_in_path(target)
-        possible_config_files = dirs_to_search(target).map do |dir|
-          File.join(dir, DOTFILE)
-        end
-        possible_config_files.select { |config_file| File.exist?(config_file) }
-      end
-
-      def dirs_to_search(target_dir)
-        dirs_to_search = []
-        target_dir_pathname = Pathname.new(File.expand_path(target_dir))
-        target_dir_pathname.ascend do |dir_pathname|
-          dirs_to_search << dir_pathname.to_s
-        end
-        dirs_to_search << Dir.home
-        dirs_to_search
-      end
-    end
-
     def initialize(hash = {}, loaded_path = nil)
       @hash = hash
       @loaded_path = loaded_path
@@ -196,9 +39,9 @@ module Rubocop
     # TODO: This should be a private method
     def validate
       # Don't validate RuboCop's own files. Avoids inifinite recursion.
-      return if @loaded_path.start_with?(RUBOCOP_HOME)
+      return if @loaded_path.start_with?(ConfigLoader::RUBOCOP_HOME)
 
-      default_config = self.class.default_configuration
+      default_config = ConfigLoader.default_configuration
 
       valid_cop_names, invalid_cop_names = @hash.keys.partition do |key|
         default_config.key?(key)
@@ -244,7 +87,7 @@ module Rubocop
 
     def relative_path_to_loaded_dir(file)
       return file unless loaded_path
-      Config.relative_path(file, loaded_dir_pathname)
+      ConfigLoader.relative_path(file, loaded_dir_pathname)
     end
 
     def loaded_dir_pathname

data/lib/rubocop/config_loader.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+
+require 'yaml'
+require 'pathname'
+
+module Rubocop
+  # This class represents the configuration of the RuboCop application
+  # and all its cops. A Config is associated with a YAML configuration
+  # file from which it was read. Several different Configs can be used
+  # during a run of the rubocop program, if files in several
+  # directories are inspected.
+  class ConfigLoader
+    DOTFILE = '.rubocop.yml'
+    RUBOCOP_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
+    DEFAULT_FILE = File.join(RUBOCOP_HOME, 'config', 'default.yml')
+    AUTO_GENERATED_FILE = 'rubocop-todo.yml'
+
+    class << self
+      attr_accessor :debug
+      alias_method :debug?, :debug
+
+      def load_file(path)
+        path = File.absolute_path(path)
+        hash = YAML.load_file(path)
+        puts "configuration from #{path}" if debug?
+        contains_auto_generated_config = false
+
+        base_configs(path, hash['inherit_from']).reverse_each do |base_config|
+          if File.basename(base_config.loaded_path) == DOTFILE
+            make_excludes_absolute(base_config)
+          end
+          base_config.each do |key, value|
+            if value.is_a?(Hash)
+              hash[key] = hash.key?(key) ? merge(value, hash[key]) : value
+            end
+          end
+          if base_config.loaded_path.include?(AUTO_GENERATED_FILE)
+            contains_auto_generated_config = true
+          end
+        end
+
+        hash.delete('inherit_from')
+        config = Config.new(hash, path)
+        config.warn_unless_valid
+        config.contains_auto_generated_config = contains_auto_generated_config
+        config
+      end
+
+      def make_excludes_absolute(config)
+        if config['AllCops'] && config['AllCops']['Excludes']
+          config['AllCops']['Excludes'].map! do |exclude_elem|
+            if exclude_elem.is_a?(String) && !exclude_elem.start_with?('/')
+              File.join(File.dirname(config.loaded_path), exclude_elem)
+            else
+              exclude_elem
+            end
+          end
+        end
+      end
+
+      def relative_path(path, base)
+        path_name = Pathname.new(File.expand_path(path))
+        path_name.relative_path_from(Pathname.new(base)).to_s
+      end
+
+      # Return an extended merge of two hashes. That is, a normal hash merge,
+      # with the addition that any value that is a hash, and occurs in both
+      # arguments (i.e., cop names), will also be merged.
+      def merge(base_hash, derived_hash)
+        result = base_hash.merge(derived_hash)
+        keys_appearing_in_both = base_hash.keys & derived_hash.keys
+        keys_appearing_in_both.each do |key|
+          if base_hash[key].is_a?(Hash)
+            result[key] = base_hash[key].merge(derived_hash[key])
+          end
+        end
+        result
+      end
+
+      def base_configs(path, inherit_from)
+        Array(inherit_from).map do |f|
+          f = File.join(File.dirname(path), f) unless f.start_with?('/')
+          print 'Inheriting ' if debug?
+          load_file(f)
+        end
+      end
+
+      # Returns the path of .rubocop.yml searching upwards in the
+      # directory structure starting at the given directory where the
+      # inspected file is. If no .rubocop.yml is found there, the
+      # user's home directory is checked. If there's no .rubocop.yml
+      # there either, the path to the default file is returned.
+      def configuration_file_for(target_dir)
+        config_files_in_path(target_dir).first || DEFAULT_FILE
+      end
+
+      def configuration_from_file(config_file)
+        config = load_file(config_file)
+        found_files = config_files_in_path(config_file)
+        if found_files.any? && found_files.last != config_file
+          print 'AllCops/Excludes ' if debug?
+          add_excludes_from_higher_level(config, load_file(found_files.last))
+        end
+        make_excludes_absolute(config)
+        merge_with_default(config, config_file)
+      end
+
+      def add_excludes_from_higher_level(config, highest_config)
+        if highest_config['AllCops'] && highest_config['AllCops']['Excludes']
+          config['AllCops'] ||= {}
+          config['AllCops']['Excludes'] ||= []
+          highest_config['AllCops']['Excludes'].each do |path|
+            unless path.is_a?(Regexp) || path.start_with?('/')
+              path = File.join(File.dirname(highest_config.loaded_path), path)
+            end
+            config['AllCops']['Excludes'] << path
+          end
+          config['AllCops']['Excludes'].uniq!
+        end
+      end
+
+      def default_configuration
+        @default_configuration ||= begin
+                                     print 'Default ' if debug?
+                                     load_file(DEFAULT_FILE)
+                                   end
+      end
+
+      def merge_with_default(config, config_file)
+        result = Config.new(merge(default_configuration, config), config_file)
+        result.contains_auto_generated_config =
+          config.contains_auto_generated_config
+        result
+      end
+
+      private
+
+      def config_files_in_path(target)
+        possible_config_files = dirs_to_search(target).map do |dir|
+          File.join(dir, DOTFILE)
+        end
+        possible_config_files.select { |config_file| File.exist?(config_file) }
+      end
+
+      def dirs_to_search(target_dir)
+        dirs_to_search = []
+        target_dir_pathname = Pathname.new(File.expand_path(target_dir))
+        target_dir_pathname.ascend do |dir_pathname|
+          dirs_to_search << dir_pathname.to_s
+        end
+        dirs_to_search << Dir.home
+        dirs_to_search
+      end
+    end
+  end
+end