Bump Rubocop to v0.48 #5997

ashmaroli · 2017-04-01T03:04:14Z

Fixes #5992, fixes #6005
~~WIP~~

Rubocop 0.48 introduced some new cops that broke our tests. While we temporarily locked to the previous version 0.47.1, this pull will remove the lock to bump Rubocop to v0.48 and beyond.

Lets discuss if the fixes proposed here are acceptable.

The remaining catches appear to me as bugs in Rubocop-0.48

IMO an array of symbols read better when the constituent entries appear to to be symbols (e.g. [:label, :type] instead of %i(label type))

This cop recommends using sqiggly-heredocs (`<<~`) -- a Ruby 2.3 feature or otherwise depend on external libraries like Activesupport, Powerpack, or Unindent. The better alternative is to disable this cop for as long as we support Rubies older than v2.3 Ref: rubocop/rubocop#4028

ashmaroli · 2017-04-01T03:07:38Z

@jekyll/ecosystem

pathawks · 2017-04-01T03:30:53Z

All of the tests are failing

envygeeks · 2017-04-01T03:32:10Z

.rubocop.yml

@@ -138,6 +138,8 @@ Style/StringLiterals:
  EnforcedStyle: double_quotes
 Style/StringLiteralsInInterpolation:
  EnforcedStyle: double_quotes
+Style/SymbolArray:
+  Enabled: false


This is an opinion and not a fact, this needs to be shipped as a unique pull request for everyone else to comment.

this needs to be shipped as a unique pull request for everyone else to comment.

This PR will ship with this cop disabled in line with behavior from 0.47.1 It can enabled via a dedicated PR

envygeeks · 2017-04-01T03:32:50Z

Rakefile

@@ -106,7 +106,7 @@ def siteify_file(file, overrides_front_matter = {})
  front_matter = {
    "title"     => title,
    "permalink" => "/docs/#{slug}/",
-    "note"      => "This file is autogenerated. Edit /#{file} instead."
+    "note"      => "This file is autogenerated. Edit /#{file} instead.",


This is not the Ruby way. This is the Go way.

We follow this style at Jekyll since last few releases of Rubocop

envygeeks · 2017-04-01T03:34:10Z

lib/jekyll/utils.rb

@@ -139,7 +139,7 @@ def parse_date(input, msg = "Input could not be parsed.")
    # Returns true if the YAML front matter is present.
    # rubocop: disable PredicateName
    def has_yaml_header?(file)
-      !!(File.open(file, "rb", &:readline) =~ %r!\A---\s*\r?\n!)
+      !File.open(file, "rb", &:readline) !~ %r!\A---\s*\r?\n!


You still have a ! so this change does nothing but superficially confuse the user. !! is straight forward and easy to spot from the get-go, where as ! then later !~ is confusing, without a significant performance improvement, this suites nothing.

The changes in this commit was made by rubocop -a

ashmaroli · 2017-04-01T03:36:24Z

All of the tests are failing

I'm investigating.. 😭

…ds cop This reverts commit 1a00f8f and additionally disables InverseMethods StyleCop

Many bugfixes have been applied following the release of v0.48. Check if those buggfixes apply to our failing tests.

ashmaroli · 2017-04-02T04:08:09Z

Note: Will remove the last two temporary commits as and when associated issues have been resolved elsewhere. Labelled do-not-merge till then.

pathawks · 2017-04-02T04:12:51Z

Gemfile

@@ -25,9 +25,9 @@ group :test do
  gem "nokogiri"
  gem "rspec"
  gem "rspec-mocks"
-  gem "rubocop", "~> 0.47.1"
-  gem "test-theme", :path => File.expand_path("./test/fixtures/test-theme", File.dirname(__FILE__))
+  gem "rubocop", :git => "https://github.com/smakagon/rubocop", :branch => "4227_ambiguous_block_association_false_positive"


Clearly we don't want to merge this.

ashmaroli · 2017-04-02T14:47:19Z

The checksum issue with gem faraday has been resolved upstream and consequently the temporary patch commit in this PR has been removed.

ashmaroli · 2017-04-02T17:04:46Z

Removed the temporary patch commit from a fork of Rubocop, which has been merged into Rubocop's master.

ashmaroli · 2017-04-04T17:26:56Z

@pathawks locking to latest release of Rubocop v0.48.1
@DirtyF the do-not-merge label may be removed.

envygeeks · 2017-04-04T17:35:04Z

Gemfile

@@ -25,7 +25,7 @@ group :test do
  gem "nokogiri"
  gem "rspec"
  gem "rspec-mocks"
-  gem "rubocop", :git => "https://github.com/bbatsov/rubocop"
+  gem "rubocop", "~> 0.48.1"


ashmaroli · 2017-04-06T02:42:14Z

ping @pathawks requesting a re-review 😃

parkr

Some comments/questions/concerns!

parkr · 2017-04-06T19:29:47Z

.rubocop.yml

 Style/IndentationWidth:
  Severity: error
+Style/InverseMethods:
+  Enabled: false


What is this?

https://rubocop.readthedocs.io/en/latest/cops_style/#styleinversemethods

parkr · 2017-04-06T19:30:53Z

test/test_document.rb

-        }
+        assert_nil(
+          @files.find { |doc| doc.relative_path == "_slides/non-outputted-slide.html" }
+        )


What about

assert_nil @files.find do |doc| ... end

Or does it complain about not having parentheses?

parkr · 2017-04-06T19:33:17Z

test/test_generated_site.rb

+      refute_nil(
+        @site.posts.index do |post|
+          post.relative_path == "_posts/2017-2-5-i-dont-like-zeroes.md"
+        end


Maybe in all these cases what we should do is pull out the method with the block, or use a unified helper (i thought we had one?):

post_of_interest = @site.posts.find {|post| post.relative_path == "_posts/2017-2-5-i-dont-like-zeroes.md" } refute_nil post_of_interest

or, with a helper method

refute_nil find_by(:relative_path, "_posts/2017-2-5-i-dont-like-zeroes.md", @site.posts)

❤️ the helper method idea. Tackle in another PR?

DirtyF · 2017-04-09T11:24:44Z

@jekyllbot: merge +dev

This was disabled in #5997 because it was new to Rubocop. I think it can be enabled now.

ashmaroli added 9 commits March 31, 2017 21:12

remove version constraint on Rubocop

07512d6

disable SymbolArray cop in ~> 0.48

ce36689

IMO an array of symbols read better when the constituent entries appear to to be symbols (e.g. [:label, :type] instead of %i(label type))

Sort gems in an alphabetical order within their section of the Gemfile.

5d90669

Put a comma after the last item of a multiline hash.

1a5f9d8

"Add a space after magic comments."

029e268

Prefer double-quoted strings

4ed3c4e

Use !~ instead of inverting =~.

1a00f8f

Exclude Gemfile and gemspec from LineLength check

a483099

jekyllbot assigned parkr Apr 1, 2017

envygeeks suggested changes Apr 1, 2017

View reviewed changes

ashmaroli added 3 commits April 1, 2017 12:28

Revert "Use !~ instead of inverting =~." and disable InverseMetho…

11f01b5

…ds cop This reverts commit 1a00f8f and additionally disables InverseMethods StyleCop

Test with Rubocop's master branch

522b931

Many bugfixes have been applied following the release of v0.48. Check if those buggfixes apply to our failing tests.

parenthesize params to avoid ambiguous block association

cdc367b

pathawks requested changes Apr 2, 2017

View reviewed changes

DirtyF added the do-not-merge label Apr 2, 2017

ashmaroli force-pushed the rubocop048 branch from a9a757f to e11b862 Compare April 2, 2017 14:21

ashmaroli force-pushed the rubocop048 branch from e11b862 to cdc367b Compare April 2, 2017 16:42

Enforce lf EndOfLine Style on all Platforms including Windows

0466a17

ashmaroli force-pushed the rubocop048 branch from b061222 to 0466a17 Compare April 2, 2017 17:38

lock to latest release v0.48.1

21bc8ba

envygeeks reviewed Apr 4, 2017

View reviewed changes

Merge branch 'master' into rubocop048

cbdae99

pathawks approved these changes Apr 6, 2017

View reviewed changes

pathawks removed the do-not-merge label Apr 6, 2017

parkr approved these changes Apr 6, 2017

View reviewed changes

jekyllbot merged commit 7d7a312 into jekyll:master Apr 9, 2017

jekyllbot added fix internal labels Apr 9, 2017

jekyllbot added a commit that referenced this pull request Apr 9, 2017

Update history to reflect merge of #5997 [ci skip]

cce53ab

pathawks added a commit that referenced this pull request Oct 23, 2017

Rubocop: Enable Style/SymbolArray

ae58186

This was disabled in #5997 because it was new to Rubocop. I think it can be enabled now.

jekyllbot mentioned this pull request Oct 23, 2017

Rubocop: Enable more cops #6470

Closed

ashmaroli deleted the rubocop048 branch October 23, 2017 06:42

jekyll locked and limited conversation to collaborators Jul 11, 2019

jekyllbot added the frozen-due-to-age label Jul 11, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump Rubocop to v0.48 #5997

Bump Rubocop to v0.48 #5997

ashmaroli commented Apr 1, 2017 •

edited

ashmaroli commented Apr 1, 2017

pathawks commented Apr 1, 2017

envygeeks Apr 1, 2017

ashmaroli Apr 1, 2017

ashmaroli Apr 1, 2017

envygeeks Apr 1, 2017

ashmaroli Apr 4, 2017

envygeeks Apr 1, 2017

ashmaroli Apr 1, 2017

ashmaroli commented Apr 1, 2017

ashmaroli commented Apr 2, 2017

pathawks Apr 2, 2017

ashmaroli commented Apr 2, 2017

ashmaroli commented Apr 2, 2017

ashmaroli commented Apr 4, 2017

envygeeks Apr 4, 2017

ashmaroli commented Apr 6, 2017

parkr left a comment

parkr Apr 6, 2017

DirtyF Apr 6, 2017

parkr Apr 6, 2017

parkr Apr 6, 2017

ashmaroli Apr 7, 2017

DirtyF commented Apr 9, 2017

Bump Rubocop to v0.48 #5997

Bump Rubocop to v0.48 #5997

Conversation

ashmaroli commented Apr 1, 2017 • edited

ashmaroli commented Apr 1, 2017

pathawks commented Apr 1, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ashmaroli commented Apr 1, 2017

ashmaroli commented Apr 2, 2017

Choose a reason for hiding this comment

ashmaroli commented Apr 2, 2017

ashmaroli commented Apr 2, 2017

ashmaroli commented Apr 4, 2017

Choose a reason for hiding this comment

ashmaroli commented Apr 6, 2017

parkr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DirtyF commented Apr 9, 2017

ashmaroli commented Apr 1, 2017 •

edited