build-files 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3809d8bed57d7862f74c35cda9b396784537f26e
-  data.tar.gz: 1a0551a1f94d10ef77f3daf7ef23c71ed7640a74
+  metadata.gz: 219675f752dc63697b9075f9b14c5e528ad8571e
+  data.tar.gz: 632cd210ac7a90160607bb02ab03d70d33583a74
 SHA512:
-  metadata.gz: d2cf244dd15dddc8d0f9649efb3cbf82ff6b1b10687d593d3dbe6656c549c802934139906895c6f508f36cd29095157984c0eb70837fa8a58218866ce7fb756c
-  data.tar.gz: ade83990959c59d889dc1e77489b115536e262499036d36be0db7dd3479f7260df3e8a3d6f9029086e4319612a738a9f2d0d871b5d226e54716158fab4729565
+  metadata.gz: 88cfce577e99a4c3bba47890ce126675649e8880b8bc447d706a7c06bb45c663b3f5951824b2865cbe7f45d0040e29bd7b28a48a3925f08aeb582a05aa5ff5c1
+  data.tar.gz: 92471caf1ea8d0cd24713cacd34a92f04d5c02a37327489447cdc7b2fb5f7c267092e3fd9c565ea1dc88525c65fc73e7405ff9e1b2a44bb008c762a17c85f4ab

data/lib/build/files/monitor.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require 'set'
+require 'logger'
 
 require 'build/files/state'
 
@@ -51,23 +52,29 @@ module Build
 		end
 		
 		class Monitor
-			def initialize
+			def initialize(logger: nil)
 				@directories = Hash.new { |hash, key| hash[key] = Set.new }
 				
 				@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|
-						# directory = File.realpath(directory)
+						@logger.debug{"Directory: #{directory}"}
 						
 						@directories[directory].each do |handle|
+							@logger.debug{"Handle changed: #{handle.inspect}"}
+							
 							handle.changed!(*args)
 						end
 					end
@@ -80,6 +87,7 @@ module Build
 			
 			def delete(handle)
 				if @deletions
+					@logger.debug{"Delayed delete handle: #{handle}"}
 					@deletions << handle
 				else
 					purge(handle)
@@ -93,6 +101,8 @@ module Build
 			end
 			
 			def add(handle)
+				@logger.debug{"Adding handle: #{handle}"}
+				
 				handle.directories.each do |directory|
 					@directories[directory] << handle
 					
@@ -113,7 +123,7 @@ module Build
 					else; :polling
 				end
 				
-				if driver = options.fetch(:driver, default_driver)
+				if driver = (options[:driver] || default_driver)
 					method_name = "run_with_#{driver}"
 					Files.send(method_name, self, options, &block)
 				end
@@ -134,6 +144,8 @@ module Build
 			end
 			
 			def purge(handle)
+				@logger.debug{"Purge handle: #{handle}"}
+				
 				handle.directories.each do |directory|
 					@directories[directory].delete(handle)
 					

data/lib/build/files/path.rb

@@ -88,15 +88,6 @@ module Build
 				self.components.last
 			end
 			
-			# Ensure the path has an absolute root if it doesn't already:
-			def to_absolute(root)
-				if @root == "."
-					self.rebase(root)
-				else
-					self
-				end
-			end
-			
 			attr :root
 			attr :full_path
 			

data/lib/build/files/version.rb

@@ -20,6 +20,6 @@
 
 module Build
 	module Files
-		VERSION = "0.3.3"
+		VERSION = "0.3.4"
 	end
 end

data/spec/build/files/filesystem_spec.rb

@@ -0,0 +1,56 @@
+# 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/path'
+require 'build/files/path/filesystem'
+
+require 'pathname'
+
+module Build::Files::FilesystemSpec
+	include Build::Files
+	
+	describe Build::Files::Path do
+		let(:root) {Path.new(__dir__)}
+		let(:path) {root + "filesystem_spec"}
+		
+		after(:each) do
+			path.delete
+		end
+		
+		it "should open file for writing" do
+			path.write("Hello World")
+			
+			expect(File).to be_exist(path)
+			expect(path.read).to be == "Hello World"
+			
+			expect(path).to be_exist
+			expect(path.directory?).to be == false
+			
+			expect(path.modified_time.to_f).to be_within(5.0).of(Time.now.to_f)
+		end
+		
+		it "should make a directory" do
+			path.create
+			
+			expect(path.directory?).to be == true
+		end
+	end
+end

data/spec/build/files/list_spec.rb

@@ -28,6 +28,50 @@ module Build::Files::ListSpec
 	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'),

data/spec/build/files/monitor_spec.rb

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

data/spec/build/files/path_spec.rb

@@ -29,6 +29,11 @@ module Build::Files::PathSpec
 	describe Build::Files::Path do
 		let(:path) {Path.new("/foo/bar/baz", "/foo")}
 		
+		it "should be inspectable" do
+			expect(path.inspect).to be_include path.root.to_s
+			expect(path.inspect).to be_include path.relative_path.to_s
+		end
+		
 		it "should convert to path" do
 			pathname = Pathname("/foo/bar/baz")
 			
@@ -123,11 +128,32 @@ module Build::Files::PathSpec
 			expect(path + "d/e/f").to be == "/a/b/c/d/e/f"
 		end
 		
+		it "should give a list of components" do
+			expect(Path.components(path)).to be == ["", "foo", "bar", "baz"]
+			expect(Path.components(path.to_s)).to be == ["", "foo", "bar", "baz"]
+		end
+		
+		it "should give a basename" do
+			expect(path.basename).to be == "baz"
+		end
+		
 		it "should have a new root" do
 			rerooted_path = path / "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(path.for_reading).to be == [path.to_s, File::RDONLY]
+		end
+		
+		it "should give correct modes for writing" do
+			expect(path.for_writing).to be == [path.to_s, File::CREAT|File::TRUNC|File::WRONLY]
+		end
+		
+		it "should give correct modes for appending" do
+			expect(path.for_appending).to be == [path.to_s, File::CREAT|File::APPEND|File::WRONLY]
+		end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: build-files
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ files:
 - lib/build/files/state.rb
 - lib/build/files/version.rb
 - spec/build/files/directory_spec.rb
+- spec/build/files/filesystem_spec.rb
 - spec/build/files/glob_spec.rb
 - spec/build/files/list_spec.rb
 - spec/build/files/monitor_spec.rb
@@ -107,6 +108,7 @@ summary: Build::Files is a set of idiomatic classes for dealing with paths and m
   directories.
 test_files:
 - spec/build/files/directory_spec.rb
+- spec/build/files/filesystem_spec.rb
 - spec/build/files/glob_spec.rb
 - spec/build/files/list_spec.rb
 - spec/build/files/monitor_spec.rb