hyper-spec 0.1.2 → 0.99.0

data/README.md

@@ -1,5 +1,7 @@
 # HyperSpec
 
+[![Build Status](https://travis-ci.org/ruby-hyperloop/hyper-spec.svg?branch=master)](https://travis-ci.org/ruby-hyperloop/hyper-spec)
+
 With HyperSpec you can run *isomorphic* specs for all your Hyperloop code using RSpec.  Everything runs as standard RSpec test specs.  
 
 For example if you have a component like this:
@@ -47,7 +49,7 @@ end
 
 Hyperloop wants to make the server-client divide as transparent to the developer as practical.  Given this, it makes sense that the testing should also be done with as little concern for client versus server.  
 
-HyperSpec allows you to directly use tools like FactoryGirl (or Hyperloop Operations) to setup some test data, then run a spec to make sure that a component correctly displays, or modifies that data.  You can use Timecop to manipulate time and keep in sync between the server and client.  This makes testing easier and more realistic without writing a lot of redundant code.
+HyperSpec allows you to directly use tools like FactoryBot (or Hyperloop Operations) to setup some test data, then run a spec to make sure that a component correctly displays, or modifies that data.  You can use Timecop to manipulate time and keep in sync between the server and client.  This makes testing easier and more realistic without writing a lot of redundant code.
 
 
 ## Installation

data/Rakefile

@@ -2,4 +2,10 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  task :prepare do
+  end
+end
+
 task :default => :spec

data/hyper-spec.gemspec

@@ -6,67 +6,55 @@ require 'hyper-spec/version'
 Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.name          = 'hyper-spec'
   spec.version       = HyperSpec::VERSION
-  spec.authors       = ['catmando', 'adamcreekroad']
-  spec.email         = ['mitch@catprint.com']
-
-  spec.summary       =
-    'Drive your Hyperloop client and server specs from RSpec and Capybara'
-  spec.description   =
-    'A Hyperloop application consists of isomorphic React Components, '\
-    'Active Record Models, Stores, Operations and Policiespec. '\
-    'Test them all from Rspec, regardless if the code runs on the client or server.'
-  spec.homepage      = 'https://github.com/ruby-hyperloop/hyper-spec'
+  spec.authors       = ['Mitch VanDuyn', 'Adam Creekroad', 'Jan Biedermann']
+  spec.email         = ['mitch@catprint.com', 'jan@kursator.com']
+  spec.summary       = 'Drive your Hyperloop client and server specs from RSpec and Capybara'
+  spec.description   = 'A Hyperloop application consists of isomorphic React Components, '\
+                       'Active Record Models, Stores, Operations and Policiespec. '\
+                       'Test them all from Rspec, regardless if the code runs on the client or server.'
+  spec.homepage      = 'http://ruby-hyperloop.org'
   spec.license       = 'MIT'
+  # spec.metadata      = {
+  #   "homepage_uri" => 'http://ruby-hyperloop.org',
+  #   "source_code_uri" => 'https://github.com/ruby-hyperloop/hyper-component'
+  # }
 
-  # Prevent pushing this gem to RubyGemspec.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
-  spec.files         =
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(gemfiles|spec)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  # Test app dependencies
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'hyper-react', '>= 0.10.0'
-  spec.add_development_dependency 'rails', '~>5.0.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'react-rails', '< 1.10.0'
-
-  # Keep linter-rubocop happy
-  spec.add_development_dependency 'rubocop'
-
-  if RUBY_PLATFORM == 'java'
-    spec.add_development_dependency 'therubyrhino'
-  else
-    spec.add_development_dependency 'therubyracer', '0.12.2'
-
-    # Actual dependencies
-    spec.add_dependency 'capybara'
-    spec.add_dependency 'opal'
-    spec.add_dependency 'parser'
-    spec.add_dependency 'poltergeist'
-    spec.add_dependency 'pry'
-    spec.add_dependency 'rspec-rails'
-    spec.add_dependency 'selenium-webdriver', '2.53.4'
-    spec.add_dependency 'timecop'
-    spec.add_dependency 'unparser', '0.2.5'
-
-    # Test app dependencies
-    spec.add_development_dependency 'chromedriver-helper'
-    spec.add_development_dependency 'method_source'
-    spec.add_development_dependency 'opal-browser'
-    spec.add_development_dependency 'opal-rails'
-    spec.add_development_dependency 'puma'
-    spec.add_development_dependency 'rspec-collection_matchers'
-    spec.add_development_dependency 'rspec-expectations'
-    spec.add_development_dependency 'rspec-its'
-    spec.add_development_dependency 'rspec-mocks'
-    spec.add_development_dependency 'rspec-steps'
-    spec.add_development_dependency 'shoulda'
-    spec.add_development_dependency 'shoulda-matchers'
-    spec.add_development_dependency 'spring-commands-rspec'
-  end
+  spec.add_dependency 'capybara'
+  spec.add_dependency 'chromedriver-helper', '1.2.0'
+  spec.add_dependency 'libv8', '~> 6.3.0' # see https://github.com/discourse/mini_racer/issues/92
+  spec.add_dependency 'method_source'
+  spec.add_dependency 'mini_racer', '~> 0.1.15'
+  spec.add_dependency 'opal', '>= 0.11.0', '< 0.12.0'
+  spec.add_dependency 'parser', '>= 2.3.3.1'
+  spec.add_dependency 'pry'
+  spec.add_dependency 'rspec-rails'
+  spec.add_dependency 'selenium-webdriver'
+  spec.add_dependency 'timecop', '~> 0.8.1'
+  spec.add_dependency 'uglifier'
+  spec.add_dependency 'unparser'
+  spec.add_dependency 'webdrivers'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'hyper-component', HyperSpec::VERSION
+  spec.add_development_dependency 'opal-browser', '~> 0.2.0'
+  spec.add_development_dependency 'opal-rails', '~> 0.9.4'
+  spec.add_development_dependency 'pry-rescue'
+  spec.add_development_dependency 'puma'
+  spec.add_development_dependency 'rails', '>= 4.0.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'react-rails', '>= 2.3.0', '< 2.5.0'
+  spec.add_development_dependency 'rspec-collection_matchers'
+  spec.add_development_dependency 'rspec-expectations'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'rspec-steps', '~> 2.1.1'
+  spec.add_development_dependency 'rubocop', '~> 0.51.0'
+  spec.add_development_dependency 'shoulda'
+  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency 'spring-commands-rspec'
 end

data/lib/hyper-spec.rb

@@ -1,13 +1,10 @@
 require 'capybara/rspec'
-require 'capybara/poltergeist'
 require 'opal'
 require 'selenium-webdriver'
 
 require 'hyper-spec/component_test_helpers'
-require 'hyper-spec/rails/engine'
 require 'hyper-spec/version'
 require 'hyper-spec/wait_for_ajax'
-require 'react/isomorphic_helpers'
 require 'selenium/web_driver/firefox/profile'
 
 RSpec.configure do |config|
@@ -17,14 +14,20 @@ RSpec.configure do |config|
 
   config.mock_with :rspec
 
-  if defined?(HyperMesh)
-    config.before(:each) do
-      HyperMesh.class_eval do
-        def self.on_server?
-          true
-        end
+  config.add_setting :debugger_width, default: nil
+
+  config.before(:each) do
+    Hyperloop.class_eval do
+      def self.on_server?
+        true
       end
-    end
+    end if defined?(Hyperloop)
+    # for compatibility with HyperMesh
+    HyperMesh.class_eval do
+      def self.on_server?
+        true
+      end
+    end if defined?(HyperMesh)
   end
 
   config.before(:each, js: true) do
@@ -40,49 +43,65 @@ RSpec.configure do |config|
       PusherFake::Channel.reset if defined? PusherFake
     end
   end
+
 end
 
 # Capybara config
 RSpec.configure do |_config|
   Capybara.default_max_wait_time = 10
 
-  # # In case Google ever fixes chromedriver to work with Opal...
-  # Capybara.register_driver :chrome do |app|
-  #   caps = Selenium::WebDriver::Remote::Capabilities.chrome(
-  #     'chromeOptions' => { 'args' => ['--window-size=200,200'] }
-  #   )
-  #
-  #   Capybara::Selenium::Driver.new(app, browser: :chrome, desired_capabilities: caps)
-  # end
-
-  Capybara.register_driver :poltergeist do |app|
-    options = {
-      js_errors: false, timeout: 180, inspector: true,
-      phantomjs_options: ['--load-images=no', '--ignore-ssl-errors=yes']
-    }.tap do |hash|
-      unless ENV['SHOW_LOGS']
-        hash[:phantomjs_logger] = StringIO.new
-        hash[:logger] = StringIO.new
-      end
-    end
+  Capybara.register_driver :chrome do |app|
+    options = {}
+    options.merge!(
+      args: %w[auto-open-devtools-for-tabs],
+      prefs: { 'devtools.open_docked' => false, "devtools.currentDockState" => "undocked", devtools: {currentDockState: :undocked} }
+    ) unless ENV['NO_DEBUGGER']
+    # this does not seem to work properly.  Don't document this feature yet.
+    options['mobileEmulation'] = { 'deviceName' => ENV['DEVICE'].tr('-', ' ') } if ENV['DEVICE']
+    capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(chromeOptions: options)
+    Capybara::Selenium::Driver.new(app, browser: :chrome, desired_capabilities: capabilities)
+  end
 
-    Capybara::Poltergeist::Driver.new(app, options)
+  Capybara.register_driver :chrome_headless_docker_travis do |app|
+    options = ::Selenium::WebDriver::Chrome::Options.new
+    options.add_argument('--headless')
+    options.add_argument('--no-sandbox')
+    options.add_argument('--disable-dev-shm-usage')
+    Capybara::Selenium::Driver.new(app, browser: :chrome, :driver_path => "/usr/lib/chromium-browser/chromedriver", options: options)
+  end
+
+  Capybara.register_driver :firefox do |app|
+    Capybara::Selenium::Driver.new(app, browser: :firefox)
+  end
+
+  Capybara.register_driver :firefox_headless do |app|
+    options = Selenium::WebDriver::Firefox::Options.new
+    options.headless!
+    Capybara::Selenium::Driver.new(app, browser: :firefox, options: options)
   end
 
   Capybara.register_driver :selenium_with_firebug do |app|
     profile = Selenium::WebDriver::Firefox::Profile.new
-    profile.frame_position = ENV['DRIVER'] && ENV['DRIVER'][2]
+    ENV['FRAME_POSITION'] && profile.frame_position = ENV['FRAME_POSITION']
     profile.enable_firebug
+    options = Selenium::WebDriver::Firefox::Options.new(profile: profile)
+    Capybara::Selenium::Driver.new(app, browser: :firefox, options: options)
+  end
 
-    Capybara::Selenium::Driver.new(app, browser: :firefox, profile: profile)
+  Capybara.register_driver :safari do |app|
+    Capybara::Selenium::Driver.new(app, browser: :safari)
   end
 
   Capybara.javascript_driver =
-    if ENV['DRIVER'] =~ /^ff/
-      :selenium_with_firebug
-    # elsif ENV['DRIVER'] == 'chrome'
-    #   Capybara.javascript_driver = :chrome
-    else
-      :poltergeist
+    case ENV['DRIVER']
+    when 'beheaded' then :firefox_headless
+    when 'chrome' then :chrome
+    when 'ff' then :selenium_with_firebug
+    when 'firefox' then :firefox
+    when 'headless' then :selenium_chrome_headless
+    when 'safari' then :safari
+    when 'travis' then :chrome_headless_docker_travis
+    else :selenium_chrome_headless
     end
+
 end

data/lib/hyper-spec/component_test_helpers.rb

@@ -1,29 +1,31 @@
 # see component_test_helpers_spec.rb for examples
-
 require 'parser/current'
 require 'unparser'
 require 'method_source'
-require_relative '../../vendor/assets/javascripts/time_cop' # 'hyper-spec/time_cop'
+require_relative '../../lib/hyper-spec/time_cop.rb'
 
 module HyperSpec
   module ComponentTestHelpers
     TOP_LEVEL_COMPONENT_PATCH =
       Opal.compile(File.read(File.expand_path('../../react/top_level_rails_component.rb', __FILE__)))
+    TIME_COP_CLIENT_PATCH =
+      Opal.compile(File.read(File.expand_path('../../hyper-spec/time_cop.rb', __FILE__))) +
+      "\n#{File.read(File.expand_path('../../sources/lolex.js', __FILE__))}"
 
     class << self
       attr_accessor :current_example
       attr_accessor :description_displayed
 
       def display_example_description
-        "<script type='text/javascript'>console.log(console.log('%c#{current_example.description}'"\
-        ",'color:green; font-weight:bold; font-size: 200%'))</script>"
+        "<script type='text/javascript'>console.log('%c#{current_example.description}'"\
+        ",'color:green; font-weight:bold; font-size: 200%')</script>"
       end
     end
 
     def build_test_url_for(controller)
       unless controller
         unless defined?(::ReactTestController)
-          Object.const_set('ReactTestController', Class.new(ActionController::Base))
+          Object.const_set('ReactTestController', Class.new(::ActionController::Base))
         end
 
         controller = ::ReactTestController
@@ -47,11 +49,14 @@ module HyperSpec
 
             page = '<%= react_component @component_name, @component_params, '\
                    "{ prerender: #{render_on != :client_only} } %>"
-            page = "<script type='text/javascript'>\n#{TOP_LEVEL_COMPONENT_PATCH}\n</script>\n#{page}"
-
-            page = "<script type='text/javascript'>\n#{code}\n</script>\n#{page}" if code
+            unless render_on == :server_only
+              page = "<script type='text/javascript'>\n#{TOP_LEVEL_COMPONENT_PATCH}\n</script>\n#{page}"
+              page = "<script type='text/javascript'>\n#{code}\n</script>\n#{page}" if code
+            end
 
-            page = "<%= javascript_include_tag 'time_cop' %>\n#{page}" if true || Lolex.initialized?
+            if render_on != :server_only || Lolex.initialized?
+              page = "<script type='text/javascript'>\n#{TIME_COP_CLIENT_PATCH}\n</script>\n#{page}"
+            end
 
             if (render_on != :server_only && !render_params[:layout]) || javascript
               page = "<%= javascript_include_tag '#{javascript || 'application'}' %>\n#{page}"
@@ -60,22 +65,14 @@ module HyperSpec
             if !render_params[:layout] || style_sheet
               page = "<%= stylesheet_link_tag '#{style_sheet || 'application'}' %>\n#{page}"
             end
-
-            if render_on == :server_only # so that test helper wait_for_ajax works
-              page = "<script type='text/javascript'>window.jQuery = {'active': 0}</script>\n#{page}"
-            else
-              page = "<%= javascript_include_tag 'jquery' %>\n"\
-                     "<%= javascript_include_tag 'jquery_ujs' %>\n#{page}"
-            end
-
             page = "<script type='text/javascript'>go = function() "\
                    "{window.hyper_spec_waiting_for_go = false}</script>\n#{page}"
 
             title = view_context.escape_javascript(ComponentTestHelpers.current_example.description)
             title = "#{title}...continued." if ComponentTestHelpers.description_displayed
 
-            page = "<script type='text/javascript'>console.log(console.log('%c#{title}',"\
-                   "'color:green; font-weight:bold; font-size: 200%'))</script>\n#{page}"
+            page = "<script type='text/javascript'>console.log('%c#{title}',"\
+                   "'color:green; font-weight:bold; font-size: 200%')</script>\n#{page}"
 
             ComponentTestHelpers.description_displayed = true
             render_params[:inline] = page
@@ -112,6 +109,8 @@ module HyperSpec
         str = "#{str}\n#{Unparser.unparse Parser::CurrentRuby.parse(block.source).children.last}"
       end
       js = Opal.compile(str).delete("\n").gsub('(Opal);', '(Opal)')
+      # workaround for firefox 58 and geckodriver 0.19.1, because firefox is unable to find .$to_json:
+      # JSON.parse(evaluate_script("(function(){var a=Opal.Array.$new(); a[0]=#{js}; return a.$to_json();})();"), opts).first
       JSON.parse(evaluate_script("[#{js}].$to_json()"), opts).first
     end
 
@@ -129,25 +128,25 @@ module HyperSpec
       "#{Unparser.unparse Parser::CurrentRuby.parse(block.source).children.first.children.last}"
     end
 
-    def expect_promise(str = '', opts = {}, &block)
+    def evaluate_promise(str = '', opts = {}, &block)
       insure_mount
-
-      str = add_opal_block(str, block)
+      str = "#{str}\n#{Unparser.unparse Parser::CurrentRuby.parse(block.source).children.last}" if block
       str = "#{str}.then { |args| args = [args]; `window.hyper_spec_promise_result = args` }"
-      js = Opal.compile(str).delete("\n").gsub('(Opal);', '(Opal)')
-      page.evaluate_script('window.hyper_spec_promise_result = false')
+      js = Opal.compile(str).gsub("\n","").gsub("(Opal);","(Opal)")
+      page.evaluate_script("window.hyper_spec_promise_result = false")
       page.execute_script(js)
-
       Timeout.timeout(Capybara.default_max_wait_time) do
         loop do
           sleep 0.25
-          break if page.evaluate_script('!!window.hyper_spec_promise_result')
+          break if page.evaluate_script("!!window.hyper_spec_promise_result")
         end
       end
+      JSON.parse(page.evaluate_script("window.hyper_spec_promise_result.$to_json()"), opts).first
+    end
 
-      result =
-        JSON.parse(page.evaluate_script('window.hyper_spec_promise_result.$to_json()'), opts).first
-      expect(result)
+    def expect_promise(str = '', opts = {}, &block)
+      insure_mount
+      expect(evaluate_promise(add_opal_block(str, block), opts))
     end
 
     def ppr(str)
@@ -193,19 +192,32 @@ module HyperSpec
               `eval(s)`
             end
             def self.dasherize(s)
-              `s.replace(/[-_\\s]+/g, '-')
+              res = %x{
+                s.replace(/[-_\\s]+/g, '-')
                 .replace(/([A-Z\\d]+)([A-Z][a-z])/g, '$1-$2')
                 .replace(/([a-z\\d])([A-Z])/g, '$1-$2')
-                .toLowerCase()`
+                .toLowerCase()
+              }
+              res
             end
             def self.add_class(class_name, styles={})
-              style = styles.collect { |attr, value| "\#{dasherize(attr)}:\#{value}"}.join("; ")
-              s = "<style type='text/css'> .\#{class_name}{ \#{style} } </style>"
-              `$(\#{s}).appendTo("head");`
+              style = styles.collect { |attr, value| "\#{dasherize(attr)}:\#{value}" }.join("; ")
+              cs = class_name.to_s
+              %x{
+                var style_el = document.createElement("style");
+                var css = "." + cs + " { " + style + " }";
+                style_el.type = "text/css";
+                if (style_el.styleSheet){
+                  style_el.styleSheet.cssText = css;
+                } else {
+                  style_el.appendChild(document.createTextNode(css));
+                }
+                document.head.appendChild(style_el);
+              }
             end
           end
           class React::Component::HyperTestDummy < React::Component::Base
-            def render; end
+                def render; end
           end
           #{@client_code}
           #{Unparser.unparse(Parser::CurrentRuby.parse(block.source).children.last) if block}
@@ -215,6 +227,19 @@ module HyperSpec
 
       component_name ||= 'React::Component::HyperTestDummy'
       ::Rails.cache.write(test_url, [component_name, params, opts])
+      test_code_key = "hyper_spec_prerender_test_code.js"
+      @@original_server_render_files ||= ::Rails.configuration.react.server_renderer_options[:files]
+      if opts[:render_on] == :both || opts[:render_on] == :server_only
+        unless opts[:code].blank?
+          ::Rails.cache.write(test_code_key, opts[:code])
+          ::Rails.configuration.react.server_renderer_options[:files] = @@original_server_render_files + [test_code_key]
+          ::React::ServerRendering.reset_pool # make sure contexts are reloaded so they dont use code from cache, as the rails filewatcher doesnt look for cache changes
+        else
+          ::Rails.cache.delete(test_code_key)
+          ::Rails.configuration.react.server_renderer_options[:files] = @@original_server_render_files
+          ::React::ServerRendering.reset_pool # make sure contexts are reloaded so they dont use code from cache, as the rails filewatcher doesnt look for cache changes
+        end
+      end
       visit test_url
       wait_for_ajax unless opts[:no_wait]
       page.instance_variable_set('@hyper_spec_mounted', true)
@@ -234,7 +259,7 @@ module HyperSpec
     end
 
     def add_class(class_name, style)
-      @client_code = "#{@client_code}ComponentHelpers.add_class '#{class_name}', #{style}\n"
+      @client_code = "#{@client_code}ComponentHelpers.add_class('#{class_name}', #{style})\n"
     end
 
     def open_in_chrome
@@ -263,7 +288,28 @@ module HyperSpec
       end
     end
 
+    def wait_for_size(width, height)
+      start_time = Capybara::Helpers.monotonic_time
+      stable_count_w = 0
+      stable_count_h = 0
+      prev_size = [0, 0]
+      begin
+        sleep 0.05
+        curr_size = Capybara.current_session.current_window.size
+        return if [width, height] == curr_size
+        # some maximum or minimum is reached and size doesnt change anymore
+        stable_count_w += 1 if prev_size[0] == curr_size[0]
+        stable_count_h += 1 if prev_size[1] == curr_size[1]
+        return if stable_count_w > 2 || stable_count_h > 2
+        prev_size = curr_size
+      end while (Capybara::Helpers.monotonic_time - start_time) < Capybara.current_session.config.default_max_wait_time
+      raise Capybara::WindowError, "Window size not stable within #{Capybara.current_session.config.default_max_wait_time} seconds."
+    end
+
     def size_window(width = nil, height = nil)
+      # return if @window_cannot_be_resized
+      # original_width = evaluate_script('window.innerWidth')
+      # original_height = evaluate_script('window.innerHeight')
       width, height = [height, width] if width == :portrait
       width, height = width if width.is_a? Array
       portrait = true if height == :portrait
@@ -283,7 +329,15 @@ module HyperSpec
 
       width, height = [height, width] if portrait
 
-      Capybara.current_session.current_window.resize_to(width, height)
+      unless RSpec.configuration.debugger_width
+        Capybara.current_session.current_window.resize_to(1000, 500)
+        wait_for_size(1000, 500)
+        inner_width = evaluate_script('window.innerWidth')
+        RSpec.configuration.debugger_width = 1000 - inner_width
+      end
+      Capybara.current_session.current_window
+              .resize_to(width + RSpec.configuration.debugger_width, height)
+      wait_for_size(width + RSpec.configuration.debugger_width, height)
     end
   end