oreilly-snippets 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a57aed1d32d05bc35423e603bba10ea6b33426d3
-  data.tar.gz: 8331074a515faf1bef013088c32c9712c6d4151d
+  metadata.gz: 67d27cdaa420bb60920b3d025fbf2fd1d1801d74
+  data.tar.gz: 3598b75bc1051bca2581724e64cf894c66c6f3bb
 SHA512:
-  metadata.gz: a9d0a940242a3eebd2e62f4a8270fdd3d23bac0f54d99a4281d368a81a0c89408bd56b689a9ea18ccc31339d5e1a145cc8f660591b30e249ef4b0ad23d77acbc
-  data.tar.gz: f883d854dc8b5876d5d09c2920b02510b6f779b1386b7fd416d086b7dfed8a9fb54cf012e3b146cb5b8bc393b08083e1fb5f022ef9c95f7a23156126642cc961
+  metadata.gz: cb4578a7500000a4711f9cd15c6957f781a8d0c809a2bb2f83bedb77723d19b06ced9b9852ad723e186f3bfccf0dbb2c9e952fe190a112ce990ec4eec91fe662
+  data.tar.gz: 0d0adae1b813dbcf5d02efd72ad3202203e498fc577ee8b1120a521155e0adfe1128d10bdb45d3246fb750736d080a6d75ac17c3157b1be684e57a6770366c13

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 spec/oreilly-snippets-sample-content
+*~

data/README.md

@@ -26,7 +26,7 @@ Send a string with proper snippet code into the process method:
 
 ### Snippets Usage
 
