Add support for flattening

Author: xrd

.gitignore

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

lib/oreilly/snippets.rb

@@ -2,25 +2,27 @@
 
 COMMENTS = {
   :js => "\/\/",
-  :ruby => "#"
+  :ruby => "#",
+  :python => "#"
 }
 
 module Oreilly
   module Snippets
 
-    def self.get_content_from_file( spec, identifier, language, sha=nil, numbers=nil )
+    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
@@ -33,7 +35,9 @@ def self.get_content_from_file( spec, identifier, language, sha=nil, numbers=nil
       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,11 +49,35 @@ def self.get_content_from_file( spec, identifier, language, sha=nil, numbers=nil
         rv = contents
       end
 
+      if flatten
+        rv = self.flatten_it( rv )
+      end
+
       rv = "INVALID SNIPPET, WARNING" if error
       # rv = scrub_other_identifiers( contents, comments )
       rv
     end
 
+    def self.flatten_it( content ) 
+      # find the smallest indent level, and then strip that off the beginning of all lines
+      smallest = nil
+      lines = content.split "\n"
+      lines.each do |l|
+        if l =~ /^(\s+)/
+          if smallest
+            if $1.length < smallest.length
+              smallest = $1
+            end
+          else
+            smallest = $1
+          end
+        end
+      end
+
+      replaced = content.gsub( /^#{smallest}/, '' )
+      replaced
+    end
+    
     def self.scrub_other_identifiers( s, comments )
       puts s
       re = /#{comments} BEGIN \S+\n(.*)\n#{comments} END \S+\n/m
@@ -62,7 +90,7 @@ def self.process( input )
       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 +106,7 @@ def self.parse( input )
         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

spec/fixtures/with_spaces.rb

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

spec/fixtures/with_tabs.rb

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

spec/process_spec.rb

@@ -27,18 +27,6 @@
 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"]
@@ -88,6 +76,30 @@
 
 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
+
+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 +136,7 @@ def download_test_repository
       output = outputs[0]
       output[:sha].should == "c863f786f5959799d7c:test.js"
     end
+
   end
 
   # describe "#scrub_other_identifiers" do
@@ -150,6 +163,30 @@ def download_test_repository
       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 )
+        output
+      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,22 +206,19 @@ def download_test_repository
 
       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
         output = Oreilly::Snippets.process( WITH_PLACEHOLDER_SHA )
         output.should match( /PLACEHOLDER/ )
       end
     end
-
-
-    
   end
 end

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