Comment out ERB

openc3/lib/openc3/config/config_parser.rb

@@ -166,7 +166,7 @@ def render(template_name, options = {})
         options[:locals].each { |key, value| b.local_variable_set(key, value) }
       end
 
-      return ERB.new(read_file(template_name), trim_mode: "-").result(b)
+      return ERB.new(read_file(template_name).comment_erb(), trim_mode: "-").result(b)
     end
 
     # Can be called during parsing to read a referenced file
@@ -385,7 +385,7 @@ def create_parsed_output_file(filename, run_erb, variables)
         output = nil
         if run_erb
           OpenC3.set_working_dir(File.dirname(filename)) do
-            output = ERB.new(File.read(filename), trim_mode: "-").result(binding.set_variables(variables))
+            output = ERB.new(File.read(filename).comment_erb(), trim_mode: "-").result(binding.set_variables(variables))
           end
         else
           output = File.read(filename)

openc3/lib/openc3/config/meta_config_parser.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'erb'

openc3/lib/openc3/core_ext/string.rb

@@ -389,4 +389,20 @@ def to_utf8!
     end
   end
 
-end # class String
+  def comment_erb
+    # Split with -1 to avoid stripping empty strings
+    output = self.split("\n", -1).collect! do |line|
+      # If we have a commented out line that starts with #
+      # but not followed by % (allows for disabling ERB comments),
+      # which contains an ERB statement (<% ...)
+      # then comment out the ERB statement (<%# ...).
+      # We explicitly don't comment out trailing ERB statements
+      # as that is not typical and is difficult to regex
+      if line.strip() =~ /^#[^%]*<%/
+        line.gsub!('<%', '<%#')
+      end
+      line.chomp
+    end
+    return output.join("\n")
+  end
+end

openc3/lib/openc3/models/microservice_model.rb

@@ -221,7 +221,7 @@ def deploy(gem_path, variables, validate_only: false)
         # Load microservice files
         data = File.read(filename, mode: "rb")
         OpenC3.set_working_dir(File.dirname(filename)) do
-          data = ERB.new(data, trim_mode: "-").result(binding.set_variables(variables)) if data.is_printable? and File.basename(filename)[0] != '_'
+          data = ERB.new(data.comment_erb(), trim_mode: "-").result(binding.set_variables(variables)) if data.is_printable? and File.basename(filename)[0] != '_'
         end
         unless validate_only
           @bucket.put_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: key, body: data)

openc3/lib/openc3/models/target_model.rb

@@ -563,7 +563,9 @@ def deploy(gem_path, variables, validate_only: false)
           data = File.read(filename, mode: "rb")
           begin
             OpenC3.set_working_dir(File.dirname(filename)) do
-              data = ERB.new(data, trim_mode: "-").result(binding.set_variables(variables)) if data.is_printable? and File.basename(filename)[0] != '_'
+              if data.is_printable? and File.basename(filename)[0] != '_'
+                data = ERB.new(data.comment_erb(), trim_mode: "-").result(binding.set_variables(variables))
+              end
             end
           rescue => error
             # ERB error parsing a screen is just a logger error because life can go on
@@ -673,7 +675,7 @@ def render(template_name, options = {})
 
       begin
         OpenC3.set_working_dir(File.dirname(path)) do
-          return ERB.new(File.read(path), trim_mode: "-").result(b)
+          return ERB.new(File.read(path.comment_erb()), trim_mode: "-").result(b)
         end
       rescue => error
         raise "ERB error parsing: #{path}: #{error.formatted}"

openc3/lib/openc3/models/tool_model.rb

@@ -240,7 +240,7 @@ def deploy(gem_path, variables, validate_only: false)
 
         # Load tool files
         data = File.read(filename, mode: "rb")
-        data = ERB.new(data, trim_mode: "-").result(binding.set_variables(variables)) if data.is_printable?
+        data = ERB.new(data.comment_erb(), trim_mode: "-").result(binding.set_variables(variables)) if data.is_printable?
         unless validate_only
           client = Bucket.getClient()
           cache_control = BucketUtilities.get_cache_control(filename)

openc3/lib/openc3/models/widget_model.rb

@@ -124,7 +124,7 @@ def deploy(gem_path, variables, validate_only: false)
       # Load widget file
       data = File.read(filename, mode: "rb")
       OpenC3.set_working_dir(File.dirname(filename)) do
