watchcat 0.2.1-x86_64-linux → 0.4.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1a3d40bdf9a9bc7f37f4d09c48696ae7d284826c245838c4c265a4f58915d51
-  data.tar.gz: edbb2fea91f315f7248a86f29f751d7f35c0664a75fb57e783a060cadd723e3c
+  metadata.gz: 39e18906d85d9534153d3cdb2c417635eae3a631c4b8992a9d663f524230ea8c
+  data.tar.gz: daba78690d4d037271282828df66c81303dd82810b2e2fa64a6c3f99a0969619
 SHA512:
-  metadata.gz: 7bb34a1bc339c9e865b8d5ae8eff2742c7d52c87860c0030595a2d7784d4783cf6c93b0ba0a779abd94d9f0fa14a8f1e21b92c84b1b3bdb888ee2fe8f03cd737
-  data.tar.gz: 894556bfa2fbb66362f167906639936cc7242f62212e25416c38612c09b187fa8aa899f0f44a91fa655daf6287e52fdbabfc96e07abf3b2cb4ee877970ce897b
+  metadata.gz: e2ff13c8c9fcf11a83a69a91b28a1b0420537cefe4302f2268a0d0d7beb8a1327749329aa831e0a776b60eb8ee8b1fc5290bced2f1b3c349be5f1a112a04fe71
+  data.tar.gz: ab4dcdead0a8acba220c2dbd3a2394fa67124414131375368a520b15aa4fd4a953493ecb9fdc419ccc20be072f1596ec9c91da314c6aa858f9d5064411396d9d

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.4.0
+
+* Add CLI
+* Add filters option
+
+## 0.3.0
+
+* Support Windows

data/Gemfile.lock

@@ -1,57 +1,72 @@
 PATH
   remote: .
   specs:
-    watchcat (0.2.1)
-      drb
+    watchcat (0.4.0)
+      psych
       rb_sys
 
 GEM
   remote: https://rubygems.org/
   specs:
-    debug (1.9.2)
+    cgi (0.5.0)
+    date (3.4.1)
+    debug (1.11.0)
       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)
+    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.2)
-    minitest-retry (0.2.3)
+    minitest (5.25.5)
+    minitest-retry (0.2.5)
       minitest (>= 5.0)
-    nokogiri (1.16.7-arm64-darwin)
+    nokogiri (1.18.1-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-darwin)
+    nokogiri (1.18.1-x64-mingw-ucrt)
       racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-linux)
+    nokogiri (1.18.1-x86_64-darwin)
       racc (~> 1.4)
-    psych (5.1.2)
+    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.2.1)
-    rake-compiler (1.2.8)
+    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.103)
-    rdoc (6.7.0)
+    rb_sys (0.9.117)
+      rake-compiler-dock (= 1.9.1)
+    rdoc (6.14.1)
+      erb
       psych (>= 4.0.0)
-    reline (0.5.10)
+    reline (0.6.1)
       io-console (~> 0.5)
-    ruby_memcheck (3.0.0)
+    ruby_memcheck (3.0.1)
       nokogiri
-    stringio (3.1.1)
+    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
@@ -67,4 +82,4 @@ DEPENDENCIES
   watchcat!
 
 BUNDLED WITH
-   2.5.4
+   2.6.2

data/README.md

@@ -8,7 +8,7 @@ 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.
+This gem supports Linux, macOS and Windows.
 
 ## Installation
 
@@ -27,7 +27,7 @@ Please specify a filename or directory and callback block to `Watchcat.watch`. T
 ```ruby
 require "watchcat"
 
-w = Watchcat.watch("/tmp/test") do |e|
+Watchcat.watch("/tmp/test") do |e|
   pp e.paths, e.kind
 end
 
@@ -58,7 +58,7 @@ You can know what event is happened with `Watchcat::EventKind`. For example, wha
 ```ruby
 require "watchcat"
 
-w = Watchcat.watch("/tmp/target") do |e|
+Watchcat.watch("/tmp/target") do |e|
   if e.kind.create?
     if e.kind.create.file?
       puts "'#{e.paths[0]}'(File) is added."
@@ -84,7 +84,6 @@ sleep
 
 **CAUTION** The `watchcat` doesn't normalize the events. So the result might change per the platform.
 
-
 ### Options
 
 | Name                       | Description                              | Default           |
@@ -94,6 +93,82 @@ sleep
 | **debounce**               | Debounce events for the same file.       | `-1`              |
 
 
+### Filters Option
+
+You can use the `filters` option to ignore specific event types:
+
+| Key             | Description                       |
+|-----------------|-----------------------------------|
+| ignore_remove   | Ignore remove (delete) events     |
+| ignore_access   | Ignore access events              |
+| ignore_create   | Ignore create events              |
+| ignore_modify   | Ignore modify events              |
+
+Example usage:
+
+```ruby
+Watchcat.watch("/tmp/test", filters: { ignore_remove: true, ignore_access: true }) do |e|
+  pp e.paths, e.kind
+end
+```
+
+
+## CLI
+
+`watchcat` comes with a command-line interface that allows you to watch files and execute commands when changes occur.
+
+### Usage
+
+```
+$ watchcat -C config.yml
+```
+
+### Configuration File
+
+The configuration file should be in YAML format. Here's an example:
+
+```yaml
+watches:
+  - path: "./lib"
+    recursive: true
+    debounce: 300
+    filters:
+      ignore_access: true
+    patterns:
+      - "*.rb"
+      - "*.yml"
+    actions:
+      - command: "echo 'Ruby/YAML file changed: {{file_name}}'"
+      - command: "rubocop {{file_path}}"
+```
+
+### Configuration Options
+
+Each watch entry supports the following options:
+
+| Option      | Description                                            | Default |
+|-------------|--------------------------------------------------------|---------|
+| path        | Directory or file path to watch (required)             | -       |
+| recursive   | Watch a directory recursively or not                   | `true`  |
+| debounce    | Debounce events for the same file (in milliseconds)    | `500`   |
+| filters     | Event filters (same as library filters option)         | `{}`    |
+| patterns    | File patterns to match (using File.fnmatch)            | `[]`    |
+| actions     | Commands to execute when files change                  | `[]`    |
+
+### Available Variables for Commands
+
+When specifying commands, you can use the following variables:
+
+| Variable      | Description                              | Example                |
+|---------------|------------------------------------------|------------------------|
+| {{file_path}} | Full path of the changed file            | `/home/user/app/file.rb` |
+| {{file_dir}}  | Directory containing the file            | `/home/user/app`        |
+| {{file_name}} | File name with extension                 | `file.rb`               |
+| {{file_base}} | File name without extension              | `file`                  |
+| {{file_ext}}  | File extension                           | `.rb`                   |
+
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/y-yagi/watchcat.

data/cli_example.yml

@@ -0,0 +1,14 @@
+# Watchcat Configuration File
+
+watches:
+  - path: "./lib"
+    recursive: true
+    debounce: 300
+    filters:
+      ignore_access: true
+    patterns:
+      - "*.rb"
+      - "*.yml"
+    actions:
+      - command: "echo 'Ruby/YAML file changed: {{file_name}}'"
+      - command: "rubocop {{file_path}}"

data/exe/watchcat

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "watchcat"
+require "watchcat/cli"
+
+begin
+  Watchcat::CLI.start(ARGV)
+rescue Watchcat::CLI::Error => e
+  puts "Error: #{e.message}"
+  exit 1
+rescue Interrupt
+  puts "\nGoodbye!"
+  exit 0
+end

data/lib/watchcat/cli/action_executor.rb

