watchcat 0.3.0-x86_64-linux → 0.5.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a100f98bc642f7e4f8ca785271849ff5bd7c86249aa52e915797325baaeca15
-  data.tar.gz: 7ce9498af1556b1ae7a59dcafb9e14eefe9d3e30450f01199b809166b44a7476
+  metadata.gz: 06645aee84876dac8c231d425b846d54aacfbbfc56082d615327c059d796205e
+  data.tar.gz: 59ed59a908d0b8e270540aa7dbd4abe520ea94dcfbcf300b86b78706d45e291b
 SHA512:
-  metadata.gz: 21bbb0fe635899c9ed7a55857752036500bb213a297629d7148ca3192c4d7bacba497ca2c0b6c88831017f7eddef272b11669727e1f1c02c3dd759d07897807e
-  data.tar.gz: 531a6acacdddeb0b8b0c567c621191f020519babaaa2e53a34677ebdb11e599ec7da54ce528a6d3cdecdef031be46a4dcd82c363d9a27f5f6ecc68f7b5db9b61
+  metadata.gz: c68fee7c1b1a61c58d451aa9663bf558bc2ee18fd26b0bb921258a3ec9fd1434d4d9cf308dd2c364f9fcede3e988197fff07ae66fa904b2b944246f08349dca1
+  data.tar.gz: 392b34865e7e958a8abecca656d2c721cbd85439f1f7ea229e561f607c6e6cf9ebd5bc3c6b9b29248d23aa9c6694366f61f152ba9304c00adc5e97efbe37ab35

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.5.0
+
+* Rework the debounce feature. Now all events are debounced.
+* Add `init` option to CLI
+
+## 0.4.0
+
+* Add CLI
+* Add filters option
+
 ## 0.3.0
 
 * Support Windows

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    watchcat (0.3.0)
+    watchcat (0.5.0)
+      psych
       rb_sys
 
 GEM
@@ -27,6 +28,8 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     minitest (5.25.5)
+    minitest-fail-fast (0.1.0)
+      minitest (~> 5)
     minitest-retry (0.2.5)
       minitest (>= 5.0)
     nokogiri (1.18.1-arm64-darwin)
@@ -74,6 +77,7 @@ DEPENDENCIES
   debug
   listen
   minitest
+  minitest-fail-fast
   minitest-retry
   rake
   rake-compiler

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
 
@@ -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,86 @@ 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
+
+```
+# Run watchcat with a config file
+$ watchcat -C config.yml
+
+# Generate a template config file
+$ watchcat --init 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)    | `-1`    |
+| 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,72 @@
+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
+
+      def self.generate_template(file_path)
+        template = <<~YAML
+          # Watchcat Configuration File
+
+          watches:
+            - path: "./src"
+              recursive: true
+              debounce: 300
+              patterns:
+                - "*.js"
+                - "*.ts"
+                - "*.css"
+              actions:
+                - command: "echo 'File changed: {{file_path}}'"
+
+            - path: "./docs"
+              recursive: true
+              patterns:
+                - "*.md"
+              actions:
+                - command: "echo 'Documentation updated: {{file_name}}'"
+        YAML
+
+        if File.exist?(file_path)
+          raise Error, "File already exists: #{file_path}. Won't overwrite."
+        end
+
+        File.write(file_path, template)
+        puts "Config template generated at #{file_path}"
+      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", -1),
+            filters: watch_config["filters"]&.transform_keys(&:to_sym) || {},
+          }
+        end
+      end
+    end
+  end
+end

data/lib/watchcat/cli/watcher.rb

@@ -0,0 +1,85 @@
+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],
+          debounce: watch_config[:debounce],
+        ) 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}"
+          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,52 @@
+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)
+
+        if options[:init]
+          Config.generate_template(options[:init])
+          return
+        end
+
+        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 = { config: 'watchcat.yml' }
+        OptionParser.new do |opts|
+          opts.banner = "Usage: watchcat [options]"
+
+          opts.on("-C", "--config PATH", "Path to the config file. Default is 'watchcat.yml'.") do |v|
+            options[:config] = v
+          end
+
+          opts.on("--init PATH", "Generate a template config file at the specified path") do |v|
+            options[:init] = v
+          end
+
+          opts.on("-h", "--help", "Show this help message") do
+            puts opts
+            exit
+          end
+        end.parse!(argv)
+
+        if !options[:init] && options[:config].nil?
+          raise OptionParser::MissingArgument.new("-C")
+        end
+
+        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

@@ -2,14 +2,14 @@ require_relative "event"
 
 module Watchcat
   class Executor
-    def initialize(paths, recursive:, force_polling:, poll_interval:, wait_until_startup:, ignore_remove:, debounce:, block:)
+    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
+      @debouncer = Debouncer.new if @debounce > 0
       @block = block
       @watcher = Watchcat::Watcher.new
       @watch_thread = nil
@@ -23,11 +23,6 @@ module Watchcat
         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
@@ -49,14 +44,22 @@ module Watchcat
         recursive: @recursive,
         force_polling: @force_polling,
         poll_interval: @poll_interval,
-        ignore_remove: @ignore_remove,
-        debounce: @debounce
+        ignore_remove: @filters[:ignore_remove],
+        ignore_access: @filters[:ignore_access],
+        ignore_create: @filters[:ignore_create],
+        ignore_modify: @filters[:ignore_modify]
       ) 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)
+        if @debounce > 0 && paths.size == 1
+          @debouncer.debounce(paths[0], @debounce) do
+            event = Watchcat::Event.new(kind, paths, raw_kind)
+            @block.call(event)
+          end
+        else
+          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.3.0"
+  VERSION = "0.5.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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: watchcat
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: x86_64-linux
 authors:
 - Yuji Yaginuma
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2025-08-03 00:00:00.000000000 Z
+date: 2025-09-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-fail-fast
+  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
@@ -121,12 +149,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- cli_example.yml
+- exe/watchcat
 - 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/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