diff options
| -rw-r--r-- | app/controllers/help_controller.rb | 30 | ||||
| -rw-r--r-- | app/views/help/show.html.haml | 2 | ||||
| -rw-r--r-- | config/initializers/mime_types.rb | 1 | ||||
| -rw-r--r-- | config/routes.rb | 2 | ||||
| -rw-r--r-- | features/steps/dashboard/help.rb | 2 | ||||
| -rw-r--r-- | spec/features/help_pages_spec.rb | 2 | ||||
| -rw-r--r-- | spec/routing/routing_spec.rb | 38 |
7 files changed, 30 insertions, 47 deletions
diff --git a/app/controllers/help_controller.rb b/app/controllers/help_controller.rb index 0e5567c7734..964f624d6d7 100644 --- a/app/controllers/help_controller.rb +++ b/app/controllers/help_controller.rb @@ -3,40 +3,24 @@ class HelpController < ApplicationController end def show - @filepath = clean_path_info(params[:filepath]) - @format = params[:format] + @category = clean_path_info(params[:category]) + @file = clean_path_info(params[:file]) - respond_to do |format| - format.md { render_doc } - format.all { send_file_data } - end - end - - def shortcuts - end - - private - - def render_doc - if File.exists?(Rails.root.join('doc', @filepath + '.md')) - render 'show.html.haml' + if File.exists?(Rails.root.join('doc', @category, @file + '.md')) + render 'show' else not_found! end end - def send_file_data - path = Rails.root.join('doc', "#{@filepath}.#{@format}") - if File.exists?(path) - send_file(path, disposition: 'inline') - else - head :not_found - end + def shortcuts end def ui end + private + PATH_SEPS = Regexp.union(*[::File::SEPARATOR, ::File::ALT_SEPARATOR].compact) # Taken from ActionDispatch::FileHandler diff --git a/app/views/help/show.html.haml b/app/views/help/show.html.haml index f22aa92caf7..eca34dbff06 100644 --- a/app/views/help/show.html.haml +++ b/app/views/help/show.html.haml @@ -1,2 +1,2 @@ .documentation.wiki - = markdown File.read(Rails.root.join('doc', @filepath + '.md')).gsub("$your_email", current_user.email) + = markdown File.read(Rails.root.join('doc', @category, @file + '.md')).gsub("$your_email", current_user.email) diff --git a/config/initializers/mime_types.rb b/config/initializers/mime_types.rb index 6978ad93024..8f8bef42bef 100644 --- a/config/initializers/mime_types.rb +++ b/config/initializers/mime_types.rb @@ -6,4 +6,3 @@ Mime::Type.register_alias "text/plain", :diff Mime::Type.register_alias "text/plain", :patch -Mime::Type.register_alias 'text/html', :md diff --git a/config/routes.rb b/config/routes.rb index 4f33b11d220..af58e095d9a 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -39,9 +39,9 @@ Gitlab::Application.routes.draw do # Help get 'help' => 'help#index' + get 'help/:category/:file' => 'help#show', as: :help_page get 'help/shortcuts' get 'help/ui' => 'help#ui' - get 'help/:filepath' => 'help#show', as: :help_page, constraints: { filepath: /[^\.]+/ } # # Global snippets diff --git a/features/steps/dashboard/help.rb b/features/steps/dashboard/help.rb index fa52e391f05..ef433c57c6e 100644 --- a/features/steps/dashboard/help.rb +++ b/features/steps/dashboard/help.rb @@ -8,7 +8,7 @@ class Spinach::Features::DashboardHelp < Spinach::FeatureSteps end step 'I visit the "Rake Tasks" help page' do - visit help_page_path('raketasks/maintenance', format: 'md') + visit help_page_path("raketasks", "maintenance") end step 'I should see "Rake Tasks" page markdown rendered' do diff --git a/spec/features/help_pages_spec.rb b/spec/features/help_pages_spec.rb index 28423eb8caa..41088ce8271 100644 --- a/spec/features/help_pages_spec.rb +++ b/spec/features/help_pages_spec.rb @@ -6,7 +6,7 @@ describe 'Help Pages', feature: true do login_as :user end it 'replace the variable $your_email with the email of the user' do - visit help_page_path(filepath: 'ssh/README', format: 'md') + visit help_page_path(category: 'ssh', file: 'README.md') expect(page).to have_content("ssh-keygen -t rsa -C \"#{@user.email}\"") end end diff --git a/spec/routing/routing_spec.rb b/spec/routing/routing_spec.rb index f5db548f97c..d4915b51952 100644 --- a/spec/routing/routing_spec.rb +++ b/spec/routing/routing_spec.rb @@ -73,41 +73,41 @@ end # help_markdown GET /help/markdown(.:format) help#markdown # help_ssh GET /help/ssh(.:format) help#ssh # help_raketasks GET /help/raketasks(.:format) help#raketasks -describe HelpController, 'routing' do - it 'to #index' do - expect(get('/help')).to route_to('help#index') +describe HelpController, "routing" do + it "to #index" do + expect(get("/help")).to route_to('help#index') end - it 'to #permissions' do - expect(get('/help/permissions/permissions')).to route_to('help#show', filepath: 'permissions/permissions') + it "to #permissions" do + expect(get("/help/permissions/permissions")).to route_to('help#show', category: "permissions", file: "permissions") end - it 'to #workflow' do - expect(get('/help/workflow/README')).to route_to('help#show', filepath: 'workflow/README') + it "to #workflow" do + expect(get("/help/workflow/README")).to route_to('help#show', category: "workflow", file: "README") end - it 'to #api' do - expect(get('/help/api/README')).to route_to('help#show', filepath: 'api/README') + it "to #api" do + expect(get("/help/api/README")).to route_to('help#show', category: "api", file: "README") end - it 'to #web_hooks' do - expect(get('/help/web_hooks/web_hooks')).to route_to('help#show', filepath: 'web_hooks/web_hooks') + it "to #web_hooks" do + expect(get("/help/web_hooks/web_hooks")).to route_to('help#show', category: "web_hooks", file: "web_hooks") end - it 'to #system_hooks' do - expect(get('/help/system_hooks/system_hooks')).to route_to('help#show', filepath: 'system_hooks/system_hooks') + it "to #system_hooks" do + expect(get("/help/system_hooks/system_hooks")).to route_to('help#show', category: "system_hooks", file: "system_hooks") end - it 'to #markdown' do - expect(get('/help/markdown/markdown')).to route_to('help#show',filepath: 'markdown/markdown') + it "to #markdown" do + expect(get("/help/markdown/markdown")).to route_to('help#show',category: "markdown", file: "markdown") end - it 'to #ssh' do - expect(get('/help/ssh/README')).to route_to('help#show', filepath: 'ssh/README') + it "to #ssh" do + expect(get("/help/ssh/README")).to route_to('help#show', category: "ssh", file: "README") end - it 'to #raketasks' do - expect(get('/help/raketasks/README')).to route_to('help#show', filepath: 'raketasks/README') + it "to #raketasks" do + expect(get("/help/raketasks/README")).to route_to('help#show', category: "raketasks", file: "README") end end |