@@ -0,0 +1,43 @@
+module Watchcat
+  module CLI
+    class ActionExecutor
+      def initialize(file_path, event)
+        @file_path = file_path
+        @event = event
+        @file_dir = File.dirname(file_path)
+        @file_name = File.basename(file_path)
+        @file_ext = File.extname(file_path)
+        @file_base = File.basename(file_path, @file_ext)
+      end
+
+      def execute(action)
+        execute_command(action)
+      rescue => e
+        puts "Error executing action #{action}: #{e.message}"
+      end
+
+      private
+
+      def execute_command(action)
+        command = substitute_variables(action["command"])
+        puts "Executing: #{command}"
+
+        success = system(command)
+        unless success
+          puts "Command failed with exit code: #{$?.exitstatus}"
+        end
+      end
+
+      def substitute_variables(template)
+        return template unless template.is_a?(String)
+
+        template
+          .gsub("{{file_path}}", @file_path)
+          .gsub("{{file_dir}}", @file_dir)
+          .gsub("{{file_name}}", @file_name)
+          .gsub("{{file_base}}", @file_base)
+          .gsub("{{file_ext}}", @file_ext)
+      end
+    end
+  end
+end

data/lib/watchcat/cli/config.rb

@@ -0,0 +1,41 @@
+require "psych"
+
+module Watchcat
+  module CLI
+    class Config
+      attr_reader :watches
+
+      def initialize(data)
+        @watches = parse_watches(data["watches"] || [])
+      end
+
+      def self.load(file_path)
+        unless File.exist?(file_path)
+          raise Error, "Configuration file not found: #{file_path}"
+        end
+
+        begin
+          data = Psych.load_file(file_path)
+          new(data)
+        rescue Psych::SyntaxError => e
+          raise Error, "Invalid YAML syntax in #{file_path}: #{e.message}"
+        end
+      end
+
+      private
+
+      def parse_watches(watches_data)
+        watches_data.map do |watch_config|
+          {
+            path: watch_config["path"],
+            recursive: watch_config.fetch("recursive", true),
+            patterns: watch_config["patterns"] || [],
+            actions: watch_config["actions"] || [],
+            debounce: watch_config.fetch("debounce", 500),
+            filters: watch_config["filters"]&.transform_keys(&:to_sym) || {},
+          }
+        end
+      end
+    end
+  end
+end

data/lib/watchcat/cli/watcher.rb

@@ -0,0 +1,84 @@
+module Watchcat
+  module CLI
+    class Watcher
+      def initialize(config)
+        @config = config
+        @watchers = []
+      end
+
+      def start
+        puts "Starting Watchcat file watcher..."
+
+        @config.watches.each do |watch_config|
+          start_watching_path(watch_config)
+        end
+
+        puts "Watchcat is now watching for file changes. Press Ctrl+C to stop."
+
+        # Keep the main thread alive
+        begin
+          sleep
+        rescue Interrupt
+          puts "\nStopping Watchcat..."
+          stop
+        end
+      end
+
+      def stop
+        @watchers.each(&:stop)
+        @watchers.clear
+      end
+
+      private
+
+      def start_watching_path(watch_config)
+        path = watch_config[:path]
+
+        unless File.exist?(path)
+          puts "Warning: Path does not exist: #{path}"
+          return
+        end
+
+        puts "Watching: #{path} (recursive: #{watch_config[:recursive]}, debounce: #{watch_config[:debounce]}ms)"
+
+        watcher = Watchcat.watch(
+          path,
+          recursive: watch_config[:recursive],
+          filters: watch_config[:filters],
+        ) do |event|
+          handle_file_event(event, watch_config)
+        end
+
+        @watchers << watcher
+      end
+
+      def handle_file_event(event, watch_config)
+        return if event.kind.access?
+
+        event.paths.each do |file_path|
+          next unless should_process_file?(file_path, watch_config[:patterns])
+
+          puts "File changed: #{file_path} #{event.kind}"
+          execute_actions(file_path, event, watch_config[:actions])
+        end
+      end
+
+      def should_process_file?(file_path, patterns)
+        return true if patterns.empty?
+
+        patterns.any? do |pattern|
+          File.fnmatch?(pattern, File.basename(file_path)) ||
+            File.fnmatch?(pattern, file_path)
+        end
+      end
+
+      def execute_actions(file_path, event, actions)
+        executor = ActionExecutor.new(file_path, event)
+
+        actions.each do |action|
+          executor.execute(action)
+        end
+      end
+    end
+  end
+end

data/lib/watchcat/cli.rb

