watchcat 0.3.0-x64-mingw-ucrt

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8983688d6c542c9f7ac71faa0c2d7a09898ca099e06f5c83fbb778331dd4ba5f
+  data.tar.gz: 5b9d3abd0d85e454772bddcfbb6900d39ae96483d565ccfd8e9bbe9844042055
+SHA512:
+  metadata.gz: a6dd54bb0d8c7240860c064786f83c515c73dc0348b1280a4bfd1625e7da8f40b19fb15853870ac0afd8b94b34a06498c67595e231f4092a1caa2d2f44fed2c0
+  data.tar.gz: f34cc8e97640c88518e85ffb9fab3c523c66082428113161ccb01cbf92d9c6db55f915ec5587539ba97a1b401ef0d4d1623d2ff59a3004b75729f3549c5b78df

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.3.0
+
+* Support Windows

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,84 @@
+PATH
+  remote: .
+  specs:
+    watchcat (0.3.0)
+      rb_sys
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cgi (0.5.0)
+    date (3.4.1)
+    debug (1.11.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    erb (4.0.4)
+      cgi (>= 0.3.3)
+    ffi (1.17.1-arm64-darwin)
+    ffi (1.17.1-x64-mingw-ucrt)
+    ffi (1.17.1-x86_64-darwin)
+    ffi (1.17.1-x86_64-linux-gnu)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.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.5)
+    minitest-retry (0.2.5)
+      minitest (>= 5.0)
+    nokogiri (1.18.1-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.1-x64-mingw-ucrt)
+      racc (~> 1.4)
+    nokogiri (1.18.1-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.1-x86_64-linux-gnu)
+      racc (~> 1.4)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.6)
+      date
+      stringio
+    racc (1.8.1)
+    rake (13.3.0)
+    rake-compiler (1.3.0)
+      rake
+    rake-compiler-dock (1.9.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rb_sys (0.9.117)
+      rake-compiler-dock (= 1.9.1)
+    rdoc (6.14.1)
+      erb
+      psych (>= 4.0.0)
+    reline (0.6.1)
+      io-console (~> 0.5)
+    ruby_memcheck (3.0.1)
+      nokogiri
+    stringio (3.1.7)
+
+PLATFORMS
+  arm64-darwin-22
+  arm64-darwin-23
+  x64-mingw-ucrt
+  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.6.2

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"
+
+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"
+
+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

data/lib/watchcat/event.rb

@@ -0,0 +1,63 @@
+require "watchcat/kind"
+
+module Watchcat
+  class Event
+    attr_reader :kind, :paths, :raw_kind, :event
+
+    def initialize(kinds, paths, raw_kind)
+      @paths = paths
+      @raw_kind = raw_kind
+      build_kind(kinds)
+    end
+
+    def deconstruct_keys(_keys)
+      { paths: @paths, event: @event }
+    end
+
+    private
+
+    def build_kind(kinds)
+      @kind = Watchcat::EventKind.new
+      @event = kinds.shift
+      if event
+        @kind.public_send("#{event}=", Object.const_get("Watchcat::#{event.capitalize}Kind").new)
+        send("build_#{event}_kind", kinds)
+      else
+        @kind.any = Watchcat::AnyKind.new
+        if File.directory?(@paths.first)
+          @kind.any.kind = "folder"
+        else
+          @kind.any.kind = "file"
+        end
+      end
+    end
+
+    def build_access_kind(kinds)
+      @kind.access.kind = kinds.shift
+
+      if @kind.access.open? || @kind.access.close?
+        @kind.access.access_mode = Watchcat::AccessMode.new(kinds.shift)
+      end
+    end
+
+    def build_create_kind(kinds)
+      @kind.create.kind = kinds.shift
+    end
+
+    def build_modify_kind(kinds)
+      @kind.modify.kind = kinds.shift
+
+      if @kind.modify.data_change?
+        @kind.modify.data_change = Watchcat::DataChange.new(kinds.shift)
+      elsif @kind.modify.metadata?
+        @kind.modify.metadata = Watchcat::MetadataKind.new(kinds.shift)
+      elsif @kind.modify.rename?
+        @kind.modify.rename = Watchcat::RenameMode.new(kinds.shift)
+      end
+    end
+
+    def build_remove_kind(kinds)
+      @kind.remove.kind = kinds.shift
+    end
+  end
+end

data/lib/watchcat/executor.rb

@@ -0,0 +1,63 @@
+require_relative "event"
+
+module Watchcat
+  class Executor
+    def initialize(paths, recursive:, force_polling:, poll_interval:, wait_until_startup:, ignore_remove:, debounce:, block:)
+      @paths = paths
+      @recursive = recursive
+      @force_polling = force_polling
+      @poll_interval = poll_interval
+      @wait_until_startup = wait_until_startup
+      @ignore_remove = ignore_remove
+      @debounce = debounce
+      @block = block
+      @watcher = Watchcat::Watcher.new
+      @watch_thread = nil
+      @stop_requested = false
+    end
+
+    def start
+      # Always start watching in a background thread to avoid blocking
+      @watch_thread = Thread.new do
+        Thread.current.name = "watchcat-watcher"
+        start_watching
+      end
+
+      # If wait_until_startup is true, give the thread a moment to start
+      if @wait_until_startup
+        sleep 0.1
+      end
+
+      at_exit do
+        stop
+      end
+    end
+
+    def stop
+      @stop_requested = true
+      @watcher.close
+      if @watch_thread && @watch_thread.alive?
+        @watch_thread.join(1) # Wait up to 1 second for thread to finish
+      end
+    end
+
+    private
+
+    def start_watching
+      @watcher.watch(
+        @paths,
+        recursive: @recursive,
+        force_polling: @force_polling,
+        poll_interval: @poll_interval,
+        ignore_remove: @ignore_remove,
+        debounce: @debounce
+      ) do |kind, paths, raw_kind|
+        break if @stop_requested
+
+        # Create an event object and call the block
+        event = Watchcat::Event.new(kind, paths, raw_kind)
+        @block.call(event)
+      end
+    end
+  end
+end

data/lib/watchcat/kind.rb

@@ -0,0 +1,200 @@
+require "forwardable"
+
+module Watchcat
+  class EventKind
+    attr_accessor :access, :create, :modify, :remove, :any
+
+    def initialize
+      @access, @create, @modify, @remove, @any = nil, nil, nil, nil,nil
+    end
+
+    def access?
+      !@access.nil?
+    end
+
+    def create?
+      !@create.nil?
+    end
+
+    def modify?
+      !@modify.nil?
+    end
+
+    def remove?
+      !@remove.nil?
+    end
+
+    def any?
+      !@any.nil?
+    end
+  end
+
+  class AccessKind
+    extend Forwardable
+
+    attr_accessor :kind, :access_mode
+    delegate [:excute_mode?, :read_mode?, :write_mode?] => :@access_mode
+
+    def initialize
+      @kind, @access_mode = nil, nil
+    end
+
+    def read?
+      @kind == "read"
+    end
+
+    def open?
+      @kind == "open"
+    end
+
+    def close?
+      @kind == "close"
+    end
+  end
+
+  class CreateKind
+    attr_accessor :kind
+
+    def file?
+      @kind == "file"
+    end
+
+    def folder?
+      @kind == "folder"
+    end
+  end
+
+  class ModifyKind
+    extend Forwardable
+
+    attr_accessor :kind, :data_change, :metadata, :rename
+    delegate [:size?, :content?] => :@data_change
+    delegate [:access_time?, :write_time?, :permission?, :ownership?, :extended?] => :@metadata
+    delegate [:from?, :to?, :both?] => :@rename
+
+    def initialize
+      @kind, @data_change, @metadata, @rename = nil, nil, nil, nil
+    end
+
+    def data_change?
+      @kind == "data_change"
+    end
+
+    def metadata?
+      @kind == "metadata"
+    end
+
+    def rename?
+      @kind == "rename"
+    end
+  end
+
+  class RemoveKind
+    attr_accessor :kind
+
+    def file?
+      @kind == "file"
+    end
+
+    def folder?
+      @kind == "folder"
+    end
+  end
+
+  class AnyKind
+    attr_accessor :kind
+
+    def file?
+      @kind == "file"
+    end
+
+    def folder?
+      @kind == "folder"
+    end
+  end
+
+
+  class AccessMode
+    attr_accessor :mode
+
+    def initialize(mode)
+      @mode = mode
+    end
+
+    def execute_mode?
+      @mode == "execute"
+    end
+
+    def read_mode?
+      @mode == "read"
+    end
+
+    def write_mode?
+      @mode == "write"
+    end
+  end
+
+  class DataChange
+    attr_accessor :kind
+
+    def initialize(kind)
+      @kind = kind
+    end
+
+    def size?
+      @kind == "size"
+    end
+
+    def content?
+      @kind == "content"
+    end
+  end
+
+  class MetadataKind
+    attr_accessor :kind
+
+    def initialize(kind)
+      @kind = kind
+    end
+
+    def access_time?
+      @kind == "access_time"
+    end
+
+    def write_time?
+      @kind == "write_time"
+    end
+
+    def permission?
+      @kind == "permission"
+    end
+
+    def ownership?
+      @kind == "ownership"
+    end
+
+    def extended?
+      @kind == "extended"
+    end
+  end
+
+  class RenameMode
+    attr_accessor :mode
+
+    def initialize(mode)
+      @mode = mode
+    end
+
+    def from?
+      @mode == "from"
+    end
+
+    def to?
+      @mode == "to"
+    end
+
+    def both?
+      @mode == "both"
+    end
+  end
+end

data/lib/watchcat/version.rb

@@ -0,0 +1,3 @@
+module Watchcat
+  VERSION = "0.3.0"
+end

data/lib/watchcat.rb

@@ -0,0 +1,37 @@
+require_relative "watchcat/version"
+require_relative "watchcat/executor"
+
+begin
+  require "watchcat/#{RUBY_VERSION.to_f}/watchcat"
+rescue LoadError
+  require "watchcat/watchcat"
+end
+
+module Watchcat
+  class << self
+    def watch(
+      paths,
+      recursive: true,
+      force_polling: false,
+      poll_interval: nil,
+      wait_until_startup: false,
+      ignore_remove: false,
+      debounce: -1,
+      &block
+    )
+      w =
+        Watchcat::Executor.new(
+          Array(paths),
+          recursive: recursive,
+          force_polling: force_polling,
+          poll_interval: poll_interval,
+          wait_until_startup: wait_until_startup,
+          ignore_remove: ignore_remove,
+          debounce: debounce,
+          block: block
+        )
+      w.start
+      w
+    end
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: watchcat
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: x64-mingw-ucrt
+authors:
+- Yuji Yaginuma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby_memcheck
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- yuuji.yaginuma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/watchcat/.gitignore
+- lib/watchcat.rb
+- lib/watchcat/3.1/watchcat.so
+- lib/watchcat/3.2/watchcat.so
+- lib/watchcat/3.3/watchcat.so
+- lib/watchcat/3.4/watchcat.so
+- lib/watchcat/event.rb
+- lib/watchcat/executor.rb
+- lib/watchcat/kind.rb
+- lib/watchcat/version.rb
+homepage: https://github.com/y-yagi/watchcat
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/y-yagi/watchcat
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.5.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key: 
+specification_version: 4
+summary: Simple filesystem notification library for Ruby.
+test_files: []