opal-rspec 0.5.0.beta2 → 0.5.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c317905daac139b9a3b70651c7c9305a7279078f
-  data.tar.gz: 00b344281961f64460a8b667c2ac849c8de70b3d
+  metadata.gz: e305c2f7bb59109967cbb5289965f1768476df0b
+  data.tar.gz: b60ba2e8cf4f778bd45da0051a7484275e216564
 SHA512:
-  metadata.gz: 2c916613b1f125e6ee5f17cf56cee9c8e5f41bda97741c4deedc825f43c0d780533147c72c77d42d6a320d1ad51a54f62920b9dee84cfb8fa80ab8269285ec7c
-  data.tar.gz: de0c3fcf3536cc6f59bfc8c404f7f9d4e6c299e445fbaa2e240c970570493e6bc4bf03df40d8a441d67ffae5e445247fc2b833e42d4864ee5be6aec3a2195f98
+  metadata.gz: ddb89491fed04a63256e2cea28df2cd56a020adbd63b09325ff76f26166744695bebc0a30724a0f3570d07d5d0d96181ad2991276f9ea5ad92532f4c64504b49
+  data.tar.gz: 9f78bfdf6d812667149f8b978a2694c66227b1f42bdf01f1036424f476bc89fb78bdab62cc0dfc5b47d69766b75cccf7c66a74c8bac4ab78675eb5271beec3d9

data/.gitignore

@@ -2,3 +2,4 @@
 Gemfile.lock
 *.gem
 Gemfile.lock
+gemfiles/*.lock

data/.travis.yml

@@ -1,10 +1,26 @@
 language: ruby
 sudo: false
 
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+cache:
+  bundler: true
+
+matrix:
+  fast_finish: true
+
+  include:
+    - rvm: 1.9.3
+      env: RUN=default
+    - rvm: 2.0.0
+      env: RUN=default
+    - rvm: 2.1.0
+      env: RUN=default
+    - rvm: 2.2.3
+      env: RUN=default
+    - rvm: 2.2.3
+      env: RUN=default RUNNER=node
+    - rvm: 2.2.3
+      env: RUN=default
+      gemfile: gemfiles/opal_master.gemfile
 
 before_install:
   - git submodule update --init
@@ -15,3 +31,6 @@ before_script:
 
 notifications:
   irc: "irc.freenode.org#opal"
+
+script:
+  - "bundle exec rake $RUN"

data/CHANGELOG.md

@@ -4,7 +4,28 @@
 
 *   Update to RSpec 3.1 (core is 3.1.7, expectations/support 3.1.2, mocks 3.1.3)
 
-*   Remove copy of source (and just rely on git submodule fetch)
+*   Opal 0.9 compatibility
+
+*   A lot more aspects of RSpec should work now as 20+ Opal pull requests were completed from opal-rspec work
+
+*   Remove copy of source from opal-rspec git repo (and just rely on git submodule fetch)
+
+*   Rake task improvements:
+  * supports passing a test pattern (include and exclude) and FileLists besides 'spec/**/*_spec.rb
+  * colors, formatter, and additional requires can be supplied from the command line via the SPEC_OPTS environment variable
+
+*   Formatters:
+  * Fixed issues with RSpec's BaseTextFormatter and made ProgressFormatter the default when run via the Rake task
+  * Fix redundant messages with expectation fails
+  * Browser formatter now works w/ progress bar
+  * JSON formatter supported
+
+*   Fixed issues with constants/example group naming
+
+*   Basic nodejs runner support
+
+*   A lot more matchers enabled
+
 
 ## 0.4.3 (2015-06-14)
 

data/Gemfile

@@ -7,6 +7,13 @@ end
 
 # Opal 0.9 still in development
 # gem 'opal', git: 'https://github.com/opal/opal.git'
-gem 'rspec'
-gem 'capybara-webkit'
-gem 'selenium-webdriver'
+gem 'capybara-webkit', require: false
+gem 'selenium-webdriver', require: false
+
+# These need to come from our local path in order for create_requires.rb to work properly
+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

