From 8f42ed64f86ee8d73e64ebc8442ab0ce193712cf Mon Sep 17 00:00:00 2001
From: Rene Saarsoo <nene@triin.net>
Date: Wed, 29 Jun 2011 13:46:39 +0300
Subject: [PATCH] Remove old HTML-pages creation code.

---
 lib/jsduck/app.rb              |  15 ----
 lib/jsduck/cfg_table.rb        |  21 ------
 lib/jsduck/event_table.rb      |  33 ---------
 lib/jsduck/inheritance_tree.rb |  42 ------------
 lib/jsduck/long_params.rb      |  30 --------
 lib/jsduck/method_table.rb     |  45 ------------
 lib/jsduck/property_table.rb   |  21 ------
 lib/jsduck/short_params.rb     |  24 -------
 lib/jsduck/table.rb            | 121 ---------------------------------
 9 files changed, 352 deletions(-)
 delete mode 100644 lib/jsduck/cfg_table.rb
 delete mode 100644 lib/jsduck/event_table.rb
 delete mode 100644 lib/jsduck/inheritance_tree.rb
 delete mode 100644 lib/jsduck/long_params.rb
 delete mode 100644 lib/jsduck/method_table.rb
 delete mode 100644 lib/jsduck/property_table.rb
 delete mode 100644 lib/jsduck/short_params.rb
 delete mode 100644 lib/jsduck/table.rb

diff --git a/lib/jsduck/app.rb b/lib/jsduck/app.rb
index ed8a39c3..3a042701 100644
--- a/lib/jsduck/app.rb
+++ b/lib/jsduck/app.rb
@@ -9,7 +9,6 @@ require 'jsduck/tree_icons'
 require 'jsduck/members'
 require 'jsduck/relations'
 require 'jsduck/aliases'
-require 'jsduck/page'
 require 'jsduck/exporter'
 require 'jsduck/timer'
 require 'jsduck/parallel_wrap'
@@ -230,20 +229,6 @@ module JsDuck
       File.open(filename, 'w') {|f| f.write(js) }
     end
 
-    # Writes documentation page for each class
-    # We do it in parallel using as many processes as available CPU-s
-    def write_pages(path, relations)
-      cache = {}
-      @parallel.each(relations.classes) do |cls|
-        filename = path + "/" + cls[:name] + ".html"
-        Logger.instance.log("Writing to #{filename} ...")
-        page = Page.new(cls, relations, cache)
-        page.link_tpl = @link_tpl if @link_tpl
-        page.img_tpl = @img_tpl if @img_tpl
-        File.open(filename, 'w') {|f| f.write(page.to_html) }
-      end
-    end
-
     # Writes JsonP export file for each class
     def write_class(path, relations)
       exporter = Exporter.new(relations, get_doc_formatter(relations))
