Issue #504: try merging invoca .rubocop.yml

[ColinDKelley]

I made an attempt to address issue #504 :

• Merged in https://github.com/Invoca/style-guide/blob/master/ruby/.rubocop.yml as a start.
• Disabled a few cops and tuned a couple more to better match this repo.
• Ran rubocop -a: 931106f
• Ran rubocop -A: 8c5fed6

After the above tuning and auto-correcting, there were 15 remaining offenses:

lib/listen/event/processor.rb:73:9: C: Naming/MemoizedInstanceVariableName: Memoized variable @first_unprocessed_event_time does not match method name _remember_time_of_first_unprocessed_event. Use @_remember_time_of_first_unprocessed_event instead.
        @first_unprocessed_event_time ||= _timestamp
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/listen/options.rb:19:5: C: Style/MissingRespondToMissing: When using method_missing, define respond_to_missing?.
    def method_missing(name, *_) ...
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/listen/thread.rb:18:9: W: Lint/RescueException: Avoid rescuing the Exception class. Perhaps you meant to rescue StandardError?
        rescue Exception => ex ...
        ^^^^^^^^^^^^^^^^^^^^^^
lib/listen/thread.rb:21:9: C: Style/MultilineBlockChain: Avoid multi-line chains of blocks.
        end.tap do |thread|
        ^^^^^^^
lib/listen/thread.rb:28:26: C: Naming/MethodParameterName: Method parameter must be at least 3 characters long.
      def _log_exception(ex, thread_name, caller_stack)
                         ^^
lib/listen/thread.rb:34:34: C: Naming/MethodParameterName: Method parameter must be at least 3 characters long.
      def _exception_with_causes(ex)
                                 ^^
listen.gemspec:30:31: C: Gemspec/RequiredRubyVersion: required_ruby_version (2.2, declared in listen.gemspec) and TargetRubyVersion (2.6, which may be specified in .rubocop.yml) should be equal.
  gem.required_ruby_version = '>= 2.2.7'
                              ^^^^^^^^^^
spec/acceptance/listen_spec.rb:20:48: W: Lint/LiteralAsCondition: Literal 'both' appeared as a condition.
      case ENV['TEST_LISTEN_ADAPTER_MODES'] || 'both'
                                               ^^^^^^
spec/lib/listen/directory_spec.rb:16:21: C: Naming/MethodParameterName: Method parameter must be at least 3 characters long.
  def fake_children(ex, dir, *args, &block)
                    ^^
spec/lib/listen/thread_spec.rb:32:151: C: Layout/LineLength: Line is too long. [177/150]
                                 with(/Exception rescued in listen-worker_thread:\nArgumentError: boom!\n.*\/listen\/thread\.rb.*--- Thread.new ---.*\/listen\/thread_spec\.rb/m)
                                                                                                                                                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^
spec/lib/listen/thread_spec.rb:54:34: C: Layout/DotPosition: Place the . on the previous line, together with the method call receiver.
                                 .with(/RuntimeError: nested outer\n--- Caused by: ---\nRuntimeError: nested inner\n--- Caused by: ---\nArgumentError: boom!/)
                                 ^
spec/lib/listen/thread_spec.rb:54:151: C: Layout/LineLength: Line is too long. [158/150]
                                 .with(/RuntimeError: nested outer\n--- Caused by: ---\nRuntimeError: nested inner\n--- Caused by: ---\nArgumentError: boom!/)
                                                                                                                                                      ^^^^^^^^
spec/support/acceptance_helper.rb:46:5: C: Security/Open: The use of Kernel#open is a serious security risk.
    open(path, 'a') { |f| f.write('foo') }
    ^^^^
spec/support/acceptance_helper.rb:59:5: C: Security/Open: The use of Kernel#open is a serious security risk.
    open(path, 'w') { |f| f.write('foo') }
    ^^^^
spec/support/acceptance_helper.rb:181:3: W: Lint/DuplicateMethods: Method ListenerWrapper#changes is defined at both spec/support/acceptance_helper.rb:146 and spec/support/acceptance_helper.rb:181.
  def changes
  ^^^^^^^^^^^

After fixing the easy ones, there are 5 offenses left:

