Class: PDK::Module::Convert

Inherits:
Object
  • Object
show all
Defined in:
lib/pdk/module/convert.rb

Direct Known Subclasses

Update

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Convert

Returns a new instance of Convert.



10
11
12
 
# File 'lib/pdk/module/convert.rb', line 10

def initialize(options = {})
  @options = options
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



8
9
10
 
# File 'lib/pdk/module/convert.rb', line 8

def options
  @options
end

Class Method Details

.invoke(options) ⇒ Object 



4
5
6
 
# File 'lib/pdk/module/convert.rb', line 4

def self.invoke(options)
  new(options).run
end

Instance Method Details

#add_tests! ⇒ Object 



102
103
104
105
106
 
# File 'lib/pdk/module/convert.rb', line 102

def add_tests!
  test_generators.each do |gen|
    gen.run if gen.can_run?
  end
end

#add_tests? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/pdk/module/convert.rb', line 77

def add_tests?
  options[:'add-tests']
end

#adding_tests? ⇒ Boolean

Returns:

  • (Boolean) 


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

def adding_tests?
  add_tests? && missing_tests?
end

#convert? ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/pdk/module/convert.rb', line 14

def convert?
  instance_of?(PDK::Module::Convert)
end

#force? ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/pdk/module/convert.rb', line 73

def force?
  options[:force]
end

#full_report(path) ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/pdk/module/convert.rb', line 249

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 



262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/pdk/module/convert.rb', line 262

def generate_banner(text, width = 80)
  padding = width - text.length
  banner = ''
  padding_char = '-'

  (padding / 2.0).ceil.times { banner << padding_char }
  banner << text
  (padding / 2.0).floor.times { banner << padding_char }

  banner
end

#missing_tests? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/pdk/module/convert.rb', line 85

def missing_tests?
  test_generators.any? { |gen| gen.can_run? }
end

#needs_bundle_update? ⇒ Boolean

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/pdk/module/convert.rb', line 108

def needs_bundle_update?
  update_manager.changed?('Gemfile')
end

#noop? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/pdk/module/convert.rb', line 69

def noop?
  options[:noop]
end

#print_result(banner_text) ⇒ Object 



241
242
243
244
245
246
247
 
# File 'lib/pdk/module/convert.rb', line 241

def print_result(banner_text)
  require 'pdk/report'

  PDK::Report.default_target.puts(_("\n%{banner}") % { banner: generate_banner(banner_text, 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 



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/pdk/module/convert.rb', line 225

def print_summary
  require 'pdk/report'

  footer = false

  summary.keys.each do |category|
    next if summary[category].empty?

    PDK::Report.default_target.puts(_("\n%{banner}") % { banner: generate_banner("Files to be #{category}", 40) })
    PDK::Report.default_target.puts(summary[category])
    footer = true
  end

  PDK::Report.default_target.puts(_("\n%{banner}") % { banner: generate_banner('', 40) }) if footer
end

#run ⇒ Object 



18
19
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
 
# File 'lib/pdk/module/convert.rb', line 18

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 



112
113
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
 
# File 'lib/pdk/module/convert.rb', line 112

def stage_changes!
  require 'pdk/module/templatedir'
  require 'pdk/util/filesystem'

  metadata_path = 'metadata.json'

  PDK::Module::TemplateDir.new(template_uri, nil, true) do |templates|
    new_metadata = update_metadata(metadata_path, templates.metadata)
    templates.module_metadata = new_metadata.data unless new_metadata.nil?

    if options[:noop] && new_metadata.nil?
      update_manager.add_file(metadata_path, '')
    elsif PDK::Util::Filesystem.file?(metadata_path)
      update_manager.modify_file(metadata_path, new_metadata.to_json)
    else
      update_manager.add_file(metadata_path, new_metadata.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 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/pdk/module/convert.rb', line 206

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 



159
160
161
162
163
 
# File 'lib/pdk/module/convert.rb', line 159

def template_uri
  require 'pdk/util/template_uri'

  @template_uri ||= PDK::Util::TemplateURI.new(options)
end

#test_generators ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/pdk/module/convert.rb', line 89

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 



153
154
155
156
157
 
# File 'lib/pdk/module/convert.rb', line 153

def update_manager
  require 'pdk/module/update_manager'

  @update_manager ||= PDK::Module::UpdateManager.new
end

#update_metadata(metadata_path, template_metadata) ⇒ Object 



165
166
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
 
# File 'lib/pdk/module/convert.rb', line 165

def update_metadata(metadata_path, template_metadata)
  require 'pdk/generate/module'
  require 'pdk/util/filesystem'
  require 'pdk/module/metadata'

  if PDK::Util::Filesystem.file?(metadata_path)
    unless PDK::Util::Filesystem.readable?(metadata_path)
      raise PDK::CLI::ExitWithError, _('Unable to update module metadata; %{path} exists but it is not readable.') % {
        path: metadata_path,
      }
    end

    begin
      metadata = PDK::Module::Metadata.from_file(metadata_path)
      new_values = PDK::Module::Metadata::DEFAULTS.select do |key, _|
        !metadata.data.key?(key) || metadata.data[key].nil? ||
          (key == 'requirements' && metadata.data[key].empty?)
      end
      metadata.update!(new_values)
    rescue ArgumentError
      metadata = PDK::Generate::Module.prepare_metadata(options) unless options[:noop]
    end
  elsif PDK::Util::Filesystem.exist?(metadata_path)
    raise PDK::CLI::ExitWithError, _('Unable to update module metadata; %{path} exists but it is not a file.') % {
      path: metadata_path,
    }
  else
    return if options[:noop]

    project_dir = File.basename(Dir.pwd)
    options[:module_name] = project_dir.split('-', 2).compact[-1]
    options[:prompt] = false
    options[:'skip-interview'] = true if options[:force]

    metadata = PDK::Generate::Module.prepare_metadata(options)
  end

  metadata.update!(template_metadata)
  metadata
end