hanna-nouveau 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6c8a2e662bfa7585fb1fd1f3837824c02c11d9e
-  data.tar.gz: be3233cfa1bbd708256b2f5c6b425db3d7721b5b
+  metadata.gz: d5ced1825c89f3942fad828e81c77faf431779eb
+  data.tar.gz: 699b6b1f76859328db25deefc220714d00aca96b
 SHA512:
-  metadata.gz: 3203e0cd922812a11db23f2c55c656c29ef0424b59d6a1838d8effca6b8986355ba85eaedecb664b90df2a13fb5f4b6f1889f79ce66b777901eae25f7f677ad1
-  data.tar.gz: 90ba1c6e40cbf9fdf31aef304e8b7eb4f30c4ddaa0812c4fddf0afada907a36f4848d434e27a1e1def9a72c218246f4598fa51f0df29bbe11a39ed2ea08077fe
+  metadata.gz: e1a6d6a77b822e044d6840bf2d21334617d77a2a3e17bc88e16f87f8168bbb15f104dbf34a194097dd6a0fe673bfd32126c265be81ec54b4919abd4e70d8fa2c
+  data.tar.gz: f832b5ab9f42e516627b5fdb6e8008a8732fc234a0891431a9cd445ef937bdfaefef6732b205a746d47590ae26d3e0cfb99d9b0c6c576cfdfb732212c0957756

data/Gemfile

@@ -1,3 +1,4 @@
 source "http://rubygems.org"
 gem 'rdoc', "~> 4.0"
 gem 'haml', "= 3.0.25"
+gem 'parser'

data/README.rdoc

@@ -79,3 +79,17 @@ library}[http://github.com/rdbi/rdbi/tree/master/Rakefile]:
       rdoc.rdoc_files.include('README*')
       rdoc.rdoc_files.include('lib/**/*.rb')
     end
+
+== Modifications to RDoc
+
+Hanna makes some small modifications to RDoc to generate more
+friendly documentation.  First, a real parser is used for all
+verbatim sections, and any verbatim section that is valid ruby
+code will be highlighted. This is different than the RDoc
+default, which is to use a simple regexp with both false
+positives and false negatives.
+
+Second, label lists are marked using a table instead of a
+description list, since it is very difficult to get visually
+appealing styling for description lists without cutting
+corners (like using fixed widths).

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/hanna-nouveau.rb

@@ -16,6 +16,45 @@ require 'haml'
 require 'sass'
 require 'rdoc/rdoc'
 require 'rdoc/generator'
+require 'parser/current'
+
+class RDoc::Markup::ToHtml
+  LIST_TYPE_TO_HTML[:LABEL] = ['<table class="rdoc-list label-list"><tbody>', '</tbody></table>']
+  LIST_TYPE_TO_HTML[:NOTE]  = ['<table class="rdoc-list note-list"><tbody>',  '</tbody></table>']
+
+  def list_item_start(list_item, list_type)
+    case list_type
+    when :BULLET, :LALPHA, :NUMBER, :UALPHA then
+      "<li>"
+    when :LABEL, :NOTE then
+      "<tr><td class='label'>#{Array(list_item.label).map{|label| to_html(label)}.join("<br />")}</td><td>"
+    else
+      raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
+    end
+  end
+
+  def list_end_for(list_type)
+    case list_type
+    when :BULLET, :LALPHA, :NUMBER, :UALPHA then
+      "</li>"
+    when :LABEL, :NOTE then
+      "</td></tr>"
+    else
+      raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
+    end
+  end
+
+  def parseable? text
+    parser = Parser::CurrentRuby.new
+    parser.diagnostics.consumer = lambda{|d|}
+    buffer = Parser::Source::Buffer.new('(string)')
+    buffer.source = text
+    parser.parse(buffer)
+    true
+  rescue
+    false
+  end
+end
 
 class RDoc::Generator::Hanna 
   STYLE            = 'styles.sass'

data/lib/hanna-nouveau/template_files/styles.sass

@@ -258,6 +258,18 @@ div.header
       list-style: decimal
       li
         white-space: normal
+  table.rdoc-list
+    border-collapse: collapse
+    border-spacing: 0
+    tr
+      background-color: white
+      &:nth-child(2n)
+        background-color: #f8f8f8
+    td.label
+      font-weight: bold
+    td
+      border: 1px solid #ddd
+      padding: 6px 13px
 
 #method-list
   position: absolute
@@ -318,7 +330,7 @@ div.header
     color: #eeeeee
     background: $light_link
 
-#content .method .source pre
+#content .method .source pre, #content pre.ruby, #methods .method .description pre.ruby
   background: #262626
   color: #ffdead
   margin: 1em

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanna-nouveau
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jeremy Evans
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -41,6 +41,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: ''
 email: code@jeremyevans.net
 executables: []