Markup agnostic extra files

lib/yard/code_objects/extra_file_object.rb

@@ -80,7 +80,8 @@ def ensure_parsed
     # @param [String] data the file contents
     def parse_contents(data)
       retried = false
-      cut_index = 0
+      cut_index_begin = 0
+      cut_index_end = 0
       data = translate(data)
       data = data.split("\n")
       data.each_with_index do |line, index|
@@ -89,19 +90,21 @@ def parse_contents(data)
           if index == 0
             attributes[:markup] = $1
           else
-            cut_index = index
+            cut_index_end = index
             break
           end
         when /^\s*#\s*@(\S+)\s*(.+?)\s*$/
           attributes[$1] = $2
-        when /^\s*<!--\s*$/, /^\s*-->\s*$/
-          # Ignore HTML comments
         else
-          cut_index = index
-          break
+          if index == 0
+            cut_index_begin = 1
+          else
+            cut_index_end = index
+            break
+          end
         end
       end
-      data = data[cut_index..-1] if cut_index > 0
+      data[cut_index_begin...cut_index_end] = [] if cut_index_end > cut_index_begin
       contents = data.join("\n")
 
       if contents.respond_to?(:force_encoding) && attributes[:encoding]

spec/code_objects/extra_file_object_spec.rb

@@ -38,13 +38,25 @@
     it "allows the attributes section to be wrapped in an HTML comment" do
       file = ExtraFileObject.new('file.txt', "<!--\n# @title X\n-->\nFOO BAR")
       expect(file.attributes[:title]).to eq "X"
-      expect(file.contents).to eq "FOO BAR"
+      expect(file.contents).to eq "<!--\n-->\nFOO BAR"
     end
 
     it "allows whitespace around ignored HTML comment" do
       file = ExtraFileObject.new('file.txt', " \t <!-- \n# @title X\n \t --> \nFOO BAR")
       expect(file.attributes[:title]).to eq "X"
-      expect(file.contents).to eq "FOO BAR"
+      expect(file.contents).to eq " \t <!-- \n \t --> \nFOO BAR"
+    end
+
+    it "allows the attributes section to be wrapped in an AsciiDoc comment" do
+      file = ExtraFileObject.new('file.txt', "````\n# @title X\n````\nFOO BAR")
+      expect(file.attributes[:title]).to eq "X"
+      expect(file.contents).to eq "````\n````\nFOO BAR"
+    end
+
+    it "allows the attributes section to be wrapped in a Textile comment" do
+      file = ExtraFileObject.new('file.txt', "###.\n# @title X\n\nFOO BAR")
+      expect(file.attributes[:title]).to eq "X"
+      expect(file.contents).to eq "###.\n\nFOO BAR"
     end
 
     it "parses out old-style #!markup shebang format" do
@@ -58,10 +70,10 @@
       expect(file.contents).to eq " #!foobar\nHello"
     end
 
-    it "does not parse out attributes if there are newlines prior to attributes" do
-      file = ExtraFileObject.new('file.txt', "\n# @title\nFOO BAR")
+    it "does not parse out attributes if there are at least two newlines prior to attributes" do
+      file = ExtraFileObject.new('file.txt', "\n\n# @title\nFOO BAR")
       expect(file.attributes).to be_empty
-      expect(file.contents).to eq "\n# @title\nFOO BAR"
+      expect(file.contents).to eq "\n\n# @title\nFOO BAR"
     end
 
     it "sets contents to data after attributes" do