build-files 1.6.0 → 1.8.0

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/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/spec/build/files/directory_spec.rb

@@ -1,80 +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 'build/files/directory'
-
-module Build::Files::DirectorySpec
-	include Build::Files
-	
-	describe Build::Files::Directory do
-		let(:path) {Path.new("/foo/bar/baz", "/foo")}
-		let(:directory) {Directory.new(path)}
-		
-		it "can be constructed using join" do
-			joined_directory = Directory.join('/foo', 'bar/baz')
-			
-			expect(joined_directory).to be == directory
-		end
-		
-		it "has a root and path component" do
-			expect(directory.root).to be == path
-			expect(directory.to_path).to be == path
-			
-			expect(directory.roots).to be_include(path)
-		end
-		
-		it "can be converted into a string" do
-			expect(directory.to_str).to be == path.to_str
-		end
-		
-		it "can be used as a key" do
-			hash = {directory => true}
-			
-			expect(hash).to be_include directory
-		end
-		
-		it "includes subpaths" do
-			expect(directory).to be_include "/foo/bar/baz/bob/dole"
-		end
-		
-		it "can be compared" do
-			other_directory = Directory.new(path + 'dole')
-			
-			expect(directory).to be_eql directory
-			expect(directory).to_not be_eql other_directory
-		end
-		
-		it "can be rebased" do
-			rebased_directory = directory.rebase("/fu")
-			
-			expect(rebased_directory.root).to be == '/fu/bar/baz'
-		end
-		
-		context Directory.join(__dir__, "directory_spec") do
-			it "can list dot files" do
-				expect(subject).to include(subject.root + '.dot_file.yaml')
-			end
-			
-			it "can list normal files" do
-				expect(subject).to include(subject.root + 'normal_file.txt')
-			end
-		end
-	end
-end

data/spec/build/files/glob_spec.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 'build/files/glob'
-
-RSpec.describe Build::Files::Glob do
-	let(:path) {Build::Files::Path.new(__dir__)}
-	
-	it "can glob paths" do
-		paths = path.glob("*.rb")
-		
-		expect(paths.count).to be >= 1
-	end
-	
-	it "can be used as key in hash" do
-		cache = {}
-		
-		cache[path.glob("*.rb")] = true
-		
-		expect(cache).to be_include(path.glob("*.rb"))
-	end
-	
-	it "should print nice string represenation" do
-		glob = Build::Files::Glob.new(".", "*.rb")
-		
-		expect("#{glob}").to be == '<Glob "."/"*.rb">'
-	end
-	
-	context 'with dotfiles' do
-		it "should list files starting with dot" do
-			paths = path.glob("glob_spec/dotfiles/**/*")
-			
-			expect(paths.count).to be == 1
-		end
-	end
-end

data/spec/build/files/list_spec.rb

