oreilly-snippets 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c050b3514c9fad043f6558927fe6b7e446628f0
-  data.tar.gz: 7168ec00e39cc8eb811b7bf44a24a0188a71aefb
+  metadata.gz: 15d1d4d047093c3b43eb0806790c3fa563cc67ac
+  data.tar.gz: 015db5a432fa389c815269492ac308232bdee236
 SHA512:
-  metadata.gz: 3770d0c1f2eb97b7730d60928e3f1e1f0335ea9949244a901aca4eb5ff37f647ccd9981e685a7ddc0deca538728f79f9c2a672ab05956bc4c4b3c415c84a8045
-  data.tar.gz: 5a7031154a6427e11c03168b5736400a7dee1e630e569203294fc99857b160384fe41bea51db053bac9c7dd31a18c73c2fe4b09f06f2582c9b146d535d73524f
+  metadata.gz: c5d8bc7dcd875d854fb43339c3d599f93f3d6a7127b1af19f3dd3d67548b436577e6f3f0052be283528ba74e3b74d2996f35d4bff26957f8ba712f7c4b709fc3
+  data.tar.gz: 1c83c25ab9d7b3bea22ab4f51fd17d937470f14f780ecaa78437f17c831222b9eeaef8657f6f6397dad10c537ac352dc6f7a19a4aa5274f26e3b1b2a0297ad1e

data/README.md

@@ -104,14 +104,17 @@ The file structure I use for this:
 * Store my pre-processed files in the /pre directory. These are the
   files which have the snippets. I need to have a special directory
   because this means Atlas will ignore them, and guard will process
-  the files into the Asciidoc files used by Atlas.
+  the files into the Asciidoc files stored in the root of the directory, 
+  the files which Atlas will process.
 * In the directory root I have a bunch of .asciidoc files which are
   the post-processed files, the files which have the snippets resolved
   into real code.
-* Guard watches both directories. When I make a change to the files in
+* Guard watches both directories (the root and the /pre directory). 
+  When I make a change to the files in
   /pre, Guard regenerates the asciidoc files at the top level. When
   Guard sees one of those files has been changed, it processes them
-  through Asciidoctor and then builds the HTML. 
+  through Asciidoctor and then builds the HTML. You could combine these 
+  into a single watch if you want.
 * I serve the HTML file using a combination of pow (pow.cx) and
   config.ru. 
 * Use the live-reload plugin for Chrome:

data/lib/oreilly/snippets/version.rb

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

data/lib/oreilly/snippets.rb

@@ -11,17 +11,23 @@ module Oreilly
     def self.get_content_from_file( spec, identifier, language, sha=nil, numbers=nil )
       contents = nil
       line_numbers = nil
+      error = false
 
       if sha
-        if numbers
-          sae = numbers.split( ".." ).map { |d| Integer(d)+1 }
-          line_numbers = [sae[0], sae[1]]
+        if sha[0..2].eql? "xxx"
+          contents = "PLACEHOLDER TEXT, UPDATE WITH CORRECT SHA HASH"
+        else
+          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
+          cwd = Dir.pwd
+          Dir.chdir spec if spec
+          contents = `git show #{sha}`
+          error = true unless contents
+          Dir.chdir cwd if spec
         end
-        # Use the filename to change into the directory and use git-show
-        cwd = Dir.pwd
-        Dir.chdir spec if spec
-        contents = `git show #{sha}`
-        Dir.chdir cwd if spec
       else
         contents = File.read( spec )
       end
@@ -39,6 +45,7 @@ module Oreilly
         rv = contents
       end
 
+      rv = "INVALID SNIPPET, WARNING" if error
       # rv = scrub_other_identifiers( contents, comments )
       rv
     end

data/spec/process_spec.rb

@@ -20,6 +20,13 @@ Put any descriptive text you want here. It will be replaced with the
 snippet~~~~
 END
 
+WITH_PLACEHOLDER_SHA = <<END
+[filename="#{ROOT}", language="js", sha="xxx:test.js"]
+snippet~~~~
+Put any descriptive text you want here. It will be replaced with the
+snippet~~~~
+END
+
 ORIGINAL_CONTENTS = <<END
 var mod = angular.module( 'coffeetech', [] )
 mod.controller( 'ShopsCtrl', function( $scope ) {
@@ -170,7 +177,14 @@ describe Oreilly::Snippets do
         original = lines[2..4].join "\n"
         output.strip.should == original.strip
       end
+
+      it "should indicate placeholder if using xxx as the sha" do
+        output = Oreilly::Snippets.process( WITH_PLACEHOLDER_SHA )
+        output.should match( /PLACEHOLDER/ )
+      end
     end
+
+
     
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oreilly-snippets
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Chris Dawson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler