oreilly-snippets 0.0.17 → 0.0.18

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MmMyOTRhMGMxZTllMjFkN2VhMzZkMzg3ZTdhZmQyYzU0MDE0NjE3OQ==
-  data.tar.gz: !binary |-
-    NmYxN2YxYTYzZDk2Nzc4YzIxNWY3Y2RlNzIzODJkYTgyNDViZDYwNg==
+SHA1:
+  metadata.gz: d0682d9e05b50a2090ed835c3e5c57a03d759b5f
+  data.tar.gz: 831879746851e37f84c1723acaca638b0d2fba96
 SHA512:
-  metadata.gz: !binary |-
-    Mjc2NTU2MDEwMWI3ZTFmN2Q2MzcyYWFiMmU0NzhmYjliM2M4YjYxNzQxMjNi
-    NmY5MzNlZWE2NjQ1ODNjMjk5MDY3Yjg5Zjk2ZTk5MmE4Mjc2ODM4Y2U4M2I4
-    ZDQwOGIxOWQyMzZiZWIwZmQ1NjdkMzA2ZTdmOTUyNDRlMmY0ZmQ=
-  data.tar.gz: !binary |-
-    ZWQyZWQzY2RiYWY1ZjZlNDNjOTg0NWQ0MWRlODY4NmM0ZWY2MGYwMTY3NzJk
-    NmY0NGM2Y2E0NzJhNzJjYjhjYjc2YmYwZmRlMmRiMjQ4NWE0Yzg1ZDk3MDNk
-    ZjcxMjA4NDc4NzY1ODFjODE4YzEzYTA2ZjFkN2FkNDU4YTFkYjM=
+  metadata.gz: 4711957ef11fe51514ac17bbd19153767d1303ffbefc15afdd3d2c3437ec3fdb4a3283808c2a189813c3f27caed115d547bf18aa61f6ed94909d9c5acc32893a
+  data.tar.gz: 9e1f79bd5ab14061c6854a551305137402a2088bf220ee37d3277a88e01ce2f40da009d04d1199e2478d7779c3c08a22821d398ebd435323a4e8396152fd9df8

data/lib/oreilly/snippets.rb

@@ -25,8 +25,19 @@ module Oreilly
       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 @@ module Oreilly
       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 @@ module Oreilly
       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 @@ module Oreilly
         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

data/lib/oreilly/snippets/version.rb

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

data/spec/fixtures/some.xml

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

data/spec/process_spec.rb

@@ -87,6 +87,28 @@ snippet~~~~
 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 @@ describe Oreilly::Snippets do
         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/ 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oreilly-snippets
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Chris Dawson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,28 +28,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Use O'Reilly style snippets inside your markup (asciidoc or markdown)
@@ -78,6 +78,7 @@ files:
 - spec/fixtures/normalize_callouts.rb
 - spec/fixtures/normalize_callouts_long.js
 - spec/fixtures/really_long_line.rb
+- spec/fixtures/some.xml
 - spec/fixtures/with_spaces.rb
 - spec/fixtures/with_tabs.rb
 - spec/process_spec.rb
@@ -92,17 +93,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: See the README
@@ -116,6 +117,7 @@ test_files:
 - spec/fixtures/normalize_callouts.rb
 - spec/fixtures/normalize_callouts_long.js
 - spec/fixtures/really_long_line.rb
+- spec/fixtures/some.xml
 - spec/fixtures/with_spaces.rb
 - spec/fixtures/with_tabs.rb
 - spec/process_spec.rb