opal-rspec 0.4.0.beta3 → 0.4.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d63becff5bbb79b0f33a63ab926145f4f6b9d7b2
-  data.tar.gz: 2b43af87ee229788e1f9abcb67f0e97ffe7bc6e6
+  metadata.gz: b6ec1f1110451f412a61b923b32d640e293e2929
+  data.tar.gz: 6aebaf694d03562bc10ff99c956dc53c7cb36155
 SHA512:
-  metadata.gz: 643059f5e8419b5d7f828e8b0687b378ee380641f6379a20df9922345f34cea58d3d6d226487019ce16d83c582aaf1c0ad99faa1ead946ede6275e8a4564c9b4
-  data.tar.gz: 79a56fd3dd9a7704bb3aedad971cc555fafcc3cb6d9d25501a08bcc3afb34a64394a47c64d94666fc2a2e0df152c0da0def8e8e931d2d7978dd61a8a7f6847a5
+  metadata.gz: 1f07f2a9acaa17631c66fa1455670f07d7f05641786e4df60d1641d853818cc2b2ecc17e3379f4e068789ecde5a1df077f076685a9aef09bf8e82570c64ebfac
+  data.tar.gz: 06559b78e1349be1765b9a14047f1b290e113b8a435c87fb02fd5c026e23676ad82892e15b3527a0ee27b3739bcfb4dc98aa7487fe892c4e2addd17dc38a1ab3

data/.gitignore

@@ -1,4 +1,3 @@
 .DS_Store
 Gemfile.lock
-opal/opal/rspec/rspec.js
 *.gem

data/.gitmodules

@@ -0,0 +1,15 @@
+[submodule "rspec"]
+	path = rspec
+	url = https://github.com/rspec/rspec.git
+[submodule "rspec-support"]
+	path = rspec-support
+	url = https://github.com/rspec/rspec-support.git
+[submodule "rspec-core"]
+	path = rspec-core
+	url = https://github.com/rspec/rspec-core.git
+[submodule "rspec-mocks"]
+	path = rspec-mocks
+	url = https://github.com/rspec/rspec-mocks.git
+[submodule "rspec-expectations"]
+	path = rspec-expectations
+	url = https://github.com/rspec/rspec-expectations.git

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+before_install:
+  - git submodule update --init
+
+notifications:
+  irc: "irc.freenode.org#opal"

data/.yardopts

@@ -0,0 +1,5 @@
+lib/**/*.rb
+opal/**/*.rb
+--markup markdown
+-
+CHANGELOG.md

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ## edge
 
+*   Remove predicate matcher fixes as Opal supports $1..$9 special gvars.
+
 *   Update Opal dependency for ~> 0.6.0.
 
 *   Remove double-escaping in inline x-strings (from Opal bug fix).
@@ -10,4 +12,4 @@
 
 *   Add timeout support to asynchronous specs
 
-## 0.2.1 2013-11-24
+## 0.2.1  November 24, 2013

data/Gemfile

@@ -1,11 +1,10 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'opal', github: 'opal/opal'
-# gem 'opal', path: '../opal'
+gem 'opal', :github => 'opal/opal'
 
-gem 'rspec',              '3.0.0.beta1'
-gem 'rspec-support',      '3.0.0.beta1'
-gem 'rspec-core',         '3.0.0.beta1'
-gem 'rspec-mocks',        '3.0.0.beta1'
-gem 'rspec-expectations', '3.0.0.beta1'
+gem 'rspec',              :path => 'rspec'
+gem 'rspec-support',      :path => 'rspec-support'
+gem 'rspec-core',         :path => 'rspec-core'
+gem 'rspec-mocks',        :path => 'rspec-mocks'
+gem 'rspec-expectations', :path => 'rspec-expectations'

data/README.md

@@ -2,6 +2,8 @@
 
 An attempt at a compatibility layer of rspec for opal.
 
