chai-backbone-rails 0.0.3 → 0.1.0

data/README.md

@@ -1,8 +1,12 @@
-# Backbone::Chai
+Backbone::Chai
+==============
 
-Some matchers to help testing backbone structures.
+- Adds Chai matchers for common backbone assertions
+- Adds Chai matchers for common sinon assertions
+- Adds support for Factories
 
-## Installation
+Installation
+------------
 
 Add this line to your application's Gemfile:
 
@@ -16,7 +20,8 @@ Or install it yourself as:
 
     $ gem install chai-backbone-rails
 
-## Usage
+Using Backbone Chai Matchers
+----------------------------
 
     #= require chai-backbone
 
@@ -34,9 +39,10 @@ this can also be chained further:
     "page/3".should.route.to myRouter, "openPage", arguments: ["3"]
     "page/3".should.route.to myRouter, "openPage", considering: [conflictingRouter]
 
-### Sinon
+Using Sinon Chai Matchers
+-------------------------
 
-Matchers have also been added for sinonjs. 
+Matchers have also been added for sinonjs.
 
     #= require chai-sinon
 
@@ -48,7 +54,35 @@ These are not complete yet, see tests and code for details.
     spy.should.have.been.called.with "argument1", 2, "argument3"
     spy.should.not.have.been.called
 
-## Contributing
+Using Factories
+--------------
+
+Factory support is added to quickly be able to build backbone models or
+other objects as you see fit:
+
+    Factory.define 'user', (attributes = {}) ->
+      new User attributes
+
+    Factory.create 'user', name: 'Matthijs'
+
+you can also use 'traits':
+
+    Factory.define 'user', (attributes = {}, traits...) ->
+      if traits.indexOf('male') isnt -1
+        attributes.gender = 'male'
+
+      returningClass = User
+      if traits.indexOf('admin') isnt -1
+        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'
+
+Contributing
+------------
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

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

@@ -1,7 +1,7 @@
 module Chai
   module Backbone
     module Rails
-      VERSION = "0.0.3"
+      VERSION = "0.1.0"
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: chai-backbone-rails
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Matthijs Groen