@@ -0,0 +1,39 @@
+require "optparse"
+require_relative "cli/watcher"
+require_relative "cli/config"
+require_relative "cli/action_executor"
+
+module Watchcat
+  module CLI
+    class Error < StandardError; end
+    class << self
+      def start(argv)
+        options = parse(argv)
+        config = Config.load(options[:config])
+        watcher = Watcher.new(config)
+        watcher.start
+      rescue => e
+        raise Error, "Failed to start Watchcat: #{e.message}"
+      end
+
+      def parse(argv)
+        options = {}
+        OptionParser.new do |opts|
+          opts.banner = "Usage: watchcat [options]"
+
+          opts.on("-C", "--config PATH", "Path to the config file") do |v|
+            options[:config] = v
+          end
+
+          opts.on("-h", "--help", "Show this help message") do
+            puts opts
+            exit
+          end
+        end.parse!(argv)
+
+        raise OptionParser::MissingArgument.new("-C") if options[:config].nil?
+        options
+      end
+    end
+  end
+end

data/lib/watchcat/debouncer.rb

@@ -0,0 +1,41 @@
+module Watchcat
+  class Debouncer
+    def initialize
+      @timers = {}
+      @mutex = Mutex.new
+    end
+
+    def debounce(key, delay_ms, &block)
+      @mutex.synchronize do
+        # Cancel existing timer for this key
+        if @timers[key]
+          @timers[key].kill
+        end
+
+        # Create new timer
+        @timers[key] = Thread.new do
+          sleep(delay_ms / 1000.0)  # Convert ms to seconds
+
+          @mutex.synchronize do
+            @timers.delete(key)
+          end
+
+          block.call
+        end
+      end
+    end
+
+    def clear
+      @mutex.synchronize do
+        @timers.each_value(&:kill)
+        @timers.clear
+      end
+    end
+
+    def pending_count
+      @mutex.synchronize do
+        @timers.size
+      end
+    end
+  end
+end

data/lib/watchcat/executor.rb

@@ -1,67 +1,59 @@
-require "drb"
-require "drb/unix"
-require_relative "server"
-require_relative "client"
+require_relative "event"
 
 module Watchcat
   class Executor
-    def initialize(paths, recursive:, force_polling:, poll_interval:, wait_until_startup:, ignore_remove:, debounce:, block:)
-      @service = nil
-      @child_pid = nil
+    def initialize(paths, recursive:, force_polling:, poll_interval:, filters:, debounce:, block:)
       @paths = paths
       @recursive = recursive
       @force_polling = force_polling
       @poll_interval = poll_interval
-      @wait_until_startup = wait_until_startup
-      @ignore_remove = ignore_remove
+      @filters = filters || {}
       @debounce = debounce
       @block = block
       @watcher = Watchcat::Watcher.new
+      @watch_thread = nil
+      @stop_requested = false
     end
 
     def start
-      server = Server.new(@block)
-      @service = DRb.start_service("drbunix:", server)
-      client = nil
-      client = build_client if @wait_until_startup
-
-      @child_pid = fork do
-        client = build_client unless @wait_until_startup
-        Process.setproctitle("watchcat: watcher")
-        client.run
+      # Always start watching in a background thread to avoid blocking
+      @watch_thread = Thread.new do
+        Thread.current.name = "watchcat-watcher"
+        start_watching
       end
 
-      main = Process.pid
       at_exit do
-        @exit_status = $!.status if $!.is_a?(SystemExit)
-        stop if Process.pid == main
-        exit @exit_status if @exit_status
+        stop
       end
     end
 
     def stop
-      begin
-        @watcher.close
-        Process.kill(:KILL, @child_pid)
-      rescue Errno::ESRCH
-        # NOTE: We can ignore this error because there process is already dead.
+      @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
-      @service.stop_service
     end
 
     private
 
