watchcat 0.1.0-x86_64-darwin → 0.2.0-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cca421ade28011a018db724cb3072cce6c6889e14b4153080253b2865e9efcb6
-  data.tar.gz: 650c802880a603b4fbc83b931a658c580d05532c2e82608352b9f2eed5f4251f
+  metadata.gz: 0a1975541b2f0f08bad88df909f41fc41b38a7afe4996cdb8e931b9333f6ba86
+  data.tar.gz: 2931a5d9b5b2e841d6213f21036c36850373e86aa2e4a0aab3712e2d7f5e9556
 SHA512:
-  metadata.gz: 7dc2754e9dfc88963a02c68e7f2b1575193360c71338e1a537ac8a37bf72a716b398098c06303db9842a3c4b25213748efacd6c2645f7e39953ef54ff8115d44
-  data.tar.gz: 2396c03f7667dfac500ba67b907334de7263b6f3c22c4bde6a7276da408b08388a3ec24a6bd234bef15a27be2853b7e3a9c839cf0a283d7b8f6f6fe5b2c749b7
+  metadata.gz: acc778857a6801b794610a4e0c30b1bca37870bfb37ba0d750fd1fefc12d09f70edfb57e3ac8a169d03812e45a5d6c49da523aae4ccf22e426e21618718c3119
+  data.tar.gz: 6c163bec6112353e45e04f21c976ee5c41c8967662f6b62209622b02d319dd4db1fc30f679e2c877f12ea538b7ea79dc63422272df033f23252177b975d81148

data/Gemfile.lock

@@ -1,39 +1,70 @@
 PATH
   remote: .
   specs:
-    watchcat (0.1.0)
+    watchcat (0.2.0)
+      drb
       rb_sys
 
 GEM
   remote: https://rubygems.org/
   specs:
-    debug (1.7.1)
-      irb (>= 1.5.0)
-      reline (>= 0.3.1)
-    io-console (0.6.0)
-    irb (1.6.2)
-      reline (>= 0.3.0)
-    minitest (5.18.0)
-    minitest-retry (0.2.2)
+    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)
-    rake (13.0.6)
-    rake-compiler (1.2.1)
+    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_sys (0.9.67)
-    reline (0.3.2)
+    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.3.17
+   2.5.4

data/README.md

@@ -31,9 +31,6 @@ w = Watchcat.watch("/tmp/test") do |e|
   pp e.paths, e.kind
 end
 
-# Don't forget to call `stop`.
-at_exit { w.stop }
-
 sleep
 ```
 
@@ -81,9 +78,6 @@ w = Watchcat.watch("/tmp/target") do |e|
   end
 end
 
-# Don't forget to call `stop`.
-at_exit { w.stop }
-
 sleep
 ```
 
@@ -97,7 +91,7 @@ sleep
 | -------------------------- | -----------------------------------------| ----------------- |
 | **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

data/Rakefile

@@ -3,6 +3,8 @@
 require "rake/testtask"
 require "rb_sys/extensiontask"
 require "bundler/gem_tasks"
+require "minitest/test_task"
+require "ruby_memcheck"
 
 task default: :test
 
@@ -11,7 +13,7 @@ RbSys::ExtensionTask.new("watchcat", GEMSPEC) do |ext|
   ext.lib_dir = "lib/watchcat"
 end
 
-Rake::TestTask.new do |t|
+test_config = lambda do |t|
   t.libs << "test"
   t.libs << "lib"
   t.deps << :compile
@@ -20,6 +22,24 @@ Rake::TestTask.new do |t|
   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/lib/watchcat/client.rb

@@ -1,18 +1,26 @@
 module Watchcat
   class Client
-    def initialize(uri, paths:, recursive:, force_polling:)
+    def initialize(uri, paths:, recursive:, force_polling:, poll_interval:, ignore_remove:, debounce:)
       DRb.start_service
       @watcher = Watchcat::Watcher.new
       @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) do |notification|
-        @server.execute(notification)
-      end
+      @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/event.rb

@@ -2,7 +2,7 @@ require "watchcat/kind"
 
 module Watchcat
   class Event
