RubyGems - hyper-spec - Versions diffs - 1.0.alpha1.8 → 1.0.0.lap28 - Mend

hyper-spec 1.0.alpha1.8 → 1.0.0.lap28

Files changed (33) hide show

checksums.yaml +4 -4
data/.gitignore +1 -4
data/.rubocop.yml +107 -0
data/.travis.yml +15 -20
data/CODE_OF_CONDUCT.md +49 -0
data/Gemfile +1 -5
data/LICENSE.txt +21 -0
data/README.md +380 -0
data/Rakefile +2 -0
data/bin/console +0 -0
data/bin/setup +0 -0
data/dciy.toml +3 -0
data/hyper-spec.gemspec +21 -19
data/lib/hyper-spec.rb +23 -174
data/lib/hyper-spec/component_test_helpers.rb +360 -0
data/lib/hyper-spec/{internal/time_cop.rb → time_cop.rb} +2 -14
data/lib/hyper-spec/version.rb +1 -1
data/lib/hyper-spec/wait_for_ajax.rb +4 -4
data/lib/react/top_level_rails_component.rb +94 -0
metadata +54 -107
data/lib/hyper-spec/controller_helpers.rb +0 -164
data/lib/hyper-spec/expectations.rb +0 -64
data/lib/hyper-spec/helpers.rb +0 -225
data/lib/hyper-spec/internal/client_execution.rb +0 -94
data/lib/hyper-spec/internal/component_mount.rb +0 -140
data/lib/hyper-spec/internal/controller.rb +0 -70
data/lib/hyper-spec/internal/copy_locals.rb +0 -103
data/lib/hyper-spec/internal/patches.rb +0 -86
data/lib/hyper-spec/internal/rails_controller_helpers.rb +0 -50
data/lib/hyper-spec/internal/window_sizing.rb +0 -73
data/lib/hyper-spec/rack.rb +0 -67
data/lib/sources/top_level_rails_component.rb +0 -103
data/multi_level_how_it_works.md +0 -49

data/lib/hyper-spec/controller_helpers.rb DELETED Viewed

@@ -1,164 +0,0 @@
-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

data/lib/hyper-spec/expectations.rb DELETED Viewed

@@ -1,64 +0,0 @@
-# don't put this in directory lib/rspec/ as that will cause stack overflow with rails/rspec loads
-module RSpec
-  module Expectations
-    class ExpectationTarget; end
-    module HyperSpecInstanceMethods
-      def self.included(base)
-        base.include HyperSpec::Helpers
-      end
-      def to_on_client(matcher, message = nil, &block)
-        evaluate_client.to(matcher, message, &block)
-      end
-      alias on_client_to to_on_client
-      alias to_then to_on_client
-      alias then_to to_on_client
-      def to_on_client_not(matcher, message = nil, &block)
-        evaluate_client.not_to(matcher, message, &block)
-      end
-      alias on_client_to_not to_on_client_not
-      alias on_client_not_to to_on_client_not
-      alias to_not_on_client to_on_client_not
-      alias not_to_on_client to_on_client_not
-      alias then_to_not to_on_client_not
-      alias then_not_to to_on_client_not
-      alias to_not_then to_on_client_not
-      alias not_to_then to_on_client_not
-      private
-      def evaluate_client
-        source = add_opal_block(@args_str, @target)
-        value = @target.binding.eval("evaluate_ruby(#{source.inspect}, {}, {})")
-        ExpectationTarget.for(value, nil)
-      end
-    end
-    class OnClientWithArgsTarget
-      include HyperSpecInstanceMethods
-      def initialize(target, args)
-        unless args.is_a? Hash
-          raise ExpectationNotMetError,
-                "You must pass a hash of local var, value pairs to the 'with' modifier"
-        end
-        @target = target
-        @args_str = args.collect do |name, value|
-          set_local_var(name, value)
-        end.join("\n")
-      end
-    end
-    class BlockExpectationTarget < ExpectationTarget
-      include HyperSpecInstanceMethods
-      def with(args)
-        OnClientWithArgsTarget.new(@target, args)
-      end
-    end
-  end
-end

data/lib/hyper-spec/helpers.rb DELETED Viewed

