build-files 1.3.0 → 1.4.0

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/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/path.rb

@@ -123,13 +123,24 @@ module Build
 				self.class.new(@full_path + extension, @root)
 			end
 			
+			# Add a path component to the current path.
+			# @param path [String, nil] (Optionally) the path to append.
 			def +(path)
-				self.class.new(File.join(@full_path, path), @root)
+				if path
+					self.class.new(File.join(@full_path, path), @root)
+				else
+					self
+				end
 			end
 			
-			# Define a new root with a sub-path:
+			# Use the current path to define a new root, with an optional sub-path.
+			# @param path [String, nil] (Optionally) the path to append.
 			def /(path)
-				self.class.new(File.join(self, path), self)
+				if path
+					self.class.new(File.join(self, path), self)
+				else
+					self.class.new(self, self)
+				end
 			end
 			
 			def rebase(root)

data/lib/build/files/version.rb

@@ -20,6 +20,6 @@
 
 module Build
 	module Files
-		VERSION = "1.3.0"
+		VERSION = "1.4.0"
 	end
 end

data/spec/build/files/monitor_spec.rb

@@ -25,76 +25,66 @@ require 'build/files/path'
 require 'build/files/system'
 require 'build/files/directory'
 
-module Build::Files::MonitorSpec
-	include Build::Files
+RSpec.shared_examples_for Monitor do |driver|
+	let(:root) {Build::Files::Path.expand('tmp', __dir__)}
+	let(:path) {root + "test.txt"}
 	
-	ROOT = File.expand_path('../tmp', __FILE__)
+	before do
+		root.delete
+		root.create
+	end
 	
-	describe Build::Files::Monitor do
-		shared_examples_for Monitor do |driver|
-			let(:path) {Path.new(ROOT) + "test.txt"}
-			
-			before(:all) do
-				Path.new(ROOT).create
-			end
-			
-			after(:all) do
-				Path.new(ROOT).delete
-			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
 			
-			it 'should detect additions' do
-				directory = Build::Files::Directory.new(ROOT)
-				monitor = Build::Files::Monitor.new
-				
-				changed = false
-				
-				monitor.track_changes(directory) do |state|
-					changed = state.added.include? path
-				end
-				
-				touched = false
-				triggered = 0
-				
-				thread = Thread.new do
-					while triggered == 0 or touched == false
-						sleep 0.1 if touched
-						
-						path.touch
-						touched = true
-					end
-				end
-				
-				monitor.run(driver: driver) do
-					triggered += 1
-					
-					throw :interrupt if touched
-				end
-				
-				thread.join
-				
-				expect(changed).to be true
-				expect(triggered).to be >= 1
-			end
+			expect(state.added).to include(path)
 		end
 		
-		# Use the cross-platform driver, :polling
-		it_behaves_like Monitor, :polling
+		thread = Thread.new do
+			sleep 1
+			path.touch
+		end
 		
-		# Use the native platform driver, e.g. fsevent or inotify.
-		it_behaves_like Monitor
+		monitor.run do
+			throw :interrupt if changed
+		end
 		
-		it "should add and remove monitored paths" do
-			directory = Build::Files::Directory.new(ROOT)
-			monitor = Build::Files::Monitor.new
-			
-			handler = monitor.track_changes(directory) do |state|
-			end
-			
-			expect(monitor.roots).to be_include ROOT
-			
-			handler.remove!
-			
-			expect(monitor.roots).to be_empty
+		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

data/spec/build/files/path_spec.rb

@@ -23,173 +23,177 @@ require 'build/files/path'
 
 require 'pathname'
 
-module Build::Files::PathSpec
-	include Build::Files
-	
-	describe Build::Files::Path do
-		it "should expand the path" do
-			expect(Build::Files::Path.expand("foo", "/bar")).to be == "/bar/foo"
-		end
-	end
-	
-	describe Build::Files::Path.new("/test") do
-		it "should start_with? full path" do
-			expect(subject).to be_start_with '/test'
-		end
-		
-		it "should start_with? partial pattern" do
-			expect(subject).to be_start_with '/te'
-		end
-	end
-	
-	describe Build::Files::Path.new("/foo/bar.txt") do
-		it "should replace existing file extension" do
-			expect(subject.with(extension: '.jpeg', basename: true)).to be == "/foo/bar.jpeg"
-		end
-		
-		it "should append file extension" do
-			expect(subject.with(extension: '.jpeg')).to be == "/foo/bar.txt.jpeg"
-		end
-		
-		it "should change basename" do
-			expect(subject.with(basename: 'baz', extension: '.txt')).to be == "/foo/baz.txt"
-		end
-	end
-	
-	describe Build::Files::Path.new("/foo/bar/baz", "/foo") do
-		it "should be inspectable" do
-			expect(subject.inspect).to be_include subject.root.to_s
-			expect(subject.inspect).to be_include subject.relative_path.to_s
-		end
-		
-		it "should convert to path" do
-			pathname = Pathname("/foo/bar/baz")
-			
-			expect(Path[pathname]).to be == subject
-			expect(Path["/foo/bar/baz"]).to be == subject
-		end
-		
-		it "should be equal" do
-			expect(subject).to be_eql subject
-			expect(subject).to be == subject
-			
-			different_root_path = Path.join("/foo/bar", "baz")
-			expect(subject).to_not be_eql different_root_path
-			expect(subject).to be == different_root_path
-		end
-		
-		it "should convert to string" do
-			expect(subject.to_s).to be == "/foo/bar/baz"
-			
-			# The to_str method should return the full path (i.e. the same as to_s):
-			expect(subject.to_s).to be == subject.to_str
-			
-			# Check the equality operator:
-			expect(subject).to be == subject.dup
-			
-			# The length should be reported correctly:
-			expect(subject.length).to be == subject.to_s.length
-			
-			# Check the return types:
-			expect(subject).to be_kind_of Path
-			expect(subject.root).to be_kind_of String
-			expect(subject.relative_path).to be_kind_of String
-		end
-		
-		it "should consist of parts" do
-			expect(subject.parts).to be == ["", "foo", "bar", "baz"]
-			
-			expect(subject.root).to be == "/foo"
-			
-			expect(subject.relative_path).to be == "bar/baz"
-			
-			expect(subject.relative_parts).to be == ["bar", "baz"]
-		end
-		
-		it "should have a new extension" do
-			renamed_path = subject.with(root: '/tmp', extension: '.txt')
-			
-			expect(renamed_path.root).to be == '/tmp'
-			
-			expect(renamed_path.relative_path).to be == 'bar/baz.txt'
-			
-			object_path = subject.append(".o")
-		
-			expect(object_path.root).to be == "/foo"
-			expect(object_path.relative_path).to be == "bar/baz.o"
-		end
-		
-		it "should give the shortest path for outer paths" do
-			input = Path.new("/a/b/c/file.cpp")
-			output = Path.new("/a/b/c/d/e/")
-			
-			expect(input.root).to be == "/a/b/c"
-			expect(output.root).to be == "/a/b/c/d/e"
-			
-			short = input.shortest_path(output)
-			
-			expect(short).to be == "../../file.cpp"
-			
-			expect(File.expand_path(short, output)).to be == input
-		end
-		
-		it "should give the shortest path for inner paths" do
-			input = Path.new("/a/b/c/file.cpp")
-			output = Path.new("/a/")
-			
-			expect(input.root).to be == "/a/b/c"
-			expect(output.root).to be == "/a"
-			
-			short = input.shortest_path(output)
-			
-			expect(short).to be == "b/c/file.cpp"
-			
-			expect(File.expand_path(short, output)).to be == input
-		end
-		
-		it "should append a path" do
-			subject = Path.new("/a/b/c")
-			
-			expect(subject + "d/e/f").to be == "/a/b/c/d/e/f"
-		end
-		
-		it "should give a list of components" do
-			expect(Path.components(subject)).to be == ["", "foo", "bar", "baz"]
-			expect(Path.components(subject.to_s)).to be == ["", "foo", "bar", "baz"]
-		end
-		
-		it "should give a basename" do
-			expect(subject.basename).to be == "baz"
-		end
-		
-		it "should have a new root" do
-			rerooted_path = subject / "cat"
-			
-			expect(rerooted_path.root).to be == "/foo/bar/baz"
-			expect(rerooted_path.relative_path).to be == "cat"
-		end
-		
-		it "should give correct modes for reading" do
-			expect(subject.for_reading).to be == [subject.to_s, File::RDONLY]
-		end
-		
-		it "should give correct modes for writing" do
-			expect(subject.for_writing).to be == [subject.to_s, File::CREAT|File::TRUNC|File::WRONLY]
-		end
-		
-		it "should give correct modes for appending" do
-			expect(subject.for_appending).to be == [subject.to_s, File::CREAT|File::APPEND|File::WRONLY]
-		end
-		
-		it "should match against relative path" do
-			expect(subject.match(subject.relative_path)).to be_truthy
-			expect(subject.match("*/baz")).to be_truthy
-			expect(subject.match("/baz")).to be_falsey
-		end
-		
-		it "should match against absolute path" do
-			expect(subject.match(subject.to_s)).to be_truthy
-			expect(subject.match("/foo/**")).to be_truthy
-		end
+RSpec.describe Build::Files::Path do
+	it "should expand the path" do
+		expect(Build::Files::Path.expand("foo", "/bar")).to be == "/bar/foo"
+	end
+	
+	it "should give the shortest path for outer paths" do
+		input = Build::Files::Path.new("/a/b/c/file.cpp")
+		output = Build::Files::Path.new("/a/b/c/d/e/")
+		
+		expect(input.root).to be == "/a/b/c"
+		expect(output.root).to be == "/a/b/c/d/e"
+		
+		short = input.shortest_path(output)
+		
+		expect(short).to be == "../../file.cpp"
+		
+		expect(File.expand_path(short, output)).to be == input
+	end
+	
+	it "should give the shortest path for inner paths" do
+		input = Build::Files::Path.new("/a/b/c/file.cpp")
+		output = Build::Files::Path.new("/a/")
+		
+		expect(input.root).to be == "/a/b/c"
+		expect(output.root).to be == "/a"
+		
+		short = input.shortest_path(output)
+		
+		expect(short).to be == "b/c/file.cpp"
+		
+		expect(File.expand_path(short, output)).to be == input
+	end
+end
+
+RSpec.describe Build::Files::Path.new("/test") do
+	it "should start_with? full path" do
+		expect(subject).to be_start_with '/test'
+	end
+	
+	it "should start_with? partial pattern" do
+		expect(subject).to be_start_with '/te'
+	end
+end
+
+RSpec.describe Build::Files::Path.new("/foo/bar.txt") do
+	it "should replace existing file extension" do
+		expect(subject.with(extension: '.jpeg', basename: true)).to be == "/foo/bar.jpeg"
+	end
+	
+	it "should append file extension" do
+		expect(subject.with(extension: '.jpeg')).to be == "/foo/bar.txt.jpeg"
+	end
+	
+	it "should change basename" do
+		expect(subject.with(basename: 'baz', extension: '.txt')).to be == "/foo/baz.txt"
+	end
+end
+
+RSpec.describe Build::Files::Path.new("/foo/bar/baz", "/foo") do
+	it "can add nil path" do
+		expect(subject + nil).to be == subject
+	end
+	
+	it "can add nil root" do
+		expect(subject / nil).to be == subject
+	end
+	
+	it "should be inspectable" do
+		expect(subject.inspect).to be_include subject.root.to_s
+		expect(subject.inspect).to be_include subject.relative_path.to_s
+	end
+	
+	it "should convert to path" do
+		pathname = Pathname("/foo/bar/baz")
+		
+		expect(Build::Files::Path[pathname]).to be == subject
+		expect(Build::Files::Path["/foo/bar/baz"]).to be == subject
+	end
+	
+	it "should be equal" do
+		expect(subject).to be_eql subject
+		expect(subject).to be == subject
+		
+		different_root_path = Build::Files::Path.join("/foo/bar", "baz")
+		expect(subject).to_not be_eql different_root_path
+		expect(subject).to be == different_root_path
+	end
+	
+	it "should convert to string" do
+		expect(subject.to_s).to be == "/foo/bar/baz"
+		
+		# The to_str method should return the full path (i.e. the same as to_s):
+		expect(subject.to_s).to be == subject.to_str
+		
+		# Check the equality operator:
+		expect(subject).to be == subject.dup
+		
+		# The length should be reported correctly:
+		expect(subject.length).to be == subject.to_s.length
+		
+		# Check the return types:
+		expect(subject).to be_kind_of Build::Files::Path
+		expect(subject.root).to be_kind_of String
+		expect(subject.relative_path).to be_kind_of String
+	end
+	
+	it "should consist of parts" do
+		expect(subject.parts).to be == ["", "foo", "bar", "baz"]
+		
+		expect(subject.root).to be == "/foo"
+		
+		expect(subject.relative_path).to be == "bar/baz"
+		
+		expect(subject.relative_parts).to be == ["bar", "baz"]
+	end
+	
+	it "should have a new extension" do
+		renamed_path = subject.with(root: '/tmp', extension: '.txt')
+		
+		expect(renamed_path.root).to be == '/tmp'
+		
+		expect(renamed_path.relative_path).to be == 'bar/baz.txt'
+		
+		object_path = subject.append(".o")
+	
+		expect(object_path.root).to be == "/foo"
+		expect(object_path.relative_path).to be == "bar/baz.o"
+	end
+	
+	it "should append a path" do
+		subject = Build::Files::Path.new("/a/b/c")
+		
+		expect(subject + "d/e/f").to be == "/a/b/c/d/e/f"
+	end
+	
+	it "should give a list of components" do
+		expect(Build::Files::Path.components(subject)).to be == ["", "foo", "bar", "baz"]
+		expect(Build::Files::Path.components(subject.to_s)).to be == ["", "foo", "bar", "baz"]
+	end
+	
+	it "should give a basename" do
+		expect(subject.basename).to be == "baz"
+	end
+	
+	it "should have a new root" do
+		rerooted_path = subject / "cat"
+		
+		expect(rerooted_path.root).to be == "/foo/bar/baz"
+		expect(rerooted_path.relative_path).to be == "cat"
+	end
+	
+	it "should give correct modes for reading" do
+		expect(subject.for_reading).to be == [subject.to_s, File::RDONLY]
+	end
+	
+	it "should give correct modes for writing" do
+		expect(subject.for_writing).to be == [subject.to_s, File::CREAT|File::TRUNC|File::WRONLY]
+	end
+	
+	it "should give correct modes for appending" do
+		expect(subject.for_appending).to be == [subject.to_s, File::CREAT|File::APPEND|File::WRONLY]
+	end
+	
+	it "should match against relative path" do
+		expect(subject.match(subject.relative_path)).to be_truthy
+		expect(subject.match("*/baz")).to be_truthy
+		expect(subject.match("/baz")).to be_falsey
+	end
+	
+	it "should match against absolute path" do
+		expect(subject.match(subject.to_s)).to be_truthy
+		expect(subject.match("/foo/**")).to be_truthy
 	end
 end