hyper-spec 1.0.alpha1.3 → 1.0.alpha1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 657e9bc17795ba45447406d198992262325fac98d154915ca576a9b20ebe3492
-  data.tar.gz: 25f616308e4d1d3cd6fe64c8a4b02f702a3e240a4e2b6357139a96a63e662bc8
+  metadata.gz: 70e0d39ed642bc1a7d8215db2edcc4798d3229f0530d3a6c1a3355c452158630
+  data.tar.gz: cbc96bac1e4e5378537364bea704afe27afecceab369920c281569622b59cbad
 SHA512:
-  metadata.gz: 1436b202f936dbd8c9a7746fbcdbbdbf4e11f42b9b3ba845dc065d3e8c4c00396e0de495b0d6d5c53058d99caaf6db5e1acfed9f0858b14a097c74f36537a5a5
-  data.tar.gz: 4a5d334f5b7fafba3dd99ab08cb442a42c48bbbf4f92c25cd69ba00bfa37093573b9f5a80a6bae6c3d77222e966d86a19ea4b6bd7a08115b542980ffb9818d5a
+  metadata.gz: ef7ed137034bf28dfcd5af3a72914ab8aa81734ef53006d0ce6287d767bca067b6417e5c86f699be4460dba3e7ba62b690d370f463690557e164647b604c8070
+  data.tar.gz: dfbc57840b6ee1560080181e83d8cc391eafe18084613b48facfc7a566df815d4fbab8c29987a895df77bf8219a54323dec85393db1f8bbecb436152969e7a3c

data/.gitignore

@@ -52,3 +52,7 @@ bower.json
 
 # ignore Idea files
 .idea
+
+# ignore Gemfile.locks https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+/spec/test_app/Gemfile.lock
+/Gemfile.lock

data/hyper-spec.gemspec

@@ -6,54 +6,51 @@ require 'hyper-spec/version'
 Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.name          = 'hyper-spec'
   spec.version       = HyperSpec::VERSION
