hubot 10.0.4 → 10.0.5

package/README.md

@@ -6,7 +6,9 @@
 
 # Hubot
 
-**Please note that in v11, CoffeeScript support was removed.**
+**Note: v10.0.4 contains the removal of CoffeeScript**
+
+Semver is looking for **BREAKING CHANGE** singular, not **BREAKING CHANGES**. As a result, the removal of CoffeeScript was marked as the `v10.0.4` release.
 
 Hubot is a framework to build chat bots, modeled after GitHub's Campfire bot of the same name, hubot.
 He's pretty cool. He's [extendable with scripts](https://hubotio.github.io/hubot/docs#scripts) and can work

package/bin/hubot

@@ -1,3 +1,9 @@
-#!/usr/bin/env node
+#!/usr/bin/env coffee
 
-require('./hubot.js')
+# While all other files have been converted to JavaScript via https://github.com/github/hubot/pull/1347,
+# we left the `bin/hubot` file to remain in CoffeeScript in order prevent
+# breaking existing 3rd party adapters of which some are still written in
+# CoffeeScript themselves. We will deprecate and eventually remove this file
+# in a future version of hubot
+
+require './hubot.js'

package/es2015.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const User = require('./src/user')
+const Brain = require('./src/brain')
+const Robot = require('./src/robot')
+const Adapter = require('./src/adapter')
+const Response = require('./src/response')
+const Listener = require('./src/listener')
+const Message = require('./src/message')
+const DataStore = require('./src/datastore')
+
+module.exports = {
+  User,
+  Brain,
+  Robot,
+  Adapter,
+  Response,
+  Listener: Listener.Listener,
+  TextListener: Listener.TextListener,
+  Message: Message.Message,
+  TextMessage: Message.TextMessage,
+  EnterMessage: Message.EnterMessage,
+  LeaveMessage: Message.LeaveMessage,
+  TopicMessage: Message.TopicMessage,
+  CatchAllMessage: Message.CatchAllMessage,
+  DataStore: DataStore.DataStore,
+  DataStoreUnavailable: DataStore.DataStoreUnavailable,
+  loadBot (adapter, enableHttpd, name, alias) {
+    return new module.exports.Robot(adapter, enableHttpd, name, alias)
+  }
+}

package/index.js

@@ -1,31 +1,40 @@
 'use strict'
+require('coffeescript/register')
 
-const User = require('./src/user')
-const Brain = require('./src/brain')
-const Robot = require('./src/robot')
-const Adapter = require('./src/adapter')
-const Response = require('./src/response')
-const Listener = require('./src/listener')
-const Message = require('./src/message')
-const DataStore = require('./src/datastore')
-
-module.exports = {
-  User,
-  Brain,
-  Robot,
-  Adapter,
-  Response,
-  Listener: Listener.Listener,
-  TextListener: Listener.TextListener,
-  Message: Message.Message,
-  TextMessage: Message.TextMessage,
-  EnterMessage: Message.EnterMessage,
-  LeaveMessage: Message.LeaveMessage,
-  TopicMessage: Message.TopicMessage,
-  CatchAllMessage: Message.CatchAllMessage,
-  DataStore: DataStore.DataStore,
-  DataStoreUnavailable: DataStore.DataStoreUnavailable,
-  loadBot (adapter, enableHttpd, name, alias) {
-    return new module.exports.Robot(adapter, enableHttpd, name, alias)
+const inherits = require('util').inherits
+
+const hubotExport = require('./es2015')
+
+// make all es2015 class declarations compatible with CoffeeScript’s extend
+// see https://github.com/hubotio/evolution/pull/4#issuecomment-306437501
+module.exports = Object.keys(hubotExport).reduce((map, current) => {
+  if (current !== 'loadBot') {
+    map[current] = makeClassCoffeeScriptCompatible(hubotExport[current])
+  } else {
+    map[current] = hubotExport[current]
+  }
+  return map
+}, {})
+
+function makeClassCoffeeScriptCompatible (klass) {
+  function CoffeeScriptCompatibleClass () {
+    const Hack = Function.prototype.bind.apply(klass, [null].concat([].slice.call(arguments)))
+    const instance = new Hack()
+
+    // pass methods from child to returned instance
+    for (const key in this) {
+      instance[key] = this[key]
+    }
+
+    // support for constructor methods which call super()
+    // in which this.* properties are set
+    for (const key in instance) {
+      this[key] = instance[key]
+    }
+
+    return instance
   }
+  inherits(CoffeeScriptCompatibleClass, klass)
+
+  return CoffeeScriptCompatibleClass
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hubot",
-  "version": "10.0.4",
+  "version": "10.0.5",
   "author": "hubot",
   "keywords": [
     "github",
@@ -15,6 +15,7 @@
     "url": "https://github.com/hubotio/hubot.git"
   },
   "dependencies": {
+    "coffeescript": "^2.7.0",
     "connect-multiparty": "^2.2.0",
     "express": "^4.18.2",
     "express-basic-auth": "^1.2.1",

package/src/robot.js

@@ -328,6 +328,10 @@ class Robot {
     }
   }
 
+  async loadcoffee (filePath) {
+    return await this.loadjs(filePath)
+  }
+
   async loadjs (filePath) {
     const script = require(filePath)
     if (typeof script === 'function') {
@@ -348,7 +352,7 @@ class Robot {
     const full = path.join(filepath, path.basename(filename))
 
     // see https://github.com/hubotio/hubot/issues/1355
-    if (['js', 'mjs'].indexOf(ext) === -1) {
+    if (['js', 'mjs', 'coffee'].indexOf(ext) === -1) {
       this.logger.debug(`Skipping unsupported file type ${full}`)
       return
     }
@@ -476,7 +480,7 @@ class Robot {
     try {
       if (Array.from(HUBOT_DEFAULT_ADAPTERS).indexOf(this.adapterName) > -1) {
         this.adapter = this.requireAdapterFrom(path.resolve(path.join(__dirname, 'adapters', this.adapterName)))
-      } else if (['.js', '.cjs'].includes(ext)) {
+      } else if (['.js', '.cjs', '.coffee'].includes(ext)) {
         this.adapter = this.requireAdapterFrom(path.resolve(adapterPath))
       } else if (['.mjs'].includes(ext)) {
         this.adapter = await this.importAdapterFrom(pathToFileURL(path.resolve(adapterPath)).href)