File: array.rb

package info (click to toggle)
ruby-filepath 0.7-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster
  • size: 244 kB
  • sloc: ruby: 1,691; makefile: 5
file content (45 lines) | stat: -rw-r--r-- 1,171 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# This is free software released into the public domain (CC0 license).


class Array
	# Generates a path using the elements of an array as path segments.
	#
	# `[a, b, c].as_path` is equivalent to `Filepath.join(a, b, c)`.
	#
	# @example Filepath from an array of strings
	#
	#     ["/", "foo", "bar"].as_path #=> </foo/bar>
	#
	# @example Filepath from an array of strings and other Filepaths
	#
	#     server_dir = config["root_dir"] / "server"
	#     ["..", config_dir, "secret"].as_path #=> <../config/server/secret>
	#
	# @return [Filepath] a new path generated using the element as path
	#         segments
	#
	# @note FIXME: `#as_path` should be `#to_path` but that method name
	#       is already used

	def as_path
		Filepath.join(self)
	end


	# Generates a path list from an array of paths.
	#
	# The elements of the array must respond to `#as_path`.
	#
	# `ary.as_path` is equivalent to `FilepathList.new(ary)`.
	#
	# @return [FilepathList] a new path list containing the elements of
	#                        the array as Filepaths
	#
	# @see String#as_path
	# @see Array#as_path
	# @see Filepath#as_path

	def as_path_list
		FilepathList.new(self)
	end
end