Merge pull request #30 from mxstbr/flat-file-adapter

Extract flat-file-db adapter into separate package

README.md

@@ -4,7 +4,7 @@ Public analytics as a Node.js microservice, no sysadmin experience required.
 
 [![Build Status](https://travis-ci.org/mxstbr/micro-analytics.svg?branch=master)](https://travis-ci.org/mxstbr/micro-analytics)
 
-A tiny analytics server with ~150 lines of code, easy to run and hack around on. It does one thing, and it does it well: count the views of something and making the views publicly accessible via an API.
+A tiny analytics server with ~100 lines of code, easy to run and hack around on. It does one thing, and it does it well: count the views of something and making the views publicly accessible via an API.
 
 (there is currently no frontend to display pretty graphs, feel free to build one yourself!)
 
@@ -52,7 +52,7 @@ If you want to get all views for all ids, set the `all` query parameter to `true
 
 ### Database adapters
 
-By default, `micro-analytics` uses `flat-file-db`, a fast in-process flat file database, which makes for easy setup and backups. _(change the path to the database with the `DB_PATH` env variable, e.g. `$ DB_PATH=storage/analytics.db micro-analytics`)_
+By default, `micro-analytics` uses `flat-file-db`, a fast in-process flat file database, which makes for easy setup and backups.
 
 This works fine for side-project usage, but for a production application with bajillions of visitors you might want to use a real database with a _database adapter_. Install the necessary npm package (e.g. `micro-analytics-adapter-xyz`) and then specify the `DB_ADAPTER` environment variable: `$ DB_ADAPTER=xyz micro-analytics`
 

package.json

@@ -26,6 +26,7 @@
   "dependencies": {
     "flat-file-db": "^1.0.0",
     "micro": "6.1.0",
+    "micro-analytics-adapter-flat-file-db": "^1.0.3",
     "promise": "^7.1.1",
     "shelljs": "^0.7.6"
   },
@@ -41,5 +42,10 @@
   },
   "execMap": {
     "js": "micro"
+  },
+  "jest": {
+    "collectCoverageFrom": [
+      "src/**/*.js"
+    ]
   }
 }

src/db.js

@@ -1,22 +1,20 @@
 const promise = require('promise')
 
 let adapter
+const adapterName = `micro-analytics-adapter-${process.env.DB_ADAPTER || 'flat-file-db'}`
 
 const repeatCharacter = (char, n) => `${Array(n + 1).join(char)}`
 
-if (process.env.DB_ADAPTER) {
-  const adapterName = `micro-analytics-adapter-${process.env.DB_ADAPTER}`
-  try {
-    adapter = require(adapterName)
-  } catch (err) {
-    if (err.code === 'MODULE_NOT_FOUND') {
-      // Console.error a warning message, but normally exit the process to avoid printing ugly npm ERR lines and stack trace.
-      console.error(`\n${repeatCharacter(' ', 22)}⚠️ ERROR ⚠️\n${repeatCharacter('-', 55)}\nYou specified "${process.env.DB_ADAPTER}" as the DB_ADAPTER, but no package\ncalled "${adapterName}" was found.\n\nPlease make sure you spelled the name correctly and\nhave "npm install"ed the necessary adapter package!\n${repeatCharacter('-', 55)}\n`)
-      process.exit(0)
-    }
+try {
+  adapter = require(adapterName)
+} catch (err) {
+  if (err.code === 'MODULE_NOT_FOUND') {
+    // Console.error a warning message, but normally exit the process to avoid printing ugly npm ERR lines and stack trace.
+    console.error(`\n${repeatCharacter(' ', 22)}⚠️ ERROR ⚠️\n${repeatCharacter('-', 55)}\nYou specified "${process.env.DB_ADAPTER}" as the DB_ADAPTER, but no package\ncalled "${adapterName}" was found.\n\nPlease make sure you spelled the name correctly and\nhave "npm install"ed the necessary adapter package!\n${repeatCharacter('-', 55)}\n`)
+    process.exit(0)
+  } else {
+    throw err
   }
-} else {
-  adapter = require('./flat-file-adapter')
 }
 
 module.exports = {

tests/utils.js

@@ -1,4 +1,5 @@
 const micro = require('micro')
+const noop = () => {}
 
 // Mock the database
 const DB = () => {
@@ -16,6 +17,10 @@ const DB = () => {
       },
       has: (key) => ({}.hasOwnProperty.call(data, key)),
       keys: () => Object.keys(data),
+      del: noop,
+      clear: noop,
+      close: noop,
+      on: noop,
     }),
 
     // Custom methods used in tests

writing-adapters.md

@@ -2,6 +2,8 @@
 
 `micro-analytics` database adapters are simple JavaScript modules which export an object with some methods. They _have_ to be called `micro-analytics-adapter-xyz`, where `xyz` is the name users will pass to the `DB_ADAPTER` environment variable when starting `micro-analytics`.
 
+If you want to see an example adapter, check out the default [`flat-file-db` adapter](https://github.com/mxstbr/micro-analytics-adapter-flat-file-db)!
+
 ## Overview
 
 The methods every adapter has to have are: