hanna 0.1.12 → 1.5.1

data/lib/hanna/template_files/styles.css

@@ -0,0 +1,369 @@
+html, body {
+  height: 100%; }
+
+body {
+  font-family: Lucida Grande, Verdana, Arial, Helvetica, sans-serif;
+  font-size: 90%;
+  margin: 0;
+  padding: 0;
+  background: white;
+  color: black; }
+
+#wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -43px; }
+
+#footer-push {
+  height: 43px; }
+
+div.header, #footer {
+  background: #eeeeee; }
+
+#footer {
+  border-top: 1px solid silver;
+  margin-top: 12px;
+  padding: 0 2em;
+  line-height: 30px;
+  text-align: center;
+  font-variant: small-caps;
+  font-size: 95%; }
+
+.clearing:after {
+  content: ".";
+  visibility: hidden;
+  height: 0;
+  display: block;
+  clear: both; }
+* html .clearing {
+  height: 1px; }
+.clearing *:first-child + html {
+  overflow: hidden; }
+
+h1, h2, h3, h4, h5, h6 {
+  margin: 0;
+  font-weight: normal; }
+
+a {
+  color: #0b3e71; }
+  a:hover {
+    background: #336699;
+    text-decoration: none;
+    color: #eeeeff; }
+
+#diagram img {
+  border: 0; }
+
+#description a, .method .description a, .header a {
+  color: #336699; }
+  #description a:hover, .method .description a:hover, .header a:hover {
+    color: #eeeeee; }
+#description h1 a, #description h2 a, #description h3 a, #description h4 a, #description h5 a, #description h6 a, .method .description h1 a, .method .description h2 a, .method .description h3 a, .method .description h4 a, .method .description h5 a, .method .description h6 a, .header h1 a, .header h2 a, .header h3 a, .header h4 a, .header h5 a, .header h6 a {
+  color: #0b3e71; }
+
+ol {
+  margin: 0;
+  padding: 0;
+  list-style: none; }
+  ol li {
+    margin-left: 0;
+    white-space: nowrap; }
+    ol li.other {
+      display: none; }
+
+ol.expanded li.other {
+  display: list-item; }
+
+table {
+  margin-bottom: 1em;
+  font-size: 1em;
+  border-collapse: collapse; }
+  table td, table th {
+    padding: 0.4em 0.8em; }
+  table thead {
+    background-color: #e8e8e8; }
+    table thead th {
+      font-variant: small-caps;
+      color: #666666; }
+  table tr {
+    border-bottom: 1px solid silver; }
+
+#index a.show, div.header a.show {
+  text-decoration: underline;
+  font-style: italic;
+  color: #666666; }
+  #index a.show:after, div.header a.show:after {
+    content: " ..."; }
+  #index a.show:hover, div.header a.show:hover {
+    color: black;
+    background: #ffffee; }
+
+#index {
+  font: 85%/1.2 Arial, Helvetica, sans-serif; }
+  #index a {
+    text-decoration: none; }
+  #index h1 {
+    padding: 0.2em 0.5em 0.1em;
+    background: #cccccc;
+    font: small-caps 1.2em Georgia, serif;
+    color: #333333;
+    border-bottom: 1px solid gray; }
+  #index form {
+    margin: 0;
+    padding: 0; }
+    #index form input {
+      margin: 0.4em 3px 0 0.4em;
+      width: 80%; }
+    #index form #search.untouched {
+      color: #777777; }
+    #index form .clear_button {
+      -moz-border-radius: 7px;
+      -webkit-border-radius: 7px;
+      background: #aaaaaa;
+      color: white;
+      padding: 0 5px 1px 5px;
+      cursor: pointer; }
+  #index ol {
+    padding: 0.4em 0.5em; }
+    #index ol li {
+      white-space: nowrap; }
+  #index #index-entries li.hide {
+    display: none; }
+  #index #index-entries.all li.hide {
+    display: block; }
+  #index #index-entries li a {
+    padding: 1px 2px; }
+  #index #index-entries.classes {
+    font-size: 1.1em; }
+    #index #index-entries.classes ol {
+      padding: 0; }
+    #index #index-entries.classes span.nodoc {
+      display: none; }
+    #index #index-entries.classes span.nodoc, #index #index-entries.classes a {
+      font-weight: bold; }
+    #index #index-entries.classes .parent {
+      font-weight: normal; }
+  #index #index-entries.methods li, #index #search-results.methods li {
+    margin-bottom: 0.2em; }
+    #index #index-entries.methods li a .method_name, #index #search-results.methods li a .method_name {
+      margin-right: 0.25em; }
+    #index #index-entries.methods li a .module_name, #index #search-results.methods li a .module_name {
+      color: #666666; }
+    #index #index-entries.methods li a:hover .module_name, #index #search-results.methods li a:hover .module_name {
+      color: #dddddd; }
+
+#index div#index-entries.classes details > summary { list-style: none; white-space: nowrap; }
+#index div#index-entries.classes details > summary::marker { content: none; }
+#index div#index-entries.classes details > summary:after { content: "  \25B6"; }
+#index div#index-entries.classes details[open] > summary:after { content: "  \25BC"; }
+#index div#index-entries.classes span.class-link { display: block; white-space: nowrap; }
+
+#attribute-list .context-item-name {
+  font-weight: bold; }
+
+div.header {
+  font-size: 80%;
+  padding: 0.5em 1rem;
+  font-family: Arial, Helvetica, sans-serif;
+  border-bottom: 1px solid silver; }
+  div.header .name {
+    font-size: 1.6em;
+    font-family: Georgia, serif;
+    overflow-wrap: break-word; }
+    div.header .name .type {
+      color: #666666;
+      font-size: 80%;
+      font-variant: small-caps; }
+  div.header h1.name {
+    font-size: 2.2em; }
+  div.header .paths, div.header .last-update, div.header .parent {
+    color: #666666; }
+  div.header .last-update .datetime {
+    color: #484848; }
+  div.header .parent {
+    margin-top: 0.3em; }
+    div.header .parent strong {
+      font-weight: normal;
+      color: #484848; }
+
+#content {
+  padding: 12px 1rem; }
+  #content pre, #content .method .synopsis {
+    font: 14px Monaco, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace;
+    overflow-wrap: break-word; }
+  #content pre {
+    color: black;
+    background: #eeeeee;
+    border: 1px solid silver;
+    padding: 0.5em 0.8em;
+    overflow: auto; }
+  #content p code, #content p tt, #content li code, #content li tt, #content dl code, #content dl tt {
+    font: 14px Monaco, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace;
+    background: #ffffe3;
+    padding: 2px 3px;
+    overflow-wrap: break-word;
+    line-height: 1.4; }
+  #content h1 code, #content h1 tt, #content h2 code, #content h2 tt, #content h3 code, #content h3 tt, #content h4 code, #content h4 tt, #content h5 code, #content h5 tt, #content h6 code, #content h6 tt {
+    font-size: 1.1em; }
+  #content #text {
+    position: relative; }
+  #content #description p {
+    margin-top: 0.5em; }
+  #content #description h1, #content #description h2, #content #description h3, #content #description h4, #content #description h5, #content #description h6 {
+    font-family: Georgia, serif; }
+  #content #description h1 {
+    font-size: 2.2em;
+    margin-bottom: 0.2em;
+    border-bottom: 3px double #d8d8d8;
+    padding-bottom: 0.1em; }
+  #content #description h2 {
+    font-size: 1.8em;
+    color: #0e3062;
+    margin: 0.8em 0 0.3em 0; }
+  #content #description h3 {
+    font-size: 1.6em;
+    margin: 0.8em 0 0.3em 0;
+    color: #666666; }
+  #content #description h4 {
+    font-size: 1.4em;
+    margin: 0.8em 0 0.3em 0; }
+  #content #description h5 {
+    font-size: 1.2em;
+    margin: 0.8em 0 0.3em 0;
+    color: #0e3062; }
+  #content #description h6 {
+    font-size: 1em;
+    margin: 0.8em 0 0.3em 0;
+    color: #666666; }
+  #content #description ul, #content #description ol, #content .method .description ul, #content .method .description ol {
+    margin: 0.8em 0;
+    padding-left: 1.5em; }
+  #content #description ol, #content .method .description ol {
+    list-style: decimal; }
+    #content #description ol li, #content .method .description ol li {
+      white-space: normal; }
+  #content table.rdoc-list {
+    border-collapse: collapse;
+    border-spacing: 0;
+    width: 100%;
+    overflow: auto;
+    display: block; }
+    #content table.rdoc-list tr {
+      background-color: white; }
+      #content table.rdoc-list tr:nth-child(2n) {
+        background-color: #f8f8f8; }
+    #content table.rdoc-list td.label {
+      font-weight: bold; }
+    #content table.rdoc-list td {
+      border: 1px solid #ddd;
+      padding: 6px 13px; }
+
+#method-list {
+  max-height: 30rem;
+  background: #eeeeee;
+  border: 1px solid silver;
+  padding: 0.4em 1%;
+  overflow-y: auto;
+  overflow-x: hidden; }
+  #method-list h2 {
+    font-size: 1.3em; }
+  #method-list h3 {
+    font-variant: small-caps;
+    text-transform: capitalize;
+    font-family: Georgia, serif;
+    color: #666666;
+    font-size: 1.1em; }
+  #method-list ol {
+    padding: 0 0 0.5em 0.5em; }
+
+#context {
+  border-top: 1px dashed silver;
+  margin-top: 1em;
+  margin-bottom: 1em; }
+
+#context h2, #section h2 {
+  font: small-caps 1.2em Georgia, serif;
+  color: #444444;
+  margin: 1em 0 0.2em 0; }
+
+.name-list, #class-list ol, #context ol {
+  overflow: auto; }
+
+#methods .method {
+  border: 1px solid silver;
+  margin-top: 0.5em;
+  background: #eeeeee; }
+  #methods .method .synopsis {
+    color: black;
+    background: silver;
+    padding: 0.2em 1em; }
+    #methods .method .synopsis .name {
+      font-weight: bold; }
+    #methods .method .synopsis a {
+      text-decoration: none; }
+  #methods .method .description {
+    padding: 0 1em; }
+    #methods .method .description pre {
+      background: #f8f8f8; }
+  #methods .method .source {
+    margin: 0.5em 0; }
+  #methods .method .source-toggle {
+    font-size: 85%;
+    margin-left: 1em; }
+#methods .public-class {
+  background: #ffffe4; }
+#methods .public-instance .synopsis {
+  color: #eeeeee;
+  background: #336699; }
+
+#content .method .source pre, #content pre.ruby, #methods .method .description pre.ruby {
+  background: #262626;
+  color: #ffdead;
+  padding: 0.5em;
+  border: 1px dashed #999999;
+  overflow: auto; }
+  #content .method .source pre .ruby-constant, #content pre.ruby .ruby-constant, #methods .method .description pre.ruby .ruby-constant {
+    color: #7fffd4;
+    background: transparent; }
+  #content .method .source pre .ruby-keyword, #content pre.ruby .ruby-keyword, #methods .method .description pre.ruby .ruby-keyword {
+    color: aqua;
+    background: transparent; }
+  #content .method .source pre .ruby-ivar, #content pre.ruby .ruby-ivar, #methods .method .description pre.ruby .ruby-ivar {
+    color: #eedd82;
+    background: transparent; }
+  #content .method .source pre .ruby-operator, #content pre.ruby .ruby-operator, #methods .method .description pre.ruby .ruby-operator {
+    color: #00ffee;
+    background: transparent; }
+  #content .method .source pre .ruby-identifier, #content pre.ruby .ruby-identifier, #methods .method .description pre.ruby .ruby-identifier {
+    color: #ffdead;
+    background: transparent; }
+  #content .method .source pre .ruby-string, #content pre.ruby .ruby-string, #methods .method .description pre.ruby .ruby-string {
+    color: #faa;
+    background: transparent; }
+  #content .method .source pre .ruby-node, #content pre.ruby .ruby-node, #methods .method .description pre.ruby .ruby-node {
+    color: #ffa07a;
+    background: transparent; }
+  #content .method .source pre .ruby-comment, #content pre.ruby .ruby-comment, #methods .method .description pre.ruby .ruby-comment {
+    color: #fdf;
+    font-weight: bold;
+    background: transparent; }
+  #content .method .source pre .ruby-regexp, #content pre.ruby .ruby-regexp, #methods .method .description pre.ruby .ruby-regexp {
+    color: #ffa07a;
+    background: transparent; }
+  #content .method .source pre .ruby-value, #content pre.ruby .ruby-value, #methods .method .description pre.ruby .ruby-value {
+    color: #7fffd4;
+    background: transparent; }
+
+@media (min-width: 640px) {
+  div.class #content {
+    position: relative;
+    width: 72%; }
+
+  #method-list {
+    position: absolute;
+    top: 0px;
+    right: -33%;
+    width: 28%;
+  }
+}