-  spec.authors       = ['Mitch VanDuyn', 'Adam Creekroad', 'Jan Biedermann']
+  spec.authors       = ['Mitch VanDuyn', 'AdamCreekroad', '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, '\
+  spec.summary       = 'Drive your Opal and Hyperstack client and server specs from RSpec and Capybara'
+  spec.description   = 'A Hyperstack 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.homepage      = 'http://hyperstack.org'
   spec.license       = 'MIT'
-  # spec.metadata      = {
-  #   "homepage_uri" => 'http://ruby-hyperloop.org',
-  #   "source_code_uri" => 'https://github.com/ruby-hyperloop/hyper-component'
-  # }
-
   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']
 
+  spec.add_dependency 'actionview'
   spec.add_dependency 'capybara'
   spec.add_dependency 'chromedriver-helper', '1.2.0'
-  spec.add_dependency 'libv8'
+  spec.add_dependency 'filecache'
   spec.add_dependency 'method_source'
-  spec.add_dependency 'mini_racer', '~> 0.2.4'
-  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 'opal', ENV['OPAL_VERSION'] || '>= 0.11.0', '< 2.0'
+  spec.add_dependency 'parser'
+  spec.add_dependency 'rspec'
   spec.add_dependency 'selenium-webdriver'
   spec.add_dependency 'timecop', '~> 0.8.1'
   spec.add_dependency 'uglifier'
-  spec.add_dependency 'unparser', '>= 0.2', '< 0.4' # 0.4 is incompatible
+  spec.add_dependency 'unparser', '>= 0.4.2'
   spec.add_dependency 'webdrivers'
 
-  spec.add_development_dependency 'bundler', ['>= 1.17.3', '< 2.1']
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'hyper-component', HyperSpec::VERSION
+  spec.add_development_dependency 'mini_racer'
   spec.add_development_dependency 'opal-browser', '~> 0.2.0'
-  spec.add_development_dependency 'opal-rails', '~> 0.9.4'
+  spec.add_development_dependency 'opal-rails', '>= 0.9.4'
   spec.add_development_dependency 'pry-rescue'
+  spec.add_development_dependency 'pry-stack_explorer'
   spec.add_development_dependency 'puma'
-  spec.add_development_dependency 'rails', '>= 4.0.0'
+  spec.add_development_dependency 'rails', ENV['RAILS_VERSION'] || '>= 5.0.0', '< 7.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'react-rails', '>= 2.3.0', '< 2.5.0'
+  spec.add_development_dependency 'rspec-rails'
   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 'rubocop' #, '~> 0.51.0'
   spec.add_development_dependency 'shoulda'
   spec.add_development_dependency 'shoulda-matchers'
   spec.add_development_dependency 'spring-commands-rspec'

data/lib/hyper-spec.rb

@@ -1,14 +1,144 @@
-require 'capybara/rspec'
+# hyper-spec
+require 'action_view'
 require 'opal'
+require 'unparser'
+require 'method_source'
+require 'filecache'
+
+require 'capybara/rspec'
+require 'hyper-spec/internal/client_execution'
+require 'hyper-spec/internal/component_mount'
+require 'hyper-spec/internal/controller'
+require 'hyper-spec/internal/copy_locals'
+require 'hyper-spec/internal/patches'
+require 'hyper-spec/internal/rails_controller_helpers'
+require 'hyper-spec/internal/time_cop.rb'
+require 'hyper-spec/internal/window_sizing'
+
+require 'hyper-spec/controller_helpers'
+
+require 'hyper-spec/wait_for_ajax'
+
+require 'hyper-spec/helpers'
+require 'hyper-spec/expectations'
+
+require 'parser/current'
+if defined?(Selenium::WebDriver::Firefox)
+  require 'selenium/web_driver/firefox/profile'
+end
 require 'selenium-webdriver'
 
-require 'hyper-spec/component_test_helpers'
 require 'hyper-spec/version'
-require 'hyper-spec/wait_for_ajax'
-require 'selenium/web_driver/firefox/profile'
+
+
+begin
+  require 'pry'
+rescue LoadError
+  nil
+end
+
+# opt-in to most recent AST format:
+Parser::Builders::Default.emit_lambda              = true
+Parser::Builders::Default.emit_procarg0            = true
+(Parser::Builders::Default.emit_encoding            = true) rescue nil
+(Parser::Builders::Default.emit_index               = true) rescue nil
+(Parser::Builders::Default.emit_arg_inside_procarg0 = true) rescue nil
+(Parser::Builders::Default.emit_forward_arg         = true) rescue nil
+(Parser::Builders::Default.emit_kwargs              = true) rescue nil
+(Parser::Builders::Default.emit_match_pattern       = true) rescue nil
+
+# not available in parser 2.3
+if Parser::Builders::Default.respond_to? :emit_arg_inside_procarg0
+  Parser::Builders::Default.emit_arg_inside_procarg0 = true
+end
+
+module HyperSpec
+  if defined? Pry
+    # add a before eval hook to pry so we can capture the source
+    class << self
+      attr_accessor :current_pry_code_block
+      Pry.hooks.add_hook(:before_eval, 'hyper_spec_code_capture') do |code|
+        HyperSpec.current_pry_code_block = code
+      end
+    end
+  end
+
+  def self.reset_between_examples
+    @reset_between_examples ||= []
+  end
+
+  def self.reset_between_examples?
+    RSpec.configuration.reset_between_examples
+  end
+
+  def self.reset_sessions!
+    Capybara.old_reset_sessions!
+  end
+end
+
+# TODO: figure out why we need this patch - its because we are on an old version
+# of Selenium Webdriver, but why?
+require 'selenium-webdriver'
+
+module Selenium
+  module WebDriver
+    module Chrome
+      module Bridge
+        COMMANDS = remove_const(:COMMANDS).dup
+        COMMANDS[:get_log] = [:post, 'session/:session_id/log']
+        COMMANDS.freeze
+
+        def log(type)
+          data = execute :get_log, {}, type: type.to_s
+
+          Array(data).map do |l|
+            begin
+              LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
+            rescue KeyError
+              next
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+module Capybara
+  class << self
+    alias old_reset_sessions! reset_sessions!
+    def reset_sessions!
+      old_reset_sessions! if HyperSpec.reset_between_examples?
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.add_setting :reset_between_examples, default: true
+  config.before(:all, no_reset: true) do
+    HyperSpec.reset_between_examples << RSpec.configuration.reset_between_examples
+    RSpec.configuration.reset_between_examples = false
+  end
+  config.before(:all, no_reset: false) do
+    HyperSpec.reset_between_examples << RSpec.configuration.reset_between_examples
+    RSpec.configuration.reset_between_examples = true
+  end
+  config.after(:all) do
+    HyperSpec.reset_sessions! unless HyperSpec.reset_between_examples?
+    # If rspecs step is used first in a file, it will NOT call config.before(:all) causing the
+    # reset_between_examples stack to be mismatched, so we check, if its already empty we
+    # just leave.
+    next if HyperSpec.reset_between_examples.empty?
+
+    RSpec.configuration.reset_between_examples = HyperSpec.reset_between_examples.pop
+  end
+  config.before(:each) do |example|
+    insure_page_loaded(true) if example.metadata[:js] && !HyperSpec.reset_between_examples?
+  end
+end
 
 RSpec.configure do |config|
-  config.include HyperSpec::ComponentTestHelpers
+  config.include HyperSpec::Helpers
   config.include HyperSpec::WaitForAjax
   config.include Capybara::DSL
 
@@ -17,17 +147,21 @@ RSpec.configure do |config|
   config.add_setting :debugger_width, default: nil
 
   config.before(:each) do
-    Hyperstack.class_eval do
-      def self.on_server?
-        true
+    if defined?(Hyperstack)
+      Hyperstack.class_eval do
+        def self.on_server?
+          true
+        end
       end
-    end if defined?(Hyperstack)
+    end
     # for compatibility with HyperMesh
-    HyperMesh.class_eval do
-      def self.on_server?
-        true
+    if defined?(HyperMesh)
+      HyperMesh.class_eval do
+        def self.on_server?
+          true
+        end
       end
-    end if defined?(HyperMesh)
+    end
   end
 
   config.before(:each, js: true) do
@@ -43,42 +177,51 @@ RSpec.configure do |config|
       PusherFake::Channel.reset if defined? PusherFake
     end
   end
-
 end
 
 # Capybara config
-RSpec.configure do |_config|
+RSpec.configure do |config|
+  config.before(:each) do |example|
+    HyperSpec::Internal::Controller.current_example = example
+    HyperSpec::Internal::Controller.description_displayed = false
+  end
+
+  config.add_setting :wait_for_initialization_time
+  config.wait_for_initialization_time = 3
+
   Capybara.default_max_wait_time = 10
 
   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.
+      w3c: false,
+      args: %w[auto-open-devtools-for-tabs]
+    )
     options['mobileEmulation'] = { 'deviceName' => ENV['DEVICE'].tr('-', ' ') } if ENV['DEVICE']
