Class: PDK::Generate::PuppetObject
- Inherits:
-
Object
- Object
- PDK::Generate::PuppetObject
- Defined in:
- lib/pdk/generate/puppet_object.rb
Direct Known Subclasses
Instance Attribute Summary collapse
-
#module_dir ⇒ Object
readonly
Returns the value of attribute module_dir.
-
#object_name ⇒ Object
readonly
Returns the value of attribute object_name.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Instance Method Summary collapse
-
#check_preconditions ⇒ Object
Check preconditions of this template group.
-
#initialize(module_dir, object_name, options = {}) ⇒ PuppetObject
constructor
Initialises the PDK::Generate::PuppetObject object.
-
#module_metadata ⇒ PDK::Module::Metadata
private
Parses the metadata.json file for the module.
-
#module_name ⇒ String
private
Retrieves the name of the module (without the forge username) from the module metadata.
-
#object_type ⇒ Symbol
private
Retrieves the type of the object being generated, e.g.
-
#render_file(dest_path, template_path, data) ⇒ void
private
Render a file using the provided template and write it to disk.
-
#run ⇒ Object
Check that the templates can be rendered.
- #target_object_path ⇒ Object abstract
- #target_spec_path ⇒ Object abstract
-
#target_type_path ⇒ String
abstract
Returns nil if there is no additional object file.
- #target_type_spec_path ⇒ Object abstract
- #template_data ⇒ Object abstract
-
#templates ⇒ Array<Hash{Symbol => Object}>
private
Provides the possible template directory locations in the order in which they should be searched for a valid template.
-
#with_templates {|template_paths, config_hash| ... } ⇒ Object
private
Search the possible template directories in order of preference to find a template that can be used to render a new object of the specified type.
-
#write_file(dest_path) ⇒ void
private
Write the result of the block to disk.
Constructor Details
#initialize(module_dir, object_name, options = {}) ⇒ PuppetObject
Initialises the PDK::Generate::PuppetObject object.
In general, this object should never be instantiated directly. Instead, one of the subclasses should be used e.g. PDK::Generate::Klass.
New subclasses generally only need to inherit this class, set the OBJECT_TYPE constant and implement the #template_data, #target_object_path and #target_spec_path methods.
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/pdk/generate/puppet_object.rb', line 32 def initialize(module_dir, object_name, = {}) @module_dir = module_dir @options = @object_name = object_name if [:class, :defined_type].include?(object_type) # rubocop:disable Style/GuardClause object_name_parts = object_name.split('::') @object_name = if object_name_parts.first == module_name object_name else [module_name, object_name].join('::') end end end |
Instance Attribute Details
#module_dir ⇒ Object (readonly)
Returns the value of attribute module_dir.
13 14 15 |
# File 'lib/pdk/generate/puppet_object.rb', line 13 def module_dir @module_dir end |
#object_name ⇒ Object (readonly)
Returns the value of attribute object_name.
14 15 16 |
# File 'lib/pdk/generate/puppet_object.rb', line 14 def object_name @object_name end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
15 16 17 |
# File 'lib/pdk/generate/puppet_object.rb', line 15 def @options end |
Instance Method Details
#check_preconditions ⇒ Object
Check preconditions of this template group. By default this only makes sure that the target files do not already exist. Override this (and call super) to add your own preconditions.
101 102 103 104 105 106 107 108 109 110 |
# File 'lib/pdk/generate/puppet_object.rb', line 101 def check_preconditions [target_object_path, target_type_path, target_spec_path, target_type_spec_path].compact.each do |target_file| next unless File.exist?(target_file) raise PDK::CLI::ExitWithError, _("Unable to generate %{object_type}; '%{file}' already exists.") % { file: target_file, object_type: object_type, } end end |
#module_metadata ⇒ PDK::Module::Metadata
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Parses the metadata.json file for the module.
279 280 281 282 283 284 285 |
# File 'lib/pdk/generate/puppet_object.rb', line 279 def @module_metadata ||= begin PDK::Module::Metadata.from_file(File.join(module_dir, 'metadata.json')) rescue ArgumentError => e raise PDK::CLI::FatalError, _("'%{dir}' does not contain valid Puppet module metadata: %{msg}") % { dir: module_dir, msg: e. } end end |
#module_name ⇒ String
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Retrieves the name of the module (without the forge username) from the module metadata.
267 268 269 |
# File 'lib/pdk/generate/puppet_object.rb', line 267 def module_name @module_name ||= .data['name'].rpartition('-').last end |
#object_type ⇒ Symbol
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Retrieves the type of the object being generated, e.g. :class, :defined_type, etc. This is specified in the subclass’ OBJECT_TYPE constant.
91 92 93 |
# File 'lib/pdk/generate/puppet_object.rb', line 91 def object_type self.class::OBJECT_TYPE end |
#render_file(dest_path, template_path, data) ⇒ void
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
This method returns an undefined value.
Render a file using the provided template and write it to disk.
150 151 152 153 154 |
# File 'lib/pdk/generate/puppet_object.rb', line 150 def render_file(dest_path, template_path, data) write_file(dest_path) do PDK::TemplateFile.new(template_path, data).render end end |
#run ⇒ Object
Check that the templates can be rendered. Find an appropriate template and create the target files from the template. This is the main entry point for the class.
120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/pdk/generate/puppet_object.rb', line 120 def run check_preconditions with_templates do |template_path, config_hash| data = template_data.merge(configs: config_hash) render_file(target_object_path, template_path[:object], data) render_file(target_type_path, template_path[:type], data) if template_path[:type] render_file(target_spec_path, template_path[:spec], data) if template_path[:spec] render_file(target_type_spec_path, template_path[:type_spec], data) if template_path[:type_spec] end end |
#target_object_path ⇒ Object
Subclass and implement #target_object_path. Implementations of this method should return a String containing the destination path of the object being generated.
58 59 60 |
# File 'lib/pdk/generate/puppet_object.rb', line 58 def target_object_path raise NotImplementedError end |
#target_spec_path ⇒ Object
Subclass and implement #target_spec_path. Implementations of this method should return a String containing the destination path of the tests for the object being generated.
73 74 75 |
# File 'lib/pdk/generate/puppet_object.rb', line 73 def target_spec_path raise NotImplementedError end |
#target_type_path ⇒ String
Subclass and implement #target_type_path. Implementations of this method should return a String containing the destination path of the additional object file being generated.
Returns nil if there is no additional object file
66 67 68 |
# File 'lib/pdk/generate/puppet_object.rb', line 66 def target_type_path nil end |
#target_type_spec_path ⇒ Object
Subclass and implement #target_type_spec_path. Implementations of this method should return a String containing the destination path of the tests for the object being generated.
80 81 82 |
# File 'lib/pdk/generate/puppet_object.rb', line 80 def target_type_spec_path nil end |
#template_data ⇒ Object
Subclass and implement #template_data to provide data to the templates during rendering. Implementations of this method should return a Hash{Symbol => Object}.
51 52 53 |
# File 'lib/pdk/generate/puppet_object.rb', line 51 def template_data raise NotImplementedError end |
#templates ⇒ Array<Hash{Symbol => Object}>
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Provides the possible template directory locations in the order in which they should be searched for a valid template.
If a template-url has been specified on in the options hash (e.g. from a CLI parameter), then this template directory will be checked first and we do not fall back to the next possible template directory.
If we have not been provided a specific template directory to use, we try the template specified in the module metadata (as set during PDK::Generate::Module) and fall back to the default template if necessary.
252 253 254 255 256 257 258 |
# File 'lib/pdk/generate/puppet_object.rb', line 252 def templates @templates ||= [ { type: 'CLI', url: @options[:'template-url'], allow_fallback: false }, { type: 'metadata', url: .data['template-url'], allow_fallback: true }, { type: 'default', url: PDK::Util.default_template_url, allow_fallback: false }, ] end |
#with_templates {|template_paths, config_hash| ... } ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Search the possible template directories in order of preference to find a template that can be used to render a new object of the specified type.
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/pdk/generate/puppet_object.rb', line 206 def with_templates templates.each do |template| if template[:url].nil? PDK.logger.debug(_('No %{dir_type} template specified; trying next template directory.') % { dir_type: template[:type] }) next end PDK::Module::TemplateDir.new(template[:url]) do |template_dir| template_paths = template_dir.object_template_for(object_type) if template_paths config_hash = template_dir.object_config yield template_paths, config_hash # TODO: refactor to a search-and-execute form instead return # work is done # rubocop:disable Lint/NonLocalExitFromIterator elsif template[:allow_fallback] PDK.logger.debug(_('Unable to find a %{type} template in %{url}; trying next template directory.') % { type: object_type, url: template[:url] }) else raise PDK::CLI::FatalError, _('Unable to find the %{type} template in %{url}.') % { type: object_type, url: template[:url] } end end end rescue ArgumentError => e raise PDK::CLI::ExitWithError, e end |
#write_file(dest_path) ⇒ void
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
This method returns an undefined value.
Write the result of the block to disk.
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/pdk/generate/puppet_object.rb', line 170 def write_file(dest_path) PDK.logger.info(_("Creating '%{file}' from template.") % { file: dest_path }) file_content = yield begin FileUtils.mkdir_p(File.dirname(dest_path)) rescue SystemCallError => e raise PDK::CLI::FatalError, _("Unable to create directory '%{path}': %{message}") % { path: File.dirname(dest_path), message: e., } end PDK::Util::Filesystem.write_file(dest_path, file_content) rescue SystemCallError => e raise PDK::CLI::FatalError, _("Unable to write to file '%{path}': %{message}") % { path: dest_path, message: e., } end |