Skip to content

Commit

Permalink
Initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
netzpirat committed Feb 21, 2011
0 parents commit 5bcfd13
Show file tree
Hide file tree
Showing 19 changed files with 868 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.DS_Store
._.DS_Store
Icon?
1 change: 1 addition & 0 deletions .rvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
rvm jruby-1.6.0.RC2
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source 'http://rubygems.org'

# Specify your gem's dependencies in jruby-notify.gemspec
gemspec
25 changes: 25 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
PATH
remote: .
specs:
jruby-notify (0.0.1)

GEM
remote: http://rubygems.org/
specs:
diff-lcs (1.1.2)
rspec (2.5.0)
rspec-core (~> 2.5.0)
rspec-expectations (~> 2.5.0)
rspec-mocks (~> 2.5.0)
rspec-core (2.5.1)
rspec-expectations (2.5.0)
diff-lcs (~> 1.1.2)
rspec-mocks (2.5.0)

PLATFORMS
java

DEPENDENCIES
bundler (~> 1.0.10)
jruby-notify!
rspec (~> 2.5.0)
22 changes: 22 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (c) 2011 Michael Kessler

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
76 changes: 76 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# JNotify for JRuby

jruby-notify is a thin wrapper around the [JNotify](http://jnotify.sourceforge.net/) library, a java library that allow
java application to listen to file system events, such as:

* File created
* File modified
* File renamed
* File deleted

## Supported platforms

The gem is written for JRuby and uses the JNotify library that supports the following platforms:

* Windows (2000 or newer)
* Linux with INofity support (2.6.14 or newer)
* Mac OS X (10.5 or newer)

Please have a look at the platform specific notes on the [JNotify](http://jnotify.sourceforge.net/) page.

## Installation

gem install jruby-notify

## Example

require 'jruby-notify'

notify = JRubyNotify::Notify.new
notify.watch Dir.pwd do |path, file|
puts "Detected change in: #{ File.join(path, file) }"
end

notify.run

## Forecast

With the upcoming release of Java 7 there will be a more robust solution to this problem with the
[WatchService API](http://java.sun.com/developer/technicalArticles/javase/nio/#6). This gem will
make use of this API when it'll be released.

## Other solutions

There are other gems that provides almost the same functionality for MRI:

* [rb-fsevent](https://github.com/thibaudgg/rb-fsevent) for Mac OS X only
* [rb-inotify](https://github.com/nex3/rb-inotify) for Linux only

## Acknowledgement

Omry Yadan for writting the JNotify library and Matthew Donoughe for providing the Mac OS X support.

## License

(The MIT License)

Copyright (c) 2011 Michael Kessler

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
6 changes: 6 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
require 'bundler'
Bundler::GemHelper.install_tasks

require 'rspec/core/rake_task'
RSpec::Core::RakeTask.new(:spec)
task :default => :spec
21 changes: 21 additions & 0 deletions jruby-notify.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# -*- encoding: utf-8 -*-
$:.push File.expand_path('../lib', __FILE__)
require 'jruby-notify'

Gem::Specification.new do |s|
s.name = %q{jruby-notify}
s.version = JRubyNotify::VERSION
s.platform = Gem::Platform::RUBY

s.authors = ['Michael Kessler']
s.email = %q{michi@netzpiraten.ch}
s.homepage = %q{https://github.com/netzpirat/jruby-notify}
s.summary = %q{JNotify for JRuby}
s.description = %q{JRuby-Notify is an thin wrapper around the JNotify library.}

s.add_development_dependency 'bundler', '~> 1.0.10'
s.add_development_dependency 'rspec', '~> 2.5.0'

s.files = Dir.glob('lib/**/*') + %w[LICENSE README.md]
s.require_paths = ['lib']
end
Loading

0 comments on commit 5bcfd13

Please sign in to comment.