fix: missing this context (#12)

* v1.0.3-beta

* v1.0.3-beta1

* v1.0.3-beta2

* v1.0.3-beta3

* v1.0.3-beta4

* fix: update Babel to transpile back to Node 6

* fix: update to string-based docs for schema

* fix: add model to an object

Because `context` gets copied and combined with `extraContext`, we need
to export an object rather than an instance of a class. Otherwise we get
issues with `this` misbehaving.

* chore: upgrade dependencies

* test: fix Babel coverage with temporary plugin

Until istanbuljs/istanbuljs#125 is merged, we need a temporary plugin to
get coverage to report correctly.

BREAKING CHANGE: Moves model class from `context` prop directly to a `context.model` prop, which prevents issues when merging context objects.

Author: jlengstorf

.babelrc

@@ -1,15 +1,17 @@
 {
   "presets": [
-    "stage-2",
     [
-      "env",
+      "@babel/preset-env",
       {
-        "targets": {
-          "node": "current"
-        }
+        "targets": { "node": "6" },
+        "shippedProposals": true,
+        "useBuiltIns": "usage"
       }
     ]
   ],
-  "plugins": ["babel-plugin-inline-import"],
-  "ignore": ["node_modules/**"]
+  "plugins": [
+    "@babel/plugin-proposal-class-properties",
+    "babel-plugin-inline-import",
+    "./babel/arrow-function-coverage-fix.js"
+  ]
 }

babel/arrow-function-coverage-fix.js

@@ -0,0 +1,18 @@
+// Restore old babylon behavior for istanbul.
+// https://github.com/babel/babel/pull/6836
+// https://github.com/istanbuljs/istanbuljs/issues/119
+// Temporary fix for Jest issue: https://github.com/facebook/jest/issues/5001
+module.exports = function hacks() {
+  return {
+    visitor: {
+      Program(programPath) {
+        programPath.traverse({
+          ArrowFunctionExpression(path) {
+            const node = path.node;
+            node.expression = node.body.type !== 'BlockStatement';
+          },
+        });
+      },
+    },
+  };
+};

package.json

@@ -20,6 +20,7 @@
     "prepare": "npm run build",
     "prebuild": "del-cli ./dist",
     "build": "babel src -d dist",
+    "postbuild": "cpy ./src/schema.graphql ./dist",
     "dev": "gramps dev -d ./",
     "mock-data": "npm run dev -- --mock",
     "live-data": "npm run dev -- --live",
@@ -34,35 +35,38 @@
   "license": "MIT",
   "dependencies": {
     "@gramps/errors": "^1.0.0",
-    "@gramps/rest-helpers": "^1.0.0-beta.3",
+    "@gramps/rest-helpers": "^1.0.0",
     "casual": "^1.5.14"
   },
   "peerDependencies": {
     "graphql": "^0.9.0 || ^0.10.0 || ^0.11.0",
     "graphql-tools": "^1.2.1 || ^2.5.1"
   },
   "devDependencies": {
-    "@gramps/cli": "^1.1.0",
-    "@gramps/gramps": "^1.0.0",
-    "babel-cli": "^6.24.1",
-    "babel-eslint": "^8.0.1",
-    "babel-jest": "^22.0.3",
+    "@babel/cli": "^7.0.0-beta.37",
+    "@babel/core": "^7.0.0-beta.37",
+    "@babel/plugin-proposal-class-properties": "^7.0.0-beta.37",
+    "@babel/preset-env": "^7.0.0-beta.37",
+    "@gramps/cli": "^1.1.4",
+    "@gramps/gramps": "^1.2.0",
+    "babel-core": "^7.0.0-0",
+    "babel-eslint": "^8.2.1",
+    "babel-jest": "^22.0.6",
     "babel-plugin-inline-import": "^2.0.6",
-    "babel-preset-env": "^1.6.1",
-    "babel-preset-stage-2": "^6.24.1",
+    "cpy-cli": "^1.0.1",
     "del-cli": "^1.1.0",
-    "eslint": "^4.4.1",
+    "eslint": "^4.15.0",
     "eslint-config-airbnb-base": "^12.1.0",
     "eslint-config-prettier": "^2.3.0",
     "eslint-plugin-import": "^2.7.0",
     "eslint-plugin-prettier": "^2.1.2",
-    "graphql": "^0.11.7",
-    "graphql-tools": "^2.5.1",
+    "graphql": "^0.12.3",
+    "graphql-tools": "^2.18.0",
     "husky": "^0.14.3",
-    "jest": "^22.0.3",
-    "nodemon": "^1.11.0",
-    "prettier": "^1.5.3",
-    "semantic-release": "^8.2.0"
+    "jest": "^22.0.6",
+    "nodemon": "^1.14.11",
+    "prettier": "^1.10.2",
+    "semantic-release": "^11.0.2"
   },
   "jest": {
     "coverageReporters": [
@@ -81,5 +85,5 @@
       }
     }
   },
