Merge pull request #466 from matestack/next-release

1.0.1 Release

Author: jonasjabari

Diff for: CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v1.0.1 Release
+
+This release contains bugfixes.
+
+### Bugfixes
+
+*  Fixed javascript automatic scroll top on page transition for short pages #462
+*  Enable async components on app level, only usable in pages and components before #458
+*  Fixed duplicate directory error when using matestack-ui-core with webpacker #460
+
+
 ## v1.0.0 Release
 
 Please note that this release contains breaking changes and soft deprecations. To make things easy for users of the current `v0.7.*` version, we have provided **Migration TODOs** at the end of each chapter.

Diff for: Dockerfile.dev

@@ -1,4 +1,4 @@
-FROM ruby:2.6.5-alpine3.9
+FROM ruby:2.7.2-alpine3.12
 
 RUN gem install bundler:2.1.4
 

Diff for: Dockerfile.test

@@ -1,4 +1,4 @@
-FROM ruby:2.6.5-alpine3.9
+FROM ruby:2.7.2-alpine3.12
 
 RUN gem install bundler:2.1.4
 
@@ -20,14 +20,14 @@ RUN apk update && apk upgrade \
     && echo @edge http://nl.alpinelinux.org/alpine/edge/community >> /etc/apk/repositories \
     && echo @edge http://nl.alpinelinux.org/alpine/edge/main >> /etc/apk/repositories \
     && apk add --no-cache \
