watchcat 0.0.1-x86_64-darwin

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d207f0133bbecdeb433e3972886bc7cafb0ba749b8a272fd51d23f53e891ba2
+  data.tar.gz: 586d87a2f66e317e384f9bc3c643decc2f111a6d70869de112b21711e8b58953
+SHA512:
+  metadata.gz: cc02fc03f9f852acfcb83c681154611421a2368e324e4961f5d5c9f613fa6e256fb30fd7f92d6c896a73fd04facf90b2c5814cb7c514ee0b93a000b1b7ff14e9
+  data.tar.gz: 19054e83476c5552a365eee0eae7695b545b750a215d680b0fff0516b1599c8bceea5d94b4c0eeb2e39b083ada1d2e10c085482134678dc5e7a51110e03e51b7

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,39 @@
+PATH
+  remote: .
+  specs:
+    watchcat (0.0.1)
+      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)
+      minitest (>= 5.0)
+    rake (13.0.6)
+    rake-compiler (1.2.1)
+      rake
+    rb_sys (0.9.65)
+    reline (0.3.2)
+      io-console (~> 0.5)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  debug
+  minitest
+  minitest-retry
+  rake
+  rake-compiler
+  watchcat!
+
+BUNDLED WITH
+   2.4.6

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,109 @@
+# 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"
+
+w = Watchcat.watch("/tmp/test") do |e|
+  pp e.paths, e.kind
+end
+
+# Don't forget to call `stop`.
+at_exit { w.stop }
+
+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"
+
+w = 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
+
+# Don't forget to call `stop`.
+at_exit { w.stop }
+
+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`           |
+
+
+
+## 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,24 @@
+# frozen_string_literal: true
+
+require "rake/testtask"
+require "rb_sys/extensiontask"
+
+task default: :test
+
+GEMSPEC = Gem::Specification.load("watchcat.gemspec")
+RbSys::ExtensionTask.new("watchcat", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/watchcat"
+end
+
+Rake::TestTask.new 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
+
+task console: :compile do
+  ruby "bin/console"
+end

data/ext/watchcat/.gitignore

@@ -0,0 +1 @@
+target

data/lib/watchcat/client.rb

@@ -0,0 +1,18 @@
+module Watchcat
+  class Client
+    def initialize(uri, paths:, recursive:, force_polling:)
+      DRb.start_service
+      @watcher = Watchcat::Watcher.new
+      @server = DRbObject.new_with_uri(uri)
+      @paths = paths
+      @recursive = recursive
+      @force_polling = force_polling
+    end
+
+    def run
+      @watcher.watch(@paths, recursive: @recursive, force_polling: @force_polling) do |notification|
+        @server.execute(notification)
+      end
+    end
+  end
+end

data/lib/watchcat/event.rb

@@ -0,0 +1,50 @@
+require "watchcat/kind"
+
+module Watchcat
+  class Event
+    attr_reader :kind, :paths, :raw_kind
+
+    def initialize(kinds, paths, raw_kind)
+      @paths = paths
+      @raw_kind = raw_kind
+      build_kind(kinds)
+    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)
+    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,32 @@
+require "drb"
+require "drb/unix"
+require_relative "server"
+require_relative "client"
+
+module Watchcat
+  class Executor
+    def initialize(paths, recursive:, force_polling:, block:)
+      @service = nil
+      @child_pid = nil
+      @paths = paths
+      @recursive = recursive
+      @force_polling = force_polling
+      @block = block
+    end
+
+    def start
+      server = Server.new(@block)
+      @service = DRb.start_service("drbunix:", server)
+      @child_pid = fork do
+        Process.setproctitle("watchcat: watcher")
+        client = Client.new(@service.uri, paths: @paths, recursive: @recursive, force_polling: @force_polling)
+        client.run
+      end
+    end
+
+    def stop
+      Process.kill(:KILL, @child_pid)
+      @service.stop_service
+    end
+  end
+end

data/lib/watchcat/kind.rb

@@ -0,0 +1,183 @@
+require "forwardable"
+
+module Watchcat
+  class EventKind
+    attr_accessor :access, :create, :modify, :remove
+
+    def initialize
+      @access, @create, @modify, @remove = 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
+  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 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/server.rb

@@ -0,0 +1,14 @@
+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

data/lib/watchcat/version.rb

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

data/lib/watchcat.rb

@@ -0,0 +1,18 @@
+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, &block)
+      w = Watchcat::Executor.new(Array(paths), recursive: recursive, force_polling: force_polling, block: block)
+      w.start
+      w
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: watchcat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: x86_64-darwin
+authors:
+- Yuji Yaginuma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-03-12 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'
+description: 
+email:
+- yuuji.yaginuma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/watchcat/.gitignore
+- lib/watchcat.rb
+- lib/watchcat/3.0/watchcat.bundle
+- lib/watchcat/3.1/watchcat.bundle
+- lib/watchcat/3.2/watchcat.bundle
+- lib/watchcat/client.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:
+- MIT
+metadata:
+  homepage_uri: https://github.com/y-yagi/watchcat
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.3.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.4
+signing_key: 
+specification_version: 4
+summary: Simple filesystem notification library for Ruby.
+test_files: []