oreilly-snippets 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0665f1c4662d4210fee1977523b0d67aea964901
-  data.tar.gz: d56b78197b8912cd40869a692ea9f38d00d4d0aa
+  metadata.gz: f885055861b8a6cc216b6a62a9c68e9bef24ff66
+  data.tar.gz: f1753cb37934c3f84d51c550c5f036e669e3dc66
 SHA512:
-  metadata.gz: df67277eed2c5692cb4bb2c703d7c212b74c7a70d6b131a6cc248180aca591ee871f1d2a65b208ffb44671e09d45f28e415069b467f2cf0eed63ebe253bd8749
-  data.tar.gz: 2968b5febfa65029c32eedec864cfda1b0d7e74f48512a597422f774ddf5fa7681f0b8ecaa6270c507ac654907ef06549605fd54f60dc144504e4ecc92b640d6
+  metadata.gz: b7902c79fb4e7043f2e7ab4fa0820a1adf5e2b17ceac17d5b9767873abff5e7c2c25ea8aebff7db4290e1050df00c693d42439f07ff0d738fd74a1dc450458af
+  data.tar.gz: 7a27f369b5b3fc2f6073c0972aabfe3a2eaacf9b2366af47d8c3eb5d74e74639811c2e7b8dd9578352f6ebb518ca8db3fbe0cbe9a907ee23dee62e545491f24e

data/README.md

@@ -108,10 +108,10 @@ 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. 
+indentation. For example, if you are including a snippet 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:
 
@@ -144,6 +144,8 @@ if anotherVar == "anotherVar"
 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 )` 
 
+At the moment, flattening does not work perfectly for Java files. You can ignore java with `Oreilly::Snippets.config( flatten: true, flatten_exceptions: { java: true } )` 
+
 #### Incompatibilities with Atlas from O'Reilly
 
 NB: This format of snippets is not currently compatible with Atlas

data/lib/oreilly/snippets/version.rb

@@ -1,5 +1,5 @@
 module Oreilly
   module Snippets
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   end
 end

data/lib/oreilly/snippets.rb

@@ -55,7 +55,7 @@ module Oreilly
         rv = contents
       end
 
-      if flatten or @@_config[:flatten]
+      if ( flatten or @@_config[:flatten] ) and not flatten_exceptions( language )
         rv = flatten_it( rv )
       end
 
@@ -64,6 +64,10 @@ module Oreilly
       rv
     end
 
+    def self.flatten_exceptions( language )
+      @@_config[:flatten_exceptions] and @@_config[:flatten_exceptions][language.to_sym]
+    end
+
     def self.flatten_it( content ) 
       # find the smallest indent level, and then strip that off the beginning of all lines
       smallest = nil

data/spec/fixtures/factorial.java

@@ -0,0 +1,6 @@
+
+public class Factorial {
+    public static void main( String[] args ) {
+      // Do something
+    }
+}

data/spec/process_spec.rb

@@ -54,6 +54,14 @@ specified code snippet when you build ebook outputs
 snippet~~~~
 END
 
+DONT_USE_JAVA_FOR_FLATTENING = <<END
+[filename="spec/fixtures/factorial.java", language="java", lines="3..5"]
+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
@@ -202,6 +210,17 @@ describe Oreilly::Snippets do
         lines[-1][0].should match /\s/ # Last line is not indented
       end
 
+      it "should not flatten if java is used and properly configured" do
+        string = <<END
+    public static void main( String[] args ) {
+      // Do something
+    }
+END
+        Oreilly::Snippets.config( flatten: true, flatten_exceptions: { java: true } )
+        output = Oreilly::Snippets.process( DONT_USE_JAVA_FOR_FLATTENING )
+        string.should eq( output )
+      end
+
       it "should support flattening with tabs" do
         output = Oreilly::Snippets.process( FLATTEN_WITH_TABS )
         output.should == @tabs_flattened

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oreilly-snippets
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Chris Dawson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - lib/oreilly/snippets/version.rb
 - oreilly-snippets.gemspec
 - spec/fixtures/coffeetech.js
+- spec/fixtures/factorial.java
 - spec/fixtures/factorial.js
 - spec/fixtures/with_spaces.rb
 - spec/fixtures/with_tabs.rb
@@ -101,6 +102,7 @@ specification_version: 4
 summary: See the README
 test_files:
 - spec/fixtures/coffeetech.js
+- spec/fixtures/factorial.java
 - spec/fixtures/factorial.js
 - spec/fixtures/with_spaces.rb
 - spec/fixtures/with_tabs.rb