opal-spec 0.2.10 → 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f1c0478a579f30dd1260e1eac1f4e7fc7ec7de64
+  data.tar.gz: 4d1bd16512841732a1dbb24c9af3094b380b7a4f
+SHA512:
+  metadata.gz: a537c224a1e36c6c37ceb5dfc17efb60665fd14188a7d48f0052c449f1312e5caf97248371a1ea0d0d265ed2fad2bb1bd5210682cdd0eb56e396323662616e02
+  data.tar.gz: bd4212cc0da890c8036c7640f48c94282a5c82f90723d39cc2c0453d085f11cfef58dfc28869dc98de6b4902ebef0b566f5cde40b41ccb1541c8e3685fd626c0

data/Gemfile

@@ -1,6 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
-
-gem 'rake'
-gem 'opal'
-gem 'sprockets'

data/README.md

@@ -23,14 +23,29 @@ describe MyClass do
 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
-Opal::Spec::Runner.autorun
+### Supported notations
+
+````
+* describe "foo" do ... end
+* it "should foo" do ... end
+* before do ... end
+* after do ... end
+* let(:foo) { ... }
+* async  # see below
+
+* obj.should == other
+* obj.should != other
+* obj.should be_nil
+* obj.should be_true
+* obj.should be_false
+* obj.should be_kind_of(klass)
+* obj.should eq(other)  # compare with :==
+* obj.should equal(other)  # compare with :equal?
+* obj.should raise_error
+* obj.should be_empty
+* obj.should respond_to(method)
+
+* obj.should_not xxx
 ```
 
 ###  Async examples
@@ -38,17 +53,17 @@ Opal::Spec::Runner.autorun
 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
+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
@@ -66,26 +81,3 @@ 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
-----------
-
-### 0.2.7
-
-* Can be built using asset pipeline/sprockets
-* BrowserFormatter is now default
-
-### 0.0.3
-
-* Allow group names to be non-strings
-* Nested groups now have outer group name as prefix
-* Nested groups should inherit `before` and `after` blocks
-
-### 0.0.2
-
-* Added seperate BrowserFormatter class for cleaner output
-* Update Rake tasks to use new Opal::Builder class
-
-### 0.0.1
-
-Initial release

data/config.ru

@@ -1,5 +1,8 @@
 require 'bundler'
 Bundler.require
 
-require 'opal/spec/server'
-run Opal::Spec::Server.new
+run Opal::Server.new { |s|
+  s.main = 'opal/spec/sprockets_runner'
+  s.append_path 'spec'
+  s.debug = false
+}

data/example/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'opal'
+gem 'opal-spec'

data/example/README.md

@@ -0,0 +1,8 @@
+opal-spec example
+=================
+
+Running spec
+------------
+
+    $ bundle install
+    $ rake

data/example/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler.require
+
+require 'opal'
+# Help Opal to find your library in ./opal/
+Opal.append_path File.expand_path("opal", File.dirname("__FILE__"))
+
+require 'opal/spec/rake_task'
+Opal::Spec::RakeTask.new(:default)
+

data/example/opal/stack.rb

@@ -0,0 +1,2 @@
+class Stack < Array
+end

data/example/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'opal-spec'
+require 'stack'

data/example/spec/stack_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Stack do
+  before do
+    @stack = Stack.new
+  end
+
+  it "should be initially empty" do
+    @stack.empty?.should be_true
+  end
+
+  it "can contain an object" do
+    @stack.push(1)
+    @stack.pop.should == 1
+  end
+end
+

data/lib/opal/spec/rake_task.rb

@@ -1,30 +1,35 @@
 require 'opal/spec'
-require 'opal/spec/server'
+require 'opal-sprockets'
 
 module Opal
   module Spec
     class RakeTask
       include Rake::DSL if defined? Rake::DSL
 
-      attr_accessor :name
+      RUNNER = File.expand_path('../../../../vendor/spec_runner.js', __FILE__)
+      PORT = 9999
+      URL = "http://localhost:9999/"
 
-      def initialize(name = 'opal:spec')
-        @name = name
-        define_tasks
-      end
-
-      def define_tasks
+      def initialize(name = 'opal:test', &block)
         desc "Run opal specs in phantomjs"
-        task @name do
+        task name do
           require 'rack'
           require 'webrick'
 
           server = fork do
-            Rack::Server.start(:app => Opal::Spec::Server.new(false), :Port => port,
-              :Logger => WEBrick::Log.new("/dev/null"), :AccessLog => [])
+            app = Opal::Server.new { |s|
+              s.main = 'opal/spec/sprockets_runner'
+              s.append_path 'spec'
+              s.debug = false
+
+              block.call s if block
+            }
+
+            Rack::Server.start(:app => app, :Port => PORT, :AccessLog => [],
+              :Logger => WEBrick::Log.new("/dev/null"))
           end
 
-          system "phantomjs #{runner_path} \"#{url_path}\""
+          system "phantomjs #{RUNNER} \"#{URL}\""
           success = $?.success?
 
           Process.kill(:SIGINT, server)
@@ -33,18 +38,6 @@ module Opal
           exit 1 unless success
         end
       end
-
-      def runner_path
-        File.join(VENDOR_PATH, 'spec_runner.js')
-      end
-
-      def url_path
-        "http://localhost:9999/"
-      end
-
-      def port
-        9999
-      end
     end
   end
 end

data/lib/opal/spec/version.rb

@@ -1,5 +1,5 @@
 module Opal
   module Spec
-    VERSION = '0.2.10'
+    VERSION = '0.3.2'
   end
 end

data/lib/opal/spec.rb

@@ -1,11 +1,5 @@
 require 'opal'
 require 'opal/spec/version'
 
-module Opal
-  module Spec
-    VENDOR_PATH = File.join(File.dirname(__FILE__), '..', '..', 'vendor')
-  end
-end
-
 # Just register our opal code path with opal build tools
-Opal.append_path File.join(File.dirname(__FILE__), '..', 'assets', 'javascripts')
+Opal.append_path File.expand_path('../../../opal', __FILE__)

data/opal/opal/spec/browser_formatter.rb

@@ -0,0 +1,218 @@
+module OpalSpec
+  class BrowserFormatter
+    CSS = <<-CSS
+
+      body {
+        font-size: 14px;
+        font-family: Helvetica Neue, Helvetica, Arial, sans-serif;
+      }
+
+      pre {
+        font-family: "Bitstream Vera Sans Mono", Monaco, "Lucida Console", monospace;
+        font-size: 12px;
+        color: #444444;
+        white-space: pre;
+        padding: 3px 0px 3px 12px;
+        margin: 0px 0px 8px;
+
+        background: #FAFAFA;
+        -webkit-box-shadow: rgba(0,0,0,0.07) 0 1px 2px inset;
+        -webkit-border-radius: 3px;
+        -moz-border-radius: 3px;
+        border-radius: 3px;
+        border: 1px solid #DDDDDD;
+      }
+
+      ul.example_groups {
+        list-style-type: none;
+      }
+
+      li.group.passed .group_description {
+        color: #597800;
+        font-weight: bold;
+      }
+
+      li.group.failed .group_description {
+        color: #FF000E;
+        font-weight: bold;
+      }
+
+      li.example.passed {
+        color: #597800;
+      }
+
+      li.example.failed {
+        color: #FF000E;
+      }
+
+      .examples {
+        list-style-type: none;
+      }
+    CSS
+
+    class Node
+
+      attr_reader :element
+
+      def self.create(tag)
+        new(`document.createElement(tag)`)
+      end
+
+      def initialize(element)
+        @element = element
+      end
+
+      def class_name=(name)
+        `#{ @element }.className = name`
+      end
+
+      def html=(html)
+        `#{ @element }.innerHTML = html`
+      end
+
+      def text=(text)
+        self.html = text.gsub(/</, '&lt').gsub(/>/, '&gt')
+      end
+
+      def type=(type)
+        `#{ @element }.type = type`
+      end
+
+      def append(child)
+        `#{ @element }.appendChild(#{ child.element })`
+      end
+
+      def css_text=(text)
+        %x{
+          if (#{ @element }.styleSheet) {
+            #{ @element }.styleSheet.cssText = text;
+          }
+          else {
+            #{ @element }.appendChild(document.createTextNode(text));
+          }
+        }
+      end
+
+      def style(name, value)
+        `#{@element}.style[name] = value`
+      end
+
+      def append_to_head
+        `document.getElementsByTagName('head')[0].appendChild(#{@element})`
+      end
+    end
+
+    def initialize
+      @examples        = []
+      @failed_examples = []
+    end
+
+    def start
+      raise "Not running in browser" unless Runner.in_browser?
+
+      @summary_element = Node.create 'p'
+      @summary_element.class_name = "summary"
+      @summary_element.text = "Runner..."
+
+      @groups_element = Node.create("ul")
+      @groups_element.class_name = "example_groups"
+
+      target = Node.new(`document.body`)
+      target.append @summary_element
+      target.append @groups_element
+
+      styles = Node.create "style"
+      styles.type = "text/css"
+      styles.css_text = CSS
+      styles.append_to_head
+
+      @start_time = Time.now.to_f
+    end
+
+    def finish
+      time = Time.now.to_f - @start_time
+      text = "\n#{example_count} examples, #{@failed_examples.size} failures (time taken: #{time})"
+
+      @summary_element.text = text
+    end
+
+    def example_group_started group
+      @example_group = group
+      @example_group_failed = false
+
+      @group_element = Node.create("li")
+
+      description = Node.create("span")
+      description.class_name = "group_description"
+      description.text = group.description.to_s
+      @group_element.append description
+
+      @example_list = Node.create "ul"
+      @example_list.class_name = "examples"
+      @group_element.append @example_list
+
+      @groups_element.append @group_element
+    end
+
+    def example_group_finished group
+      if @example_group_failed
+        @group_element.class_name = "group failed"
+      else
+        @group_element.class_name = "group passed"
+      end
+    end
+
+    def example_started example
+      @examples << example
+      @example = example
+    end
+
+    def example_failed example
+      @failed_examples << example
+      @example_group_failed = true
+
+      exception = example.exception
+
+      case exception
+      when OpalSpec::ExpectationNotMetError
+        output  = exception.message
+      else
+        output  = "#{exception.class.name}: #{exception.message}\n"
+        output += "    #{exception.backtrace.join "\n    "}\n"
+      end
+
+      wrapper = Node.create "li"
+      wrapper.class_name = "example failed"
+
+      description = Node.create "span"
+      description.class_name = "example_description"
+      description.text = example.description.to_s
+
+      exception = Node.create "pre"
+      exception.class_name = "exception"
+      exception.text = output
+
+      wrapper.append description
+      wrapper.append exception
+
+      @example_list.append wrapper
+      @example_list.style :display, "list-item"
+    end
+
+    def example_passed example
+      wrapper = Node.create "li"
+      wrapper.class_name = "example passed"
+
+      description = Node.create "span"
+      description.class_name = "example_description"
+      description.text = example.description.to_s
+
+      wrapper.append description
+      @example_list.append wrapper
+    end
+
+    def example_count
+      @examples.size
+    end
+  end
+end

