opal-rspec 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23bf8d729fbc2c2e9744acce64d22afca3bf463dfb46e08f6cd1c56de23d4582
-  data.tar.gz: 957fc9a45cbc3eba184581c98932b0b5cbe2db0fb2cee7eedac55a3f04c6390e
+  metadata.gz: c68bbe588e9f4799786a07239f9b09201d9ff8852eba3d0427d475d2c7d26eb4
+  data.tar.gz: f879318367b656f9da5068088a05093d02aa0ff30271b4886983e1f007e310ff
 SHA512:
-  metadata.gz: c83250a2ac319e1b17a8d71cf3ca78c974a1bb8f57730418b58f74bd9a0bad42816804b091a1d4aa017d081c69a6da45b0e653597825a980a72e85482fe05e21
-  data.tar.gz: 46083eb69027ff18304bbfec9d02ebb48c3d9b61509973e1e04e8f8269857b35ea3c445c1773a45eaf7897634ce2fc86bfc6ff970598e04c44277f49fed60115
+  metadata.gz: 151736466857ed69765cac6061530352e9c43a37323a0c2cc5b75acffbddf2f4cccffe5dcd6d48e6ef1aa8ac88962fe2be6f38e283758adb5a76562823faec42
+  data.tar.gz: b68d39d4ac974ccfa7893995e117329ffeaaf56e0f3999e8a39648a8d03e24e46f1bcd927df537618fba69348ccad9e576f0fae3864f95fe0a68c1e646f0133d

data/.github/workflows/build.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - master
       - "*-stable"
-      - "*ci-check"
+      - "*/ci-check"
   pull_request:
     branches:
       - master
@@ -15,8 +15,8 @@ jobs:
     strategy:
       matrix:
         os: [ 'ubuntu-latest' ]
-        ruby: [ 2.7, 2.6, 2.5, ruby-head ]
-        opal: [ 1.0.3 ]
+        ruby: [ ruby-head, 3.1, "3.0", 2.7 ]
+        opal: [ master, 1.6.alpha1 ]
 
     runs-on: ${{ matrix.os }}
 
@@ -30,7 +30,7 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
       - name: Setup project
         run: bin/setup
-      - name: Run test
-        run:
-          - "bundle exec exe/opal-rspec spec-opal-passing"
-          - "bundle exec rspec"
+      - name: Run opal-rspec test
+        run: "bundle exec exe/opal-rspec spec-opal-passing"
+      - name: Run rspec test
+        run: bundle exec rspec

data/.gitmodules

@@ -13,3 +13,9 @@
 [submodule "rspec-expectations"]
 	path = rspec-expectations/upstream
 	url = https://github.com/rspec/rspec-expectations.git
+[submodule "diff-lcs/diff-lcs/upstream"]
+	path = diff-lcs/diff-lcs/upstream
+	url = https://github.com/halostatue/diff-lcs
+[submodule "diff-lcs/upstream"]
+	path = diff-lcs/upstream
+	url = https://github.com/halostatue/diff-lcs

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Opal-RSpec Changelog
 
+## 1.0.0 - 2022-11-24
+
+- Drop support for anything below Opal v1.6.alpha1
+
+- Update to the latest RSpec versions
+
+- Vendor-in `diff-lcs`
+
+- Rework the async logic to use the `await` feature of Opal
+  * If you use async features, it's crucial to use a `# await: *await*` magic comment (this will cause any call to a method containing an `await` word to be compiled with an `await` ES8 keyword)
+  * Both `let` and `subject` that return a promise (ie. are async) must be referenced with an `.await` method
+  * In `around` blocks, you must call `example.run_await` instead of just `example.run`
+  * Only `PromiseV2` is supported (`PromiseV1` may work, but you should migrate your application to use `PromiseV2` nevertheless, in Opal 2.0 it will become the default)
+
+- Drop a requirement of `opal-sprockets`
+  * Sprockets support is still provided, but you need to manually `require "opal/rspec/sprockets"`
+
+
 ## 0.8.0 - 2021-12-01
 
 - Support for Opal v1.x

data/Gemfile

@@ -13,3 +13,16 @@ gem 'rspec-mocks',        path: 'rspec-mocks/upstream'
 gem 'rspec-expectations', path: 'rspec-expectations/upstream'
 
 gem 'pry'
