crohr-docapi 0.1.1 → 0.1.2

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/docapi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{docapi}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril Rohr"]
-  s.date = %q{2009-09-09}
+  s.date = %q{2009-09-10}
   s.default_executable = %q{docapi}
   s.description = %q{RDoc template for generating API documentation.}
   s.email = %q{cyril.rohr@gmail.com}

data/files/stylesheets/documentation/layout.css

@@ -11,9 +11,12 @@ h1 {
   margin:0.8em 0 0.3em;
 }
 h2 {
-  font-size: 1.2em;
+  font-size: 1.4em;
   font-family: 'Bitstream Vera Sans Mono', Monaco, monospace, courier, 'courier new';
 }
+h3 {
+  font-family: "Courier New";
+}
 pre
 {
 /*  margin: 0 0 10px 0;*/
@@ -75,11 +78,14 @@ p.page-title {
   font-weight: bold;
   font-size: 2em;
 }
-
-ol.methods {
-/*  list-style-type: none;*/
+.docapi-section {
+  margin-left: 15px;
+}
+.docapi-subsection {
+  padding: 5px;
+  margin-bottom: 20px;
 }
-ol.methods .synopsis {
+.docapi-subsection .docapi-title {
   padding: 3px 10px;
   font-size: 1.4em;
   background: #336699;
@@ -88,11 +94,10 @@ ol.methods .synopsis {
   font-weight: bold;
   font-family: "Courier New";
 }
-ol.methods li {
-  padding: 5px;
-  margin-bottom: 20px;
-}
-ol.methods li h2 {
+.docapi-subsection .docapi-subtitle {
+  font-size: 1.1em;
+  font-weight: bold;
+  font-family: 'Bitstream Vera Sans Mono', Monaco, monospace, courier, 'courier new';
   margin:20px 2px 5px 0px;
   border-left: 5px solid orange;
   padding-left: 5px;

data/lib/docapi.rb

@@ -21,49 +21,63 @@ class Docapi
     output_dir.mkpath
     output = File.open(output_dir+"index.html", "w+")
     output << header(:title => options[:title])
-    convert_directory(input_dir, output)
+    output << convert_directory(input_dir)
     output << footer
     output.close
     # copy stylesheets and javascripts files
     FileUtils.cp_r(File.join(File.dirname(__FILE__), "..", "files", "."), output_dir)
   end
   
-  def convert_directory(dir, output, level = 1)
+  def convert_directory(dir, level = 1)
+    output = []
     dir.entries.each do |entry|
       next if entry.to_s =~ /^\./
       path = dir+entry
+      title = entry.to_s.gsub(/\d+-/, "")
+      output << "<div id='#{title}' class='docapi-section'>"
       if path.directory?
-        output << "<h#{level}>#{entry.to_s.gsub(/\d+-/, "").capitalize}</h#{level}>"
-        convert_directory(path, output, level+1)
+        output << "<h#{level}>#{title.capitalize}</h#{level}>"
+        output << convert_directory(path, level+1)
       else
-        convert_file(path, output, level+1)
-      end
+        output << convert_file(path)
+      end  
+      output << '</div>'
     end
+    output.flatten
   end
   
-  def convert_file(file, output, level = 1)
+  def convert_file(file)
     case file.extname
     when ".md"
-      output << Maruku.new( File.read(file) ).to_html
+      Maruku.new( File.read(file) ).to_html
     when ".rb"
-      blocks = []
-      File.open(file, "r").each do |line|
-        if line =~ /^=begin (.*)$/
-          output << write_block(blocks.pop)
-          blocks << {:content => "", :language => $1}
-        elsif line =~ /^=end$/
-          output << write_block(blocks.pop)
-        else
-          blocks << {:content => "", :language => "ruby"} if blocks.last.nil?
-          blocks.last[:content] << line
-        end
-      end  
-      output << write_block(blocks.pop)
+      process_file_sections(file, 'ruby', [/^=begin (.*)$/, /^=end$/])
+    when ".py"
+      process_file_sections(file, 'python', [/^''' (.*)$/, /^'''$/])
     when ".html"
-      output << File.read(file)
+      File.read(file)
     end
   end
   
+  
+  def process_file_sections(file, language, regexps)
+    blocks = []
+    output = ["<div class='docapi-subsection'><div class='docapi-title'>#{File.basename(file).gsub(/^\d+-/, "")}</div>"]
+    File.open(file, "r").each do |line|
+      if line =~ regexps.first
+        output << write_block(blocks.pop)
+        blocks << {:content => "", :language => $1}
+      elsif line =~ regexps.last
+        output << write_block(blocks.pop)
+      else
+        blocks << {:content => "", :language => language} if blocks.last.nil?
+        blocks.last[:content] << line
+      end
+    end  
+    output << write_block(blocks.pop)
+    output << '</div>'
+  end
+  
   def write_block(block)
     if block
       case block[:language]
@@ -98,13 +112,11 @@ class Docapi
     methods = documentation.split("<h4>  method: ")
     methods.shift
     methods.map!{ |m| 
-      ["<li>", m.gsub(/<blockquote><pre>.*/m, "").gsub(/<a name="(.+?)">(.*?)<br \/>\s*?<\/a>/m, "<div class=\"synopsis\"><a name=\"\\1\">\\2<a></div>").gsub(/<pre>(.*?)<\/pre>/m, "<pre><code>\\1</code></pre>"), "</li>"].join("")
+      ["<div class='docapi-subsection'>", m.gsub(/<blockquote><pre>.*/m, "").gsub(/<a name="(.+?)">(.*?)<br \/>\s*?<\/a>/m, "<div class='docapi-title'><a name=\"\\1\">\\2<a></div>").gsub(/<h2>(.*?)<\/h2>/m, "<div class='docapi-subtitle'>\\1</div>").gsub(/<pre>(.*?)<\/pre>/m, "<pre><code>\\1</code></pre>"), "</div>"].join("")
     }.reverse!
 
     File.open(File.join(output_dir.realpath, "documentation.html"), "w+") do |f|
-      f << '<ol class="methods">'
       methods.each{ |method| f << method }
-      f << "</ol>"
     end
   end
   
@@ -123,6 +135,7 @@ class Docapi
   end
   def footer
     output = []
+    output << "<div id='generation-date'>Generated at: <span class='date'>#{Time.now.to_s}</span></div>"
     output << "</body></html>"
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: crohr-docapi
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-09 00:00:00 -07:00
+date: 2009-09-10 00:00:00 -07:00
 default_executable: docapi
 dependencies: []
 
@@ -55,6 +55,7 @@ files:
 - test/doc/3-tutorials/2-ruby/example-1.rb
 has_rdoc: true
 homepage: http://github.com/crohr/docapi
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: RDoc template for generating API documentation.