Merge branch 'fix-4-anchor-link' into develop

Author: jonasjabari

Gemfile

@@ -26,7 +26,7 @@ group :development, :test do
   gem 'puma'
   gem 'simplecov', require: false, group: :test
   gem 'byebug'
-  # gem 'pry-byebug'
+  gem 'pry-byebug'
   gem 'webmock'
   gem 'webdrivers', '~> 4.1'
 end

Gemfile.lock

@@ -80,6 +80,7 @@ GEM
       cells (>= 4.1.6, < 5.0.0)
     childprocess (0.9.0)
       ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.2)
     concurrent-ruby (1.1.5)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
@@ -125,6 +126,12 @@ GEM
     nokogiri (1.10.5)
       mini_portile2 (~> 2.4.0)
     pipetree (0.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
     public_suffix (3.0.3)
     puma (4.3.1)
       nio4r (~> 2.0)
@@ -253,6 +260,7 @@ DEPENDENCIES
   cells-rails
   generator_spec
   matestack-ui-core!
+  pry-byebug
   puma
   rspec-rails (~> 3.8)
   selenium-webdriver

app/concepts/matestack/ui/core/app/app.js

@@ -1,7 +1,7 @@
 import Vue from 'vue/dist/vue.esm'
-import axios from 'axios'
 import VRuntimeTemplate from "v-runtime-template"
 import Vuex from 'vuex'
+import isNavigatingToAnotherPage from "./location"
 
 const componentDef = {
   props: ['appConfig', 'params'],
@@ -12,9 +12,10 @@ const componentDef = {
     asyncTemplate: state => state.pageTemplate,
   }),
   mounted: function(){
-    const self = this;
-    window.onpopstate = function(event) {
-      self.$store.dispatch("navigateTo", {url: document.location.pathname, backwards: true} );
+    window.onpopstate = (event) => {
+      if (isNavigatingToAnotherPage(document.location, event)) {
+        this.$store.dispatch("navigateTo", {url: document.location.pathname, backwards: true} );
+      };
     }
   },
   components: {

app/concepts/matestack/ui/core/app/location.js

@@ -0,0 +1,10 @@
+const isNavigatingToAnotherPage = function(currentLocation, popstateEvent) {
+  const targetLocation = popstateEvent.target.location;
+
+  // omits hash by design
+  return currentLocation.pathname !== targetLocation.pathname ||
+    currentLocation.origin !== targetLocation.origin ||
+    currentLocation.search !== targetLocation.search
+}
+
+export default isNavigatingToAnotherPage

spec/spec_helper.rb

@@ -36,6 +36,8 @@
 
 Dir[File.join File.dirname(__FILE__), 'support', '**', '*.rb'].each { |f| require f }
 
+require 'pry'
+
 RSpec.configure do |config|
   # config.include Capybara::DSL
   # rspec-expectations config goes here. You can use an alternate

spec/usage/components/link_spec.rb

@@ -179,4 +179,140 @@ def response
     expect(stripped(static_output)).to ( include(stripped(expected_static_output)) )
   end
 
+  it "behaves correctly with anchor links (no reload, retain anchor)" do
+    class ExamplePage < Matestack::Ui::Page
+      def response
+        components {
+          link path: "#someanchor", text: "go to anchor", id: "my-link"
+
+          br times: 200
+
+          div id: "someanchor" do
+            plain "hello!"
+          end
+
+          div id: "my-div" do
+            plain "#{DateTime.now.strftime('%Q')}"
+          end
+        }
+      end
+    end
+
+    visit "/example"
+
+    element = page.find("#my-div")
+    before_content = element.text
+
+    # don't you rerender on me!
+    expect(ExamplePage).not_to receive(:new)
+
+    page.click_link("my-link")
+
+    # if the page reloaded we'd have different content here but as we don't want reloads
+    # we want the same
+    expect(page).to have_css("#my-div", text: before_content)
+    expect(page.current_url).to end_with("#someanchor")
+  end
+
+  describe "with an App" do
+
+    after :each do
+      class ExamplePage < Matestack::Ui::Page
+        # as the test suites work with redefining classes and this
+        # hack here was used to set a specific app easily,
+        # we need to "restore" previous state
+        def set_app_class
+          super
+        end
+      end
+    end
+
+    it "behaves correctly with anchor links (no reload, retain anchor) even inside an app" do
+      class Apps::MyTestApp < Matestack::Ui::App
+        def response
+          components {
+            page_content
+          }
+        end
+      end
+
+      class ExamplePage < Matestack::Ui::Page
+        def response
+          components {
+            link path: "#someanchor", text: "go to anchor", id: "my-link"
+
+            br times: 200
+
+            div id: "someanchor" do
+              plain "hello!"
+            end
+
+            div id: "my-div" do
+              plain "#{DateTime.now.strftime('%Q')}"
+            end
+          }
+        end
+
+        # Hacky/instable but easy way to set my custom App for this page
+        def set_app_class
+          @app_class = Apps::MyTestApp
+        end
+      end
+
+      visit "/example"
+
+      element = page.find("#my-div")
+      before_content = element.text
+
+      # don't you rerender on me!
+      expect(ExamplePage).not_to receive(:new)
+
+      page.click_link("my-link")
+
+      # if the page reloaded we'd have different content here but as we don't want reloads
+      # we want the same
+      expect(page).to have_css("#my-div", text: before_content)
+      expect(page.current_url).to end_with("#someanchor")
+    end
+
+    it "just changing the search string will still reload the page" do
+      class Apps::MyTestApp < Matestack::Ui::App
+        def response
+          components {
+            page_content
+          }
+        end
+      end
+
+      class ExamplePage < Matestack::Ui::Page
+        def response
+          components {
+            link path: "?a=true", text: "go to anchor", id: "my-link"
+
+            br times: 200
+
+            div id: "my-div" do
+              plain "#{DateTime.now.strftime('%Q')}"
+            end
+          }
+        end
+
+        # Hacky/instable but easy way to set my custom App for this page
+        def set_app_class
+          @app_class = Apps::MyTestApp
+        end
+      end
+
+      visit "/example"
+
+      element = page.find("#my-div")
+      before_content = element.text
+
+      page.click_link("my-link")
+
+      expect(page).to have_css("#my-div")
+      expect(page).to have_no_css("#my-div", text: before_content)
+      expect(page.current_url).to end_with("?a=true")
+    end
+  end
 end