-    capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(chromeOptions: options)
+    capabilities = Selenium::WebDriver::Remote::Capabilities.chrome(
+      chromeOptions: options, 'goog:loggingPrefs' => { browser: 'ALL' }
+    )
     Capybara::Selenium::Driver.new(app, browser: :chrome, desired_capabilities: capabilities)
   end
 
+  Capybara.register_driver :firefox do |app|
+    Capybara::Selenium::Driver.new(app, browser: :firefox)
+  end
+
   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)
+    Selenium::WebDriver::Chrome::Service.driver_path = '/usr/lib/chromium-browser/chromedriver'
+    Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
   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
+  end if defined?(Selenium::WebDriver::Firefox)
 
   Capybara.register_driver :selenium_with_firebug do |app|
     profile = Selenium::WebDriver::Firefox::Profile.new
@@ -86,7 +229,7 @@ RSpec.configure do |_config|
     profile.enable_firebug
     options = Selenium::WebDriver::Firefox::Options.new(profile: profile)
     Capybara::Selenium::Driver.new(app, browser: :firefox, options: options)
-  end
+  end if defined?(Selenium::WebDriver::Firefox)
 
   Capybara.register_driver :safari do |app|
     Capybara::Selenium::Driver.new(app, browser: :safari)
@@ -103,5 +246,4 @@ RSpec.configure do |_config|
     when 'travis' then :chrome_headless_docker_travis
     else :selenium_chrome_headless
     end
-
 end

data/lib/hyper-spec/controller_helpers.rb

