(#4329) - clean up docs, add fruitdown safari test

pouchdb · Oct 4, 2015 · 13b53d5 · 13b53d5
1 parent 06536be
commit 13b53d5
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 60 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -54,82 +54,83 @@ env:
 
   matrix:
   - CLIENT=node COMMAND=test
-  # - CLIENT=node LEVEL_PREFIX=foo_ COMMAND=test
+  - CLIENT=node LEVEL_PREFIX=foo_ COMMAND=test
 
   # Test against pouchdb-server
-  # - CLIENT=node SERVER=pouchdb-server COMMAND=test
-  # - CLIENT=selenium:firefox SERVER=pouchdb-server COMMAND=test
-  # - SERVER_ADAPTER=memdown LEVEL_ADAPTER=memdown SERVER=pouchdb-server COMMAND=test
+  - CLIENT=node SERVER=pouchdb-server COMMAND=test
+  - CLIENT=selenium:firefox SERVER=pouchdb-server COMMAND=test
+  - SERVER_ADAPTER=memdown LEVEL_ADAPTER=memdown SERVER=pouchdb-server COMMAND=test
 
   # Test against pouchdb-express-router
-  # - CLIENT=node SERVER=pouchdb-express-router COMMAND=test
+  - CLIENT=node SERVER=pouchdb-express-router COMMAND=test
 
   # Test in firefox/phantomjs running on travis
-  # - CLIENT=selenium:firefox COMMAND=test
-  # - CLIENT=selenium:phantomjs ES5_SHIM=true COMMAND=test
+  - CLIENT=selenium:firefox COMMAND=test
+  - CLIENT=selenium:phantomjs ES5_SHIM=true COMMAND=test
 
   # Test auto-compaction in Node, Phantom, and Firefox
-  # - AUTO_COMPACTION=true CLIENT=node COMMAND=test
-  # - AUTO_COMPACTION=true CLIENT=selenium:firefox COMMAND=test
-  # - AUTO_COMPACTION=true CLIENT=selenium:phantomjs ES5_SHIM=true COMMAND=test
+  - AUTO_COMPACTION=true CLIENT=node COMMAND=test
+  - AUTO_COMPACTION=true CLIENT=selenium:firefox COMMAND=test
+  - AUTO_COMPACTION=true CLIENT=selenium:phantomjs ES5_SHIM=true COMMAND=test
 
   # Test map/reduce
-  # - TYPE=mapreduce CLIENT=node COMMAND=test
-  # - TYPE=mapreduce CLIENT=selenium:firefox COMMAND=test
-  # - TYPE=mapreduce CLIENT=selenium:phantomjs ES5_SHIM=true COMMAND=test
+  - TYPE=mapreduce CLIENT=node COMMAND=test
+  - TYPE=mapreduce CLIENT=selenium:firefox COMMAND=test
+  - TYPE=mapreduce CLIENT=selenium:phantomjs ES5_SHIM=true COMMAND=test
 
   # Testing in saucelabs
-  # - CLIENT=saucelabs:chrome:36 COMMAND=test
-  # - CLIENT=saucelabs:chrome:37 COMMAND=test
-  # - CLIENT=saucelabs:chrome COMMAND=test
-  # - CLIENT=saucelabs:safari:6 COMMAND=test
-  # - CLIENT="saucelabs:internet explorer:10:Windows 8" COMMAND=test
-  # - CLIENT="saucelabs:internet explorer:10:Windows 8" ADAPTERS=memory COMMAND=test
+  - CLIENT=saucelabs:chrome:36 COMMAND=test
+  - CLIENT=saucelabs:chrome:37 COMMAND=test
+  - CLIENT=saucelabs:chrome COMMAND=test
+  - CLIENT=saucelabs:safari:6 COMMAND=test
+  - CLIENT="saucelabs:internet explorer:10:Windows 8" COMMAND=test
+  - CLIENT="saucelabs:internet explorer:10:Windows 8" ADAPTERS=memory COMMAND=test
 
   # split up the android+iphone tests as it goes over time
-  # - GREP=suite2 INVERT=true SKIP_MIGRATION=true CLIENT="saucelabs:iphone:8.1:OS X 10.10" COMMAND=test
-  # - GREP=suite2 SKIP_MIGRATION=true CLIENT="saucelabs:iphone:8.1:OS X 10.10" COMMAND=test
+  - GREP=suite2 INVERT=true SKIP_MIGRATION=true CLIENT="saucelabs:iphone:8.1:OS X 10.10" COMMAND=test
+  - GREP=suite2 SKIP_MIGRATION=true CLIENT="saucelabs:iphone:8.1:OS X 10.10" COMMAND=test
 
-  # - GREP=suite2 CLIENT="saucelabs:Android:5.1:Linux" COMMAND=test
-  # - GREP=suite2 INVERT=true CLIENT="saucelabs:Android:5.1:Linux" COMMAND=test
+  - GREP=suite2 CLIENT="saucelabs:Android:5.1:Linux" COMMAND=test
+  - GREP=suite2 INVERT=true CLIENT="saucelabs:Android:5.1:Linux" COMMAND=test
 
-  # - CLIENT=selenium:firefox ADAPTERS=memory COMMAND=test
-  # - CLIENT=selenium:firefox ADAPTERS=localstorage COMMAND=test
-  - CLIENT=selenium:firefox ADAPTERS=fruitdown COMMAND=test
+  - CLIENT=selenium:firefox ADAPTERS=memory COMMAND=test
+  - CLIENT=selenium:firefox ADAPTERS=localstorage COMMAND=test
+  - CLIENT="saucelabs:iphone:8.4:OS X 10.11" ADAPTERS=fruitdown GREP=suite2 INVERT=true COMMAND=test
+  - CLIENT="saucelabs:iphone:8.4:OS X 10.11" ADAPTERS=fruitdown GREP=suite2 COMMAND=test
 
   # Test CouchDB master (aka bigcouch branch)
-  # - CLIENT=node SERVER=couchdb-master COMMAND=test
-  # - SKIP_MIGRATION=true CLIENT=selenium:firefox SERVER=couchdb-master COMMAND=test
+  - CLIENT=node SERVER=couchdb-master COMMAND=test
+  - SKIP_MIGRATION=true CLIENT=selenium:firefox SERVER=couchdb-master COMMAND=test
 
   # Test Couchbase Sync Gateway
-  # - GREP=test.replication.js CLIENT=node SERVER=sync-gateway BAIL=0 COMMAND=test
+  - GREP=test.replication.js CLIENT=node SERVER=sync-gateway BAIL=0 COMMAND=test
 
   # Performance tests
-  # - CLIENT=selenium:firefox PERF=1 COMMAND=test
-  # - PERF=1 COMMAND=test
+  - CLIENT=selenium:firefox PERF=1 COMMAND=test
+  - PERF=1 COMMAND=test
 
-  # - COMMAND=test-unit
-  # - COMMAND=test-component
-  # - COMMAND=test-fuzzy
-  # - COMMAND=report-coverage
-  # - COMMAND=verify-bundle-size
+  - COMMAND=test-unit
+  - COMMAND=test-component
+  - COMMAND=test-fuzzy
+  - COMMAND=report-coverage
+  - COMMAND=verify-bundle-size
 
 matrix:
 
   allow_failures:
   # Expected failures
-  # - env: GREP=test.replication.js CLIENT=node SERVER=sync-gateway BAIL=0 COMMAND=test
+  - env: GREP=test.replication.js CLIENT=node SERVER=sync-gateway BAIL=0 COMMAND=test
 
   # Allowed failures
-  # - env: CLIENT=node SERVER=couchdb-master COMMAND=test
-  # - env: SKIP_MIGRATION=true CLIENT=selenium:firefox SERVER=couchdb-master COMMAND=test
-  # - env: CLIENT=node SERVER=pouchdb-express-router COMMAND=test
-  # - node_js: "iojs"
-  #   env: CLIENT=node COMMAND=test
-  # - env: CLIENT=node SERVER=pouchdb-server COMMAND=test
-  # - env: CLIENT=selenium:firefox SERVER=pouchdb-server COMMAND=test
-  # - env: SERVER_ADAPTER=memdown LEVEL_ADAPTER=memdown SERVER=pouchdb-server COMMAND=test
-  # - env: COMMAND=report-coverage
+  - env: CLIENT=node SERVER=couchdb-master COMMAND=test
+  - env: SKIP_MIGRATION=true CLIENT=selenium:firefox SERVER=couchdb-master COMMAND=test
+  - env: CLIENT=node SERVER=pouchdb-express-router COMMAND=test
+  - node_js: "iojs"
+    env: CLIENT=node COMMAND=test
+  - env: CLIENT=node SERVER=pouchdb-server COMMAND=test
+  - env: CLIENT=selenium:firefox SERVER=pouchdb-server COMMAND=test
+  - env: SERVER_ADAPTER=memdown LEVEL_ADAPTER=memdown SERVER=pouchdb-server COMMAND=test
+  - env: COMMAND=report-coverage
 
 
   fast_finish: true

diff --git a/docs/_includes/api/extras.html b/docs/_includes/api/extras.html
@@ -8,20 +8,6 @@
 
 These adapters are alternatives to PouchDB's built-in IndexedDB/WebSQL adapters. They fully pass the PouchDB test suite.
 
-#### FruitDOWN adapter
-
-{% highlight js %}
-var PouchDB = require('pouchdb');
-require('pouchdb/extras/fruitdown');
-
-var db = new PouchDB('mydb', {adapter: 'fruitdown'});
-{% endhighlight %}
-
-PouchDB adapter using [FruitDOWN](https://github.com/nolanlawson/fruitdown).
-This is an alternative to the default IndexedDB adapter that ships with PouchDB, which works over all implementations of IndexedDB, including Apple's buggy version.
-
-You can also download this plugin [as a standalone script](https://github.com/pouchdb/pouchdb/releases/download/{{ site.version }}/pouchdb.fruitdown.js).
-
 #### In-memory adapter
 
 {% highlight js %}
@@ -68,6 +54,22 @@
 {% endmarkdown %}
 {% include alert/end.html%}
 
+#### FruitDOWN adapter
+
+{% highlight js %}
+var PouchDB = require('pouchdb');
+require('pouchdb/extras/fruitdown');
+
+var db = new PouchDB('mydb', {adapter: 'fruitdown'});
+{% endhighlight %}
+
+PouchDB adapter using [FruitDOWN](https://github.com/nolanlawson/fruitdown).
+This is an alternative to the default IndexedDB adapter that ships with PouchDB, which works over all implementations of IndexedDB, including Apple's version.
+
+It is slower and more inefficient than PouchDB's default IndexedDB adapter, but it's handy if you need to use IndexedDB in Safari, iOS, WKWebView, etc.
+
+You can also download this plugin [as a standalone script](https://github.com/pouchdb/pouchdb/releases/download/{{ site.version }}/pouchdb.fruitdown.js).
+
 ### APIs for plugin authors
 
 These APIs are designed for PouchDB plugin authors, who may want to re-use some PouchDB code to avoid duplication.

diff --git a/docs/adapters.md b/docs/adapters.md
@@ -159,6 +159,7 @@ PouchDB also offers separate browser plugins that use backends other than Indexe
 
 * [pouchdb.memory.js](https://github.com/pouchdb/pouchdb/releases/download/{{ site.version }}/pouchdb.memory.js) (Minified: [pouchdb.memory.min.js](https://github.com/pouchdb/pouchdb/releases/download/{{ site.version }}/pouchdb.memory.min.js))
 * [pouchdb.localstorage.js](https://github.com/pouchdb/pouchdb/releases/download/{{ site.version }}/pouchdb.localstorage.js) (Minified: [pouchdb.localstorage.min.js](https://github.com/pouchdb/pouchdb/releases/download/{{ site.version }}/pouchdb.localstorage.min.js))
+* [pouchdb.fruitdown.js](https://github.com/pouchdb/pouchdb/releases/download/{{ site.version }}/pouchdb.fruitdown.js) (Minified: [pouchdb.fruitdown.min.js](https://github.com/pouchdb/pouchdb/releases/download/{{ site.version }}/pouchdb.fruitdown.min.js))
 
 {% include alert/start.html variant="warning"%}
 {% markdown %}
@@ -207,6 +208,19 @@ If you need to support very old browsers, such as IE &le; 9.0 and Opera Mini, yo
 The LocalStorage plugin should be considered highly experimental, and the underlying structure may change in the future.  Currently it stores all document IDs in memory, which works fine on small databases but may crash on larger databases.  You can follow <a href='https://github.com/No9/localstorage-down'>localstorage-down</a> to track our progress.
 {% include alert/end.html %}
 
+#### FruitDOWN adapter
+
+If you need to support IndexedDB in Apple browsers (which PouchDB normally does not support due to instability), then you can use FruitDOWN, which works over all IndexedDB implementations at the expense of using a much smaller part of the IndexedDB API and therefore being slower and less efficient.
+
+```html
+<script src="pouchdb.js"></script>
+<script src="pouchdb.fruitdown.js"></script>
+<script>
+  // this pouch is backed by FruitDOWN
+  var pouch = new PouchDB('mydb', {adapter: 'fruitdown'});
+</script>
+```
+
 {% include anchor.html title="PouchDB in Node.js" hash="pouchdb_in_node_js"%}
 
 In Node.js, the adapter situation is much simpler than in browsers.  By default, if you create a PouchDB like this one: