nanoc-code-classifier 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,53 @@
+# nanoc-code-classifier
+
+The nanoc syntax highlighting filter (Nanoc3::Filters::ColorizeSyntax) requires that the class of the `code` element is set to the language used in the `code` element. However it is impossible to set a class in markup formats other than HTML (e.g. markdown, textile, etc).
+
+This nanoc filter pre-processes HTML for `code` elements for simple tags which are used to modify the markup for your code blocks.
+
+For example, the following markdown:
+
+    This is a code block in ruby:
+
+        [@language="ruby"]
+        [@caption="Listing 1: Example in ruby."]
+
+        puts "hello world"
+
+    And this is a code block in javascript:
+
+        [@language="javascript"]
+        [@caption="Listing 2: Example in javascript."]
+
+        alert("hello world");
+
+becomes:
+
+    <p>This is a code block in ruby:</p>
+
+    <figure>
+      <pre><code class="language-ruby">
+      puts "hello world"
+      </code></pre>
+      <figcaption>Listing 1: Example in ruby.</figcaption>
+    </figure>
+
+    <p>And this is a code block in javascript:</p>
+
+    <figure>
+      <pre><code class="language-javascript">
+      alert("hello world");
+      </code></pre>
+      <figcaption>Listing 2: Example in javascript.</figcaption>
+    </figure>
+
+
+## Quickstart
+
+This rule first generates HTML from markdown using bluecloth, then applies the language classes using nanoc-code-classifier and finally highlights the syntax using coderay.
+
+    compile "/*/" do
+      filter :bluecloth
+      filter :code_classifier, :pre_class => "coderay"
+      filter :colorize_syntax, :colorizers => {:ruby => :coderay}
+      layout "default"
+    end

data/lib/nanoc-code-classifier.rb

@@ -1 +1 @@
-require "nanoc3/filters/code_classifier"
+require 'nanoc3/filters/code_classifier'

data/lib/nanoc3/filters/code_classifier.rb

@@ -2,21 +2,59 @@ require 'nokogiri'
 
 module Nanoc3
   module Filters
-    # A nanoc filter which pre-processes a code block for a language tag.
+    # A nanoc filter which pre-processes code elements for special tags.
+    #
+    # For example:
+    #
+    #     [@language="ruby"]
+    #     [@caption="lorem ipsum"]
     class CodeClassifier < Nanoc3::Filter
       identifier :code_classifier
       type :text
 
       def run(content, params = {})
-        doc = Nokogiri::HTML.fragment(content)
-        doc.css("pre > code").each do |element|
-          element.content = element.content.sub(/\s*@(language-\w+)\s*/) do
-            element["class"] = $1
-            element.parent["class"] = "coderay"
-            nil
-          end.strip
+        html = Nokogiri::HTML.fragment(content)
+
+        html.xpath("pre/code").each do |code|
+          pre = code.parent
+
+          # Set the class on the <pre>.
+          append_class(pre, params[:pre_class]) if params[:pre_class]
+
+          process_language_tag(code)
+          process_caption_tag(code)
         end
-        doc.to_s
+
+        html.to_s
+      end
+
+    private
+
+      def process_language_tag(element)
+        element.content = element.content.sub(/\[\s*@language\s*=\s*"([^"]+)"\s*\]/) do
+          append_class(element, "language-#{$1}")
+          nil
+        end.strip!
+      end
+
+      def process_caption_tag(element)
+        element.content = element.content.sub(/\[\s*@caption\s*=\s*"([^"]+)"\s*\]/) do
+          # Wrap in a <figure>.
+          figure = Nokogiri::XML::Node.new("figure", element.document)
+          element.parent.add_next_sibling(figure)
+          element.parent.parent = figure
+
+          # Add a <figcaption>.
+          figcaption = Nokogiri::XML::Node.new("figcaption", element.document)
+          figcaption.content = $1
+          element.parent.add_next_sibling(figcaption)
+
+          nil
+        end.strip!
+      end
+
+      def append_class(element, klass)
+        element["class"] = ((element["class"] || "") + " " + klass).strip
       end
     end
   end

data/lib/nanoc3/filters/code_classifier/version.rb

@@ -1,7 +1,7 @@
 module Nanoc3
   module Filters
     module CodeClassifier
-      VERSION = "0.0.2"
+      VERSION = "0.0.3"
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc-code-classifier
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Josh Bassett
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-19 00:00:00 +11:00
+date: 2011-01-21 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,14 +24,30 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 15
         segments: 
+        - 1
         - 0
-        version: "0"
+        version: "1.0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nanoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
 description: By using special tags the code classifier filter can pre-process you code blocks and apply classes to the generated HTML.
 email: josh.bassett@gmail.com
 executables: []