chai-backbone-rails 0.3.1 → 0.4.0

data/.gitmodules

@@ -0,0 +1,9 @@
+[submodule "chai-backbone"]
+	path = chai-backbone
+	url = git://github.com/matthijsgroen/chai-backbone.git
+[submodule "chai-changes"]
+	path = chai-changes
+	url = git://github.com/matthijsgroen/chai-changes.git
+[submodule "js-factories"]
+	path = js-factories
+	url = git://github.com/matthijsgroen/js-factories.git

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
+gem 'rake'
 # Specify your gem's dependencies in chai-backbone-rails.gemspec
 gemspec

data/README.md

@@ -1,9 +1,8 @@
-Backbone::Chai
-==============
+Chai-Backbone-Rails
+===================
 
-- Adds Chai matchers for common backbone assertions
 - Adds Chai matchers to assert changes
-- Adds Chai matchers for common sinon assertions
+- Adds Chai matchers for common backbone assertions
 - Adds support for Factories
 
 Installation
@@ -21,69 +20,50 @@ Or install it yourself as:
 
     $ gem install chai-backbone-rails
 
-Using Backbone Chai Matchers
-----------------------------
+Dependencies
+------------
 
-    #= require chai-backbone
+The provided libraries have dependencies to
+[backbone](http://documentcloud.github.com/backbone/),
+[underscore](http://documentcloud.github.com/underscore/) and
+[sinon](http://sinonjs.org/)
 
-### Triggers
+to install these dependencies, you can add the following to your
+`Gemfile`:
 
-    model.should.trigger("change", with: [model]).when -> model.set attribute: "value"
+    gem 'sinonjs-rails'
+    gem 'rails-backbone'
 
-this can also be chained further:
+and in your `spec_helper`:
 
-    model.should.trigger("change").and.trigger("change:attribute").when -> model.set attribute: "value"
-    model.should.trigger("change").and.not.trigger("reset").when -> model.set attribute: "value"
+    #= require sinon/sinon-1.5.0
+    #= require underscore
+    #= require backbone
+    #= require chai-backbone-rails
 
-### Routing
+to run all specs of the libraries:
 
-    "page/3".should.route.to myRouter, "openPage", arguments: ["3"]
-    "page/3".should.route.to myRouter, "openPage", considering: [conflictingRouter]
+    #= require chai-backbone-rails-spec
 
 Using Changes Chai matchers
 ---------------------------
 
     #= require chai-changes
 
-Plain change checking:
-
-    expect(-> result).to.change.when -> result += 1
-    expect(-> result).to.not.change.when -> somethingElse()
-
-Changes by delta: 'change.by'
-
-    expect(-> view.$('p').length).to.change.by(4).when -> collection.add [{}, {}, {}, {}]
-
-Changes to end result: 'change.to'
-
-    result = ['a']
-    expect(-> result).to.change.to(['b']).when -> result = ['b']
-
-Changes from begin result: 'change.from'
+See [the Chai-changes plugin page](http://chaijs.com/plugins/chai-changes)
 
-    result = ['a']
-    expect(-> result).to.change.from(['a']).when -> result = ['b']
+or [the Node.js package page](https://npmjs.org/package/chai-changes)
 
-Mix and match:
 
-    result = 3
-    expect(-> result).to.change.from(3).to(5).by(2).when -> result = 5
-
-
-Using Sinon Chai Matchers
--------------------------
+Using Backbone Chai Matchers
+----------------------------
 
-Matchers have also been added for sinonjs.
+    #= require chai-backbone
 
-    #= require chai-sinon
+See [the Chai-backbone plugin page](http://chaijs.com/plugins/chai-backbone)
 
-These are not complete yet, see tests and code for details.
+or [the Node.js package page](https://npmjs.org/package/chai-backbone)
 
-    spy.should.have.been.called.exactly(x).times
-    spy.should.have.been.called.before otherSpy
-    spy.should.have.been.called.after otherSpy
-    spy.should.have.been.called.with "argument1", 2, "argument3"
-    spy.should.not.have.been.called
 
 Using Factories
 ---------------
@@ -93,98 +73,34 @@ other objects as you see fit:
 
     #= require factories
 
-    Factory.define 'user', (attributes = {}) ->
-      new User attributes
-
-    Factory.create 'user', name: 'Matthijs'
-
-### Traits
-
-you can also use 'traits'.
-Traits are flags that are set when the user calls create with the
-factory name prefixed with terms separated by dashes.
-
-Like: 'female-admin-user'
-
-This will call the 'user' factory, and provide the terms 'female' and
-'admin' as traits for this user
-
-this list is accessible in the factory callback using `this.traits`
+See [the Node.js package page](https://npmjs.org/package/js-factories)
 
-There are 2 helper methods to help check if traits are set:
-
-    this.trait('returns', 'one', 'of', 'these', 'values')
-
-and
-
-    this.is('admin') # returns a boolean value
-
-Extended example:
-
-    Factory.define 'user', (attributes = {}) ->
-      attributes.gender = @trait('male', 'female') || 'male'
-
-      returningClass = User
-      if @is('admin')
-        returningClass = AdminUser
-
-      new returningClass attributes
-
-    Factory.create 'user', name: 'Matthijs' # => new User name: 'Matthijs'
-    Factory.create 'male-user', name: 'Matthijs' # => new User name: 'Matthijs', gender: 'male'
-    Factory.create 'male-admin-user', name: 'Matthijs' # => new AdminUser name: 'Matthijs', gender: 'male'
-    Factory.create 'female-user', name: 'Beppie' # => new User name: 'Beppie', gender: 'female'
-
-### Sequences
-
-Sequences are also supported:
-
-    Factory.define 'counter', ->
-      {
-        amount: @sequence('amount')
-        other: @sequence('other')
-      }
-
-This does not conflict with similar names in other factory definitions.
-
-You can also yield results:
-
-    Factory.define 'abc', ->
-      @sequence (i) -> ['a','b','c'][i]
-
-    # results in:
-    Factory.create('abc') => 'a'
-    Factory.create('abc') => 'b'
-
-### Sampling
-
-You can sample a value from a list
-
-    Factory.define 'sampler', ->
-      @sample 'a', 'b', 'c'
-
-Will randomly return a, b or c every time
 
 Running the tests
 =================
 
-You can runn the tests by including:
+You can run the tests by including:
 
     #= require chai-backbone_spec
 
 or you can run the suites seperately:
 
     #= require spec/chai-backbone_spec
-    #= require spec/chai-sinon_spec
     #= require spec/chai-changes_spec
     #= require spec/factory_spec
 
 
 Contributing
-------------
+============
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+Todo
+----
+
+- Add a rake task to update dependencies
+

data/USAGE-CHANGES.md

@@ -0,0 +1,74 @@
+chai-changes
+============
+
+chai-changes is an extension to the [chai](http://chaijs.com/) assertion library that
+provides a set of change-specific assertions.
+
+Usage
+-----
+
+Include `chai-changes.js` in your test file, after `chai.js` (version 1.0.0-rc1 or later):
+
+    <script src="chai-changes.js"></script>
+
+Use the assertions with chai's `expect` or `should` assertions.
+
+Assertions
+----------
+
+All assertions use a `when` mechanism. 
+
+
+Using 'expect':
+
+    expect(-> codeThatYieldsAChangedResult).to....when ->
+      executeTheCodeThatCausesTheChange()
+
+The code within the `expect` section will be executed first, then the
+code in the `when` section will be executed and then the code in the
+`expect` section will be executed again and the differences will be
+asserted.
+
+Same test using 'should':
+
+    (-> codeThatYieldsAChangedResult).should....when ->
+      executeTheCodeThatCausesTheChange()
+
+### `change`
+
+Assert if the 'expect/should' changes its outcome when 'when' is
+executed
+
+    result = 0
+    (-> result).should.change.when -> result += 1
+    expect(-> result).to.change.when -> result -= 1
+    expect(-> result).not.to.change.when -> result = result * 1
+
+### `change.by(delta)`
+
+Assert if the change of the 'expect/should' has the provided delta
+
+    result = 0
+    (-> result).should.change.by(3).when -> result += 3
+    expect(-> result).not.to.change.by(-3).when -> result += 1
+    expect(-> result).to.change.by(-2).when -> result -= 2
+
+### `change.from(startValue)`
+
+Assert if the change starts from a certain value. The value is
+compared using a deep equal.
+
+    result = ['a', 'b']
+    (-> result).should.change.from(['a', 'b']).when -> result.push('c')
+    (-> result).should.change.from(['a', 'b']).to(['a', 'b', 'c']).when -> result.push('c')
+
+### `change.to(endValue)`
+
+Assert if the change ends in a certain value. The value is
+compared using a deep equal.
+
+    result = ['a', 'b']
+    (-> result).should.change.to(['a', 'b', 'c']).when -> result.push('c')
+    (-> result).should.change.from(['a', 'b']).to(['a', 'c']).when -> result = ['a', 'c']
+
+

data/lib/assets/javascripts/chai-backbone-rails-spec.js.coffee

@@ -0,0 +1,3 @@
+#= require spec/chai-backbone_spec
+#= require spec/chai-changes_spec
+#= require spec/factory_spec

data/lib/assets/javascripts/chai-backbone-rails.js.coffee

@@ -0,0 +1,3 @@
+#= require chai-changes
+#= require chai-backbone
+#= require factories

data/lib/chai-backbone-rails/version.rb

@@ -1,7 +1,7 @@
 module Chai
   module Backbone
     module Rails
-      VERSION = "0.3.1"
+      VERSION = "0.4.0"
     end
   end
 end

data/vendor/assets/javascripts/chai-backbone.js.coffee

@@ -1,5 +1,3 @@
-#= require underscore
-#= require ./chai-changes
 
 ((chaiBackbone) ->
   # Module systems magic dance.
@@ -116,5 +114,26 @@
       else
         _super.apply(this, arguments)
 
+  chai.Assertion.addMethod 'call', (methodName) ->
+    object = flag(this, 'object')
+    definedActions = flag(this, 'whenActions') || []
+    definedActions.push
+      negate: flag(this, 'negate')
+      before: (context) ->
+        @originalMethod = object[methodName]
+        @spy = sinon.spy()
+        object[methodName] = @spy
+        object.delegateEvents?()
+      after: (context) ->
+        object[methodName] = @originalMethod
+        object.delegateEvents?()
+
+        context.assert @spy.callCount > 0,
+          @spy.printf("expected %n to have been called at least once"),
+          @spy.printf("expected %n to not have been called")
+
+    flag(this, 'whenActions', definedActions)
+
 )
 
+

data/vendor/assets/javascripts/chai-changes.js.coffee

@@ -53,11 +53,9 @@
     endValue = object()
     actualDelta = endValue - startValue
 
-    result = (@expectedDelta is actualDelta)
-    result = !result if negate
-    context.assert result,
+    context.assert (@expectedDelta is actualDelta),
       "expected `#{formatFunction object}` to change by #{@expectedDelta}, but it changed by #{actualDelta}",
-      "not supported"
+      "expected `#{formatFunction object}` not to change by #{@expectedDelta}, but it did"
     flag(context, 'negate', negate)
 
   changeToBeginAssert = (context) ->
@@ -82,10 +80,9 @@
     endValue = object()
 
     result = utils.eql(endValue, @expectedEndValue)
-    result = !result if negate
     context.assert result,
       "expected `#{formatFunction object}` to change to #{utils.inspect @expectedEndValue}, but it changed to #{utils.inspect endValue}",
-      "not supported"
+      "expected `#{formatFunction object}` not to change to #{utils.inspect @expectedEndValue}, but it did"
     flag(context, 'negate', negate)
 
   changeFromBeginAssert = (context) ->
@@ -96,10 +93,9 @@
     startValue = object()
 
     result = utils.eql(startValue, @expectedStartValue)
-    result = !result if negate
     context.assert result,
-      "expected `#{formatFunction object}` to change from #{utils.inspect @expectedStartValue}, but it changed from #{utils.inspect startValue}",
-      "not supported"
+      "expected the change of `#{formatFunction object}` to start from #{utils.inspect @expectedStartValue}, but it started from #{utils.inspect startValue}",
+      "expected the change of `#{formatFunction object}` not to start from #{utils.inspect @expectedStartValue}, but it did",
     flag(context, 'negate', negate)
 
   changeFromAssert = (context) ->
@@ -181,3 +177,4 @@
 
 )
 
+

data/vendor/assets/javascripts/factories.js.coffee

@@ -1,3 +1,4 @@
+
 sequencer = (property) ->
   value = if @sequences[property]?
     @sequences[property] += 1
@@ -49,3 +50,4 @@ window.Factory =
 
 
 
+

data/vendor/assets/javascripts/spec/chai-backbone_spec.js.coffee

@@ -1,4 +1,3 @@
-#= require ./../chai-backbone
 
 describe 'Chai-Backbone', ->
 
@@ -49,3 +48,31 @@ describe 'Chai-Backbone', ->
     it 'leaves the `to` keyword working properly', ->
       expect('1').to.be.equal '1'
 
+  describe 'call', ->
+
+    it 'asserts if a method on provided object is called', ->
+      obj =
+        method: ->
+
+      obj.should.call('method').when ->
+        obj.method()
+
+    it 'raises AssertionError if method was not called', ->
+      obj =
+        method: ->
+      expect(->
+        obj.should.call('method').when ->
+          "noop"
+      ).to.throw /been called/
+
+   if Backbone? and jQuery?
+     it 'can check event calls of Backbone.Views', ->
+       viewClass = class extends Backbone.View
+         events:
+           'click': 'eventCall'
+         eventCall: ->
+
+       viewInstance = new viewClass
+       viewInstance.should.call('eventCall').when ->
+         viewInstance.$el.trigger('click')
+