Updates for next version

Author: brandon93s

.gitignore

@@ -1,2 +1 @@
 node_modules
-.vscode/

.vscode/launch.json

@@ -0,0 +1,25 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+          "type": "node",
+          "request": "launch",
+          "name": "Debug AVA test file",
+          "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/ava",
+          "runtimeArgs": [
+            "debug",
+            "--break",
+            "--serial",
+            "${file}"
+          ],
+          "port": 9229,
+          "outputCapture": "std",
+          "skipFiles": [
+            "<node_internals>/**/*.js"
+          ]
+        }
+    ]
+}

index.d.ts

@@ -3,7 +3,7 @@
 const cheerio = require('cheerio')
 
 class HtmlTableToJson {
-  constructor (html, opts) {
+  constructor (html, opts = {}) {
     if (typeof html !== 'string') { throw new TypeError('html input must be a string') }
 
     this.html = html
@@ -14,10 +14,12 @@ class HtmlTableToJson {
     this._headers = []
     this._count = null
 
+    this._firstRowUsedAsHeaders = []
+
     this._process()
   }
 
-  static factory (html, opts) {
+  static parse (html, opts) {
     return new HtmlTableToJson(html, opts)
   }
 
@@ -26,7 +28,9 @@ class HtmlTableToJson {
   }
 
   get results () {
-    return this._results
+    return this.opts.values === true
+      ? this._results.map(result => result.map(Object.values))
+      : this._results
   }
 
   get headers () {
@@ -50,6 +54,8 @@ class HtmlTableToJson {
   }
 
   _processRow (tableIndex, index, row) {
+    if (index === 0 && this._firstRowUsedAsHeaders[tableIndex] === true) return
+
     this._results[tableIndex][index] = {}
 
     this._$(row).find('td').each((i, cell) => {
@@ -65,6 +71,13 @@ class HtmlTableToJson {
         this._headers[index][j] = this._$(cell).text().trim()
       })
     })
+
+    if (this._headers[index].length) return
+
+    this._firstRowUsedAsHeaders[index] = true
+    this._$(table).find('tr').first().find('td').each((j, cell) => {
+      this._headers[index][j] = this._$(cell).text().trim()
+    })
   }
 
   _pruneEmptyRows (tableIndex) {

index.js

@@ -3,11 +3,9 @@
   "version": "0.4.1",
   "description": "Extracts all tables within a provided html snippet and converts them to JSON objects.",
   "license": "MIT",
-  "types": "index.d.ts",
   "repository": "brandon93s/html-table-to-json",
   "author": {
     "name": "Brandon Smith",
-    "email": "[email protected]",
     "url": "github.com/brandon93s"
   },
   "engines": {
@@ -17,20 +15,18 @@
     "test": "ava --verbose"
   },
   "files": [
-    "index.js",
-    "index.d.ts"
+    "index.js"
   ],
   "keywords": [
     "html",
     "table",
     "json"
   ],
   "dependencies": {
-    "@types/cheerio": "^0.22.9",
-    "cheerio": "^1.0.0-rc.2"
+    "cheerio": "^1.0.0-rc.3"
   },
   "devDependencies": {
-    "ava": "^0.25.0",
+    "ava": "^3.0.0",
     "eslint": "^4.19.1",
     "eslint-config-standard": "^11.0.0",
     "eslint-plugin-import": "^2.10.0",

package.json

@@ -2,12 +2,10 @@
 
 > Extracts tables from a provided html snippet and converts them to JSON objects
 
-*Note: Currently always returns an array of results regardless of table count*
-
 ## Install
 
 ```
-$ npm install --save html-table-to-json
+$ npm install html-table-to-json
 ```
 
 
@@ -16,7 +14,7 @@ $ npm install --save html-table-to-json
 ```js
 const HtmlTableToJson = require('html-table-to-json');
 
-const jsonTables = new HtmlTableToJson(`
+const jsonTables = HtmlTableToJson.parse(`
         <table>
             <tr>
                 <th>Animal</th>
@@ -51,8 +49,7 @@ console.log(jsonTables.count);
 
 ## API
 
-### new HtmlTableToJson(input [,options])
-### HtmlTableToJson.factory(input [,options])
+### HtmlTableToJson.parse(input [,options])
 
 #### input
 
@@ -62,8 +59,25 @@ Any html snippet.
 
 #### options
 
-##### // todo
+Type: `object`
+
+##### values
+
+Type: `bool`
+
+Return table rows as value arrays:
+
+```js
+/* => [[
+ *      ['Unicorn', 'Pink', 'Billy'],
+ *      ['Walrus', 'Orange', 'Sue']
+ *    ]]
+ */
+```
+
+## Headers
 
+HtmlTableToJson extracts table headers ( `th` ) to be used as JSON object keys.  The first row is used when no `th` elements are present.
 
 ## License
 

readme.md

@@ -1,7 +1,7 @@
 'use strict'
 
-import test from 'ava'
-import HtmlTableToJson from './'
+const test = require('ava')
+const HtmlTableToJson = require('./')
 
 const singleEmpty = `<table></table>`
 const doubleEmpty = `${singleEmpty}${singleEmpty}`
@@ -21,7 +21,7 @@ test('double table count is 2', t => {
 
 const singleWithHeaderRow = `<table><tr><th>${h1}</th><th>${h2}</th><th>${h3}</th><th>${h4}</th></tr></table>`
 
-test('extracts headers correctly', t => {
+test('extracts th headers correctly', t => {
   const toString = value => value + ''
 
   const headers = new HtmlTableToJson(singleWithHeaderRow).headers[0]
@@ -32,10 +32,70 @@ test('extracts headers correctly', t => {
   t.is(headers[3], toString(h4))
 })
 
+const singleWithoutHeaderRow = `<table>
+                                  <tr><td>${h1}</td><td>${h2}</td><td>${h3}</td><td>${h4}</td></tr>
+                                  <tr><td>A</td><td>B</td><td>C</td><td>D</td></tr>
+                                </table>`
+
+test('falls back to first row for headers', t => {
+  const toString = value => value + ''
+
+  const _sut = new HtmlTableToJson(singleWithoutHeaderRow)
+
+  const headers = _sut.headers[0]
+  t.is(headers[0], toString(h1))
+  t.is(headers[1], toString(h2))
+  t.is(headers[2], toString(h3))
+  t.is(headers[3], toString(h4))
+
+  const rows = _sut.results[0]
+  t.is(rows[0][headers[0]], 'A')
+  t.is(rows[0][headers[1]], 'B')
+  t.is(rows[0][headers[2]], 'C')
+  t.is(rows[0][headers[3]], 'D')
+})
+
 test('throws when html is not a string', t => {
   t.throws(() => new HtmlTableToJson({}))
   t.throws(() => new HtmlTableToJson([]))
   t.throws(() => new HtmlTableToJson(1))
   t.throws(() => new HtmlTableToJson(NaN))
   t.throws(() => new HtmlTableToJson(true))
 })
+
+test('parse method', t => {
+  const _sut = HtmlTableToJson.parse(doubleEmpty)
+
+  t.is(_sut.count, 2)
+})
+
+const sampleTable = `<table>
+                        <tr>
+                            <th>Animal</th>
+                            <th>Color</th>
+                            <th>Name</th>
+                        </tr>
+                        <tr>
+                            <td>Unicorn</td>
+                            <td>Pink</td>
+                            <td>Billy</td>
+                        </tr>
+                        <tr>
+                            <td>Walrus</td>
+                            <td>Orange</td>
+                            <td>Sue</td>
+                        </tr>
+                    </table>`
+
+test('values option', t => {
+  const _sut = new HtmlTableToJson(sampleTable, { values: true })
+
+  t.is(_sut.count, 1)
+
+  const results = _sut.results[0]
+  t.is(results.length, 2)
+  t.true(Array.isArray(results[0]))
+  t.true(Array.isArray(results[1]))
+  t.is(results[0][0], 'Unicorn')
+  t.is(results[1][2], 'Sue')
+})