Changeset 9590 for lang/javascript/jsAutoPageScraper

Timestamp:

04/16/08 22:49:38 (5 years ago)

Author:

drry

Message:

lang/javascript/jsAutoPageScraper/trunk/test/jsAutoPageScraper-test.js
lang/javascript/jsAutoPageScraper/trunk/test/yahoo_auction.js
lang/javascript/jsAutoPageScraper/trunk/js/jsAutoPageScraper.js:

• trivial fixes and cleanups in comments.
  
• et cetera.
  

Location:

lang/javascript/jsAutoPageScraper/trunk

Files:

• js/jsAutoPageScraper.js (modified) (19 diffs)
• test/jsAutoPageScraper-test.js (modified) (2 diffs)
• test/yahoo_auction.js (modified) (1 diff)

lang/javascript/jsAutoPageScraper/trunk/js/jsAutoPageScraper.js

@@ -40 +40 @@
   } :
   function(element, evt, func) {
-    element.detachEvent('on'+evt, func);
+    element.detachEvent('on' + evt, func);
   };
 
 
 /**
- * Create hidden(invisible) iframe in order to scrape contents from DOM tree
- *
- * @param {String} url - URL path to scrape
- * @param {Function} callback - Callback function, invoked when iframe document load complete
+ * Create a hidden(invisible) iframe in order to scrape contents from a DOM tree.
+ *
+ * @param {String} url - URL path to scrape.
+ * @param {Function} callback - Callback function, invoked when iframe document load completed.
  * @param {Object} scope - Scope object that callback to be applied.
  */
 function createIframe(url, callback, scope) {
   // ugly W/A to prevent cache...
-  if (url==window.location.href) {
-    url += url.indexOf('?')>=0 ? '&' : '?';
+  if (url == window.location.href) {
+    url += url.indexOf('?') >= 0 ? '&' : '?';
   }
   var iframeEl = windoc.createElement('iframe');
@@ -72 +72 @@
 
 
-// detect base URL from own script URL
+// detect base URL from own script URL.
 var baseUrl = (function() {
   var scripts = windoc.getElementsByTagName('script');
-  for (var i=0,len=scripts.length; i < len; i++) {
-    var m = (scripts[i].src || '').match(/^(.*\/)jsAutoPageScraper\.js$/);
-    if (m) return m[1];
-  }
+  for (var i=scripts.length,m; i-- > 0; ) {
+    if (m = /^.*\/(?=jsAutoPageScraper\.js$)/.exec(scripts[i])) {
+      return m[0];
+    }
+  }
+  return '';
 })();
 
-// assuming JavaScript-XPath lib is located in following path :
+// assuming JavaScript-XPath lib is located in the following path :
 var xpathLibUrl = baseUrl + 'javascript-xpath/javascript-xpath.js';
 
 
 /**
- * Append JavaScript-XPath(http://coderepos.org/share/wiki/JavaScript-XPath) to HTML Document
- *
- * @param {Document} doc - HTML Document to add XPath lib
- * @param {Function} callback - callback function, invoked when XPath lib loaded
+ * Append JavaScript-XPath <http://coderepos.org/share/wiki/JavaScript-XPath> to HTML Document.
+ *
+ * @param {Document} doc - HTML Document to add XPath lib.
+ * @param {Function} callback - callback function, invoked when XPath lib loaded.
  * @param {Object} scope - Scope object that callback to be applied.
  */
@@ -99 +101 @@
     scriptEl.type = 'text/javascript';
     scriptEl.src = xpathLibUrl;
-    var ctEl = doc.documentElement;
-    ctEl.appendChild(scriptEl);
+    doc.documentElement.appendChild(scriptEl);
     pollXPathLibLoadStatus();
   }
@@ -117 +118 @@
  * Query items from HTML doc matching to the given XPath expression.
  *
- * @param {Document} doc - HTML Document
- * @param {String} xpath - XPath expression
- * @param {Node} contextNode - context node to search elements by xpath
+ * @param {Document} doc - HTML Document.
+ * @param {String} xpath - XPath expression.
+ * @param {Node} contextNode - context node to search elements by xpath.
  * @returns XPath matching nodes
  * @type Node
@@ -135 +136 @@
  * Query one item from HTML doc matching to the given XPath expression.
  *
- * @param {Document} doc - HTML Document
- * @param {String} xpath - XPath expression
- * @param {Node} contextNode - context node to search elements by xpath
+ * @param {Document} doc - HTML Document.
+ * @param {String} xpath - XPath expression.
+ * @param {Node} contextNode - context node to search elements by xpath.
  * @returns XPath matching node
  * @type Node
@@ -147 +148 @@
 
 /**
- * Convert DOM to JavaScript Object
- *
- * @param {Node} elem - HTML Document Node
- * @param {String|Object|Function} mapping - Mapping information
+ * Convert DOM to JavaScript Object.
+ *
+ * @param {Node} elem - HTML Document Node.
+ * @param {String|Object|Function} mapping - Mapping information.
  * @returns JavaScript object
  * @type Object
@@ -165 +166 @@
       return mapping(elem);
     case 'object' :
-      var o = {}
+      var o = {};
       for (var k in mapping) {
         o[k] = convertDOM2Object(elem, mapping[k]);
@@ -182 +183 @@
 /**
  * JSAutoPageScraper
- * 
+ *
  * Usage : <pre>
  var jscr = new JSAutoPageScraper('http://twitter.com/home', {
@@ -191 +192 @@
      author : './/td[contains(@class,"content")]/strong/a/text()',
      content : function(p) { return (p.textContent || p.innerText).replace(/\s+/g, ' '); }
-   } 
+   }
  });
 
@@ -208 +209 @@
  *
  * @constructor
- * @param {String} url - Page URL to start scraping
- * @param {Object} info - Siteinfo config, includes "nextLink", "paragraph", and "mapping".
+ * @param {String} url - Page URL to start scraping.
+ * @param {Object} info - Siteinfo config, includes "nextLink", "paragraph" and "mapping".
  */
 var JSAutoPageScraper = function(url, info) {
   this.proxy = new ScrapeProxy(url, info);
   this.cmdQueue = [];
-}
+};
 
 
@@ -223 +224 @@
 
   /**
-   * Scrape paragraphs by given count. 
-   * 
-   * @param {Number} count - Number of records to fetch. 
+   * Scrape paragraphs by given count.
+   *
+   * @param {Number} count - Number of records to fetch.
    * @param {Function} callback - Callback function to get scraped records.
    * @param {Object} scope - Scope object that callback to be applied.
@@ -240 +241 @@
           count,
           function(rec) { records.push(rec) },
-          function() { callback.call(scope, records); _this.force() } 
+          function() { callback.call(scope, records); _this.force() }
         ]
       }
@@ -251 +252 @@
   /**
    * Skip and proceed cursor by given count.
-   * 
-   * @param {Number} count - Number of paragraphs to skip. 
+   *
+   * @param {Number} count - Number of paragraphs to skip.
    * @returns Self instance
    * @type JSAutoPageScraper
@@ -269 +270 @@
   /**
    * Refresh queued commands and wait next command by keeping current cursor and resources.
-   * 
+   *
    * @returns Self instance
    * @type JSAutoPageScraper
@@ -281 +282 @@
   /**
    * Refresh queued commands and cleanup all resources pointing to scraping document.
-   * 
+   *
    * @returns Self instance
    * @type JSAutoPageScraper
@@ -296 +297 @@
 
   /**
-   * Evaluate delayed command
+   * Evaluate delayed command.
    */
   force : function() {
@@ -302 +303 @@
     if (cmd) this.proxy[cmd.method].apply(this.proxy, cmd.args);
   }