lib/listen/options.rb:19:5: C: Style/MissingRespondToMissing: When using method_missing, define respond_to_missing?.
    def method_missing(name, *_) ...
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/listen/thread.rb:18:9: W: Lint/RescueException: Avoid rescuing the Exception class. Perhaps you meant to rescue StandardError?
        rescue Exception => exception ...
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
listen.gemspec:30:31: C: Gemspec/RequiredRubyVersion: required_ruby_version (2.2, declared in listen.gemspec) and TargetRubyVersion (2.6, which may be specified in .rubocop.yml) should be equal.
  gem.required_ruby_version = '>= 2.2.7'
                              ^^^^^^^^^^
spec/support/acceptance_helper.rb:46:5: C: Security/Open: The use of Kernel#open is a serious security risk.
    open(path, 'a') { |f| f.write('foo') }
    ^^^^
spec/support/acceptance_helper.rb:59:5: C: Security/Open: The use of Kernel#open is a serious security risk.
    open(path, 'w') { |f| f.write('foo') }
    ^^^^

65 files inspected, 5 offenses detected

[houndci-bot]

Some files could not be reviewed due to errors:

.rubocop.yml: Layout/EmptyLineAfterGuardClause has the wrong namespace - shou...

.rubocop.yml: Layout/EmptyLineAfterGuardClause has the wrong namespace - should be Style
Warning: unrecognized cop Lint/SuppressedException found in .rubocop.yml
Warning: unrecognized cop Layout/HashAlignment found in .rubocop.yml
Warning: unrecognized cop Layout/HeredocIndentation found in .rubocop.yml
Warning: unrecognized cop Lint/RedundantRequireStatement found in .rubocop.yml
Warning: unrecognized cop Naming/RescuedExceptionsVariableName found in .rubocop.yml
Error: Unknown Ruby version 2.6 found in `TargetRubyVersion` parameter (in .rubocop.yml).
Supported versions: 2.1, 2.2, 2.3, 2.4, 2.5

[ColinDKelley]

@KapilSachdev What do you think?

[KapilSachdev]

We can update to 1.2.0, I think there will be not much changes as I have checked in my local machine.

[ColinDKelley]

Currently, the highest supported by hound is 0.91.0.

[KapilSachdev]

We can use something else than hound in that case? Github actions like lint-action.

[ColinDKelley]

@KapilSachdev That sounds reasonable. So that we don't bog this Issue down, can you file a separate issue for that?

[KapilSachdev]

The time i commented about lint-action, i was unaware of one issue that they have i.e. annotations don't work when PR is created from a fork. Which is where most PRs come from. Though there is a new pull_request_target event for that, but it still isn't working (from what i had tried).
shoulda-matcher gem also recently reverted from lint-action (which initially uses hound) and has fallen back to non-annotation based rubocop linting (like what rails uses).

I will create a issue for rubocop linting based on github actions.

[KapilSachdev]

Adding the assignment in the next line could help in less indentation spaces.

Suggested change

	@listener = if callback
	Listen.send(*args) do |modified, added, removed|
	# Add changes to trigger frozen Hash error, making sure lag is enough
	_add_changes(:modified, modified, changes)
	_add_changes(:added, added, changes)
	_add_changes(:removed, removed, changes)
	unless callback == :track_changes
	callback.call(modified, added, removed)
	end
	end
	else
	Listen.send(*args)
	end
	@listener =
	if callback
	Listen.send(*args) do |modified, added, removed|
	# Add changes to trigger frozen Hash error, making sure lag is enough
	_add_changes(:modified, modified, changes)
	_add_changes(:added, added, changes)
	_add_changes(:removed, removed, changes)
	unless callback == :track_changes
	callback.call(modified, added, removed)
	end
	end
	else
	Listen.send(*args)
	end

[ioquatix]

I also agree, this alignment change is a mess, and it should probably just be

@listener = if callback
  Listen.send(...)
else
  ...
end

[ColinDKelley]

Rubocop wouldn't tolerate that formatting. I put 10 minutes into finding an option that would, but I didn't find it. Instead, I tried the if on the next line and it was ok with that. Of course then it complained that the method was too long! So I moved an unless from leading to trailing. 🤦

745d0e3

[KapilSachdev]

I think below should help. However as you have used next line, you won't need this then. Next lines looks good to me.

Layout/EndAlignment:
  EnforcedStyleAlignWith: variable

[ColinDKelley]

Thanks @KapilSachdev. I made that EnforcedStyleAlignWith: variable change and put the @listener = code back the way it was, then ran rubocop -a -A. e1045d2

[ColinDKelley]

@KapilSachdev I merged up to latest master and applied all the changes in discussion here.

$ rubocop
Inspecting 65 files
.................................................................

65 files inspected, no offenses detected