core-watch 0.0.0

checksums.yaml

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [v0.0.0](https://github.com/metabahn/corerb/releases/tag/2021-04-03)
+
+*released on 2021-04-03*
+
+  * `add` [#26](https://github.com/metabahn/corerb/pull/26) Initial implementation of core-watch ([bryanp](https://github.com/bryanp))
+
+

data/LICENSE

@@ -0,0 +1,353 @@
+Mozilla Public License, version 2.0
+
+1. Definitions
+
+1.1. “Contributor”
+
+     means each individual or legal entity that creates, contributes to the
+     creation of, or owns Covered Software.
+
+1.2. “Contributor Version”
+
+     means the combination of the Contributions of others (if any) used by a
+     Contributor and that particular Contributor’s Contribution.
+
+1.3. “Contribution”
+
+     means Covered Software of a particular Contributor.
+
+1.4. “Covered Software”
+
+     means Source Code Form to which the initial Contributor has attached the
+     notice in Exhibit A, the Executable Form of such Source Code Form, and
+     Modifications of such Source Code Form, in each case including portions
+     thereof.
+
+1.5. “Incompatible With Secondary Licenses”
+     means
+
+     a. that the initial Contributor has attached the notice described in
+        Exhibit B to the Covered Software; or
+
+     b. that the Covered Software was made available under the terms of version
+        1.1 or earlier of the License, but not also under the terms of a
+        Secondary License.
+
+1.6. “Executable Form”
+
+     means any form of the work other than Source Code Form.
+
+1.7. “Larger Work”
+
+     means a work that combines Covered Software with other material, in a separate
+     file or files, that is not Covered Software.
+
+1.8. “License”
+
+     means this document.
+
+1.9. “Licensable”
+
+     means having the right to grant, to the maximum extent possible, whether at the
+     time of the initial grant or subsequently, any and all of the rights conveyed by
+     this License.
+
+1.10. “Modifications”
+
+     means any of the following:
+
+     a. any file in Source Code Form that results from an addition to, deletion
+        from, or modification of the contents of Covered Software; or
+
+     b. any new file in Source Code Form that contains any Covered Software.
+
+1.11. “Patent Claims” of a Contributor
+
+      means any patent claim(s), including without limitation, method, process,
+      and apparatus claims, in any patent Licensable by such Contributor that
+      would be infringed, but for the grant of the License, by the making,
+      using, selling, offering for sale, having made, import, or transfer of
+      either its Contributions or its Contributor Version.
+
+1.12. “Secondary License”
+
+      means either the GNU General Public License, Version 2.0, the GNU Lesser
+      General Public License, Version 2.1, the GNU Affero General Public
+      License, Version 3.0, or any later versions of those licenses.
+
+1.13. “Source Code Form”
+
+      means the form of the work preferred for making modifications.
+
+1.14. “You” (or “Your”)
+
+      means an individual or a legal entity exercising rights under this
+      License. For legal entities, “You” includes any entity that controls, is
+      controlled by, or is under common control with You. For purposes of this
+      definition, “control” means (a) the power, direct or indirect, to cause
+      the direction or management of such entity, whether by contract or
+      otherwise, or (b) ownership of more than fifty percent (50%) of the
+      outstanding shares or beneficial ownership of such entity.
+
+
+2. License Grants and Conditions
+
+2.1. Grants
+
+     Each Contributor hereby grants You a world-wide, royalty-free,
+     non-exclusive license:
+
+     a. under intellectual property rights (other than patent or trademark)
+        Licensable by such Contributor to use, reproduce, make available,
+        modify, display, perform, distribute, and otherwise exploit its
+        Contributions, either on an unmodified basis, with Modifications, or as
+        part of a Larger Work; and
+
+     b. under Patent Claims of such Contributor to make, use, sell, offer for
+        sale, have made, import, and otherwise transfer either its Contributions
+        or its Contributor Version.
+
+2.2. Effective Date
+
+     The licenses granted in Section 2.1 with respect to any Contribution become
+     effective for each Contribution on the date the Contributor first distributes
+     such Contribution.
+
+2.3. Limitations on Grant Scope
+
+     The licenses granted in this Section 2 are the only rights granted under this
+     License. No additional rights or licenses will be implied from the distribution
+     or licensing of Covered Software under this License. Notwithstanding Section
+     2.1(b) above, no patent license is granted by a Contributor:
+
+     a. for any code that a Contributor has removed from Covered Software; or
+
+     b. for infringements caused by: (i) Your and any other third party’s
+        modifications of Covered Software, or (ii) the combination of its
+        Contributions with other software (except as part of its Contributor
+        Version); or
+
+     c. under Patent Claims infringed by Covered Software in the absence of its
+        Contributions.
+
+     This License does not grant any rights in the trademarks, service marks, or
+     logos of any Contributor (except as may be necessary to comply with the
+     notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+     No Contributor makes additional grants as a result of Your choice to
+     distribute the Covered Software under a subsequent version of this License
+     (see Section 10.2) or under the terms of a Secondary License (if permitted
+     under the terms of Section 3.3).
+
+2.5. Representation
+
+     Each Contributor represents that the Contributor believes its Contributions
+     are its original creation(s) or it has sufficient rights to grant the
+     rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+     This License is not intended to limit any rights You have under applicable
+     copyright doctrines of fair use, fair dealing, or other equivalents.
+
+2.7. Conditions
+
+     Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in
+     Section 2.1.
+
+
+3. Responsibilities
+
+3.1. Distribution of Source Form
+
+     All distribution of Covered Software in Source Code Form, including any
+     Modifications that You create or to which You contribute, must be under the
+     terms of this License. You must inform recipients that the Source Code Form
+     of the Covered Software is governed by the terms of this License, and how
+     they can obtain a copy of this License. You may not attempt to alter or
+     restrict the recipients’ rights in the Source Code Form.
+
+3.2. Distribution of Executable Form
+
+     If You distribute Covered Software in Executable Form then:
+
+     a. such Covered Software must also be made available in Source Code Form,
+        as described in Section 3.1, and You must inform recipients of the
+        Executable Form how they can obtain a copy of such Source Code Form by
+        reasonable means in a timely manner, at a charge no more than the cost
+        of distribution to the recipient; and
+
+     b. You may distribute such Executable Form under the terms of this License,
+        or sublicense it under different terms, provided that the license for
+        the Executable Form does not attempt to limit or alter the recipients’
+        rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+     You may create and distribute a Larger Work under terms of Your choice,
+     provided that You also comply with the requirements of this License for the
+     Covered Software. If the Larger Work is a combination of Covered Software
+     with a work governed by one or more Secondary Licenses, and the Covered
+     Software is not Incompatible With Secondary Licenses, this License permits
+     You to additionally distribute such Covered Software under the terms of
+     such Secondary License(s), so that the recipient of the Larger Work may, at
+     their option, further distribute the Covered Software under the terms of
+     either this License or such Secondary License(s).
+
+3.4. Notices
+
+     You may not remove or alter the substance of any license notices (including
+     copyright notices, patent notices, disclaimers of warranty, or limitations
+     of liability) contained within the Source Code Form of the Covered
+     Software, except that You may alter any license notices to the extent
+     required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+     You may choose to offer, and to charge a fee for, warranty, support,
+     indemnity or liability obligations to one or more recipients of Covered
+     Software. However, You may do so only on Your own behalf, and not on behalf
+     of any Contributor. You must make it absolutely clear that any such
+     warranty, support, indemnity, or liability obligation is offered by You
+     alone, and You hereby agree to indemnify every Contributor for any
+     liability incurred by such Contributor as a result of warranty, support,
+     indemnity or liability terms You offer. You may include additional
+     disclaimers of warranty and limitations of liability specific to any
+     jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+
+   If it is impossible for You to comply with any of the terms of this License
+   with respect to some or all of the Covered Software due to statute, judicial
+   order, or regulation then You must: (a) comply with the terms of this License
+   to the maximum extent possible; and (b) describe the limitations and the code
+   they affect. Such description must be placed in a text file included with all
+   distributions of the Covered Software under this License. Except to the
+   extent prohibited by statute or regulation, such description must be
+   sufficiently detailed for a recipient of ordinary skill to be able to
+   understand it.
+
+5. Termination
+
+5.1. The rights granted under this License will terminate automatically if You
+     fail to comply with any of its terms. However, if You become compliant,
+     then the rights granted under this License from a particular Contributor
+     are reinstated (a) provisionally, unless and until such Contributor
+     explicitly and finally terminates Your grants, and (b) on an ongoing basis,
+     if such Contributor fails to notify You of the non-compliance by some
+     reasonable means prior to 60 days after You have come back into compliance.
+     Moreover, Your grants from a particular Contributor are reinstated on an
+     ongoing basis if such Contributor notifies You of the non-compliance by
+     some reasonable means, this is the first time You have received notice of
+     non-compliance with this License from such Contributor, and You become
+     compliant prior to 30 days after Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+     infringement claim (excluding declaratory judgment actions, counter-claims,
+     and cross-claims) alleging that a Contributor Version directly or
+     indirectly infringes any patent, then the rights granted to You by any and
+     all Contributors for the Covered Software under Section 2.1 of this License
+     shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user
+     license agreements (excluding distributors and resellers) which have been
+     validly granted by You or Your distributors under this License prior to
+     termination shall survive termination.
+
+6. Disclaimer of Warranty
+
+   Covered Software is provided under this License on an “as is” basis, without
+   warranty of any kind, either expressed, implied, or statutory, including,
+   without limitation, warranties that the Covered Software is free of defects,
+   merchantable, fit for a particular purpose or non-infringing. The entire
+   risk as to the quality and performance of the Covered Software is with You.
+   Should any Covered Software prove defective in any respect, You (not any
+   Contributor) assume the cost of any necessary servicing, repair, or
+   correction. This disclaimer of warranty constitutes an essential part of this
+   License. No use of  any Covered Software is authorized under this License
+   except under this disclaimer.
+
+7. Limitation of Liability
+
+   Under no circumstances and under no legal theory, whether tort (including
+   negligence), contract, or otherwise, shall any Contributor, or anyone who
+   distributes Covered Software as permitted above, be liable to You for any
+   direct, indirect, special, incidental, or consequential damages of any
+   character including, without limitation, damages for lost profits, loss of
+   goodwill, work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses, even if such party shall have been
+   informed of the possibility of such damages. This limitation of liability
+   shall not apply to liability for death or personal injury resulting from such
+   party’s negligence to the extent applicable law prohibits such limitation.
+   Some jurisdictions do not allow the exclusion or limitation of incidental or
+   consequential damages, so this exclusion and limitation may not apply to You.
+
+8. Litigation
+
+   Any litigation relating to this License may be brought only in the courts of
+   a jurisdiction where the defendant maintains its principal place of business
+   and such litigation shall be governed by laws of that jurisdiction, without
+   reference to its conflict-of-law provisions. Nothing in this Section shall
+   prevent a party’s ability to bring cross-claims or counter-claims.
+
+9. Miscellaneous
+
+   This License represents the complete agreement concerning the subject matter
+   hereof. If any provision of this License is held to be unenforceable, such
+   provision shall be reformed only to the extent necessary to make it
+   enforceable. Any law or regulation which provides that the language of a
+   contract shall be construed against the drafter shall not be used to construe
+   this License against a Contributor.
+
+
+10. Versions of the License
+
+10.1. New Versions
+
+      Mozilla Foundation is the license steward. Except as provided in Section
+      10.3, no one other than the license steward has the right to modify or
+      publish new versions of this License. Each version will be given a
+      distinguishing version number.
+
+10.2. Effect of New Versions
+
+      You may distribute the Covered Software under the terms of the version of
+      the License under which You originally received the Covered Software, or
+      under the terms of any subsequent version published by the license
+      steward.
+
+10.3. Modified Versions
+
+      If you create software not governed by this License, and you want to
+      create a new license for such software, you may create and use a modified
+      version of this License if you rename the license and remove any
+      references to the name of the license steward (except to note that such
+      modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses
+      If You choose to distribute Source Code Form that is Incompatible With
+      Secondary Licenses under the terms of this version of the License, the
+      notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+
+      This Source Code Form is subject to the
+      terms of the Mozilla Public License, v.
+      2.0. If a copy of the MPL was not
+      distributed with this file, You can
+      obtain one at
+      http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular file, then
+You may include the notice in a location (such as a LICENSE file in a relevant
+directory) where a recipient would be likely to look for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - “Incompatible With Secondary Licenses” Notice
+
+      This Source Code Form is “Incompatible
+      With Secondary Licenses”, as defined by
+      the Mozilla Public License, v. 2.0.

data/lib/core/watch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Core
+  module Watch
+    require_relative "watch/callback"
+    require_relative "watch/diff"
+    require_relative "watch/snapshot"
+    require_relative "watch/status"
+    require_relative "watch/strategy"
+    require_relative "watch/system"
+    require_relative "watch/version"
+  end
+end

data/lib/core/watch/callback.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Core
+  module Watch
+    # [public] Callback for a watched system.
+    #
+    class Callback
+      class << self
+        # [public] Build a callback instance for a given value and block.
+        #
+        def build(value, &block)
+          case value
+          when Callback
+            value
+          when ::NilClass
+            Callback.new(&block)
+          when ::Regexp
+            Callbacks::Regexp.new(value, &block)
+          else
+            Callbacks::Path.new(value, &block)
+          end
+        end
+      end
+
+      def initialize(&block)
+        @block = block
+      end
+
+      # [public] Invoke the callback.
+      #
+      def call(*args, **kwargs)
+        @block.call(*args, **kwargs)
+      end
+
+      # [public]
+      #
+      def match?(_)
+        true
+      end
+    end
+
+    require_relative "callbacks/path"
+    require_relative "callbacks/regexp"
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module Core
+  module Watch
+    module Callbacks
+      # [public] Callback that wraps a path.
+      #
+      class Path < Callback
+        def initialize(value, **kwargs, &block)
+          super(**kwargs, &block)
+
+          @path = Pathname(value.to_s)
+        end
+
+        # [public] Return `true` if this callback matches the path.
+        #
+        def match?(path)
+          @path == path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Core
+  module Watch
+    module Callbacks
+      # [public] Callback that wraps a regular expression.
+      #
+      class Regexp < Callback
+        def initialize(regexp, **kwargs, &block)
+          super(**kwargs, &block)
+
+          @regexp = regexp
+        end
+
+        # [public] Return `true` if this callback matches the path.
+        #
+        def match?(path)
+          @regexp.match?(path.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/core/watch/diff.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module Core
+  module Watch
+    # [public] Contains changes to a watched system, organized by operation.
+    #
+    class Diff
+      OPERATIONS = %i[added changed removed].freeze
+
+      def initialize
+        @changes = {}
+      end
+
+      OPERATIONS.each do |operation|
+        # [public]
+        #
+        class_eval <<~CODE, __FILE__, __LINE__ + 1
+          def #{operation}(path)
+            @changes[path] = #{operation.inspect}
+          end
+        CODE
+      end
+
+      # [public] Call the given block once with each changed path and operation.
+      #
+      def each_change(&block)
+        return to_enum(:each_change) unless block
+
+        @changes.each_pair(&block)
+      end
+
+      # [public] Call the given block once with each changed path.
+      #
+      def each_changed_path(&block)
+        return to_enum(:each_changed_path) unless block
+
+        @changes.each_key(&block)
+      end
+
+      # [public] Return `true` if the diff contains changes.
+      #
+      def changed?
+        @changes.any?
+      end
+
+      # [public] Return `true` if `path` is included in the changes.
+      #
+      def include?(path)
+        @changes.include?(Pathname(path))
+      end
+
+      # [public] Return the operation for the given path.
+      #
+      def operation(path)
+        @changes[path]
+      end
+    end
+  end
+end

data/lib/core/watch/snapshot.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "diff"
+
+module Core
+  module Watch
+    # [public] Snapshot of a watched system that can generate diffs.
+    #
+    class Snapshot
+      class << self
+        def default_strategy
+          require_relative "strategies/digest"
+
+          Strategies::Digest
+        end
+      end
+
+      def initialize(*paths, ignore: [], strategy: self.class.default_strategy)
+        @ignore = ignore
+        @directories = {}
+        @files = {}
+        @strategy = strategy.new
+
+        track(*paths)
+      end
+
+      # [public] Return `true` if `path` is ignored.
+      #
+      def ignore?(path)
+        @ignore.any? do |ignore|
+          path.fnmatch?(ignore)
+        end
+      end
+
+      # [public] Detect changes, update the snapshot, and return a diff.
+      #
+      def diff
+        trackable = []
+        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
+              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
+          end
+        end
+
+        track(*trackable)
+        untrack(*untrackable)
+
+        diff
+      end
+
+      # [public]
+      #
+      private def track(*paths)
+        paths.each do |path|
+          next if ignore?(path)
+
+          if path.file?
+            @files[path] = @strategy.identify(path)
+          elsif path.directory?
+            existed = @directories.include?(path)
+            @directories[path] = @strategy.identify(path)
+
+            unless existed
+              track(*path.glob("*"))
+            end
+          else
+            track(*Dir.glob(path).map { |string| Pathname(string) })
+          end
+        end
+      end
+
+      # [public]
+      #
+      private def untrack(*paths)
+        paths.each do |path|
+          @files.delete(path)
+          @directories.delete(path)
+        end
+      end
+    end
+  end
+end

data/lib/core/watch/status.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Core
+  module Watch
+    # [public] The status of a system watch.
+    #
+    class Status
+      STATES = %i[running paused stopped].freeze
+
+      def initialize
+        @state = :stopped
+        @mutex = Mutex.new
+      end
+
+      STATES.each do |state|
+        # [public]
+        #
+        class_eval <<~CODE, __FILE__, __LINE__ + 1
+          def #{state}!
+            @mutex.synchronize {
+              if @state == #{state.inspect}
+                false
+              else
+                @state = #{state.inspect}
+                true
+              end
+            }
+          end
+        CODE
+
+        # [public]
+        #
+        class_eval <<~CODE, __FILE__, __LINE__ + 1
+          def #{state}?
+            @state == #{state.inspect} || (#{state.inspect} == :running && @state == :paused)
+          end
+        CODE
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "openssl"
+
+require_relative "../strategy"
+
+module Core
+  module Watch
+    module Strategies
+      # [public] Identifies a path by digest or modified time (for directories).
+      #
+      class Digest
+        BUFFER_LENGTH = 16_384
+
+        # [public]
+        #
+        def identify(path)
+          if path.file?
+            md5 = OpenSSL::Digest.new("MD5")
+
+            path.open("rb") do |file|
+              buffer = +""
+              while file.read(BUFFER_LENGTH, buffer)
+                md5 << buffer
+              end
+            end
+
+            md5.digest
+          else
+            path.mtime
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../strategy"
+
+module Core
+  module Watch
+    module Strategies
+      # [public] Identifies a path by modified time.
+      #
+      class Timestamp
+        # [public]
+        #
+        def identify(path)
+          path.mtime
+        end
+      end
+    end
+  end
+end

data/lib/core/watch/strategy.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Core
+  module Watch
+    # [public] Abstract strategy for uniquely identifying a path.
+    #
+    class Strategy
+      # [public]
+      #
+      def identify(path)
+        raise "unimplemented"
+      end
+    end
+  end
+end

data/lib/core/watch/system.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+require "core/async"
+
+require_relative "callback"
+require_relative "snapshot"
+require_relative "status"
+
+module Core
+  module Watch
+    # [public] The system watcher.
+    #
+    class System
+      include Is::Async
+
+      # [public] The configured polling interval.
+      #
+      attr_accessor :interval
+
+      # [public] The status object.
+      #
+      attr_reader :status
+
+      # [public] The current latency.
+      #
+      attr_reader :latency
+
+      def initialize(interval: 0.1, strategy: :digest)
+        @interval = interval
+        @status = Status.new
+        @mutex = Mutex.new
+        @watched = []
+        @ignored = []
+        @callbacks = []
+        @working = false
+        @latency = nil
+
+        @strategy = case strategy.to_sym
+        when :digest
+          require_relative "strategies/digest"
+          Strategies::Digest
+        when :timestamp
+          require_relative "strategies/timestamp"
+          Strategies::Timestamp
+        else
+          raise ArgumentError, "unknown watch strategy `#{strategy.inspect}'"
+        end
+      end
+
+      # [public] Watch `path` for changes.
+      #
+      def watch(path)
+        path = Pathname(path).expand_path
+
+        @mutex.synchronize do
+          unless @watched.include?(path)
+            mutate do
+              @watched << path
+            end
+          end
+        end
+      end
+
+      # [public] Ignore changes at `path`.
+      #
+      def ignore(path)
+        path = path.to_s
+
+        @mutex.synchronize do
+          unless @ignored.include?(path)
+            mutate do
+              @ignored << path
+            end
+          end
+        end
+      end
+
+      # [public] Register a callback to be called when a change is detected. The callback will only be called once per
+      # tick and will be given a `Core::Watch::Diff` instance. If `matcher` is passed, the callback will only be called
+      # for matching changes. The matcher can be a string or any object that responds to `match?`.
+      #
+      def callback(matcher = nil, &block)
+        raise ArgumentError, "expected a block" if block.nil?
+
+        @mutex.synchronize do
+          @callbacks << Callback.build(matcher, &block)
+        end
+      end
+
+      # [public] Start the watcher.
+      #
+      def start
+        await do
+          unless @status.running?
+            @future = run
+          end
+        end
+      end
+
+      # [public] Stop the watcher.
+      #
+      def stop(force: false)
+        if !@working || force
+          @future&.cancel
+        end
+
+        @status.stopped!
+      end
+
+      # [public] Pause the watcher, causing it to continue running but not invoke callbacks.
+      #
+      def pause
+        @status.paused!
+      end
+
+      # [public] Resume a paused watcher.
+      #
+      def resume
+        @status.running!
+      end
+
+      private def run
+        async {
+          @status.running!
+
+          rebuild_snapshot
+
+          until @status.stopped?
+            sleep(@interval)
+
+            started = current_time
+
+            # Don't process this tick if the watch was paused or stopped while sleeping.
+            #
+            next if @status.paused? || @status.stopped?
+
+            # Do the work, updating the snapshot in the process.
+            #
+            invoke_callbacks(@snapshot.diff)
+
+            # Measure the latency for this tick.
+            #
+            @latency = [0, current_time - started - @interval].max
+          end
+        }
+      end
+
+      private def mutate
+        yield
+
+        if @status.running?
+          rebuild_snapshot
+        end
+      end
+
+      private def rebuild_snapshot
+        @snapshot = Snapshot.new(*@watched, ignore: @ignored, strategy: @strategy)
+      end
+
+      private def invoke_callbacks(diff)
+        return unless diff.changed?
+
+        await do
+          @working = true
+          @callbacks.each do |callback|
+            maybe_invoke_callback(callback, diff)
+          end
+        end
+      ensure
+        @working = false
+      end
+
+      private def maybe_invoke_callback(callback, diff)
+        diff.each_change do |path, event|
+          if callback.match?(path)
+            return async { callback.call(diff) }
+          end
+        end
+      end
+
+      private def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

data/lib/core/watch/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Core
+  module Watch
+    VERSION = "0.0.0"
+
+    def self.version
+      VERSION
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: core-watch
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Bryan Powell
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: core-async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Watches the filesystem for changes.
+email: bryan@metabahn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- lib/core/watch.rb
+- lib/core/watch/callback.rb
+- lib/core/watch/callbacks/path.rb
+- lib/core/watch/callbacks/regexp.rb
+- lib/core/watch/diff.rb
+- lib/core/watch/snapshot.rb
+- lib/core/watch/status.rb
+- lib/core/watch/strategies/digest.rb
+- lib/core/watch/strategies/timestamp.rb
+- lib/core/watch/strategy.rb
+- lib/core/watch/system.rb
+- lib/core/watch/version.rb
+homepage: https://github.com/metabahn/corerb/
+licenses:
+- MPL-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.4
+signing_key:
+specification_version: 4
+summary: Watches the filesystem for changes.
+test_files: []