No commit activity in last 3 years
No release in over 3 years
Rack middleware to handle events on file modifications
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
~> 10.0
>= 0

Runtime

>= 0
 Project Readme

Rack::FileWatcher

Build Status

Rack middleware to handle events on file modifications.

If you are using an application server of prefork type(unicorn, passenger), it is useful if you want to do a simple processing in the child process. (For example, clear the Rails.cache)

Installation

Add this line to your application's Gemfile:

gem 'rack-file-watcher'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rack-file-watcher

Usage

Basic configuring the middleware:

require 'rack/file_watcher'

use Rack::FileWatcher, 'tmp/watch.txt' do
  puts 'updated.'
end

app = proc do |env|
  [ 200, {'Content-Type' => 'text/plain'}, 'Hello World' ]
end
run app

Example

Example in Rails:

# config/application.rb

module YourApp
  class Application < Rails::Application

    # ...

    config.middleware.use Rack::FileWatcher, config.root.join('tmp/clear_cache.txt') do
      Rails.cache.clear
    end
  end
end

Contributing

  1. Fork it ( https://github.com/daic-h/rack-file-watcher/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Copyright

Copyright (c) Daichi HIRATA, released under the MIT license.