RubyGems - jsduck - Versions diffs - 0.6.1 → 2.0.pre - Mend

jsduck 0.6.1 → 2.0.pre

Files changed (453) hide show

@@ -4,20 +4,26 @@ module JsDuck
   #
   # Also provides a place to look up classes by name.
   #
-  # The constructor is initialized with array of all available
-  # classes.
+  # The constructor is initialized with array of all available classes
+  # and list of class names to ignore.  By default the latter list
+  # contains only JavaScript base class "Object".
   class Relations
     # Returns list of all classes
     attr_reader :classes
-    def initialize(classes = [])
+    def initialize(classes = [], ignorables = [])
       @classes = classes
+      @ignorables = {"Object" => true}
+      ignorables.each {|classname| @ignorables[classname] = true }
       # First build class lookup table; building lookup tables for
       # mixins and subclasses will depend on that.
       @lookup = {}
       @classes.each do |cls|
         @lookup[cls.full_name] = cls
+        (cls[:alternateClassNames] || []).each do |alt_name|
+          @lookup[alt_name] = cls
+        end
         cls.relations = self
       end
@@ -34,6 +40,11 @@ module JsDuck
       @lookup[classname]
     end
+    # Returns true if class is in list of ignored classes.
+    def ignore?(classname)
+      @ignorables[classname]
+    end
     def each(&block)
       @classes.each(&block)
     end

data/lib/jsduck/{members.rb → search_data.rb} RENAMED

@@ -3,7 +3,7 @@ module JsDuck
   # Creates list of all members in all classes that is used by the
   # searching feature in UI.
-  class Members
+  class SearchData
     # Given list of class documentation objects returns an array of
     # hashes describing all the members.
     def create(docs)
@@ -13,7 +13,7 @@ module JsDuck
         [:cfg, :property, :method, :event].each do |type|
           cls.members(type).each do |m|
             # skip inherited items and constructors
-            if m[:member] == cls.full_name && m[:name] != cls.short_name
+            if m[:owner] == cls.full_name && m[:name] != cls.short_name
               list << member_node(m, cls)
             end
           end
@@ -28,7 +28,7 @@ module JsDuck
         :cls => cls.full_name,
         :member => cls.short_name,
         :type => :cls,
-        :doc => short_desc(cls[:doc])
+        :xtypes => cls[:xtypes]
       }
     end
@@ -38,34 +38,9 @@ module JsDuck
         :cls => cls.full_name,
         :member => member[:name],
         :type => member[:tagname],
-        :doc => short_desc(member[:doc])
       }
     end
