Merge pull request #463 from matestack/20201006_#458_async-on-app-level

Enable async components on app level

Author: NdotHenning

app/lib/matestack/ui/core/rendering/main_renderer.rb

@@ -21,9 +21,10 @@ def render(controller_instance, page_class, options)
       render_matestack_object(controller_instance, page_instance)
     elsif (params[:component_key].present? && params[:component_class].blank?)
       # async component rerendering from non isolated context
+      app_instance = app_class.new(page_class, controller_instance, context)
       component_key = params[:component_key]
       page_instance = page_class.new(controller_instance: controller_instance, context: context)
-      render_component(component_key, page_instance, controller_instance, context)
+      render_component(component_key, app_instance, controller_instance, context)
     elsif (params[:component_class].present? && params[:component_key].blank?)
       # isolated component rendering
       component_class = params[:component_class]
@@ -75,15 +76,15 @@ def render_matestack_object(controller_instance, object, opts = {}, render_metho
     controller_instance.render rendering_options
   end
 
-  def render_component(component_key, page_instance, controller_instance, context)
+  def render_component(component_key, app_or_page_instance, controller_instance, context)
     matched_component = nil
 
-    page_instance.matestack_set_skip_defer(false)
+    app_or_page_instance.matestack_set_skip_defer(false)
 
-    page_instance.prepare
-    page_instance.response
+    app_or_page_instance.prepare
+    app_or_page_instance.response
 
-    matched_component = dig_for_component(component_key, page_instance)
+    matched_component = dig_for_component(component_key, app_or_page_instance)
 
     unless matched_component.nil?
       render_matestack_object(controller_instance, matched_component, {}, :render_content)

spec/rails_helper.rb

@@ -1,7 +1,7 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
 require 'spec_helper'
 ENV['RAILS_ENV'] ||= 'test'
-require File.expand_path('../../config/environment', __FILE__)
+# require File.expand_path('../../config/environment', __dir__)
 # Prevent database truncation if the environment is production
 abort("The Rails environment is running in production mode!") if Rails.env.production?
 require 'rspec/rails'

spec/spec_helper.rb

@@ -140,4 +140,14 @@
   # as the one that triggered the failure.
   Kernel.srand config.seed
 =end
+
+  config.before :all, type: :feature do
+    unless Rails.application.routes.url_helpers.method_defined?(:matestack_components_test_path)
+      Rails.application.routes.append do
+        get '/matestack_components_test', to: 'matestack_components#matestack_components_test', as: :matestack_components_test 
+      end
+      Rails.application.reload_routes!
+    end
+  end
+
 end

spec/test/components/dynamic/async/app_level_spec.rb

@@ -0,0 +1,42 @@
+require 'rails_helper'
+
+describe "Async Component", type: :feature, js: true do
+  include Utils
+
+  it 'works on page level' do
+    matestack_render do
+      async id: 'async', rerender_on: 'update' do
+        plain 'Time now: '
+        paragraph text: DateTime.now.strftime("%Q")
+      end
+    end
+
+    expect(page).to have_content('Time now:')
+    initial_timestamp = page.find("p").text # initial page load
+    page.execute_script('MatestackUiCore.matestackEventHub.$emit("update")')
+    expect(page).to have_content('Time now:')
+    expect(page).not_to have_content(initial_timestamp)
+  end
+
+  it 'should work on app level' do
+    matestack_app do
+      async id: 'async', rerender_on: 'update' do
+        plain 'Time now: '
+        paragraph text: DateTime.now.strftime("%Q")
+      end
+      yield_page
+    end
+    matestack_render reset_app: false do
+      plain 'A page inside the app'
+    end
+
+    expect(page).to have_content('A page inside the app')
+    expect(page).to have_content('Time now:')
+    initial_timestamp = page.find("p").text # initial page load
+    page.execute_script('MatestackUiCore.matestackEventHub.$emit("update")')
+    expect(page).to have_content('Time now:')
+    expect(page).not_to have_content(initial_timestamp)
+    reset_matestack_app
+  end
+
+end

spec/test/support/matestack_components_controller.rb

@@ -0,0 +1,9 @@
+class MatestackComponentsController < ApplicationController
+  include Matestack::Ui::Core::ApplicationHelper
+
+  matestack_app MatestackWrapperApp
+
+  def matestack_components_test
+    render MatestackWrapperPage
+  end
+end

spec/test/support/matestack_wrapper_app.rb

@@ -0,0 +1,5 @@
+class MatestackWrapperApp < Matestack::Ui::App
+  def response
+    yield_page
+  end
+end

spec/test/support/matestack_wrapper_page.rb

@@ -0,0 +1,4 @@
+class MatestackWrapperPage < Matestack::Ui::Page
+  def response
+  end
+end

spec/test/support/utils.rb

@@ -23,4 +23,18 @@ def register_component(dsl_method, component_class)
   def register_self_as(dsl_method)
     register_component(dsl_method, self)
   end
+
+  def matestack_render(reset_app: true, &block)
+    MatestackWrapperPage.define_method(:response, block)
+    visit matestack_components_test_path 
+    reset_matestack_app if reset_app
+  end
+
+  def matestack_app(&block)
+    MatestackWrapperApp.define_method(:response, block)
+  end
+
+  def reset_matestack_app
+    matestack_app { yield_page }
+  end
 end