@@ -0,0 +1,164 @@
+module HyperSpec
+  # Defines a series of methods that will build a test page
+  # This module is typically included into the HyperSpecTestController class.
+  module ControllerHelpers
+    # These methods are dependent on the stack being used.  See the
+    # RailsControllerHelpers module and rack.rb for two implementations.
+    # Each method should append the appropriate code to the @page array
+
+    # return an empty 204 status either by setting headers or
+    # returning and appropriate response for rack.
+    def ping!
+      raise 'must implement'
+    end
+
+    def json!
+      # this can be a no-op but if json is not included by the application,
+      # hyper-spec will fail, with an error complaining about to_json
+    end
+
+    # return a script or style_sheet tag pointing to some asset.
+    # typically you be pointing to a path on the server or using
+    # sprockets to deliver the file.
+
+    def require!(_file_)
+      raise 'must implement'
+    end
+
+    def style_sheet!(_file_)
+      raise 'must implement'
+    end
+
+    # deliver the page.  The @page variable will contain the html ready to go,
+    # any additional options that are passed through from the spec will be
+    # in the @render_params variable.  For example layout: 'my_special_layout'
+
+    def deliver!
+      raise 'must implement'
+    end
+
+    # generate a react_render top level block.  This will only be called if
+    # you use the mount directive in your specs, so it is optional.
+
+    def mount_component!
+      raise 'mount_component not implemented in HyperSpecTestController'
+    end
+
+    # by default the route back to the controller will be the controller name, less the
+    # word Controller, and underscored.  If you want some other name redefine this
+    # method in the HyperSpecController class.
+
+    def self.included(base)
+      def base.route_root
+        # Implement underscore without using rails underscore, so we don't have a
+        # dependency on ActiveSupport
+        name.gsub(/Controller$/, '')
+            .gsub(/::/, '/')
+            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr('-', '_')
+            .downcase
+      end
+    end
+
+    # The remainder of the methods should work for most implementations.
+
+    # helper method checking the render_on parameter
+
+    def on_client?
+      @render_on != :server_only
+    end
+
+    # The controllers behavior is kept as an array of values in the Controller cache
+    # under a unique id for each test run.  Grab the parameters and move them to instance vars
+
+    # If this is just a ping! Then we can just exit with nil.
+
+    def initialize!
+      return if params[:id] == 'ping'
+
+      key =               "/#{self.class.route_root}/#{params[:id]}"
+      test_params =       Internal::Controller.cache_read(key)
+
+      @component_name =   test_params[0]
+      @component_params = test_params[1]
+      @html_block =       test_params[2]
+      @render_params =    test_params[3]
+      @render_on =        @render_params.delete(:render_on) || :client_only
+      @_mock_time =       @render_params.delete(:mock_time)
+      @style_sheet =      @render_params.delete(:style_sheet)
+      @javascript =       @render_params.delete(:javascript)
+      @code =             @render_params.delete(:code)
+
+      @page = ['<body>']
+    end
+
+    # add any html code generated by the insert_html directive
+
+    def html_block!
+      @page << @html_block
+    end
+
+    # patch behavior of the HyperComponent TopLevelRailsComponent class
+    # so that things like events are passed back to the test harness
+    TOP_LEVEL_COMPONENT_PATCH =
+      Opal.compile(File.read(File.expand_path('../sources/top_level_rails_component.rb', __dir__)))
+
+    # patch time cop and lolex so they stay in sync across the client and server
+    TIME_COP_CLIENT_PATCH =
+      Opal.compile(File.read(File.expand_path('../hyper-spec/internal/time_cop.rb', __dir__))) +
+      "\n#{File.read(File.expand_path('../sources/lolex.js', __dir__))}"
+
+    def client_code!
+      if @component_name
+        @page << "<script type='text/javascript'>\n#{TOP_LEVEL_COMPONENT_PATCH}\n</script>"
+      end
+      @page << "<script type='text/javascript'>\n#{@code}\n</script>" if @code
+    end
+
+    def time_cop_patch!
+      @page << "<script type='text/javascript'>\n#{TIME_COP_CLIENT_PATCH}\n</script>"
+    end
+
+    # Add the go_function to the client console.  This is used to stop a hyper-spec pause directive.
+
+    def go_function!
+      @page << "<script type='text/javascript'>go = function() "\
+               '{window.hyper_spec_waiting_for_go = false}</script>'
+    end
+
+    # First lines displayed on the console will be the name of the spec
+
+    def example_title!
+      title = Internal::Controller.current_example_description!
+      @page << "<script type='text/javascript'>console.log('%c#{title}',"\
+               "'color:green; font-weight:bold; font-size: 200%')</script>"
+    end
+
+    # generate each piece of the page, and then deliver it
+
+    def style_sheet_file
+      @style_sheet || (!@render_params[:layout] && 'application')
+    end
+
+    def application_file
+      @javascript || (on_client? && !@render_params[:layout] && 'application')
+    end
+
+    def test
+      return ping! unless initialize!
+
+      html_block!
+      example_title!                 if Internal::Controller.current_example
+      go_function!                   if on_client?
+      style_sheet!(style_sheet_file) if style_sheet_file
+      application!(application_file) if application_file
+      json!
+      time_cop_patch!                if on_client? || Lolex.initialized?
+      client_code!                   if on_client?
+      mount_component!               if @component_name
+      @page = @page.join("\n") + "\n</body>\n"
+      deliver!
+    end
+  end
+end