-        data = ERB.new(data, trim_mode: "-").result(binding.set_variables(variables)) if data.is_printable?
+        data = ERB.new(data.comment_erb(), trim_mode: "-").result(binding.set_variables(variables)) if data.is_printable?
       end
       unless validate_only
         cache_control = BucketUtilities.get_cache_control(@filename)

openc3/lib/openc3/utilities/cli_generator.rb

@@ -51,7 +51,7 @@ def self.process_template(template_dir, the_binding)
           FileUtils.mkdir(base_name) unless File.exist?(base_name)
           next
         end
-        output = ERB.new(File.read(file), trim_mode: "-").result(the_binding)
+        output = ERB.new(File.read(file).comment_erb(), trim_mode: "-").result(the_binding)
         File.open(base_name, 'w') do |file|
           file.write output
         end

openc3/spec/config/config_parser_spec.rb

@@ -79,6 +79,23 @@ module OpenC3
         tf.unlink
       end
 
+      it "ignores commented out ERB syntax" do
+        tf = Tempfile.new('unittest')
+        tf.puts "# KEYWORD <%= raise 'boom' %>"
+        tf.puts "# <%= render '_ccsds_cmd.txt', locals: {id: 4} %>"
+        tf.puts "# KEYWORD <% if true %>"
+        tf.puts "# KEYWORD <% raise 'dead' %>"
+        tf.puts "# KEYWORD <% end %>"
+        tf.puts "OTHER stuff"
+        tf.close
+
+        @cp.parse_file(tf.path) do |keyword, params|
+          expect(keyword).to eql "OTHER"
+          expect(params[0]).to eql "stuff"
+        end
+        tf.unlink
+      end
+
       it "requires ERB partials begin with an underscore" do
         tf = Tempfile.new('unittest')
         tf.puts "<%= render 'partial.txt' %>"

openc3/spec/core_ext/string_spec.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'spec_helper'
@@ -296,6 +296,55 @@
       expect(output.length).to eql 3
       expect(output.force_encoding('ASCII-8BIT')).to eql "\xC2\xB0\xE2\x84\xA2\xE2\x80\xA6"
     end
+  end
 
+  describe "comment_erb" do
+    it "comments out ERB syntax" do
+      input = "\n<%= ERB1 %>\n\n"
+      input += "#<% ERB2 %>\n"
+      input += "\n # <% ERB3 %>\n"
+      input += "test # <% ERB4 %>\n"
+      input += "puts \"\#{test} <%= ERB5 %>\"\n\n"
+      input += " #puts \"\#{test} <%= ERB6 %>\"\n"
+      input += "#\{ <%= ERB7 %>\n\n"
+      input += "#% <% ERB8 %>\n"
+
+      output = "\n<%= ERB1 %>\n\n" # normal no ERB comment
+      output += "#<%# ERB2 %>\n" # ERB comment
+      output += "\n # <%# ERB3 %>\n" # ERB comment
+      output += "test # <% ERB4 %>\n" # trailing, no ERB comment
+      # string interpolation #{} code, no ERB comment
+      output += "puts \"\#{test} <%= ERB5 %>\"\n\n"
+      output += " #puts \"\#{test} <%#= ERB6 %>\"\n" # ERB comment
+      output += "#\{ <%#= ERB7 %>\n\n" # ERB comment
+      output += "#% <% ERB8 %>\n" # Special #% comment, no ERB comment
+
+      expect(input.comment_erb()).to eql output
+    end
   end
+
+  # require 'benchmark'
+  # input = "HI"
+  # 10000.times do |x|
+  #   input += "this is a very long line that will be part of the code that we look at\n"
+  #   if x % 10 == 0
+  #     input += "# <%= 'ERB input' %>\n"
+  #   end
+  # end
+  # File.open('test.txt', 'w') do |file|
+  #   file.write(input.comment_erb())
+  # end
+  # Benchmark.bm do |x|
+  #   x.report do
+  #     input.comment_erb()
+  #   end
+  #   x.report do
+  #     input
+  #   end
+  # end
+  # Macbook Air M2 results:
+  # bundle exec rspec spec/core_ext/string_spec.rb
+  #      user     system      total        real
+  #  0.004457   0.000286   0.004743 (  0.004743)
+  #  0.000002   0.000001   0.000003 (  0.000002)
 end