highlight-code 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gem "nokogiri"
+gem "coderay"

data/Gemfile.lock

@@ -0,0 +1,12 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.5)
+    nokogiri (1.5.0-x86-mingw32)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  coderay
+  nokogiri

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Philippe Monnet, http://blog.monnet-usa.com/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+##  highlight-code ##
+
+### Rationale ###
+When I write blog posts and tutorials I include many code samples and apply syntax highlighting to increase readability. For that I use Alex Gorbatchev's excellent [SyntaxHighlighter](http://alexgorbatchev.com/SyntaxHighlighter/) Javascript library. But if I am interested in creating eBooks the challenge is to maintain the highlighting. Since the markup needs to be all inclusive, I need a "pre-processor" to take my markup and apply syntax highlighting so that the final XHTML can be used for the eBook. 
+
+highlight-code is a small Ruby utility which will take a XHTML document as input and apply syntax highlighting and save the resulting XHTML in an output file.
+
+### Why a new library? ###
+Actually this is really a command line utility built "on the shoulders of giants", i.e. [Nokogiri](http://nokogiri.org/) and [CodeRay](http://coderay.rubychan.de/). "They" do the heavy lift, I am just assembling them into a utility to help me apply syntax highlighting to XHTML markup containing code samples (in pre/code tags).
+
+### Installation ###
+
+	gem install highlight-code
+
+### Simple Usage ###
+
+	highligh-code test.xhtml
+
+### Syntax ###
+
+	highlight-code XHTMLFILEPATH [OPTIONS]
+
+	XHTMLFILEPATH: The .xhtml file containing the code to highlight
+
+	OPTIONS:
+		-c, --css-path PATH/TO/CSS/FILES 	path for the coderay.css (default same location as the input file)
+		-e, --extension EXTENSION        	extension for the processed / output file (default: .highlighted.xhtml)
+		-t, --tag TAG                    	type of tag (pre or code) containing the code to highlight 
+											(note: the css class must follow the syntax: brush: language, e.g. brush: ruby)
+											(default: both)
+		-h, --help                       	help
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/highlight-code

@@ -0,0 +1 @@
+#!/usr/bin/env ruby
  opt.banner = "Usage: highlight-code XHTMLFILEPATH [OPTIONS]"
  opt.separator  ""
  opt.separator  "XHTMLFILEPATH: The .xhtml file containing the code to highlight"
  opt.separator  ""
  opt.separator  "Options"
 
  opt.on("-c","--css-path PATH/TO/CSS/FILES","path for the coderay.css (default same location as the input file)") do | csspath |
    options[:csspath] = csspath
  end
 
  opt.on("-e","--extension EXTENSION","extension for the processed / output file (default: .highlighted.xhtml)") do | extension |
    options[:extension] = extension
  end
  opt.on("-t","--tag TAG",
    options[:tag] = tag
  end
 
 opt.on("-h","--help","help") do
    puts opt_parser
  end

data/examples/README.md

@@ -0,0 +1,11 @@
+## README ##
+
+	cd examples
+	highlight-code test.xhtml
+
+This should produce 2 files:
+
+  * test.xhtml.highlighted.xhtml - the markup has been processed and your code and pre tags have been replaced by divs with styling
+  * coderay.css - the basic CSS needed to render the highlighting
+
+You should be able to view test.xhtml.highlighted.xhtml in a browser.

data/examples/test.xhtml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"[]>
+<html>
+  <head>
+    <link rel="stylesheet" type="text/css" href="custom.css" />
+    <title>Creating Rich Interactive Web Applications With KnockoutJS</title>
+  </head>
+  <body>
+  
+		<p>This is an example of HTML code:</p>
+<pre class="brush: html">
+&lt;div id='test'&gt;
+	&lt;span&gt;Hello&lt;/span&gt;
+&lt;/div&gt;
+</pre>
+
+		<p>This is an example of Javascript code:</p>
+<code class="brush: javascript">
+function doThis(parm1) {
+	return parm1;
+}
+</code>		
+
+		<p>This is an example of Ruby code:</p>
+<code class="brush: ruby">
+def do_this(parm1)
+	parm1
+end
+</code>
+
+	<p>This is an example of unknown code (to be left alone):</p>
+<pre>
+declare doThis(string parm1)
+	parm1
+end
+</pre>		
+  </body>
+</html>

data/highlight-code.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "highlight-code/version"
+
+Gem::Specification.new do |s|
+  s.name        = "highlight-code"
+  s.version     = HighlightCode::VERSION
+  s.authors     = ["Philippe Monnet"]
+  s.email       = ["techarch@monnet-usa.com"]
+  s.homepage    = "http://blog.monnet-usa.com/"
+  s.summary     = %q{highlight-code is a small Ruby utility which will take a XHTML document as input and apply syntax highlighting and save the resulting XHTML in an output file.}
+  s.description = <<-EOF
+  highlight-code will help you post-process an XHTML document containing code examples in pre or code tags so that the code is highlighted. The pre and code tags need to follow the class conventions from Alex Gorbatchev's SyntaxHighlighter (http://alexgorbatchev.com/SyntaxHighlighter/) Javascript library. The resulting file can be used for an eBook. 
+  EOF
+  s.licenses = ['MIT']
+  s.rubyforge_project = "highlight-code"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 1.9.1'
+  # specify any dependencies here; for example:
+  s.add_runtime_dependency "nokogiri"
+  s.add_runtime_dependency "coderay"
+end

data/lib/highlight-code.rb

@@ -0,0 +1,135 @@
+require "rubygems"
+require "bundler/setup"
+
+require 'FileUtils'
+require 'nokogiri'
+require 'coderay'
+
+class CodeHighlighter
+	attr_accessor :doc, :code_nodes, :output_file_path, :options
+
+	CODERAY_CSS_FILE_NAME = "coderay.css"
+	HIGHLIGHTED_EXTENSION = ".highlighted.xhtml"
+	
+	def initialize(options = { })
+		self.code_nodes = Array.new
+		self.output_file_path = nil
+		self.options = options
+		return self
+	end
+
+	def self.parse(path, options = { })
+		ch = CodeHighlighter.new options
+		ch.parse path
+		ch
+	end
+	
+	def self.highlight(path, options = { })
+		ch = CodeHighlighter.parse path, options
+		return nil unless ch.doc
+		
+		begin
+			ch.highlight
+			ch.save
+		rescue Object => ex
+			puts "Cannot highlight #{path} due to: #{ex}"
+		end
+		
+		@output_file_path
+	end
+	
+	def parse (path)
+		begin
+			# get the file contents
+			@path = path
+			puts "Parsing #{@path}"
+			f = File.open(@path)
+			
+			# parse the file
+			@doc = Nokogiri::XML(f)
+			
+			# find code/pre or both tag(s)
+			tag = @options[:tag] || 'both'
+			tag = 'code,pre' if tag == 'both'
+			@code_nodes = doc.css(tag)
+			puts "Found #{@code_nodes.length} nodes"
+		rescue Object => ex
+			puts "Cannot open #{path} due to: #{ex}"
+		ensure
+			f.close
+		end
+	end
+	
+	def highlight
+		puts "Highlight with options: #{@options}"
+		
+		@code_nodes.each do | code_node |
+			brush = code_node['class']
+			brush_spec = brush ? brush.split(' ') : [ ]
+			language_code = (brush_spec.count > 1) ? brush_spec.last : "N/A"
+			
+			if language_code != "N/A"
+				puts "Found node #{language_code} #{code_node.text}"
+				
+				# Highlight the code 
+				highlighted_code = CodeRay.scan(code_node.text.strip, language_code.to_sym).div(:css => :class, :tab_width => 4, :line_numbers => :inline)
+
+				# Transform the pre node into a div
+				code_node.name = "div"
+				code_node['class'] = "code"
+				code_node.content=  ''
+				
+				highlighted_code_node = Nokogiri::XML(highlighted_code)
+				code_node.add_child highlighted_code_node.children.first
+			else
+				puts "Found unrecognizable language in source: #{code_node.text}"				
+			end #if
+		end #each
+	end #def
+	
+	def include_css
+		code_ray_css_node = @doc.css("link[href*='" + CODERAY_CSS_FILE_NAME + "']")
+		return unless code_ray_css_node.count == 0
+		
+		src_css_file_path	= File.dirname(__FILE__) + '/../resources/' + CODERAY_CSS_FILE_NAME
+
+		dest_directory			= File.dirname(@path)
+		css_path = @options[:csspath] || dest_directory
+		dest_css_file_path	= dest_directory + '/' + CODERAY_CSS_FILE_NAME
+		FileUtils.copy_file(src_css_file_path, dest_css_file_path)
+		puts "Created the CSS file: #{dest_css_file_path}"
+		
+		code_ray_css_node = Nokogiri::XML::Node.new "link", @doc
+		code_ray_css_node['rel'] = 'stylesheet'
+		code_ray_css_node['type'] = 'text/css'
+		code_ray_css_node['href'] = CODERAY_CSS_FILE_NAME
+		
+		head_node = @doc.css('head').first
+		unless head_node
+			head_node = Nokogiri::XML::Node.new "head", @doc
+			body_node = @doc.css('body').first
+			body_node.add_child head_node
+		end
+		
+		head_node.add_child code_ray_css_node
+		puts "Added CSS: #{code_ray_css_node}"
+	end
+	
+	def save
+		include_css
+		
+		begin
+			extension = @options[:extension] || HIGHLIGHTED_EXTENSION
+			@output_file_path = @path + extension
+			puts "Saving result to #{@output_file_path} ..."
+			f = File.open(@output_file_path, "w")
+			f.write(@doc.to_xhtml)
+		rescue Object => ex
+			puts "Cannot save the result to #{@path} due to: #{ex}"
+		ensure
+			f.close
+		end
+	end
+	
+end #class
+

data/lib/highlight-code/version.rb

@@ -0,0 +1,3 @@
+module HighlightCode
+  VERSION = "0.0.1"
+end

data/resources/coderay.css

@@ -0,0 +1,120 @@
+.CodeRay {
+  background-color: hsl(0,0%,95%);
+  border: 1px solid silver;
+  color: black;
+}
+.CodeRay pre {
+  margin: 0px;
+}
+
+span.CodeRay { white-space: pre; border: 0px; padding: 2px; }
+
+table.CodeRay { border-collapse: collapse; width: 100%; padding: 2px; }
+table.CodeRay td { padding: 2px 4px; vertical-align: top; }
+
+.CodeRay .line-numbers {
+  background-color: hsl(180,65%,90%);
+  color: gray;
+  text-align: right;
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  user-select: none;
+}
+.CodeRay .line-numbers a {
+  background-color: hsl(180,65%,90%) !important;
+  color: gray !important;
+  text-decoration: none !important;
+}
+.CodeRay .line-numbers a:target { color: blue !important; }
+.CodeRay .line-numbers .highlighted { color: red !important; }
+.CodeRay .line-numbers .highlighted a { color: red !important; }
+.CodeRay span.line-numbers { padding: 0px 4px; }
+.CodeRay .line { display: block; float: left; width: 100%; }
+.CodeRay .code { width: 100%; }
+
+.CodeRay .debug { color: white !important; background: blue !important; }
+
+.CodeRay .annotation { color:#007 }
+.CodeRay .attribute-name { color:#b48 }
+.CodeRay .attribute-value { color:#700 }
+.CodeRay .binary { color:#509 }
+.CodeRay .char .content { color:#D20 }
+.CodeRay .char .delimiter { color:#710 }
+.CodeRay .char { color:#D20 }
+.CodeRay .class { color:#B06; font-weight:bold }
+.CodeRay .class-variable { color:#369 }
+.CodeRay .color { color:#0A0 }
+.CodeRay .comment { color:#777 }
+.CodeRay .comment .char { color:#444 }
+.CodeRay .comment .delimiter { color:#444 }
+.CodeRay .complex { color:#A08 }
+.CodeRay .constant { color:#036; font-weight:bold }
+.CodeRay .decorator { color:#B0B }
+.CodeRay .definition { color:#099; font-weight:bold }
+.CodeRay .delimiter { color:black }
+.CodeRay .directive { color:#088; font-weight:bold }
+.CodeRay .doc { color:#970 }
+.CodeRay .doc-string { color:#D42; font-weight:bold }
+.CodeRay .doctype { color:#34b }
+.CodeRay .entity { color:#800; font-weight:bold }
+.CodeRay .error { color:#F00; background-color:#FAA }
+.CodeRay .escape  { color:#666 }
+.CodeRay .exception { color:#C00; font-weight:bold }
+.CodeRay .float { color:#60E }
+.CodeRay .function { color:#06B; font-weight:bold }
+.CodeRay .global-variable { color:#d70 }
+.CodeRay .hex { color:#02b }
+.CodeRay .imaginary { color:#f00 }
+.CodeRay .include { color:#B44; font-weight:bold }
+.CodeRay .inline { background-color: hsla(0,0%,0%,0.07); color: black }
+.CodeRay .inline-delimiter { font-weight: bold; color: #666 }
+.CodeRay .instance-variable { color:#33B }
+.CodeRay .integer  { color:#00D }
+.CodeRay .key .char { color: #60f }
+.CodeRay .key .delimiter { color: #404 }
+.CodeRay .key { color: #606 }
+.CodeRay .keyword { color:#080; font-weight:bold }
+.CodeRay .label { color:#970; font-weight:bold }
+.CodeRay .local-variable { color:#963 }
+.CodeRay .namespace { color:#707; font-weight:bold }
+.CodeRay .octal { color:#40E }
+.CodeRay .operator { }
+.CodeRay .predefined { color:#369; font-weight:bold }
+.CodeRay .predefined-constant { color:#069 }
+.CodeRay .predefined-type { color:#0a5; font-weight:bold }
+.CodeRay .preprocessor { color:#579 }
+.CodeRay .pseudo-class { color:#00C; font-weight:bold }
+.CodeRay .regexp .content { color:#808 }
+.CodeRay .regexp .delimiter { color:#404 }
+.CodeRay .regexp .modifier { color:#C2C }
+.CodeRay .regexp { background-color:hsla(300,100%,50%,0.06); }
+.CodeRay .reserved { color:#080; font-weight:bold }
+.CodeRay .shell .content { color:#2B2 }
+.CodeRay .shell .delimiter { color:#161 }
+.CodeRay .shell { background-color:hsla(120,100%,50%,0.06); }
+.CodeRay .string .char { color: #b0b }
+.CodeRay .string .content { color: #D20 }
+.CodeRay .string .delimiter { color: #710 }
+.CodeRay .string .modifier { color: #E40 }
+.CodeRay .string { background-color:hsla(0,100%,50%,0.05); }
+.CodeRay .symbol .content { color:#A60 }
+.CodeRay .symbol .delimiter { color:#630 }
+.CodeRay .symbol { color:#A60 }
+.CodeRay .tag { color:#070 }
+.CodeRay .type { color:#339; font-weight:bold }
+.CodeRay .value { color: #088; }
+.CodeRay .variable  { color:#037 }
+
+.CodeRay .insert { background: hsla(120,100%,50%,0.12) }
+.CodeRay .delete { background: hsla(0,100%,50%,0.12) }
+.CodeRay .change { color: #bbf; background: #007; }
+.CodeRay .head { color: #f8f; background: #505 }
+.CodeRay .head .filename { color: white; }
+
+.CodeRay .delete .eyecatcher { background-color: hsla(0,100%,50%,0.2); border: 1px solid hsla(0,100%,45%,0.5); margin: -1px; border-bottom: none; border-top-left-radius: 5px; border-top-right-radius: 5px; }
+.CodeRay .insert .eyecatcher { background-color: hsla(120,100%,50%,0.2); border: 1px solid hsla(120,100%,25%,0.5); margin: -1px; border-top: none; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; }
+
+.CodeRay .insert .insert { color: #0c0; background:transparent; font-weight:bold }
+.CodeRay .delete .delete { color: #c00; background:transparent; font-weight:bold }
+.CodeRay .change .change { color: #88f }
+.CodeRay .head .head { color: #f4f }

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: highlight-code
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Philippe Monnet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &9329364 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9329364
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: &9381516 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9381516
+description: ! "  highlight-code will help you post-process an XHTML document containing
+  code examples in pre or code tags so that the code is highlighted. The pre and code
+  tags need to follow the class conventions from Alex Gorbatchev's SyntaxHighlighter
+  (http://alexgorbatchev.com/SyntaxHighlighter/) Javascript library. The resulting
+  file can be used for an eBook. \n"
+email:
+- techarch@monnet-usa.com
+executables:
+- highlight-code
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/highlight-code
+- examples/README.md
+- examples/test.xhtml
+- highlight-code.gemspec
+- lib/highlight-code.rb
+- lib/highlight-code/version.rb
+- resources/coderay.css
+homepage: http://blog.monnet-usa.com/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: highlight-code
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: highlight-code is a small Ruby utility which will take a XHTML document as
+  input and apply syntax highlighting and save the resulting XHTML in an output file.
+test_files: []