Allow the use of listen's 3.1.x branch.

[MentalPower]

Summary

We have a need to use the newer versions of the listen gem and the version pinning in rails & specifically railties is preventing this. When the initial evented monitor feature was written, the latest version of listen was the 3.0.x series. Since then the listen project has moved on to the 3.1.x series. This patch corrects that version pinning by expanding its range to include the 3.1.x branch.

Other Information

The bundle exec rake test command was run for railties & activesupport to make sure that there was no regression. CHANGELOG, Gemfile.lock and documentation were also updated.

This is the 5.0 branch version of #26695.

[rails-bot]

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @arthurnn (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

[rails-bot]

Warning

• Pull requests are usually filed against the master branch for this repo, but this one is against 5-0-stable. Please double check that you specified the right target!

[jeremy]

You aren't disallowed from using any other version of listen. Just bump the dep in your app's Gemfile.

Consider submitting a PR against the master branch that loosens the version dep for new apps.

[matthewd]

I'm even hesitant about #26695 on master... any library that thinks it has the right to write to stderr on startup is not something we would add a dependency on, IMO. That the library in question grew such an opinion after we started using it changes that calculus slightly, but not by a lot.

[guilleiguaran]

@matthewd agree and probably many people will think that the stderr messages are from rails not from a dependency.

[e2]

@matthewd - it was never about "a right to write to stderr" but more as "somehow make sure users know they're shooting themselves in the foot and also allow silencing the warning".

The solution is to set a logger, so warnings can be logged there, see: e2/ruby_dep#26

Let me know if that solves the issue. If so, the logger has to be passed through spring -> listen -> ruby_dep.

Let me know how to output warnings and errors so that it's clearer to users where to report the problem.

[e2]

I just released RubyDep 1.5.0, which lets you do:

RubyDep.logger = Rails.logger

or

RubyDep.logger = nil

For non-rails/console apps, it uses an stderr-based logger, but with a simplified formatter for puts-like output.