@@ -1,225 +0,0 @@
-module HyperSpec
-  module Helpers
-    include Internal::ClientExecution
-    include Internal::Controller
-    include Internal::ComponentMount
-    include Internal::CopyLocals
-    include Internal::WindowSizing
-    ##
-    # Mount a component on a page, with a full execution environment
-    # i.e. `mount('MyComponent')` will mount MyComponent on the page.
-    # The params argument is a hash of parameters to be passed to the
-    # component.
-    # i.e. `mount('MyComponent', title: 'hello')`
-    # The options parameters can set things like:
-    # + controller: the controller class, defaults to HyperSpecTestController
-    # + no_wait: do not wait for any JS to finish executing before proceeding with the spec
-    # + render_on: :client_only (default), :client_and_server, or :server_only
-    # + style_sheet: style sheet file defaults to 'application'
-    # + javascript:  javascript file defaults to 'application'
-    # + layout: if provided will use the specified layout otherwise no layout is used
-    # Note that if specifying options the params will have to inclosed in their
-    # own hash.
-    # i.e. `mount('MyComponent', { title: 'hello' }, render_on: :server_only)`
-    # The options can be specified globally using the client_options method (see below.)
-    # You may provide a block to mount.  This block will be executed on the client
-    # before mounting the component.  This is useful for setting up test
-    # components or modifying a components behavior.
-    # i.e.
-    # ```ruby
-    # mount('MyComponent', title: 'hello') do
-    #   # this line will be printed on the client console
-    #   puts "I'm about to mount my component!"
-    # end
-    # ```
-    def mount(component_name = nil, params = nil, opts = {}, &block)
-      unless params
-        params = opts
-        opts = {}
-      end
-      internal_mount(component_name, params, client_options(opts), &block)
-    end
-    ##
-    # The following methods retrieve callback and event responses from
-    # the mounted components.  The history methods contain the array of all
-    # responses, while last_... returns the last response.
-    # i.e. event_history_for(:save) would return any save events
-    # that the component has raised.
-    %i[
-      callback_history_for last_callback_for clear_callback_history_for
-      event_history_for last_event_for clear_event_history_for
-    ].each do |method|
-      define_method(method) do |event_name|
-        evaluate_ruby(
-          "Hyperstack::Internal::Component::TopLevelRailsComponent.#{method}('#{event_name}')"
-        )
-      end
-    end
-    ##
-    # Define a code block to be prefixed to the mount code.
-    # Useful in before(:each) blocks.
-    # In legacy code this was called `on_client`. To get the legacy
-    # behavior alias on_client before_mount
-    # but be aware that on_client is now by default the method
-    # for executing a block of code on the client which was called
-    # evaluate_ruby
-    def before_mount(&block)
-      @_hyperspec_private_client_code =
-        "#{@_hyperspec_private_client_code}#{add_opal_block('', block)}"
-    end
-    # Execute the block both on the client and on the server.  Useful
-    # for mocking isomorphic classes such as ActiveRecord models.
-    def isomorphic(&block)
-      yield
-      if page.instance_variable_get('@hyper_spec_mounted')
-        internal_evaluate_ruby(&block)
-      else
-        before_mount(&block)
-      end
-    end
-    # Allows options to the mount method to be specified globally
-    def client_option(opts = {})
-      @_hyperspec_private_client_options ||= { arity_check: default_arity_check }
-      @_hyperspec_private_client_options.merge! opts
-      build_var_inclusion_lists
-      @_hyperspec_private_client_options
-    end
-    def default_arity_check
-      Rails.application.config.opal.arity_check_enabled if defined? Rails
-    rescue StandardError
-      false
-    end
-    alias client_options client_option
-    ##
-    # shorthand for mount with no params (which will effectively reload the page.)
-    # also aliased as reload_page
-    def load_page
-      mount
-    end
-    alias reload_page load_page
-    ##
-    # evaluate a block (or string) on the client
-    #   on_client(<optional str>, <opts and/or vars>, &block)
-    #
-    # normal use is to pass a block that will be compiled to the client
-    # but if the ruby code can be supplied as a string in the first arg.
-    # opts are passed on to JSON.parse when retrieving the result
-    # from the client.
-    # vars is a hash of name: value pairs.  Each name will be initialized
-    # as a local variable on the client.
-    # example: on_client(x: 12) { x * x } => 144
-    # in legacy code on_client was called before_mount
-    # to get legacy on_client behavior you can alias
-    # on_client before_mount
-    alias on_client internal_evaluate_ruby
-    # attempt to set the window to a particular size
-    def size_window(width = nil, height = nil)
-      hs_internal_resize_to(*determine_size(width, height))
-    rescue StandardError
-      true
-    end
-    # same signature as on_client, but just returns the compiled
-    # js code.  Useful for debugging suspected issues with the
-    # Opal compiler, etc.
-    def to_js(*args, &block)
-      opal_compile(*process_params(*args, &block))
-    end
-    # legacy methods for backwards compatibility
-    # these may be removed in a future version
-    def expect_evaluate_ruby(*args, &block)
-      expect(evaluate_ruby(*args, &block))
-    end
-    alias evaluate_ruby internal_evaluate_ruby
-    alias evaluate_promise evaluate_ruby
-    alias expect_promise expect_evaluate_ruby
-    def run_on_client(&block)
-      script = opal_compile(Unparser.unparse(Parser::CurrentRuby.parse(block.source).children.last))
-      page.execute_script(script)
-    end
-    def insert_html(str)
-      @_hyperspec_private_html_block = "#{@_hyperspec_private_html_block}\n#{str}"
-    end
-    def ppr(str)
-      js = opal_compile(str)
-      execute_script("console.log(#{js})")
-    end
-    def debugger
-      `debugger`
-      nil
-    end
-    def add_class(class_name, style)
-      @_hyperspec_private_client_code =
-        "#{@_hyperspec_private_client_code}ComponentHelpers.add_class('#{class_name}', #{style})\n"
-    end
-    def attributes_on_client(model)
-      evaluate_ruby("#{model.class.name}.find(#{model.id}).attributes").symbolize_keys
-    end
-    ### --- Debugging Helpers ----
-    def pause(message = nil)
-      if message
-        puts message
-        internal_evaluate_ruby "puts #{message.inspect}.to_s + ' (type go() to continue)'"
-      end
-      page.evaluate_script('window.hyper_spec_waiting_for_go = true')
-      loop do
-        sleep 0.25
-        break unless page.evaluate_script('window.hyper_spec_waiting_for_go')
-      end
-    end
-    def open_in_chrome
-      # if ['linux', 'freebsd'].include?(`uname`.downcase)
-      #   `google-chrome http://#{page.server.host}:#{page.server.port}#{page.current_path}`
-      # else
-      `open http://#{page.server.host}:#{page.server.port}#{page.current_path}`
-      # end
-      loop do
-        sleep 1.hour
-      end
-    end
-    # short hand for use in pry sessions
-    alias c? internal_evaluate_ruby
-  end
-end