data/opal/opal/spec/expectations.rb

@@ -0,0 +1,128 @@
+module OpalSpec
+  class ExpectationNotMetError < StandardError; end
+
+  module Expectations; end
+
+  def self.matcher name, &block
+    klass = Class.new(Matcher, &block)
+
+    klass.define_method(:matcher_name) do
+      name
+    end
+
+    Expectations.define_method(name) do |*args|
+      klass.new(*args)
+    end
+  end
+
+  matcher :be_nil do
+    def match expected, actual
+      actual.nil?
+    end
+
+    def failure_message_for_should
+      "expected #{expected.inspect} to be nil."
+    end
+  end
+
+  matcher :be_true do
+    def match expected, actual
+      actual == true
+    end
+
+    def failure_message_for_should
+      "expected #{actual.inspect} to be true."
+    end
+  end
+
+  matcher :be_false do
+    def match expected, actual
+      actual == false
+    end
+
+    def failure_message_for_should
+      "expected #{actual.inspect} to be false."
+    end
+  end
+
+  matcher :be_kind_of do
+    def match expected, actual
+      actual.kind_of? expected
+    end
+
+    def failure_message_for_should
+      "expected #{actual.inspect} to be a kind of #{expected.name}, not #{actual.class.name}."
+    end
+  end
+
+  matcher :eq do
+    def match expected, actual
+      expected == actual
+    end
+
+    def failure_message_for_should
+      "expected #{expected.inspect}, got: #{actual.inspect} (using ==)."
+    end
+
+    def failure_message_for_should_not
+      "expected #{expected.inspect}, not to be: #{actual.inspect} (using ==)."
+    end
+  end
+
+  matcher :equal do
+    def match expected, actual
+      expected.equal? actual
+    end
+
+    def failure_message_for_should
+      "expected #{actual.inspect} to be the same as #{expected.inspect}."
+    end
+
+    def failure_message_for_should_not
+      "expected #{actual.inspect} to not be equal to #{expected.inspect}."
+    end
+  end
+
+  matcher :raise_error do
+    def initialize(&block)
+      @block = block
+    end
+
+    def match expected, actual
+      ok = true
+
+      begin
+        @block.call
+        ok = false
+      rescue => e
+        @error = e
+      end
+
+      ok
+    end
+
+    def failure_message_for_should
+      "expected #{actual} to be raised, but nothing was."
+    end
+  end
+
+  matcher :be_empty do
+    def match expected, actual
+      actual.empty?
+    end
+
+    def failure_message_for_should
+      "expected #{actual.inspect} to be empty"
+    end
+  end
+
+  matcher :respond_to do
+    def match expected, actual
+      actual.respond_to? expected
+    end
+
+    def failure_message_for_should
+      "expected #{actual.inspect} (#{actual.class}) to respond to #{expected}."
+    end
+  end
+end