-}
+};
 
 
 /**
  * Proxy object that accesses scraping document.
- * 
+ *
  * @constructor
- * @param {String} url - Page URL to start scraping
- * @param {Object} info - Siteinfo config, includes "nextLink", "paragraph", and "mapping".
- */
-var ScrapeProxy = function(url, info) { 
+ * @param {String} url - Page URL to start scraping.
+ * @param {Object} info - Siteinfo config, includes "nextLink", "paragraph" and "mapping".
+ */
+var ScrapeProxy = function(url, info) {
   this.url = this.currUrl = url;
   this.siteinfo = info;
   this.converter = function(el) {
     return convertDOM2Object(el, info.mapping);
-  }
-}
+  };
+};
 
 
@@ -327 +328 @@
 
   /**
-   * Fetch records
-   * 
+   * Fetch records.
+   *
    * @param {Number} count - Fetching count.
    * @param {Function} onScanRecord - Callbacked when scanning fetched record.
@@ -346 +347 @@
 
   /**
-   * Clear and reset fetching state.
+   * Clear and reset fetching states.
    */
   clear : function() {

lang/javascript/jsAutoPageScraper/trunk/test/jsAutoPageScraper-test.js

@@ -496 +496 @@
   var t = typeof o;
   if (t=='string') {
-    return '"'+o.replace(/"/g, '\\"').replace(/\n/g, '\\n')+'"';
+    return '"'+o.replace(/(?=")/g, '\\').replace(/\r?\n|\r/g, '\\n')+'"';
   } else if (t=='number' || t=='boolean' || o instanceof Date) {
     return (o).toString();
@@ -525 +525 @@
     ta.value = debuglogs.join('\n');
   }
-}
+};
 
 

lang/javascript/jsAutoPageScraper/trunk/test/yahoo_auction.js

@@ -9 +9 @@
   nextLink: '//td[@align="right" and @width="1%"]/small/b[last()]/a',
   paragraph: '//tr[@bgcolor="#eeeeee"]/td[@align="left"]',
-  mapping : { 
+  mapping : {
     link : './/a/@href',
     text : './/a/text()'