From a59ad3936a0bdbfd64d9c54af631a272317fe680 Mon Sep 17 00:00:00 2001 From: Timothy Andrew Date: Thu, 5 May 2016 15:38:01 +0530 Subject: [PATCH 1/3] Add a spec for `WikiLinkFilter` - And fix behavior for non-file hierarchical links. --- lib/banzai/filter/wiki_link_filter.rb | 11 ++- .../banzai/filter/wiki_link_filter_spec.rb | 77 +++++++++++++++++++ 2 files changed, 85 insertions(+), 3 deletions(-) create mode 100644 spec/lib/banzai/filter/wiki_link_filter_spec.rb diff --git a/lib/banzai/filter/wiki_link_filter.rb b/lib/banzai/filter/wiki_link_filter.rb index 06d10c98501b..7dc771afd71a 100644 --- a/lib/banzai/filter/wiki_link_filter.rb +++ b/lib/banzai/filter/wiki_link_filter.rb @@ -25,7 +25,7 @@ def project_wiki? end def process_link_attr(html_attr) - return if html_attr.blank? || file_reference?(html_attr) + return if html_attr.blank? || file_reference?(html_attr) || hierarchical_link?(html_attr) uri = URI(html_attr.value) if uri.relative? && uri.path.present? @@ -40,12 +40,17 @@ def rebuild_wiki_uri(uri) uri end + def project_wiki + context[:project_wiki] + end + def file_reference?(html_attr) !File.extname(html_attr.value).blank? end - def project_wiki - context[:project_wiki] + # Of the form `./link`, `../link`, or similar + def hierarchical_link?(html_attr) + html_attr.value[0] == '.' end def project_wiki_base_path diff --git a/spec/lib/banzai/filter/wiki_link_filter_spec.rb b/spec/lib/banzai/filter/wiki_link_filter_spec.rb new file mode 100644 index 000000000000..56b1a2673902 --- /dev/null +++ b/spec/lib/banzai/filter/wiki_link_filter_spec.rb @@ -0,0 +1,77 @@ +require 'spec_helper' + +describe Banzai::Filter::WikiLinkFilter, lib: true do + include FilterSpecHelper + + let(:namespace) { build(:namespace, name: "wiki_link_ns") } + let(:project) { build(:empty_project, :public, name: "wiki_link_project", namespace: namespace) } + let(:user) { double } + let(:project_wiki) { ProjectWiki.new(project, user) } + + describe "links within the wiki (relative)" do + describe "hierarchical links to the current directory" do + it "doesn't rewrite non-file links" do + link = "Link to Page" + filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('./page') + end + + it "doesn't rewrite file links" do + link = "Link to Page" + filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('./page.md') + end + end + + describe "hierarchical links to the parent directory" do + it "doesn't rewrite non-file links" do + link = "Link to Page" + filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('../page') + end + + it "doesn't rewrite file links" do + link = "Link to Page" + filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('../page.md') + end + end + + describe "hierarchical links to a sub-directory" do + it "doesn't rewrite non-file links" do + link = "Link to Page" + filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('./subdirectory/page') + end + + it "doesn't rewrite file links" do + link = "Link to Page" + filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('./subdirectory/page.md') + end + end + + describe "non-hierarchical links" do + it 'rewrites non-file links to be at the scope of the wiki root' do + link = "Link to Page" + filtered_link = filter(link, project_wiki: project_wiki).children[0] + + expect(filtered_link.attribute('href').value).to match('/wiki_link_ns/wiki_link_project/wikis/page') + end + + it "doesn't rewrite file links" do + link = "Link to Page" + filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('page.md') + end + end + end + + describe "links outside the wiki (absolute)" do + it "doesn't rewrite links" do + link = "Link to Page" + filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('http://example.com/page') + end + end +end -- GitLab From a4ee7d25e398f9d2e2311703fbbcf5f6b9bdf728 Mon Sep 17 00:00:00 2001 From: Timothy Andrew Date: Mon, 9 May 2016 16:04:05 +0530 Subject: [PATCH 2/3] Implement @rymai's feedback after review. - Separate 'exercise' and 'verify' steps of tests. - Use `build_stubbed` instead of `build` --- spec/lib/banzai/filter/wiki_link_filter_spec.rb | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/spec/lib/banzai/filter/wiki_link_filter_spec.rb b/spec/lib/banzai/filter/wiki_link_filter_spec.rb index 56b1a2673902..185abbb21080 100644 --- a/spec/lib/banzai/filter/wiki_link_filter_spec.rb +++ b/spec/lib/banzai/filter/wiki_link_filter_spec.rb @@ -3,8 +3,8 @@ describe Banzai::Filter::WikiLinkFilter, lib: true do include FilterSpecHelper - let(:namespace) { build(:namespace, name: "wiki_link_ns") } - let(:project) { build(:empty_project, :public, name: "wiki_link_project", namespace: namespace) } + let(:namespace) { build_stubbed(:namespace, name: "wiki_link_ns") } + let(:project) { build_stubbed(:empty_project, :public, name: "wiki_link_project", namespace: namespace) } let(:user) { double } let(:project_wiki) { ProjectWiki.new(project, user) } @@ -13,12 +13,14 @@ it "doesn't rewrite non-file links" do link = "Link to Page" filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('./page') end it "doesn't rewrite file links" do link = "Link to Page" filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('./page.md') end end @@ -27,12 +29,14 @@ it "doesn't rewrite non-file links" do link = "Link to Page" filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('../page') end it "doesn't rewrite file links" do link = "Link to Page" filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('../page.md') end end @@ -41,12 +45,14 @@ it "doesn't rewrite non-file links" do link = "Link to Page" filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('./subdirectory/page') end it "doesn't rewrite file links" do link = "Link to Page" filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('./subdirectory/page.md') end end @@ -62,6 +68,7 @@ it "doesn't rewrite file links" do link = "Link to Page" filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('page.md') end end @@ -71,6 +78,7 @@ it "doesn't rewrite links" do link = "Link to Page" filtered_link = filter(link, project_wiki: project_wiki).children[0] + expect(filtered_link.attribute('href').value).to eq('http://example.com/page') end end -- GitLab From 555610b619b552ca058a7656f373743db4d34765 Mon Sep 17 00:00:00 2001 From: Timothy Andrew Date: Tue, 10 May 2016 09:04:14 +0530 Subject: [PATCH 3/3] Add CHANGELOG entry. --- CHANGELOG | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG b/CHANGELOG index d5ab79602f2c..187011c60167 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -44,6 +44,9 @@ v 8.8.0 (unreleased) - Fix adding a todo for private group members (Ahmad Sherif) - Bump ace-rails-ap gem version from 2.0.1 to 4.0.2 which upgrades Ace Editor from 1.1.2 to 1.2.3 +v 8.7.5 + - Fix relative links in wiki pages. !4050 + v 8.7.4 - Links for Redmine issue references are generated correctly again !4048 (Benedikt Huss) - Fix setting trusted proxies !3970 -- GitLab