watchly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f99ea235b8e5f9266131b1e25353c54c6a5c725cb9fca3c2ec7a503ae84bd73b
+  data.tar.gz: 170a74f2b7e9642f57d19a141b65b3ab50d20199de44c9f48f0d5a16692732c5
+SHA512:
+  metadata.gz: 61e82c4f0f9077a6af68fe057ece3bffacd1030eaeab69f77b6476b71f2dfa172d0f3f934552a45b9e6cd2d1d898f35e896dd5bf1d8dca59d53e16b2dca47a1c
+  data.tar.gz: 30bcceb7691daab5d6def2ff15a5284ebcb89c2a492c83020713a8bea3db9ec470ed732dccc197e65f8f507e1e6a882a1e7ec884635a1286a2d797dac4c4d6f1

data/README.md

@@ -0,0 +1,57 @@
+# Watchly
+
+Watchly is a lightweight, dependency-free, polling-based file watcher for Ruby.
+It watches one or more glob patterns and reports changes.
+
+## Installation
+
+```bash
+gem install watchly
+```
+
+Or in your Gemfile:
+
+```ruby
+gem 'watchly'
+```
+
+## Usage
+
+**Initialize a watcher:**
+
+```ruby
+require 'watchly'
+
+# with the default interval (1 second)
+watcher = Watchly::Watcher.new '**/*'
+
+# with a different interval
+watcher = Watchly::Watcher.new '**/*', interval: 2.0
+
+# with multiple glob patterns
+watcher = Watchly::Watcher.new 'spec/**/*.rb', 'lib/*.*'
+```
+
+**Watch for changes:**
+
+```ruby
+watcher.on_change do |changes|
+  puts "Added: #{changes.added.join(', ')}" if changes.added.any?
+  puts "Removed: #{changes.removed.join(', ')}" if changes.removed.any?
+  puts "Modified: #{changes.modified.join(', ')}" if changes.modified.any?
+end
+```
+
+**Stop the watcher:**
+
+```ruby
+# Mainly for tests, but can be called from another thread
+watcher.stop
+```
+
+## Contributing / Support
+
+If you experience any issue, have a question, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+[issues]: https://github.com/dannyben/watchly/issues

data/lib/watchly/changeset.rb

@@ -0,0 +1,24 @@
+module Watchly
+  class Changeset
+    attr_reader :added, :removed, :modified
+
+    def initialize(added:, removed:, modified:)
+      @added    = added.freeze
+      @removed  = removed.freeze
+      @modified = modified.freeze
+      freeze
+    end
+
+    def empty? = added.empty? && removed.empty? && modified.empty?
+    def any? = !empty?
+    def to_h = { added: added, removed: removed, modified: modified }
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      added.each    { |path| yield :added, path }
+      removed.each  { |path| yield :removed, path }
+      modified.each { |path| yield :modified, path }
+    end
+  end
+end

data/lib/watchly/snapshot.rb

@@ -0,0 +1,47 @@
+module Watchly
+  class Snapshot
+    attr_reader :globs, :files
+
+    def initialize(globs)
+      @globs = globs
+      @files = capture(globs)
+    end
+
+    def diff(other)
+      Changeset.new(
+        added:    added_files(other),
+        removed:  removed_files(other),
+        modified: modified_files(other)
+      )
+    end
+
+    def ==(other)
+      return false unless other.is_a? self.class
+
+      files == other.files
+    end
+
+  private
+
+    def added_files(other) = other.files.keys - files.keys
+    def removed_files(other) = files.keys - other.files.keys
+
+    def modified_files(other)
+      (files.keys & other.files.keys).reject do |path|
+        files[path] == other.files[path]
+      end
+    end
+
+    def capture(globs)
+      Array(globs)
+        .flat_map { |glob| Dir.glob glob }
+        .uniq
+        .each_with_object({}) do |path, acc|
+          next unless File.file? path
+
+          stat = File.stat path
+          acc[path] = [stat.mtime.to_i, stat.size]
+        end
+    end
+  end
+end

data/lib/watchly/version.rb

@@ -0,0 +1,3 @@
+module Watchly
+  VERSION = '0.1.0'
+end

data/lib/watchly/watcher.rb

@@ -0,0 +1,33 @@
+module Watchly
+  class Watcher
+    DEFAULT_INTERVAL = 1.0
+
+    attr_reader :globs, :interval, :stopped
+
+    def initialize(*globs, interval: nil)
+      @globs = globs
+      @interval = interval || DEFAULT_INTERVAL
+      @stopped = false
+    end
+
+    def stop = @stopped = true
+
+    def on_change
+      raise ArgumentError, 'Block required' unless block_given?
+
+      previous = Snapshot.new globs
+
+      until stopped
+        sleep interval
+
+        current = Snapshot.new globs
+        next if previous == current
+
+        changes = previous.diff current
+        yield changes
+
+        previous = current
+      end
+    end
+  end
+end

data/lib/watchly.rb

@@ -0,0 +1,3 @@
+require 'watchly/changeset'
+require 'watchly/snapshot'
+require 'watchly/watcher'

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: watchly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A small, dependency-free, polling-based library that watches one or more
+  glob patterns and reports on change
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/watchly.rb
+- lib/watchly/changeset.rb
+- lib/watchly/snapshot.rb
+- lib/watchly/version.rb
+- lib/watchly/watcher.rb
+homepage: https://github.com/dannyben/watchly
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/dannyben/watchly/issues
+  changelog_uri: https://github.com/dannyben/watchly/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/dannyben/watchly
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Lightweight, polling-based file system watcher
+test_files: []