Class: Utopia::Path

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

Overview

Represents a path as an array of path components. Useful for efficient URL manipulation.

Defined Under Namespace

Classes: Matcher

Constant Summary collapse

SEPARATOR = 
'/'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(components = []) ⇒ Path

Returns a new instance of Path.



30
31
32
 
# File 'lib/utopia/path.rb', line 30

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

Instance Attribute Details

#components ⇒ Object

Returns the value of attribute components.



34
35
36
 
# File 'lib/utopia/path.rb', line 34

def components
  @components
end

Class Method Details

.[](path) ⇒ Object 



82
83
84
 
# File 'lib/utopia/path.rb', line 82

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

.create(path) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/utopia/path.rb', line 112

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))
	when nil
		return nil
	else
		return self.new([path])
	end
end

.dump(instance) ⇒ Object 



108
109
110
 
# File 'lib/utopia/path.rb', line 108

def self.dump(instance)
	instance.to_s if instance
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.



100
101
102
 
# File 'lib/utopia/path.rb', line 100

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

.load(value) ⇒ Object 



104
105
106
 
# File 'lib/utopia/path.rb', line 104

def self.load(value)
	from_string(value) if value
end

.prefix_length(a, b) ⇒ Object

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



53
54
55
 
# File 'lib/utopia/path.rb', line 53

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

.root ⇒ Object 



48
49
50
 
# File 'lib/utopia/path.rb', line 48

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

.shortest_path(path, root) ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/utopia/path.rb', line 58

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 



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/utopia/path.rb', line 86

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.



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

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

Instance Method Details

#+(other) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/utopia/path.rb', line 189

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



212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/utopia/path.rb', line 212

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 



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

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

#==(other) ⇒ Object 



340
341
342
343
344
345
346
347
348
 
# File 'lib/utopia/path.rb', line 340

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 



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

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

#[]=(index, value) ⇒ Object

Replaces a named component, indexing as per



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

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

#absolute? ⇒ Boolean

Returns:

  • (Boolean) 


151
152
153
 
# File 'lib/utopia/path.rb', line 151

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

#ascend(&block) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/utopia/path.rb', line 300

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 ⇒ String

Returns the last path component without any file extension.

Returns:

  • (String) —

    the last path component without any file extension.



265
266
267
268
269
 
# File 'lib/utopia/path.rb', line 265

def basename
	basename, _ = @components.last.split('.', 2)
	
	return basename || ''
end

#delete_at(index) ⇒ Object 



367
368
369
 
# File 'lib/utopia/path.rb', line 367

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

#descend(&block) ⇒ Object 



288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/utopia/path.rb', line 288

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) 


135
136
137
 
# File 'lib/utopia/path.rb', line 135

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

#dirname(count = 1) ⇒ Object 



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

def dirname(count = 1)
	path = self.class.new(@components[0...-count])
	
	return absolute? ? path.to_absolute : path
end

#dup ⇒ Object 



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

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

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/utopia/path.rb', line 44

def empty?
	@components.empty?
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#expand(root) ⇒ Object 



185
186
187
 
# File 'lib/utopia/path.rb', line 185

def expand(root)
	root + self
end

#extension ⇒ String

Returns the last path component’s file extension.

Returns:

  • (String) —

    the last path component’s file extension.



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

def extension
	_, extension = @components.last.split('.', 2)
	
	return extension
end

#first ⇒ Object

Returns the first path component.



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

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

#freeze ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/utopia/path.rb', line 36

def freeze
	return self if frozen?
	
	@components.freeze
	
	super
end

#hash ⇒ Object 



336
337
338
 
# File 'lib/utopia/path.rb', line 336

def hash
	@components.hash
end

#include?(*arguments) ⇒ Boolean

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/utopia/path.rb', line 131

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

#join(other) ⇒ Object 



181
182
183
 
# File 'lib/utopia/path.rb', line 181

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

#last ⇒ Object

Returns the last path component.



250
251
252
253
254
 
# File 'lib/utopia/path.rb', line 250

def last
	if @components != ['']
		@components.last
	end
end

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



284
285
286
 
# File 'lib/utopia/path.rb', line 284

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

#pop ⇒ Object

Pops the last path component.



257
258
259
260
261
262
 
# File 'lib/utopia/path.rb', line 257

def pop
	# We don't want to convert an absolute path to a relative path.
	if @components != ['']
		@components.pop
	end
end

#relative? ⇒ Boolean

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/utopia/path.rb', line 147

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

#replace(other_path) ⇒ Object 



127
128
129
 
# File 'lib/utopia/path.rb', line 127

def replace(other_path)
	@components = other_path.components.dup
end

#shortest_path(root) ⇒ Object 



71
72
73
 
# File 'lib/utopia/path.rb', line 71

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

#simplify ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/utopia/path.rb', line 224

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 



312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/utopia/path.rb', line 312

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) 


350
351
352
353
354
355
356
 
# File 'lib/utopia/path.rb', line 350

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 



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

def to_a
	@components
end

#to_absolute ⇒ Object 



155
156
157
158
159
160
161
 
# File 'lib/utopia/path.rb', line 155

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

#to_directory ⇒ Object 



139
140
141
142
143
144
145
 
# File 'lib/utopia/path.rb', line 139

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

#to_relative! ⇒ Object 



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

def to_relative!
	@components.shift if relative?
end

#to_str ⇒ Object Also known as: to_s 



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

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

#with_prefix(*arguments) ⇒ Object 



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

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