rocco 0.4 → 0.5

data/bin/rocco

@@ -7,14 +7,14 @@
 #/   -c, --comment-chars=<chars>
 #/                          The string to recognize as a comment marker
 #/   -o, --output=<dir>     Directory where generated HTML files are written
-#/
 #/       --help             Show this help message
 
 require 'optparse'
+require 'fileutils'
 
 # Write usage message to stdout and exit.
 def usage(stream=$stderr, status=1)
-  stream.puts File.read(__FILE__).
+  stream.puts File.readlines(__FILE__).
     grep(/^#\//).
     map { |line| line.sub(/^#. ?/, '') }.
     join
@@ -35,12 +35,20 @@ options = {}
 ARGV.options { |o|
   o.program_name = File.basename($0)
   o.on("-o", "--output=DIR") { |dir| output_dir = dir }
-	o.on("-l", "--language=LANG") { |lang| options[:language] = lang }
-	o.on("-c", "--comment-chars=CHARS") { |chars| options[:comment_chars] = Regexp.escape(chars) }
+  o.on("-l", "--language=LANG") { |lang| options[:language] = lang }
+  o.on("-c", "--comment-chars=CHARS") { |chars| options[:comment_chars] = Regexp.escape(chars) }
   o.on_tail("-h", "--help") { usage($stdout, 0) }
   o.parse!
 } or abort_with_note
 
+# Use http://pygments.appspot.com in case `pygmentize(1)` isn't available.
+if ! ENV['PATH'].split(':').any? { |dir| File.exist?("#{dir}/pygmentize") }
+  unless options[:webservice]
+    $stderr.puts "pygmentize not in PATH; using pygments.appspot.com instead"
+    options[:webservice] = true
+  end
+end
+
 # Eat sources from ARGV.
 sources << ARGV.shift while ARGV.any?
 
@@ -77,13 +85,11 @@ rescue LoadError
   raise
 end
 
-# Create the output directory if it doesn't already exist.
-Dir.mkdir output_dir if !File.directory?(output_dir)
-
 # Run each file through Rocco and write output.
 sources.each do |filename|
   rocco = Rocco.new(filename, sources, options)
-  dest = filename.split('.')[0..-2].join('.') + '.html'
+  dest = File.join(output_dir, (filename.split('.')[0..-2].empty? ? filename : filename.split('.')[0..-2].join('.')) + '.html')
   puts "rocco: #{filename} -> #{dest}"
+  FileUtils.mkdir_p File.dirname(dest)
   File.open(dest, 'wb') { |fd| fd.write(rocco.to_html) }
 end

data/lib/rocco.rb

@@ -38,7 +38,7 @@
 begin
   require 'rdiscount'
 rescue LoadError => boom
-  warn "warn: #{boom}. trying bluecloth"
+  warn "WARNING: #{boom}. Trying bluecloth."
   require 'bluecloth'
   Markdown = BlueCloth
 end
@@ -47,11 +47,14 @@ end
 # HTML templating.
 require 'mustache'
 
+# We use `Net::HTTP` to highlight code via <http://pygments.appspot.com>
+require 'net/http'
+
 # Code is run through [Pygments](http://pygments.org/) for syntax
-# highlighting. Fail fast right here if we can't find the `pygmentize`
-# program on PATH.
-if ! ENV['PATH'].split(':').any? { |dir| File.exist?("#{dir}/pygmentize") }
-  fail "Pygments is required for syntax highlighting"
+# highlighting. If it's not installed, locally, use a webservice.
+include FileTest
+if !ENV['PATH'].split(':').any? { |dir| executable?("#{dir}/pygmentize") }
+  warn "WARNING: Pygments not found. Using webservice."
 end
 
 #### Public Interface
@@ -66,7 +69,7 @@ end
 # means necessary and return it as a string. With no `block`, the file is read
 # to retrieve data.
 class Rocco
-  VERSION = '0.4'
+  VERSION = '0.5'
 
   def initialize(filename, sources=[], options={}, &block)
     @file = filename
@@ -76,7 +79,10 @@ class Rocco
       else
         File.read(filename)
       end
-    defaults = { :language => 'ruby', :comment_chars => '#' }
+    defaults = {
+      :language      => 'ruby',
+      :comment_chars => '#',
+    }
     @options = defaults.merge(options)
     @sources = sources
     @comment_pattern = Regexp.new("^\\s*#{@options[:comment_chars]}")
@@ -157,15 +163,36 @@ class Rocco
       to_html.
       split(/\n*<h5>DIVIDER<\/h5>\n*/m)
 
-    # Combine all code blocks into a single big stream and run through
-    # Pygments. We `popen` a read/write pygmentize process in the parent and
-    # then fork off a child process to write the input.
+    # Combine all code blocks into a single big stream and run through either
+    # `pygmentize(1)` or <http://pygments.appspot.com>
+    code_stream = code_blocks.join("\n\n#{@options[:comment_chars]} DIVIDER\n\n")
+
+    if ENV['PATH'].split(':').any? { |dir| executable?("#{dir}/pygmentize") }
+      code_html = highlight_pygmentize(code_stream)
+    else 
+      code_html = highlight_webservice(code_stream)
+    end
+
+    # Do some post-processing on the pygments output to split things back
+    # into sections and remove partial `<pre>` blocks.
+    code_html = code_html.
+      split(/\n*<span class="c.">#{@options[:comment_chars]} DIVIDER<\/span>\n*/m).
+      map { |code| code.sub(/\n?<div class="highlight"><pre>/m, '') }.
+      map { |code| code.sub(/\n?<\/pre><\/div>\n/m, '') }
+
+    # Lastly, combine the docs and code lists back into a list of two-tuples.
+    docs_html.zip(code_html)
+  end
+
+  # We `popen` a read/write pygmentize process in the parent and
+  # then fork off a child process to write the input.
+  def highlight_pygmentize(code)
     code_html = nil
     open("|pygmentize -l #{@options[:language]} -f html", 'r+') do |fd|
       pid =
         fork {
           fd.close_read
-          fd.write code_blocks.join("\n\n# DIVIDER\n\n")
+          fd.write code
           fd.close_write
           exit!
         }
@@ -175,15 +202,16 @@ class Rocco
       Process.wait(pid)
     end
 
-    # Do some post-processing on the pygments output to split things back
-    # into sections and remove partial `<pre>` blocks.
-    code_html = code_html.
-      split(/\n*<span class="c1"># DIVIDER<\/span>\n*/m).
-      map { |code| code.sub(/\n?<div class="highlight"><pre>/m, '') }.
-      map { |code| code.sub(/\n?<\/pre><\/div>\n/m, '') }
-
-    # Lastly, combine the docs and code lists back into a list of two-tuples.
-    docs_html.zip(code_html)
+    code_html
+  end
+  
+  # Pygments is not one of those things that's trivial for a ruby user to install,
+  # so we'll fall back on a webservice to highlight the code if it isn't available.
+  def highlight_webservice(code)
+    Net::HTTP.post_form(
+      URI.parse('http://pygments.appspot.com/'),
+      {'lang' => @options['language'], 'code' => code}
+    ).body
   end
 end
 

data/rocco.gemspec

@@ -3,8 +3,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.name = 'rocco'
-  s.version = '0.4'
-  s.date = '2010-03-19'
+  s.version = '0.5'
+  s.date = '2010-09-10'
 
   s.description = "Docco in Ruby"
   s.summary     = s.description

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  version: "0.4"
+  - 5
+  version: "0.5"
 platform: ruby
 authors: 
 - Ryan Tomayko
@@ -13,13 +13,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-19 00:00:00 -07:00
+date: 2010-09-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rdiscount
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -32,6 +33,7 @@ dependencies:
   name: mustache
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -68,6 +70,7 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -75,6 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -84,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 2
 summary: Docco in Ruby