-    chromium@edge=72.0.3626.121-r0 \
+    chromium@edge \
     nss@edge \
     && rm -rf /var/lib/apt/lists/* \
     /var/cache/apk/* \
     /usr/share/man \
     /tmp/*
 
-RUN apk add chromium-chromedriver@edge=72.0.3626.121-r0
+RUN apk add chromium-chromedriver@edge
 
 ENV CHROME_BIN=/usr/bin/chromium-browser \
     CHROME_PATH=/usr/lib/chromium/

Diff for: Gemfile

@@ -20,7 +20,7 @@ group :development, :test do
   gem 'capybara'
   gem 'webpacker', '~> 4.0'
   gem 'pg', '>= 0.18', '< 2.0'
-  gem 'selenium-webdriver', '~> 3.142', '>= 3.142.7'
+  gem 'selenium-webdriver'
   gem 'puma'
   gem 'simplecov', require: false, group: :test
   gem 'byebug'

Diff for: Gemfile.lock

@@ -197,7 +197,7 @@ GEM
     rspec-support (3.9.2)
     rspec-wait (0.0.9)
       rspec (>= 3, < 4)
-    rubyzip (2.2.0)
+    rubyzip (2.3.0)
     safe_yaml (1.0.5)
     selenium-webdriver (3.142.7)
       childprocess (>= 0.5, < 4.0)
@@ -257,7 +257,7 @@ DEPENDENCIES
   rspec-rails (~> 3.8)
   rspec-retry
   rspec-wait (~> 0.0.9)
-  selenium-webdriver (~> 3.142, >= 3.142.7)
+  selenium-webdriver
   simplecov
   trailblazer-cells
   turbolinks

Diff for: app/concepts/matestack/ui/core/app/store.js

@@ -40,7 +40,11 @@ const store = new Vuex.Store({
           return getScrollParent(node.parentNode)
         }
       }
-      getScrollParent(document.getElementsByClassName("matestack-page-root")[0]).scrollTop = 0
+      var scrollParent = getScrollParent(document.getElementsByClassName("matestack-page-root")[0])
+      if(scrollParent){
+        scrollParent.scrollTop = 0;
+      }
+      // getScrollParent(document.getElementsByClassName("matestack-page-root")[0]).scrollTop = 0
     }
   },
   actions: {

Diff for: 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)

Diff for: builder/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '2.6.5'
+ruby '2.7.2'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 5.2.0'

Diff for: builder/Gemfile.lock

@@ -177,7 +177,7 @@ DEPENDENCIES
   webpacker
 
 RUBY VERSION
-   ruby 2.6.5p114
+   ruby 2.7.2p137
 
 BUNDLED WITH
    2.1.4

Diff for: docs/guides/000-installation/README.md

@@ -27,7 +27,7 @@ Rails 6+ apps use webpacker by default. Rails 5 and below apps use the asset pip
 Add 'matestack-ui-core' to your `package.json` by running:
 
 ```
-$ yarn add https://github.com/matestack/matestack-ui-core#v1.0.0
+$ yarn add https://github.com/matestack/matestack-ui-core#v1.0.1
 $ yarn install
 ```
 
@@ -127,11 +127,11 @@ For further reading check out the [basic building blocks](/docs/guides/200-basic
 
 ## Usage
 
-There are two ways to use matestack. 
+There are two ways to use matestack.
 
 ### Full matestack
 
-First, as we call it, _full matestack_, enabling all features and developing with all benefits. Learn more about the _full matestack_  approach by following the [tutorial](/docs/guides/100-tutorial/README.md) or reading about matestacks [basic building blocks](/docs/guides/200-basic_building_blocks/README.md). 
+First, as we call it, _full matestack_, enabling all features and developing with all benefits. Learn more about the _full matestack_  approach by following the [tutorial](/docs/guides/100-tutorial/README.md) or reading about matestacks [basic building blocks](/docs/guides/200-basic_building_blocks/README.md).
 
 ### Integration in existing projects
 

Diff for: lib/matestack/ui/core/version.rb

@@ -1,7 +1,7 @@
 module Matestack
   module Ui
     module Core
-      VERSION = '1.0.0'
+      VERSION = '1.0.1'
     end
   end
 end

Diff for: package.json

@@ -1,6 +1,6 @@
 {
   "name": "matestack-ui-core",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "app/javascript/matestack-ui-core",
   "private": true,
   "dependencies": {

Diff for: spec/dummy/vendor/matestack-ui-core

@@ -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'

Diff for: spec/rails_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

Diff for: spec/spec_helper.rb

@@ -12,8 +12,8 @@ def response
       end
 
       visit "/example"
-      static_output = page.html
-      expect(static_output).to include("<h1>#{XSS::ESCAPED_EVIL_SCRIPT}</h1>")
+      expect(page).to have_selector('h1', text: XSS::EVIL_SCRIPT)
+      expect_alert false
     end
 
     it "does not escape when we specifically say #html_safe" do
@@ -26,10 +26,8 @@ def response
       # gotta accept our injected alert
       accept_alert do
         visit "/example"
+        expect_alert true
       end
-
-      # for reasons beyond me Chrome seems to remove our injected script tag,
-      # but since we accepted an alert to get here this test should be fine
     end
 
     # note that `heading do "string" end` doesn't work and you
@@ -47,6 +45,7 @@ def response
       end
 
       visit "/example"
+      expect_alert false
       static_output = page.html
       expect(static_output).not_to include("alert(")
     end
@@ -59,7 +58,20 @@ def response
       end
 
       visit "/example"
-      expect(page.html).to include("id=\"something-&quot;&gt;&lt;script&gt;alert('hello');&lt;/script&gt;")
+      expect_alert false
+      # expect(page.html).to include("id=\"something-&quot;&gt;&lt;script&gt;alert('hello');&lt;/script&gt;")
+    end
+  end
+
+  
+
+  def expect_alert(alert)
+    @alert = true
+    begin
+      page.driver.browser.switch_to.alert
+    rescue
+      @alert = false        
     end
+    expect(@alert).to be(alert)
   end
 end

Diff for: spec/test/base/xss_spec.rb

@@ -1,20 +1,17 @@
-require_relative "../support/utils"
-include Utils
+require 'rails_helper'
 
 describe "Address Component", type: :feature, js: true do
+  include Utils
+
   it "Example 1 - yield a given block" do
+    matestack_render do
+        area shape: :rect, coords: [1,2,3,4], href: '#', hreflang: 'de', 
+          media: "screen", rel: 'nofollow', target: :_blank
+    end    
 
-    class ExamplePage < Matestack::Ui::Page
-      def response
-        area shape: :rect, coords: [1,2,3,4], href: '#', hreflang: 'de', media: "screen", rel: 'nofollow', target: :_blank
-      end
-    end
-    
-    visit "/example"
-    static_output = page.html
-    expected_static_output = <<~HTML
-    <area coords="1,2,3,4" href="#" hreflang="de" media="screen" rel="nofollow" shape="rect" target="_blank" />
-    HTML
-    expect(stripped(static_output)).to include(stripped(expected_static_output))
+    expect(page).to have_selector(
+      "area[shape='rect'][coords='1,2,3,4'][href='#'][hreflang='de'][media='screen'][rel='nofollow'][target='_blank']", 
+      visible: false
+    )
   end
 end

Diff for: spec/test/components/area_spec.rb

@@ -1,45 +1,14 @@
-require_relative '../support/utils'
-include Utils
+require 'rails_helper'
 
 describe 'Br Component', type: :feature, js: true do
+  include Utils
 
   it 'Example 1' do
-
-    class ExamplePage < Matestack::Ui::Page
-      def response
-        # simple br tag
-        plain 'hello'
-        br
-        plain 'world!'
-        # multiple br tags
-        plain 'hello'
-        br times: 5
-        plain 'world!'
-        # br tag with id and class
-        plain 'hello'
-        br id: 'my-br', class: 'fancy-br-class'
-        plain 'world!'
-      end
+    matestack_render do
+      br
+      br
     end
-
-    visit "/example"
-    static_output = page.html
-    expected_static_output = <<~HTML
-      hello
-      <br/>
-      world!
-      hello
-      <br/>
-      <br/>
-      <br/>
-      <br/>
-      <br/>
-      world!
-      hello
-      <br id="my-br" class="fancy-br-class"/>
-      world!
-    HTML
-    expect(stripped(static_output)).to ( include(stripped(expected_static_output)) )
+    expect(page).to have_selector('br', count: 2, visible: false)
   end
 
 end

Diff for: spec/test/components/br_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