build out documentation

matthewmueller · May 31, 2015 · 2603c0b · 2603c0b
1 parent 7709e08
commit 2603c0b
Show file tree

Hide file tree

Showing 16 changed files with 186 additions and 300 deletions.
diff --git a/Readme.md b/Readme.md
diff --git a/examples/array-of-arrays.html b/examples/array-of-arrays.html
@@ -0,0 +1,9 @@
+<ul class="tags">
+  <li>a</li>
+  <li>b</li>
+  <li>c</li>
+</ul>
+<ul class="tags">
+  <li>d</li>
+  <li>e</li>
+</ul>
diff --git a/examples/array-of-arrays.js b/examples/array-of-arrays.js
@@ -0,0 +1,8 @@
+var read = require('fs').readFileSync;
+var html = read(__dirname + '/array-of-arrays.html');
+var Xray = require('..');
+var x = Xray()
+
+x(html, '.tags', [['li']])(function(err, arr) {
+  console.log(arr);
+});
diff --git a/examples/arrays.html b/examples/arrays.html
@@ -0,0 +1,5 @@
+<body>
+  <a href="http://google.com">Google</a>
+  <a href="http://facebook.com">Facebook</a>
+  <a href="http://twitter.com">Twitter</a>
+</body>
diff --git a/examples/arrays.js b/examples/arrays.js
@@ -0,0 +1,8 @@
+var read = require('fs').readFileSync;
+var html = read(__dirname + '/arrays.html');
+var Xray = require('..');
+var x = Xray()
+
+x(html, ['a'])(function(err, arr) {
+  console.log(arr);
+})
diff --git a/examples/collection-of-collections.html b/examples/collection-of-collections.html
@@ -0,0 +1,17 @@
+<div class="items">
+  <div class="item">
+    <h2>first item</h2>
+    <ul class="tags">
+      <li>a</li>
+      <li>b</li>
+      <li>c</li>
+    </ul>
+  </div>
+  <div class="item">
+    <h2>second item</h2>
+    <ul class="tags">
+      <li>d</li>
+      <li>e</li>
+    </ul>
+  </div>
+</div>
diff --git a/examples/collection-of-collections.js b/examples/collection-of-collections.js
@@ -0,0 +1,11 @@
+var read = require('fs').readFileSync;
+var html = read(__dirname + '/collection-of-collections.html');
+var Xray = require('..');
+var x = Xray()
+
+x(html, '.item', [{
+  title: 'h2',
+  tags: x('.tags', ['li'])
+}])(function(err, arr) {
+  console.log(arr);
+});
diff --git a/examples/collections.html b/examples/collections.html
@@ -0,0 +1,7 @@
+<h2 class="title">first item</h2>
+<img src="item.png">
+<ul class="tags">
+  <li>a</li>
+  <li>b</li>
+  <li>c</li>
+</ul>
diff --git a/examples/collections.js b/examples/collections.js
@@ -0,0 +1,12 @@
+var read = require('fs').readFileSync
+var html = read(__dirname + '/collections.html')
+var Xray = require('..')
+var x = Xray()
+
+x(html, {
+  title: '.title',
+  image: 'img@src',
+  tags: ['li']
+})(function(err, obj) {
+  console.log(obj);
+})
diff --git a/examples/github-stars.js b/examples/github-stars.js
diff --git a/examples/selector.html b/examples/selector.html
@@ -0,0 +1 @@
+<h2>header two</h2>
diff --git a/examples/selector.js b/examples/selector.js
@@ -0,0 +1,8 @@
+var read = require('fs').readFileSync
+var html = read(__dirname + '/selector.html')
+var Xray = require('..')
+var x = Xray()
+
+x(html, 'h2')(function(err, title) {
+  console.log(title);
+})
diff --git a/index.js b/index.js
@@ -32,7 +32,7 @@ var error = require('debug')('x-ray:error');
  * Crawler methods
  */
 
-var methods = [ 'concurrency', 'throttle', 'timeout', 'driver', 'delay' ];
+var methods = [ 'concurrency', 'throttle', 'timeout', 'driver', 'delay', 'limit'];
 
 /**
  * Export

diff --git a/lib/is-html.js b/lib/is-html.js
@@ -9,7 +9,7 @@ module.exports = isHTML;
  */
 
 function isHTML(str) {
-  str = (str || '').trim();
+  str = (str || '').toString().trim();
   return '<' == str[0]
     && '>' == str[str.length - 1];
 }
diff --git a/test.js b/test.js
@@ -0,0 +1,9 @@
+var Xray = require('./');
+var x = Xray();
+
+x('http://google.com', {
+  main: 'title',
+  image: x('https://images.google.com', 'title')
+})(function(err, obj) {
+  console.log(obj); // => { main: 'Google', image: 'Google Images' }
+})
diff --git a/test/index.js b/test/index.js
@@ -178,10 +178,10 @@ describe('Xray()', function() {
     var $ = cheerio.load(html);
     var x = Xray();
 
-    x('.item', [{
+    x($, '.item', [{
       title: 'h2',
       tags: x('.tags', ['li'])
-    }])($, function(err, arr) {
+    }])(function(err, arr) {
       if (err) return done(err);
       assert.deepEqual([
         { title: 'first item', tags: [ 'a', 'b', 'c' ] },