jsduck 0.6.1 → 2.0.pre

data/lib/jsduck/cfg_table.rb

@@ -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

data/lib/jsduck/event_table.rb

@@ -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

data/lib/jsduck/inheritance_tree.rb

@@ -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

data/lib/jsduck/long_params.rb

@@ -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

data/lib/jsduck/method_table.rb

@@ -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

data/lib/jsduck/property_table.rb

@@ -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

data/lib/jsduck/short_params.rb

@@ -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

data/lib/jsduck/table.rb

@@ -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[:member]}-#{@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[:member])
-      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[:member], item[:name], Class.short_name(item[:member]))
-    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[:member] != @cls.full_name
-    end
-
-  end
-
-end

data/template/resources/TabCloseMenu.js

@@ -1,150 +0,0 @@
-/*!
- * Ext JS Library 3.2.1
- * Copyright(c) 2006-2010 Ext JS, Inc.
- * licensing@extjs.com
- * http://www.extjs.com/license
- */
-/**
- * @class Ext.ux.TabCloseMenu
- * @extends Object 
- * Plugin (ptype = 'tabclosemenu') for adding a close context menu to tabs. Note that the menu respects
- * the closable configuration on the tab. As such, commands like remove others and remove all will not
- * remove items that are not closable.
- * 
- * @constructor
- * @param {Object} config The configuration options
- * @ptype tabclosemenu
- */
-Ext.ux.TabCloseMenu = Ext.extend(Object, {
-    /**
-     * @cfg {String} closeTabText
-     * The text for closing the current tab. Defaults to <tt>'Close Tab'</tt>.
-     */
-    closeTabText: 'Close Tab',
-
-    /**
-     * @cfg {String} closeOtherTabsText
-     * The text for closing all tabs except the current one. Defaults to <tt>'Close Other Tabs'</tt>.
-     */
-    closeOtherTabsText: 'Close Other Tabs',
-    
-    /**
-     * @cfg {Boolean} showCloseAll
-     * Indicates whether to show the 'Close All' option. Defaults to <tt>true</tt>. 
-     */
-    showCloseAll: true,
-
-    /**
-     * @cfg {String} closeAllTabsText
-     * <p>The text for closing all tabs. Defaults to <tt>'Close All Tabs'</tt>.
-     */
-    closeAllTabsText: 'Close All Tabs',
-    
-    constructor : function(config){
-        Ext.apply(this, config || {});
-    },
-
-    //public
-    init : function(tabs){
-        this.tabs = tabs;
-        tabs.on({
-            scope: this,
-            contextmenu: this.onContextMenu,
-            destroy: this.destroy
-        });
-    },
-    
-    destroy : function(){
-        Ext.destroy(this.menu);
-        delete this.menu;
-        delete this.tabs;
-        delete this.active;    
-    },
-
-    // private
-    onContextMenu : function(tabs, item, e){
-        this.active = item;
-        var m = this.createMenu(),
-            disableAll = true,
-            disableOthers = true,
-            closeAll = m.getComponent('closeall');
-        
-        m.getComponent('close').setDisabled(!item.closable);
-        tabs.items.each(function(){
-            if(this.closable){
-                disableAll = false;
-                if(this != item){
-                    disableOthers = false;
-                    return false;
-                }
-            }
-        });
-        m.getComponent('closeothers').setDisabled(disableOthers);
-        if(closeAll){
-            closeAll.setDisabled(disableAll);
-        }
-        
-        e.stopEvent();
-        m.showAt(e.getPoint());
-    },
-    
-    createMenu : function(){
-        if(!this.menu){
-            var items = [{
-                itemId: 'close',
-                text: this.closeTabText,
-                scope: this,
-                handler: this.onClose
-            }];
-            if(this.showCloseAll){
-                items.push('-');
-            }
-            items.push({
-                itemId: 'closeothers',
-                text: this.closeOtherTabsText,
-                scope: this,
-                handler: this.onCloseOthers
-            });
-            if(this.showCloseAll){
-                items.push({
-                    itemId: 'closeall',
-                    text: this.closeAllTabsText,
-                    scope: this,
-                    handler: this.onCloseAll
-                });
-            }
-            this.menu = new Ext.menu.Menu({
-                items: items
-            });
-        }
-        return this.menu;
-    },
-    
-    onClose : function(){
-        this.tabs.remove(this.active);
-    },
-    
-    onCloseOthers : function(){
-        this.doClose(true);
-    },
-    
-    onCloseAll : function(){
-        this.doClose(false);
-    },
-    
-    doClose : function(excludeActive){
-        var items = [];
-        this.tabs.items.each(function(item){
-            if(item.closable){
-                if(!excludeActive || item != this.active){
-                    items.push(item);
-                }    
-            }
-        }, this);
-        Ext.each(items, function(item){
-            this.tabs.remove(item);
-        }, this);
-    }
-});
-
-Ext.preg('tabclosemenu', Ext.ux.TabCloseMenu);