rocco 0.7 → 0.8

data/CHANGES.md

@@ -1,6 +1,16 @@
 CHANGES
 =======
 
+0.8 (2011-06-19)
+----------------
+
+https://github.com/rtomayko/rocco/compare/0.7...0.8
+
+0.7 (2011-05-22)
+----------------
+
+https://github.com/rtomayko/rocco/compare/0.6...0.7
+
 0.6 (2011-03-05)
 ----------------
 

data/lib/rocco.rb

@@ -31,16 +31,15 @@
 
 #### Prerequisites
 
-# We'll need a Markdown library. [RDiscount][rd], if we're lucky. Otherwise,
-# issue a warning and fall back on using BlueCloth.
-#
-# [rd]: http://github.com/rtomayko/rdiscount
-begin
-  require 'rdiscount'
-rescue LoadError => boom
-  warn "WARNING: #{boom}. Trying bluecloth."
-  require 'bluecloth'
-  Markdown = BlueCloth
+# We'll need a Markdown library. Try to load one if not already established.
+if !defined?(Markdown)
+  libs = %w[redcarpet rdiscount bluecloth]
+  begin
+    require libs.shift
+  rescue LoadError => boom
+    retry if libs.any?
+    raise
+  end
 end
 
 # We use [{{ mustache }}](http://defunkt.github.com/mustache/) for
@@ -73,7 +72,7 @@ end
 #   to `nil` (that is, Mustache will use `./lib/rocco/layout.mustache`)_.
 #
 class Rocco
-  VERSION = '0.7'
+  VERSION = '0.8'
 
   def initialize(filename, sources=[], options={}, &block)
     @file       = filename
@@ -207,56 +206,8 @@ class Rocco
   #
   # At the moment, we're only returning `:single`.  Consider this
   # groundwork for block comment parsing.
-  C_STYLE_COMMENTS = {
-    :single => "//",
-    :multi  => { :start => "/**", :middle => "*", :end => "*/" },
-    :heredoc => nil
-  }
-  COMMENT_STYLES  = {
-    "bash"          =>  { :single => "#", :multi => nil },
-    "c"             =>  C_STYLE_COMMENTS,
-    "coffee-script" =>  {
-      :single => "#",
-      :multi  => { :start => "###", :middle => nil, :end => "###" },
-      :heredoc => nil
-    },
-    "cpp" =>  C_STYLE_COMMENTS,
-    "csharp" => C_STYLE_COMMENTS,
-    "css"           =>  {
-      :single => nil,
-      :multi  => { :start => "/**", :middle => "*", :end => "*/" },
-      :heredoc => nil
-    },
-    "html"           =>  {
-      :single => nil,
-      :multi => { :start => '<!--', :middle => nil, :end => '-->' },
-      :heredoc => nil
-    },
-    "java"          =>  C_STYLE_COMMENTS,
-    "js"            =>  C_STYLE_COMMENTS,
-    "lua"           =>  {
-      :single => "--",
-      :multi => nil,
-      :heredoc => nil
-    },
-    "php" => C_STYLE_COMMENTS,
-    "python"        =>  {
-      :single => "#",
-      :multi  => { :start => '"""', :middle => nil, :end => '"""' },
-      :heredoc => nil
-    },
-    "rb"            =>  {
-      :single => "#",
-      :multi  => { :start => '=begin', :middle => nil, :end => '=end' },
-      :heredoc => "<<-"
-    },
-    "scheme"        =>  { :single => ";;",  :multi => nil, :heredoc => nil },
-    "xml"           =>  {
-      :single => nil,
-      :multi => { :start => '<!--', :middle => nil, :end => '-->' },
-      :heredoc => nil
-    },
-  }
+  require 'rocco/comment_styles'
+  include CommentStyles
 
   def generate_comment_chars
     @_commentchar ||=
@@ -437,8 +388,7 @@ class Rocco
     # dividers and run through the Markdown processor. Then split it back out
     # into separate sections.
     markdown = docs_blocks.join("\n\n##### DIVIDER\n\n")
-    docs_html = Markdown.new(markdown, :smart).
-      to_html.
+    docs_html = process_markdown(markdown).
       split(/\n*<h5>DIVIDER<\/h5>\n*/m)
 
     # Combine all code blocks into a single big stream with section dividers and
@@ -492,6 +442,11 @@ class Rocco
     docs_html.zip(code_html)
   end
 
+  # Convert Markdown to classy HTML.
+  def process_markdown(text)
+    Markdown.new(text, :smart).to_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)

data/lib/rocco/comment_styles.rb

@@ -0,0 +1,56 @@
+class Rocco
+  module CommentStyles
+    C_STYLE_COMMENTS = {
+      :single => "//",
+      :multi  => { :start => "/**", :middle => "*", :end => "*/" },
+      :heredoc => nil
+    }
+
+    COMMENT_STYLES  = {
+      "bash"          =>  { :single => "#", :multi => nil },
+      "c"             =>  C_STYLE_COMMENTS,
+      "coffee-script" =>  {
+        :single => "#",
+        :multi  => { :start => "###", :middle => nil, :end => "###" },
+        :heredoc => nil
+      },
+      "cpp" =>  C_STYLE_COMMENTS,
+      "csharp" => C_STYLE_COMMENTS,
+      "css"           =>  {
+        :single => nil,
+        :multi  => { :start => "/**", :middle => "*", :end => "*/" },
+        :heredoc => nil
+      },
+      "html"           =>  {
+        :single => nil,
+        :multi => { :start => '<!--', :middle => nil, :end => '-->' },
+        :heredoc => nil
+      },
+      "java"          =>  C_STYLE_COMMENTS,
+      "js"            =>  C_STYLE_COMMENTS,
+      "lua"           =>  {
+        :single => "--",
+        :multi => nil,
+        :heredoc => nil
+      },
+      "php" => C_STYLE_COMMENTS,
+      "python"        =>  {
+        :single => "#",
+        :multi  => { :start => '"""', :middle => nil, :end => '"""' },
+        :heredoc => nil
+      },
+      "rb"            =>  {
+        :single => "#",
+        :multi  => { :start => '=begin', :middle => nil, :end => '=end' },
+        :heredoc => "<<-"
+      },
+      "scala"         =>  C_STYLE_COMMENTS,
+      "scheme"        =>  { :single => ";;",  :multi => nil, :heredoc => nil },
+      "xml"           =>  {
+        :single => nil,
+        :multi => { :start => '<!--', :middle => nil, :end => '-->' },
+        :heredoc => nil
+      },
+    }
+  end
+end

data/lib/rocco/layout.rb

@@ -15,9 +15,14 @@ class Rocco::Layout < Mustache
     File.basename(@doc.file)
   end
 
+  def file
+    @doc.file
+  end
+
   def sections
     num = 0
     @doc.sections.map do |docs,code|
+      code ||= ''
       is_header = /^<h.>(.+)<\/h.>$/.match( docs )
       header_text = is_header && is_header[1].split.join("_")
       num += 1

data/lib/rocco/tasks.rb

@@ -58,6 +58,8 @@ class Rocco
   # `Rocco::Task.new` takes a task name, the destination directory docs
   # should be built under, and a source file pattern or file list.
   class Task
+    include Rake::DSL if defined?(Rake::DSL)
+
     def initialize(task_name, dest='docs/', sources='lib/**/*.rb', options={})
       @name = task_name
       @dest = dest[-1] == ?/ ? dest : "#{dest}/"

data/rocco.gemspec

@@ -1,10 +1,15 @@
+# rocco.gemspec
+#
+# To update this file's version, date, and file list, change the VERSION
+# constant in lib/rocco.rb and run `rake rocco.gemspec`.
+
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.name = 'rocco'
-  s.version = '0.7'
-  s.date = '2011-05-22'
+  s.version = '0.8'
+  s.date = '2011-06-19'
 
   s.description = "Docco in Ruby"
   s.summary     = s.description
@@ -20,6 +25,7 @@ Gem::Specification.new do |s|
     Rakefile
     bin/rocco
     lib/rocco.rb
+    lib/rocco/comment_styles.rb
     lib/rocco/layout.mustache
     lib/rocco/layout.rb
     lib/rocco/tasks.rb
@@ -46,7 +52,7 @@ Gem::Specification.new do |s|
   s.executables = ["rocco"]
 
   s.test_files = s.files.select {|path| path =~ /^test\/.*_test.rb/}
-  s.add_dependency 'rdiscount'
+  s.add_dependency 'redcarpet'
   s.add_dependency 'mustache'
 
   s.has_rdoc = false

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rocco
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 7
-  version: "0.7"
+  - 8
+  version: "0.8"
 platform: ruby
 authors: 
 - Ryan Tomayko
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-22 00:00:00 -07:00
+date: 2011-06-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rdiscount
+  name: redcarpet
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -63,6 +63,7 @@ files:
 - Rakefile
 - bin/rocco
 - lib/rocco.rb
+- lib/rocco/comment_styles.rb
 - lib/rocco/layout.mustache
 - lib/rocco/layout.rb
 - lib/rocco/tasks.rb