Allow callouts to be wrapped (when used in XML)

Author: xrd

lib/oreilly/snippets.rb

@@ -25,8 +25,19 @@ def self.get_content_from_file( s )
       flatten = s[:flatten]
       normcallouts = s[:normcallouts] 
       callouts_prefix = s[:callouts_prefix]
+      callouts_wrap = s[:callouts_wrap]
       callouts = s[:callouts]
 
+      if callouts_wrap
+        if callouts_prefix
+          raise "Cannot use both callout prefix and wrap together"
+        end
+
+        if -1 == callouts_wrap.index( '{x}' )
+          raise "Improper use of callouts: needs to be like '<!-- {x} -->' ('{x}' must be a placeholder)" 
+        end
+      end
+
       contents = nil
       line_numbers = nil
       error = false
@@ -74,7 +85,7 @@ def self.get_content_from_file( s )
       end
 
       if callouts
-        rv = process_callouts( rv, callouts, callouts_prefix )
+        rv = process_callouts( rv, callouts, callouts_prefix, callouts_wrap )
       elsif normcallouts
         rv = normalize_callouts( rv )
       end
@@ -84,7 +95,7 @@ def self.get_content_from_file( s )
       rv
     end
 
-    def self.process_callouts( input, callouts, comment_character = nil )
+    def self.process_callouts( input, callouts, comment_character = nil, wrap = nil )
       rv = nil
       # Strip them out and figure out the comment character
       rv = input.gsub( /([#\/]\/?) ?<\d+>/ ) { |c| comment_character ||= $1; '' }
@@ -107,7 +118,17 @@ def self.process_callouts( input, callouts, comment_character = nil )
         lines = rv.split /\n/
         list.each_with_index do |c,i|
           index = c.to_i - 1
-          lines[index] += "#{comment_character} <#{i+1}>" if lines.length > index and index >= 0
+
+          if lines.length > index and index >= 0
+            callout = nil
+            if wrap
+              callout = wrap.gsub( '{x}', "<#{i+1}>" )
+            else
+              callout = "#{comment_character} <#{i+1}>" 
+            end
+
+            lines[index] += callout
+          end
         end
         rv = lines.join "\n"
       end

lib/oreilly/snippets/version.rb

@@ -1,5 +1,5 @@
 module Oreilly
   module Snippets
-    VERSION = "0.0.17"
+    VERSION = "0.0.18"
   end
 end

spec/fixtures/some.xml

@@ -0,0 +1,5 @@
+<xml>
+  <item>
+    <something attr="attr1"/>
+  </item>
+</xml>

spec/process_spec.rb

@@ -87,6 +87,28 @@
 snippet~~~~
 END
 
+CALLOUTS_WRAP_AND_PREFIX_JS = <<"END"
+[filename="spec/fixtures/normalize_callouts_long.js", callouts_prefix="#", callouts_wrap="# {1} #", callouts="1,10,15"]
+snippet~~~~
+...
+snippet~~~~
+END
+
+CALLOUTS_WRAP_XML = <<"END"
+[filename="spec/fixtures/some.xml", callouts_wrap="<!-- {x} -->", callouts="1,2,3"]
+snippet~~~~
+...
+snippet~~~~
+END
+
+INVALID_CALLOUTS_WRAP_XML = <<"END"
+[filename="spec/fixtures/some.xml", callouts_wrap="<!-- no x! -->", callouts="1,2,3"]
+snippet~~~~
+...
+snippet~~~~
+END
+
+
 NORMALIZE_CALLOUTS_JS = <<"END"
 [filename="spec/fixtures/normalize_callouts.js", normcallouts="true"]
 snippet~~~~
@@ -296,6 +318,41 @@ def download_test_repository
         lines[14].should match( /# <3>/ )        
       end
 
+      it "should add a prefix character to a callout to makes sure the code is runnable" do
+        output = Oreilly::Snippets.process( CALLOUTS_PREFIX_JS )
+        lines = output.split /\n/ 
+        lines[0].should match( /# <1>/ )        
+        lines[9].should match( /# <2>/ )        
+        lines[14].should match( /# <3>/ )        
+      end
+
+      it "should properly wrap callouts" do
+        output = Oreilly::Snippets.process( CALLOUTS_WRAP_XML )
+        lines = output.split /\n/ 
+        lines[0].should match( /<!-- <1> -->/ )        
+        lines[1].should match( /<!-- <2> -->/ )        
+        lines[2].should match( /<!-- <3> -->/ )        
+      end
+
+      it "should raise an error when prefix and wrap are used together for callouts" do
+        lambda {
+          output = Oreilly::Snippets.process( CALLOUTS_WRAP_AND_PREFIX_JS )
+        }.should raise_error
+      end
+
+      it "should raise an error when wrap is misued" do
+        lambda {
+          output = Oreilly::Snippets.process( INVALID_CALLOUTS_WRAP_JS )
+        }.should raise_error
+      end
+
+      it "should raise an error when wrap is misued" do
+        lambda {
+          output = Oreilly::Snippets.process( CALLOUTS_WRAP_AND_PREFIX_JS )
+        }.should raise_error
+      end
+
+
       it "should add callouts using a default comment" do
         output = Oreilly::Snippets.process( REALLY_LONG_CALLOUTS_JS )
         lines = output.split /\n/