Class: Utopia::Path

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/utopia/path.rb,
lib/utopia/path/matcher.rb

Defined Under Namespace

Classes: Matcher

Constant Summary collapse

SEPARATOR = 
'/'.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(components = []) ⇒ Path

Returns a new instance of Path.



73
74
75
 
# File 'lib/utopia/path.rb', line 73

def initialize(components = [])
	@components = components
end

Instance Attribute Details

#components ⇒ Object

Returns the value of attribute components.



77
78
79
 
# File 'lib/utopia/path.rb', line 77

def components
  @components
end

Class Method Details

.[](path) ⇒ Object 



123
124
125
 
# File 'lib/utopia/path.rb', line 123

def self.[] path
	self.create(path)
end

.create(path) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/utopia/path.rb', line 145

def self.create(path)
	case path
	when Path
		return path
	when Array
		return self.new(path)
	when String
		return self.new(unescape(path).split(SEPARATOR, -1))
	else
		return self.new([path])
	end
end

.from_string(string) ⇒ Object

This constructor takes a string and generates a relative path as efficiently as possible. This is a direct entry point for all controller invocations so it’s designed to suit the requirements of that function.



141
142
143
 
# File 'lib/utopia/path.rb', line 141

def self.from_string(string)
	self.new(unescape(string).split(SEPARATOR, -1))
end

.prefix_length(a, b) ⇒ Object

Returns the length of the prefix which is shared by two strings.



94
95
96
 
# File 'lib/utopia/path.rb', line 94

def self.prefix_length(a, b)
	[a.size, b.size].min.times{|i| return i if a[i] != b[i]}
end

.root ⇒ Object 



89
90
91
 
# File 'lib/utopia/path.rb', line 89

def self.root
	self.new([''])
end

.shortest_path(path, root) ⇒ Object

Return the shortest relative path to get to path from root:



99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/utopia/path.rb', line 99

def self.shortest_path(path, root)
	path = self.create(path)
	root = self.create(root).dirname
	
	# Find the common prefix:
	i = prefix_length(path.components, root.components) || 0
	
	# The difference between the root path and the required path, taking into account the common prefix:
	up = root.components.size - i
	
	return self.create([".."] * up + path.components[i..-1])
end

.split(path) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/utopia/path.rb', line 127

def self.split(path)
	case path
	when Path
		return path.to_a
	when Array
		return path
	when String
		create(path).to_a
	else
		[path]
	end
end

.unescape(string) ⇒ Object

Converts ‘+’ into whitespace and hex encoded characters into their equivalent characters.



117
118
119
120
121
 
# File 'lib/utopia/path.rb', line 117

def self.unescape(string)
	string.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) {
		[$1.delete('%')].pack('H*')
	}
end

Instance Method Details

#+(other) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/utopia/path.rb', line 218

def +(other)
	if other.kind_of? Path
		if other.absolute?
			return other
		else
			return join(other.components)
		end
	elsif other.kind_of? Array
		return join(other)
	elsif other.kind_of? String
		return join(other.split(SEPARATOR, -1))
	else
		return join([other.to_s])
	end
end

#-(other) ⇒ Object

Computes the difference of the path. /a/b/c - /a/b -> c a/b/c - a/b -> c



241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/utopia/path.rb', line 241

def -(other)
	i = 0
	
	while i < other.components.size
		break if @components[i] != other.components[i]
		
		i += 1
	end
	
	return self.class.new(@components[i,@components.size])
end

#<=>(other) ⇒ Object 



323
324
325
 
# File 'lib/utopia/path.rb', line 323

def <=> other
	@components <=> other.components
end

#==(other) ⇒ Object 



335
336
337
338
339
340
341
342
343
 
# File 'lib/utopia/path.rb', line 335

def == other
	return false unless other
	
	case other
	when String then self.to_s == other
	when Array then self.to_a == other
	else other.is_a?(self.class) && @components == other.components
	end
end

#[](index) ⇒ Object 



353
354
355
 
# File 'lib/utopia/path.rb', line 353

def [] index
	return @components[component_offset(index)]
end

#[]=(index, value) ⇒ Object

Replaces a named component, indexing as per



358
359
360
 
# File 'lib/utopia/path.rb', line 358

def []= index, value
	return @components[component_offset(index)] = value
end

#absolute? ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
 
# File 'lib/utopia/path.rb', line 178

def absolute?
	@components.first == ''
end

#ascend(&block) ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/utopia/path.rb', line 295

def ascend(&block)
	return to_enum(:ascend) unless block_given?
	
	components = self.components.dup
	
	while components.any?
		yield self.class.new(components.dup)
		
		components.pop
	end
end

#basename(*args) ⇒ Object 



269
270
271
 
# File 'lib/utopia/path.rb', line 269

def basename(*args)
	Basename.new(@components.last, *args)
end

#delete_at(index) ⇒ Object 



362
363
364
 
# File 'lib/utopia/path.rb', line 362

def delete_at(index)
	@components.delete_at(component_offset(index))
end

#descend(&block) ⇒ Object 



283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/utopia/path.rb', line 283

