Class: Puppet::FileServing::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet/file_serving/base.rb

Overview

The base class for Content and Metadata; provides common functionality like the behaviour around links.

Direct Known Subclasses

Content, Metadata

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path, links: nil, relative_path: nil, source: nil) ⇒ Base

Returns a new instance of Base.



37
38
39
40
41
42
43
44
 
# File 'lib/puppet/file_serving/base.rb', line 37

def initialize(path, links: nil, relative_path: nil, source: nil)
  self.path = path
  @links = :manage

  self.links = links if links
  self.relative_path = relative_path if relative_path
  self.source = source if source
end

Instance Attribute Details

Determine how we deal with links.



47
48
49
 
# File 'lib/puppet/file_serving/base.rb', line 47

def links
  @links
end

#path ⇒ Object

Set our base path.



59
60
61
 
# File 'lib/puppet/file_serving/base.rb', line 59

def path
  @path
end

#relative_path ⇒ Object

Set a relative path; this is used for recursion, and sets the file’s path relative to the initial recursion point.



69
70
71
 
# File 'lib/puppet/file_serving/base.rb', line 69

def relative_path
  @relative_path
end

#source ⇒ Object

This is for external consumers to store the source that was used to retrieve the metadata.



11
12
13
 
# File 'lib/puppet/file_serving/base.rb', line 11

def source
  @source
end

Class Method Details

.absolute?(path) ⇒ Boolean

Returns:

  • (Boolean) 


91
92
93
 
# File 'lib/puppet/file_serving/base.rb', line 91

def self.absolute?(path)
  Puppet::Util.absolute_path?(path, :posix) || (Puppet::Util::Platform.windows? && Puppet::Util.absolute_path?(path, :windows))
end

Instance Method Details

#exist? ⇒ Boolean

Does our file exist?

Returns:

  • (Boolean) 


14
15
16
17
18
19
 
# File 'lib/puppet/file_serving/base.rb', line 14

def exist?
  stat
  true
rescue
  false
end

#full_path ⇒ Object

Return the full path to our file. Fails if there’s no path set.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/puppet/file_serving/base.rb', line 22

def full_path
  if relative_path.nil? or relative_path == "" or relative_path == "."
    full_path = path
  else
    full_path = File.join(path, relative_path)
  end

  if Puppet::Util::Platform.windows?
    # Replace multiple slashes as long as they aren't at the beginning of a filename
    full_path.gsub(%r{(./)/+}, '\1')
  else
    full_path.gsub(%r{//+}, '/')
  end
end

#stat ⇒ Object

Stat our file, using the appropriate link-sensitive method.



78
79
80
81
 
# File 'lib/puppet/file_serving/base.rb', line 78

def stat
  @stat_method ||= links == :manage ? :lstat : :stat
  Puppet::FileSystem.send(@stat_method, full_path)
end

#to_data_hash ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/puppet/file_serving/base.rb', line 83

def to_data_hash
  {
    'path' => @path,
    'relative_path' => @relative_path,
    'links' => @links.to_s
  }
end