jsduck 0.5 → 0.6

data/lib/jsduck/table.rb

@@ -1,5 +1,3 @@
-require 'jsduck/doc_formatter'
-
 module JsDuck
 
   # Base class for creating HTML tables of class members.
@@ -12,18 +10,17 @@ module JsDuck
     #
     # - 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, cache={})
+    def initialize(cls, formatter, cache={})
       @cls = cls
+      @formatter = formatter
       @cache = cache
-      @formatter = DocFormatter.new
-      @formatter.context = cls.full_name
-      @formatter.css_class = 'docClass'
-      @formatter.url_template = 'output/%cls%.html'
     end
 
     def to_html
@@ -57,8 +54,12 @@ module JsDuck
         html = @cache[cache_key] = create_row(item)
       end
       inherited = inherited?(item) ? 'inherited' : ''
-      owner = inherited?(item) ? member_link(item) : Class.short_name(item[:member])
-      html.sub(/!!--inherited--!!/, inherited).sub(/!!--owner-class--!!/, owner)
+      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
@@ -72,7 +73,7 @@ module JsDuck
       <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-class--!!</td>
+        <td class='msource'>!!--owner-link--!!</td>
       </tr>
       EOHTML
     end
@@ -82,7 +83,7 @@ module JsDuck
     end
 
     def signature(item)
-      id = @cls.full_name+ "-" + item[:name]
+      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

data/template/resources/docs.js

@@ -235,10 +235,9 @@ MainPanel = function(){
 			fields: ['cls', 'member', 'type', 'doc']
 		})
 	});
-	this.searchStore.loadData(Docs.membersData);
-	this.searchStore.filterBy(function(r) {
-		return false;
-	});
+    this.searchStore.loadData(Docs.membersData);
+    var records = this.searchStore.getRange();
+    this.searchStore.removeAll();
 
 	
     MainPanel.superclass.constructor.call(this, {
@@ -258,25 +257,14 @@ MainPanel = function(){
             autoLoad: {url: 'welcome.html', callback: this.initSearch, scope: this, delay: 100},
             iconCls:'icon-docs',
             autoScroll: true,
-			tbar: [
-				'Search: ', ' ',
-                new Ext.ux.SelectBox({
-                    listClass:'x-combo-list-small',
-                    width:90,
-                    value:'Starts with',
-                    id:'search-type',
-                    store: new Ext.data.SimpleStore({
-                        fields: ['text'],
-                        expandData: true,
-                        data : ['Starts with', 'Ends with', 'Any match']
-                    }),
-                    displayField: 'text'
-                }), ' ',
+            tbar: [
+                'Search: ', ' ',
                 new Ext.app.SearchField({
-	                width:240,
-					store: this.searchStore,
-					paramName: 'q'
-	            })
+                    width: 340,
+                    records: records,
+                    store: this.searchStore,
+                    paramName: 'q'
+                })
             ]
         }
     });
@@ -341,12 +329,18 @@ Ext.extend(MainPanel, Ext.TabPanel, {
 	    var resultTpl = new Ext.XTemplate(
 	        '<tpl for=".">',
 	        '<div class="search-item">',
-	            '<a class="member docClass" rel="{cls}#{member}" href="output/{cls}.html">',
+	            '<a class="member docClass" rel="{[this.rel(values)]}" href="output/{cls}.html">',
 				'<img src="resources/images/default/s.gif" class="item-icon icon-{type}"/>{member}',
 				'</a> ',
 				'<a class="cls docClass" rel="{cls}" href="output/{cls}.html">{cls}</a>',
 	            '<p>{doc}</p>',
-	        '</div></tpl>'
+	        '</div></tpl>',
+            {
+                // Different links to classes and members
+                rel: function(values) {
+                    return (values.type === "cls") ? values.cls : values.cls+"#"+values.member;
+                }
+            }
 	    );
 
 		var p = new Ext.DataView({
@@ -358,20 +352,6 @@ Ext.extend(MainPanel, Ext.TabPanel, {
             itemSelector: 'div.search-item',
 			emptyText: '<h3>Use the search field above to search the Ext API for classes, properties, config options, methods and events.</h3>'
         });
-	},
-	
-	doSearch : function(e){
-		var k = e.getKey();
-		if(!e.isSpecialKey()){
-			var text = e.target.value;
-			if(!text){
-				this.searchStore.baseParams.q = '';
-				this.searchStore.removeAll();
-			}else{
-				this.searchStore.baseParams.q = text;
-				this.searchStore.reload();
-			}
-		}
 	}
 });
 
@@ -451,9 +431,7 @@ Ext.app.SearchField = Ext.extend(Ext.form.TwinTriggerField, {
 
     onTrigger1Click : function(){
         if(this.hasSearch){
-            this.store.filterBy(function(r) {
-                return false;
-            });
+            this.store.removeAll();
             this.el.dom.value = '';
             this.triggers[0].hide();
             this.hasSearch = false;
@@ -472,23 +450,37 @@ Ext.app.SearchField = Ext.extend(Ext.form.TwinTriggerField, {
 			return;
 		}
 
-		var type = Ext.getCmp('search-type').getValue();
-		this.store.filter("member", this.createRegex(type, v));
+        this.store.removeAll();
+        this.store.add(this.search(v));
 
         this.hasSearch = true;
         this.triggers[0].show();
 		this.focus();
     },
 
-    createRegex: function(type, text) {
+    search: function(text) {
+        var results = [[], [], []];
         var safeText = Ext.escapeRe(text);
-        if (type === 'Starts with') {
-            return new RegExp("^" + safeText, "i");
-        } else if (type === 'Ends with') {
-            return new RegExp(safeText + "$", "i");
-        } else {
-            return new RegExp(safeText, "i");
-        }
+        var re0 = new RegExp("^" + safeText + "$", "i");
+        var re1 = new RegExp("^" + safeText, "i");
+        var re2 = new RegExp(safeText, "i");
+        this.records.forEach(function(r) {
+            var member = r.get("member");
+            if (re0.test(member)) {
+                results[0].push(r);
+            }
+            else if (re1.test(member)) {
+                results[1].push(r);
+            }
+            else if (re2.test(member)) {
+                results[2].push(r);
+            }
+        });
+        // flatten results array
+        var arr = [];
+        results = arr.concat.apply(arr, results);
+        // only pick first n results
+        return results.slice(0, 50);
     }
 });
 

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: jsduck
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
-  version: "0.5"
+  - 6
+  version: "0.6"
 platform: ruby
 authors: 
 - Rene Saarsoo
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-29 00:00:00 +03:00
+date: 2011-04-27 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,11 +78,13 @@ files:
 - lib/jsduck/app.rb
 - lib/jsduck/cfg_table.rb
 - lib/jsduck/class.rb
+- lib/jsduck/css_parser.rb
 - lib/jsduck/doc_formatter.rb
 - lib/jsduck/doc_parser.rb
 - lib/jsduck/event_table.rb
 - lib/jsduck/exporter.rb
 - lib/jsduck/inheritance_tree.rb
+- lib/jsduck/js_parser.rb
 - lib/jsduck/lexer.rb
 - lib/jsduck/long_params.rb
 - lib/jsduck/members.rb
@@ -90,11 +92,11 @@ files:
 - lib/jsduck/method_table.rb
 - lib/jsduck/page.rb
 - lib/jsduck/parallel_wrap.rb
-- lib/jsduck/parser.rb
 - lib/jsduck/property_table.rb
 - lib/jsduck/relations.rb
 - lib/jsduck/short_params.rb
-- lib/jsduck/source_formatter.rb
+- lib/jsduck/source_file.rb
+- lib/jsduck/source_writer.rb
 - lib/jsduck/table.rb
 - lib/jsduck/timer.rb
 - lib/jsduck/tree.rb