Merge pull request noflo#8 from djdeath/new-port-api

New port api
paulyoung · May 9, 2014 · 52c786b · 52c786b
2 parents 3c254fb + ccd80de
commit 52c786b
Show file tree

Hide file tree

Showing 30 changed files with 322 additions and 163 deletions.
diff --git a/components/CallMethod.coffee b/components/CallMethod.coffee
@@ -9,13 +9,22 @@ class CallMethod extends noflo.Component
     @method = null
     @args   = []
 
-    @inPorts =
-      in: new noflo.Port 'object'
-      method: new noflo.Port 'string'
-      arguments: new noflo.Port 'all'
-    @outPorts =
-      out: new noflo.Port 'all'
-      error: new noflo.Port 'string'
+    @inPorts = new noflo.InPorts
+      in:
+        datatype: 'object'
+        description: 'Object on which a method will be called'
+      method:
+        datatype: 'string'
+        description: 'Name of the method to call'
+      arguments:
+        datatype: 'all'
+        description: 'Arguments given to the method (one argument per IP)'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'all'
+        description: 'Value returned by the method call'
+      error:
+        datatype: 'object'
 
     @inPorts.in.on 'begingroup', (group) =>
       @outPorts.out.beginGroup group
@@ -42,7 +51,7 @@ class CallMethod extends noflo.Component
 
     @inPorts.arguments.on 'connect', =>
       @args = []
-    
+
     @inPorts.arguments.on 'data', (data) =>
       @args.push data
 

diff --git a/components/CreateDate.coffee b/components/CreateDate.coffee
@@ -4,10 +4,14 @@ class CreateDate extends noflo.Component
   description: 'Create a new Date object from string'
   icon: 'clock-o'
   constructor: ->
-    @inPorts =
-      in: new noflo.Port 'string'
-    @outPorts =
-      out: new noflo.Port 'object'
+    @inPorts = new noflo.InPorts
+      in:
+        datatype: 'string'
+        description: 'A string representation of a date in RFC2822/IETF/ISO8601 format'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'object'
+        description: 'A new Date object'
 
     @inPorts.in.on 'begingroup', (group) =>
       @outPorts.out.beginGroup group

diff --git a/components/CreateObject.coffee b/components/CreateObject.coffee
@@ -2,10 +2,14 @@ noflo = require 'noflo'
 
 class CreateObject extends noflo.Component
   constructor: ->
-    @inPorts =
-      start: new noflo.Port 'bang'
-    @outPorts =
-      out: new noflo.Port 'object'
+    @inPorts = new noflo.InPorts
+      start:
+        datatype: 'bang'
+        description: 'Signal to create a new object'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'object'
+        description: 'A new empty object'
 
     @inPorts.start.on 'begingroup', (group) =>
       @outPorts.out.beginGroup group

diff --git a/components/DuplicateProperty.coffee b/components/DuplicateProperty.coffee
@@ -5,12 +5,16 @@ class DuplicateProperty extends noflo.Component
     @properties = {}
     @separator = '/'
 
-    @inPorts =
-      property: new noflo.ArrayPort()
-      separator: new noflo.Port()
-      in: new noflo.Port()
-    @outPorts =
-      out: new noflo.Port()
+    @inPorts = new noflo.InPorts
+      property:
+        datatype: 'all'
+      separator:
+        datatype: 'string'
+      in:
+        datatype: 'object'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'object'
 
     @inPorts.property.on 'data', (data) =>
       @setProperty data
@@ -35,7 +39,7 @@ class DuplicateProperty extends noflo.Component
     if propParts.length > 2
       @properties[propParts.pop()] = propParts
       return
-    
+
     @properties[propParts[1]] = propParts[0]
 
   addProperties: (object) ->

diff --git a/components/Extend.coffee b/components/Extend.coffee
@@ -12,13 +12,23 @@ class Extend extends noflo.Component
     @key = null
     @reverse = false
 
