Merge pull request #6 from laurilehmijoki/containerOf

Add "containerOf" matcher

Author: jliuhtonen

README.md

@@ -14,20 +14,20 @@ You can also filter using `.where()`
 And there's negation
 
     age.is().not().greaterThan(18)
-    
+
 You can compare to either constant values or other Observables. Like
 
     // Returns a Property of Booleans
-    var collision = playerPos.is().equalTo(monsterPos)    
-    
+    var collision = playerPos.is().equalTo(monsterPos)
+
 Complete examples:
 
     Bacon.fromArray([1,2,3]).is().equalTo(2)
-    
+
     => false, true, false
-    
+
     Bacon.fromArray([1,2,3]).where().equalTo(2)
-    
+
     => 2
 
 ## Additions to Observable API
@@ -58,6 +58,23 @@ Complete examples:
 
 `not()` returns a negated `Matchers` object
 
+`containerOf(x)` supports arrays, strings and object key-values. Examples:
+
+```javascript
+stream = Bacon.once([6]).is().containerOf(6) // is true
+
+Bacon.once('hello bacon').is().containerOf('bacon') // is true
+
+Bacon.once({
+  alien: 'morninglightmountain'
+  human: 'dudleybose'
+}).is().containerOf({ alien: 'morninglightmountain' }) // is true
+```
+
+## Browser support
+
+IE 9 and above.
+
 ## Download / Install
 
 - Download [javascript file](https://raw.github.com/raimohanska/bacon.matchers/master/bacon.matchers.js)

bacon.matchers.coffee

@@ -37,6 +37,21 @@ init = (Bacon) ->
     context["inClosedRange"] = apply3((val, a, b) ->
       a <= val <= b
     )
+    context["containerOf"] = apply2((a, b) ->
+      if a instanceof Array or typeof a == 'string'
+        a.indexOf(b) >= 0
+      else if typeof a == 'object'
+        matchingKeyValuePairs = 0
+        Object.keys(b).forEach (bKey) -> # Object.keys works in IE9 and above
+          aHasBKeyAndValue = a.hasOwnProperty(bKey) and a[bKey] == b[bKey]
+          if aHasBKeyAndValue
+            matchingKeyValuePairs += 1
+        aHasAllKeyValuesOfB = matchingKeyValuePairs == Object.keys(b).length
+        bIsNotEmpty = Object.keys(b).length > 0
+        aHasAllKeyValuesOfB and bIsNotEmpty
+      else
+        false
+    )
     context
   Bacon.Observable::is = ->
     apply1 = (f) ->

bacon.matchers.js

@@ -1 +1,6 @@
+#!/bin/bash -e
+
+echo "Building ..."
+bash build
+echo "Running tests ..."
 node_modules/mocha/bin/mocha --require coffee-script --compilers coffee:coffee-script/register spec/bacon.matchers.spec.coffee

run-tests

@@ -1,5 +1,5 @@
 assert = require("assert")
-Bacon = require("../bacon.matchers")
+Bacon = require("../bacon.matchers.js") # Test the result of the build
 
 assertConstantly = (expectedValue, stream, done) ->
   stream.onValue (val) -> assert.equal expectedValue, val
@@ -75,4 +75,64 @@ describe 'bacon.matchers', ->
       it 'should return false with values not within range', (done) ->
         stream = Bacon.fromArray([6,20]).is().inClosedRange(7, 19)
         assertConstantly false, stream, done
-
+    describe 'containerOf', ->
+      context 'value is an array', ->
+        it 'should return true when the array contains the element', (done) ->
+          stream = Bacon.once([6]).is().containerOf(6)
+          assertConstantly true, stream, done
+        it 'should return false when the array does not contain the element', (done) ->
+          stream = Bacon.once([66]).is().containerOf(6)
+          assertConstantly false, stream, done
+      context 'value is a string', ->
+        it 'should return true when the string contains the sub-string', (done) ->
+          stream = Bacon.once('hello bacon').is().containerOf('bacon')
+          assertConstantly true, stream, done
+        it 'should return false when the string does not contain the sub-string', (done) ->
+          stream = Bacon.once('hello bacon').is().containerOf('Bacon')
+          assertConstantly false, stream, done
+      context 'value is an object', ->
+        it 'should return true when the object contains the key-value pair', (done) ->
+          stream = Bacon.once({
+            alien: 'morninglightmountain'
+            human: 'dudleybose'
+          }).is().containerOf({alien: 'morninglightmountain'})
+          assertConstantly true, stream, done
+        it 'should return true when comparing equal objects', (done) ->
+          object =
+            alien: 'morninglightmountain'
+          stream = Bacon.once(object).is().containerOf(object)
+          assertConstantly true, stream, done
+        it 'should return false when key matches but value does not', (done) ->
+          stream = Bacon.once(
+            alien: 'morninglightmountain'
+          ).is().containerOf(alien: 't1000')
+          assertConstantly false, stream, done
+        it 'should return false when the object contains a subset of the compared value', (done) ->
+          stream = Bacon.once(
+            alien: 'morninglightmountain'
+          ).is().containerOf(
+            alien: 'morninglightmountain'
+            human: 'dudleybose'
+          )
+          assertConstantly false, stream, done
+        it 'should return false when comparing a non-empty object to {}', (done) ->
+          stream = Bacon.once(
+            alien: 'morninglightmountain'
+          ).is().containerOf( {} )
+          assertConstantly false, stream, done
+        it 'should return false when comparing {} to {}', (done) ->
+          stream = Bacon.once( {} ).is().containerOf( {} )
+          assertConstantly false, stream, done
+      context 'value is a boolean', ->
+        it 'should always return false', (done) ->
+          stream = Bacon.once(false).is().containerOf(false)
+          assertConstantly false, stream, done
+      context 'value is a number', ->
+        it 'should always return false', (done) ->
+          stream = Bacon.once(1).is().containerOf(1)
+          assertConstantly false, stream, done
+      context 'value is a function', ->
+        it 'should always return false', (done) ->
+          fun = ->
+          stream = Bacon.once(fun).is().containerOf(fun)
+          assertConstantly false, stream, done