hanna-nouveau 0.2.3 → 0.2.4

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/hanna-nouveau.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hanna-nouveau}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Erik Hollensbe", "James Tucker", "Mislav Marohnic"]
-  s.date = %q{2011-05-12}
+  s.date = %q{2011-07-24}
   s.description = %q{}
   s.email = %q{erik@hollensbe.org}
   s.extra_rdoc_files = [
@@ -41,7 +41,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/erikh/hanna-nouveau}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.2}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{A rework of the Hanna generator for RDoc 2.5 and 3.x}
 
   if s.respond_to? :specification_version then

data/lib/hanna-nouveau.rb

@@ -160,6 +160,19 @@ class RDoc::Generator::Hanna
     @classes.each do |klass|
       outfile = classfile(klass)
       stylesheet = Pathname.new(STYLE_OUT).relative_path_from(outfile.dirname)
+      sections = {}
+      klass.each_section do |section, constants, attributes|
+        method_types = []
+        alias_types = []
+        klass.methods_by_type(section).each do |type, visibilities|
+          visibilities.each do |visibility, methods|
+            aliases, methods = methods.partition{|x| x.is_alias_for}
+            method_types << ["#{visibility.to_s.capitalize} #{type.to_s.capitalize}", methods.sort] unless methods.empty?
+            alias_types << ["#{visibility.to_s.capitalize} #{type.to_s.capitalize}", aliases.sort] unless aliases.empty?
+          end
+        end
+        sections[section] = {:constants=>constants, :attributes=>attributes, :method_types=>method_types, :alias_types=>alias_types}
+      end
 
       values = { 
         :file => klass.path, 
@@ -169,20 +182,13 @@ class RDoc::Generator::Hanna
         :title => klass.full_name,
         :list_title => nil,
         :description => klass.description,
-        :section => {
-          # FIXME linkify
-          :classlist => '<ol>' + klass.classes_and_modules.inject('') { |x,y| x << '<li>' + y.name + '</li>' } + '</ol>',
-          :constants => klass.constants,
-          :aliases   => klass.method_list.select { |x| x.is_alias_for }.sort,
-          :attributes => klass.attributes.sort,
-          :method_list => klass.method_list.select { |x| !x.is_alias_for }.sort
-        }
+        :sections => sections
       } 
 
       result = with_layout(values) do 
-        class_page.to_html(binding, :values => values) do 
-          method_list_page.to_html(binding, :values => values) +
-            sections_page.to_html(binding, :values => values)
+        h = {:values => values}
+        class_page.to_html(binding, h) do 
+          method_list_page.to_html(binding, h) + sections_page.to_html(binding, h)
         end
       end
 

data/lib/hanna-nouveau/template_files/method_list.haml

@@ -1,4 +1,6 @@
-- methods = values[:entry].method_list + values[:entry].attributes
+- entry = values[:entry]
+- sections = values[:sections].keys if values.has_key?(:sections)
+- methods = entry.method_list + entry.attributes
 - unless methods.empty?
   #method-list
     %h2 Methods
@@ -26,27 +28,29 @@
               - else
                 %li= method.name
 
-- if values[:entry].requires or values[:entry].sections or values[:entry].includes
+- if entry.requires or sections or entry.includes
   #context
-    - unless values[:entry].requires.empty?
+    - unless entry.requires.empty?
       #requires
         %h2 Required files
         %ol
-          - values[:entry].requires.each do |req|
+          - entry.requires.each do |req|
             %li= req.name
 
-    -# FIXME reenable
-    -#- if values[:entry].sections
-      -##contents
-        -#%h2 Contents
-        -#%ol
-          -#- values[:entry].sections.each do |item|
-            -#%li= link_to values[:secname], values[:href]
+    - if sections && (sections.length > 1 || sections.first.title.to_s != '')
+      #contents
+        %h2 Contents
+        %ol
+          - sections.sort_by{|s| s.title.to_s}.each do |section|
+            %li= link_to section.title, "##{section.aref}"
 
-    - unless values[:entry].includes.empty?
+    - unless entry.includes.empty?
       #includes
         %h2 Included modules
         %ol