-    @inPorts =
-      in: new noflo.Port
-      base: new noflo.Port
-      key: new noflo.Port
-      reverse: new noflo.Port
-    @outPorts =
-      out: new noflo.Port
+    @inPorts = new noflo.InPorts
+      in:
+        datatype: 'object'
+        description: 'Object to extend'
+      base:
+        datatype: 'object'
+        description: 'Objects to extend with (one object per IP)'
+      key:
+        datatype: 'string'
+        description: 'Property name to extend with'
+      reverse:
+        datatype: 'string'
+        description: 'A string equal "true" if you want to reverse the order of extension algorithm'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'object'
+        description: 'The object received on port "in" extended'
 
     @inPorts.base.on "connect", =>
       @bases = []

diff --git a/components/ExtractProperty.coffee b/components/ExtractProperty.coffee
@@ -7,11 +7,17 @@ class ExtractProperty extends noflo.Component
   in the incoming object"
 
   constructor: ->
-    @inPorts =
-      in: new noflo.Port
-      key: new noflo.Port
-    @outPorts =
-      out: new noflo.Port
+    @inPorts = new noflo.InPorts
+      in:
+        datatype: 'object'
+        description: 'An object to extract property from'
+      key:
+        datatype: 'string'
+        description: 'Property names to extract (one property per IP)'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'all'
+        description: 'Values of the property extracted (each value sent as a separate IP)'
 
     @inPorts.key.on "connect", =>
       @keys = []

diff --git a/components/FilterProperty.coffee b/components/FilterProperty.coffee
@@ -21,16 +21,27 @@ class FilterProperty extends noflo.Component
     @accepts = []
     @regexps = []
 
-    @inPorts =
-      in: new noflo.Port
-      key: new noflo.Port
-      recurse: new noflo.Port
-      keep: new noflo.Port
+    @inPorts = new noflo.InPorts
+      in:
+        datatype: 'object'
+        description: 'Object to filter properties from'
+      key:
+        datatype: 'string'
+        description: 'Keys to filter (one key per IP)'
+      recurse:
+        datatype: 'string'
+        description: '"true" to recurse on the object\'s values'
+      keep:
+        datatype: 'string'
+        description: '"true" if matching properties must be kept, otherwise removed'
       # Legacy mode
-      accept: new noflo.ArrayPort
-      regexp: new noflo.ArrayPort
-    @outPorts =
-      out: new noflo.Port
+      accept:
+        datatype: 'all'
+      regexp:
+        datatype: 'all'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'object'
 
     @inPorts.keep.on "data", (keep) =>
       @keep = true if keep is "true"

diff --git a/components/FilterPropertyValue.coffee b/components/FilterPropertyValue.coffee
@@ -6,13 +6,23 @@ class FilterPropertyValue extends noflo.Component
     @accepts = {}
     @regexps = {}
 
-    @inPorts =
-      accept: new noflo.ArrayPort 'all'
-      regexp: new noflo.ArrayPort 'string'
-      in: new noflo.Port 'object'
-    @outPorts =
-      out: new noflo.Port 'object'
-      missed: new noflo.Port 'object'
+    @inPorts = new noflo.InPorts
+      accept:
+        datatype: 'all'
+        description: ''
+      regexp:
+        datatype: 'string'
+        description: ''
+      in:
+        datatype: 'object'
+        description: 'Object to filter properties from'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'object'
+        description: 'Object including the filtered properties'
+      missed:
+        datatype: 'object'
+        description: 'Object received as input if no key have been matched'
 
     @inPorts.accept.on 'data', (data) =>
       @prepareAccept data

diff --git a/components/FlattenObject.coffee b/components/FlattenObject.coffee
@@ -3,11 +3,15 @@ noflo = require 'noflo'
 class FlattenObject extends noflo.Component
   constructor: ->
     @map = {}
-    @inPorts =
-      map: new noflo.ArrayPort()
-      in: new noflo.Port()
-    @outPorts =
-       out: new noflo.Port()
+    @inPorts = new noflo.InPorts
+      map:
+        datatype: 'all'
+      in:
+        datatype: 'object'
+        description: 'Object to flatten'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'array'
 
     @inPorts.map.on 'data', (data) =>
       @prepareMap data

diff --git a/components/GetObjectKey.coffee b/components/GetObjectKey.coffee
@@ -7,14 +7,26 @@ class GetObjectKey extends noflo.Component
     @data = []
     @key = []
 