-    def short_desc(str)
-      tagless = first_sentence(strip_tags(strip_links(str)))
-      if tagless.length > 120
-        short_doc = tagless[0..116]
-        ellipsis = tagless.length > short_doc.length ? "..." : ""
-        tagless[0..116] + ellipsis
-      else
-        tagless
-      end
-    end
-    def strip_tags(str)
-      str.gsub(/<.*?>/, "")
-    end
-    def strip_links(str)
-      str = str.gsub(/\{@link +(\S*?)(?: +(.+?))?\}/, "\\1")
-      str = str.gsub(/#/, ".")
-    end
-    def first_sentence(str)
-      str.sub(/\A(.+?\.)\s.*\Z/m, "\\1")
-    end
   end
 end

data/lib/jsduck/source_file.rb CHANGED

@@ -68,8 +68,8 @@ module JsDuck
         doc[:name].gsub(/\./, '-')
       else
         # when creation of global class is skipped,
-        # this member property can be nil.
-        (doc[:member] || "global").gsub(/\./, '-') + "-" + doc[:tagname].to_s + "-" + doc[:name]
+        # this owner property can be nil.
+        (doc[:owner] || "global").gsub(/\./, '-') + "-" + doc[:tagname].to_s + "-" + doc[:name]
       end
     end
@@ -93,8 +93,8 @@ module JsDuck
       doc[:filename] = @filename
       doc[:linenr] = linenr
       if doc[:tagname] == :class
-        doc[:cfg].each {|cfg| link(linenr, cfg) }
-        doc[:method].each {|method| link(linenr, method) }
+        doc[:members][:cfg].each {|cfg| link(linenr, cfg) }
+        doc[:members][:method].each {|method| link(linenr, method) }
       end
       doc
     end

data/lib/jsduck/source_writer.rb CHANGED

@@ -45,8 +45,8 @@ module JsDuck
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
-  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
-  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../prettify/prettify.js"></script>
   <style type="text/css">
     .highlight { display: block; background-color: #ddd; }
   </style>

data/lib/jsduck/timer.rb CHANGED

@@ -1,3 +1,5 @@
+require 'jsduck/logger'
 module JsDuck
   # Helper for timing execution of named code blocks.
@@ -31,9 +33,11 @@ module JsDuck
       result
     end
-    # prints timings report to console
+    # prints timings report to log
     def report
-      @timings.each {|name, time| puts "#{name}:\t#{time} seconds" }
+      @timings.each do |name, time|
+        Logger.instance.log("#{name}:\t#{time} seconds")
+      end
     end
   end

data/lib/jsduck/tree.rb CHANGED

@@ -12,7 +12,6 @@ module JsDuck
         :id => "apidocs",
         :iconCls => "icon-docs",
         :text => "API Documentation",
-        :singleClickExpand => true,
         :children => []
       }
       @packages = {"" => @root}
@@ -21,24 +20,25 @@ module JsDuck
     # Given list of class documentation objects returns a
     # tree-structure that can be turned into JSON that's needed by
     # documentation browser interface.
-    def create(docs)
+    def create(docs, guides=[])
       docs.each {|cls| add_class(cls) }
       sort_tree(@root)
+      add_guides(guides)
       @root
     end
     # Sorts all child nodes, and recursively all child packages.
     def sort_tree(node)
       node[:children].sort! {|a,b| compare(a, b) }
-      node[:children].find_all {|c| c[:cls] == "package" }.each {|c| sort_tree(c) }
+      node[:children].find_all {|c| c[:children] }.each {|c| sort_tree(c) }
     end
     # Comparson method that sorts package nodes before class nodes.
     def compare(a, b)
-      if a[:cls] == b[:cls]
-        a[:text] <=> b[:text]
+      if a[:leaf] == b[:leaf]
+        a[:text].casecmp(b[:text])
       else
-        a[:cls] == "package" ? -1 : 1
+        a[:leaf] ? 1 : -1
       end
     end
@@ -65,40 +65,53 @@ module JsDuck
       package
     end
+    # When guides list not empty, add guides to tree
+    def add_guides(guides)
+      if guides.length > 0
+        pkg = package_node("guides")
+        guides.each {|g| pkg[:children] << guide_node(g) }
+        @root[:children] << pkg
+      end
+    end
     # Given full doc object for class creates class node
     def class_node(cls)
       return {
-        :href => "output/#{cls.full_name}.html",
         :text => cls.short_name,
-        :id => cls.full_name,
-        :isClass => true,
+        :url => "/api/"+cls.full_name,
         :iconCls => class_icon(cls),
-        :cls => "cls",
         :leaf => true
       }
     end
     def class_icon(cls)
       if cls[:singleton]
-        "icon-static"
+        "icon-singleton"
       elsif cls.inherits_from?("Ext.Component")
-        "icon-cmp"
+        "icon-component"
       else
-        "icon-cls"
+        "icon-class"
       end
     end
     # Given full package name like my.package creates package node
     def package_node(name)
       return {
-        :id => "pkg-#{name}",
         :text => Class.short_name(name),
         :iconCls => "icon-pkg",
-        :cls => "package",
-        :singleClickExpand => true,
         :children => []
       }
     end
+    # Given full guide object creates guide node
+    def guide_node(guide)
+      return {
+        :text => guide[:title],
+        :url => "/guide/"+guide[:name],
+        :iconCls => "icon-guide",
+        :leaf => true
+      }
+    end
   end
 end

data/lib/jsduck/tree_icons.rb CHANGED

@@ -10,7 +10,7 @@ module JsDuck
           icons.merge!(extract_icons(child))
         end
       else
-        icons[node[:id]] = node[:iconCls]
+        icons[node[:url]] = node[:iconCls]
       end
       icons
     end

data/template/README.md ADDED

@@ -0,0 +1,14 @@
+Manyally create extjs/ directory inside this dir.
+Either copy over ExtJS directory or create symlink to it.
+    $ cp -r /path/to/ext-4.0.0 template/extjs
+or
+    $ ln -s /path/to/ext-4.0.0 template/extjs
+Then run compass to generate custom ExtJS theme:
+    $ compass template/resources/sass

data/template/app.js ADDED

@@ -0,0 +1,25 @@
+Ext.ns("Docs");
+Ext.Loader.setConfig({
+    enabled: true,
+    paths: {
+        'Docs': 'app'
+    }
+});
+Ext.require('Docs.view.Viewport');
+Ext.require('Ext.form.field.Trigger');
+Ext.require('Ext.tab.Panel');
+Ext.require('Ext.grid.column.Action');
+Ext.require('Ext.grid.plugin.DragDrop');
+Ext.require('Ext.layout.container.Border');
+Ext.require('Ext.data.TreeStore');
+// The following is exactly what Ext.application() function does, but
+// we use our own Application class that extends Ext.app.Application
+Ext.require('Docs.Application');
+Ext.onReady(function() {
+    Ext.create('Docs.Application');
+});

data/template/app/Application.js ADDED

@@ -0,0 +1,53 @@
+/**
+ * Main application definition for Docs app.
+ *
+ * We define our own Application class because this way we can also
+ * easily define the dependencies.
+ */
+Ext.define('Docs.Application', {
+    extend: 'Ext.app.Application',
+    name: 'Docs',
+    requires: [
+        'Docs.Favorites',
+        'Docs.History',
+        'Docs.Settings'
+    ],
+    uses: [
+        'Ext.util.History',
+        'Ext.data.JsonP'
+    ],
+    controllers: [
+        'Classes',
+        'Search'
+    ],
+    launch: function() {
+        Docs.App = this;
+        Docs.Favorites.init();
+        Docs.Settings.init();
+        Ext.create('Docs.view.Viewport');
+        // Update favorites grid height between browser tabs if changed
+        Ext.getStore('Settings').on('load', function(store) {
+            var favHeight = Docs.Settings.get('favorites-height');
+            if (favHeight) {
+                var tabPanel = Ext.getCmp('classes-tab-panel');
+                tabPanel.suspendEvents();
+                tabPanel.setHeight(favHeight);
+                tabPanel.resumeEvents();
+            }
+        });
+        Docs.History.init();
+        // When google analytics event tracking script present on page
+        if (Docs.initEventTracking) {
+            Docs.initEventTracking();
+        }
+    }
+});

data/template/app/Favorites.js ADDED

@@ -0,0 +1,88 @@
+/**
+ * Favorites management.
+ */
+Ext.define("Docs.Favorites", {
+    extend: 'Docs.LocalStore',
+    storeName: 'Favorites',
+    singleton: true,
+    init: function() {
+        this.callParent(arguments);
+        // Populate favorites with Top 10 classes
+        if (this.store.data.items.length == 0) {
+            var top10 = [
+                'Ext.data.Store',
+                'Ext',
+                'Ext.grid.Panel',
+                'Ext.panel.Panel',
+                'Ext.form.field.ComboBox',
+                'Ext.data.Model',
+                'Ext.form.Panel',
+                'Ext.button.Button',
+                'Ext.tree.Panel',
+                'Ext.Component'
+            ];
+            this.store.add(Ext.Array.map(top10, function(clsName) {
+                return {url: "/api/"+clsName, title: clsName};
+            }));
+            this.syncStore();
+        }
+        // For backwards compatibility with old Favorites Model
+        // convert the old-style records to new schema.
+        else if (!this.store.first().get("url")) {
+            this.store.each(function(r) {
+                r.set("title", r.data.cls);
+                r.set("url", "/api/"+r.get("cls"));
+                r.set("cls", "");
+            });
+            this.syncStore();
+        }
+    },
+    /**
+     * Associates Favorites with Docs TreePanel component.
+     * @param {Docs.view.tree.Tree} tree
+     */
+    setTree: function(tree) {
+        this.tree = tree;
+    },
+    /**
+     * Adds page to favorites
+     *
+     * @param {String} url  the page to add
+     * @param {String} title  title for Favorites entry
+     */
+    add: function(url, title) {
+        if (!this.has(url)) {
+            this.store.add({url: url, title: title});
+            this.syncStore();
+            this.tree.setFavorite(url, true);
+        }
+    },
+    /**
+     * Removes page from favorites.
+     *
+     * @param {String} url  the page URL to remove
+     */
+    remove: function(url) {
+        if (this.has(url)) {
+            this.store.removeAt(this.store.findExact('url', url));
+            this.syncStore();
+            this.tree.setFavorite(url, false);
+        }
+    },
+    /**
+     * Checks if page exists in favorites
+     *
+     * @param {String} url  the URL to check
+     * @return {Boolean} true when present
+     */
+    has: function(url) {
+        return this.store.findExact('url', url) > -1;
+    }
+});