+
+case ENV['OPAL_VERSION']
+when 'local'
+  gem 'opal', path: '../opal'
+when /^[0-9]/
+  gem 'opal', ENV['OPAL_VERSION']
+when String
+  gem 'opal', git: 'https://github.com/opal/opal.git', branch: ENV['OPAL_VERSION']
+end
+
+gem 'opal-sprockets', '>=1.0'
+
+gem 'puma'

data/README.md

@@ -1,8 +1,8 @@
 # opal-rspec
 
 [![Build Status](http://img.shields.io/travis/opal/opal-rspec/master.svg?style=flat)](http://travis-ci.org/opal/opal-rspec)
-[![Quality](http://img.shields.io/codeclimate/github/opal/opal-rspec.svg?style=flat-square)](https://codeclimate.com/github/opal/opal-rspec)
-[![Version](http://img.shields.io/gem/v/opal-rspec.svg?style=flat-square)](https://rubygems.org/gems/opal-rspec)
+[![Quality](https://img.shields.io/codeclimate/maintainability-percentage/opal/opal-rspec.svg?style=flat)](https://codeclimate.com/github/opal/opal-rspec)
+[![Version](http://img.shields.io/gem/v/opal-rspec.svg?style=flat)](https://rubygems.org/gems/opal-rspec)
 
 An attempt at a compatibility layer of RSpec for Opal.
 
@@ -37,20 +37,21 @@ bundle exec opal-rspec --color spec-opal/
 ## Requirements
 
 Besides what's already reflected in the GEM dependencies:
-* PhantomJS 2.0 or 2.1 for Rake task testing
 * Browser if you want to run and debug tests that way
 
-### Run specs in phantomjs
+### Run specs in Headless Chromium
 
 To run specs, a rake task can be added which will load all spec files from
-`spec/`:
+`spec-opal/`:
 
 ```ruby
 require 'opal/rspec/rake_task'
-Opal::RSpec::RakeTask.new(:default)
+Opal::RSpec::RakeTask.new(:default) do |server, task|
+  task.runner = :chrome
+end
 ```
 
-Then, to run your specs inside phantomjs (the default runner), just run the rake task:
+Then, to run your specs inside headless chrome (the default runner), just run the rake task:
 
 ```
 bundle exec rake
@@ -83,6 +84,7 @@ You can also customize the pattern of specs used similiar to how RSpec's rake ta
 
 ```ruby
 Opal::RSpec::RakeTask.new(:default) do |server, task|
+  task.runner = :chrome
   # 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
   # NOTE: opal-rspec, like rspec, only adds 'spec' to the Opal load path unless you set default_path
@@ -94,6 +96,8 @@ Excluding patterns can be setup this way:
 
 ```ruby
 Opal::RSpec::RakeTask.new(:default) do |server, task|
+  task.runner = :chrome
+
   task.exclude_pattern = 'spec_alternate/**/*_spec.rb' # can also supply an array of patterns
 end
 ```
@@ -102,14 +106,18 @@ FileLists (as in Rake FileLists) can also be supplied:
 
 ```ruby
 Opal::RSpec::RakeTask.new(:default) do |server, task|
+  task.runner = :chrome
+
   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:
+Headless Chromium 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.runner = :chrome
+
   task.files = FileList['spec/**/something_spec.rb']
   task.timeout = 80000 # 80 seconds, unit needs to be milliseconds
 end
@@ -119,13 +127,18 @@ Arity checking is enabled by default. Opal allows you to disable arity checking
 
 ```ruby
 Opal::RSpec::RakeTask.new(:default) do |server, task|
+  task.runner = :chrome
+
   task.arity_checking = :disabled
 end
 ```
 
-### Run specs in nodejs
+If you don't specify a runner using `task.runner`, a default one is Node. In this case you can also use `RUNNER=chrome` to run a particular test with Headless Chromium.
+
+### Run specs in Node.js
 
-Same options as above, you can use the `RUNNER=node` environment variable or use the Rake task like so:
+Same options as above, you can use the `RUNNER=node` environment variable
+(which is the default) or use the Rake task like so:
 
 ```ruby
 Opal::RSpec::RakeTask.new(:default) do |server, task|
@@ -133,21 +146,30 @@ Opal::RSpec::RakeTask.new(:default) do |server, task|
 end
 ```
 
-NOTE: nodejs runner does not yet work with source maps or debug mode
-
 ### Run specs in a browser
 
+Same options as above, you can use the `RUNNER=server` environment variable
+(which is the default) or use the Rake task like so:
+
+```ruby
+Opal::RSpec::RakeTask.new(:default) do |server, task|
+  task.runner = :server
+end
+```
+
+### Run specs in a browser (Sprockets, deprecated)
+
 `opal-rspec` can use sprockets to build and serve specs over a simple rack
 server. Add the following to a `config.ru` file (see config.ru in this GEM):
 
 ```ruby
-require 'opal/rspec'
+require 'opal/rspec/sprockets'
 # 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'
   sprockets_env.add_spec_paths_to_sprockets
-  s.debug = false
+  s.debug = true
 }
 ```
 
@@ -160,14 +182,13 @@ to navigate to where an exception occurred.
 
 ## Async examples
 
-`opal-rspec` adds support for async specs to rspec. These specs can be defined using 2 approaches:
+`opal-rspec` adds support for async specs to rspec.
 
-1. Promises returned from subject or the `#it` block (preferred)
-1. `#async` instead of `#it` (in use with opal-rspec <= 0.4.3)
+```ruby
+# await: *await*
 
-### Promise approach
+require 'opal/rspec/async'
 
-```ruby
 describe MyClass do
   # normal example
   it 'does something' do
@@ -176,7 +197,7 @@ describe MyClass do
 
   # async example
   it 'does something else, too' do
-    promise = Promise.new
+    promise = PromiseV2.new
     delay 1 do
       expect(:foo).to eq(:foo)
       promise.resolve
@@ -197,7 +218,7 @@ describe MyClass2 do
   # will wait for the before promise to complete before proceeding
   before do
     delay_with_promise 0 do
-      puts 'async before 'action
+      puts 'async before action'
     end
   end
 
@@ -208,12 +229,12 @@ describe MyClass2 do
     end
   end
 
-  it { is_expected.to eq 42 }
+  it { expect(subject.await).to eq 42 }
 
   # If you use an around block and have async specs, you must use this approach
   around do |example|
     puts 'do stuff before'
-    example.run.then do
+    example.run_await.then do
       puts 'do stuff after example'
     end
   end
@@ -222,42 +243,18 @@ end
 
 Advantages:
 
-* Assuming your subject under test (or matchers) return/use promises, the syntax is the same for sync or async specs
+* Assuming your subject under test (or matchers) return/use promises, or uses `await` syntax, the syntax is the same for sync or async specs
 
-Limitations (apply to both async approaches):
+Limitations:
 
-* 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
 
-### Async/it approach
-
-This is the approach that was supported in opal-rspec <= 0.4.3 and it still works.
+Changes since 1.0:
 
-```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
-end
-```
-
-The block passed to the second `async` call informs the runner that this spec is finished
-so it can move on. Any failures/expectations run inside this block will be run
-in the context of the example.
-
-Advantages:
-
-* Hides promises from the specs
-
-Disadvantages:
-
-* Requires different syntax for async specs vs. sync specs
+* If you use async features, it's crucial to use a `# await: *await*` magic comment (this will cause any call to a method containing an `await` word to be compiled with an `await` ES8 keyword)
+* Both `let` and `subject` that return a promise (ie. are async) must be referenced with an `.await` method
+* In `around` blocks, you must call `example.run_await` instead of just `example.run`
+* Only `PromiseV2` is supported (`PromiseV1` may work, but you should migrate your application to use `PromiseV2` nevertheless, in Opal 2.0 it will become the default)
 
 ## Opal load path
 
@@ -277,9 +274,19 @@ Opal::RSpec::RakeTask.new do |server, task|
 end
 ```
 
+Since 0.8, the default spec location is `spec-opal` and the default source location is `lib-opal`. If your code aims to run the same specs and libraries for Ruby and Opal, you should use the following:
+
+```ruby
+Opal::RSpec::RakeTask.new do |server, task|
+  server.append_path 'lib'
+  task.default_path = 'spec'
+  task.files = FileList['spec/**/*_spec.rb']
+end
+```
+
 ## Other Limitations/Known Issues
 
-80%+ of the RSpec test suites pass so most items work but there are a few things that do not yet work.
+80%+ of the RSpec test suites pass so most items work but there are a few things that do not yet work. Do note that some of the items described here may actually work in the recent version.
 
 * Core Examples
   * Example groups included like this are currently not working:
@@ -301,15 +308,11 @@ end
 * Formatting/Reporting
   * Specs will not have file path/line number information on them unless they are supplied from user metadata or they fail, see [this issue](https://github.com/opal/opal-rspec/issues/36)
   * 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 past bugs with the `undef` keyword in Opal. Status of changing this via config has not been retested.
   * 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.
-* 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)
   * equal and eq matchers function largely the same right now since `==` and `equal?` in Opal are largely the same
@@ -344,6 +347,7 @@ When updating the RSpec versions, after updating the submodule revisions, you ma
 
 (The MIT License)
 
+Copyright (C) 2022 by hmdne and the Opal contributors
 Copyright (C) 2015 by Brady Wied
 Copyright (C) 2013 by Adam Beynon
 

data/diff-lcs/spec/files_to_exclude.txt

@@ -0,0 +1 @@
+**/ldiff_spec.rb

data/diff-lcs/spec/requires.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  config.add_formatter RSpec::Core::Formatters::JsonFormatter, File.open('/tmp/diff-lcs-results.json', 'w')
+  config.add_formatter RSpec::Core::Formatters::ProgressFormatter, $stdout
+end

data/diff-lcs/upstream/.autotest

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+
+# vim: ft=ruby

data/diff-lcs/upstream/.fasterer.yml

@@ -0,0 +1,3 @@
+exclude_paths:
+  - research/**/*
+  - pkg/**/*

data/diff-lcs/upstream/.github/workflows/ci.yml

@@ -0,0 +1,64 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os:
+          - macos-10.15
+          - macos-11
+          - ubuntu-20.04
+        ruby:
+          - '2.4'
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - head
+          - jruby
+          - jruby-head
+          - truffleruby
+          - truffleruby-head
+          - truffleruby+graalvm
+          - truffleruby+graalvm-head
+        include:
+          - ruby: head
+            continue-on-error: true
+          - ruby: jruby-head
+            continue-on-error: true
+          - os: windows-latest
+            ruby: mingw
+          - os: windows-latest
+            ruby: mswin
+          - os: windows-latest
+            ruby: jruby
+            continue-on-error: true
+          - os: ubuntu-22.04
+            ruby: head
+          - os: ubuntu-22.04
+            ruby: '3.1'
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.continue-on-error || false }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          rubygems: latest
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec ruby -S rake test --trace

data/diff-lcs/upstream/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: 'CodeQL'
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+  schedule:
+    - cron: '28 4 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ['ruby']
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

data/diff-lcs/upstream/.gitignore

@@ -0,0 +1,20 @@
+*.pyc
+*.rbc
+*.swp
+*~
+.DS_Store
+.rake_tasks~
+.rvmrc
+.source_index
+Gemfile.lock
+coverage.info
+coverage.vim
+coverage/
+doc/
+html/
+pkg/
+publish/
+research/
+spec/ldap.yml
+website/index.html
+.byebug_history

data/diff-lcs/upstream/.hoerc

@@ -0,0 +1,52 @@
+---
+exclude: !ruby/regexp '/
+  \.(?:
+    tmp |
+    swp
+  )$
+  |
+  \.(?:
+      bundle|
+      git|
+      github|
+      hg|
+      idea|
+      svn|
+      vagrant
+    )\/
+  |
+  [gG]emfile(?:\.lock)?
+  |
+  (?:
+    support |
+    research
+  )\/
+  |
+  \.(?:
+    appveyor |
+    coveralls |
+    fasterer |
+    pullreview |
+    rubocop.* |
+    travis |
+    unused
+    )\.yml$
+  |
+  (?i:TAGS)$
+  |
+  \.(?:
+      DS_Store |
+      autotest |
+      byebug_history |
+      gemtest |
+      gitattributes |
+      gitignore |
+      hoerc |
+      minitest.rb |
+      simplecov-prelude.rb
+  )$
+  |
+  \.gemspec$
+  |
+  ^Vagrantfile$
+  /x'

data/diff-lcs/upstream/.rspec

@@ -0,0 +1 @@
+--colour

data/diff-lcs/upstream/.standard.yml

@@ -0,0 +1,6 @@
+parallel: true
+ruby_version: 2.0
+ignore:
+  - 'diff-lcs.gemspec'
+  - 'research/**/*'
+  - 'pkg/**/*'