Whitelist the Rakefile and Gemfile from name check

[theckman]

When building a Ruby project it's very common that you'll have a Rakefile and a Gemfile. These files are normally capitalized, which violates the default Rubocop filename checks. This changeset adds a whitelist for base filenames that should NOT be included in the file_name checks.

This works by adding a constant to the FileName class, WHITELIST, which is an Array that contains the whitelisted basenames. Later on, it will only add an offense if the basename is not snake case, and the basename is not Rakefile or Gemfile.

I've updated the tests for this specific use case and have confirmed that all tests pass on my local system.

-Tim

[yujinakayama]

Could you explain your situation where RuboCop registers offenses for Rakefile and Gemfile in more detail?

Normally RuboCop inspect files with .rb extension or files with no extension and ruby shebang, so Rakefile and Gemfile won't be inspected unless you specify them in AllCops/Includes in your .rubocop.yml (though Rakefile is already in the default built-in configuration). And Filename cop accepts any filename if it's specified in AllCops/Includes.

[theckman]

I found this behavior with the following configuration in my Rakefile caused my CI to fail the build:

Rubocop::RakeTask.new(:rubocop) do |t|
  t.patterns = %w{ Rakefile Gemfile rmuh.gemspec lib/**/*.rb spec/*_spec.rb }
  t.fail_on_error = true
end

I wanted to make sure my Rakefile and Gemfile both are within rubocop compliancy. If there is a better option that doesn't require this patch I'm open for suggestions.

[bbatsov]

@theckman You can either list the files in AllCops/Includes or in FileName/Exclude.

[yujinakayama]

@theckman I understood your case. I forgot the case where file paths are explicitly passed in CLI.

@bbatsov There's no FileName/Exclude configuration currently.

IMO, the whitelist should be configurable rather than fixed list.

[bbatsov]

@yujinakayama Every cop has Include and Exclude. :-) Those are global cop params like Enabled. I guess we should simply list all known problematic files in the default Exclude.

[yujinakayama]

@bbatsov Forgot about it. :) By the way, are these typos?

I guess we should simply list all known problematic files in the default Exclude.

👍

[bbatsov]

Totally. I must have been copy-pasting an entry with a typo. :-) Should be more careful. I’ll fix both issues now.

Cheers,
Bozhidar

On Friday, March 14, 2014 at 6:45 PM, Yuji Nakayama wrote:

@bbatsov (https://github.com/bbatsov) Forgot about it. :) By the way, are these (https://github.com/bbatsov/rubocop/blob/522f1341ca836de6f39448cabb3495b5b406068b/config/default.yml#L423-L444) typos?

I guess we should simply list all known problematic files in the default Exclude.

—
Reply to this email directly or view it on GitHub (#878 (comment)).