docubot 1.1.4 → 1.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmNkOTU4ZTVmMzM5OGI0YTA5MmFhYjk2NmQyNDQ2NThiYmY0NGFhZA==
+    ZGFiNGM1OGVhYmEwYTgzNzk0NTUxMzQwNTBiYTcxYWVmOGY3NjU0ZA==
   data.tar.gz: !binary |-
-    MjIwYzA0MDAzOGYzMTU1ZWJlOTM2NGQ0NjZmYWEzZDUzM2YxYmFiOQ==
+    ZDU3ZWM0OWJlZWExMWIzOGE5YTJmYTQ2NDU3NGE1NjAzMjZkMDNkZA==
 SHA512:
   metadata.gz: !binary |-
-    MzAxYzhjYzFhYWEyMGEyY2FhZWMyOGJmNWZlZmZjYjQxZDYyY2M4ZTk2NTZj
-    MzAzZmQ2ZmRkNmRjZDllNjRhMmY5MWZiOGRlZWNiZTg0OWRlMTc4NmZiMWU0
-    MTU0MDc2NDQ0NDllMjE3YzZkNzJlMDk4MTlmZDljYWIyZTc2N2U=
+    N2JmOGYwY2E5YWQyNzI3MjM0NzI0ZDI1ODI2YmRhMTYyZjE3YWY0ODk1Y2Jj
+    YmNlYzlkOWMxMzgyODk3OWFiOGQ4YTZkYTAzY2Q5MWQyZmE1ZWNlM2NlNjVm
+    ZTkxZThhMzFjYTE4YjY4ZjYwZWIxYzQ2OThhNzg4MjMyNGY5YzY=
   data.tar.gz: !binary |-
-    NzY5YTYwMTFkNzNiOTk4YWE2ODU4ZDY4YjhiYjUzMmJlMGZlMjQxZDEyNWQ3
-    NDdiZDAxMGY1NWZhYzM5MmExNmViODViZTBlZjgwNGViNjY5YzdkZGI0ODdk
-    ZWFiZmZiMDMwYjQwOTVjMDJlNzBkYWFjZWUxMTI4ZTZlZWEyM2Q=
+    ZjJhOTE5ZTcyMGY4ZDRhNzhhYTZiZjVhZmYzOWEzYTFiNjc2OWVlODMzMjc4
+    OWRlYjY3MTlmYzYxMDEzMTY0YzMyZDMxNTAwODc0OGM2ODY2YjhkOGQ5NDhl
+    ZTBiZmJhOWU2ZThmNzJjZGFjMDAxODI3YmFhZTcwNDExYTI4Y2U=

data/lib/docubot.rb

@@ -20,7 +20,7 @@ module FileUtils
 end
 
 module DocuBot
-	VERSION = '1.1.4'
+	VERSION = '1.2.0'
 	DIR     = File.expand_path( File.dirname( __FILE__ ) )
 	
 	TEMPLATE_DIR = DIR / 'docubot/templates'

data/lib/docubot/converters/html.rb

@@ -1,5 +1,25 @@
 # encoding: UTF-8
+begin
+	require 'coderay'
+rescue LoadError
+	warn "Unable to load coderay gem; code blocks will not support syntax highlighting."
+	warn "(Use   gem install coderay   to fix this, if you desire syntax highlighting.)"
+end
+
 DocuBot::Converter.to_convert :html, :htm do |page, source_html|
