Class: PDK::Module::Convert
- Inherits:
-
Object
- Object
- PDK::Module::Convert
- Defined in:
- lib/pdk/module/convert.rb
Direct Known Subclasses
Instance Attribute Summary collapse
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Class Method Summary collapse
Instance Method Summary collapse
- #add_tests! ⇒ Object
- #add_tests? ⇒ Boolean
- #adding_tests? ⇒ Boolean
- #convert? ⇒ Boolean
- #force? ⇒ Boolean
- #full_report(path) ⇒ Object
- #generate_banner(text, width = 80) ⇒ Object
-
#initialize(options = {}) ⇒ Convert
constructor
A new instance of Convert.
- #missing_tests? ⇒ Boolean
- #needs_bundle_update? ⇒ Boolean
- #noop? ⇒ Boolean
- #print_result(banner_text) ⇒ Object
- #print_summary ⇒ Object
- #run ⇒ Object
- #stage_changes! ⇒ Object
- #summary ⇒ Object
- #template_uri ⇒ Object
- #test_generators ⇒ Object
- #update_manager ⇒ Object
- #update_metadata(metadata_path, template_metadata) ⇒ Object
Constructor Details
#initialize(options = {}) ⇒ Convert
Returns a new instance of Convert.
12 13 14 |
# File 'lib/pdk/module/convert.rb', line 12 def initialize( = {}) @options = end |
Instance Attribute Details
#options ⇒ Object (readonly)
Returns the value of attribute options.
10 11 12 |
# File 'lib/pdk/module/convert.rb', line 10 def @options end |
Class Method Details
.invoke(options) ⇒ Object
6 7 8 |
# File 'lib/pdk/module/convert.rb', line 6 def self.invoke() new().run end |
Instance Method Details
#add_tests! ⇒ Object
104 105 106 107 108 |
# File 'lib/pdk/module/convert.rb', line 104 def add_tests! test_generators.each do |gen| gen.run if gen.can_run? end end |
#add_tests? ⇒ Boolean
79 80 81 |
# File 'lib/pdk/module/convert.rb', line 79 def add_tests? [:'add-tests'] end |
#adding_tests? ⇒ Boolean
83 84 85 |
# File 'lib/pdk/module/convert.rb', line 83 def adding_tests? add_tests? && missing_tests? end |
#convert? ⇒ Boolean
16 17 18 |
# File 'lib/pdk/module/convert.rb', line 16 def convert? instance_of?(PDK::Module::Convert) end |
#force? ⇒ Boolean
75 76 77 |
# File 'lib/pdk/module/convert.rb', line 75 def force? [:force] end |
#full_report(path) ⇒ Object
251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/pdk/module/convert.rb', line 251 def full_report(path) require 'pdk/report' File.open(path, 'w') do |f| f.write("/* Report generated by PDK at #{Time.now} */") update_manager.changes[:modified].each do |_, diff| f.write("\n\n\n" + diff) end f.write("\n") end PDK::Report.default_target.puts(_("\nYou can find a report of differences in %{path}.\n\n") % { path: path }) end |
#generate_banner(text, width = 80) ⇒ Object
264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/pdk/module/convert.rb', line 264 def (text, width = 80) padding = width - text.length = '' padding_char = '-' (padding / 2.0).ceil.times { << padding_char } << text (padding / 2.0).floor.times { << padding_char } end |
#missing_tests? ⇒ Boolean
87 88 89 |
# File 'lib/pdk/module/convert.rb', line 87 def missing_tests? test_generators.any? { |gen| gen.can_run? } end |
#needs_bundle_update? ⇒ Boolean
110 111 112 |
# File 'lib/pdk/module/convert.rb', line 110 def needs_bundle_update? update_manager.changed?('Gemfile') end |
#noop? ⇒ Boolean
71 72 73 |
# File 'lib/pdk/module/convert.rb', line 71 def noop? [:noop] end |
#print_result(banner_text) ⇒ Object
243 244 245 246 247 248 249 |
# File 'lib/pdk/module/convert.rb', line 243 def print_result() require 'pdk/report' PDK::Report.default_target.puts(_("\n%{banner}") % { banner: (, 40) }) summary_to_print = summary.map { |k, v| "#{v.length} files #{k}" unless v.empty? }.compact PDK::Report.default_target.puts(_("\n%{summary}\n\n") % { summary: "#{summary_to_print.join(', ')}." }) end |
#print_summary ⇒ Object
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/pdk/module/convert.rb', line 227 def print_summary require 'pdk/report' = false summary.keys.each do |category| next if summary[category].empty? PDK::Report.default_target.puts(_("\n%{banner}") % { banner: ("Files to be #{category}", 40) }) PDK::Report.default_target.puts(summary[category]) = true end PDK::Report.default_target.puts(_("\n%{banner}") % { banner: ('', 40) }) if end |
#run ⇒ Object
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 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/pdk/module/convert.rb', line 20 def run stage_changes! unless update_manager.changes? if adding_tests? add_tests! else require 'pdk/report' PDK::Report.default_target.puts(_('No changes required.')) end return end print_summary full_report('convert_report.txt') unless update_manager.changes[:modified].empty? return if noop? unless force? require 'pdk/cli/util' PDK.logger.info _( 'Module conversion is a potentially destructive action. ' \ 'Ensure that you have committed your module to a version control ' \ 'system or have a backup, and review the changes above before continuing.', ) continue = PDK::CLI::Util.prompt_for_yes(_('Do you want to continue and make these changes to your module?')) return unless continue end # Remove these files straight away as these changes are not something that the user needs to review. if needs_bundle_update? update_manager.unlink_file('Gemfile.lock') update_manager.unlink_file(File.join('.bundle', 'config')) end update_manager.sync_changes! if needs_bundle_update? require 'pdk/util/bundler' PDK::Util::Bundler.ensure_bundle! end add_tests! if adding_tests? print_result 'Convert completed' end |
#stage_changes! ⇒ Object
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/pdk/module/convert.rb', line 114 def stage_changes! require 'pdk/module/templatedir' require 'pdk/util/filesystem' = 'metadata.json' PDK::Module::TemplateDir.new(template_uri, nil, true) do |templates| = (, templates.) templates. = .data unless .nil? if [:noop] && .nil? update_manager.add_file(, '') elsif PDK::Util::Filesystem.file?() update_manager.modify_file(, .to_json) else update_manager.add_file(, .to_json) end templates.render do |file_path, file_content, file_status| case file_status when :unmanage PDK.logger.debug(_("skipping '%{path}'") % { path: file_path }) when :delete update_manager.remove_file(file_path) when :init if convert? && !PDK::Util::Filesystem.exist?(file_path) update_manager.add_file(file_path, file_content) end when :manage if PDK::Util::Filesystem.exist?(file_path) update_manager.modify_file(file_path, file_content) else update_manager.add_file(file_path, file_content) end end end end rescue ArgumentError => e raise PDK::CLI::ExitWithError, e end |
#summary ⇒ Object
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/pdk/module/convert.rb', line 208 def summary summary = {} update_manager.changes.each do |category, update_category| if update_category.respond_to?(:keys) updated_files = update_category.keys else begin updated_files = update_category.map { |file| file[:path] } rescue TypeError updated_files = update_category.to_a end end summary[category] = updated_files end summary end |
#template_uri ⇒ Object
161 162 163 164 165 |
# File 'lib/pdk/module/convert.rb', line 161 def template_uri require 'pdk/util/template_uri' @template_uri ||= PDK::Util::TemplateURI.new() end |
#test_generators ⇒ Object
91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/pdk/module/convert.rb', line 91 def test_generators return @test_generators unless @test_generators.nil? require 'pdk/util/puppet_strings' test_gens = PDK::Util::PuppetStrings.all_objects.map do |generator, objects| (objects || []).map do |obj| generator.new(Dir.pwd, obj['name'], spec_only: true) end end @test_generators = test_gens.flatten end |
#update_manager ⇒ Object
155 156 157 158 159 |
# File 'lib/pdk/module/convert.rb', line 155 def update_manager require 'pdk/module/update_manager' @update_manager ||= PDK::Module::UpdateManager.new end |
#update_metadata(metadata_path, template_metadata) ⇒ Object
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/pdk/module/convert.rb', line 167 def (, ) require 'pdk/generate/module' require 'pdk/util/filesystem' require 'pdk/module/metadata' if PDK::Util::Filesystem.file?() unless PDK::Util::Filesystem.readable?() raise PDK::CLI::ExitWithError, _('Unable to update module metadata; %{path} exists but it is not readable.') % { path: , } end begin = PDK::Module::Metadata.from_file() new_values = PDK::Module::Metadata::DEFAULTS.select do |key, _| !.data.key?(key) || .data[key].nil? || (key == 'requirements' && .data[key].empty?) end .update!(new_values) rescue ArgumentError = PDK::Generate::Module.() unless [:noop] end elsif PDK::Util::Filesystem.exist?() raise PDK::CLI::ExitWithError, _('Unable to update module metadata; %{path} exists but it is not a file.') % { path: , } else return if [:noop] project_dir = File.basename(Dir.pwd) [:module_name] = project_dir.split('-', 2).compact[-1] [:prompt] = false [:'skip-interview'] = true if [:force] = PDK::Generate::Module.() end .update!() end |