-          - values[:entry].includes.each do |inc|
-            %li= inc.name
+          - entry.includes.each do |inc|
+            - if (mod = inc.module).is_a?(String)
+              %li= inc.name
+            - else
+              %li= link_to inc.name, entry.aref_to(mod.path)
 

data/lib/hanna-nouveau/template_files/sections.haml

@@ -1,86 +1,88 @@
-- section = values[:section]
-#section
-  - if section[:sectitle]
-    %h2= link_to section[:sectitle], section[:secsequence]
-    - if section[:seccomment]
-      .section-comment= section[:seccomment]
-      
-  - if section[:classlist] =~ /<li>/
-    #class-list
-      %h2 Classes and Modules
-      = section[:classlist]
-      
-  - unless section[:constants].empty?
-    #constants-list
-      %h2 Constants
-      .name-list
-        %table{ :summary => "Constants" }
-          - section[:constants].each do |const|
-            %tr.top-aligned-row.context-row
-              %td.context-item-name= const.name
-              %td =
-              %td.context-item-value= const.value
-              - if const.description then
-                %td &nbsp;
-                %td.context-item-desc= const.description
-                  
-  - unless section[:aliases].empty?
-    #aliases-list
-      %h2 External Aliases
-      .name-list
-        %table{ :summary => "Aliases" }
-          - section[:aliases].each do |alia|
-            %tr.top-aligned-row.context-row
-              %td.context-item-name= alia.name
-              %td -&gt;
-              %td.context-item-value= link_to alia.is_alias_for.name, "##{alia.is_alias_for.aref}"
-            - unless alia.description.empty?
+- unless values[:entry].classes_and_modules.empty?
+  #class-list
+    %h2 Classes and Modules
+    %ol
+      - (values[:entry].modules.sort + values[:entry].classes.sort).each do |mod|
+        %li= link_to mod.full_name, values[:entry].aref_to(mod.path)
+
+- values[:sections].sort_by{|s, h| s.title.to_s}.each do |section, h|
+  - constants, attributes, alias_types, method_types = h.values_at(:constants, :attributes, :alias_types, :method_types)
+  #section
+    - if section.title.to_s != ''
+      %h2 
+        %a{ :name =>section.aref }= section.title
+        - if section.comment
+          .section-comment= section.description
+        
+    - unless constants.empty?
+      #constants-list
+        %h2 Constants
+        .name-list
+          %table{ :summary => "Constants" }
+            - constants.each do |const|
               %tr.top-aligned-row.context-row
