opal-connect-rspec 0.5.0

data/Rakefile

@@ -0,0 +1,169 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+require 'opal/rspec/rake_task'
+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 => [:phantom_node_ver,
+                  :unit_specs,
+                  :verify_opal_specs,
+                  :integration_specs,
+                  :verify_rspec_specs]
+
+task :phantom_node_ver do
+  sh 'phantomjs -v'
+  sh 'node -v'
+  sh 'firefox --version'
+end
+
+desc 'Runs a set of specs in opal'
+Opal::RSpec::RakeTask.new(:opal_specs) do |_, task|
+  task.pattern = 'spec/opal/**/*_spec.{rb,opal}'
+  task.default_path = 'spec/opal'
+end
+
+desc 'Generates an RSpec requires file free of dynamic requires'
+task :generate_requires do
+  # Do this free of any requires used to make this Rake task happen
+  sh 'ruby -Irspec/lib -Irspec-core/lib/rspec -Irspec-support/lib/rspec util/create_requires.rb'
+end
+
+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'
+  task.default_path = 'spec/other'
+end
+
+Opal::RSpec::RakeTask.new(:color_on_by_default) do |_, task|
+  task.pattern = 'spec/other/color_on_by_default_spec.rb'
+  task.default_path = 'spec/other'
+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)
+
+# 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
+  total, failed, pending = count_match.captures
+
+  actual_failures = []
+  test_output.scan /\d+\) (.*)/ do |match|
+    actual_failures << match[0].strip
+  end
+  actual_failures.sort!
+
+  failure_messages = []
+
+  bad_strings = [/.*is still running, after block problem.*/,
+                 /.*should not have.*/,
+                 /.*Expected \d+ after hits but got \d+.*/,
+                 /.*Expected \d+ around hits but got \d+.*/]
+
+  bad_strings.each do |regex|
+    test_output.scan(regex) do |match|
+      failure_messages << "Expected not to see #{regex} in output, but found match #{match}"
+    end
+  end
+
+  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
+    failure_messages << "Expected test failures do not match actual\n"
+    failure_messages << "\nUnexpected fails:\n#{unexpected.join("\n")}\n\nMissing fails:\n#{missing.join("\n")}\n\n"
+  end
+
+  failure_messages << "Expected #{expected_pending_count} pending examples but actual was #{pending}" unless pending == expected_pending_count.to_s
+
+  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

data/config.ru

@@ -0,0 +1,15 @@
+require 'opal/rspec'
+
+Opal::Processor.source_map_enabled = false
+
+sprockets_env = Opal::RSpec::SprocketsEnvironment.new(spec_pattern='spec/opal/**/*_spec.{rb,opal}',
+                                                      spec_exclude_pattern=nil,
+                                                      spec_files=nil,
+                                                      default_path='spec/opal')
+run Opal::Server.new(sprockets: sprockets_env) { |s|
+      s.main = 'sprockets_runner_js_errors'
+      # sprockets_runner_js_errors will not be in the opal load path by default
+      s.append_path 'spec/mri/integration/rack'
+      sprockets_env.add_spec_paths_to_sprockets
+      s.debug = ENV['OPAL_DEBUG']
+    }

data/example/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'opal-rspec', :path => '../'

data/example/README.md

@@ -0,0 +1,13 @@
+# opal-spec example
+
+Install dependencies:
+
+```
+bundle install
+```
+
+Run examples:
+
+```
+bundle exec rake
+```

data/example/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler.require
+
+# Add our opal/ directory to the load path
+Opal.append_path File.expand_path('../opal', __FILE__)
+
+require 'opal/rspec/rake_task'
+Opal::RSpec::RakeTask.new(:default)

data/example/opal/user.rb

@@ -0,0 +1,11 @@
+class User
+  attr_accessor :name
+
+  def initialize(name)
+    @name = name
+  end
+
+  def admin?
+    @name == 'Bob'
+  end
+end

data/example/spec/user_spec.rb

@@ -0,0 +1,15 @@
+require 'user'
+
+describe User do
+  it '#initialize accepts a name' do
+    expect(User.new('Jim').name).to eq('Jim')
+  end
+
+  it 'is an admin if name is Bob' do
+    expect(User.new('Bob')).to be_admin
+  end
+
+  it 'is not an admin if name is not Bob' do
+    expect(User.new('Jim')).to_not be_admin
+  end
+end

data/gemfiles/opal_master.gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+gemspec path: '../'
+
+unless Dir['rspec{,-{core,expectations,mocks,support}}'].any?
+  warn 'Run: "git submodule update --init" to get RSpec sources'
+end
+
+gem 'opal', git: 'https://github.com/opal/opal.git'
+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/lib/opal-rspec.rb

@@ -0,0 +1,2 @@
+require 'opal/rspec'
+

data/lib/opal/rspec.rb

@@ -0,0 +1,39 @@
+require 'opal'
+require 'opal/rspec/version'
+require 'opal/rspec/sprockets_environment'
+
+# Just register our opal code path with opal build tools
+Opal.append_path File.expand_path('../../../opal', __FILE__)
+
+# Catch our git submodule included directories
+%w{rspec rspec-core rspec-expectations rspec-mocks rspec-support}.each do |gem|
+  Opal.append_path File.expand_path("../../../#{gem}/lib", __FILE__)
+end
+
+# Since we have better specs than before (and a script to deal with this), ignoring
+Opal::Processor.dynamic_require_severity = :ignore
+
+stubs = [
+  'mutex_m', # Used with some threading operations but seems to run OK without this
+  'prettyprint',
+  'tempfile', # Doesn't exist in Opal
+  'diff/lcs',
+  'diff/lcs/block',
+  'diff/lcs/callbacks',
+  'diff/lcs/change',
+  'diff/lcs/hunk',
+  'diff/lcs/internals',
+  'test/unit/assertions',
+  # Opal doesn't have optparse, yet
+  'optparse',
+  'shellwords',
+  'socket',
+  'uri',
+  'drb/drb',
+  'cgi/util',
+  'minitest', # RSpec uses require to see if minitest is there, opal/sprockets won't like that, so stub it
+  'minitest/unit',
+  'minitest/assertions'
+]
+
+stubs.each {|mod| Opal::Processor.stub_file mod }

data/lib/opal/rspec/cached_environment.rb

@@ -0,0 +1,25 @@
+require 'sprockets'
+require 'opal/rspec/post_rack_locator'
+
+module Opal
+  module RSpec
+    class CachedEnvironment < ::Sprockets::CachedEnvironment
+      # this class is accessible from the ERB/runner file
+
+      def initialize(env, pre_run_locator)
+        super env
+        @locator = RSpec::PostRackLocator.new(pre_run_locator)
+      end
+
+      def get_opal_spec_requires
+        @locator.get_opal_spec_requires.map do |file|
+          asset = find_asset(file)
+          raise "Unable to find asset for file #{file} within load paths #{paths}. Check your load path/file specification." unless asset
+          logical_path = asset.logical_path
+          # These will go directly into require '...' statements in Opal, so need to trim extensions
+          logical_path.sub File.extname(logical_path), ''
+        end
+      end
+    end
+  end
+end

data/lib/opal/rspec/post_rack_locator.rb

@@ -0,0 +1,20 @@
+require 'rake'
+
+module Opal
+  module RSpec
+    class PostRackLocator
+      def initialize(pre_run_locator)
+        @spec_pattern = pre_run_locator.spec_pattern
+        @spec_exclude_pattern = pre_run_locator.spec_exclude_pattern
+        @spec_files = pre_run_locator.spec_files
+      end
+
+      def get_opal_spec_requires
+        files = @spec_files || FileList[*@spec_pattern].exclude(*@spec_exclude_pattern)
+        files.uniq.map do |file|
+          File.expand_path file
+        end
+      end
+    end
+  end
+end

data/lib/opal/rspec/pre_rack_locator.rb

@@ -0,0 +1,32 @@
+require 'pathname'
+# require the bundled RSpec's file and don't rely on the load path in case opal-rspec is included in a project's
+# Gemfile without rspec also being in the Gemfile
+require_relative '../../../rspec-core/lib/rspec/core/ruby_project'
+
+module Opal
+  module RSpec
+    class PreRackLocator
+      include ::RSpec::Core::RubyProject
+
+      DEFAULT_PATTERN = 'spec/**/*_spec.{rb,opal}'
+      DEFAULT_DEFAULT_PATH = 'spec'
+
+      attr_accessor :spec_pattern, :spec_exclude_pattern, :spec_files, :default_path
+
+      def initialize(spec_pattern=nil, spec_exclude_pattern=nil, spec_files=nil, default_path=nil)
+        @spec_pattern = spec_pattern || DEFAULT_PATTERN
+        @spec_exclude_pattern = spec_exclude_pattern
+        @spec_files = spec_files
+        @default_path = default_path || DEFAULT_DEFAULT_PATH
+      end
+
+      def determine_root
+        find_first_parent_containing(@default_path) || '.'
+      end
+
+      def get_spec_load_paths
+        [@default_path].map { |dir| File.join(root, dir) }
+      end
+    end
+  end
+end

data/lib/opal/rspec/rake_task.rb

@@ -0,0 +1,132 @@
+require 'opal/rspec'
+require 'tempfile'
+require 'socket'
+
+module Opal
+  module RSpec
+    class RakeTask
+      include Rake::DSL if defined? Rake::DSL
+
+      RUNNER = File.expand_path('../../../../vendor/spec_runner.js', __FILE__)
+      PORT = 9999
+      URL = "http://localhost:#{PORT}/"
+
+      attr_accessor :pattern, :exclude_pattern, :files, :default_path, :runner, :timeout
+
+      def launch_phantom(timeout_value)
+        command_line = %Q{phantomjs #{RUNNER} "#{URL}"#{timeout_value ? " #{timeout_value}" : ''}}
+        puts "Running #{command_line}"
+        system command_line
+        success = $?.success?
+
+        exit 1 unless success
+      end
+
+      def runner
+        ((via_env = ENV['RUNNER']) && via_env.to_sym) || @runner || :phantom
+      end
+
+      def get_load_asset_code(server)
+        sprockets = server.sprockets
+        name = server.main
+        asset = sprockets[name]
+        raise "Cannot find asset: #{name}" if asset.nil?
+        Opal::Processor.load_asset_code(sprockets, name)
+      end
+
+      # TODO: Avoid the Rack server and compile directly
+      def launch_node(server)
+        compiled = Tempfile.new 'opal_rspec.js'
+        begin
+          uri = URI(URL)
+          Net::HTTP.start uri.hostname, uri.port do |http|
+            resp = http.get File.join('/assets', server.main)
+            compiled.write resp.body
+            load_asset_code = get_load_asset_code server
+            compiled.write load_asset_code
+            compiled.close
+          end
+          command_line = "node #{compiled.path} 2>&1"
+          puts "Running #{command_line}"
+          system command_line
+          exit 1 unless $?.success?
+        ensure
+          compiled.close unless compiled.closed?
+          compiled.unlink
+        end
+      end
+
+      def wait_for_server
+        # avoid retryable dependency
+        tries = 0
+        up = false
+        uri = URI(URL)
+        while tries < 4 && !up
+          tries += 1
+          sleep 0.1
+          begin
+            # Using TCPSocket, not net/http open because executing the HTTP GET / will incur a decent delay just to check if the server is up
+            # in order to better communicate to the user what is going on, save the actual HTTP request for the phantom/node run
+            # the only objective here is to see if the Rack server has started
+            socket = TCPSocket.new uri.hostname, uri.port
+            up = true
+            socket.close
+          rescue Errno::ECONNREFUSED
+            # server not up yet
+          end
+        end
+        raise 'Tried 4 times to contact Rack server and not up!' unless up
+      end
+
+      def initialize(name = 'opal:rspec', &block)
+        desc 'Run opal specs in phantomjs/node'
+        task name do
+          require 'rack'
+          require 'webrick'
+
+          sprockets_env = Opal::RSpec::SprocketsEnvironment.new
+          app = Opal::Server.new(sprockets: sprockets_env) { |s|
+            s.main = 'opal/rspec/sprockets_runner'
+            s.debug = false
+
+            block.call s, self if block
+            sprockets_env.spec_pattern = self.pattern if self.pattern
+            sprockets_env.spec_exclude_pattern = self.exclude_pattern
+            sprockets_env.spec_files = self.files
+            sprockets_env.default_path = self.default_path if self.default_path
+            raise 'Cannot supply both a pattern and files!' if self.files and self.pattern
+            sprockets_env.add_spec_paths_to_sprockets
+          }
+
+          # TODO: Once Opal 0.9 compatibility is established, if we're running node, add in the node stdlib requires in so RSpec can use them, also add NODE_PATH to the runner command above
+
+          server = Thread.new do
+            Thread.current.abort_on_exception = true
+            Rack::Server.start(
+                :app => app,
+                :Port => PORT,
+                :AccessLog => [],
+                :Logger => WEBrick::Log.new("/dev/null"),
+            )
+          end
+
+          wait_for_server
+          is_phantom = runner == :phantom
+          if is_phantom
+            if `phantomjs -v`.nil?
+              warn "Could not find phantomjs command"
+              exit 1
+            end
+          end
+
+          begin
+            is_phantom ? launch_phantom(timeout) : launch_node(app)
+          ensure
+            server.kill
+          end
+        end
+      end
+    end
+  end
+end
+