build-files 0.3.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 219675f752dc63697b9075f9b14c5e528ad8571e
-  data.tar.gz: 632cd210ac7a90160607bb02ab03d70d33583a74
+  metadata.gz: 175cf300ef1bb7f8873e0932c313a2d43ec1fdaf
+  data.tar.gz: 12f0e5f2dac80a6f59c7e1945fe6a04467604e39
 SHA512:
-  metadata.gz: 88cfce577e99a4c3bba47890ce126675649e8880b8bc447d706a7c06bb45c663b3f5951824b2865cbe7f45d0040e29bd7b28a48a3925f08aeb582a05aa5ff5c1
-  data.tar.gz: 92471caf1ea8d0cd24713cacd34a92f04d5c02a37327489447cdc7b2fb5f7c267092e3fd9c565ea1dc88525c65fc73e7405ff9e1b2a44bb008c762a17c85f4ab
+  metadata.gz: 19cbf2b9570233c4cd423f53e9c59e4053c6e3cf020157bcf1c2cae28389996872351cb374b9001ede12070de73b0a625d06ce5a0f56e8e8306e1c0576429b80
+  data.tar.gz: bac413fc3b5e4503d6ea4d85c8b2632134d8e603c0fdb84d5411f8b12412d84a3f2de673cca28b56c7427ca94723d1f93fbf097dc8a3b4df3d84965262294d25

data/lib/build/files/directory.rb

@@ -46,11 +46,11 @@ module Build
 					yield Path.new(path, @root)
 				end
 			end
-		
+			
 			def eql?(other)
 				self.class.eql?(other.class) and @root.eql?(other.root)
 			end
-		
+			
 			def hash
 				@root.hash
 			end

data/lib/build/files/list.rb

@@ -35,6 +35,17 @@ module Build
 				Composite.new([self, list])
 			end
 			
+			# This isn't very efficient, but it IS generic.
+			def ==(other)
+				if self.class == other.class
+					self.eql?(other)
+				elsif other.kind_of? self.class
+					self.to_a.sort == other.to_a.sort
+				else
+					super
+				end
+			end
+			
 			# Does this list of files include the path of any other?
 			def intersects? other
 				other.any?{|path| include?(path)}
@@ -77,54 +88,6 @@ module Build
 			end
 		end
 		
-		class Paths < List
-			def initialize(list, roots = nil)
-				@list = Array(list).freeze
-				@roots = roots
-			end
-			
-			attr :list
-			
-			# The list of roots for a given list of immutable files is also immutable, so we cache it for performance:
-			def roots
-				@roots ||= super
-			end
-			
-			def count
-				@list.count
-			end
-			
-			def each
-				return to_enum(:each) unless block_given?
-				
-				@list.each{|path| yield path}
-			end
-			
-			def eql?(other)
-				self.class.eql?(other.class) and @list.eql?(other.list)
-			end
-		
-			def hash
-				@list.hash
-			end
-			
-			def to_paths
-				self
-			end
-			
-			def inspect
-				"<Paths #{@list.inspect}>"
-			end
-			
-			def self.directory(root, relative_paths)
-				paths = relative_paths.collect do |path|
-					Path.join(root, path)
-				end
-				
-				self.new(paths, [root])
-			end
-		end
-		
 		class Composite < List
 			def initialize(files, roots = nil)
 				@files = []

data/lib/build/files/paths.rb

@@ -0,0 +1,73 @@
+# 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'
+
+module Build
+	module Files
+		class Paths < List
+			def initialize(list, roots = nil)
+				@list = Array(list).freeze
+				@roots = roots
+			end
+			
+			attr :list
+			
+			# The list of roots for a given list of immutable files is also immutable, so we cache it for performance:
+			def roots
+				@roots ||= super
+			end
+			
+			def count
+				@list.count
+			end
+			
+			def each
+				return to_enum(:each) unless block_given?
+				
+				@list.each{|path| yield path}
+			end
+			
+			def eql?(other)
+				self.class.eql?(other.class) and @list.eql?(other.list)
+			end
+		
+			def hash
+				@list.hash
+			end
+			
+			def to_paths
+				self
+			end
+			
+			def inspect
+				"<Paths #{@list.inspect}>"
+			end
+			
+			def self.directory(root, relative_paths)
+				paths = relative_paths.collect do |path|
+					Path.join(root, path)
+				end
+				
+				self.new(paths, [root])
+			end
+		end
+	end
+end

data/lib/build/files/{path/filesystem.rb → system.rb}

@@ -20,54 +20,82 @@
 
 require 'fileutils'
 
+require_relative 'path'
+require_relative 'list'
+
 module Build
 	module Files
 		class Path
+			# Open a file with the specified mode.
 			def open(mode, &block)
 				File.open(self, mode, &block)
 			end
 			
+			# Read the entire contents of the file.
 			def read(mode = File::RDONLY)
 				open(mode) do |file|
 					file.read
 				end
 			end
 			
+			# Write a buffer to the file, creating it if it doesn't exist. 
 			def write(buffer, mode = File::CREAT|File::TRUNC|File::WRONLY)
 				open(mode) do |file|
 					file.write(buffer)
 				end
 			end
 			
