Module: PDK::Util

Defined in:
lib/pdk/util.rb,
lib/pdk/util/git.rb,
lib/pdk/util/bundler.rb,
lib/pdk/util/version.rb,
lib/pdk/util/windows.rb,
lib/pdk/util/filesystem.rb,
lib/pdk/util/ruby_version.rb,
lib/pdk/util/template_uri.rb,
lib/pdk/util/vendored_file.rb,
lib/pdk/util/puppet_strings.rb,
lib/pdk/util/puppet_version.rb

Defined Under Namespace

Modules: Bundler, Filesystem, Git, PuppetStrings, Version, Windows Classes: GitError, PuppetVersion, RubyVersion, TemplateURI, VendoredFile

Constant Summary collapse

MODULE_FOLDERS = 
%w[
  manifests
  lib
  tasks
  facts.d
  functions
  types
].freeze

Class Method Summary collapse

Class Method Details

.cachedir ⇒ String

Returns the fully qualified path to a per-user PDK cachedir.

Returns:

  • (String) —

    Fully qualified path to per-user PDK cachedir.



101
102
103
104
105
106
107
 
# File 'lib/pdk/util.rb', line 101

def cachedir
  if Gem.win_platform?
    File.join(ENV['LOCALAPPDATA'], 'PDK', 'cache')
  else
    File.join(Dir.home, '.pdk', 'cache')
  end
end

.canonical_path(path) ⇒ String

Return an expanded, absolute path

Parameters:

  • path (String) —

    Existing path that may not be canonical

Returns:

  • (String) —

    Canonical path



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/pdk/util.rb', line 59

def canonical_path(path)
  if Gem.win_platform?
    unless File.exist?(path)
      raise PDK::CLI::FatalError, _("Cannot resolve a full path to '%{path}', as it does not currently exist.") % { path: path }
    end
    PDK::Util::Windows::File.get_long_pathname(path)
  else
    File.expand_path(path)
  end
end

.configdir ⇒ Object 



110
111
112
113
114
115
116
 
# File 'lib/pdk/util.rb', line 110

def configdir
  if Gem.win_platform?
    File.join(ENV['LOCALAPPDATA'], 'PDK')
  else
    File.join(ENV.fetch('XDG_CONFIG_HOME', File.join(Dir.home, '.config')), 'pdk')
  end
end

.development_mode? ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/pdk/util.rb', line 76

def development_mode?
  (!PDK::Util::Version.git_ref.nil? || PDK::VERSION.end_with?('.pre'))
end

.find_all_json_in(text) ⇒ Array<Hash>

Iterate through possible JSON documents for all valid JSON

Parameters:

  • text (String) —

    the text in which to find JSON document(s)

Returns:

  • (Array<Hash>) —

    subset of text as Array of all JSON object found, empty Array if none are found JSON found in the text



160
161
162
 
# File 'lib/pdk/util.rb', line 160

def find_all_json_in(text)
  find_valid_json_in(text, break_on_first: false)
end

.find_first_json_in(text) ⇒ Hash?

Iterate through possible JSON documents until we find one that is valid.

Parameters:

  • text (String) —

    the text in which to find a JSON document

Returns:

  • (Hash, nil) —

    subset of text as Hash of first valid JSON found, or nil if no valid JSON found in the text



150
151
152
 
# File 'lib/pdk/util.rb', line 150

def find_first_json_in(text)
  find_valid_json_in(text)
end

.find_upwards(target, start_dir = nil) ⇒ String?

Searches upwards from current working directory for the given target file.

Parameters:

  • target (String) —

    Name of file to search for.

  • start_dir (String) (defaults to: nil) —

    Directory to start searching from, defaults to Dir.pwd

Returns:

  • (String, nil) —

    Fully qualified path to the given target file if found, nil if the target file could not be found.



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/pdk/util.rb', line 29

def find_upwards(target, start_dir = nil)
  previous = nil
  current  = File.expand_path(start_dir || Dir.pwd)

  until !File.directory?(current) || current == previous
    filename = File.join(current, target)
    return filename if File.file?(filename)
    previous = current
    current = File.expand_path('..', current)
  end
end

.find_valid_json_in(text, opts = {}) ⇒ Hash, ...

Iterate through possible JSON documents until we find one that is valid.

Parameters:

  • text (String) —

    the text in which to find a JSON document

  • opts (Hash) (defaults to: {}) —

    options

Options Hash (opts):

  • :break_on_first (Boolean) —

    Whether or not to break after valid JSON is found, defaults to true

Returns:

  • (Hash, Array<Hash>, nil) —

    subset of text as Hash of first valid JSON found, array of all valid JSON found, or nil if no valid JSON found in the text



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/pdk/util.rb', line 175

def find_valid_json_in(text, opts = {})
  break_on_first = opts.key?(:break_on_first) ? opts[:break_on_first] : true

  json_result = break_on_first ? nil : []

  text.scan(%r{\{(?:[^{}]|(?:\g<0>))*\}}x) do |str|
    begin
      if break_on_first
        json_result = JSON.parse(str)
        break
      else
        json_result.push(JSON.parse(str))
      end
    rescue JSON::ParserError
      next
    end
  end

  json_result
end

.gem_install? ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/pdk/util.rb', line 81

def gem_install?
  !(package_install? || development_mode?)
end

.in_module_root? ⇒ boolean

Returns true or false depending on if any of the common directories in a module are found in the current directory

Returns:

  • (boolean) —

    True if any folders from MODULE_FOLDERS are found in the current dir, false otherwise.



140
141
142
 
# File 'lib/pdk/util.rb', line 140

def in_module_root?
  PDK::Util::MODULE_FOLDERS.any? { |dir| File.directory?(dir) }
end

.make_tmpdir_name(base) ⇒ String

Generate a name for a temporary directory.

Parameters:

  • base (String) —

    A string to base the name generation off.

Returns:

  • (String) —

    The temporary directory path.



47
48
49
50
51
 
# File 'lib/pdk/util.rb', line 47

def make_tmpdir_name(base)
  t = Time.now.strftime('%Y%m%d')
  name = "#{base}#{t}-#{Process.pid}-#{rand(0x100000000).to_s(36)}"
  File.join(Dir.tmpdir, name)
end

.module_metadata ⇒ Object

TO-DO: Refactor replacement of lib/pdk/module/build.rb:metadata to use this function instead



212
213
214
 
# File 'lib/pdk/util.rb', line 212

def module_metadata
  PDK::Module::Metadata.from_file(File.join(module_root, 'metadata.json')).data
end

.module_pdk_compatible? ⇒ Boolean

TO-DO: Refactor replacement of lib/pdk/module/build.rb:module_pdk_compatible? to use this function instead

Returns:

  • (Boolean) 


218
219
220
 
# File 'lib/pdk/util.rb', line 218

def module_pdk_compatible?
  ['pdk-version', 'template-url'].any? { |key| module_metadata.key?(key) }
end

.module_pdk_version ⇒ Object 



223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/pdk/util.rb', line 223

def module_pdk_version
  metadata = module_metadata

  if metadata.nil? || metadata.fetch('pdk-version', nil).nil?
    nil
  else
    metadata['pdk-version'].split.first
  end
rescue ArgumentError => e
  PDK.logger.error(e)
  nil
end

.module_root ⇒ String?

Returns path to the root of the module being worked on.

Returns:

  • (String, nil) —

    Fully qualified base path to module, or nil if the current working dir does not appear to be within a module.



123
124
125
126
127
128
129
130
131
132
 
# File 'lib/pdk/util.rb', line 123

def module_root
  metadata_path = find_upwards('metadata.json')
  if metadata_path
    File.dirname(metadata_path)
  elsif in_module_root?
    Dir.pwd
  else
    nil
  end
end

.package_cachedir ⇒ Object 



93
94
95
 
# File 'lib/pdk/util.rb', line 93

def package_cachedir
  File.join(pdk_package_basedir, 'share', 'cache')
end

.package_install? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/pdk/util.rb', line 71

def package_install?
  !PDK::Util::Version.version_file.nil?
end

.pdk_package_basedir ⇒ Object

Raises:



86
87
88
89
90
 
# File 'lib/pdk/util.rb', line 86

def pdk_package_basedir
  raise PDK::CLI::FatalError, _('Package basedir requested for non-package install.') unless package_install?

  File.dirname(PDK::Util::Version.version_file)
end

.targets_relative_to_pwd(targets) ⇒ Array<String>

Returns the targets’ paths relative to the working directory

Returns:

  • (Array<String>) —

    The absolute or path to the target



200
201
202
203
204
205
206
207
208
 
# File 'lib/pdk/util.rb', line 200

def targets_relative_to_pwd(targets)
  targets.map do |t|
    if Pathname.new(t).absolute?
      Pathname.new(t).relative_path_from(Pathname.pwd)
    else
      t
    end
  end
end