opal-spec 0.2.0 → 0.2.1

data/Gemfile

@@ -1,2 +1,2 @@
-gem "opal", :git => 'git://github/opal/opal.git'
+gem "opal", :git => 'git://github.com/opal/opal.git'
 gem "rake"

data/README.md

@@ -5,6 +5,69 @@ opal-spec is a minimal spec lib for opal, inspired by RSpec and MSpec.
 It is designed to run on [opal](http://opalrb.org), and provides the
 bare minimum to get specs running.
 
+## Writing Specs
+
+Your specs should go into the `/spec` directory of your app. They take
+the same form as rspec/mspec:
+
+```ruby
+describe MyClass do
+  it 'should do some feature' do
+    1.should == 1
+  end
+
+  it 'does something else' do
+    nil.should be_nil
+    false.should be_false
+    true.should be_true
+  end
+end
+```
+
+### Running specs
+
+Loading these specs in a browser won't just work. You need to run them.
+The best place to do this is inside `spec/spec_helper.rb`, and with a
+simple call:
+
+```ruby
+OpalSpec::Runner.autorun
+```
+
+###  Async examples
+
+Examples can be async, and need to be defined as so:
+
+```ruby
+  describe 'MyClass' do
+    # normal, sync example
+    it 'does something' do
+      # ...
+    end
+
+    # async example
+    async 'does something else too' do
+      # ...
+    end
+  end
+```
+
+This just marks the example as being async. To actually handle the async
+result, you also need to use a `run_async` call inside some future handler:
+
+```ruby
+async 'HTTP requests should work' do
+  HTTP.get('users/1.json') do |response|
+    run\_async {
+      response.ok?.should be\_true
+    }
+  end
+end
+```
+
+The end of the block passed to `run_async` informs opal-spec that you are
+done with this test, so it can move on.
+
 Change Log
 ----------
 

data/Rakefile

@@ -1 +1,8 @@
-require 'opal'
+require 'bundler'
+Bundler.setup
+
+require 'opal/rake_task'
+
+Opal::RakeTask.new do |t|
+  t.name = 'opal-spec'
+end

data/lib/opal-spec/browser_formatter.rb

@@ -138,7 +138,7 @@ module OpalSpec
       when OpalSpec::ExpectationNotMetError
         output  = exception.message
       else
-        output  = "#{exception.class}: #{exception.message}\n"
+        output  = "#{exception.class.name}: #{exception.message}\n"
         output += "    #{exception.backtrace.join "\n    "}\n"
       end
 

data/lib/opal-spec/example.rb

@@ -1,6 +1,7 @@
 module OpalSpec
   class Example
     attr_reader :description, :example_group, :exception
+    attr_accessor :asynchronous
 
     def initialize(group, desc, block)
       @example_group = group
@@ -8,38 +9,68 @@ module OpalSpec
       @__block__     = block
     end
 
-    def run_before_hooks
-      @example_group.before_hooks.each do |before|
-        instance_eval &before
+    def finish_running
+      if @exception
+        @example_group.example_failed self
+      else
+        @example_group.example_passed self
+      end
+    end
+
+    def run
+      begin
+        @example_group.example_started self
+        run_before_hooks
+        instance_eval(&@__block__)
+      rescue => e
+        @exception = e
+      ensure
+        run_after_hooks unless @asynchronous
+      end
+
+      if @asynchronous
+        # must wait ...
+      else
+        finish_running
       end
     end
 
     def run_after_hooks
-      @example_group.after_hooks.each do |after|
+      begin
+        @example_group.after_hooks.each do |after|
         instance_eval &after
+        end
+      rescue => e
+        @exception = e
+      end
+    end
+
+    def run_before_hooks
+      @example_group.before_hooks.each do |before|
+        instance_eval &before
       end
     end
 
-    def run runner
+    def run_async(&block)
       begin
-        runner.example_started self
-        run_before_hooks
-        instance_eval &@__block__
+        block.call
       rescue => e
         @exception = e
       ensure
-        begin
-          run_after_hooks
-        rescue => e
-          @exception = e
-        end
+        run_after_hooks
       end
 
-      if @exception
-        runner.example_failed self
-      else
-        runner.example_passed self
-      end
+      finish_running
+    end
+
+    def set_timeout(duration, &block)
+      %x{
+        setTimeout(function() {
+          #{ block.call };
+        }, duration);
+      }
+
+      self
     end
   end
-end
+end

data/lib/opal-spec/example_group.rb

@@ -24,10 +24,16 @@ module OpalSpec
       @after_hooks  = []
     end
 
-    def it desc, &block
+    def it(desc, &block)
       @examples << Example.new(self, desc, block)
     end
 
+    def async(desc, &block)
+      example = Example.new(self, desc, block)
+      example.asynchronous = true
+      @examples << example
+    end
+
     def it_behaves_like(*objs)
     end
 
@@ -49,10 +55,34 @@ module OpalSpec
       @parent ? [].concat(@parent.after_hooks).concat(@after_hooks) : @after_hooks
     end
 
-    def run runner
-      runner.example_group_started self
-      @examples.each { |example| example.run runner }
-      runner.example_group_finished self
+    def run(runner)
+      @runner = runner
+      @runner.example_group_started self
+
+      @running_examples = @examples.dup
+      run_next_example
+    end
+
+    def run_next_example
+      if @running_examples.empty?
+        @runner.example_group_finished self
+      else
+        @running_examples.shift.run
+      end
+    end
+
+    def example_started(example)
+      @runner.example_started(example)
+    end
+
+    def example_passed(example)
+      @runner.example_passed(example)
+      run_next_example
+    end
+
+    def example_failed(example)
+      @runner.example_failed(example)
+      run_next_example
     end
 
     def description

data/lib/opal-spec/phantom_formatter.rb

@@ -24,7 +24,7 @@ module OpalSpec
       if @failed_examples.empty?
         log "\nFinished"
         log_green "#{example_count} examples, 0 failures"
-        `phantom.exit(0)`
+        finish_with_code(0)
       else
         log "\nFailures:"
         @failed_examples.each_with_index do |example, idx|
@@ -35,7 +35,7 @@ module OpalSpec
           when OpalSpec::ExpectationNotMetError
             output  = exception.message
           else
-            output  = "#{exception.class}: #{exception.message}\n"
+            output  = "#{exception.class.name}: #{exception.message}\n"
             output += "      #{exception.backtrace.join "\n      "}\n"
           end
           log_red "    #{output}"
@@ -43,9 +43,20 @@ module OpalSpec
 
         log "\nFinished"
         log_red "#{example_count} examples, #{@failed_examples.size} failures"
-        `phantom.exit(1)`
+        finish_with_code(1)
       end
     end
+    
+    def finish_with_code(code)
+      %x{
+        if (typeof(phantom) !== 'undefined') {
+          return phantom.exit(code);
+        }
+        else {
+          window.OPAL_SPEC_CODE = code;
+        }
+      }
+    end
 
     def example_group_started group
       @example_group = group

data/lib/opal-spec/runner.rb

@@ -12,7 +12,7 @@ module OpalSpec
 
     def self.in_phantom?
       %x{
-        if (typeof(phantom) !== 'undefined' && phantom.exit) {
+        if (typeof(phantom) !== 'undefined' || typeof(OPAL_SPEC_PHANTOM) !== 'undefined') {
           return true;
         }
 
@@ -41,10 +41,17 @@ module OpalSpec
     end
 
     def run
-      groups = ExampleGroup.example_groups
+      @groups = ExampleGroup.example_groups.dup
       @formatter.start
-      groups.each { |group| group.run self }
-      @formatter.finish
+      run_next_group
+    end
+
+    def run_next_group
+      if @groups.empty?
+        @formatter.finish
+      else
+        @groups.shift.run self
+      end
     end
 
     def example_group_started group
@@ -53,6 +60,7 @@ module OpalSpec
 
     def example_group_finished group
       @formatter.example_group_finished group
+      run_next_group
     end
 
     def example_started example

data/lib/opal-spec/version.rb

@@ -1,3 +1,3 @@
 module OpalSpec
-  VERSION = "0.2.0"
+  VERSION = '0.2.1'
 end

data/spec/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+  <title>opal-spec tests</title>
+</head>
+<body>
+  <script src="../build/opal.js"></script>
+  <script src="../build/opal-spec.js"></script>
+  <script src="../build/specs.js"></script>
+</body>
+</html>

data/spec/test.rb

@@ -0,0 +1,56 @@
+@passed = 0
+@failures = []
+
+def assert(value, message='Not true')
+  if value
+    @passed += 1
+  else
+    @failures << message
+  end
+end
+
+def assert_equal(got, expected, message='Not equal')
+  assert(got == expected, message)
+end
+
+describe 'Normal group' do
+  it 'this should fail' do
+    1.should == 2
+  end
+end
+
+describe 'Another group' do
+  it 'this should pass' do
+    1.should == 1
+  end
+
+  it 'this should fail' do
+    raise "whatever error you like"
+  end
+
+  it 'this should pass' do
+    true.should be_true
+    false.should be_false
+    nil.should be_nil
+  end
+
+  async 'this should pass (in 1 second time)' do
+    set_timeout(1000) do
+      run_async {
+        1.should == 1
+      }
+    end
+  end
+
+  async 'this should fail (in 1 second time)' do
+    set_timeout(1000) do
+      run_async {
+        1.should == 5
+      }
+    end
+  end
+end
+
+OpalSpec::Runner.autorun
+
+puts "Assertions: #{@passed + @failures.length}, Passed: #{@passed}, Failures: #{@failures.length}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opal-spec
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-11 00:00:00.000000000Z
+date: 2012-09-17 00:00:00.000000000Z
 dependencies: []
 description: Opal compatible spec library
 email: adam@adambeynon.com
@@ -33,6 +33,8 @@ files:
 - lib/opal-spec/scratch_pad.rb
 - lib/opal-spec/version.rb
 - opal-spec.gemspec
+- spec/index.html
+- spec/test.rb
 homepage: http://opalrb.org
 licenses: []
 post_install_message: