visionmedia-jspec 1.1.7 → 2.0.0

data/History.rdoc

@@ -1,4 +1,23 @@
 
+=== 2.0.0 / 2009-04-27
+
+* Added DOM loading indicator [#105]
+* Added wait() helper for additional async support
+* Added shared behavior support using should_behave_like('Another Suite')
+* Added CSS body toggling [#1]
+* Added receive matcher for Proxy Assertins
+* Added grammar-less support
+* Added an_instance_of() helper
+* Removed .this literal
+* Removed deprecated be_a_TYPE_input matchers
+
+* Added ProxyAssertion 
+* Added select() util
+* Added does() util for report-less assertions
+* Added find() util 
+* Added JSpec.contentsOf()
+* Added matchers to body evaluation [#90]
+
 === 1.1.7 / 2009-04-22
 
 * Removed trailing commas causing issues with IE (what a suprise ;) )

data/Manifest

@@ -3,6 +3,7 @@ History.rdoc
 jspec.gemspec
 lib/images/bg.png
 lib/images/hr.png
+lib/images/loading.gif
 lib/images/sprites.bg.png
 lib/images/sprites.png
 lib/images/vr.png
@@ -17,12 +18,15 @@ server/server.rb
 spec/async
 spec/jquery-1.3.1.js
 spec/server.html
-spec/spec.core.dom.js
-spec/spec.core.js
+spec/spec.grammar-less.js
 spec/spec.grammar.js
 spec/spec.html
 spec/spec.jquery.js
+spec/spec.js
+spec/spec.matchers.js
 spec/spec.rhino.js
+spec/spec.shared-behaviors.js
+spec/spec.utils.js
 templates/default/History.rdoc
 templates/default/lib/yourlib.core.js
 templates/default/README.rdoc

data/README.rdoc

@@ -25,39 +25,10 @@ and much more.
 * DOM sandbox support
 * Great looking default DOM theme
 * `jspec` command-line utility for auto-running specs, and initializing project templates
+* Proxy or 'Spy' assertions 
+* Shared behaviors
 * Profiling
-* Tiny (15 kb compressed, 1000-ish LOC)
-
-== Features Coming Soon
-
-* 'Spy' or 'Proxy' assertions. person.should.receive('addPet').with('suki').and_return(['suki'])
-* Grammar-less option. Dislike JSpec's grammar? well we will soon have grammar-less support,
-  which in turn will make your specs look much like traditional JavaScript BDD frameworks:
-  expect(this).to('be_coming', 'soon')  
-
-== Example
-
-  describe 'ShoppingCart'
-    var cart
-  
-    before_each
-      cart = new ShoppingCart
-    end
-    
-    describe 'addProducts'
-      it 'should add several products'
-        cart.addProduct('cookie')
-        cart.addProduct('icecream')
-        cart.should.have 2, 'products'
-      end
-    end
-  
-    describe 'checkout'
-      it 'throw an error when checking out with no products'
-        -{ cart.clear().checkout() }.should.throw_error
-      end
-    end
-  end
+* Tiny (15 kb compressed, 1600-ish LOC)
 
 == Installation
 
@@ -91,6 +62,54 @@ You may optionally want to use sources in the /pkg directory
 for your project, since it includes compressed alternatives generated
 each release.
 
+== Example
+
+  describe 'ShoppingCart'
+    before_each
+      cart = new ShoppingCart
+    end
+    
+    describe 'addProducts'
+      it 'should add several products'
+        cart.addProduct('cookie')
+        cart.addProduct('icecream')
+        cart.should.have 2, 'products'
+      end
+    end
+  
+    describe 'checkout'
+      it 'should throw an error when checking out with no products'
+        -{ cart.clear().checkout() }.should.throw_error EmptyCart
+      end
+    end
+  end
+
+== Grammar-less Example
+
+JSpec's grammar is optional, you may also use the equivalent grammar-less
+alternative below using pure JavaScript (when using the JSpec grammar you
+may also use grammar-less assertions):
+
+  JSpec.describe('ShoppingCart', function(){
+    before_each(function{
+      cart = new ShoppingCart
+    })
+
+    describe('addProducts', function(){
+      it ('should add several products', function(){
+        cart.addProducts('cookie')
+        cart.addProducts('icecream')
+        expect(cart).to(have, 2, 'products')
+      })
+    })
+
+    describe('checkout', function(){
+      it ('should throw an error when checking out with no products', function(){
+        expect(function(){ cart.clear().checkout() }).to(throw_error, EmptyCart)
+      })
+    })
+  }) 
+
 == Options
 
 You may alter the way JSpec operates by assigning options via the
@@ -153,6 +172,7 @@ JSpec.options.failuresOnly = true, and ?failuresOnly=1 will both work.
   - have_target
   - have_value     
   - have_class
+  - have_classes
   - be_visible
   - be_hidden
   - be_enabled
@@ -160,11 +180,31 @@ JSpec.options.failuresOnly = true, and ?failuresOnly=1 will both work.
   - be_selected
   - be_checked
 
+== Proxy Assertions
+
+Proxy or 'Spy' assertions allow you to assert that a method is called n number
+of times, with x arguments, returning x value. For example:
+
+  person = { getPets : function(species){ return ['izzy'] }}
+  person.should.receive('getPets', 'twice').with_args(an_instance_of(String))and_return(['izzy'])
+  person.getPets('dog') // This will pass
+  person.getPets()      // This will fail because we asked an instance of String
+
+This is a useful mechanism for testing the behavior of your object, as well as
+how other methods may interact with it. Below is another example:
+
+  array = ['foo', 'bar']
+  array.should.receive('toString').and_return('foo,bar')
+  'array: ' + array // This line causes the spec to pass due to calling toString()
+
+For more examples view spec/spec.matchers.js
+
 == Helpers
 
   * Core
 
-  - sandbox     used to generate new DOM sandbox
+  - wait             delay execution of a spec for the duration set (async support)
+  - an_instance_of   used in conjunction with the 'receive' matcher
                 
   * jQuery      
                 
@@ -172,6 +212,51 @@ JSpec.options.failuresOnly = true, and ?failuresOnly=1 will both work.
   - element     same as invoking jQuery, just reads better and no need to worry about $ collisions
   - elements    alias of element
 
+== Shared Behaviors
+
+JSpec's support for shared behaviors allows multiple suites or describe blocks to share
+common functionality. For example an Admin, would inherit all specs of User:
+
+  describe 'User'
+    before
+      User = function(name) { this.name = name }
+      user = new User('joe')
+    end
+    
+    it 'should have a name'
+      user.should.have_property 'name'
+    end
+    
+    describe 'Administrator'
+      should_behave_like('User')
+  
+      before
+        Admin = function(name) { this.name = name }
+        Admin.prototype.may = function(perm){ return true }
+        user = new Admin('tj')
+      end
+  
+      it 'should have access to all permissions'
+        user.may('edit pages').should.be_true
+      end
+    end
+  end
+
+NOTE: both User and Administrator's before hooks implement the 'user' variable
+
+== Async Support Using wait()
+
+When using jQuery with JSpec all requests are switched to sync, allowing specs
+to run naturally, however when testing functionality using setTimeout, setInterval etc
+JSpec supplies the wait() utility to delay a spec from running:
+
+  it 'should wait for n milliseconds'
+    wait(2, 'seconds')
+    setTimeout(function(){
+      true.should.be true
+    }, 1500)
+  end
+
 == Hooks
 
 Currently the following hooks are supported, and may be utilized any number of times as they
@@ -188,10 +273,9 @@ scope, they will both run, but this can help keep your specs readable.
 Custom contexts can be applied to supply helper
 methods or properties to all subsequent bodies (other hooks, or specs).
 
-In most cases the default context will suffice, in combination with the
-'this' keyword. Keep in mind that when replacing the default context
-you will loose functionality provided by it, unless you manually merge it
-into your custom context.
+Keep in mind that when replacing the default context you will loose 
+functionality provided by it, unless you manually merge it with your 
+custom context.
 
 To reset the context simply assign null to obtain the original context.
 
@@ -205,7 +289,7 @@ To reset the context simply assign null to obtain the original context.
   end
 
   it 'will work ;)'
-    this.foo.should_equal 'bar'
+    foo.should_equal 'bar'
   end
   ...
 
@@ -258,50 +342,6 @@ The following expands to the array of [1,2,3,4,5]
 
   n.should.be_within 1..5
 
-=== This Literal
-
-Commonly throughout using JSpec you will often need to do things like the following,
-while referencing 'this.cart' throughout your specs:
-
-  before
-    this.cart = new ShoppingCart
-  end
-
-Thanks to the pre-processor we can simply use the terse alternative below:
-
-  ...
-  before
-    .cart = new ShoppingCart
-  end
-
-  it '...'
-    .cart.should.have 4, 'products'
-  end
-  ...
-
-Alternatively you may utilize literal javascript outside of the closures:
-
-  ...
-  cart = new ShoppingCart
-
-  it '...'
-    cart.should.have 4, 'products'
-  end
-  ...
-
-Another option is to declare a variable outside of the spec closures:
-
-  var cart
-
-  before
-    cart = new ShoppingCart
-  end
-
-  it '...'
-    cart.should.have 4, 'products'
-  end
-  ...
-
 == Formatters
 
 To change a formatter simply alter the options hash like below, assigning
@@ -425,10 +465,6 @@ Run with:
 * Get the TextMate bundle at https://github.com/visionmedia/jspec.tmbundle/tree
 * For more information consult the JSpec source code documentation or visit http://visionmedia.github.com/jspec
 
-== Known Issues
-
-* Opera likes to break for various reasons ... we are working on fixing these compat issues
-
 == License 
 
 (The MIT License)

data/bin/jspec

@@ -10,7 +10,7 @@ require 'fileutils'
 RHINO = 'java org.mozilla.javascript.tools.shell.Main'
 
 program :name, 'JSpec'
-program :version, '1.1.7'
+program :version, '2.0.0'
 program :description, 'JavaScript BDD Testing Framework'
 default_command :bind
 

data/jspec.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jspec}
-  s.version = "1.1.7"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-04-22}
+  s.date = %q{2009-04-27}
   s.default_executable = %q{jspec}
   s.description = %q{JavaScript BDD Testing Framework}
   s.email = %q{tj@vision-media.ca}
   s.executables = ["jspec"]
-  s.extra_rdoc_files = ["bin/jspec", "lib/images/bg.png", "lib/images/hr.png", "lib/images/sprites.bg.png", "lib/images/sprites.png", "lib/images/vr.png", "lib/jspec.css", "lib/jspec.jquery.js", "lib/jspec.js", "README.rdoc"]
-  s.files = ["bin/jspec", "History.rdoc", "jspec.gemspec", "lib/images/bg.png", "lib/images/hr.png", "lib/images/sprites.bg.png", "lib/images/sprites.png", "lib/images/vr.png", "lib/jspec.css", "lib/jspec.jquery.js", "lib/jspec.js", "Manifest", "Rakefile", "README.rdoc", "server/browsers.rb", "server/server.rb", "spec/async", "spec/jquery-1.3.1.js", "spec/server.html", "spec/spec.core.dom.js", "spec/spec.core.js", "spec/spec.grammar.js", "spec/spec.html", "spec/spec.jquery.js", "spec/spec.rhino.js", "templates/default/History.rdoc", "templates/default/lib/yourlib.core.js", "templates/default/README.rdoc", "templates/default/spec/spec.core.js", "templates/default/spec/spec.html", "templates/rhino/History.rdoc", "templates/rhino/lib/yourlib.core.js", "templates/rhino/README.rdoc", "templates/rhino/spec/spec.core.js", "templates/rhino/spec/spec.js", "templates/server/History.rdoc", "templates/server/lib/yourlib.core.js", "templates/server/README.rdoc", "templates/server/spec/spec.core.js", "templates/server/spec/spec.html"]
+  s.extra_rdoc_files = ["bin/jspec", "lib/images/bg.png", "lib/images/hr.png", "lib/images/loading.gif", "lib/images/sprites.bg.png", "lib/images/sprites.png", "lib/images/vr.png", "lib/jspec.css", "lib/jspec.jquery.js", "lib/jspec.js", "README.rdoc"]
+  s.files = ["bin/jspec", "History.rdoc", "jspec.gemspec", "lib/images/bg.png", "lib/images/hr.png", "lib/images/loading.gif", "lib/images/sprites.bg.png", "lib/images/sprites.png", "lib/images/vr.png", "lib/jspec.css", "lib/jspec.jquery.js", "lib/jspec.js", "Manifest", "Rakefile", "README.rdoc", "server/browsers.rb", "server/server.rb", "spec/async", "spec/jquery-1.3.1.js", "spec/server.html", "spec/spec.grammar-less.js", "spec/spec.grammar.js", "spec/spec.html", "spec/spec.jquery.js", "spec/spec.js", "spec/spec.matchers.js", "spec/spec.rhino.js", "spec/spec.shared-behaviors.js", "spec/spec.utils.js", "templates/default/History.rdoc", "templates/default/lib/yourlib.core.js", "templates/default/README.rdoc", "templates/default/spec/spec.core.js", "templates/default/spec/spec.html", "templates/rhino/History.rdoc", "templates/rhino/lib/yourlib.core.js", "templates/rhino/README.rdoc", "templates/rhino/spec/spec.core.js", "templates/rhino/spec/spec.js", "templates/server/History.rdoc", "templates/server/lib/yourlib.core.js", "templates/server/README.rdoc", "templates/server/spec/spec.core.js", "templates/server/spec/spec.html"]
   s.has_rdoc = true
   s.homepage = %q{http://visionmedia.github.com/jspec}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Jspec", "--main", "README.rdoc"]

data/lib/jspec.css

@@ -1,6 +1,5 @@
 body.jspec {
   margin: 45px 0;
-  text-align: center;
   font: 12px "Helvetica Neue Light", "Lucida Grande", "Calibri", "Arial", sans-serif;
   background: #efefef url(images/bg.png) top left repeat-x;
 }
@@ -24,6 +23,12 @@ body.jspec {
   height: 15px;
   background: url(images/sprites.bg.png) bottom left no-repeat;
 }
+#jspec .loading {
+  margin-top: -45px;
+  width: 1008px;
+  height: 80px;
+  background: url(images/loading.gif) 50% 50% no-repeat;
+}
 #jspec-title {
   position: relative;
   top: 35px;
@@ -32,6 +37,7 @@ body.jspec {
   font-size: 22px;
   font-weight: normal;
   background: url(images/sprites.png) 0 -126px no-repeat;
+  text-align: center;
 }
 #jspec-title em {
   font-size: 10px;
@@ -68,7 +74,6 @@ body.jspec {
   color: #FA1616;
 }
 #jspec-report table {
-  width: 100%;
   font-size: 11px;
   border-collapse: collapse;
 }
@@ -77,6 +82,16 @@ body.jspec {
   text-indent: 30px;
   color: #7B8D9B;
 }
+#jspec-report tr.body {
+  display: none;
+}
+#jspec-report tr.body pre {
+  margin: 0;
+  padding: 0 0 5px 25px;
+}
+#jspec-report tr:not(.body):hover + tr.body {
+  display: block;
+}
 #jspec-report tr td:first-child em {
   font-style: normal;
   font-weight: normal;

data/lib/jspec.jquery.js

@@ -15,8 +15,7 @@
 
   JSpec.defaultContext.element = jQuery
   JSpec.defaultContext.elements = jQuery
-  JSpec.defaultContext.defaultSandbox = JSpec.defaultContext.sandbox
-  JSpec.defaultContext.sandbox = function() { return jQuery(JSpec.defaultContext.defaultSandbox()) }
+  JSpec.defaultContext.sandbox = function() { return jQuery('<div class="sandbox"></div>') }
 
   // --- Matchers
 
@@ -35,9 +34,9 @@
     have_class    : "jQuery(actual).hasClass(expected)",
     
     have_classes : function(actual) {
-      for (i = 1; i < arguments.length; i++)
-        if (!jQuery(actual).hasClass(arguments[i])) return false
-      return true
+      return !JSpec.any(JSpec.argumentsToArray(arguments, 1), function(arg){
+        return !JSpec.does(actual, 'have_class', arg)
+      })
     },
     
     have_attr : function(actual, attr, value) {
@@ -60,15 +59,6 @@
     })
   })
   
-  // --- be_a_TYPE_input (deprecated)
-  
-  JSpec.each('checkbox radio file password submit image text reset button', function(type){
-    JSpec.addMatcher('be_a_' + type + '_input', function(actual, expected) {
-      console.warn("be_a_" + type + "_input is deprected; use have_type('" + type + "')");
-      return jQuery(actual).get(0).type == type
-    })
-  })
-  
 })()