data/opal/opal/spec/matchers.rb

@@ -0,0 +1,61 @@
+module OpalSpec
+  class Matcher
+    attr_reader :actual, :expected
+
+    def initialize expected = nil
+      @expected = expected
+    end
+
+    def positive_match? actual
+      @actual = actual
+
+      unless match expected, actual
+        raise OpalSpec::ExpectationNotMetError, failure_message_for_should
+      end
+    end
+
+    def negative_match? actual
+      @actual = actual
+
+      if match expected, actual
+        raise OpalSpec::ExpectationNotMetError, failure_message_for_should_not
+      end
+    end
+
+    def failure_message_for_should
+      "expected: #{expected.inspect}, actual: #{actual.inspect} (#{matcher_name}) [should]."
+    end
+
+    def failure_message_for_should_not
+      "expected: #{expected.inspect}, actual: #{actual.inspect} (#{matcher_name}) [should_not]."
+    end
+  end
+
+  class PositiveOperatorMatcher < Matcher
+    def == actual
+      @actual = actual
+
+      unless expected == actual
+        raise Opal::Spec::ExpectationNotMetError, failure_message_for_should
+      end
+    end
+
+    def failure_message_for_should
+      "expected #{actual.inspect}, but got: #{expected.inspect} (using ==)."
+    end
+  end
+
+  class NegativeOperatorMatcher < Matcher
+    def == actual
+      @actual = actual
+
+      if expected == actual
+        raise Opal::Spec::ExpectationNotMetError, failure_message_for_should_not
+      end
+    end
+
+    def failure_message_for_should_not
+      "expected #{actual.inspect} not to be: #{expected.inspect} (using ==)."
+    end
+  end
+end

data/opal/opal/spec/object.rb

@@ -0,0 +1,21 @@
+class Object
+  def describe desc, &block
+    OpalSpec::Example.create desc, block
+  end
+
+  def should matcher = nil
+    if matcher
+      matcher.positive_match? self
+    else
+      OpalSpec::PositiveOperatorMatcher.new self
+    end
+  end
+
+  def should_not matcher = nil
+    if matcher
+      matcher.negative_match? self
+    else
+      OpalSpec::NegativeOperatorMatcher.new self
+    end
+  end
+end