Class: OpenC3::CliGenerator

Inherits:
Object show all
Defined in:
lib/openc3/utilities/cli_generator.rb

Constant Summary collapse

GENERATORS = 
%w(plugin target microservice conversion limits_response)
TEMPLATES_DIR = 
"#{File.dirname(__FILE__)}/../../../templates"

Class Method Summary collapse

Class Method Details

.check_args(args) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/openc3/utilities/cli_generator.rb', line 33

def self.check_args(args)
  args.each do |arg|
    if arg =~ /\s/
      abort("#{args[0].capitalize} arguments can not have spaces!")
    end
  end
  # All generators except 'plugin' must be within an existing plugin
  if args[0] != 'plugin' and Dir.glob("*.gemspec").empty?
    abort("No gemspec file detected. #{args[0].capitalize} generator should be run within an existing plugin.")
  end
end

.generate(args) ⇒ Object

Called by openc3cli with ARGV



25
26
27
28
29
30
31
 
# File 'lib/openc3/utilities/cli_generator.rb', line 25

def self.generate(args)
  unless GENERATORS.include?(args[0])
    abort("Unknown generator '#{args[0]}'. Valid generators: #{GENERATORS.join(', ')}")
  end
  check_args(args)
  send("generate_#{args[0]}", args)
end

.generate_conversion(args) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/openc3/utilities/cli_generator.rb', line 152

def self.generate_conversion(args)
  if args.length != 3
    abort("Usage: cli generate conversion <TARGET> <NAME>")
  end

  # Create the local variables
  target_name = args[1].upcase
  unless File.exist?("targets/#{target_name}")
    abort("Target '#{target_name}' does not exist! Conversions must be created for existing targets.")
  end
  conversion_name = "#{args[2].upcase.gsub(/_+|-+/, '_')}_CONVERSION"
  conversion_path = "targets/#{target_name}/lib/"
  conversion_basename = "#{conversion_name.downcase}.rb"
  conversion_class = conversion_basename.filename_to_class_name
  conversion_filename = "targets/#{target_name}/lib/#{conversion_basename}"
  if File.exist?(conversion_filename)
    abort("Conversion #{conversion_filename} already exists!")
  end

  process_template("#{TEMPLATES_DIR}/conversion", binding) do |filename|
    filename.sub!("conversion.rb", conversion_filename)
  end

  puts "Conversion #{conversion_filename} successfully generated!"
  puts "To use the conversion add the following to a telemetry item:"
  puts "  READ_CONVERSION #{conversion_basename}"
  return conversion_name
end

.generate_limits_response(args) ⇒ Object 



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
207
208
 
# File 'lib/openc3/utilities/cli_generator.rb', line 181

def self.generate_limits_response(args)
  if args.length != 3
    abort("Usage: cli generate limits_response <TARGET> <NAME>")
  end

  # Create the local variables
  target_name = args[1].upcase
  unless File.exist?("targets/#{target_name}")
    abort("Target '#{target_name}' does not exist! Limits responses must be created for existing targets.")
  end
  response_name = "#{args[2].upcase.gsub(/_+|-+/, '_')}_LIMITS_RESPONSE"
  response_path = "targets/#{target_name}/lib/"
  response_basename = "#{response_name.downcase}.rb"
  response_class = response_basename.filename_to_class_name
  response_filename = "targets/#{target_name}/lib/#{response_basename}"
  if File.exist?(response_filename)
    abort("response #{response_filename} already exists!")
  end

  process_template("#{TEMPLATES_DIR}/limits_response", binding) do |filename|
    filename.sub!("response.rb", response_filename)
  end

  puts "Limits response #{response_filename} successfully generated!"
  puts "To use the limits response add the following to a telemetry item:"
  puts "  LIMITS_RESPONSE #{response_basename}"
  return response_name
end

.generate_microservice(args) ⇒ Object 



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
 
# File 'lib/openc3/utilities/cli_generator.rb', line 119

