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 = 
'/'.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(components = []) ⇒ Path

Returns a new instance of Path.



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

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

Instance Attribute Details

#components ⇒ Object

Returns the value of attribute components.



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

def components
  @components
end

Class Method Details

.[](path) ⇒ Object 



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

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

.create(path) ⇒ Object 



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

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.



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

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.



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

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

.root ⇒ Object 



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

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

.shortest_path(path, root) ⇒ Object

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



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

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 



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

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.



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

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

Instance Method Details

#+(other) ⇒ Object 



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

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



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

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 



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

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

#==(other) ⇒ Object 



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

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 



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

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

#[]=(index, value) ⇒ Object

Replaces a named component, indexing as per



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

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

#absolute? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#ascend(&block) ⇒ Object 



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

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 



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

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

#delete_at(index) ⇒ Object 



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

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

#descend(&block) ⇒ Object 



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

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) 


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

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

#dirname(count = 1) ⇒ Object 



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

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

  return absolute? ? path.to_absolute : path
end

#dup ⇒ Object 



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

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

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


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

def empty?
  @components.empty?
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#expand(root) ⇒ Object 



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

def expand(root)
  root + self
end

#extension ⇒ Object 



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

def extension
  basename(true).extension
end

#first ⇒ Object 



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

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

#freeze ⇒ Object 



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

def freeze
  @components.freeze
  
  super
end

#hash ⇒ Object 



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

def hash
  @components.hash
end

#include?(*args) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#join(other) ⇒ Object 



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

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

#last ⇒ Object 



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

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

#relative? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#shortest_path(root) ⇒ Object 



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

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

#simplify ⇒ Object 



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

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 



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

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) 


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

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 



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

def to_a
  @components
end

#to_absolute ⇒ Object 



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

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

#to_directory ⇒ Object 



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

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

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



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

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

#to_relative! ⇒ Object 



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

def to_relative!
  @components.shift if relative?
end

#to_s ⇒ Object 



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

def to_s
  to_str
end

#to_str ⇒ Object 



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

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

#with_prefix(*args) ⇒ Object 



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

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