build-files-monitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c927ec94d7e43c768d9b72cc2bd22aff95dc233a6c6969731093c110d4ba575f
+  data.tar.gz: 35416ba5b3908a3c68739071c24abb5bcb6f5ed25ae0c7b2bc18ce8eca697e41
+SHA512:
+  metadata.gz: 551f9e5d4a55888fb8f12424fa810e9989dc775a825b279b909d4a0e37179dcf345e1ed4113d7fa15730f31b9d018b47cf2cee4cbdf3b01f47f9d8e137b6646d
+  data.tar.gz: b684c90665fa6e3d97f5aba086215b48941c4443734848a844f97ea809b8696a293454ee698efccb12f0e936fe0f9d41bee58b6418bcb1ed329cb687f10dd708

data/lib/build/files/monitor.rb

@@ -0,0 +1,43 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Build
+	module Files
+		module Monitor
+			case RUBY_PLATFORM
+			when /linux/i
+				require_relative 'monitor/inotify'
+				Native = INotify
+				Default = Native
+			when /darwin/i
+				require_relative 'monitor/fsevent'
+				Native = FSEvent
+				Default = Native
+			else 
+				require_relative 'monitor/polling'
+				Default = Polling
+			end
+		
+			def self.new(*args)
+				Default.new(*args)
+			end
+		end
+	end
+end

data/lib/build/files/monitor/fsevent.rb

@@ -0,0 +1,55 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'polling'
+
+require 'rb-fsevent'
+
+module Build
+	module Files
+		module Monitor
+			class FSEvent < Polling
+				def run(**options, &block)
+					notifier = ::FSEvent.new
+					
+					catch(:interrupt) do
+						while true
+							notifier.watch self.roots do |directories|
+								directories.collect! do |directory|
+									File.expand_path(directory)
+								end
+								
+								self.update(directories)
+								
+								yield
+								
+								if self.updated
+									notifier.stop
+								end
+							end
+							
+							notifier.run
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/build/files/monitor/handle.rb

@@ -0,0 +1,61 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'state'
+
+module Build
+	module Files
+		module Monitor
+			class Handle
+				def initialize(monitor, files, &block)
+					@monitor = monitor
+					@state = State.new(files)
+					@block = block
+				end
+			
+				attr :monitor
+			
+				def commit!
+					@state.update!
+				end
+			
+				def directories
+					@state.files.roots
+				end
+			
+				def remove!
+					@monitor.delete(self)
+				end
+				
+				# Inform the handle that it might have been modified.
+				def changed!
+					# If @state.update! did not find any changes, don't invoke the callback:
+					if @state.update!
+						@block.call(@state)
+					end
+				end
+				
+				def to_s
+					"\#<#{self.class} @state=#{@state} @block=#{@block}>"
+				end
+			end
+		end
+	end
+end

data/lib/build/files/monitor/inotify.rb

@@ -0,0 +1,53 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'polling'
+
+require 'rb-inotify'
+
+module Build
+	module Files
+		module Monitor
+			class INotify < Polling
+				def run(**options, &block)
+					notifier = ::INotify::Notifier.new
+					
+					catch(:interrupt) do
+						while true
+							self.roots.each do |root|
+								notifier.watch root, :create, :modify, :attrib, :delete do |event|
+									self.update([root])
+									
+									yield
+									
+									if self.updated
+										notifier.stop
+									end
+								end
+							end
+							
+							notifier.run
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/build/files/monitor/polling.rb

@@ -0,0 +1,145 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'set'
+require 'logger'
+
+require_relative 'handle'
+
+module Build
+	module Files
+		module Monitor
+			class Polling
+				def initialize(logger: nil)
+					@directories = Hash.new do |hash, key|
+						hash[key] = Set.new
+					end
+					
+					@updated = false
+					
+					@deletions = nil
+					
+					@logger = logger || Logger.new(nil)
+				end
+				
+				attr :updated
+				
+				# Notify the monitor that files in these directories have changed.
+				def update(directories, *args)
+					@logger.debug{"Update: #{directories} #{args.inspect}"}
+					
+					delay_deletions do
+						directories.each do |directory|
+							@logger.debug{"Directory: #{directory}"}
+							
+							@directories[directory].each do |handle|
+								@logger.debug{"Handle changed: #{handle.inspect}"}
+								
+								# Changes here may not actually require an update to the handle:
+								handle.changed!(*args)
+							end
+						end
+					end
+				end
+				
+				def roots
+					@directories.keys
+				end
+				
+				def delete(handle)
+					if @deletions
+						@logger.debug{"Delayed delete handle: #{handle}"}
+						@deletions << handle
+					else
+						purge(handle)
+					end
+				end
+				
+				def track_changes(files, &block)
+					handle = Handle.new(self, files, &block)
+					
+					add(handle)
+				end
+				
+				def add(handle)
+					@logger.debug{"Adding handle: #{handle}"}
+					
+					handle.directories.each do |directory|
+						# We want the full path as a plain string:
+						directory = directory.to_s
+						
+						@directories[directory] << handle
+						
+						# We just added the first handle:
+						if @directories[directory].size == 1
+							# If the handle already existed, this might trigger unnecessarily.
+							@updated = true
+						end
+					end
+					
+					handle
+				end
+				
+				def run(**options, &block)
+					catch(:interrupt) do
+						while true
+							monitor.update(monitor.roots)
+							
+							yield
+							
+							sleep(options[:latency] || 1.0)
+						end
+					end
+				end
+				
+				protected
+				
+				def delay_deletions
+					@deletions = []
+					
+					yield
+					
+					@deletions.each do |handle|
+						purge(handle)
+					end
+					
+					@deletions = nil
+				end
+				
+				def purge(handle)
+					@logger.debug{"Purge handle: #{handle}"}
+					
+					handle.directories.each do |directory|
+						directory = directory.to_s
+						
+						@directories[directory].delete(handle)
+						
+						# Remove the entire record if there are no handles:
+						if @directories[directory].size == 0
+							@directories.delete(directory)
+							
+							@updated = true
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/build/files/monitor/state.rb

@@ -0,0 +1,174 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'build/files/list'
+
+require 'forwardable'
+
+module Build
+	module Files
+		module Monitor
+			# Represents a specific file on disk with a specific mtime.
+			class FileTime
+				include Comparable
+				
+				def initialize(path, time)
+					@path = path
+					@time = time
+				end
+				
+				attr :path
+				attr :time
+				
+				def <=> other
+					@time <=> other.time
+				end
+				
+				def inspect
+					"<FileTime #{@path.inspect} #{@time.inspect}>"
+				end
+			end
+			
+			# A stateful list of files captured at a specific time, which can then be checked for changes.
+			class State < List
+				extend Forwardable
+				
+				def initialize(files)
+					raise ArgumentError.new("Invalid files list: #{files}") unless Files::List === files
+					
+					@files = files
+					
+					@times = {}
+					
+					update!
+				end
+				
+				attr :files
+				
+				attr :added
+				attr :removed
+				attr :changed
+				attr :missing
+				
+				attr :times
+				
+				def_delegators :@files, :each, :roots, :count
+				
+				def update!
+					last_times = @times
+					@times = {}
+					
+					@added = []
+					@removed = []
+					@changed = []
+					@missing = []
+					
+					file_times = []
+					
+					@files.each do |path|
+						# When processing the same path twice (perhaps by accident), we should skip it otherwise it might cause issues when being deleted from last_times multuple times.
+						next if @times.include? path
+						
+						if File.exist?(path)
+							modified_time = File.mtime(path)
+						
+							if last_time = last_times.delete(path)
+								# Path was valid last update:
+								if modified_time != last_time
+									@changed << path
+									
+									# puts "Changed: #{path}"
+								end
+							else
+								# Path didn't exist before:
+								@added << path
+								
+								# puts "Added: #{path}"
+							end
+						
+							@times[path] = modified_time
+						
+							unless File.directory?(path)
+								file_times << FileTime.new(path, modified_time)
+							end
+						else
+							@missing << path
+							
+							# puts "Missing: #{path}"
+						end
+					end
+					
+					@removed = last_times.keys
+					# puts "Removed: #{@removed.inspect}" if @removed.size > 0
+					
+					@oldest_time = file_times.min
+					@newest_time = file_times.max
+					
+					return @added.size > 0 || @changed.size > 0 || @removed.size > 0 || @missing.size > 0
+				end
+				
+				attr :oldest_time
+				attr :newest_time
+				
+				def missing?
+					!@missing.empty?
+				end
+				
+				def empty?
+					@times.empty?
+				end
+				
+				def inspect
+					"<State Added:#{@added} Removed:#{@removed} Changed:#{@changed} Missing:#{@missing}>"
+				end
+				
+				# Are these (output) files dirty with respect to the given inputs?
+				def dirty?(inputs)
+					if self.missing?
+						return true
+					end
+					
+					# If there are no inputs or no outputs, we are always clean:
+					if inputs.empty? or self.empty?
+						return false
+					end
+					
+					oldest_output_time = self.oldest_time
+					newest_input_time = inputs.newest_time
+					
+					if newest_input_time and oldest_output_time
+						# We are dirty if any inputs are newer (bigger) than any outputs:
+						if newest_input_time > oldest_output_time
+							return true
+						else
+							return false
+						end
+					end
+					
+					return true
+				end
+				
+				def self.dirty?(inputs, outputs)
+					outputs.dirty?(inputs)
+				end
+			end
+		end
+	end
+end

data/lib/build/files/monitor/version.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Copyright, 2021, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Build
+	module Files
+		module Monitor
+			VERSION = "0.1.0"
+		end
+	end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: build-files-monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: build-files
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: covered
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/build/files/monitor.rb
+- lib/build/files/monitor/fsevent.rb
+- lib/build/files/monitor/handle.rb
+- lib/build/files/monitor/inotify.rb
+- lib/build/files/monitor/polling.rb
+- lib/build/files/monitor/state.rb
+- lib/build/files/monitor/version.rb
+homepage: https://github.com/ioquatix/build-files-monitor
+licenses:
+- MIT
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Efficiently monitor changes to the file system.
+test_files: []