+[See the website for documentation](http://opalrb.org/docs/rspec/).
+
 ## Usage
 
 Add `opal-rspec` to your Gemfile:

data/Rakefile

@@ -1,64 +1,26 @@
 require 'bundler'
 Bundler.require
+
 Bundler::GemHelper.install_tasks
 
 require 'opal/rspec/rake_task'
 Opal::RSpec::RakeTask.new(:default)
 
-desc "Build opal/opal/rspec/rspec.js"
-task :dist do
-  File.open('opal/opal/rspec/rspec.js', 'w+') do |out|
-    out << build_rspec
-  end
-end
-task :build => :dist
-
-desc "Show dev/min sizes"
-task :sizes do
-  code = build_rspec
-  min  = uglify code
-
-  puts "\ndevelopment: #{code.size}, minified: #{min.size}"
-end
-
-def build_rspec
-  Opal::Processor.dynamic_require_severity = :warning
-
-  code = []
-  gems = %w(rspec rspec-core rspec-support rspec-expectations rspec-mocks)
 
-  gems.each do |gem_name|
-    spec = Gem::Specification.find_by_name gem_name
-    gem_dir = File.join spec.gem_dir, 'lib'
-    prefix = gem_dir + '/'
+require 'fileutils'
+desc "Copy RSpec sources"
+task :copy_rspec do
+  gems = %w(rspec rspec-core rspec-expectations rspec-mocks rspec-support)
 
-    Dir.glob(File.join(gem_dir, '**/*.rb')).each do |source|
-      requirable = source.sub(prefix, '').sub(/\.rb$/, '')
+  gems.each do |gem|
+    spec = Gem::Specification.find_by_name gem
+    lib  = File.join spec.gem_dir, 'lib'
 
-      compiler = Opal::Compiler.new File.read(source),
-        requirable: true, file: requirable, dynamic_require_severity: :warning
+    Dir["#{lib}/**/*.rb"].each do |file|
+      out = file.sub(/^#{lib}\//, 'opal/')
 
-      code << compiler.compile
+      FileUtils.mkdir_p File.dirname(out)
+      FileUtils.cp file, out
     end
   end
-
-  stubs = %w(shellwords fileutils optparse)
-
-  stubs.each do |stub|
-    compiler = Opal::Compiler.new '', requirable: true, file: stub
-    code << compiler.compile
-  end
-
-  code.join "\n"
-end
-
-def uglify(str)
-  IO.popen('uglifyjs', 'r+') do |i|
-    i.puts str
-    i.close_write
-    return i.read
-  end
-rescue Errno::ENOENT
-  $stderr.puts '"uglifyjs" command not found (install with: "npm install -g uglify-js")'
-  nil
 end

data/lib/opal/rspec/version.rb

@@ -1,5 +1,5 @@
 module Opal
   module RSpec
-    VERSION = '0.4.0.beta3'
+    VERSION = '0.4.0.beta4'
   end
 end

data/lib/opal/rspec.rb

@@ -3,4 +3,18 @@ require 'opal/rspec/version'
 
 # Just register our opal code path with opal build tools
 Opal.append_path File.expand_path('../../../opal', __FILE__)
+Opal.append_path File.expand_path('../../../vendor_lib', __FILE__)
 
+Opal::Processor.dynamic_require_severity = :warning
+
+Opal::Processor.stub_file "rspec/matchers/built_in/have"
+Opal::Processor.stub_file "diff/lcs"
+Opal::Processor.stub_file "diff/lcs/hunk"
+Opal::Processor.stub_file "fileutils"
+Opal::Processor.stub_file "test/unit/assertions"
+Opal::Processor.stub_file "coderay"
+Opal::Processor.stub_file "optparse"
+Opal::Processor.stub_file "shellwords"
+Opal::Processor.stub_file "socket"
+Opal::Processor.stub_file "uri"
+Opal::Processor.stub_file "drb/drb"

data/opal/opal/rspec/async.rb

@@ -1,27 +1,148 @@
 module Opal
   module RSpec
-    module AsyncDefinitions
-      def async(desc, *args, &block)
-        options = ::RSpec::Core::Metadata.build_hash_from(args)
-        Opal::RSpec::AsyncExample.register(self, desc, options, block)
+    # {AsyncHelpers} is automatically included in all example groups to add
+    # support for running specs async. Usually, rspec runners expect all
+    # examples to run synchronously, but this is not ideal in the case for
+    # Opal where a lot of underlying libraries expect the ability to run code
+    # in an asynchronous manner.
+    #
+    # This module defines an {AsyncHelpers::ClassMethods.async} method which
+    # can be used instead of `it` inside an example group, which marks the
+    # example as being async. This makes the runner wait for the example to
+    # complete.
+    #
+    #     describe "Some examples" do
+    #       it "normal example" do
+    #         # normal test code
+    #       end
+    #
+    #       async "async example" do
+    #         # this will wait until completion before moving on
+    #       end
+    #     end
+    #
+    # Marking an example as being async is only half the task. Examples will
+    # also have an instance {AsyncHelpers#async} method defined which is then
+    # used to complete the example. Any code run inside this block will run
+    # inside the context of the example.
+    #
+    #     describe "HTTP requests" do
+    #       async "might take a while" do
+    #         HTTP.get("/url/to/get") do |res|
+    #           async { expect(res).to be_ok }
+    #         end
+    #       end
+    #     end
+    #
+    # As soon as `async` is run inside the block, the example completes. This
+    # means that only 1 `async` call is allowed. However, you can use `async`
+    # multiple times aslong as it is only called once:
+    #
+    #     describe "HTTP requests" do
+    #       async "should work" do
+    #         HTTP.get("/users/1").then |res|
+    #           async { expect(res).to be_ok }
+    #         end.fail do
+    #           async { raise "this should not be called" }
+    #         end
+    #       end
+    #     end
+    #
+    # Here, a promise will either be accepted or rejected, so an `async` block
+    # can be used in each case as only 1 will be called.
+    #
+    # Another helper, {AsyncHelpers#delay} can also be used to run a block of
+    # code after a given time in seconds. This is useful to wait for animations
+    # or time restricted operations to occur.
+    module AsyncHelpers
+      module ClassMethods
+        # Define an async example method. This should be used instead of `it`
+        # to inform the spec runner that the example will need to wait for an
+        # {AsyncHelpers#async} method to complete the test. Any additional
+        # configuration options can be passed to this call, and they just get
+        # delegated to the underlying `#it` call.
+        #
+        # @example
+        #   describe "Some tests" do
+        #     async "should be async" do
+        #       # ... async code
+        #     end
+        #
+        #     it "should work with normal tests" do
+        #       expect(1).to eq(1)
+        #     end
+        #   end
+        #
+        # @param desc [String] description
+        def async(desc, *args, &block)
+          options = ::RSpec::Core::Metadata.build_hash_from(args)
+          Opal::RSpec::AsyncExample.register(self, desc, options, block)
+        end
       end
-    end
 
-    module AsyncHelpers
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # Must be used with {ClassMethods#async} to finish the async action. If
+      # this is not called inside the body then the spec runner will time out
+      # or the error might give a false positive as it is not caught inside
+      # the current example.
+      #
+      # @example Complete expectation after HTTP request
+      #   describe "HTTP calls" do
+      #     async "complete eventually" do
+      #       HTTP.get("/some_url") do |response|
+      #         async { expect(response).to be_ok }
+      #       end
+      #     end
+      #   end
+      #
       def async(&block)
         @example.continue_async(block)
       end
 
-      alias run_async async
-
+      # Runs the given block after a given duration. You are still required to
+      # use a {#async} block inside the delayed callback. This helper can be
+      # used to simulate IO delays, or just to wait for animations/other
+      # behaviour to finish.
+      #
+      # The `duaration` should be given in seconds, i.e. `1` means 1 second, or
+      # 0.3 means 300ms. The given block is just run after the time delay.
+      #
+      # @example
+      #   describe "Some interaction" do
+      #     async "takes a while to complete" do
+      #       task = start_long_task!
+      #
+      #       delay(1) do
+      #         async { expect(task).to be_completed }
+      #       end
+      #     end
+      #   end
+      #
+      # @param duration [Integer, Float] time in seconds to wait
       def delay(duration, &block)
         `setTimeout(block, duration * 1000)`
         self
       end
 
-      alias set_timeout delay
+      # Use {#async} instead.
+      #
+      # @deprecated
+      def run_async(&block)
+        async(&block)
+      end
+
+      # Use {#delay} instead.
+      #
+      # @deprecated
+      def set_timeout(*args, &block)
+        delay(*args, &block)
+      end
     end
 
+    # Runs all async examples from {AsyncExample.examples}.
     class AsyncRunner
       def initialize(runner, reporter, finish_block)
         @runner = runner
@@ -65,17 +186,31 @@ module Opal
       end
     end
 
+    # An {AsyncExample} is a subclass of regular example instances which adds
+    # support for running an example, and waiting for a non-sync outcome. All
+    # async examples in a set of spec files will get registered through
+    # {AsyncExample.register}, and added to the {AsyncExample.examples} array
+    # ready for the runner to run.
+    #
+    # You will not need to create new instances of this class directly, and
+    # should instead use {AsyncHelpers} to create async examples.
     class AsyncExample < ::RSpec::Core::Example
+      include AsyncHelpers
+
+      # Register new async example.
+      #
+      # @see AsyncHelpers::ClassMethods.async
       def self.register(*args)
         examples << new(*args)
       end
 
+      # All async examples in specs.
+      #
+      # @return [Array<AsyncExample>]
       def self.examples
         @examples ||= []
       end
 
-      include AsyncHelpers
-
       def run(example_group_instance, reporter, &after_run_block)
         @example_group_instance = example_group_instance
         @reporter               = reporter

data/opal/opal/rspec/fixes.rb

@@ -1,3 +1,10 @@
+# IO.closed? missing - BaseFormatter uses it for sync impl
+class IO
+  def closed?
+    false
+  end
+end
+
 # Opal defines enumerable#flat_map, but doesnt implement it
 module RSpec::Core::FlatMap
   def flat_map(array)
@@ -42,14 +49,6 @@ module RSpec
   end
 end
 
-# Opal does not yet support $1..$9 backrefs
-class RSpec::Matchers::BuiltIn::BePredicate
-  def prefix_and_expected(symbol)
-    symbol.to_s =~ /^(be_(an?_)?)(.*)/
-    return $~[1], $~[3]
-  end
-end
-
 module RSpec::ExampleGroups
   # opal cannot use mutable strings AND opal doesnt support `\A` or `\z` anchors
   def self.base_name_for(group)
@@ -96,3 +95,14 @@ class RSpec::Mocks::MethodDouble
     @original_method ||= @method_stasher.original_method
   end
 end
+
+# Missing on vendored rspec version
+module RSpec
+  module Core
+    module MemoizedHelpers
+      def is_expected
+        expect(subject)
+      end
+    end
+  end
+end

data/opal/opal/rspec/requires.rb

@@ -0,0 +1,45 @@
+require 'corelib/dir'
+require 'thread'
+
+require 'set'
+require 'time'
+require 'rbconfig'
+require 'pathname'
+
+# TODO: still needed? meh..
+require 'rspec/core/version'
+require 'rspec/core/flat_map'
+require 'rspec/core/filter_manager'
+require 'rspec/core/dsl'
+require 'rspec/core/reporter'
+require 'rspec/core/hooks'
+require 'rspec/core/memoized_helpers'
+require 'rspec/core/metadata'
+require 'rspec/core/pending'
+require 'rspec/core/formatters'
+require 'rspec/core/ordering'
+require 'rspec/core/world'
+require 'rspec/core/configuration'
+require 'rspec/core/option_parser'
+require 'rspec/core/configuration_options'
+require 'rspec/core/command_line'
+require 'rspec/core/runner'
+require 'rspec/core/example'
+require 'rspec/core/shared_example_group/collection'
+require 'rspec/core/shared_example_group'
+require 'rspec/core/example_group'
+
+require 'rspec/core/mocking/with_rspec'
+
+require 'rspec/support'
+require 'rspec/core'
+require 'rspec/expectations'
+require 'rspec/mocks'
+require 'rspec'
+
+# FIXME: still needed?
+require 'rspec/core/formatters/base_text_formatter'
+require 'rspec/core/formatters/html_printer'
+require 'rspec/matchers/pretty'
+require 'rspec/matchers/built_in/base_matcher'
+require 'rspec/matchers/built_in/be'

data/opal/opal/rspec.rb

@@ -4,29 +4,7 @@ end
 
 Test = MiniTest
 
-require 'file'
-require 'corelib/dir'
-require 'thread'
-
-require 'set'
-require 'time'
-require 'rbconfig'
-require 'pathname'
-
-# vendor a pre-built rspec
-require 'opal/rspec/rspec'
-
-# we "fix" these files, so require them now so they are loaded before our
-# fixes file. We can't use Kernel#require() directly as the compiler will
-# complain it can't find these files at compile time, but they are available
-# from rspec.js from the gem.
-%w[rspec
-  rspec/core/formatters/base_text_formatter
-  rspec/core/formatters/html_printer
-  rspec/matchers/pretty
-  rspec/matchers/built_in/base_matcher
-  rspec/matchers/built_in/be].each { |r| `self.$require(r)` }
-
+require 'opal/rspec/requires'
 require 'opal/rspec/fixes'
 require 'opal/rspec/text_formatter'
 require 'opal/rspec/browser_formatter'
@@ -39,7 +17,6 @@ RSpec.configure do |config|
 
   # Async helpers for specs
   config.include Opal::RSpec::AsyncHelpers
-  config.extend Opal::RSpec::AsyncDefinitions
 
   # Always support expect() and .should syntax (we should not do this really..)
   config.expect_with :rspec do |c|

data/opal-rspec.gemspec

@@ -11,11 +11,11 @@ Gem::Specification.new do |s|
   s.description  = 'Opal compatible rspec library'
 
   s.files = `git ls-files`.split("\n")
-  s.files << 'opal/opal/rspec/rspec.js'
 
   s.require_paths  = ['lib']
 
   s.add_dependency 'opal', '~> 0.7.0.beta1'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'yard'
 end
 

data/spec/async_spec.rb

@@ -1,5 +1,4 @@
 describe "Asynchronous helpers" do
-
   let(:foo) { 100 }
 
   before do
@@ -7,13 +6,13 @@ describe "Asynchronous helpers" do
   end
 
   async "can run examples async" do
-    run_async do
+    async do
       1.should == 1
     end
   end
 
   async "can access let() helpers and before() helpers" do
-    run_async do
+    async do
       foo.should eq(100)
       @model.should be_kind_of(Object)
     end
@@ -23,7 +22,7 @@ describe "Asynchronous helpers" do
     obj = [1, 2, 3, 4]
 
     delay(1) do
-      run_async { obj.should == [1, 2, 3, 4] }
+      async { obj.should == [1, 2, 3, 4] }
     end
   end
 
@@ -33,7 +32,7 @@ describe "Asynchronous helpers" do
     }.to raise_error(Exception)
 
     delay(0) do
-      run_async { expect(42).to eq(42) }
+      async { expect(42).to eq(42) }
     end
   end
 end

data/spec/matchers_spec.rb

@@ -179,3 +179,23 @@ describe "operator ==" do
     }.to raise_error(Exception)
   end
 end