diff --git a/lib/jsduck/cfg_table.rb b/lib/jsduck/cfg_table.rb
deleted file mode 100644
index 8113b224..00000000
--- a/lib/jsduck/cfg_table.rb
+++ /dev/null
@@ -1,21 +0,0 @@
-require 'jsduck/table'
-
-module JsDuck
-
-  class CfgTable < Table
-    def initialize(cls, formatter, cache={})
-      super(cls, formatter, cache)
-      @type = :cfg
-      @id = @cls.full_name + "-configs"
-      @title = "Config Options"
-      @column_title = "Config Options"
-      @row_class = "config-row"
-    end
-
-    def signature_suffix(item)
-      " : " + item[:type]
-    end
-
-  end
-
-end
diff --git a/lib/jsduck/event_table.rb b/lib/jsduck/event_table.rb
deleted file mode 100644
index bbf5500c..00000000
--- a/lib/jsduck/event_table.rb
+++ /dev/null
@@ -1,33 +0,0 @@
-require 'jsduck/table'
-require 'jsduck/short_params'
-require 'jsduck/long_params'
-
-module JsDuck
-
-  class EventTable < Table
-    def initialize(cls, formatter, cache={})
-      super(cls, formatter, cache)
-      @type = :event
-      @id = @cls.full_name + "-events"
-      @title = "Public Events"
-      @column_title = "Event"
-      @row_class = "event-row"
-      @short_params = ShortParams.new
-      @long_params = LongParams.new(@formatter)
-    end
-
-    def signature_suffix(item)
-      " : " + @short_params.render(item[:params])
-    end
-
-    def extra_doc(item)
-      [
-        "<div class='mdetail-params'>",
-        "<strong style='font-weight: normal;'>Listeners will be called with the following arguments:</strong>",
-        @long_params.render(item[:params]),
-        "</div>"
-      ].join("\n")
-    end
-  end
-
-end
diff --git a/lib/jsduck/inheritance_tree.rb b/lib/jsduck/inheritance_tree.rb
deleted file mode 100644
index 29259dbd..00000000
--- a/lib/jsduck/inheritance_tree.rb
+++ /dev/null
@@ -1,42 +0,0 @@
-module JsDuck
-
-  # Creates the inheritance tree shown on class documentation page.
-  class InheritanceTree
-    def initialize(cls, formatter)
-      @cls = cls
-      @formatter = formatter
-    end
-
-    # Renders the tree using HTML <pre> element
-    def to_html
-      i = -1
-      html = (@cls.superclasses + [@cls]).collect do |cls|
-        i += 1
-        make_indent(i) + make_link(cls)
-      end.join("\n")
-
-      return <<-EOHTML
-        <div class="inheritance res-block">
-          <pre class="res-block-inner">#{html}</pre>
-        </div>
-      EOHTML
-    end
-
-    def make_indent(level)
-      if level > 0
-        ("  " * level) + "<img src='resources/elbow-end.gif' alt=''>"
-      else
-        ""
-      end
-    end
-
-    def make_link(cls)
-      if cls == @cls
-        cls.short_name
-      else
-        @formatter.link(cls.full_name, nil, cls.short_name)
-      end
-    end
-  end
-
-end
diff --git a/lib/jsduck/long_params.rb b/lib/jsduck/long_params.rb
deleted file mode 100644
index 0872ec98..00000000
--- a/lib/jsduck/long_params.rb
+++ /dev/null
@@ -1,30 +0,0 @@
-module JsDuck
-
-  # Renders method/event parameters list in long form
-  # for use in documentation body.
-  class LongParams
-    def initialize(formatter)
-      @formatter = formatter
-    end
-
-    def render(params)
-      if params.length > 0
-        "<ul>" + params.collect {|p| render_single(p) }.join("") + "</ul>"
-      else
-        "<ul><li>None.</li></ul>"
-      end
-    end
-
-    def render_single(param)
-      doc = @formatter.format(param[:doc])
-      type = @formatter.replace(param[:type])
-      return [
-        "<li>",
-        "<code>#{param[:name]}</code> : #{type}",
-        "<div class='sub-desc'>#{doc}</div>",
-        "</li>",
-      ].join("")
-    end
-  end
-
-end
diff --git a/lib/jsduck/method_table.rb b/lib/jsduck/method_table.rb
deleted file mode 100644
index c07ce1e7..00000000
--- a/lib/jsduck/method_table.rb
+++ /dev/null
@@ -1,45 +0,0 @@
-require 'jsduck/table'
-require 'jsduck/short_params'
-require 'jsduck/long_params'
-
-module JsDuck
-
-  class MethodTable < Table
-    def initialize(cls, formatter, cache={})
-      super(cls, formatter, cache)
-      @type = :method
-      @id = @cls.full_name + "-methods"
-      @title = "Public Methods"
-      @column_title = "Method"
-      @row_class = "method-row"
-      @short_params = ShortParams.new
-      @long_params = LongParams.new(@formatter)
-    end
-
-    def signature_suffix(item)
-      @short_params.render(item[:params]) + " : " + item[:return][:type]
-    end
-
-    def extra_doc(item)
-      [
-        "<div class='mdetail-params'>",
-        "<strong>Parameters:</strong>",
-        @long_params.render(item[:params]),
-        "<strong>Returns:</strong>",
-        render_return(item),
-        "</div>"
-      ].join("\n")
-    end
-
-    def render_return(item)
-      type = @formatter.replace(item[:return][:type])
-      doc = @formatter.format(item[:return][:doc])
-      if type == "void" && doc.length == 0
-        "<ul><li>void</li></ul>"
-      else
-        "<ul><li><code>#{type}</code><div class='sub-desc'>#{doc}</div></li></ul>"
-      end
-    end
-  end
-
-end
diff --git a/lib/jsduck/property_table.rb b/lib/jsduck/property_table.rb
deleted file mode 100644
index 1abf74bc..00000000
--- a/lib/jsduck/property_table.rb
+++ /dev/null
@@ -1,21 +0,0 @@
-require 'jsduck/table'
-
-module JsDuck
-
-  class PropertyTable < Table
-    def initialize(cls, formatter, cache={})
-      super(cls, formatter, cache)
-      @type = :property
-      @id = @cls.full_name + "-props"
-      @title = "Public Properties"
-      @column_title = "Property"
-      @row_class = "property-row"
-    end
-
-    def signature_suffix(item)
-      " : " + item[:type]
-    end
-
-  end
-
-end
diff --git a/lib/jsduck/short_params.rb b/lib/jsduck/short_params.rb
deleted file mode 100644
index 5063f9f6..00000000
--- a/lib/jsduck/short_params.rb
+++ /dev/null
@@ -1,24 +0,0 @@
-module JsDuck
-
-  # Renders method/event parameters list in short form
-  # for use in signatures
-  class ShortParams
-    def render(params)
-      if params.length > 0
-        "( " + params.collect {|p| render_single(p) }.join(", ") + " )"
-      else
-        "()"
-      end
-    end
-
-    def render_single(param)
-      str = "<code>#{param[:type]} #{param[:name]}</code>"
-      if param[:optional]
-        "<span title='Optional' class='optional'>[" + str + "]</span>"
-      else
-        str
-      end
-    end
-  end
-
-end
diff --git a/lib/jsduck/table.rb b/lib/jsduck/table.rb
deleted file mode 100644
index 73a2b835..00000000
--- a/lib/jsduck/table.rb
+++ /dev/null
@@ -1,121 +0,0 @@
-module JsDuck
-
-  # Base class for creating HTML tables of class members.
-  #
-  # Subclasses must set variables @type, @id, @title, @column_title,
-  # @row_class, and implement the signature_suffix() and extra_doc()
-  # methods.
-  class Table
-    # Initializes class member table generator
-    #
-    # - cls : the class for which to generate the table.
-    #
-    # - formatter : instance of JsDuck::DocFormatter
-    #
-    # - cache : shared cache of already generated HTML rows.  If Foo
-    #   inherits from Bar and we have already generated members table
-    #   for Bar, then we don't have to re-render all the HTML the
-    #   methods from Bar, but can just look them up from cache.
-    #
-    def initialize(cls, formatter, cache={})
-      @cls = cls
-      @formatter = formatter
-      @cache = cache
-    end
-
-    def to_html
-      rows = @cls.members(@type).collect {|m| row(m) }
-
-      # When no rows to show, create no table whatsoever
-      return "" if rows.length == 0
-
-      [
-       "<a id='#{@id}'></a>",
-       "<h2>#{@title}</h2>",
-       "<table cellspacing='0' class='member-table'><tbody>",
-       "<tr><th colspan='2' class='sig-header'>#{@column_title}</th><th class='msource-header'>Defined By</th></tr>",
-       rows.join("\n"),
-       "</tbody></table>",
-      ].join("\n")
-    end
-
-    # Returns HTML row for class member.
-    #
-    # When HTML for member has already been rendered we can pick it
-    # from cache and only fill in some details which differ from class
-    # to class.
-    #
-    # Otherwise perform the rendering of HTML and save it to cache.
-    def row(item)
-      cache_key = "#{item[:owner]}-#{@row_class}-#{item[:name]}"
-      if @cache[cache_key]
-        html = @cache[cache_key]
-      else
-        html = @cache[cache_key] = create_row(item)
-      end
-      inherited = inherited?(item) ? 'inherited' : ''
-      owner_link = inherited?(item) ? member_link(item) : Class.short_name(item[:owner])
-      owner_class = @cls.full_name
-      html = html.sub(/!!--inherited--!!/, inherited)
-      html = html.sub(/!!--owner-link--!!/, owner_link)
-      html = html.sub(/!!--owner-class--!!/, owner_class)
-      html
-    end
-
-    # Generates HTML for the row, leaving in placeholders for owner
-    # class name and inherited class.
-    def create_row(item)
-      p_doc = primary_doc(item)
-      e_doc = extra_doc(item)
-      description = expandable_desc(p_doc, e_doc)
-      expandable = expandable?(p_doc, e_doc) ? 'expandable' : ''
-      return <<-EOHTML
-      <tr class='#{@row_class} #{expandable} !!--inherited--!!'>
-        <td class='micon'><a href='#expand' class='exi'>&nbsp;</a></td>
-        <td class='sig'>#{signature(item)}<div class='mdesc'>#{description}</div></td>
-        <td class='msource'>!!--owner-link--!!</td>
-      </tr>
-      EOHTML
-    end
-
-    def member_link(item)
-      @formatter.link(item[:owner], item[:name], Class.short_name(item[:owner]))
-    end
-
-    def signature(item)
-      id = "!!--owner-class--!!-" + item[:name]
-      src = "source/#{item[:href]}"
-      return "<a id='#{id}'></a><b><a href='#{src}'>#{item[:name]}</a></b>" + signature_suffix(item)
-    end
-
-    # Creates either expandable or normal doc-entry
-    def expandable_desc(p_doc, e_doc)
-      if expandable?(p_doc, e_doc)
-        short_doc = @formatter.shorten(p_doc)
-        "<div class='short'>#{short_doc}</div>" +
-          "<div class='long'>#{p_doc}#{e_doc}</div>"
-      else
-        p_doc
-      end
-    end
-
-    def primary_doc(item)
-      @formatter.format(item[:doc])
-    end
-
-    # Override to append extra documentation to the doc found in item[:doc]
-    def extra_doc(item)
-      ""
-    end
-
-    def expandable?(p_doc, e_doc)
-      @formatter.too_long?(p_doc) || e_doc.length > 0
-    end
-
-    def inherited?(item)
-      item[:owner] != @cls.full_name
-    end
-
-  end
-
-end
-- 
GitLab