Add normalization of callouts

Author: xrd

README.md

@@ -145,13 +145,22 @@ If you want the default to be to flatten (avoiding setting it each
 snippet declaration), you can set that using the config method: `Oreilly::Snippets.config( flatten: true )` 
 
 At the moment, flattening does not work perfectly for Java files. You can ignore java with `Oreilly::Snippets.config( flatten: true, skip_flattening: { java: true } )` 
+
 #### Incompatibilities with Atlas from O'Reilly
 
 NB: This format of snippets is not currently compatible with Atlas
 from O'Reilly. However, you can always process the snippet and write
 out a normal Asciidoc file, a file which will be compatible with
 Atlas. See below for an example using Guard.
 
+### Normalizing Callouts
+
+If you use callouts, you might run into a situation where you write 10
+of them inside a snippet, and then you break that snippet into
+two. Your second snippet will have callouts 6-10. If you specify
+`normcallouts="true"` in your snippet, this module will rewrite those to
+start from 1. 
+
 ### Using with Guard and live-reload
 
 One nice workflow is to edit files in your editor, then have guard

lib/oreilly/snippets.rb

@@ -15,7 +15,7 @@ def self.config( opts )
       @@_config.merge!( opts )
     end
 
-    def self.get_content_from_file( spec, identifier, language, sha=nil, numbers=nil, flatten=false )
+    def self.get_content_from_file( spec, identifier, language, sha=nil, numbers=nil, flatten=false, normcallouts=false )
       contents = nil
       line_numbers = nil
       error = false
@@ -62,11 +62,22 @@ def self.get_content_from_file( spec, identifier, language, sha=nil, numbers=nil
         end
       end
 
+      if normcallouts
+        rv = normalize_callouts( rv )
+      end
+
       rv = "INVALID SNIPPET, WARNING" if error
       # rv = scrub_other_identifiers( contents, comments )
       rv
     end
 
+    def self.normalize_callouts( rv )
+      # Find something that looks like comment character + whitespace + < + number + >
+      index = 0
+      rv.gsub!( /([\/#]) <\d+>/ ) { |c| index += 1; "#{$1} <#{index}>" }
+      rv
+    end
+
     def self.skip_flattening( language )
       rv = ( !!@@_config[:skip_flattening] and language and !!@@_config[:skip_flattening][language.to_sym] ) 
       # rv = ( !!@@_config[:skip_flattening] and !!@@_config[:skip_flattening][language.to_sym] ) 
@@ -107,7 +118,7 @@ def self.process( input )
       rv = input
       if snippets and snippets.length > 0 
         snippets.each do |s|
-          content = get_content_from_file( s[:filename], s[:identifier], s[:language], s[:sha], s[:lines], s[:flatten] )
+          content = get_content_from_file( s[:filename], s[:identifier], s[:language], s[:sha], s[:lines], s[:flatten], s[:normcallouts] )
           rv = rv.gsub( s[:full], content )
         end
       end

lib/oreilly/snippets/version.rb

@@ -1,5 +1,5 @@
 module Oreilly
   module Snippets
-    VERSION = "0.0.11"
+    VERSION = "0.0.12"
   end
 end

spec/fixtures/normalize_callouts.honey

@@ -0,0 +1,2 @@
+OK().do( <2> ).it()
+another.thing( <3> ).bad() 

spec/fixtures/normalize_callouts.js

@@ -0,0 +1,2 @@
+something().is().here() // <2>
+another.thing().ok() // <3>

spec/fixtures/normalize_callouts.rb

@@ -0,0 +1,2 @@
+something.do.it # <2>
+yeah.it.works # <3>

spec/process_spec.rb

@@ -37,6 +37,28 @@
 
 END
 
+NORMALIZE_CALLOUTS_JS = <<"END"
+[filename="spec/fixtures/normalize_callouts.js", normcallouts="true"]
+snippet~~~~
+...
+snippet~~~~
+END
+
+HONEYPOT_NORMALIZE_CALLOUTS = <<"END"
+[filename="spec/fixtures/normalize_callouts.honey", normcallouts="true"]
+snippet~~~~
+...
+snippet~~~~
+END
+
+
+NORMALIZE_CALLOUTS_RB = <<"END"
+[filename="spec/fixtures/normalize_callouts.rb", normcallouts="true"]
+snippet~~~~
+...
+snippet~~~~
+END
+
 
 FULL = <<END
 [filename="spec/fixtures/factorial.js", language="js", identifier="FACTORIAL_FUNC"]
@@ -195,6 +217,25 @@ def download_test_repository
       output.should_not match( /END FACTORIAL_FUNC/ ) 
     end
 
+    describe "#normcallouts" do
+      it "should normalize callouts" do
+        output = Oreilly::Snippets.process( NORMALIZE_CALLOUTS_JS )
+        output.should match( /<1>/ )        
+        output.should_not match( /<3>/ )
+      end
+
+      it "should normalize callouts with alternative comments" do
+        output = Oreilly::Snippets.process( NORMALIZE_CALLOUTS_RB )
+        output.should match( /<1>/ )        
+        output.should_not match( /<3>/ )
+      end
+
+      it "should not mistakenly normalize callouts" do
+        output = Oreilly::Snippets.process( HONEYPOT_NORMALIZE_CALLOUTS )
+        output.should match( /<2>/ )
+      end
+    end
+
     describe "#flatten" do
       before( :each ) do
         @with_spaces = File.read( "spec/fixtures/with_spaces.rb" )