@@ -1,182 +0,0 @@
-# Copyright, 2012, 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'
-require 'build/files/list'
-require 'build/files/glob'
-
-module Build::Files::ListSpec
-	include Build::Files
-	
-	describe Build::Files::Paths do
-		let(:path) {Path.new("/foo/bar/baz", "/foo")}
-		
-		it "should be inspectable" do
-			paths = Paths.new(path)
-			
-			expect(paths.inspect).to be_include path.inspect
-		end
-		
-		it "should be possible to convert to paths" do
-			paths = Paths.new(path)
-			
-			expect(paths.to_paths).to be paths
-		end
-		
-		it "should be count number of paths" do
-			paths = Paths.new(path)
-			
-			expect(paths.count).to be == 1
-		end
-		
-		it "should coerce array to paths" do
-			paths = Paths.coerce([path])
-			
-			expect(paths).to be_kind_of Paths
-			expect(paths.count).to be == 1
-			expect(paths).to be_include path
-			
-			same_paths = Paths.coerce(paths)
-			expect(same_paths).to be paths
-		end
-		
-		it "can add two lists of paths together" do
-			paths_a = Paths.new(path)
-			paths_b = Paths.new(Path.join('/foo/bar', 'alice'))
-			
-			paths = paths_a + paths_b
-			
-			expect(paths.count).to be 2
-			expect(paths).to be_include path
-			expect(paths).to be_kind_of Composite
-			
-			# Composite equality
-			expect(paths).to be_eql paths
-			expect(paths).to_not be_eql paths_a
-		end
-		
-		it "maps paths with a new extension" do
-			paths = Paths.new([
-				Path.join('/foo/bar', 'alice'),
-				Path.join('/foo/bar', 'bob'),
-				Path.join('/foo/bar', 'charles'),
-				path
-			])
-			
-			expect(paths).to include(path)
-			
-			expect(paths).to be_intersects(paths)
-			expect(paths).to_not be_intersects(Paths::NONE)
-			
-			mapped_paths = paths.map {|path| path + ".o"}
-			
-			expect(mapped_paths).to be_kind_of(Paths)
-			expect(mapped_paths.roots).to be == paths.roots
-		end
-		
-		it "globs multiple files" do
-			glob = Glob.new(__dir__, '*.rb')
-			
-			expect(glob.count).to be > 1
-			
-			mapped_paths = glob.map {|path| path + ".txt"}
-			
-			expect(glob.roots).to be == mapped_paths.roots
-		end
-		
-		it "should intersect one file in the glob" do
-			# Glob all test files:
-			glob = Glob.new(__dir__, "*.rb")
-		
-			expect(glob.count).to be > 0
-		
-			# Should include this file:
-			expect(glob).to include(__FILE__)
-		
-			# Glob should intersect self:
-			expect(glob).to be_intersects(glob)
-		end
-		
-		it "should include composites" do
-			lib = File.join(__dir__, "../lib")
-		
-			test_glob = Glob.new(__dir__, "*.rb")
-			lib_glob = Glob.new(lib, "*.rb")
-		
-			both = test_glob + lib_glob
-		
-			# List#roots is the generic accessor for Lists
-			expect(both.roots).to include test_glob.root
-		
-			# The composite should include both:
-			expect(both).to include(__FILE__)
-		end
-		
-		it "should have path with correct root" do
-			test_glob = Glob.new(__dir__, "*.rb")
-			
-			expect(test_glob.first).to be_kind_of Path
-			
-			expect(test_glob.first.root).to be == __dir__
-		end
-		
-		it "maps paths with new extension" do
-			glob = Glob.new(__dir__, "*.rb")
-			
-			paths = glob.map {|path| path.append ".txt"}
-			
-			expect(paths.first).to be == (glob.first.append ".txt")
-			expect(paths.first.to_s).to be_end_with ".rb.txt"
-		end
-		
-		it "should map paths using with" do
-			glob = Glob.new(__dir__, "*.rb")
-			
-			paths = glob.with extension: ".txt"
-			path = paths.first
-			
-			expect(path).to be_kind_of Array
-			
-			expect(path[0]).to be == glob.first
-			expect(path[1]).to be == glob.first.append(".txt")
-		end
-		
-		it "should define an empty set of files" do
-			expect(Paths::NONE).to be_kind_of List
-			
-			expect(Paths::NONE.count).to be 0
-		end
-		
-		it "can be used as key in hash" do
-			cache = {}
-			
-			cache[Paths.new(path)] = true
-			
-			expect(cache).to be_include(Paths.new(path))
-		end
-		
-		it "can be constructed from a list of relative paths" do
-			paths = Paths.directory('/foo', ['bar', 'baz', 'bob'])
-			
-			expect(paths.count).to be 3
-			expect(paths).to be_include Path.new('/foo/bar')
-		end
-	end
-end

data/spec/build/files/monitor_spec.rb

@@ -1,90 +0,0 @@
-#!/usr/bin/env rspec
-
-# Copyright, 2015, 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/monitor'
-require 'build/files/path'
-require 'build/files/system'
-require 'build/files/directory'
-
-RSpec.shared_examples_for Monitor do |driver|
-	let(:root) {Build::Files::Path.expand('tmp', __dir__)}
-	let(:path) {root + "test.txt"}
-	
-	before do
-		root.delete
-		root.create
-	end
-	
-	let(:directory) {Build::Files::Directory.new(root)}
-	let(:monitor) {Build::Files::Monitor.new}
-	
-	it "should include touched path" do
-		path.touch
-		
-		expect(directory.to_a).to include(path)
-	end
-	
-	it 'should detect additions' do
-		changed = false
-		
-		monitor.track_changes(directory) do |state|
-			changed = true
-			
-			expect(state.added).to include(path)
-		end
-		
-		thread = Thread.new do
-			sleep 1
-			path.touch
-		end
-		
-		monitor.run do
-			throw :interrupt if changed
-		end
-		
-		thread.join
-		
-		expect(changed).to be true
-	end
-	
-	it "should add and remove monitored paths" do
-		handler = monitor.track_changes(directory) do |state|
-			# Do nothing.
-		end
-		
-		expect(monitor.roots).to be_include root
-		
-		handler.remove!
-		
-		expect(monitor.roots).to be_empty
-	end
-end
-
-RSpec.describe Build::Files::Monitor::Polling do
-	it_behaves_like Monitor
-end
-
-if defined? Build::Files::Monitor::Native
-	RSpec.describe Build::Files::Monitor::Native do
-		it_behaves_like Monitor
-	end
-end