Merge pull request #1495 from OpenC3/accessor_escape

Better escaping in TemplateAccessor

openc3/lib/openc3/accessors/template_accessor.rb

@@ -38,21 +38,18 @@ def configure
       # Convert the template into a Regexp for reading each item
       template = @packet.template.dup
       template_items = template.scan(Regexp.new("#{escaped_left_char}.*?#{escaped_right_char}"))
-      escaped_read_template = template
-      if @left_char != '('
-        escaped_read_template = escaped_read_template.gsub('(', '\(')
-      end
-      if @right_char != ')'
-        escaped_read_template = escaped_read_template.gsub(')', '\)')
-      end
+      escaped_read_template = Regexp.escape(template)
 
       @item_keys = []
       template_items.each do |item|
         @item_keys << item[1..-2]
+        # If they're using parens we have to escape them
+        # since we're working with the already escaped template
+        item = "\\#{item}" if @left_char == '('
+        item = "#{item[0..-2]}\\)" if @right_char == ')'
         escaped_read_template.gsub!(item, "(.*)")
       end
       @read_regexp = Regexp.new(escaped_read_template)
-
       @configured = true
     end
 

openc3/spec/accessors/template_accessor_spec.rb

@@ -34,6 +34,36 @@ module OpenC3
     end
 
     describe "read_item and read_items" do
+      it "should escape regexp chars" do
+        packet = Packet.new
+        packet.template = 'VOLT <VOLTAGE>, ($1); VOLT? (+1)'
+        data = 'VOLT 5, ($1); VOLT? (+1)'
+        accessor = TemplateAccessor.new(packet)
+        packet.buffer = data
+
+        item1 = OpenStruct.new
+        item1.name = 'VOLTAGE'
+        item1.key = 'VOLTAGE'
+        item1.data_type = :FLOAT
+        value = accessor.read_item(item1, packet.buffer(false))
+        expect(value).to eq 5.0
+      end
+
+      it "should allow different delimiters" do
+        packet = Packet.new
+        packet.template = 'VOLT (VOLTAGE), *1.0; VOLT? *1.0'
+        data = 'VOLT 5, *1.0; VOLT? *1.0'
+        accessor = TemplateAccessor.new(packet, '(', ')')
+        packet.buffer = data
+
+        item1 = OpenStruct.new
+        item1.name = 'VOLTAGE'
+        item1.key = 'VOLTAGE'
+        item1.data_type = :FLOAT
+        value = accessor.read_item(item1, packet.buffer(false))
+        expect(value).to eq 5.0
+      end
+
       it "should read values" do
         accessor = TemplateAccessor.new(@packet)
         @packet.buffer = @data