Class: Utopia::Path
- Inherits:
-
Object
- Object
- Utopia::Path
- 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
-
#components ⇒ Object
Returns the value of attribute components.
Class Method Summary collapse
- .[](path) ⇒ Object
- .create(path) ⇒ Object
- .dump(instance) ⇒ Object
-
.from_string(string) ⇒ Object
This constructor takes a string and generates a relative path as efficiently as possible.
- .load(value) ⇒ Object
-
.prefix_length(a, b) ⇒ Object
Returns the length of the prefix which is shared by two strings.
- .root ⇒ Object
-
.shortest_path(path, root) ⇒ Object
Return the shortest relative path to get to path from root:.
- .split(path) ⇒ Object
-
.unescape(string) ⇒ Object
Converts '+' into whitespace and hex encoded characters into their equivalent characters.
Instance Method Summary collapse
- #+(other) ⇒ Object
-
#-(other) ⇒ Object
Computes the difference of the path.
- #<=>(other) ⇒ Object
- #==(other) ⇒ Object
- #[](index) ⇒ Object
-
#[]=(index, value) ⇒ Object
Replaces a named component, indexing as per.
- #absolute? ⇒ Boolean
- #ascend(&block) ⇒ Object
- #basename ⇒ Object
- #delete_at(index) ⇒ Object
- #descend(&block) ⇒ Object
- #directory? ⇒ Boolean
- #dirname(count = 1) ⇒ Object
- #dup ⇒ Object
- #empty? ⇒ Boolean
- #eql?(other) ⇒ Boolean
- #expand(root) ⇒ Object
- #extension ⇒ Object
- #first ⇒ Object
- #freeze ⇒ Object
- #hash ⇒ Object
- #include?(*args) ⇒ Boolean
-
#initialize(components = []) ⇒ Path
constructor
A new instance of Path.
- #join(other) ⇒ Object
- #last ⇒ Object
- #relative? ⇒ Boolean
- #replace(other_path) ⇒ Object
- #shortest_path(root) ⇒ Object
- #simplify ⇒ Object
- #split(at) ⇒ Object
- #start_with?(other) ⇒ Boolean
- #to_a ⇒ Object
- #to_absolute ⇒ Object
- #to_directory ⇒ Object
- #to_local_path(separator = File::SEPARATOR) ⇒ Object
- #to_relative! ⇒ Object
- #to_str ⇒ Object (also: #to_s)
- #with_prefix(*args) ⇒ Object
Constructor Details
#initialize(components = []) ⇒ Path
Returns a new instance of Path.
28 29 30 |
# File 'lib/utopia/path.rb', line 28 def initialize(components = []) @components = components end |
Instance Attribute Details
#components ⇒ Object
Returns the value of attribute components.
32 33 34 |
# File 'lib/utopia/path.rb', line 32 def components @components end |
Class Method Details
.[](path) ⇒ Object
78 79 80 |
# File 'lib/utopia/path.rb', line 78 def self.[] path self.create(path) end |
.create(path) ⇒ Object
108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/utopia/path.rb', line 108 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 |
.dump(instance) ⇒ Object
104 105 106 |
# File 'lib/utopia/path.rb', line 104 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.
96 97 98 |
# File 'lib/utopia/path.rb', line 96 def self.from_string(string) self.new(unescape(string).split(SEPARATOR, -1)) end |
.load(value) ⇒ Object
100 101 102 |
# File 'lib/utopia/path.rb', line 100 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.
49 50 51 |
# File 'lib/utopia/path.rb', line 49 def self.prefix_length(a, b) [a.size, b.size].min.times{|i| return i if a[i] != b[i]} end |
.root ⇒ Object
44 45 46 |
# File 'lib/utopia/path.rb', line 44 def self.root self.new(['']) end |
.shortest_path(path, root) ⇒ Object
Return the shortest relative path to get to path from root:
54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/utopia/path.rb', line 54 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
82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/utopia/path.rb', line 82 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.
72 73 74 75 76 |
# File 'lib/utopia/path.rb', line 72 def self.unescape(string) string.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) { [$1.delete('%')].pack('H*') } end |
Instance Method Details
#+(other) ⇒ Object
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'lib/utopia/path.rb', line 183 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
206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/utopia/path.rb', line 206 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
296 297 298 |
# File 'lib/utopia/path.rb', line 296 def <=> other @components <=> other.components end |
#==(other) ⇒ Object
308 309 310 311 312 313 314 315 316 |
# File 'lib/utopia/path.rb', line 308 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
326 327 328 |
# File 'lib/utopia/path.rb', line 326 def [] index return @components[component_offset(index)] end |
#[]=(index, value) ⇒ Object
Replaces a named component, indexing as per
331 332 333 |
# File 'lib/utopia/path.rb', line 331 def []= index, value return @components[component_offset(index)] = value end |
#absolute? ⇒ Boolean
145 146 147 |
# File 'lib/utopia/path.rb', line 145 def absolute? @components.first == '' end |
#ascend(&block) ⇒ Object
268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/utopia/path.rb', line 268 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 ⇒ Object
234 235 236 237 238 |
# File 'lib/utopia/path.rb', line 234 def basename basename, _ = @components.last.split('.', 2) return basename || '' end |
#delete_at(index) ⇒ Object
335 336 337 |
# File 'lib/utopia/path.rb', line 335 def delete_at(index) @components.delete_at(component_offset(index)) end |
#descend(&block) ⇒ Object
256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/utopia/path.rb', line 256 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
129 130 131 |
# File 'lib/utopia/path.rb', line 129 def directory? return @components.last == '' end |
#dirname(count = 1) ⇒ Object
246 247 248 249 250 |
# File 'lib/utopia/path.rb', line 246 def dirname(count = 1) path = self.class.new(@components[0...-count]) return absolute? ? path.to_absolute : path end |
#dup ⇒ Object
292 293 294 |
# File 'lib/utopia/path.rb', line 292 def dup return Path.new(components.dup) end |
#empty? ⇒ Boolean
40 41 42 |
# File 'lib/utopia/path.rb', line 40 def empty? @components.empty? end |
#eql?(other) ⇒ Boolean
300 301 302 |
# File 'lib/utopia/path.rb', line 300 def eql? other self.class.eql?(other.class) and @components.eql?(other.components) end |
#extension ⇒ Object
240 241 242 243 244 |
# File 'lib/utopia/path.rb', line 240 def extension _, extension = @components.last.split('.', 2) return extension end |
#first ⇒ Object
339 340 341 342 343 344 345 |
# File 'lib/utopia/path.rb', line 339 def first if absolute? @components[1] else @components[0] end end |
#freeze ⇒ Object
34 35 36 37 38 |
# File 'lib/utopia/path.rb', line 34 def freeze @components.freeze super end |
#hash ⇒ Object
304 305 306 |
# File 'lib/utopia/path.rb', line 304 def hash @components.hash end |
#include?(*args) ⇒ Boolean
125 126 127 |
# File 'lib/utopia/path.rb', line 125 def include?(*args) @components.include?(*args) end |
#join(other) ⇒ Object
175 176 177 |
# File 'lib/utopia/path.rb', line 175 def join(other) self.class.new(@components + other).simplify end |
#last ⇒ Object
347 348 349 350 351 352 353 |
# File 'lib/utopia/path.rb', line 347 def last if directory? @components[-2] else @components[-1] end end |
#relative? ⇒ Boolean
141 142 143 |
# File 'lib/utopia/path.rb', line 141 def relative? @components.first != '' end |
#replace(other_path) ⇒ Object
121 122 123 |
# File 'lib/utopia/path.rb', line 121 def replace(other_path) @components = other_path.components.dup end |
#shortest_path(root) ⇒ Object
67 68 69 |
# File 'lib/utopia/path.rb', line 67 def shortest_path(root) self.class.shortest_path(self, root) end |
#simplify ⇒ Object
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/utopia/path.rb', line 218 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
280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/utopia/path.rb', line 280 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
318 319 320 321 322 323 324 |
# File 'lib/utopia/path.rb', line 318 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
171 172 173 |
# File 'lib/utopia/path.rb', line 171 def to_a @components end |
#to_absolute ⇒ Object
149 150 151 152 153 154 155 |
# File 'lib/utopia/path.rb', line 149 def to_absolute if absolute? return self else return self.class.new([''] + @components) end end |
#to_directory ⇒ Object
133 134 135 136 137 138 139 |
# File 'lib/utopia/path.rb', line 133 def to_directory if directory? return self else return join(['']) end end |
#to_local_path(separator = File::SEPARATOR) ⇒ Object
252 253 254 |
# File 'lib/utopia/path.rb', line 252 def to_local_path(separator = File::SEPARATOR) @components.join(separator) end |
#to_relative! ⇒ Object
157 158 159 |
# File 'lib/utopia/path.rb', line 157 def to_relative! @components.shift if relative? end |
#to_str ⇒ Object Also known as: to_s
161 162 163 164 165 166 167 |
# File 'lib/utopia/path.rb', line 161 def to_str if @components == [''] SEPARATOR else @components.join(SEPARATOR) end end |
#with_prefix(*args) ⇒ Object
199 200 201 |
# File 'lib/utopia/path.rb', line 199 def with_prefix(*args) self.class.create(*args) + self end |