Class: Webgen::Path

Inherits:

Object

• Object
• Webgen::Path

show all

Includes:

Comparable

Defined in:

lib/webgen/path.rb

Overview

Defined Under Namespace

Classes: SourceIO

Constant Summary

FILENAME_RE =

/^(?:(\d+)\.)?(\.?[^.]*?)(?:\.(\w\w\w?)(?=\.))?(?:\.(.*))?$/

Instance Attribute Summary (collapse)

• - (Object) basename

  The canonical name of the path without the extension.

• - (Object) ext

  The extension of the path.

• - (Object) meta_info

  Extracted meta information for the path.

• - (Object) parent_path readonly

  The string specifying the parent path.

• - (Object) passive writeonly

  Specifies whether this path should be used during the "tree update" phase of a webgen run or only later during node resolution.

• - (Object) path readonly

  The full path for which this Path object was created.

• - (Object) source_path readonly

  A string specifying the path that lead to the creation of this path.

Class Method Summary (collapse)

• + (Object) lcn(cn, lang)

  Utility method for creating the lcn from the cn and the language lang.

• + (Object) make_absolute(base, path)

  Make the given path absolute by prepending the absolute directory path base if necessary.

• + (Object) match(path, pattern)

  Return true if the given path matches the given pattern.

Instance Method Summary (collapse)

• - (Object) <=>(other)

  Compare the #path of this object to other.path.

• - (Object) ==(other) (also: #eql?)

  Equality -- Return true if other is a Path object with the same #path or if other is a String equal to the #path.

• - (Object) acn

  The absolute canonical name of this path.

• - (Object) alcn

  The absolute localized canonical name of this path.

• - (Boolean) changed?

  Has the content of this path changed since the last webgen run? This default implementation always returns true, a specialized sub class needs to override this behaviour!.

• - (Object) cn

  The canonical name created from the path (namely from the parts basename and extension).

• - (Object) dup

  Duplicate the path object.

• - (Object) hash

  :nodoc:.

• - (Path) initialize(path, source_path = path, &ioblock) constructor

  Create a new Path object for path.

• - (Object) inspect

  :nodoc:.

• - (Object) io

  The SourceIO object associated with the path.

• - (Object) lcn

  The localized canonical name created from the path.

• - (Object) mount_at(mp, prefix = nil)

  Mount this path at the mount point mp, optionally stripping prefix from the parent path, and return the new path object.

• - (Boolean) passive?

  Is this path only used later during node resolution? Defaults to false, i.e.

• - (Object) to_s (also: #to_str)

  :nodoc:.

122
123
124
125
126
127
128

# File 'lib/webgen/path.rb', line 122

def initialize(path, source_path = path, &ioblock)
  @meta_info = {}
  @io = block_given? ? SourceIO.new(&ioblock) : nil
  @source_path = source_path
  @passive = false
  analyse(path)
end

100
101
102

# File 'lib/webgen/path.rb', line 100

def basename
  @basename
end

103
104
105

# File 'lib/webgen/path.rb', line 103

def ext
  @ext
end

106
107
108

# File 'lib/webgen/path.rb', line 106

def meta_info
  @meta_info
end

97
98
99

# File 'lib/webgen/path.rb', line 97

def parent_path
  @parent_path
end

110
111
112

# File 'lib/webgen/path.rb', line 110

def passive=(value)
  @passive = value
end

91
92
93

# File 'lib/webgen/path.rb', line 91

def path
  @path
end

94
95
96

# File 'lib/webgen/path.rb', line 94

def source_path
  @source_path
end

185
186
187
188
189
190
191

# File 'lib/webgen/path.rb', line 185

def self.lcn(cn, lang)
  if lang.nil?
    cn
  else
    cn.split('.').insert((cn =~ /^\./ ? 2 : 1), lang.to_s).join('.')
  end
end

75
76
77
78

# File 'lib/webgen/path.rb', line 75

def self.make_absolute(base, path)
  raise(ArgumentError, 'base has to be an absolute path, ie. needs to start with a slash') unless base =~ /^\//
  Pathname.new(path =~ /^\// ? path : File.join(base, path)).cleanpath.to_s + (path =~ /.\/$/ ? '/' : '')
end

82
83
84
85

# File 'lib/webgen/path.rb', line 82

def self.match(path, pattern)
  pattern += '/' if path.to_s =~ /\/$/ && pattern !~ /\/$|^$/
  File.fnmatch(pattern, path.to_s, File::FNM_DOTMATCH|File::FNM_CASEFOLD|File::FNM_PATHNAME)
end

230
231
232

# File 'lib/webgen/path.rb', line 230

def <=>(other)
  @path <=> other.path
end

218
219
220
221
222
223
224
225
226

# File 'lib/webgen/path.rb', line 218

def ==(other)
  if other.kind_of?(Path)
    other.path == @path
  elsif other.kind_of?(String)
    other == @path
  else
    false
  end
end

199
200
201
202
203
204
205

# File 'lib/webgen/path.rb', line 199

def acn
  if @path =~ /#/
    self.class.new(@parent_path).acn + cn
  else
    @parent_path + cn
  end
end

208
209
210
211
212
213
214

# File 'lib/webgen/path.rb', line 208

def alcn
  if @path =~ /#/
    self.class.new(@parent_path).alcn + lcn
  else
    @parent_path + lcn
  end
end

166
167
168

# File 'lib/webgen/path.rb', line 166

def changed?
  true
end

180
181
182

# File 'lib/webgen/path.rb', line 180

def cn
  @basename + (@ext.length > 0 ? '.' + @ext : '') + (@basename != '/' && @path =~ /.\/$/ ? '/' : '')
end

158
159
160
161
162

# File 'lib/webgen/path.rb', line 158

def dup
  temp = super
  temp.instance_variable_set(:@meta_info, @meta_info.dup)
  temp
end

234
235
236

# File 'lib/webgen/path.rb', line 234

def hash #:nodoc:
  @path.hash
end

243
244
245

# File 'lib/webgen/path.rb', line 243

def inspect #:nodoc:
  "#<Path: #{@path}>"
end

171
172
173
174
175
176
177

# File 'lib/webgen/path.rb', line 171

def io
  if @io
    @io
  else
    raise "No IO object defined for the path #{self}"
  end
end

194
195
196

# File 'lib/webgen/path.rb', line 194

def lcn
  self.class.lcn(cn, @meta_info['lang'])
end

139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

# File 'lib/webgen/path.rb', line 139

def mount_at(mp, prefix = nil)
  raise(ArgumentError, "The mount point (#{mp}) must be a valid directory path") if mp =~ /^[^\/]|#|[^\/]$/
  raise(ArgumentError, "The strip prefix (#{prefix}) must be a valid directory path") if !prefix.nil? && prefix =~ /^[^\/]|#|[^\/]$/

  temp = dup
  strip_re = /^#{Regexp.escape(prefix.to_s)}/
  temp.instance_variable_set(:@path, temp.path.sub(strip_re, ''))
  reanalyse = (@path == '/' || temp.path == '')
  temp.instance_variable_set(:@path, File.join(mp, temp.path))
  temp.instance_variable_set(:@source_path, temp.path) if @path == @source_path
  if reanalyse
    temp.send(:analyse, temp.path)
  else
    temp.instance_variable_set(:@parent_path, File.join(mp, temp.parent_path.sub(strip_re, '')))
  end
  temp
end

114

# File 'lib/webgen/path.rb', line 114

def passive?; @passive; end

238
239
240

# File 'lib/webgen/path.rb', line 238

def to_s #:nodoc:
  @path.dup
end