-    attr_reader :kind, :paths, :raw_kind
+    attr_reader :kind, :paths, :raw_kind, :event
 
     def initialize(kinds, paths, raw_kind)
       @paths = paths
@@ -10,13 +10,26 @@ module Watchcat
       build_kind(kinds)
     end
 
+    def deconstruct_keys(_keys)
+      { paths: @paths, event: @event }
+    end
+
     private
 
     def build_kind(kinds)
       @kind = Watchcat::EventKind.new
-      event_kind = kinds.shift
-      @kind.public_send("#{event_kind}=", Object.const_get("Watchcat::#{event_kind.capitalize}Kind").new)
-      send("build_#{event_kind}_kind", kinds)
+      @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)

data/lib/watchcat/executor.rb

@@ -5,28 +5,60 @@ require_relative "client"
 
 module Watchcat
   class Executor
-    def initialize(paths, recursive:, force_polling:, block:)
+    def initialize(paths, recursive:, force_polling:, poll_interval:, wait_until_startup:, ignore_remove:, debounce:, block:)
       @service = nil
       @child_pid = nil
       @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
     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 = Client.new(@service.uri, paths: @paths, recursive: @recursive, force_polling: @force_polling)
         client.run
       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
+      end
     end
 
     def stop
-      Process.kill(:KILL, @child_pid)
+      begin
+        Process.kill(:KILL, @child_pid)
+      rescue Errno::ESRCH
+        # NOTE: We can ignore this error because there process is already dead.
+      end
       @service.stop_service
     end
+
+    private
+
+    def build_client
+      Client.new(
+        @service.uri,
+        paths: @paths,
+        recursive: @recursive,
+        force_polling: @force_polling,
+        poll_interval: @poll_interval,
+        debounce: @debounce,
+        ignore_remove: @ignore_remove
+      )
+    end
   end
 end

data/lib/watchcat/kind.rb

@@ -2,10 +2,10 @@ require "forwardable"
 
 module Watchcat
   class EventKind
-    attr_accessor :access, :create, :modify, :remove
+    attr_accessor :access, :create, :modify, :remove, :any
 
     def initialize
-      @access, @create, @modify, @remove = nil, nil, nil, nil
+      @access, @create, @modify, @remove, @any = nil, nil, nil, nil,nil
     end
 
     def access?
@@ -23,6 +23,10 @@ module Watchcat
     def remove?
       !@remove.nil?
     end
+
+    def any?
+      !@any.nil?
+    end
   end
 
   class AccessKind
@@ -97,6 +101,19 @@ module Watchcat
     end
   end
 
+  class AnyKind
+    attr_accessor :kind
+
+    def file?
+      @kind == "file"
+    end
+
+    def folder?
+      @kind == "folder"
+    end
+  end
+
+
   class AccessMode
     attr_accessor :mode
 

data/lib/watchcat/version.rb

@@ -1,3 +1,3 @@
 module Watchcat
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/watchcat.rb

@@ -9,8 +9,27 @@ end
 
 module Watchcat
   class << self
-    def watch(paths, recursive: true, force_polling: false, &block)
-      w = Watchcat::Executor.new(Array(paths), recursive: recursive, force_polling: force_polling, block: block)
+    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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: watchcat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: x86_64-darwin
 authors:
 - Yuji Yaginuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: drb
+  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
@@ -80,6 +94,34 @@ dependencies:
     - - ">="
       - !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
@@ -97,6 +139,7 @@ files:
 - lib/watchcat/3.0/watchcat.bundle
 - lib/watchcat/3.1/watchcat.bundle
 - lib/watchcat/3.2/watchcat.bundle
+- lib/watchcat/3.3/watchcat.bundle
 - lib/watchcat/client.rb
 - lib/watchcat/event.rb
 - lib/watchcat/executor.rb
@@ -108,6 +151,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/y-yagi/watchcat
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -119,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
   - - "<"
     - !ruby/object:Gem::Version
-      version: 3.3.dev
+      version: 3.4.dev
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="