@@ -24,24 +24,92 @@ require 'opal/rspec/rake_task'
 Opal::RSpec::RakeTask.new(:default)
 ```
 
-Then, to run your specs inside phantomjs, just run the rake task:
+Then, to run your specs inside phantomjs (the default runner), just run the rake task:
 
 ```
 bundle exec rake
 ```
 
+Enable colors in the output
+
+```
+SPEC_OPTS="--color" bundle exec rake
+```
+
+Use a different formatter
+
+```
+SPEC_OPTS="--format json" bundle exec rake
+```
+
+The following formatters have been tested:
+* Default (progress)
+* Documentation
+* JSON
+
+If you need to specify additional requires for a custom formatter, you can do this:
+
+```
+SPEC_OPTS="--format SomeFormatter --require some_formatter" bundle exec rake
+```
+
+You can also customize the pattern of specs used similiar to how RSpec's rake task works:
+
+```ruby
+Opal::RSpec::RakeTask.new(:default) do |server, task|
+  # server is an instance of Opal::Server in case you want to add to the load path, customize, etc.
+  task.pattern = 'spec_alternate/**/*_spec.rb' # can also supply an array of patterns
+end
+```
+
+Excluding patterns can be setup this way:
+```ruby
+Opal::RSpec::RakeTask.new(:default) do |server, task|
+  task.exclude_pattern = 'spec_alternate/**/*_spec.rb' # can also supply an array of patterns
+end
+```
+
+FileLists (as in Rake FileLists) can also be supplied:
+
+```ruby
+Opal::RSpec::RakeTask.new(:default) do |server, task|
+  task.files = FileList['spec/**/something_spec.rb]
+end
+```
+
+PhantomJS will timeout by default after 60 seconds. If you need to lengthen the timeout value, set it like this:
+
+```ruby
+Opal::RSpec::RakeTask.new(:default) do |server, task|
+  task.files = FileList['spec/**/something_spec.rb]
+  task.timeout = 80000 # 80 seconds, unit needs to be milliseconds
+end
+```
+
+### Run specs in nodejs
+
+Same options as above, you can use the RUNNER=node environment variable or use the Rake task like so:
+
+```ruby
+Opal::RSpec::RakeTask.new(:default) do |server, task|
+  task.runner = :node
+end
+```
+
+NOTE: nodejs runner does not yet work with source maps or debug mode
+
 ### Run specs in a browser
 
 `opal-rspec` can use sprockets to build and serve specs over a simple rack
-server. Add the following to a `config.ru` file:
+server. Add the following to a `config.ru` file (see config.ru in this GEM):
 
 ```ruby
-require 'bundler'
-Bundler.require
-
-run Opal::Server.new { |s|
+require 'opal/rspec'
+# or use Opal::RSpec::SprocketsEnvironment.new(spec_pattern='spec/opal/**/*_spec.{rb,opal}') to customize the pattern
+sprockets_env = Opal::RSpec::SprocketsEnvironment.new
+run Opal::Server.new(sprockets: sprockets_env) { |s|
   s.main = 'opal/rspec/sprockets_runner'
-  s.append_path 'spec'
+  sprockets_env.add_spec_paths_to_sprockets
   s.debug = false
 }
 ```
@@ -114,8 +182,9 @@ end
 Advantages:
 * Assuming your subject under test (or matchers) return/use promises, the syntax is the same for sync or async specs
 
-Limitations:
+Limitations (apply to both async approaches):
 * Right now, async `before(:context)` and `after(:context)` hooks cannot be async
+* You cannot use an around hooks on any example where before(:each)/after(:each) hooks are async or with an async implicit subject
 * `let` dependencies cannot be async, only subject
 * Opal-rspec will not timeout while waiting for your async code to finish
 
@@ -125,13 +194,13 @@ This is the approach that was supported in opal-rspec <= 0.4.3 and it still work
 
 ```ruby
 describe MyClass2 do
-	async 'HTTP requests should work' do
-	  HTTP.get('/users/1.json') do |res|
-	    async {
-	      expect(res).to be_ok
-	    }
-	  end
-	end
+  async 'HTTP requests should work' do
+    HTTP.get('/users/1.json') do |res|
+      async {
+        expect(res).to be_ok
+      }
+    end
+  end
 end
 ```
 
@@ -145,42 +214,79 @@ Advantages:
 Disadvantages:
 * Requires different syntax for async specs vs. sync specs
 
-## Contributing
+## Opal load path
 
-Install required gems at required versions:
+NOTE: Only the deepest directory specified will be added to the Opal load path.
 
-    $ bundle install
+Example 1: For the example patterns above, only 'spec_alternate' will be added.
 
-opal-rspec uses a prebuilt version of rspec to fix the areas where
-opal cannot handle certain features of rspec. To build that file,
-which is needed to run specs, use:
+Example 2: Single base path
 
-    $ bundle exec rake build
+For a pattern of:
+```ruby
+'spec/other/**/*spec.rb'
+```
 
-This should build `opal/opal/rspec/rspec.js` ready to use.
+'spec/other' will be added to the load path.
 
-### Run on command line
+Example 3: Different base paths
 
-A simple rake task should run the example specs in `spec/`:
+Multiple patterns are specified that share the same parent:
 
-    $ bundle exec rake
+For a pattern of:
+```ruby
+['spec/opal/**/*hooks_spec.rb', 'spec/other/**/*_spec.rb']
+```
 
-### Run in the browser
+Only 'spec' will be added to the load path.
+
+## Other Limitations/Known Issues
+
+* Formatting
+  * Backtrace info on specs is buggy ([no Kernel::caller method in Opal](https://github.com/opal/opal/issues/894)), in Firefox w/ the browser runner, no backtraces show up with failed specs
+  * Diffs are not yet available when objects do not meet expectations (diff-lcs gem dependency has not been dealt with yet in Opal)
+* Configuration  
+  * Not all RSpec runner options are supported yet
+  * At some point, using node + Phantom's ability to read environment variables could be combined with a opal friendly optparse implementation to allow full options to be supplied/parsed
+  * Expect and should syntax are both enabled. They cannot be disabled due to bugs with the `undef` keyword in Opal 0.8. Status of changing this via config has not been tested in Opal 0.9.
+  * Random order does not work yet due to lack of [srand/Random support](https://github.com/opal/opal/issues/639) and RSpec's bundled Random implementation, `RSpec::Core::Backports::Random`, locks the browser/Phantom. If you specify random order, it will be ignored.
+* With Opal < 0.9, you can't access the example from named subject blocks (e.g. ```subject {|e| puts "example is #{e}" }```)
+* Nodejs runner
+  * debug mode + source map support not there yet (see source map support - https://github.com/evanw/node-source-map-support)
+  * currently running a lot slower than phantomjs, might need optimization
+* Matchers
+  * predicate matchers (be_some_method_on_your_subject) do not currently work with delegate objects (Opal `DelegateClass` is incomplete)
+  * operator based comparison, except for `==`, won't work on Opal 0.8 due to lack of method_missing support for operators. This works correctly in Opal 0.9.
+  * descriptions on aliased/negated matchers won't be like normal RSpec due to several bugs: method owner not being correct (not fixed yet), blocks passed after arguments and hash (fixed in Opal 0.9)
+  * equal and eq matchers function largely the same right now since `==` and `equal?` in Opal are largely the same
+  * time based matching is not yet tested
+  * arity checking is not enabled by default in Opal but it can be. It's not currently enabled because it broke a lot of Opal specs. As a result, any matcher use (particularly respond_to) that depends on arity checking will not work
+  * splat methods and expect(...).to respond_to will be inconsistent in Opal 0.8 since several splat bugs were fixed with Opal 0.9
+* Mocks
+  * `allow_any_instance/any_instance_of/any_instance` will not work and may cause runner to crash due to issues with redefining the `===` operator, which breaks a case statement inside `Hooks#find_hook`
+  * using expect/allow on `String`, `Number`, or any immutable bridged/native class, does not work since rspec-mocks uses singleton classes and those cannot be defined on immutable objects
+  * mocking class methods (including `::new`) is currently broken
+  * `class_double/class_spy` are not supported (it depends on `ClassVerifyingDouble` inheriting from `Module` to support transferring nested constants, but that doesn't work on Opal)
+  * `object_spy` is not supported (depends on proper initializer behavior in `ObjectVerifyingDoubleMethods`)
+  * verifying partial doubles do not fully work yet
+  * chaining and_return after do...end does not work
+  * duck_type argument matching is still buggy
+  * `and_throw` does not work on Opal 0.8 since throw/catch was not implemented until Opal 0.9
+* A lot of backports/monkey patches to Opal classes/methods are done to make this work on Opal 0.8. That means some things might work in your tests that do not work without opal-rspec. You can explore the opal/opal/rspec/fixes/opal directory to see what is being changed. All of the monkey patches check to see if the feature is "broken" before they apply themselves.
 
-Run attached rack app to handle building:
+## Contributing
 
-    $ bundle exec rackup
+Install required gems at required versions:
 
-Visit the page in any browser and view the console:
+    $ bundle install
 
-    $ open http://localhost:9292
+opal-rspec uses a bundled copy of rspec to fix the areas where
+opal cannot handle certain features of rspec. To build that file,
+which is needed to run specs, use:
 
-## Things to fix
+    $ git submodule update --init
 
-`opal/opal-rspec/fixes.rb` contains a few bug fixes that need to be merged upstream
-to opal itself. `app/rspec-builder.rb` is used to precompile rspec ready to be used
-in `opal-rspec`. All requires from `core.rb` have been inlined as opal cannot require
-dynamically at runtime.
+When updating the RSpec versions, after updating the submodule revisions, you may need to use the generate_requires Rake task in order to pre-resolve RSpec's dynamic requires
 
 ## License
 

data/Rakefile

@@ -1,11 +1,20 @@
 require 'bundler'
 require 'rspec/core/rake_task'
-Bundler.require
 
 Bundler::GemHelper.install_tasks
 
 require 'opal/rspec/rake_task'
-Opal::RSpec::RakeTask.new(:specs_via_rake)
+require_relative 'spec/rspec/core/core_spec_loader'
+require_relative 'spec/rspec/expectations/expectation_spec_loader'
+require_relative 'spec/rspec/support/support_spec_loader'
+require_relative 'spec/rspec/mocks/mocks_spec_loader'
+
+task :default => [:unit_specs, :verify_opal_specs, :integration_specs, :verify_rspec_specs]
+
+desc 'Runs a set of specs in opal'
+Opal::RSpec::RakeTask.new(:opal_specs) do |_, task|
+  task.pattern = 'spec/opal/**/*_spec.{rb,opal}'
+end
 
 desc 'Generates an RSpec requires file free of dynamic requires'
 task :generate_requires do
@@ -13,15 +22,52 @@ task :generate_requires do
   sh 'ruby -Irspec/lib -Irspec-core/lib/rspec -Irspec-support/lib/rspec util/create_requires.rb'
 end
 
-RSpec::Core::RakeTask.new :browser_specs do |t|
-  t.pattern = 'spec_mri/**/*_spec.rb'
+desc 'Runs a test to test browser based specs using Opal specs in spec/opal'
+RSpec::Core::RakeTask.new :integration_specs do |t|
+  t.pattern = 'spec/mri/integration/**/*_spec.rb'
+end
+
+desc 'Unit tests for MRI focused components of opal-rspec'
+RSpec::Core::RakeTask.new :unit_specs do |t|
+  t.pattern = 'spec/mri/unit/**/*_spec.rb'
+  t.exclude_pattern = 'spec/mri/unit/opal/rspec/opal/**/*'
+end
+
+desc 'A more limited spec suite to test pattern usage'
+Opal::RSpec::RakeTask.new(:other_specs) do |_, task|
+  task.pattern = 'spec/other/dummy_spec.rb'
 end
 
-task :default => [:verify_rake_specs, :browser_specs]
+Opal::RSpec::RakeTask.new(:color_on_by_default) do |_, task|
+  task.pattern = 'spec/other/color_on_by_default_spec.rb'
+end
+
+Opal::RSpec::CoreSpecLoader.rake_tasks_for(:rspec_core_specs)
+Opal::RSpec::ExpectationSpecLoader.rake_tasks_for(:rspec_expectation_specs)
+Opal::RSpec::SupportSpecLoader.rake_tasks_for(:rspec_support_specs)
+Opal::RSpec::MocksSpecLoader.rake_tasks_for(:rspec_mocks_specs)
 
-desc 'Will run a spec suite (rake specs_via_rake) and check for expected combination of failures and successes'
-task :verify_rake_specs do
-  test_output = `rake specs_via_rake`
+# These are done
+desc 'Verifies all RSpec specs'
+task :verify_rspec_specs => [
+         :verify_rspec_support_specs,
+         :verify_rspec_core_specs,
+         :verify_rspec_expectation_specs,
+         :verify_rspec_mocks_specs
+     ]
+
+desc 'Verifies other_spec_dir task ran correctly'
+task :verify_other_specs do
+  test_output = `rake other_specs`
+  unless /1 example, 0 failures/.match(test_output)
+    raise "Expected 1 passing example, but got output '#{test_output}'"
+  end
+  puts 'Test successful'
+end
+
+desc 'Will run a spec suite (rake opal_specs) and check for expected combination of failures and successes'
+task :verify_opal_specs do
+  test_output = `rake opal_specs`
   raise "Expected test runner to fail due to failed tests, but got return code of #{$?.exitstatus}" if $?.success?
   count_match = /(\d+) examples, (\d+) failures, (\d+) pending/.match(test_output)
   raise 'Expected a finished count of test failures/success/etc. but did not see it' unless count_match
@@ -46,73 +92,9 @@ task :verify_rake_specs do
     end
   end
 
-  expected_pending_count = 22
-
-  expected_failures= ['promise should make example fail properly before async block reached',
-                      'promise matcher fails properly',
-                      'promise non-assertion failure in promise no args',
-                      'promise non-assertion failure in promise string arg',
-                      'promise non-assertion failure in promise exception arg',
-                      'pending in example no promise would not fail otherwise, thus fails properly',
-                      'async/sync mix fails properly if a sync test is among async tests',
-                      'async/sync mix can finish running after a long delay and fail properly',
-                      'be_truthy fails properly with truthy values',
-                      'subject sync unnamed assertion fails properly should eq 43',
-                      'subject sync unnamed fails properly during subject create',
-                      'subject async assertion implicit fails properly should eq 43',
-                      'subject async fails properly during creation explicit async',
-                      'subject async fails properly during creation implicit usage',
-                      'subject async assertion explicit async fails properly',
-                      'hooks around sync fails after example should equal 42',
-                      'hooks around sync fails before example',
-                      'hooks around async fails after example after(:each) async fails sync match passes',
-                      'hooks around async fails after example after(:each) async passes sync match passes',
-                      'hooks around async fails after example after(:each) sync fails sync match passes',
-                      'hooks around async fails after example after(:each) sync passes sync match passes',
-                      'hooks around async fails after example before(:each) fails should not reach the example',
-                      'hooks around async fails after example matches another async match',
-                      'hooks around async fails after example matches async match',
-                      'hooks around async fails after example matches async match fails properly',
-                      'hooks around async fails after example matches sync fails properly',
-                      'hooks around async fails after example matches sync match',
-                      'hooks around async fails before example after(:each) async fails sync match passes',
-                      'hooks around async fails before example after(:each) async passes sync match passes',
-                      'hooks around async fails before example after(:each) sync fails sync match passes',
-                      'hooks around async fails before example after(:each) sync passes sync match passes',
-                      'hooks around async fails before example before(:each) fails should not reach the example',
-                      'hooks around async fails before example matches another async match',
-                      'hooks around async fails before example matches async match',
-                      'hooks around async fails before example matches async match fails properly',
-                      'hooks around async fails before example matches sync fails properly',
-                      'hooks around async fails before example matches sync match',
-                      'hooks around async succeeds after(:each) async fails sync match passes',
-                      'hooks around async succeeds after(:each) sync fails sync match passes',
-                      'hooks around async succeeds before(:each) fails should not reach the example',
-                      'hooks around async succeeds matches async match fails properly',
-                      'hooks around async succeeds matches sync fails properly',
-                      'hooks before async with async subject async match fails properly',
-                      'hooks before async with async subject before :each fails properly should not reach the example',
-                      'hooks before async with async subject before :each succeeds, assertion fails properly should not eq 42',
-                      'hooks before async with async subject before :each succeeds, subject fails properly should not reach the example',
-                      'hooks before async with async subject both subject and before(:each) fail properly should not reach the example',
-                      'hooks before async with sync subject async match fails properly',
-                      'hooks before async with sync subject before :each fails properly should not reach the example',
-                      'hooks before async with sync subject match fails properly should not eq 42',
-                      'hooks before sync with sync subject context fails properly should not reach the example',
-                      'hooks before sync with sync subject before :each fails properly should not reach the example',
-                      'hooks before sync with sync subject match fails properly should not eq 42',
-                      'hooks before sync with sync subject first before :each in chain triggers failure inner context should not reach the example',
-                      'hooks after sync after fails should eq 42',
-                      'hooks after sync before fails should not reach the example',
-                      'hooks after sync match fails async match',
-                      'hooks after sync match fails sync match should eq 43',
-                      'hooks after async after(:each) fails properly',
-                      'hooks after async before(:each) fails properly',
-                      'hooks after async match fails properly async match',
-                      'hooks after async match fails properly sync match should eq 43',
-                      'exception handling should fail properly if an exception is raised',
-                      'exception handling should ignore an exception after a failed assertion',
-                      'legacy async fails properly after a long delay'].sort
+  expected_pending_count = 12
+  expected_failures = File.read('spec/opal/expected_failures.txt').split("\n").compact.sort
+
   if actual_failures != expected_failures
     unexpected = actual_failures - expected_failures
     missing = expected_failures - actual_failures
@@ -124,7 +106,51 @@ task :verify_rake_specs do
 
   if failure_messages.empty?
     puts 'Test successful!'
+    puts "#{total} total specs, #{failed} expected failures, #{pending} expected pending"
   else
     raise "Test failed, reasons:\n\n#{failure_messages.join("\n")}\n"
   end
 end
+
+desc "Build build/opal-rspec.js"
+task :dist do
+  require 'fileutils'
+  FileUtils.mkdir_p 'build'
+
+  builder = Opal::Builder.new(stubs: Opal::Processor.stubbed_files, # stubs already specified in lib/opal/rspec.rb
+                              compiler_options: {dynamic_require_severity: :ignore}) # RSpec is full of dynamic requires
+  src = builder.build('opal-rspec')
+
+  min = uglify src
+  gzp = gzip min
+
+  File.open('build/opal-rspec.js', 'w+') do |out|
+    out << src
+  end
+
+  puts "development: #{src.size}, minified: #{min.size}, gzipped: #{gzp.size}"
+end
+
+# Used for uglifying source to minify
+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
+
+# Gzip code to check file size
+def gzip(str)
+  IO.popen('gzip -f', 'r+') do |i|
+    i.puts str
+    i.close_write
+    return i.read
+  end
+rescue Errno::ENOENT
+  $stderr.puts '"gzip" command not found, it is required to produce the .gz version'
+  nil
+end