core-watch 0.0.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 742d61f2473ddb32defdf6b2379cf4bcb2c678ce889af2e2c8ae29b63548269b
-  data.tar.gz: 72bfc097768d5abf52db5e4db2ca7828d2bb7d7013872bac622197e205529573
+  metadata.gz: b842f39a01164cc86186d2d6f4d460f072da58c49db6edfa16d1b539d7aebd23
+  data.tar.gz: b0793753ed9a521036bce634849297e8192a130afdf54c791c9110cda0065c5a
 SHA512:
-  metadata.gz: 737bbeea342ae421335afc835826f515a60f441f0beb5e370c2e1c1f1389def2c466c1b895650806acb9bd3e4b87869f6046f02805c7d74a7bc3ab9eaf85641b
-  data.tar.gz: e1725cf0a045c22d734b4819dfc9ccb0372864383e6adea88c0c2188d37ee39020087f8d8145f2ad2b6a1342779b21fe57c92dd7959c9f0ecb243f16c09e091a
+  metadata.gz: f811b6a0c04956fe4ecdf04739c56d4495dec0b3b637647007655dae6f04d4ff5c87ad2a0633f058780c6207d6abe6f0f945ff8912f98e4008a70d82a2bb8d4c
+  data.tar.gz: eb57fdb8e3185fe68f6fa69c47a97c13cdd15df6fb41767d6949da19af767e45bf6bba7263300f50a6f7c3e90c6ee54da44e9f5d3df70e1c515368d95cfc162b

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [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.0"
+    VERSION = "0.2.1"
 
     def self.version
       VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: core-watch
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Bryan Powell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-04 00:00:00.000000000 Z
+date: 2021-07-15 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.5.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        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.5.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Watches the filesystem for changes.