def descend(&block)
	return to_enum(:descend) unless block_given?
	
	components = []
	
	@components.each do |component|
		components << component
		
		yield self.class.new(components.dup)
	end
end

#directory? ⇒ Boolean

Returns:

  • (Boolean) 


162
163
164
 
# File 'lib/utopia/path.rb', line 162

def directory?
	return @components.last == ''
end

#dirname(count = 1) ⇒ Object 



273
274
275
276
277
 
# File 'lib/utopia/path.rb', line 273

def dirname(count = 1)
	path = self.class.new(@components[0...-count])

	return absolute? ? path.to_absolute : path
end

#dup ⇒ Object 



319
320
321
 
# File 'lib/utopia/path.rb', line 319

def dup
	return Path.new(components.dup)
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/utopia/path.rb', line 85

def empty?
	@components.empty?
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


327
328
329
 
# File 'lib/utopia/path.rb', line 327

def eql? other
	self.class.eql?(other.class) and @components.eql?(other.components)
end

#expand(root) ⇒ Object 



214
215
216
 
# File 'lib/utopia/path.rb', line 214

def expand(root)
	root + self
end

#extension ⇒ Object 



382
383
384
 
# File 'lib/utopia/path.rb', line 382

def extension
	basename(true).extension
end

#first ⇒ Object 



366
367
368
369
370
371
372
 
# File 'lib/utopia/path.rb', line 366

def first
	if absolute?
		@components[1]
	else
		@components[0]
	end
end

#freeze ⇒ Object 



79
80
81
82
83
 
# File 'lib/utopia/path.rb', line 79

def freeze
	@components.freeze
	
	super
end

#hash ⇒ Object 



331
332
333
 
# File 'lib/utopia/path.rb', line 331

def hash
	@components.hash
end

#include?(*args) ⇒ Boolean

Returns:

  • (Boolean) 


158
159
160
 
# File 'lib/utopia/path.rb', line 158

def include?(*args)
	@components.include?(*args)
end

#join(other) ⇒ Object 



210
211
212
 
# File 'lib/utopia/path.rb', line 210

def join(other)
	self.class.new(@components + other).simplify
end

#last ⇒ Object 



374
375
376
377
378
379
380
 
# File 'lib/utopia/path.rb', line 374

def last
	if directory?
		@components[-2]
	else
		@components[-1]
	end
end

#relative? ⇒ Boolean

Returns:

  • (Boolean) 


174
175
176
 
# File 'lib/utopia/path.rb', line 174

def relative?
	@components.first != ''
end

#shortest_path(root) ⇒ Object 



112
113
114
 
# File 'lib/utopia/path.rb', line 112

def shortest_path(root)
	self.class.shortest_path(self, root)
end

#simplify ⇒ Object 



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/utopia/path.rb', line 253

def simplify
	result = absolute? ? [''] : []

	@components.each do |bit|
		if bit == ".."
			result.pop
		elsif bit != "." && bit != ''
			result << bit
		end
	end

	result << '' if directory?
	
	return self.class.new(result)
end

#split(at) ⇒ Object 



307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/utopia/path.rb', line 307

def split(at)
	if at.kind_of? String
		at = @components.index(at)
	end
	
	if at
		return [self.class.new(@components[0...at]), self.class.new(@components[at+1..-1])]
	else
		return nil
	end
end

#start_with?(other) ⇒ Boolean

Returns:

  • (Boolean) 


345
346
347
348
349
350
351
 
# File 'lib/utopia/path.rb', line 345

def start_with? other
	other.components.each_with_index do |part, index|
		return false if @components[index] != part
	end
	
	return true
end

#to_a ⇒ Object 



206
207
208
 
# File 'lib/utopia/path.rb', line 206

def to_a
	@components
end

#to_absolute ⇒ Object 



182
183
184
185
186
187
188
 
# File 'lib/utopia/path.rb', line 182

def to_absolute
	if absolute?
		return self
	else
		return self.class.new([''] + @components)
	end
end

#to_directory ⇒ Object 



166
167
168
169
170
171
172
 
# File 'lib/utopia/path.rb', line 166

def to_directory
	if directory?
		return self
	else
		return join([''])
	end
end

#to_local_path(separator = File::SEPARATOR) ⇒ Object 



279
280
281
 
# File 'lib/utopia/path.rb', line 279

def to_local_path(separator = File::SEPARATOR)
	@components.join(separator)
end

#to_relative! ⇒ Object 



190
191
192
 
# File 'lib/utopia/path.rb', line 190

def to_relative!
	@components.shift if relative?
end

#to_s ⇒ Object 



202
203
204
 
# File 'lib/utopia/path.rb', line 202

def to_s
	to_str
end

#to_str ⇒ Object 



194
195
196
197
198
199
200
 
# File 'lib/utopia/path.rb', line 194

def to_str
	if @components == ['']
		SEPARATOR
	else
		@components.join(SEPARATOR)
	end
end

#with_prefix(*args) ⇒ Object 



234
235
236
 
# File 'lib/utopia/path.rb', line 234

def with_prefix(*args)
	self.class.create(*args) + self
end