revtree 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cfacc4513023ac62b90be3f9eed6fe2ab45af739aa6676413c947a214b7595f
-  data.tar.gz: cd7763aed7ca500ef2aaa1103d82e33667b9ad6d732839768b41100f3af435bb
+  metadata.gz: fdd5916237e12c049db40a28dfc46aae0d49a9da26d7f92dcce2f9c16ec1bfc5
+  data.tar.gz: f8666a0a6d4684ea29b88dd603104e3affbff010e13991bc929e1f578b6ed6de
 SHA512:
-  metadata.gz: b723f8f00a74e68176bb3b9c60cfd09458cd0b67029ad903c76aee21a411394de498f04285fff7ae07436b35d2b55701e16a6f68fea1645c80acb1ebc6d1111d
-  data.tar.gz: c6d506353323eb333c849460132257f93abe1426c8fb8b3e6724c16499942409d99db0311c2e7ccd36da8bd401b8396e1689928ac3951b1aa9cc3fcff70a06fa
+  metadata.gz: 8386219887c05bee8f4fe64c3b981a6772ccda56dcfe750115565aaf906d601019524ed5024a16ea97167e8630a4c88a6fc7d67b63c492f29b05d9832140cc7f
+  data.tar.gz: f9a11c1f1e9fcc91564a6bb4d07f3ae373913c31c732c1edaef963c9b531754ae7ce592a2db6a3582e66fd2ca6767895b602a0840590bebcdbf6fb55f3564bbb

data/README.md

@@ -14,6 +14,8 @@ It also provides methods to print and serialize the tree structure, as well as t
 - **Serialization**: Supports serialization to and from JSON format for easy storage and transfer.
 - **Pretty Printing**: Provides a method to print the directory tree with statuses.
 - **Iterate with `for_each`**: Traverse the tree and apply a block to files matching specific statuses.
+- **Watch for Changes**: Automatically monitors a directory for changes with `watch`, and triggers actions based on file changes.
+- **Customizable Watch Interval**: Set a custom interval between checks with the `with_interval` method.
 
 ## Install
 
@@ -39,7 +41,7 @@ sudo make install
 git clone https://github.com/juliankahlert/revtree.git
 cd revtree
 gem build revtree.gemspec
-sudo gem install --local revtree-0.1.1.gem
+sudo gem install --local revtree-0.1.3.gem
 ```
 
 ## API Documentation
@@ -70,6 +72,18 @@ sudo gem install --local revtree-0.1.1.gem
   - `&block` (Proc): A block to execute for each file matching the given statuses.
 - **Behavior**: Iterates over files in the tree, executing the block for each file whose status matches one of the statuses in the whitelist.
 
+### `#watch(status_whitelist = [:modified, :added, :removed], &block)`
+
+- **Parameters**:
+  - `status_whitelist` (Array<Symbol>): List of statuses to watch (e.g., `[:added, :removed]`).
+  - `&block` (Proc): A block to execute when a file matching the given statuses is changed.
+
+### `#with_interval(interval)`
+
+- **Parameters**:
+  - `interval` (Integer): Interval (in seconds) between checks for changes.
+- **Returns**: The `RevTree` instance, enabling method chaining.
+
 ### `RevTree.from_h(h)`
 
 - **Parameters**:
@@ -84,6 +98,8 @@ sudo gem install --local revtree-0.1.1.gem
 
 ## Example Usage
 
+### Comparing two directory structures
+
 ```ruby
 #!/bin/env ruby
 
@@ -105,6 +121,24 @@ result_tree.for_each([:added, :removed]) do |file, full_path|
 end
 ```
 
+### Watching a directory for changes
+
+```ruby
+#!/bin/env ruby
+
+require 'revtree'
+
+# Create a RevTree for the current directory, including only .rb and .md files
+file_tree = RevTree.new('./', ['*.rb', '*.md'])
+
+# Watch for changes in the directory
+file_tree.with_interval(10).watch([:modified, :added, :removed]) do |file, full_path|
+  puts "File #{file.name} #{file.status} in #{full_path}"
+end
+```
+
+This second example demonstrates the `watch` method, which continuously monitors the directory tree for changes and triggers a block of code when changes (additions, modifications, or deletions) are detected. The `with_interval` method customizes the time between checks.
+
 ## Encouragement for Contribution
 
 Contributions from the community are welcome!

data/lib/revtree.rb

@@ -126,6 +126,47 @@ class RevTree
     RevTree.traverse_tree(self, status_whitelist, @path, &block)
   end
 
+  # Watches the tree for changes
+  #
+  # Compares the refreshed tree to its last version and calls the provided block
+  # for each node that matches the statuses in the `status_whitelist`.
+  #
+  # @param status_whitelist [Array<Symbol>] the list of statuses to match (:added, :modified, etc.)
+  # @yield [node, full_path] the block to be executed for each matching file
+  # @yieldparam node [RevTree] the node that was changed
+  # @yieldparam full_path [String] the full path of the node
+  # @return [void]
+  def watch(status_whitelist = [:modified, :added, :removed], &block)
+    current_tree = self
+    @interval ||= 5
+
+    Signal.trap('INT') { exit }
+    Signal.trap('TERM') { exit }
+    loop do
+      sleep @interval
+
+      new_tree = RevTree.new(@path, @whitelist)
+      diff_tree = RevTree.compare(current_tree, new_tree)
+
+      next if diff_tree.nil?
+
+      diff_tree.for_each(status_whitelist) do |node, full_path|
+        block.call(node, full_path)
+      end
+
+      current_tree = new_tree
+    end
+  end
+
+  # Sets the interval for the watch method's sleep duration.
+  #
+  # @param interval [Integer] the number of seconds to sleep between checks
+  # @return [RevTree] the current instance for chaining
+  def with_interval(interval)
+    @interval = interval
+    self
+  end
+
   private
 
   # Calculates the MD5 hash for the file.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revtree
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Julian Kahlert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-06 00:00:00.000000000 Z
+date: 2024-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -51,7 +51,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.4'
 description: RevTree builds a recursive directory tree and compares file revisions.
-  It can mark files and folders as added, removed, modified, or unmodified.
+  It can mark files and folders as added, removed, modified, or unmodified. For convenience,
+  RevTree also allows you to watch for changes in a directory tree.
 email:
 - 90937526+juliankahlert@users.noreply.github.com
 executables: []
@@ -63,7 +64,10 @@ files:
 homepage: https://github.com/juliankahlert/revtree
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://juliankahlert.github.io/revtree/
+  documentation_uri: https://www.rubydoc.info/gems/revtree/0.1.3
+  source_code_uri: https://github.com/juliankahlert/revtree
 post_install_message: 
 rdoc_options: []
 require_paths: