build-files 1.4.3 → 1.7.1

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/build-files.gemspec

@@ -1,28 +0,0 @@
-
-require_relative 'lib/build/files/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "build-files"
-	spec.version       = Build::Files::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-	# spec.description   = %q{}
-	spec.summary       = %q{Build::Files is a set of idiomatic classes for dealing with paths and monitoring directories.}
-	spec.homepage      = ""
-	spec.license       = "MIT"
-
-	spec.files         = `git ls-files`.split($/)
-	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-	spec.require_paths = ["lib"]
-	
-	spec.required_ruby_version = '>= 2.0'
-	
-	spec.add_dependency "rb-inotify"
-	spec.add_dependency "rb-fsevent"
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rspec", "~> 3.4"
-	spec.add_development_dependency "rake"
-end

data/lib/build/files/handle.rb

@@ -1,59 +0,0 @@
-# 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
-		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

data/lib/build/files/monitor.rb

@@ -1,43 +0,0 @@
-# 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

@@ -1,55 +0,0 @@
-# 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/inotify.rb

@@ -1,53 +0,0 @@
-# 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

@@ -1,145 +0,0 @@
-# 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/state.rb

@@ -1,172 +0,0 @@
-# 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 'list'
-
-require 'forwardable'
-
-module Build
-	module Files
-		# 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 < Files::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