Merge branch 'release/v3.3.0'

Author: rhyslbw

.versions

@@ -18,13 +18,13 @@ [email protected]
 [email protected]
 [email protected]
 [email protected]
-fongandrew:[email protected].1
+fongandrew:[email protected].2
 [email protected]
 [email protected]
 [email protected]
 [email protected]
 [email protected]
-local-test:space:messaging@3.2.0
+local-test:space:messaging@3.3.0
 [email protected]
 [email protected]
 [email protected]
@@ -43,8 +43,8 @@ [email protected]
 [email protected]
 [email protected]
 [email protected]
-space:[email protected].2
-space:messaging@3.2.0
+space:[email protected].3
+space:messaging@3.3.0
 space:[email protected]
 space:[email protected]
 [email protected]

CHANGELOG.md

@@ -1,5 +1,40 @@
 Changelog
 =========
+## 3.3.0
+### New features
+- `Space.messaging.define` helper returns object with defined serializables which makes helper more usable when using ES6 module imports/exports.
+   Following implementation is now possible:
+   
+   ``` javascript
+   // Defining events:
+   export default Space.messaging.define(Space.domain.Event, {
+   
+     BankAccountOpened: {
+       owner: Contact,
+       balance: Money
+     },
+ 
+     BankAccountCredited: {
+       balance: Money
+     }
+     
+   });
+   ```
+ 
+   ``` javascript
+   // Importing and using events:
+   import events from '../events';
+   const { BankAccountOpened } = events;
+   
+   let event = new BankAccountOpened({
+     sourceId: new Guid()
+     // ...
+   });
+   
+ ```
+ 
+- New method `getHandledCommandTypes()` on `Space.messaging.CommandBus`
+
 ## 3.2.0
 ### New Features
 - `Space.messaging.Command` is now versionable, allowing older versions to be

package.js

@@ -1,7 +1,7 @@
 Package.describe({
   summary: 'Messaging infrastructure for Space applications.',
   name: 'space:messaging',
-  version: '3.2.0',
+  version: '3.3.0',
   git: 'https://github.com/meteor-space/messaging.git'
 });
 
@@ -15,8 +15,8 @@ Package.onUse(function(api) {
     'check',
     'ejson',
     'ecmascript',
-    'fongandrew:[email protected].1',
-    'space:[email protected].2'
+    'fongandrew:[email protected].2',
+    'space:[email protected].3'
   ]);
 
   // SHARED
@@ -39,7 +39,7 @@ Package.onUse(function(api) {
 
   // SHARED
   api.addFiles([
-    'source/helpers.coffee',
+    'source/helpers.js',
     'source/value-objects/guid.coffee',
     'source/serializables/event.js',
     'source/serializables/command.js',

source/command_bus.coffee

@@ -37,6 +37,8 @@ class Space.messaging.CommandBus extends Space.Object
 
   getHandlerFor: (commandType) -> @_handlers[commandType]
 
+  getHandledCommandTypes: -> commandType for commandType of @_handlers
+
   hasHandlerFor: (commandType) -> @getHandlerFor(commandType)?
 
   onSend: (handler) -> @_onSendCallbacks.push handler

source/helpers.coffee

@@ -0,0 +1,41 @@
+Space.messaging.define = (BaseType, ...options) => {
+
+  if (!BaseType.isSerializable) {
+    throw new Error('BaseType must extend Space.messaging.Serializable');
+  }
+
+  let namespace = null;
+  let definitions = null;
+  let subTypes = {};
+
+  switch (options.length) {
+  case 0:
+    throw new Error(`Space.messaging.define is missing options for defining sub typs of ${BaseType}.`);
+  case 1:
+    if (_.isObject(options[0])) {
+      // VALID: Definitions but no namespace provided
+      namespace = '';
+      definitions = options[0];
+    } else {
+      throw new Error(`Space.messaging.define is missing definitions for ${BaseType}.`);
+    }
+    break;
+  default:
+    // VALID: Namespace and definitions provided
+    namespace = options[0].toString();
+    definitions = options[1];
+    break;
+  }
+
+  _.each(definitions, (fields, className) => {
+    let classPath = className;
+    if (namespace !== '') classPath = `${namespace}.${className}`;
+    let SubType = BaseType.extend(classPath);
+    SubType.prototype.fields = () => _.extend(BaseType.prototype.fields(), fields);
+    Space.resolvePath(namespace)[className] = SubType;
+    subTypes[classPath] = SubType;
+  });
+
+  return subTypes;
+
+};

source/helpers.js

@@ -24,6 +24,13 @@ describe 'Space.messaging.CommandBus', ->
       registerTwice = => @commandBus.registerHandler TestCommand, second
       expect(registerTwice).to.throw Error
 
+    it 'can provide the types of commands it can handle', ->
+      handler = ->
+      @commandBus.registerHandler TestCommand, handler
+      expect(@commandBus.getHandledCommandTypes()).to.deep.equal(
+        ['Space.messaging.CommandBusStubCommand']
+      )
+
     it 'allows handler registrations to be overridden', ->
       first = sinon.spy()
       second = sinon.spy()

tests/unit/command_bus.unit.coffee

@@ -26,6 +26,13 @@ describe 'Space.messaging.EventBus', ->
       expect(first).to.have.been.calledWith @testEvent
       expect(second).to.have.been.calledWith @testEvent
 
+    it 'can provide the types of events it can handle', ->
+      subscriber = ->
+      @eventBus.subscribeTo TestEvent, subscriber
+      expect(@eventBus.getHandledEventTypes()).to.deep.equal(
+        ['Space.messaging.__tests__.EventBusStubEvent']
+      )
+
   describe 'publishing events', ->
 
     it 'calls the subscription with the event', ->

tests/unit/event_bus.unit.coffee

@@ -18,3 +18,19 @@ describe("Space.messaging.define", function() {
   });
 
 });
+
+describe("Space.messaging.define", function() {
+
+  beforeEach(function() {
+    this.definedSerializables = Space.messaging.define(Space.messaging.Event, {
+      FirstEvent: {},
+      SecondEvent: {}
+    });
+  });
+
+  it("returns object with defined serializables", function() {
+    expect(this.definedSerializables.FirstEvent).to.extend(Space.messaging.Event);
+    expect(this.definedSerializables.SecondEvent).to.extend(Space.messaging.Event);
+  });
+
+});