-                %td &nbsp;
-                %td.context-item-desc{ :colspan => "2" }
-                  = alia.description
-                  
-  - unless section[:attributes].empty?
-    #attribute-list
-      %h2.section-bar Attributes
-      .name-list
-        %table
-          - section[:attributes].each do |attrib|
-            %tr.top-aligned-row.context-row
-              %td.context-item-name
-                %a{:name => "method-#{attrib.html_name}"}=attrib.name
-              %td.context-item-value= attrib.rw ? "[#{attrib.rw}]" : '&nbsp;'
-              %td.context-item-desc~ sanitize_code_blocks(attrib.description)
-  
-  - unless section[:method_list].empty?
-    #methods
-      - section[:method_list].group_by { |x| [x.visibility, x.type].map(&:to_s).map(&:capitalize).join(" ") }.each do |type, list|
-        - unless list.empty?
-          %h2== #{type} methods
-          
-          - list.each do |method|
-            .method{ :id => "method-#{method.aref}", :class => "#{type.gsub(/\s+/, '-')}".downcase }
-              %a{ :name => method.aref }
-              .synopsis
-                - method_html = capture_haml do
-                  - if method.call_seq
-                    %span.name
-                      - method.call_seq.split(/\r?\n/).each do |seq|
-                        %div=seq
-                  - else
-                    %span.name= method.name
-                    %span.arguments= method.params
-                -#- if method[:codeurl]
-                  -#%a.method-signature{ :href => method[:codeurl], :onclick => "popupCode(this.href); return false", :target => "Code" }
-                    -#= method_html
-                -#- else
-                = method_html
-              - if method.description
-                .description
-                  ~ sanitize_code_blocks method.description
-              - if method.markup_code
-                .source
-                  - name = "#{method.aref}-source"
-                  %a.source-toggle{ :href => "#", :onclick => "toggleCode('#{name}'); return false" }
-                    [show source]
-                  ~ "<pre id='#{name}'>#{method.markup_code}</pre>"
+                %td.context-item-name= const.name
+                %td =
+                %td.context-item-value= const.value
+                - if const.description then
+                  %td &nbsp;
+                  %td.context-item-desc= const.description
+                    
+    - unless alias_types.empty?
+      - alias_types.each do |type, aliases|
+        #aliases-list
+          %h2 #{type} Aliases
+          .name-list
+            %table{ :summary => "#{type} Aliases" }
+              - aliases.each do |alia|
+                %tr.top-aligned-row.context-row
+                  %td.context-item-name= alia.name
+                  %td -&gt;
+                  %td.context-item-value= link_to alia.is_alias_for.name, "##{alia.is_alias_for.aref}"
+                  - unless alia.description.empty?
+                    %td.context-item-desc= alia.description
+                    
+    - unless attributes.empty?
+      #attribute-list
+        %h2.section-bar Attributes
+        .name-list
+          %table
+            - attributes.each do |attrib|
+              %tr.top-aligned-row.context-row
+                %td.context-item-name
+                  %a{:name => attrib.aref}=attrib.name
+                %td.context-item-value= attrib.rw ? "[#{attrib.rw}]" : '&nbsp;'
+                %td.context-item-desc~ sanitize_code_blocks(attrib.description)
+    
+    - unless method_types.empty?
+      #methods
+        - method_types.each do |type, list|
+          - unless list.empty?
+            %h2== #{type} methods
+            
+            - list.each do |method|
+              .method{ :id => "method-#{method.aref}", :class => "#{type.gsub(/\s+/, '-')}".downcase }
+                %a{ :name => method.aref }
+                .synopsis
+                  - method_html = capture_haml do
+                    - if method.call_seq
+                      %span.name
+                        - method.call_seq.split(/\r?\n/).each do |seq|
+                          %div=seq
+                    - else
+                      %span.name= method.name
+                      %span.arguments= method.params
+                  -#- if method[:codeurl]
+                    -#%a.method-signature{ :href => method[:codeurl], :onclick => "popupCode(this.href); return false", :target => "Code" }
+                      -#= method_html
+                  -#- else
+                  = method_html
+                - if method.description
+                  .description
+                    ~ sanitize_code_blocks method.description
+                - if method.markup_code
+                  .source
+                    - name = "#{method.aref}-source"
+                    %a.source-toggle{ :href => "#", :onclick => "toggleCode('#{name}'); return false" }
+                      [show source]
+                    ~ "<pre id='#{name}'>#{method.markup_code}</pre>"

metadata

@@ -1,117 +1,115 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hanna-nouveau
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.4
   prerelease: 
-  version: 0.2.3
 platform: ruby
-authors: 
+authors:
 - Erik Hollensbe
 - James Tucker
 - Mislav Marohnic
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-07-24 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2169109780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2169109780
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &2169108780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.5.1
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2169108780
+- !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &2169107780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2169107780
+- !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &2169106560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3.1"
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2169106560
+- !ruby/object:Gem::Dependency
   name: haml
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &2169104440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 3.0.25
   type: :runtime
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2169104440
+- !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &2169103100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2169103100
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &2169101720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2169101720
+- !ruby/object:Gem::Dependency
   name: rake
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &2169097040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id008
-description: ""
+  version_requirements: *2169097040
+description: ''
 email: erik@hollensbe.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
+files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -132,35 +130,33 @@ files:
 - lib/hanna-nouveau/template_files/sections.haml
 - lib/hanna-nouveau/template_files/styles.sass
 - lib/rdoc/discover.rb
+has_rdoc: true
 homepage: http://github.com/erikh/hanna-nouveau
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -2056902760337974259
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -711451441932497723
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A rework of the Hanna generator for RDoc 2.5 and 3.x
 test_files: []
-