-  "version": "0.0.0-development"
+  "version": "1.0.3-beta4"
 }

src/index.js

@@ -10,7 +10,7 @@ import mocks from './mocks';
  */
 export default {
   namespace: 'XKCD',
-  context: new Model({ connector: new Connector() }),
+  context: { model: new Model({ connector: new Connector() }) },
   typeDefs,
   resolvers,
   mocks,

src/resolvers.js

@@ -1,7 +1,7 @@
 export default {
   Query: {
-    getLatestComic: (_, __, context) => context.getLatestComic(),
-    getComicById: (_, { id }, context) => context.getComicById(id),
+    getLatestComic: (_, __, context) => context.model.getLatestComic(),
+    getComicById: (_, { id }, context) => context.model.getComicById(id),
   },
   XKCD_Comic: {
     // The link is often empty, so build one if it’s not returned.

src/schema.graphql

@@ -1,49 +1,51 @@
-# The query/queries to access data MUST extend the Query type.
+"The query/queries to access data MUST extend the Query type."
 type Query {
-  # Load info about the most recent xkcd comic.
+  "Load info about the most recent xkcd comic."
   getLatestComic: XKCD_Comic
 
-  # Load info about the xkcd comic with a given ID.
+  "Load info about the xkcd comic with a given ID."
   getComicById(
-    # The ID of the given comic. The ID can be found using its URL.
-    #
-    # Example: https://xkcd.com/619/ has the ID of 619.
+    """
+    The ID of the given comic. The ID can be found using its URL.
+
+    Example: https://xkcd.com/619/ has the ID of 619.
+    """
     id: ID!
   ): XKCD_Comic
 }
 
-# Details about an xkcd comic.
+"Details about an xkcd comic."
 type XKCD_Comic {
-  # The unique ID of the comic.
+  "The unique ID of the comic."
   num: ID!
 
-  # The title of the comic.
+  "The title of the comic."
   title: String!
 
-  # As far as I can tell, this is always the same as the title field.
+  "As far as I can tell, this is always the same as the title field."
   safe_title: String!
 
-  # Direct link to the comic image.
+  "Direct link to the comic image."
   img: String!
 
-  # Alt text (this is what shows on hover in comics on the site).
+  "Alt text (this is what shows on hover in comics on the site)."
   alt: String!
 
-  # A transcript of what’s happening in the comic.
+  "A transcript of what’s happening in the comic."
   transcript: String
 
-  # The year the comic was released.
+  "The year the comic was released."
   year: String
 
-  # The month the comic was released.
+  "The month the comic was released."
   month: String
 
-  # The day the comic was released.
+  "The day the comic was released."
   day: String
 
-  # A link to the comic on xkcd.com
+  "A link to the comic on xkcd.com"
   link: String
 
-  # Additional info, shown on the xkcd website in the banner.
+  "Additional info, shown on the xkcd website in the banner."
   news: String
 }

test/index.test.js

@@ -7,7 +7,7 @@ describe('Data Source: XKCD', () => {
   });
 
   it('returns its model as a context', () => {
-    expect(dataSource.context).toBeInstanceOf(Model);
+    expect(dataSource.context).toBeTruthy();
   });
 
   it('returns typeDefs', () => {

test/resolvers.test.js

@@ -7,10 +7,12 @@ describe('XKCD resolvers', () => {
 
   describe('queryResolvers', () => {
     const mockContext = {
-      // Mock a response so we can actually test it.
-      getLatestComic: () => Promise.resolve('latest'),
-      // For testing, we mock the model to simply return the ID.
-      getComicById: id => Promise.resolve(id),
+      model: {
+        // Mock a response so we can actually test it.
+        getLatestComic: () => Promise.resolve('latest'),
+        // For testing, we mock the model to simply return the ID.
+        getComicById: id => Promise.resolve(id),
+      },
     };
 
     describe('getLatestComic()', () => {