oreilly-snippets 0.0.12 → 0.0.15

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTAwOGQ0YTdhODBiMjI1MThjMTZkNTQyMzkwMjdlN2ViYmRjYjE3YQ==
-  data.tar.gz: !binary |-
-    ZDlmMjc1YTY5MWZlMmJiM2MwYjA0OGY4NWQzNDFlYzE5M2UyYzY2ZQ==
+SHA1:
+  metadata.gz: 1d3e3c29a72469016a1400732a8e020cddee9599
+  data.tar.gz: e9377684d7ba0e2bc9f4f5ae65e8514be72b57a1
 SHA512:
-  metadata.gz: !binary |-
-    YWMyOTRmNGQ4NDhhMGE1MTk5ZTMzZTA3MDA1MTdhZDRhMzhmMzVmMDYyNzg1
-    NGRmYWE3M2MxNmZjODk0MWE0YWY1ZWU5MzUwYTlhYzE1MTNlZjFiYzBjZmEz
-    YzJjMDI2MDJlYjY3ZTI2YWNiMDFlMzc0NTBlMTliMDQ0MGVkOTY=
-  data.tar.gz: !binary |-
-    MGE0NjY5MTA5ZmIzYTI3YzVjMTcxNzdiMDQ2ZjQxZjRiZTk2NmRmOWY3M2I5
-    MjUwY2ZmNjE4ZWNiOGYyZmVmMzJkZjU2YWI2YjM3OWZjMDllNTAwNDBiYmFm
-    MmQzZjc3ZDllMDlhZWJlMGYwZDMwZTU0ZWEwYTEwNDQ3Y2ZiN2Q=
+  metadata.gz: cd8d103b247334041ef4b2e487b5f4002ff56444495c2d5ca32b10c846c4911cea0648d63c1e3e61af3be9aaaba6381505e3d24377a3a3fce964892da09435a1
+  data.tar.gz: b8fd891e2fbbb6c5becc3429d8916bbd84ca7853431d9a282da3ad86d0da91f200d2ec4cb13c19395f9225bc0b0ba2a815e87948291a5dcf957a9850eec1ce93

data/lib/oreilly/snippets.rb

@@ -15,7 +15,17 @@ module Oreilly
       @@_config.merge!( opts )
     end
 
-    def self.get_content_from_file( spec, identifier, language, sha=nil, numbers=nil, flatten=false, normcallouts=false )
+    def self.get_content_from_file( s )
+
+      spec = s[:filename]
+      identifier =  s[:identifier]
+      language = s[:language]
+      sha = s[:sha]
+      numbers = s[:lines]
+      flatten = s[:flatten]
+      normcallouts = s[:normcallouts] 
+      callouts = s[:callouts]
+
       contents = nil
       line_numbers = nil
       error = false
@@ -62,7 +72,9 @@ module Oreilly
         end
       end
 
-      if normcallouts
+      if callouts
+        rv = process_callouts( rv, callouts )
+      elsif normcallouts
         rv = normalize_callouts( rv )
       end
 
@@ -71,10 +83,41 @@ module Oreilly
       rv
     end
 
+    def self.process_callouts( input, callouts )
+      rv = nil
+      # Strip them out and figure out the comment character
+      comment_character = nil
+      rv = input.gsub( /([#\/]\/?) ?<\d+>/ ) { |c| comment_character = $1; '' }
+
+      unless comment_character
+        # OK, we need to scan for it and hope to figure it out
+        if rv =~ /\/\/[\/]+$/
+          comment_character = '/'
+        elsif rv =~ /#[^#]+$/
+          comment_character = '#'
+        end
+      end
+
+      unless comment_character
+        comment_character = '//'
+      end
+
+      unless callouts.eql? ""
+        list = callouts.split /,/
+        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
+        end
+        rv = lines.join "\n"
+      end
+      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.gsub!( /([\/#]) <\d*>/ ) { |c| index += 1; "#{$1} <#{index}>" }
       rv
     end
 
@@ -107,7 +150,7 @@ module Oreilly
 
 
     def self.scrub_other_identifiers( s, comments )
-      puts s
+      # puts s
       re = /#{comments} BEGIN \S+\n(.*)\n#{comments} END \S+\n/m
       s.gsub!( re, $1 )
       s
@@ -118,7 +161,7 @@ module Oreilly
       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], s[:normcallouts] )
+          content = get_content_from_file( s ) #  s[:filename], s[:identifier], s[:language], s[:sha], s[:lines], s[:flatten], s[:normcallouts] )
           rv = rv.gsub( s[:full], content )
         end
       end

data/lib/oreilly/snippets/version.rb

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

data/spec/fixtures/add-callouts-no-space.js

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

data/spec/fixtures/normalize_callouts.js

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

data/spec/fixtures/normalize_callouts_long.js

@@ -0,0 +1,21 @@
+something().is().here() 
+another.thing().ok() 
+another.thing().ok() 
+something().is().here()
+another.thing().ok() 
+another.thing().ok() 
+something().is().here() 
+another.thing().ok() 
+another.thing().ok() 
+something().is().here() 
+another.thing().ok() 
+another.thing().ok() 
+something().is().here()
+another.thing().ok() 
+another.thing().ok() 
+something().is().here()
+another.thing().ok() 
+another.thing().ok() 
+something().is().here()
+another.thing().ok() 
+another.thing().ok() 

data/spec/process_spec.rb

@@ -6,6 +6,14 @@ TEST_REPO = "oreilly-snippets-sample-content"
 GITHUB_REPO = "https://github.com/xrd/#{TEST_REPO}.git"
 ROOT = File.join "spec", TEST_REPO
 
+WITH_DIRECTORY_AND_SHA = <<END
+[filename="../oreilly-snippets", language="js", sha="2f35461ff68c92c2e554c953:spec/fixtures/factorial.js"]
+snippet~~~~
+Put any descriptive text you want here. It will be replaced with the
+snippet~~~~
+END
+
+
 WITH_SHA = <<END
 [filename="#{ROOT}", language="js", sha="c863f786f5959799d7c:test.js"]
 snippet~~~~
@@ -37,6 +45,36 @@ snippet~~~~
 
 END
 
+STRIP_CALLOUTS_JS = <<"END"
+[filename="spec/fixtures/normalize_callouts.js", callouts=""]
+snippet~~~~
+...
+snippet~~~~
+END
+
+ADD_CALLOUTS_JS = <<"END"
+[filename="spec/fixtures/normalize_callouts.js", callouts="1,2,3"]
+snippet~~~~
+...
+snippet~~~~
+END
+
+NO_SPACED_CALLOUTS_JS = <<"END"
+[filename="spec/fixtures/add-callouts-no-space.js", callouts="1"]
+snippet~~~~
+...
+snippet~~~~
+END
+
+
+REALLY_LONG_CALLOUTS_JS = <<"END"
+[filename="spec/fixtures/normalize_callouts_long.js", callouts="1,10,15"]
+snippet~~~~
+...
+snippet~~~~
+END
+
+
 NORMALIZE_CALLOUTS_JS = <<"END"
 [filename="spec/fixtures/normalize_callouts.js", normcallouts="true"]
 snippet~~~~
@@ -51,7 +89,6 @@ snippet~~~~
 snippet~~~~
 END
 
-
 NORMALIZE_CALLOUTS_RB = <<"END"
 [filename="spec/fixtures/normalize_callouts.rb", normcallouts="true"]
 snippet~~~~
@@ -217,11 +254,47 @@ describe Oreilly::Snippets do
       output.should_not match( /END FACTORIAL_FUNC/ ) 
     end
 
+    describe "#callouts" do
+      it "should strip callouts completely" do
+        output = Oreilly::Snippets.process( STRIP_CALLOUTS_JS )
+        output.should_not match( /<\d+>/ )        
+      end
+
+      it "should add callouts" do
+        output = Oreilly::Snippets.process( ADD_CALLOUTS_JS )
+        lines = output.split /\n/ 
+        lines[0].should match( /<1>/ )        
+        lines[1].should match( /<2>/ )        
+        lines[2].should match( /<3>/ )        
+      end
+
+      it "should add callouts into a long file" do
+        output = Oreilly::Snippets.process( REALLY_LONG_CALLOUTS_JS )
+        lines = output.split /\n/ 
+        lines[0].should match( /<1>/ )        
+        lines[9].should match( /<2>/ )        
+        lines[14].should match( /<3>/ )        
+      end
+
+      it "should add callouts using a default comment" do
+        output = Oreilly::Snippets.process( REALLY_LONG_CALLOUTS_JS )
+        lines = output.split /\n/ 
+        lines[0].should match( /\/\/ <1>/ )        
+      end
+
+      it "should add callouts without a space character in between comment and callout" do
+        output = Oreilly::Snippets.process( NO_SPACED_CALLOUTS_JS )
+        lines = output.split /\n/ 
+        lines[0].should match( /\/\/ <1>/ )        
+        lines[1].should_not match( /\/\/<10>/ )        
+      end
+    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>/ )
+        output.should_not match( /<12>/ )
       end
 
       it "should normalize callouts with alternative comments" do
@@ -302,7 +375,7 @@ END
         Dir.chdir File.join( ROOT )
         original = `git show c863f786f5959799d7c11312a7ba1d603ff16339:test.js`
         Dir.chdir cwd
-        output.strip.should == original.strip
+        output.rstrip.should == original.rstrip
       end
 
       it "should retrieve by SHA and give us only certain lines" do
@@ -316,6 +389,16 @@ END
         output.should == original
       end
 
+      it "should parse directory specifications" do
+        output = Oreilly::Snippets.process( WITH_DIRECTORY_AND_SHA )
+        original = nil
+        path = ENV['REPO_NAME'] || "../oreilly-snippets"
+        Dir.chdir path do 
+          original = `git show 2f35461ff68c92c2e554c953:spec/fixtures/factorial.js`
+        end
+        output.should == ( original + "\n" )
+      end
+
       it "should indicate placeholder if using xxx as the sha" do
         output = Oreilly::Snippets.process( WITH_PLACEHOLDER_SHA )
         output.should match( /PLACEHOLDER/ )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oreilly-snippets
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.15
 platform: ruby
 authors:
 - Chris Dawson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-24 00:00:00.000000000 Z
+date: 2015-08-31 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)
@@ -69,12 +69,14 @@ files:
 - lib/oreilly/snippets.rb
 - lib/oreilly/snippets/version.rb
 - oreilly-snippets.gemspec
+- spec/fixtures/add-callouts-no-space.js
 - spec/fixtures/coffeetech.js
 - spec/fixtures/factorial.java
 - spec/fixtures/factorial.js
 - spec/fixtures/normalize_callouts.honey
 - spec/fixtures/normalize_callouts.js
 - spec/fixtures/normalize_callouts.rb
+- spec/fixtures/normalize_callouts_long.js
 - spec/fixtures/with_spaces.rb
 - spec/fixtures/with_tabs.rb
 - spec/process_spec.rb
@@ -89,27 +91,29 @@ 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
 test_files:
+- spec/fixtures/add-callouts-no-space.js
 - spec/fixtures/coffeetech.js
 - spec/fixtures/factorial.java
 - spec/fixtures/factorial.js
 - spec/fixtures/normalize_callouts.honey
 - spec/fixtures/normalize_callouts.js
 - spec/fixtures/normalize_callouts.rb
+- spec/fixtures/normalize_callouts_long.js
 - spec/fixtures/with_spaces.rb
 - spec/fixtures/with_tabs.rb
 - spec/process_spec.rb