zwerg 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cc6b79e2842c2d7fd73d23c994432be87e4a97f3a1e23c3596fe4658a1f0a6b
-  data.tar.gz: c3f81dcdba96f0255be18f863c28f2cbfe08eecee52d06b7917308b682f6e031
+  metadata.gz: 9f5101ab9cfd3931ba280fd1f99ea072f390a0b729d746f733a53de3b984c81c
+  data.tar.gz: ae2a722ad3f32d7942d89e22e4afc5b6de3094dcf5d411e68a51827dbb50dbe1
 SHA512:
-  metadata.gz: bad591c47d47f91a80feb8c0fb3284165d62790dd2ac1e6c0577db42f7dfecd07a92e366897a8d7a4d1734bb984e644ec22fb6838c37107f5b0ecc406afdcc82
-  data.tar.gz: a4be1ecd56849f66b15cc99911258e498a450714cdfa310e3be33b7ddb8a51dfcd6804ae92191937e95f8a8ca0247421e42d8a71574b8578578a9e6bac734b5d
+  metadata.gz: b7d330a786f9d42e790df64840ee513195ce15505d899d2cb4f8e6228415eca0fcfa8374b1c4625aaa7fd2c83b0c83b8adfcc210341d4937f7ddf7f7191819b6
+  data.tar.gz: 77c468b8cb4ff0e8d8da43ebaccee257a0b629855ba6ff92c8be62e5f845ff2872f5440d1c0b95c345afb9785583a24344a55b3a7f3ec847b8f3f517a7815400

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.1.2
+
+* Ignore "access" event by default
+
+## 0.1.1
+
+* Imeplement "debounce" feature
+
+## 0.1.0
+
+* Initial Release

data/README.md

@@ -40,6 +40,7 @@ gem install zwerg
 watches:
   - path: "./src"
     recursive: true
+    debounce: 500
     patterns:
       - "*.rb"
       - "*.yml"
@@ -63,6 +64,7 @@ Each watch entry can have the following properties:
 
 - `path`: The file or directory to watch (required)
 - `recursive`: Whether to watch subdirectories (default: true)
+- `debounce`: Wait time in milliseconds before firing actions for the same file (default: 500)
 - `patterns`: Array of glob patterns to match files (optional, matches all if empty)
 - `actions`: Array of actions to execute when files change (required)
 
@@ -78,6 +80,32 @@ You can use any shell command, including complex operations with pipes, redirect
 - command: "if [ -f {{file_path}} ]; then echo 'File exists: {{file_name}}' >> changes.log; fi"
 ```
 
+### Debounce Feature
+
+The debounce feature prevents actions from firing too frequently for the same file. When a file changes multiple times within the debounce period, only the last change will trigger the actions. This is implemented using Zwerg's built-in debouncer.
+
+```yaml
+- path: "./src"
+  debounce: 1000  # Wait 1000ms (1 second) before firing actions
+  actions:
+    - command: "echo 'File changed: {{file_path}}'"
+```
+
+**How it works:**
+- Each file path is tracked separately with its own debounce timer
+- When a file changes, any existing timer for that file is cancelled
+- A new timer is started for the specified debounce period
+- If the file changes again before the timer expires, the timer is reset
+- Actions only execute when the timer completes without interruption
+
+This is particularly useful for:
+- Files that are saved multiple times in quick succession by editors
+- Build processes that modify multiple files rapidly
+- Log files that are updated frequently
+- Preventing duplicate actions when files are modified in batches
+
+The debounce value is specified in milliseconds. If not specified, the default is 500ms.
+
 ### Variable Substitution
 
 The following variables can be used in action configurations:
@@ -87,7 +115,6 @@ The following variables can be used in action configurations:
 - `{{file_name}}`: Name of the file (including extension)
 - `{{file_base}}`: Name of the file without extension
 - `{{file_ext}}`: File extension (including the dot)
-- `{{event_type}}`: Type of event (create, modify, remove, access)
 
 ## Example Configuration
 

data/example_zwerg.yml

@@ -5,6 +5,7 @@ watches:
   # Watch a source directory for Ruby files
   - path: "./src"
     recursive: true
+    debounce: 300  # Wait 300ms before firing actions for the same file
     patterns:
       - "*.rb"
       - "*.yml"
@@ -15,6 +16,7 @@ watches:
   # Watch a documentation directory
   - path: "./docs"
     recursive: true
+    debounce: 1000  # Wait 1 second for documentation files
     patterns:
       - "*.md"
       - "*.txt"
@@ -25,23 +27,32 @@ watches:
   # Watch configuration files in the root directory
   - path: "."
     recursive: false
+    debounce: 2000  # Wait 2 seconds for config files (they might be edited multiple times)
     patterns:
       - "*.yml"
       - "*.yaml"
       - "*.json"
     actions:
-      - command: "echo '[{{event_type}}] Config file changed: {{file_name}}'"
+      - command: "echo 'Config file changed: {{file_name}}'"
       - command: "echo 'Config changed: {{file_path}}' | mail -s 'Config Alert' admin@example.com"
 
   # Watch for log files and compress them when they get large
   - path: "./logs"
     recursive: false
+    debounce: 5000  # Wait 5 seconds for log files (they change frequently)
     patterns:
       - "*.log"
     actions:
       - command: "if [ $(stat -c%s {{file_path}}) -gt 1048576 ]; then gzip {{file_path}}; fi"
 
 # Each action is a shell command that will be executed when files change
+#
+# Configuration options:
+# - path: Directory or file to watch (required)
+# - recursive: Watch subdirectories (default: true)
+# - debounce: Wait time in milliseconds before firing actions (default: 500ms)
+# - patterns: Glob patterns to match files (optional, matches all if empty)
+# - actions: Commands to execute when files change (required)
 
 # Available variables for substitution:
 # - {{file_path}}: Full path to the changed file
@@ -49,4 +60,3 @@ watches:
 # - {{file_name}}: Name of the file (including extension)
 # - {{file_base}}: Name of the file without extension
 # - {{file_ext}}: File extension (including the dot)
-# - {{event_type}}: Type of event (create, modify, remove, access)

data/exe/zwerg

@@ -26,6 +26,7 @@ def show_help
         watches:
           - path: "./src"
             recursive: true
+            debounce: 500
             patterns:
               - "*.rb"
               - "*.yml"
@@ -39,7 +40,6 @@ def show_help
         {{file_name}}   Name of the file (including extension)
         {{file_base}}   Name of the file without extension
         {{file_ext}}    File extension (including the dot)
-        {{event_type}}  Type of event (create, modify, remove, access)
 
     For more information, visit: https://github.com/y-yagi/zwerg
   HELP

data/lib/zwerg/action_executor.rb

@@ -38,15 +38,6 @@ module Zwerg
         .gsub("{{file_name}}", @file_name)
         .gsub("{{file_base}}", @file_base)
         .gsub("{{file_ext}}", @file_ext)
-        .gsub("{{event_type}}", determine_event_type)
-    end
-
-    def determine_event_type
-      return "create" if @event.kind.create?
-      return "modify" if @event.kind.modify?
-      return "remove" if @event.kind.remove?
-      return "access" if @event.kind.access?
-      "unknown"
     end
   end
 end

data/lib/zwerg/config.rb

@@ -31,7 +31,8 @@ module Zwerg
           path: watch_config["path"],
           recursive: watch_config.fetch("recursive", true),
           patterns: watch_config["patterns"] || [],
-          actions: watch_config["actions"] || []
+          actions: watch_config["actions"] || [],
+          debounce: watch_config.fetch("debounce", 500)
         }
       end
     end

data/lib/zwerg/debouncer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Zwerg
+  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/zwerg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zwerg
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/zwerg/watcher.rb

@@ -7,6 +7,7 @@ module Zwerg
     def initialize(config)
       @config = config
       @watchers = []
+      @debouncer = Debouncer.new
     end
 
     def start
@@ -28,6 +29,7 @@ module Zwerg
     end
 
     def stop
+      @debouncer.clear
       @watchers.each(&:stop)
       @watchers.clear
     end
@@ -42,7 +44,7 @@ module Zwerg
         return
       end
 
-      puts "Watching: #{path} (recursive: #{watch_config[:recursive]})"
+      puts "Watching: #{path} (recursive: #{watch_config[:recursive]}, debounce: #{watch_config[:debounce]}ms)"
 
       watcher = Watchcat.watch(
         path,
@@ -56,11 +58,17 @@ module Zwerg
     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])
+        # Use debouncer to delay action execution
+        debounce_key = "#{watch_config[:path]}:#{file_path}"
+        @debouncer.debounce(debounce_key, watch_config[:debounce]) do
+          puts "File changed: #{file_path}"
+          execute_actions(file_path, event, watch_config[:actions])
+        end
       end
     end
 

data/lib/zwerg.rb

@@ -4,6 +4,7 @@ require_relative "zwerg/version"
 require_relative "zwerg/watcher"
 require_relative "zwerg/config"
 require_relative "zwerg/action_executor"
+require_relative "zwerg/debouncer"
 
 module Zwerg
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zwerg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Yuji Yaginuma
@@ -44,6 +44,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
@@ -53,6 +54,7 @@ files:
 - lib/zwerg.rb
 - lib/zwerg/action_executor.rb
 - lib/zwerg/config.rb
+- lib/zwerg/debouncer.rb
 - lib/zwerg/version.rb
 - lib/zwerg/watcher.rb
 homepage: https://github.com/y-yagi/zwerg