oreilly-snippets 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6d5f18cb671bae8c31619c1d908d7c0636575b1
-  data.tar.gz: 5c717da0a54e70e02225244fb6e553099a45a91f
+  metadata.gz: 1c050b3514c9fad043f6558927fe6b7e446628f0
+  data.tar.gz: 7168ec00e39cc8eb811b7bf44a24a0188a71aefb
 SHA512:
-  metadata.gz: 80c79c398493b13a443c206109c3bab60611539a25a6d426e19352579ade4d99eeb9c3a01c4df750c27e36fc37f530d0b23861d5d532cfc38478b548135d2dfa
-  data.tar.gz: 8d8b76b771f3bcfc01bf4c0be3b0192df890bae7713d9283e58359b51f5d8b5d34138b2f3b69f3518f1724d267f742f14dfb7b9d0916f4e146b699a976842b57
+  metadata.gz: 3770d0c1f2eb97b7730d60928e3f1e1f0335ea9949244a901aca4eb5ff37f647ccd9981e685a7ddc0deca538728f79f9c2a672ab05956bc4c4b3c415c84a8045
+  data.tar.gz: 5a7031154a6427e11c03168b5736400a7dee1e630e569203294fc99857b160384fe41bea51db053bac9c7dd31a18c73c2fe4b09f06f2582c9b146d535d73524f

data/README.md

@@ -81,6 +81,12 @@ directory, then grab the file at the specific SHA hash. This means you
 can write code inside a repository, and add a snippet pointing to that
 exact revision in the repository.
 
+Also, you can specify line numbers and use just certain lines within the file retrieved:
+
+```
+[filename="../../github.js.test", language="js", sha="8e05a916fe0b1a9d3e:coffeetech.js, lines="1..5"]
+```
+
 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
@@ -111,6 +117,25 @@ The file structure I use for this:
 * Use the live-reload plugin for Chrome:
   https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei
 
+It looks like this:
+
+```
+# Files which have been processed by oreilly-snippets and 
+# have regulard [source,javascript] style code blocks
+chapter1.asciidoc 
+chapter2.asciidoc
+# Files with the exact same name which have the oreilly-snippets
+# code includes. These are the files I edit.
+/pre/chapter1.asciidoc
+/pre/chapter2.asciidoc
+# The rendered HTML files. I open these in my browser and the live-reload
+# plugin reloads once I edit anything in the /pre directory.
+chapter1.asciidoc.html
+chapter2.asciidoc.html
+```
+
+Here is the `Guardfile`
+
 ```
 require 'asciidoctor'
 require 'oreilly/snippets'

data/lib/oreilly/snippets/version.rb

@@ -1,5 +1,5 @@
 module Oreilly
   module Snippets
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/oreilly/snippets.rb

@@ -8,19 +8,13 @@ COMMENTS = {
 module Oreilly
   module Snippets
 
-    def self.get_content_from_file( spec, identifier, language, sha=nil )
+    def self.get_content_from_file( spec, identifier, language, sha=nil, numbers=nil )
       contents = nil
       line_numbers = nil
 
       if sha
-
-        if sha.count( ":" ) > 1
-          # Strip off the line numbers and use them later
-          first = sha.index ":"
-          second = (sha.index ":", first+1)+1
-          numbers = sha[second..-1]
-          sae = numbers.split( ".." ).map { |d| Integer(d) }
-          sha = sha[0..second-2]
+        if numbers
+          sae = numbers.split( ".." ).map { |d| Integer(d)+1 }
           line_numbers = [sae[0], sae[1]]
         end
         # Use the filename to change into the directory and use git-show
@@ -28,7 +22,6 @@ module Oreilly
         Dir.chdir spec if spec
         contents = `git show #{sha}`
         Dir.chdir cwd if spec
-        
       else
         contents = File.read( spec )
       end
@@ -62,7 +55,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] )
+          content = get_content_from_file( s[:filename], s[:identifier], s[:language], s[:sha], s[:lines] )
           rv = rv.gsub( s[:full], content )
         end
       end

data/spec/process_spec.rb

@@ -14,7 +14,7 @@ snippet~~~~
 END
 
 WITH_SHA_LINE_NUMBERS = <<END
-[filename="#{ROOT}", language="js", sha="c863f786f5959799d7c:test.js:1..3"]
+[filename="#{ROOT}", language="js", sha="c863f786f5959799d7c:test.js" lines="1..3"]
 snippet~~~~
 Put any descriptive text you want here. It will be replaced with the
 snippet~~~~
@@ -167,7 +167,7 @@ describe Oreilly::Snippets do
         original = `git show c863f786f5959799d7c11312a7ba1d603ff16339:test.js`
         Dir.chdir cwd
         lines = original.split /\n/
-        original = lines[1..3].join "\n"
+        original = lines[2..4].join "\n"
         output.strip.should == original.strip
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oreilly-snippets
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Chris Dawson