oreilly-snippets 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c1f282b603c87774de48d0528a5a5c502b7f781
-  data.tar.gz: 1107766b02889b4bd04852cc6010594ffd347d1c
+  metadata.gz: c6d5f18cb671bae8c31619c1d908d7c0636575b1
+  data.tar.gz: 5c717da0a54e70e02225244fb6e553099a45a91f
 SHA512:
-  metadata.gz: 0cfb0a42084e9391dfcbf575c327a48e3cab0fbf18214b4d7227f3c4d008dae3c65a3692d335faff429ac8ff81016b94c5e37efda3c7a0efdbf16eb521858f85
-  data.tar.gz: f8ea02d98b973a31bc8dcbedf52a471b40e0673646e16c12a7be2b3fbefbe489f240a03bbbe99e4039a3a8ba3f638973c2d58f70aa569b61e45fe0cc36bf294c
+  metadata.gz: 80c79c398493b13a443c206109c3bab60611539a25a6d426e19352579ade4d99eeb9c3a01c4df750c27e36fc37f530d0b23861d5d532cfc38478b548135d2dfa
+  data.tar.gz: 8d8b76b771f3bcfc01bf4c0be3b0192df890bae7713d9283e58359b51f5d8b5d34138b2f3b69f3518f1724d267f742f14dfb7b9d0916f4e146b699a976842b57

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/oreilly-snippets-sample-content

data/README.md

@@ -18,6 +18,12 @@ Or install it yourself as:
 
 ## Usage
 
