svoop / autotest-fsevent

Use FSEvent (Mac OS X 10.5 or higher) instead of filesystem polling.

autotest-fsevent

Autotest relies on filesystem polling to detect modifications in source code files. In other words: The filesytem is constantly being traversed which causes quite some load on both the CPU and the harddrive. This is not healthy for your Mac and if you are working on a portable computer, it will drain your battery.

Apple has introduced FSEvent with Mac OS X 10.5 which is a very efficient way to have the operating system monitor file alterations. This gem teaches autotest to use FSEvent and therefore be nice to your Mac.

• Homepage
• Author: Sven Schwyn - Bitcetera

Thank you for supporting free and open-source software by sponsoring on GitHub or on Donorbox. Any gesture is appreciated, from a single Euro for a ☕️ cup of coffee to 🍹 early retirement.

Install

This gem is cryptographically signed in order to assure it hasn't been tampered with. Unless already done, please add the author's public key as a trusted certificate now:

gem cert --add <(curl -Ls https://raw.github.com/svoop/autotest-fsevent/main/certs/svoop.pem)

In order to compile the fsevent binary at install time, Xcode (macOS development suite) must be installed. You can download it for free from:

https://developer.apple.com

You can use any ZenTest-compatible test suite with this gem such as:

• minitest-autotest
• Zentest
• autotest-standalone

Add this to your Gemfile or gems.rb:

gem autotest-fsevent, group: :development

And securely install the bundle:

bundle install --trust-policy MediumSecurity

Then add the following line after all other requires in your ~/.autotest file:

require 'autotest/fsevent'

Troubleshooting

Autotest Binary Not Present

Make sure you have either the ZenTest gem or the autotest-standalone gem installed. This dependency has been dropped as of autotest-fsevent-0.2.3 in order to allow any compatible test suite.

Compilation of fsevent_sleep Failed

Make sure you have Xcode (Mac OS X Development Suite) installed. You can download it for free from:

https://developer.apple.com

If you don't want to install Xcode, download the prebuilt fsevent_sleep binary, make the downloaded binary executable and install the gem as follows:

FSEVENT_SLEEP="/absolute/path/to/fsevent_sleep" gem install autotest-fsevent

Development

To install the development dependencies:

bundle install

Please submit issues on:

https://github.com/svoop/autotest-fsevent/issues

To contribute code, fork the project on Github, add your code and submit a pull request:

https://help.github.com/articles/fork-a-repo

License

The gem is available as open source under the terms of the MIT License.

autotest-fsevent's Issues

Warning, Method Redefined

Hi. I upgraded last night to version 0.1.2 last night and I am now received the following warning:

/opt/local/lib/ruby/gems/1.8/gems/autotest-fsevent-0.1.2/lib/autotest/fsevent.rb:35: warning: method redefined; discarding old wait_for_changes

cannot load such file -- autotest upon require

My name is Maciej Mensfeld and I run a research security project called https://diffend.io.

While that's not a security issue, wanted to bring to your attention, that upon requiring of this gem (diffend does that to run a sandbox for security assessment of gems based on their behaviors), it fails with:

Traceback (most recent call last):
	2: from -e:1:in `'
	1: from /home/app/.rbenv/versions/2.7.2/lib/ruby/2.7.0/rubygems/core_ext/kernel_require.rb:92:in `require'
/home/app/.rbenv/versions/2.7.2/lib/ruby/2.7.0/rubygems/core_ext/kernel_require.rb:92:in `require': cannot load such file -- autotest-fsevent (LoadError)
	9: from -e:1:in `'
	8: from /home/app/.rbenv/versions/2.7.2/lib/ruby/2.7.0/rubygems/core_ext/kernel_require.rb:156:in `require'
	7: from /home/app/.rbenv/versions/2.7.2/lib/ruby/2.7.0/rubygems/core_ext/kernel_require.rb:168:in `rescue in require'
	6: from /home/app/.rbenv/versions/2.7.2/lib/ruby/2.7.0/rubygems/core_ext/kernel_require.rb:168:in `require'
	5: from /home/app/.rbenv/versions/2.7.2/lib/ruby/gems/2.7.0/gems/autotest-fsevent-0.2.18/lib/autotest-fsevent.rb:4:in `'
	4: from /home/app/.rbenv/versions/2.7.2/lib/ruby/2.7.0/rubygems/core_ext/kernel_require.rb:92:in `require'
	3: from /home/app/.rbenv/versions/2.7.2/lib/ruby/2.7.0/rubygems/core_ext/kernel_require.rb:92:in `require'
	2: from /home/app/.rbenv/versions/2.7.2/lib/ruby/gems/2.7.0/gems/autotest-fsevent-0.2.18/lib/autotest/fsevent.rb:2:in `'
	1: from /home/app/.rbenv/versions/2.7.2/lib/ruby/2.7.0/rubygems/core_ext/kernel_require.rb:92:in `require'
/home/app/.rbenv/versions/2.7.2/lib/ruby/2.7.0/rubygems/core_ext/kernel_require.rb:92:in `require': cannot load such file -- autotest (LoadError)

which (probably) indicates, that XYZ is not present upon loading.

repro:

Gemfile

source 'https://rubygems.org'

gem 'autotest-fsevent'

steps:

1. bundle install
2. bundle exec ruby -e 'require "autotest-fsevent"'

Update for Big Sur

@bvicenzo wrote:

Hi!
Is it possible to add support to MacOS Big Sur?
I'm getting this error on gem installing.