+			# Touch the file, changing it's last modified time.
 			def touch
 				FileUtils.touch self
 			end
 			
+			# Checks if the file exists in the local file system.
 			def exist?
 				File.exist? self
 			end
 			
+			# Checks if the path refers to a directory.
 			def directory?
 				File.directory? self
 			end
 			
+			# The time the file was last modified.
 			def modified_time
 				File.mtime self
 			end
 			
-			alias mtime modified_time
-			
+			# Recursively create a directory hierarchy for the given path.
 			def create
 				FileUtils.mkpath self
 			end
 			
-			alias mkpath create
-			
+			# Recursively delete the given path and all contents.
 			def delete
 				FileUtils.rm_rf self
 			end
+		end
+		
+		class List
+			# Touch all listed files.
+			def touch
+				each(&:touch)
+			end
+			
+			# Check that all files listed exist.
+			def exist?
+				all?(&:exist?)
+			end
 			
-			alias rmpath delete
+			# Recursively create paths for all listed paths.
+			def create
+				each(&:create)
+			end
+			
+			# Recursively delete all paths and all contents within those paths.
+			def delete
+				each(&:delete)
+			end
 		end
 	end
 end

data/lib/build/files/version.rb

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

data/lib/build/files.rb

@@ -19,10 +19,11 @@
 # THE SOFTWARE.
 
 require_relative 'files/list'
+require_relative 'files/paths'
 require_relative 'files/glob'
 require_relative 'files/directory'
 
 require_relative 'files/state'
 require_relative 'files/monitor'
 
-require_relative 'files/path/filesystem'
+require_relative 'files/system'

data/spec/build/files/directory_spec.rb

@@ -24,16 +24,47 @@ module Build::Files::DirectorySpec
 	include Build::Files
 	
 	describe Build::Files::Directory do
-		let(:path) {Path.new("/foo/bar/baz", "/bob")}
+		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
 	end
 end

data/spec/build/files/glob_spec.rb

@@ -31,5 +31,13 @@ module Build::Files::GlobSpec
 			
 			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
 	end
 end

data/spec/build/files/list_spec.rb

@@ -166,7 +166,14 @@ module Build::Files::ListSpec
 			
 			cache[Paths.new(path)] = true
 			
-			expect(cache).to include(Paths.new(path))
+			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

@@ -22,7 +22,7 @@
 
 require 'build/files/monitor'
 require 'build/files/path'
-require 'build/files/path/filesystem'
+require 'build/files/system'
 require 'build/files/directory'
 
 module Build::Files::MonitorSpec

data/spec/build/files/state_spec.rb

@@ -56,13 +56,35 @@ module Build::Files::StateSpec
 			expect(state.removed).to be == []
 			expect(state.missing).to be == []
 		end
+	end
+	
+	describe Build::Files::State do
+		before(:each) do
+			@temporary_files = Build::Files::Paths.directory(__dir__, ['a'])
+			@temporary_files.touch
+			
+			@new_files = Build::Files::State.new(@temporary_files)
+			@old_files = Build::Files::State.new(Build::Files::Glob.new(__dir__, "*.rb"))
+		end
+		
+		after(:each) do
+			@temporary_files.delete
+		end
+		
+		let(:empty) {Build::Files::State.new(Build::Files::Paths::NONE)}
 		
 		it "should be clean with empty inputs or outputs" do
-			empty = Build::Files::State.new(Build::Files::Paths::NONE)
-			something = Build::Files::State.new(files)
-			
-			expect(Build::Files::State.dirty?(empty, something)).to be false
-			expect(Build::Files::State.dirty?(something, empty)).to be false
+			expect(Build::Files::State.dirty?(empty, @new_files)).to be false
+			expect(Build::Files::State.dirty?(@new_files, empty)).to be false
+		end
+		
+		it "should be clean if files are newer" do
+			expect(Build::Files::State.dirty?(@old_files, @new_files)).to be false
+		end
+		
+		it "should be dirty if files are modified" do
+			# In this case, the file mtime is usually different so... 
+			expect(Build::Files::State.dirty?(@new_files, @old_files)).to be true
 		end
 	end
 end

data/spec/build/files/{filesystem_spec.rb → system_spec.rb}

@@ -20,7 +20,7 @@
 
 require 'build/files'
 require 'build/files/path'
-require 'build/files/path/filesystem'
+require 'build/files/system'
 
 require 'pathname'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: build-files
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,16 +71,17 @@ files:
 - lib/build/files/list.rb
 - lib/build/files/monitor.rb
 - lib/build/files/path.rb
-- lib/build/files/path/filesystem.rb
+- lib/build/files/paths.rb
 - lib/build/files/state.rb
+- lib/build/files/system.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
 - spec/build/files/path_spec.rb
 - spec/build/files/state_spec.rb
+- spec/build/files/system_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -108,9 +109,9 @@ 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
 - spec/build/files/path_spec.rb
 - spec/build/files/state_spec.rb
+- spec/build/files/system_spec.rb