-    def build_client
-      Client.new(
-        @service.uri,
-        watcher: @watcher,
-        paths: @paths,
+    def start_watching
+      @watcher.watch(
+        @paths,
         recursive: @recursive,
         force_polling: @force_polling,
         poll_interval: @poll_interval,
-        debounce: @debounce,
-        ignore_remove: @ignore_remove
-      )
+        ignore_remove: @filters[:ignore_remove],
+        ignore_access: @filters[:ignore_access],
+        ignore_create: @filters[:ignore_create],
+        ignore_modify: @filters[:ignore_modify],
+        debounce: @debounce
+      ) do |kind, paths, raw_kind|
+        break if @stop_requested
+
+        event = Watchcat::Event.new(kind, paths, raw_kind)
+        @block.call(event)
+      end
     end
   end
 end

data/lib/watchcat/version.rb

@@ -1,3 +1,3 @@
 module Watchcat
-  VERSION = "0.2.1"
+  VERSION = "0.4.0"
 end

data/lib/watchcat.rb

@@ -1,5 +1,6 @@
 require_relative "watchcat/version"
 require_relative "watchcat/executor"
+require_relative "watchcat/debouncer"
 
 begin
   require "watchcat/#{RUBY_VERSION.to_f}/watchcat"
@@ -14,8 +15,7 @@ module Watchcat
       recursive: true,
       force_polling: false,
       poll_interval: nil,
-      wait_until_startup: false,
-      ignore_remove: false,
+      filters: {},
       debounce: -1,
       &block
     )
@@ -25,8 +25,7 @@ module Watchcat
           recursive: recursive,
           force_polling: force_polling,
           poll_interval: poll_interval,
-          wait_until_startup: wait_until_startup,
-          ignore_remove: ignore_remove,
+          filters: filters,
           debounce: debounce,
           block: block
         )

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: watchcat
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: x86_64-linux
 authors:
 - Yuji Yaginuma
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2024-12-08 00:00:00.000000000 Z
+date: 2025-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: drb
+  name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,22 +129,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- cli_example.yml
+- exe/watchcat
 - ext/watchcat/.gitignore
 - lib/watchcat.rb
-- lib/watchcat/3.0/watchcat.so
 - lib/watchcat/3.1/watchcat.so
 - lib/watchcat/3.2/watchcat.so
 - lib/watchcat/3.3/watchcat.so
-- lib/watchcat/client.rb
+- lib/watchcat/3.4/watchcat.so
+- lib/watchcat/cli.rb
+- lib/watchcat/cli/action_executor.rb
+- lib/watchcat/cli/config.rb
+- lib/watchcat/cli/watcher.rb
+- lib/watchcat/debouncer.rb
 - lib/watchcat/event.rb
 - lib/watchcat/executor.rb
 - lib/watchcat/kind.rb
-- lib/watchcat/server.rb
 - lib/watchcat/version.rb
 homepage: https://github.com/y-yagi/watchcat
 licenses:
@@ -160,17 +166,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
   - - "<"
     - !ruby/object:Gem::Version
-      version: 3.4.dev
+      version: 3.5.dev
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.4
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: Simple filesystem notification library for Ruby.

data/lib/watchcat/client.rb

@@ -1,26 +0,0 @@
-module Watchcat
-  class Client
-    def initialize(uri, watcher:, paths:, recursive:, force_polling:, poll_interval:, ignore_remove:, debounce:)
-      DRb.start_service
-      @watcher = watcher
-      @server = DRbObject.new_with_uri(uri)
-      @paths = paths
-      @recursive = recursive
-      @force_polling = force_polling
-      @poll_interval = poll_interval
-      @ignore_remove = ignore_remove
-      @debounce = debounce
-    end
-
-    def run
-      @watcher.watch(
-        @paths,
-        recursive: @recursive,
-        force_polling: @force_polling,
-        poll_interval: @poll_interval,
-        ignore_remove: @ignore_remove,
-        debounce: @debounce
-      ) { |notification| @server.execute(notification) }
-    end
-  end
-end

data/lib/watchcat/server.rb

@@ -1,14 +0,0 @@
-require "watchcat/event"
-
-module Watchcat
-  class Server
-    def initialize(block)
-      @block = block
-    end
-
-    def execute(notification)
-      event = Watchcat::Event.new(notification[0], notification[1], notification[2])
-      @block.call(event)
-    end
-  end
-end