-Check out (Code Snippets)[http://chimera.labs.oreilly.com/books/1230000000065/ch04.html#code_explanation]
+Check out [Code Snippets](http://chimera.labs.oreilly.com/books/1230000000065/ch04.html#code_explanation)
 from O'Reilly.
 
 A snippet looks like this inside your markup.
@@ -69,6 +69,8 @@ mod.factory( 'Github', function() {
 
 ### Special additions to snippets
 
+#### Retrieve content from the local git repository
+
 You can also use syntax like this to pull from a specific commit in
 your git repository:
 
@@ -81,22 +83,69 @@ 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.
 
+#### Line Numbers
+
 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"]
 ```
 
+This is equivalent to a range in ruby like `[0..4]`. So, we use human indexes, which are converted to zero-based numbering.
+
+#### Placeholders for future SHA hashes
+
 If you want to use a placeholder to remind you to put the correct
 content in later once you have made the  correct commit, use "xxx" as
 the sha hash.
 
 ```
-[filename="../../github.js.test", language="js", sha="8e05a916fe0b1a9d3e:coffeetech.js, lines="1..5"]
+[filename="../../github.js.test", language="js", sha="xxx:coffeetech.js, lines="1..5"]
 ```
 
 This will get replaced with `PLACEHOLDER TEXT, UPDATE WITH CORRECT SHA HASH`.
 
+#### Flattening Identation
+
+You can specify `flatten=true` and oreilly-snippets will flatten out
+indentation. For example, if you are including a snippet python
+content of python content, you might not want to keep the indentation
+level as it is in the file, but display the content "flattened" to the
+smallest indentation level. 
+
+For example, imagine this content:
+
+```
+def barfoo():
+    print "barfoo"
+    if someVar == "someVar"
+        if anotherVar == "anotherVar"       
+            if thirdVar == "thirdVar" 
+                print( "all of them" )
+```
+
+Then, imagine if you take the snippet from lines 4-6. You probably
+don't want to display the snippet like this:
+
+```
+        if anotherVar == "anotherVar"       
+            if thirdVar == "thirdVar" 
+                print( "all of them" )
+```
+
+You probably want it like this:
+
+```
+if anotherVar == "anotherVar"       
+    if thirdVar == "thirdVar" 
+        print( "all of them" )
+```
+
+If you want the default to be to flatten (avoiding setting it each
+snippet declaration), you can set that using the config method: `Oreilly::Snippets.config( flatten: true )` 
+
+#### Incompatibilities with Atlas from O'Reilly
+
 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

data/lib/oreilly/snippets/version.rb

@@ -1,5 +1,5 @@
 module Oreilly
   module Snippets
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/oreilly/snippets.rb

@@ -2,38 +2,55 @@ require "oreilly/snippets/version"
 
 COMMENTS = {
   :js => "\/\/",
-  :ruby => "#"
+  :ruby => "#",
+  :python => "#"
 }
 
+class String
+  def unindent
+    gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "")
+  end
+end
+
 module Oreilly
   module Snippets
 
-    def self.get_content_from_file( spec, identifier, language, sha=nil, numbers=nil )
+    @@_config = {}
+
+    def self.config( opts )
+      @@_config.merge!( opts )
+    end
+
+    def self.get_content_from_file( spec, identifier, language, sha=nil, numbers=nil, flatten=false )
       contents = nil
       line_numbers = nil
       error = false
 
+      if numbers
+        sae = numbers.split( ".." ).map { |d| Integer(d)-1 }
+        line_numbers = [sae[0], sae[1]]
+      end
+      
       if sha
         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
+          if spec
+            Dir.chdir spec do
+              contents = `git show #{sha}`
+              error = true unless contents
+            end
+          end
         end
       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
+      if line_numbers
+        contents = contents.split( /\n/ )[line_numbers[0]..line_numbers[1]].join( "\n" )
+      end
       
       rv = nil
       if identifier
@@ -45,6 +62,10 @@ module Oreilly
         rv = contents
       end
 
+      if flatten or @@_config[:flatten]
+        rv = rv.unindent()
+      end
+
       rv = "INVALID SNIPPET, WARNING" if error
       # rv = scrub_other_identifiers( contents, comments )
       rv
@@ -62,7 +83,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] )
+          content = get_content_from_file( s[:filename], s[:identifier], s[:language], s[:sha], s[:lines], s[:flatten] )
           rv = rv.gsub( s[:full], content )
         end
       end
@@ -78,7 +99,7 @@ module Oreilly
         m[0].scan( /([^=\[,\s]*)="([^"]*)"/ ) do |kv|
           match[kv[0].to_sym] = kv[1]
         end
-        match[:full] = full.strip
+        match[:full] = full
         output << match
       end
       output

data/spec/fixtures/with_spaces.rb

@@ -0,0 +1,5 @@
+    def foo
+      'hi'
+    end
+
+def bar; 'hi'; end

data/spec/fixtures/with_tabs.rb

@@ -0,0 +1,5 @@
+		def foo
+			'hi'
+		end
+
+def bar; 'hi'; end

data/spec/process_spec.rb

@@ -27,18 +27,6 @@ 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 ) {
-  var github = new Github({} );
-  var repo = github.getRepo( "xrd", "spa.coffeete.ch" ); 
-  repo.contents( "gh-pages", "portland.json", function(err, data) { 
-    $scope.shops = JSON.parse( data );
-    $scope.$digest();
-  }, false );
-})
-END
-
 LOTS_OF_IDENTIFIERS = <<END
 
 [filename="spec/fixtures/coffeetech.js", language="js"]
@@ -58,6 +46,14 @@ specified code snippet when you build ebook outputs
 snippet~~~~
 END
 
+FOR_FLATTENING = <<END
+[filename="spec/fixtures/factorial.js", language="js", lines="6..9"]
+snippet~~~~
+Put any descriptive text you want here. It will be replaced with the
+specified code snippet when you build ebook outputs
+snippet~~~~
+END
+
 TEMPLATE = <<END
 
 ABC
@@ -88,6 +84,38 @@ snippet~~~~~
 
 END
 
+FLATTEN_WITH_SPACES =<<END
+[filename="spec/fixtures/with_spaces.rb", language="ruby", flatten="true", lines="1..3"]
+snippet~~~~
+Put any descriptive text you want here. It will be replaced with the
+specified code snippet when you build ebook outputs
+snippet~~~~
+END
+
+FLATTEN_NO_LINE_NUMBERS =<<END
+[filename="spec/fixtures/with_tabs.rb", language="ruby", flatten="true"]
+snippet~~~~
+Put any descriptive text you want here. It will be replaced with the
+specified code snippet when you build ebook outputs
+snippet~~~~
+END
+
+# Look at this: http://stackoverflow.com/questions/3772864/how-do-i-remove-leading-whitespace-chars-from-ruby-heredoc
+
+# class String
+#   def unindent 
+#     gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "")
+#   end
+# end
+
+FLATTEN_WITH_TABS =<<END
+[filename="spec/fixtures/with_tabs.rb", language="ruby", flatten="true", lines="1..3"]
+snippet~~~~
+Put any descriptive text you want here. It will be replaced with the
+specified code snippet when you build ebook outputs
+snippet~~~~
+END
+
 def download_test_repository
   root = File.join( "spec", TEST_REPO )
   unless File.exists? root
@@ -124,6 +152,7 @@ describe Oreilly::Snippets do
       output = outputs[0]
       output[:sha].should == "c863f786f5959799d7c:test.js"
     end
+
   end
 
   # describe "#scrub_other_identifiers" do
@@ -150,6 +179,40 @@ describe Oreilly::Snippets do
       output.should_not match( /END FACTORIAL_FUNC/ ) 
     end
 
+    describe "#flatten" do
+      before( :each ) do
+        @with_spaces = File.read( "spec/fixtures/with_spaces.rb" )
+        @with_tabs = File.read( "spec/fixtures/with_tabs.rb" )
+        @spaces_flattened = @with_spaces.split( "\n" )[0..3].join( "\n" ).gsub( /^    /, "" )
+        @tabs_flattened =  @with_tabs.split( "\n" )[0..3].join( "\n" ).gsub( /^\t\t/, "" )
+      end
+
+      it "should not flatten when indentation level is zero" do
+        output = Oreilly::Snippets.process( FLATTEN_NO_LINE_NUMBERS )
+        # remove one newline, consequence of embedding inside a template, it adds a newline
+        output = output[0...-1]
+        output.should == @with_tabs
+      end
+      
+      it "should support flattening as a configuration option" do
+        Oreilly::Snippets.config( flatten: true )
+        output = Oreilly::Snippets.process( FOR_FLATTENING )
+        lines = output.split "\n"
+        lines[0][0].should_not match /\s/ # First line has no whitespace starting
+        lines[-1][0].should match /\s/ # Last line is not indented
+      end
+
+      it "should support flattening with tabs" do
+        output = Oreilly::Snippets.process( FLATTEN_WITH_TABS )
+        output.should == @tabs_flattened
+      end
+      
+      it "should support flattening with spaces" do
+        output = Oreilly::Snippets.process( FLATTEN_WITH_SPACES )
+        output.should == @spaces_flattened
+      end
+    end
+
     # NYI
     # it "should remove all identifiers when processing" do
     #   output = Oreilly::Snippets.process( LOTS_OF_IDENTIFIERS )
@@ -169,13 +232,13 @@ describe Oreilly::Snippets do
 
       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
+        original = nil
+        Dir.chdir File.join( ROOT ) do 
+          original = `git show c863f786f5959799d7c11312a7ba1d603ff16339:test.js`
+        end
         lines = original.split /\n/
-        original = lines[0..2].join "\n"
-        output.strip.should == original.strip
+        original = lines[0..2].join( "\n" ) + "\n"
+        output.should == original
       end
 
       it "should indicate placeholder if using xxx as the sha" do
@@ -183,8 +246,5 @@ describe Oreilly::Snippets do
         output.should match( /PLACEHOLDER/ )
       end
     end
-
-
-    
   end
 end

data/spec/spec_helper.rb

@@ -8,9 +8,10 @@
 require 'oreilly/snippets'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  # config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
+  config.expect_with(:rspec) { |c| c.syntax = :should }
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oreilly-snippets
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Chris Dawson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,8 @@ files:
 - oreilly-snippets.gemspec
 - spec/fixtures/coffeetech.js
 - spec/fixtures/factorial.js
+- spec/fixtures/with_spaces.rb
+- spec/fixtures/with_tabs.rb
 - spec/process_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -93,12 +95,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: See the README
 test_files:
 - spec/fixtures/coffeetech.js
 - spec/fixtures/factorial.js
+- spec/fixtures/with_spaces.rb
+- spec/fixtures/with_tabs.rb
 - spec/process_spec.rb
 - spec/spec_helper.rb