watchcat 0.2.0

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in watchcat.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    watchcat (0.2.0)
+      drb
+      rb_sys
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    drb (2.2.1)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86_64-darwin)
+    ffi (1.17.0-x86_64-linux-gnu)
+    io-console (0.7.2)
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    minitest (5.25.1)
+    minitest-retry (0.2.3)
+      minitest (>= 5.0)
+    nokogiri (1.16.7-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-linux)
+      racc (~> 1.4)
+    psych (5.1.2)
+      stringio
+    racc (1.8.1)
+    rake (13.2.1)
+    rake-compiler (1.2.8)
+      rake
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rb_sys (0.9.102)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    reline (0.5.10)
+      io-console (~> 0.5)
+    ruby_memcheck (3.0.0)
+      nokogiri
+    stringio (3.1.1)
+
+PLATFORMS
+  arm64-darwin-22
+  arm64-darwin-23
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  debug
+  listen
+  minitest
+  minitest-retry
+  rake
+  rake-compiler
+  ruby_memcheck
+  watchcat!
+
+BUNDLED WITH
+   2.5.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Yuji Yaginuma
+
+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.

data/README.md

@@ -0,0 +1,103 @@
+# Watchcat
+
+Simple filesystem notification library for Ruby.
+
+## How
+
+This gem uses [Notify](https://github.com/notify-rs/notify) to get notifications.
+
+## Platforms
+
+This gem supports Linux and macOS. Due to the using `fork`, this doesn't support Windows now.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add watchcat
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install watchcat
+
+## Usage
+
+Please specify a filename or directory and callback block to `Watchcat.watch`. The callback will call when the specified file or directory is changed.
+
+```ruby
+require "watchcat"
+
+w = Watchcat.watch("/tmp/test") do |e|
+  pp e.paths, e.kind
+end
+
+sleep
+```
+
+The value that is passed to the callback holds the paths that changed and the file change event. For example, if a file is created under the `/tmp/test`, you will get the following output.
+
+```
+["/tmp/test/a.txt"]
+#<Watchcat::EventKind:0x00007f84be7161d8 @access=nil, @create=#<Watchcat::CreateKind:0x00007f84b99eaa08 @kind="file">, @modify=nil, @remove=nil>
+["/tmp/test/a.txt"]
+#<Watchcat::EventKind:0x00007f84be7159b8
+ @access=nil,
+ @create=nil,
+ @modify=#<Watchcat::ModifyKind:0x00007f84be715968 @data_change=nil, @kind="metadata", @metadata=#<Watchcat::MetadataKind:0x00007f84b99e7a60 @kind=nil>, @rename=nil>,
+ @remove=nil>
+["/tmp/test/a.txt"]
+#<Watchcat::EventKind:0x00007f84be714dd8
+ @access=#<Watchcat::AccessKind:0x00007f84b99e3708 @access_mode=#<Watchcat::AccessMode:0x00007f84b99e3640 @mode="write">, @kind="close">,
+ @create=nil,
+ @modify=nil,
+ @remove=nil>
+```
+
+You can know what event is happened with `Watchcat::EventKind`. For example, what a file is changed or not, you can check with `Watchcat::EventKind#modify?`. Seed the following example for details.
+
+```ruby
+require "watchcat"
+
+w = Watchcat.watch("/tmp/target") do |e|
+  if e.kind.create?
+    if e.kind.create.file?
+      puts "'#{e.paths[0]}'(File) is added."
+    elsif e.kind.create.folder?
+      puts "'#{e.paths[0]}'(Folder) is added."
+    end
+  elsif e.kind.modify?
+    if e.kind.modify.data_change?
+      puts "'#{e.paths[0]}' is updated."
+    end
+  elsif e.kind.remove?
+    if e.kind.remove.file?
+      puts "'#{e.paths[0]}'(File) is removed."
+    elsif e.kind.remove.folder?
+      puts "'#{e.paths[0]}'(Folder) is removed."
+    end
+  end
+end
+
+sleep
+```
+
+
+**CAUTION** The `watchcat` doesn't normalize the events. So the result might change per the platform.
+
+
+### Options
+
+| Name                       | Description                              | Default           |
+| -------------------------- | -----------------------------------------| ----------------- |
+| **recursive**              | Watch a directory recursively or not.    | `true`            |
+| **force_polling**          | Force to use a polling to watch.         | `false`           |
+| **debounce**               | Debounce events for the same file.       | `-1`              |
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/y-yagi/watchcat.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "rake/testtask"
+require "rb_sys/extensiontask"
+require "bundler/gem_tasks"
+require "minitest/test_task"
+require "ruby_memcheck"
+
+task default: :test
+
+GEMSPEC = Gem::Specification.load("watchcat.gemspec")
+RbSys::ExtensionTask.new("watchcat", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/watchcat"
+end
+
+test_config = lambda do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.deps << :compile
+  t.test_files = FileList[File.expand_path("test/**/*_test.rb", __dir__)]
+  t.warning = true
+  t.verbose = true
+end
+
+Rake::TestTask.new(&test_config)
+namespace :test do
+  RubyMemcheck::TestTask.new(:valgrind, &test_config)
+end
+
+Minitest::TestTask.create(:unit_test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = false
+  t.test_globs = ["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+task console: :compile do
+  ruby "bin/console"
+end
+
+task example: :compile do
+  ruby "bin/example"
+end

data/ext/watchcat/.gitignore

@@ -0,0 +1 @@
+target