data/lib/hanna.rb

@@ -1 +1,311 @@
-require 'hanna/hanna'
+# frozen-string-literal: true
+
+# = A better RDoc HTML template
+
+require 'pathname'
+require 'erb'
+# :nocov:
+require 'rdoc/rdoc' unless defined?(RDoc::Markup::ToHtml)
+# :nocov:
+require 'rdoc/generator'
+
+# Hanna version of RDoc::Generator
+class RDoc::Generator::Hanna 
+  STYLE            = 'styles.css'
+  LAYOUT           = 'layout.erb'
+
+  INDEX_PAGE       = 'index.erb'
+  CLASS_PAGE       = 'page.erb'
+  METHOD_LIST_PAGE = 'method_list.erb'
+  FILE_PAGE        = CLASS_PAGE
+  SECTIONS_PAGE    = 'sections.erb'
+
+  FILE_INDEX       = 'file_index.erb'
+  CLASS_INDEX      = 'class_index.erb'
+  METHOD_INDEX     = 'method_index.erb'
+
+  CLASS_DIR        = 'classes'
+  FILE_DIR         = 'files'
+
+  INDEX_OUT        = 'index.html'
+  FILE_INDEX_OUT   = 'fr_file_index.html'
+  CLASS_INDEX_OUT  = 'fr_class_index.html'
+  METHOD_INDEX_OUT = 'fr_method_index.html'
+  STYLE_OUT        = File.join('css', 'style.css')
+
+  METHOD_SEARCH_JS = "method_search.js"
+
+  DESCRIPTION = 'RDoc generator designed with simplicity, beauty and ease of browsing in mind'
+
+  RDoc::RDoc.add_generator( self )
+
+  class << self
+    alias for new
+
+    # :nocov:
+    # For RDoc >= 6.13.1
+    def setup_options(options)
+      options.class_module_path_prefix = CLASS_DIR if options.respond_to?(:class_module_path_prefix)
+      options.file_path_prefix = FILE_DIR if options.respond_to?(:file_path_prefix)
+    end
+    # :nocov:
+  end
+
+  def initialize( store, options )
+    @options = options
+    @store = store
+
+    @templatedir = Pathname.new File.expand_path('../hanna/template_files', __FILE__)
+
+    @files      = nil
+    @classes    = nil
+    @methods    = nil
+    @attributes = nil
+
+    @basedir = Pathname.pwd.expand_path
+  end
+
+  def generate
+    @outputdir = Pathname.new( @options.op_dir ).expand_path( @basedir )
+
+    @files      = @store.all_files.sort
+    @classes    = @store.all_classes_and_modules.sort
+    @methods    = @classes.map {|m| m.method_list }.flatten.sort
+    @attributes = @classes.map(&:attributes).flatten.sort
+
+    # Now actually write the output
+    write_static_files
+    generate_indexes
+    generate_class_files
+    generate_file_files
+  end
+
+  def write_static_files
+    css_dir = outjoin('css')
+    FileUtils.mkdir_p css_dir
+    File.binwrite(File.join(css_dir, 'style.css'), File.read(templjoin(STYLE)))
+  end
+
+  def generate_indexes
+    @main_page_uri = @files.find { |f| f.name == @options.main_page }.path rescue ''
+    File.binwrite(outjoin(INDEX_OUT), erb_template(templjoin(INDEX_PAGE)).to_html(binding))
+
+    generate_index(FILE_INDEX_OUT,   FILE_INDEX,   'File',   { :files => @files})
+    generate_index(CLASS_INDEX_OUT,  CLASS_INDEX,  'Class',  { :classes => @classes })
+    generate_index(METHOD_INDEX_OUT, METHOD_INDEX, 'Method', { :methods => @methods, :attributes => @attributes })
+
+    File.binwrite(outjoin(METHOD_SEARCH_JS), File.binread(templjoin(METHOD_SEARCH_JS)))
+  end
+
+  def generate_index(outfile, templfile, index_name, values)
+    values.merge!({
+      :stylesheet => STYLE_OUT,
+      :list_title => "#{index_name} Index"
+    })
+
+    index = erb_template(templjoin(templfile))
+
+    File.binwrite(outjoin(outfile), with_layout(values){index.to_html(binding, values)})
+  end
+
+  def generate_file_files
+    file_page = erb_template(templjoin(FILE_PAGE))
+    method_list_page = erb_template(templjoin(METHOD_LIST_PAGE))
+
+    @files.each do |file|
+      path = Pathname.new(file.path)
+      stylesheet = Pathname.new(STYLE_OUT).relative_path_from(path.dirname)
+      
+      values = { 
+        :file => file, 
+        :entry => file,
+        :stylesheet => stylesheet,
+        :classmod => nil, 
+        :title => file.base_name, 
+        :list_title => nil,
+        :description => file.description
+      } 
+
+      result = with_layout(values) do 
+        file_page.to_html(binding, :values => values) do 
+          method_list_page.to_html(binding, values) 
+        end
+      end
+
+      dir = path.dirname
+      FileUtils.mkdir_p dir
+      File.binwrite(outjoin(file.path), result)
+    end
+  end
+
+  def generate_class_files
+    class_page       = erb_template(templjoin(CLASS_PAGE))
+    method_list_page = erb_template(templjoin(METHOD_LIST_PAGE))
+    sections_page    = erb_template(templjoin(SECTIONS_PAGE))
+
+    @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, 
+        :entry => klass,
+        :stylesheet => stylesheet,
+        :classmod => klass.type,
+        :title => klass.full_name,
+        :list_title => nil,
+        :description => klass.description,
+        :sections => sections
+      } 
+
+      result = with_layout(values) do 
+        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
+
+      dir = outfile.dirname
+      FileUtils.mkdir_p dir
+      File.binwrite(outfile, result)
+    end
+  end
+
+  def with_layout(values)
+    layout = erb_template(templjoin(LAYOUT))
+    layout.to_html(binding, :values => values) { yield }
+  end
+
+  def frame_link(content)
+    content.gsub(%r!<a[ \n]href="https?://[^>]*>!).each do |tag|
+      a_tag, rest = tag.split(' ', 2)
+      rest.gsub!(/target="[^"]*"/, '')
+      a_tag + ' target="_top" ' + rest
+    end
+  end
+
+  # :nocov:
+  # For RDoc < 6.13
+  def class_dir
+    CLASS_DIR
+  end
+
+  def file_dir
+    FILE_DIR
+  end
+  # :nocov:
+
+  def h(html)
+    CGI::escapeHTML(html.to_s)
+  end
+
+  def render_class_tree(entries, prefix=nil, out=String.new)
+    namespaces = { }
+
+    entries.sort.each do |klass|
+      full_name = klass.full_name
+      next if namespaces[full_name]
+
+      class_prefix = "#{full_name}::"
+      subentries = @classes.select{|c| c.full_name.start_with?(class_prefix)}
+      subentries.each { |x| namespaces[x.full_name] = true }
+
+      text = prefix ? (prefix + klass.name) : klass.name
+      link = link_to(text, classfile(klass))
+
+      if subentries.empty?
+        out << "<span class=\"class-link\">" << link << "</span>\n"
+      else
+        out << '<details'
+        out << ' open' if full_name.count(':') == 0
+        out << '><summary>' << link << "</summary>\n"
+        render_class_tree(subentries, "<span class=\"parent\">#{full_name}::</span>", out)
+        out << "</details>"
+      end
+    end
+
+    out
+  end
+    
+  def link_to(text, url)
+    %[<a href="#{url}">#{text}</a>]
+  end
+
+  def link_to_method(entry, url)
+    method_name = entry.pretty_name rescue entry.name
+    module_name = entry.parent_name rescue entry.name
+    link_to %Q(<span class="method_name" value="#{entry.name}">#{h method_name}</span> <span class="module_name">(#{h module_name})</span>), url
+  end
+
+  def classfile(klass)
+    Pathname.new(File.join(CLASS_DIR, klass.full_name.split('::')) + '.html')
+  end
+
+  def outjoin(name)
+    File.join(@outputdir, name)
+  end
+
+  def templjoin(name)
+    File.join(@templatedir, name)
+  end
+
+  class ERB < ::ERB
+    def to_html(binding, values = nil, &block)
+      local_values = {}
+      binding.local_variables.each do |lv|
+        local_values[lv] = binding.local_variable_get(lv)
+      end
+      binding.local_variable_set(:values, values) if values
+      binding.local_variable_set(:block, block) if block
+      html = result(binding)
+      local_values.each do |lv, val|
+        binding.local_variable_set(lv, val)
+      end
+      html
+    end
+  end
+
+  def erb_template(file)
+    ERB.new(File.read(file))
+  end
+
+  module LabelListTable
+    def list_item_start(list_item, list_type)
+      case list_type
+      when :LABEL, :NOTE
+        "<tr><td class='label'>#{Array(list_item.label).map{|label| to_html(label)}.join("<br />")}</td><td>"
+      else
+        super
+      end
+    end
+
+    def list_end_for(list_type)
+      case list_type
+      when :LABEL, :NOTE then
+        "</td></tr>"
+      else
+        super
+      end
+    end
+  end
+end 
+
+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>']
+
+  prepend RDoc::Generator::Hanna::LabelListTable
+end

data/lib/rdoc/discover.rb

@@ -0,0 +1 @@
+require 'hanna'