-	# TODO: If the html is inside a body, strip out the surrounds.
-	source_html
+	body = Nokogiri.HTML( source_html ).at('body')
+	if page.meta.highlight!='off' && defined? CodeRay 
+		@coderay_languages ||= {}.tap do |h|
+			# Valid as of CodeRay 1.1
+			langs = h[:all] = %w[cpp cplusplus ecmascript java_script ecma_script rhtml erb eruby irb ruby javascript js pascal delphi patch diff plain text plaintext xhtml html yml yaml default c css clojure debug java groovy haml json php python raydebug sql xml]
+			h[:regex] = /(?<=\A|\s)language-(#{Regexp.union(langs)})(?=\s|\z)/
+			h[:css]   = langs.map{ |l| ".language-#{l}" }.join(',')
+		end
+		body.css(@coderay_languages[:css]).each do |possible|
+			if lang=possible['class'][@coderay_languages[:regex],1]
+				possible.inner_html = CodeRay.scan( possible.text, lang.to_sym ).html
+			end
+		end
+	end
+	body.inner_html
 end

data/lib/docubot/converters/markdown.rb

@@ -2,7 +2,8 @@
 begin
 	require 'kramdown'
 	DocuBot::Converter.to_convert :md, :markdown do |page, source|
-		Kramdown::Document.new(source,coderay_line_numbers:nil, coderay_css: :class).to_html
+		options = page.meta.highlight=='off' ? {enable_coderay:false} : {coderay_line_numbers:nil, coderay_css: :class}
+		Kramdown::Document.new(source,options).to_html
 	end
 rescue LoadError
 	warn "Unable to load kramdown gem; *.markdown/*.md markup will not be recognized as a page."

data/spec/samples/highlighting/HTML.html

@@ -0,0 +1,45 @@
+title: Highlighting HTML
++++
+<p>Here's some HTML to highlight:</p>
+<pre class="language-cpp">
+#include &lt;AtlasUtils/Plugin.h&gt;
+#include &lt;AtlasUtils/PluginRegistry.h&gt;
+
+#include "Cube.h"
+
+class CUBE_Plugin: public AtlasUtils::Plugin&lt;AtlasSG::NodePtr&gt;
+{
+    public:
+        // The constructor calls the super-class constructor
+        // passing it the plug-in's name "cube"
+        CUBE_Plugin():
+            AtlasUtils::Plugin&lt;AtlasSG::NodePtr&gt;("cube")
+        {
+        }
+
+        // The read method will be called whenever a request is
+        // made to open a file with an extension ".cube"
+        virtual AtlasSG::NodePtr read( const std::string &amp;filename )
+        {
+            // Since this is a pseudo-plug-in we can ignore the filename
+
+            return AtlasSG::NodePtr( new Cube );
+        }
+
+        virtual bool write( AtlasSG::NodePtr, const std::string &amp;)
+        { 
+            return false;
+        }
+};
+
+
+// The PLUGIN_PROXY macro instantiates an object of class CUBE_Plugin
+// when the dynamic shared object is loaded.
+
+PLUGIN_PROXY( CUBE_Plugin )
+</pre>
+
+<p>And here's an inline <code class="language-ruby">def call; end</code></p>
+<p>Here's one that's left untouched: <code id="untouched1">def call; end</code></p>
+<p>Here's another that's left untouched: <span id="untouched2" class="ruby">def call; end</span></p>
+

data/spec/samples/highlighting/Markdown.md

@@ -0,0 +1,47 @@
+title: Highlighting Markdown
++++
+Here's some code to highlight:
+
+~~~ cpp
+#include <AtlasUtils/Plugin.h>
+#include <AtlasUtils/PluginRegistry.h>
+
+#include "Cube.h"
+
+class CUBE_Plugin: public AtlasUtils::Plugin<AtlasSG::NodePtr>
+{
+    public:
+        // The constructor calls the super-class constructor
+        // passing it the plug-in's name "cube"
+        CUBE_Plugin():
+            AtlasUtils::Plugin<AtlasSG::NodePtr>("cube")
+        {
+        }
+
+        // The read method will be called whenever a request is
+        // made to open a file with an extension ".cube"
+        virtual AtlasSG::NodePtr read( const std::string &amp;filename )
+        {
+            // Since this is a pseudo-plug-in we can ignore the filename
+
+            return AtlasSG::NodePtr( new Cube );
+        }
+
+        virtual bool write( AtlasSG::NodePtr, const std::string &amp;)
+        { 
+            return false;
+        }
+};
+
+
+// The PLUGIN_PROXY macro instantiates an object of class CUBE_Plugin
+// when the dynamic shared object is loaded.
+
+PLUGIN_PROXY( CUBE_Plugin )
+~~~
+
+And here's an inline `def call; end`{: .language-ruby} Ruby code.
+
+Here's one that's left untouched: `def call; end`{: #untouched1}
+
+Here's another that's left untouched: <span id="untouched2" class="language-ruby">def call; end</span>

data/spec/samples/highlighting/NOHTML.html

@@ -0,0 +1,46 @@
+title: Highlighting No HTML
+highlight: off
++++
+<p>Here's some HTML to highlight:</p>
+<pre class="language-cpp">
+#include &lt;AtlasUtils/Plugin.h&gt;
+#include &lt;AtlasUtils/PluginRegistry.h&gt;
+
+#include "Cube.h"
+
+class CUBE_Plugin: public AtlasUtils::Plugin&lt;AtlasSG::NodePtr&gt;
+{
+    public:
+        // The constructor calls the super-class constructor
+        // passing it the plug-in's name "cube"
+        CUBE_Plugin():
+            AtlasUtils::Plugin&lt;AtlasSG::NodePtr&gt;("cube")
+        {
+        }
+
+        // The read method will be called whenever a request is
+        // made to open a file with an extension ".cube"
+        virtual AtlasSG::NodePtr read( const std::string &amp;filename )
+        {
+            // Since this is a pseudo-plug-in we can ignore the filename
+
+            return AtlasSG::NodePtr( new Cube );
+        }
+
+        virtual bool write( AtlasSG::NodePtr, const std::string &amp;)
+        { 
+            return false;
+        }
+};
+
+
+// The PLUGIN_PROXY macro instantiates an object of class CUBE_Plugin
+// when the dynamic shared object is loaded.
+
+PLUGIN_PROXY( CUBE_Plugin )
+</pre>
+
+<p>And here's an inline <code class="language-ruby">def call; end</code></p>
+<p>Here's one that's left untouched: <code id="untouched1">def call; end</code></p>
+<p>Here's another that's left untouched: <span id="untouched2" class="ruby">def call; end</span></p>
+

data/spec/samples/highlighting/NOMarkdown.md

@@ -0,0 +1,48 @@
+title: Highlighting No Markdown
+highlight:off
++++
+Here's some code to highlight:
+
+~~~ cpp
+#include <AtlasUtils/Plugin.h>
+#include <AtlasUtils/PluginRegistry.h>
+
+#include "Cube.h"
+
+class CUBE_Plugin: public AtlasUtils::Plugin<AtlasSG::NodePtr>
+{
+    public:
+        // The constructor calls the super-class constructor
+        // passing it the plug-in's name "cube"
+        CUBE_Plugin():
+            AtlasUtils::Plugin<AtlasSG::NodePtr>("cube")
+        {
+        }
+
+        // The read method will be called whenever a request is
+        // made to open a file with an extension ".cube"
+        virtual AtlasSG::NodePtr read( const std::string &amp;filename )
+        {
+            // Since this is a pseudo-plug-in we can ignore the filename
+
+            return AtlasSG::NodePtr( new Cube );
+        }
+
+        virtual bool write( AtlasSG::NodePtr, const std::string &amp;)
+        { 
+            return false;
+        }
+};
+
+
+// The PLUGIN_PROXY macro instantiates an object of class CUBE_Plugin
+// when the dynamic shared object is loaded.
+
+PLUGIN_PROXY( CUBE_Plugin )
+~~~
+
+And here's an inline `def call; end`{: .language-ruby} Ruby code.
+
+Here's one that's left untouched: `def call; end`{: #untouched1}
+
+Here's another that's left untouched: <span id="untouched2" class="language-ruby">def call; end</span>

data/spec/syntaxhighlighting.rb

@@ -0,0 +1,51 @@
+#encoding: UTF-8
+require_relative '_helper'
+
+describe "Applying syntax highlighting" do
+	before do
+		@bundle = DocuBot::Bundle.new SAMPLES/'highlighting'
+	end
+	
+	it "should highlight code in HTML" do
+		doc = @bundle.pages.find{ |p| p.meta.title=="Highlighting HTML" }.nokodoc
+		cpp_class = doc.at_css('pre.language-cpp span.class')
+		cpp_class.wont_be_nil
+		cpp_class.text.must_equal "CUBE_Plugin"
+
+		ruby_key = doc.at_css('code.language-ruby span.keyword')
+		ruby_key.wont_be_nil
+		ruby_key.text.must_equal "def"
+	end
+
+	it "should highlight code in Markdown" do
+		doc = @bundle.pages.find{ |p| p.meta.title=="Highlighting Markdown" }.nokodoc
+		cpp_class = doc.at_css('pre span.class')
+		cpp_class.wont_be_nil
+		cpp_class.text.must_equal "CUBE_Plugin"
+
+		ruby_key = doc.at_css('code.language-ruby span.keyword')
+		ruby_key.wont_be_nil
+		ruby_key.text.must_equal "def"
+	end
+
+	it "should not highlight code without a matching class" do
+		%w[ HTML Markdown ].each do |title|
+			doc = @bundle.pages.find{ |p| p.meta.title=="Highlighting #{title}" }.nokodoc
+			no_touch = doc.at_css('#untouched1')
+			no_touch.wont_be_nil
+			no_touch.inner_html.must_equal "def call; end"
+		end
+	end
+
+	it "should not highlight if turned off" do
+		%w[ HTML Markdown ].each do |title|
+			doc = @bundle.pages.find{ |p| p.meta.title=="Highlighting No #{title}" }.nokodoc
+			cpp_class = doc.at_css('pre.language-cpp span.class')
+			cpp_class.must_be_nil
+
+			ruby_key = doc.at_css('code.language-ruby span.keyword')
+			ruby_key.must_be_nil
+		end
+	end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docubot
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Gavin Kistner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -81,6 +81,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: DocuBot creates HTML or CHM documentation from a hierarchy of files,
   supporting markups like Markdown, Textile, and Haml.
 email: gavin@phrogz.net
@@ -255,6 +269,10 @@ files:
 - spec/samples/hierarchy/main.css
 - spec/samples/hierarchy/main.haml
 - spec/samples/hierarchy/toc.md
+- spec/samples/highlighting/HTML.html
+- spec/samples/highlighting/Markdown.md
+- spec/samples/highlighting/NOHTML.html
+- spec/samples/highlighting/NOMarkdown.md
 - spec/samples/links/index.txt
 - spec/samples/links/one two three.textile
 - spec/samples/links/pending.md
@@ -302,6 +320,7 @@ files:
 - spec/samples/underscores/_static/Foo/_ignoremore.txt
 - spec/samples/underscores/_static/_Bar/_ignoreevenmore.txt
 - spec/samples/underscores/subsection/_andignoreme.md
+- spec/syntaxhighlighting.rb
 - spec/templates.rb
 - spec/toc.rb
 - spec/writer/chm.rb
@@ -331,6 +350,7 @@ requirements:
 - kramdown gem for Markdown conversion.
 - RedCloth gem for Textile conversion.
 - MiniTest gem for running specifications.
+- CodeRay gem for syntax highlighting.
 rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: