[Fix rubocop#5970] Handle paths in inherit_from

We couldn't deal with slashes in inherit_from file paths. There was also a weird checking of falsiness of the parameter rubocop_yml_contents, even though it's always truthy. Checking if it contains any non-whitespace achieves the desired result.
davearonson · Oct 26, 2018 · 1ab8170 · 1ab8170
1 parent fcd56cb
commit 1ab8170
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Bug fixes
 
 * [#5934](https://github.com/rubocop-hq/rubocop/issues/5934): Handle the combination of `--auto-gen-config` and `--config FILE` correctly. ([@jonas054][])
+* [#5970](https://github.com/rubocop-hq/rubocop/issues/5970): Make running `--auto-gen-config` in a subdirectory work. ([@jonas054][])
 
 ## 0.60.0 (2018-10-26)
 

diff --git a/lib/rubocop/config_loader.rb b/lib/rubocop/config_loader.rb
@@ -136,8 +136,9 @@ def add_inheritance_from_auto_generated_file
           files.unshift(AUTO_GENERATED_FILE)
           file_string = "\n  - " + files.join("\n  - ") if files.size > 1
           rubocop_yml_contents = IO.read(config_file, encoding: Encoding::UTF_8)
-                                   .sub(/^inherit_from: *[.\w]+/, '')
-                                   .sub(/^inherit_from: *(\n *- *[.\w]+)+/, '')
+                                   .sub(%r{^inherit_from: *[.\/\w]+}, '')
+                                   .sub(%r{^inherit_from: *(\n *- *[.\/\w]+)+},
+                                        '')
         end
         write_config_file(config_file, file_string, rubocop_yml_contents)
         puts "Added inheritance from `#{AUTO_GENERATED_FILE}` in `#{DOTFILE}`."
@@ -148,7 +149,7 @@ def add_inheritance_from_auto_generated_file
       def write_config_file(file_name, file_string, rubocop_yml_contents)
         File.open(file_name, 'w') do |f|
           f.write "inherit_from:#{file_string}\n"
-          f.write "\n#{rubocop_yml_contents}" if rubocop_yml_contents
+          f.write "\n#{rubocop_yml_contents}" if rubocop_yml_contents =~ /\S/
         end
       end
 

diff --git a/spec/rubocop/cli/cli_auto_gen_config_spec.rb b/spec/rubocop/cli/cli_auto_gen_config_spec.rb
@@ -336,6 +336,41 @@ def f
       end
     end
 
+    context 'when working in a subdirectory' do
+      it 'can generate a todo list' do
+        create_file('dir/example1.rb', ['$x = 0 ',
+                                        '#' * 90,
+                                        'y ',
+                                        'puts x'])
+        create_file('dir/.rubocop.yml', <<-YAML.strip_indent)
+          inherit_from: ../.rubocop.yml
+        YAML
+        create_file('.rubocop.yml', <<-YAML.strip_indent)
+          Layout/TrailingWhitespace:
+            Enabled: false
+          Metrics/LineLength:
+            Max: 95
+        YAML
+        Dir.chdir('dir') { expect(cli.run(%w[--auto-gen-config])).to eq(0) }
+        expect($stderr.string).to eq('')
+        # expect($stdout.string).to include('Created .rubocop_todo.yml.')
+        expect(Dir['dir/.*']).to include('dir/.rubocop_todo.yml')
+        todo_contents = IO.read('dir/.rubocop_todo.yml').lines[8..-1].join
+        expect(todo_contents).to eq(<<-YAML.strip_indent)
+          # Offense count: 1
+          # Configuration parameters: AllowedVariables.
+          Style/GlobalVars:
+            Exclude:
+              - 'example1.rb'
+        YAML
+        expect(IO.read('dir/.rubocop.yml')).to eq(<<-YAML.strip_indent)
+          inherit_from:
+            - .rubocop_todo.yml
+            - ../.rubocop.yml
+        YAML
+      end
+    end
+
     it 'can generate a todo list' do
       create_file('example1.rb', ['$x= 0 ',
                                   '#' * 90,