def self.generate_microservice(args)
  if args.length != 2
    abort("Usage: cli generate #{args[0]} <NAME>")
  end

  # Create the local variables
  microservice_name = args[1].upcase.gsub(/_+|-+/, '_')
  microservice_path = "microservices/#{microservice_name}"
  if File.exist?(microservice_path)
    abort("Microservice #{microservice_path} already exists!")
  end
  microservice_filename = "#{microservice_name.downcase}.rb"
  microservice_class = microservice_filename.filename_to_class_name

  process_template("#{TEMPLATES_DIR}/microservice", binding) do |filename|
    # Rename the template MICROSERVICE to our actual microservice name
    filename.sub!("microservices/TEMPLATE", "microservices/#{microservice_name}")
    filename.sub!("microservice.rb", microservice_filename)
  end

  # Add this microservice to plugin.txt
  File.open("plugin.txt", 'a') do |file|
    file.puts "\n      MICROSERVICE \#{microservice_name} \#{microservice_name.downcase.gsub('_','-')}-microservice\n        CMD ruby \#{microservice_name.downcase}.rb\n    DOC\n  end\n\n  puts \"Microservice \#{microservice_name} successfully generated!\"\n  return microservice_name\nend\n"

.generate_plugin(args) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/openc3/utilities/cli_generator.rb', line 60

def self.generate_plugin(args)
  if args.length != 2
    abort("Usage: cli generate #{args[0]} <NAME>")
  end

  # Create the local variables
  plugin = args[1].downcase.gsub(/_+|-+/, '-')
  plugin_name = "openc3-cosmos-#{plugin}"
  if File.exist?(plugin_name)
    abort("Plugin #{plugin_name} already exists!")
  end
  FileUtils.mkdir(plugin_name)
  Dir.chdir(plugin_name) # Change to the plugin path to make copying easier

  process_template("#{TEMPLATES_DIR}/plugin", binding) do |filename|
    filename.sub!("plugin.gemspec", "#{plugin_name}.gemspec")
  end

  puts "Plugin #{plugin_name} successfully generated!"
  return plugin_name
end

.generate_target(args) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/openc3/utilities/cli_generator.rb', line 82

def self.generate_target(args)
  if args.length != 2
    abort("Usage: cli generate #{args[0]} <NAME>")
  end

  # Create the local variables
  target_name = args[1].upcase.gsub(/_+|-+/, '_')
  target_path = "targets/#{target_name}"
  if File.exist?(target_path)
    abort("Target #{target_path} already exists!")
  end
  target_lib_filename = "#{target_name.downcase}.rb"
  target_class = target_lib_filename.filename_to_class_name
  target_object = target_name.downcase

  process_template("#{TEMPLATES_DIR}/target", binding) do |filename|
    # Rename the template TARGET to our actual target named after the plugin
    filename.sub!("targets/TARGET", "targets/#{target_name}")
    filename.sub!("target.rb", target_lib_filename)
  end

  # Add this target to plugin.txt
  File.open("plugin.txt", 'a') do |file|
    file.puts "\n      VARIABLE \#{target_name.downcase}_target_name \#{target_name}\n\n      TARGET \#{target_name} <%= \#{target_name.downcase}_target_name %>\n      INTERFACE <%= \#{target_name.downcase}_target_name %>_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST\n        MAP_TARGET <%= \#{target_name.downcase}_target_name %>\n    DOC\n  end\n\n  puts \"Target \#{target_name} successfully generated!\"\n  return target_name\nend\n"

.process_template(template_dir, the_binding) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/openc3/utilities/cli_generator.rb', line 45

def self.process_template(template_dir, the_binding)
  Dir.glob("#{template_dir}/**/*").each do |file|
    base_name = file.sub("#{template_dir}/", '')
    yield base_name
    if File.directory?(file)
      FileUtils.mkdir(base_name)
      next
    end
    output = ERB.new(File.read(file), trim_mode: "-").result(the_binding)
    File.open(base_name, 'w') do |file|
      file.write output
    end
  end
end