-    @inPorts =
-      in: new noflo.Port 'object'
-      key: new noflo.ArrayPort 'string'
-      sendgroup: new noflo.Port 'boolean'
-    @outPorts =
-      out: new noflo.Port 'all'
-      object: new noflo.Port 'object'
-      missed: new noflo.Port 'object'
+    @inPorts = new noflo.InPorts
+      in:
+        datatype: 'object'
+        description: 'Object to get keys from'
+      key:
+        datatype: 'string'
+        description: 'Keys to extract from the object (one key per IP)'
+      sendgroup:
+        datatype: 'boolean'
+        description: 'true to send keys as groups around value IPs, false otherwise'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'all'
+        description: 'Values extracts from the input object given the input keys (one value per IP, potentially grouped using the key names)'
+      object:
+        datatype: 'object'
+        description: 'Object forwarded from input if at least one property matches the input keys'
+      missed:
+        datatype: 'object'
+        description: 'Object forwarded from input if no property matches the input keys'
 
     @inPorts.in.on 'connect', =>
       @data = []
@@ -30,7 +42,7 @@ class GetObjectKey extends noflo.Component
         # Data already sent
         @outPorts.out.disconnect()
         return
-      
+
       # No key, data will be sent when we get it
       return unless @key.length
 

diff --git a/components/InsertProperty.coffee b/components/InsertProperty.coffee
@@ -8,11 +8,17 @@ class InsertProperty extends noflo.Component
   constructor: ->
     @properties = {}
 
-    @inPorts =
-      in: new noflo.Port
-      property: new noflo.Port
-    @outPorts =
-      out: new noflo.Port
+    @inPorts = new noflo.InPorts
+      in:
+        datatype: 'object'
+        description: 'Object to insert property into'
+      property:
+        datatype: 'all'
+        description: 'Property to insert (property sent as group, value sent as IP)'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'object'
+        description: 'Object received as input with added properties'
 
     @inPorts.property.on "connect", =>
       @properties = {}

diff --git a/components/Join.coffee b/components/Join.coffee
@@ -9,11 +9,17 @@ class Join extends noflo.Component
   constructor: ->
     @delimiter = ","
 
-    @inPorts =
-      in: new noflo.Port
-      delimiter: new noflo.Port
-    @outPorts =
-      out: new noflo.Port
+    @inPorts = new noflo.InPorts
+      in:
+        datatype: 'object'
+        description: 'Object to join values from'
+      delimiter:
+        datatype: 'string'
+        description: 'Delimiter to join values'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'string'
+        description: 'String conversion of all values joined with delimiter into one string'
 
     @inPorts.delimiter.on "data", (@delimiter) =>
 

diff --git a/components/Keys.coffee b/components/Keys.coffee
@@ -6,10 +6,14 @@ class Keys extends noflo.Component
   description: "gets only the keys of an object and forward them as an array"
 
   constructor: ->
-    @inPorts =
-      in: new noflo.Port 'object'
-    @outPorts =
-      out: new noflo.Port 'all'
+    @inPorts = new noflo.InPorts
+      in:
+        datatype: 'object'
+        description: 'Object to get keys from'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'string'
+        description: 'Keys from the incoming object (one per IP)'
 
     @inPorts.in.on "begingroup", (group) =>
       @outPorts.out.beginGroup(group)

diff --git a/components/MapProperty.coffee b/components/MapProperty.coffee
@@ -5,12 +5,16 @@ class MapProperty extends noflo.Component
     @map = {}
     @regexps = {}
 
-    @inPorts =
-      map: new noflo.ArrayPort()
-      regexp: new noflo.ArrayPort()
-      in: new noflo.Port()
-    @outPorts =
-      out: new noflo.Port()
+    @inPorts = new noflo.InPorts
+      map:
+        datatype: 'all'
+      regexp:
+        datatype: 'string'
+      in:
+        datatype: 'object'
+    @outPorts = new noflo.OutPorts
+      out:
+        datatype: 'object'
 
     @inPorts.map.on 'data', (data) =>
       @prepareMap data