+
+class PredicateTest
+  def foo?
+    true
+  end
+
+  def bar?
+    false
+  end
+end
+
+describe "predicate matchers" do
+  it "works with positive expectations" do
+    expect(PredicateTest.new).to be_foo
+  end
+
+  it "work with negative expectations" do
+    expect(PredicateTest.new).to_not be_bar
+  end
+end

data/spec/named_subject_spec.rb

@@ -0,0 +1,11 @@
+describe "named subject" do
+  subject(:named_subject) { [1, 2, 3] }
+
+  it "should be the subject" do
+    subject.should be_kind_of(Array)
+  end
+
+  it "should be the named subject" do
+    subject.should eql(named_subject)
+  end
+end

data/spec/should_syntax_spec.rb

@@ -0,0 +1,17 @@
+describe "One-liner should syntax" do
+  subject { 42 }
+
+  describe "should" do
+    it { should == 42 }
+    it { should_not == 43 }
+  end
+
+  describe "is_expected" do
+    it { is_expected.to eq(42) }
+    it { is_expected.to_not eq(43) }
+  end
+
+  describe "expect" do
+    it { expect(42).to eq(42) }
+  end
+end

data/vendor_lib/rspec/autorun.rb

@@ -0,0 +1,2 @@
+require 'rspec/core'
+RSpec::Core::Runner.autorun