[REFACTOR] rename isolate to isolated, fix skip children rendering, add legacy view spec

Nils Henning · Nils Henning · commit a0bef79e5c48 · 2020-08-11T11:50:14.000+02:00
diff --git a/app/concepts/matestack/ui/core/component/base.rb b/app/concepts/matestack/ui/core/component/base.rb
@@ -231,23 +231,23 @@ def add_child(child_class, *args, &block)
       # the childs content in order to respond to the subsequent component rendering call with
       # the childs content. In this case: "I should be deferred"
       skip_deferred_child_response = false
-      if child_class <= Matestack::Ui::Core::Async::Async || child_class < Matestack::Ui::Core::Isolate::Isolate
+      if child_class <= Matestack::Ui::Core::Async::Async || child_class < Matestack::Ui::Core::Isolated::Isolated
         if args.any? { |arg| arg[:defer].present? } && @matestack_skip_defer == true
           skip_deferred_child_response = true
         end
       end
 
       # check only allowed keys are passed to isolated components
-      if child_class < Matestack::Ui::Core::Isolate::Isolate
-        unless args.empty? || args[0].keys.all? { |key| [:defer, :public_options, :rerender_on, :init_on, :rerender_delay].include? key }
+      if child_class < Matestack::Ui::Core::Isolated::Isolated
+        unless args.empty? || args[0].keys.all? { |key| [:defer, :public_options, :rerender_on, :init_on, :rerender_delay, :matestack_context].include? key }
           raise "isolated components can only take params in a public_options hash, which will be exposed to the client side in order to perform an async request with these params."
         end
         if args.any? { |arg| arg[:init_on].present? } && @matestack_skip_defer == true
           skip_deferred_child_response = true
         end
       end
 
-      if self.class < Matestack::Ui::Core::Isolate::Isolate
+      if self.class < Matestack::Ui::Core::Isolated::Isolated
         parent_context_included_config = @current_parent_context.get_included_config || {}
         parent_context_included_config.merge!({ isolated_parent_class: self.class.name })
         args_with_context = add_context_to_options(args,parent_context_included_config)
diff --git a/app/concepts/matestack/ui/core/isolated/isolated.haml b/app/concepts/matestack/ui/core/isolated/isolated.haml
diff --git a/app/concepts/matestack/ui/core/isolated/isolated.js b/app/concepts/matestack/ui/core/isolated/isolated.js
@@ -71,21 +71,15 @@ const componentDef = {
   },
   mounted: function (){
     const self = this
-    console.log('mounted isolated component')
     if(this.componentConfig["init_on"] === undefined || this.componentConfig["init_on"] === null){
-      console.log('Its me')
       if(self.componentConfig["defer"] == true || Number.isInteger(self.componentConfig["defer"])){
-        console.log('I should render deferred')
         if(!isNaN(self.componentConfig["defer"])){
           self.startDefer()
         }
         else{
           self.renderIsolatedContent();
         }
       }
-      else {
-        console.log('I should NOT render deferred')
-      }
     }else{
       if(self.componentConfig["defer"] != undefined){
         if(!isNaN(self.componentConfig["defer"])){
diff --git a/app/concepts/matestack/ui/core/isolated/isolated.rb b/app/concepts/matestack/ui/core/isolated/isolated.rb
@@ -1,5 +1,5 @@
-module Matestack::Ui::Core::Isolate
-  class Isolate < Matestack::Ui::Core::Component::Dynamic
+module Matestack::Ui::Core::Isolated
+  class Isolated < Matestack::Ui::Core::Component::Dynamic
     vue_js_component_name "matestack-ui-core-isolate"
 
     def initialize(*args)
@@ -11,9 +11,9 @@ def public_options
       @public_options ||= {}
     end
 
-    def params
-      context[:params] ||= {}
-    end
+    # def params
+    #   context[:params] || matestack_context[:params]
+    # end
 
     def setup
       @component_config[:component_class] = self.class.name
@@ -35,7 +35,7 @@ def render_content
 
     # only render vuejs component wrapper on show
     def show
-      render :isolate
+      render :isolated
     end
 
     # this method gets called when the isolate vuejs component requests isolated content
diff --git a/app/concepts/matestack/ui/core/js/core.js b/app/concepts/matestack/ui/core/js/core.js
@@ -16,7 +16,7 @@ import onclick from '../onclick/onclick'
 import collectionContent from '../collection/content/content'
 import collectionFilter from '../collection/filter/filter'
 import collectionOrder from '../collection/order/order'
-import isolate from '../isolate/isolate'
+import isolate from '../isolated/isolated'
 
 let matestackUiApp = undefined
 
diff --git a/app/lib/matestack/ui/core/rendering/main_renderer.rb b/app/lib/matestack/ui/core/rendering/main_renderer.rb
@@ -153,7 +153,7 @@ def resolve_component(name)
 
   def resolve_isolated_component(name)
     constant = const_get(name)
-    if constant < Matestack::Ui::Core::Isolate::Isolate
+    if constant < Matestack::Ui::Core::Isolated::Isolated
       constant
     else
       nil
diff --git a/app/lib/matestack/ui/isolated_component.rb b/app/lib/matestack/ui/isolated_component.rb
@@ -1 +1 @@
-Matestack::Ui::IsolatedComponent = Matestack::Ui::Core::Isolate::Isolate
+Matestack::Ui::IsolatedComponent = Matestack::Ui::Core::Isolated::Isolated
diff --git a/docs/api/base/backend/isolate.md b/docs/api/base/backend/isolate.md
@@ -1,6 +1,6 @@
 # Matestack Core Component: Isolate
 
-Feel free to check out the [component specs](/spec/usage/components/dynamic/isolate).
+Feel free to check out the [component specs](/spec/test/components/dynamic/isolated).
 
 The isolate component allows you to create components, which can be rendered independently. It means that isolate components are rendered without calling the response method of your page, which gives you the possibility to rerender components dynamically without rerendering the whole UI. 
 
diff --git a/lib/matestack/ui/core/components.rb b/lib/matestack/ui/core/components.rb
@@ -85,7 +85,7 @@ def self.require_core_component(name)
   require_core_component "img"
   require_core_component "input"
   require_core_component "ins"
-  require_core_component "isolate"
+  require_core_component "isolated"
   require_core_component "kbd"
   require_core_component "label"
   require_core_component "legend"
diff --git a/spec/dummy/app/controllers/legacy_views/pages_controller.rb b/spec/dummy/app/controllers/legacy_views/pages_controller.rb
@@ -45,6 +45,10 @@ def form_custom_component
   def onclick_custom_component
   end
 
+  def isolated_custom_component
+    render 'isolated_custom_component'
+  end
+
   def success
     render json: params.to_unsafe_h, status: :ok
   end
diff --git a/spec/dummy/app/matestack/components/legacy_views/pages/isolated.rb b/spec/dummy/app/matestack/components/legacy_views/pages/isolated.rb
@@ -0,0 +1,13 @@
+class Components::LegacyViews::Pages::Isolated < Matestack::Ui::IsolatedComponent
+
+  def response
+    div class: 'my-isolated' do
+      plain I18n.l(DateTime.now)
+    end
+  end
+
+  def authorized?
+    true
+  end
+
+end
diff --git a/spec/dummy/app/matestack/components/registry.rb b/spec/dummy/app/matestack/components/registry.rb
@@ -11,6 +11,7 @@ module Components::Registry
     legacy_views_pages_collection: Components::LegacyViews::Pages::Collection,
     legacy_views_pages_form: Components::LegacyViews::Pages::Form,
     legacy_views_pages_onclick: Components::LegacyViews::Pages::Onclick,
+    legacy_views_pages_isolated: Components::LegacyViews::Pages::Isolated,
   )
 
 end
diff --git a/spec/dummy/app/views/legacy_views/pages/isolated_custom_component.html.erb b/spec/dummy/app/views/legacy_views/pages/isolated_custom_component.html.erb
@@ -0,0 +1,4 @@
+<h1>Isolated Custom Component</h1>
+<%=
+  matestack_component(:legacy_views_pages_isolated, rerender_on: 'update_time' )
+%>
diff --git a/spec/dummy/config/routes.rb b/spec/dummy/config/routes.rb
@@ -54,6 +54,7 @@
     get 'form_inline', to: 'pages#form_inline'
     get 'form_custom_component', to: 'pages#form_custom_component'
     get 'onclick_custom_component', to: 'pages#onclick_custom_component'
+    get 'isolated_custom_component', to: 'pages#isolated_custom_component'
     post 'success', to: 'pages#success'
     post 'failure', to: 'pages#failure'
     post 'create', to: 'pages#create'
diff --git a/spec/test/components/dynamic/async/rerender_spec.rb b/spec/test/components/dynamic/async/rerender_spec.rb
@@ -256,12 +256,10 @@ def response
         expect(page).to have_content("#{item} -", count: 1)
       end
       initial_content = (0..5).map { |item| page.find("#my-div-#{item}").text }
-      save_screenshot
   
       # rerender first list element asynchronously, others should not change
       page.execute_script('MatestackUiCore.matestackEventHub.$emit("my_event_0")')
       expect(page).not_to have_content(initial_content[0])
-      save_screenshot
       initial_content[0] = page.find("#my-div-0").text
       (0..5).each do |item| 
         expect(page).to have_content("#{item} -", count: 1)
diff --git a/spec/test/components/dynamic/isolated/defer_spec.rb b/spec/test/components/dynamic/isolated/defer_spec.rb
@@ -1,7 +1,7 @@
 require_relative "../../../support/utils"
 include Utils
 
-describe "Isolate Component defer", type: :feature, js: true do
+describe "Isolated Component defer", type: :feature, js: true do
 
   before :all do
     class TouchedElementsCounter
diff --git a/spec/test/components/dynamic/isolated/isolated_spec.rb b/spec/test/components/dynamic/isolated/isolated_spec.rb
diff --git a/spec/test/components/legacy_views/isolated_spec.rb b/spec/test/components/legacy_views/isolated_spec.rb
@@ -0,0 +1,19 @@
+require_relative "../../support/utils"
+include Utils
+
+describe "Isolated Component", type: :feature, js: true do
+
+  it 'should work on rails legacy views' do
+    visit 'legacy_views/isolated_custom_component'
+
+    expect(page).to have_content('Isolated Custom Component')
+    expect(page).to have_css('.my-isolated')
+    initial_timestamp = page.find(".my-isolated").text #initial page load
+    sleep
+    page.execute_script('MatestackUiCore.matestackEventHub.$emit("update_time")')
+    expect(page).to have_content('Isolated Custom Component')
+    expect(page).to have_css('.my-isolated')
+    expect(page).not_to have_content(initial_timestamp)
+  end
+
+end
diff --git a/vendor/assets/javascripts/dist/matestack-ui-core.js b/vendor/assets/javascripts/dist/matestack-ui-core.js
diff --git a/vendor/assets/javascripts/dist/matestack-ui-core.js.map b/vendor/assets/javascripts/dist/matestack-ui-core.js.map

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-Matestack::Ui::IsolatedComponent = Matestack::Ui::Core::Isolate::Isolate`
	`1`	`+Matestack::Ui::IsolatedComponent = Matestack::Ui::Core::Isolated::Isolated`