core-watch 0.0.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ed0f842d5e77d84a3a379c48ce82d1717485b56e2c33e5e6a86fcfae69f58b4
-  data.tar.gz: f75240b2e82db55ed719ef18711ddd36501b528f27d16f28a01a8097118cf21e
+  metadata.gz: 95539be18091e3862a8c38087ff09cf98303e24a7a505c30bfd684175e0857ab
+  data.tar.gz: e167fa98d5a04d4b06f3641d4bae9caecf12c959a846d320582ee7a7f7699645
 SHA512:
-  metadata.gz: 14ce6c0d7b2333652ec3a4d15cc885e7d88765a04bd5b6d93acf1a9985507b94f169510b6c4a8fc90a42daef22ef3c592fa44b48804ce4ab32f20372161f1adc
-  data.tar.gz: fd21f2387f8458c9ff96586c2e91640a2123810dc91b91393b03edea85644238f8096001e3bff5c53770cb9c04d05f24eb9e2800d812d155e256a6187cdebb3d
+  metadata.gz: d91acb6055f35e945c9996f964c726d9fa253d1cf873db677d17e735eaf3eb54f68e360720069ca4eeb0daf2af5b68c0015c72b0c162f41071a361f9953fe514
+  data.tar.gz: 7a0adabcace940051770dad54fd234fb64811125d62861e656e393adb5033e2b9672fbf63d471d6e43b6e7e454b87a0569ec347219bdab598dcfbcd05466ec25

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## [v0.3.0](https://github.com/metabahn/corerb/releases/tag/2021-10-24)
+
+*released on 2021-10-24*
+
+  * `chg` [#83](https://github.com/metabahn/corerb/pull/83) Drop Ruby 2 support from core-watch ([bryanp](https://github.com/bryanp))
+
+## [v0.2.0](https://github.com/metabahn/corerb/releases/tag/2021-07-15)
+
+*released on 2021-07-15*
+
+  * `add` [#56](https://github.com/metabahn/corerb/pull/56) Make all watch objects inspectable ([bryanp](https://github.com/bryanp))
+
+## [v0.1.0](https://github.com/metabahn/corerb/releases/tag/2021-07-07)
+
+*released on 2021-07-07*
+
+  * `chg` [#45](https://github.com/metabahn/corerb/pull/45) Drop Ruby 2.6 support from core-watch ([bryanp](https://github.com/bryanp))
+
+## [v0.0.2](https://github.com/metabahn/corerb/releases/tag/2021-05-22)
+
+*released on 2021-05-22*
+
+  * `chg` [#30](https://github.com/metabahn/corerb/pull/30) Performance improvements to watch snapshots ([bryanp](https://github.com/bryanp))
+
 ## [v0.0.0](https://github.com/metabahn/corerb/releases/tag/2021-04-03)
 
 *released on 2021-04-03*

data/lib/core/watch/callback.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
+
 module Core
   module Watch
     # [public] Callback for a watched system.
@@ -22,6 +24,8 @@ module Core
         end
       end
 
+      include Is::Inspectable
+
       def initialize(&block)
         @block = block
       end

data/lib/core/watch/callbacks/path.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
 require "pathname"
 
 module Core
@@ -8,6 +9,8 @@ module Core
       # [public] Callback that wraps a path.
       #
       class Path < Callback
+        include Is::Inspectable
+
         def initialize(value, **kwargs, &block)
           super(**kwargs, &block)
 

data/lib/core/watch/callbacks/regexp.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
+
 module Core
   module Watch
     module Callbacks
       # [public] Callback that wraps a regular expression.
       #
       class Regexp < Callback
+        include Is::Inspectable
+
         def initialize(regexp, **kwargs, &block)
           super(**kwargs, &block)
 

data/lib/core/watch/diff.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
 require "pathname"
 
 module Core
@@ -7,6 +8,8 @@ module Core
     # [public] Contains changes to a watched system, organized by operation.
     #
     class Diff
+      include Is::Inspectable
+
       OPERATIONS = %i[added changed removed].freeze
 
       def initialize

data/lib/core/watch/snapshot.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
+
 require_relative "diff"
 
 module Core
@@ -15,10 +17,11 @@ module Core
         end
       end
 
+      include Is::Inspectable
+
       def initialize(*paths, ignore: [], strategy: self.class.default_strategy)
         @ignore = ignore
-        @directories = {}
-        @files = {}
+        @watched = {}
         @strategy = strategy.new
 
         track(*paths)
@@ -39,35 +42,33 @@ module Core
         untrackable = []
         diff = Diff.new
 
-        # The mtime of the parent directory changes when its contents have changed (e.g. a file is added or removed).
-        # So, do the minimum amount of work necessary to detect added/removed files, then detect file changes below.
-        #
-        @directories.each do |path, current|
-          if !path.exist?
-            diff.removed(path)
-            untrackable << path
-          elsif @strategy.identify(path) != current
-            path.glob("*") do |each_path|
-              unless @directories.include?(each_path) || @files.include?(each_path)
-                next if ignore?(each_path)
-
-                diff.added(each_path)
-                trackable << each_path
+        @watched.each do |path, object|
+          case object[:type]
+          when :directory
+            # The mtime of the parent directory changes when its contents have changed (e.g. a file is added or removed).
+            # So, do the minimum amount of work necessary to detect added/removed files, then detect file changes below.
+            #
+            if @strategy.identify(path) != object[:identity]
+              path.glob("*") do |each_path|
+                unless @watched.include?(each_path)
+                  next if ignore?(each_path)
+
+                  diff.added(each_path)
+                  trackable << each_path
+                end
               end
-            end
-
-            trackable << path
-          end
-        end
 
-        @files.each do |path, current|
-          if !path.exist?
-            diff.removed(path)
-            untrackable << path
-          elsif @strategy.identify(path) != current
-            diff.changed(path)
-            trackable << path
+              trackable << path
+            end
+          when :file
+            if @strategy.identify(path) != object[:identity]
+              diff.changed(path)
+              trackable << path
+            end
           end
+        rescue Errno::ENOENT
+          diff.removed(path)
+          untrackable << path
         end
 
         track(*trackable)
@@ -82,13 +83,22 @@ module Core
         paths.each do |path|
           next if ignore?(path)
 
-          if path.file?
-            @files[path] = @strategy.identify(path)
+          type = if path.file?
+            :file
           elsif path.directory?
-            existed = @directories.include?(path)
-            @directories[path] = @strategy.identify(path)
+            :directory
+          end
+
+          if type
+            object = {
+              type: type,
+              identity: @strategy.identify(path)
+            }
+
+            existed = @watched.include?(path)
+            @watched[path] = object
 
-            unless existed
+            if type == :directory && !existed
               track(*path.glob("*"))
             end
           else
@@ -101,8 +111,7 @@ module Core
       #
       private def untrack(*paths)
         paths.each do |path|
-          @files.delete(path)
-          @directories.delete(path)
+          @watched.delete(path)
         end
       end
     end

data/lib/core/watch/status.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
+
 module Core
   module Watch
     # [public] The status of a system watch.
     #
     class Status
+      include Is::Inspectable
+      inspects without: [:@mutex]
+
       STATES = %i[running paused stopped].freeze
 
       def initialize

data/lib/core/watch/strategies/digest.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
 require "openssl"
 
 require_relative "../strategy"
@@ -10,6 +11,8 @@ module Core
       # [public] Identifies a path by digest or modified time (for directories).
       #
       class Digest
+        include Is::Inspectable
+
         BUFFER_LENGTH = 16_384
 
         # [public]

data/lib/core/watch/strategies/timestamp.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
+
 require_relative "../strategy"
 
 module Core
@@ -8,6 +10,8 @@ module Core
       # [public] Identifies a path by modified time.
       #
       class Timestamp
+        include Is::Inspectable
+
         # [public]
         #
         def identify(path)

data/lib/core/watch/strategy.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
+
 module Core
   module Watch
     # [public] Abstract strategy for uniquely identifying a path.
     #
     class Strategy
+      include Is::Inspectable
+
       # [public]
       #
       def identify(path)

data/lib/core/watch/system.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "is/inspectable"
 require "pathname"
 
 require "core/async"
@@ -14,6 +15,8 @@ module Core
     #
     class System
       include Is::Async
+      include Is::Inspectable
+      inspects without: [:@mutex, :@working]
 
       # [public] The configured polling interval.
       #

data/lib/core/watch/version.rb

@@ -2,7 +2,7 @@
 
 module Core
   module Watch
-    VERSION = "0.0.1"
+    VERSION = "0.3.0"
 
     def self.version
       VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: core-watch
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Bryan Powell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-20 00:00:00.000000000 Z
+date: 2021-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: core-async
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: core-inspect
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 description: Watches the filesystem for changes.
 email: bryan@metabahn.com
 executables: []
@@ -56,14 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.7
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Watches the filesystem for changes.