+### Library usage
+
+Send a string with proper snippet code into the process method:
+
+`Oreilly::Snippets.process( asciidoc_string )`
+
 ### Snippets Usage
 
 Check out (Code Snippets)[http://chimera.labs.oreilly.com/books/1230000000065/ch04.html#code_explanation]

data/lib/oreilly/snippets.rb

@@ -10,16 +10,32 @@ module Oreilly
 
     def self.get_content_from_file( spec, identifier, language, sha=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]
+          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
+        Dir.chdir spec if spec
         contents = `git show #{sha}`
-        Dir.chdir cwd
+        Dir.chdir cwd if spec
+        
       else
         contents = File.read( spec )
       end
 
+      # If line numbers are there, provide only that content
+      contents = contents.split( /\n/ )[line_numbers[0]..line_numbers[1]].join( "\n" ) if line_numbers
+      
       rv = nil
       if identifier
         comments = COMMENTS[language.to_sym]

data/lib/oreilly/snippets/version.rb

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

data/spec/process_spec.rb

@@ -1,7 +1,20 @@
 require 'spec_helper'
+require 'fileutils'
+require 'tempfile'
+
+TEST_REPO = "oreilly-snippets-sample-content"
+GITHUB_REPO = "https://github.com/xrd/#{TEST_REPO}.git"
+ROOT = File.join "spec", TEST_REPO
 
 WITH_SHA = <<END
-[filename="../../github.js.test", language="js", sha="8e05a916fe0b1a9d3e:coffeetech.js"]
+[filename="#{ROOT}", language="js", sha="c863f786f5959799d7c:test.js"]
+snippet~~~~
+Put any descriptive text you want here. It will be replaced with the
+snippet~~~~
+END
+
+WITH_SHA_LINE_NUMBERS = <<END
+[filename="#{ROOT}", language="js", sha="c863f786f5959799d7c:test.js:1..3"]
 snippet~~~~
 Put any descriptive text you want here. It will be replaced with the
 snippet~~~~
@@ -68,67 +81,96 @@ snippet~~~~~
 
 END
 
-describe "#parse" do
+def download_test_repository
+  root = File.join( "spec", TEST_REPO )
+  unless File.exists? root
+    `git clone #{GITHUB_REPO} #{root}`
+  end
+end
 
-  it "should parse wrapped items" do
-    outputs = Oreilly::Snippets.parse( WRAPPED_BY_SOURCE )
-    output = outputs[0]
-    output[:filename].should == "spec/fixtures/coffeetech.js"
-    output[:language].should == "js"
-    output[:identifier].should == "MODULE_DEFINITION"
+describe Oreilly::Snippets do
+  before( :all ) do
+    download_test_repository()
   end
   
-  it "should parse the file and extract the correct things" do
-    outputs = Oreilly::Snippets.parse( TEMPLATE )
-    output = outputs[0]
-    output[:filename].should == "spec/fixtures/factorial.js"
-    output[:language].should == "js"
-    output[:identifier].should == "FACTORIAL_FUNC"
-    output[:full].strip.should == FULL.strip
-  end
+  describe "#parse" do
+
+    it "should parse wrapped items" do
+      outputs = Oreilly::Snippets.parse( WRAPPED_BY_SOURCE )
+      output = outputs[0]
+      output[:filename].should == "spec/fixtures/coffeetech.js"
+      output[:language].should == "js"
+      output[:identifier].should == "MODULE_DEFINITION"
+    end
+    
+    it "should parse the file and extract the correct things" do
+      outputs = Oreilly::Snippets.parse( TEMPLATE )
+      output = outputs[0]
+      output[:filename].should == "spec/fixtures/factorial.js"
+      output[:language].should == "js"
+      output[:identifier].should == "FACTORIAL_FUNC"
+      output[:full].strip.should == FULL.strip
+    end
 
-  it "should get the SHA when specified" do
-    outputs = Oreilly::Snippets.parse( WITH_SHA )
-    output = outputs[0]
-    output[:sha].should == "8e05a916fe0b1a9d3e:coffeetech.js"
+    it "should get the SHA when specified" do
+      outputs = Oreilly::Snippets.parse( WITH_SHA )
+      output = outputs[0]
+      output[:sha].should == "c863f786f5959799d7c:test.js"
+    end
   end
-end
 
-# describe "#scrub_other_identifiers" do
-#   it "should scrub everything that looks like an identifier" do
-#     out = Oreilly::Snippets.scrub_other_identifiers( File.read( "spec/fixtures/coffeetech.js" ), "//" )
-#     out.should_not match( /FOOBAR/ )
-#   end
-# end
+  # describe "#scrub_other_identifiers" do
+  #   it "should scrub everything that looks like an identifier" do
+  #     out = Oreilly::Snippets.scrub_other_identifiers( File.read( "spec/fixtures/coffeetech.js" ), "//" )
+  #     out.should_not match( /FOOBAR/ )
+  #   end
+  # end
 
-describe "#process" do
+  describe "#process" do
 
-  it "should process a complex file" do
-    output = Oreilly::Snippets.process( WRAPPED_BY_SOURCE )
-    output.should_not match( /MODULE_DEFINITION/ )
-    output.should_not match( /\/\/$/ )
-  end
-  
-  it "should process a simple file" do
-    output = Oreilly::Snippets.process( TEMPLATE )
-    output.should match( /ABC/ )
-    output.should match( /DEF/ )
-    output.should match( /function factorial\(number\)/ )
-    output.should_not match( /BEGIN FACTORIAL_FUNC/ )
-    output.should_not match( /END FACTORIAL_FUNC/ ) 
-  end
+    it "should process a complex file" do
+      output = Oreilly::Snippets.process( WRAPPED_BY_SOURCE )
+      output.should_not match( /MODULE_DEFINITION/ )
+      output.should_not match( /\/\/$/ )
+    end
+    
+    it "should process a simple file" do
+      output = Oreilly::Snippets.process( TEMPLATE )
+      output.should match( /ABC/ )
+      output.should match( /DEF/ )
+      output.should match( /function factorial\(number\)/ )
+      output.should_not match( /BEGIN FACTORIAL_FUNC/ )
+      output.should_not match( /END FACTORIAL_FUNC/ ) 
+    end
 
-  # NYI
-  # it "should remove all identifiers when processing" do
-  #   output = Oreilly::Snippets.process( LOTS_OF_IDENTIFIERS )
-  #   output.should_not match( /BEGIN/ )
-  # end
-  
-  describe "#git" do
-    it "should retrieve by SHA if specified" do
-      output = Oreilly::Snippets.process( WITH_SHA )
-      ORIGINAL_CONTENTS.strip.should == output.strip
+    # NYI
+    # it "should remove all identifiers when processing" do
+    #   output = Oreilly::Snippets.process( LOTS_OF_IDENTIFIERS )
+    #   output.should_not match( /BEGIN/ )
+    # end
+    
+    describe "#git" do
+      it "should retrieve by SHA if specified" do
+        output = Oreilly::Snippets.process( WITH_SHA )
+        # strip the whitespace, makes comparison easier..
+        cwd = Dir.getwd
+        Dir.chdir File.join( ROOT )
+        original = `git show c863f786f5959799d7c11312a7ba1d603ff16339:test.js`
+        Dir.chdir cwd
+        output.strip.should == original.strip
+      end
+
+      it "should retrieve by SHA and give us only certain lines" do
+        output = Oreilly::Snippets.process( WITH_SHA_LINE_NUMBERS )
+        cwd = Dir.getwd
+        Dir.chdir File.join( ROOT )
+        original = `git show c863f786f5959799d7c11312a7ba1d603ff16339:test.js`
+        Dir.chdir cwd
+        lines = original.split /\n/
+        original = lines[1..3].join "\n"
+        output.strip.should == original.strip
+      end
     end
+    
   end
-  
 end

metadata

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