Implement auxiliary blob viewers

9 files changed, 335 insertions, 65 deletions

diff --git a/spec/features/projects/blobs/blob_show_spec.rb b/spec/features/projects/blobs/blob_show_spec.rb
index 5955623f565..9888624a509 100644
--- a/spec/features/projects/blobs/blob_show_spec.rb
+++ b/spec/features/projects/blobs/blob_show_spec.rb
@@ -5,13 +5,13 @@ feature 'File blob', :js, feature: true do
 
   def visit_blob(path, fragment = nil)
     visit namespace_project_blob_path(project.namespace, project, File.join('master', path), anchor: fragment)
+
+    wait_for_ajax
   end
 
   context 'Ruby file' do
     before do
       visit_blob('files/ruby/popen.rb')
-
-      wait_for_ajax
     end
 
     it 'displays the blob' do
@@ -35,8 +35,6 @@ feature 'File blob', :js, feature: true do
     context 'visiting directly' do
       before do
         visit_blob('files/markdown/ruby-style-guide.md')
-
-        wait_for_ajax
       end
 
       it 'displays the blob using the rich viewer' do
@@ -104,8 +102,6 @@ feature 'File blob', :js, feature: true do
     context 'visiting with a line number anchor' do
       before do
         visit_blob('files/markdown/ruby-style-guide.md', 'L1')
-
-        wait_for_ajax
       end
 
       it 'displays the blob using the simple viewer' do
@@ -148,8 +144,6 @@ feature 'File blob', :js, feature: true do
         project.update_attribute(:lfs_enabled, true)
 
         visit_blob('files/lfs/file.md')
-
-        wait_for_ajax
       end
 
       it 'displays an error' do
@@ -198,8 +192,6 @@ feature 'File blob', :js, feature: true do
     context 'when LFS is disabled on the project' do
       before do
         visit_blob('files/lfs/file.md')
-
-        wait_for_ajax
       end
 
       it 'displays the blob' do
@@ -235,8 +227,6 @@ feature 'File blob', :js, feature: true do
       ).execute
 
       visit_blob('files/test.pdf')
-
-      wait_for_ajax
     end
 
     it 'displays the blob' do
@@ -263,8 +253,6 @@ feature 'File blob', :js, feature: true do
         project.update_attribute(:lfs_enabled, true)
 
         visit_blob('files/lfs/lfs_object.iso')
-
-        wait_for_ajax
       end
 
       it 'displays the blob' do
@@ -287,8 +275,6 @@ feature 'File blob', :js, feature: true do
     context 'when LFS is disabled on the project' do
       before do
         visit_blob('files/lfs/lfs_object.iso')
-
-        wait_for_ajax
       end
 
       it 'displays the blob' do
@@ -312,8 +298,6 @@ feature 'File blob', :js, feature: true do
   context 'ZIP file' do
     before do
       visit_blob('Gemfile.zip')
-
-      wait_for_ajax
     end
 
     it 'displays the blob' do
@@ -348,8 +332,6 @@ feature 'File blob', :js, feature: true do
       ).execute
 
       visit_blob('files/empty.md')
-
-      wait_for_ajax
     end
 
     it 'displays an error' do
@@ -369,4 +351,80 @@ feature 'File blob', :js, feature: true do
       end
     end
   end
+
+  context '.gitlab-ci.yml' do
+    before do
+      project.add_master(project.creator)
+
+      Files::CreateService.new(
+        project,
+        project.creator,
+        start_branch: 'master',
+        branch_name: 'master',
+        commit_message: "Add .gitlab-ci.yml",
+        file_path: '.gitlab-ci.yml',
+        file_content: File.read(Rails.root.join('spec/support/gitlab_stubs/gitlab_ci.yml'))
+      ).execute
+
+      visit_blob('.gitlab-ci.yml')
+    end
+
+    it 'displays an auxiliary viewer' do
+      aggregate_failures do
+        # shows that configuration is valid
+        expect(page).to have_content('This GitLab CI configuration is valid.')
+
+        # shows a learn more link
+        expect(page).to have_link('Learn more')
+      end
+    end
+  end
+
+  context '.gitlab/route-map.yml' do
+    before do
+      project.add_master(project.creator)
+
+      Files::CreateService.new(
+        project,
+        project.creator,
+        start_branch: 'master',
+        branch_name: 'master',
+        commit_message: "Add .gitlab/route-map.yml",
+        file_path: '.gitlab/route-map.yml',
+        file_content: <<-MAP.strip_heredoc
+          # Team data
+          - source: 'data/team.yml'
+            public: 'team/'
+        MAP
+      ).execute
+
+      visit_blob('.gitlab/route-map.yml')
+    end
+
+    it 'displays an auxiliary viewer' do
+      aggregate_failures do
+        # shows that map is valid
+        expect(page).to have_content('This Route Map is valid.')
+
+        # shows a learn more link
+        expect(page).to have_link('Learn more')
+      end
+    end
+  end
+
+  context 'LICENSE' do
+    before do
+      visit_blob('LICENSE')
+    end
+
+    it 'displays an auxiliary viewer' do
+      aggregate_failures do
+        # shows license
+        expect(page).to have_content('This project is licensed under the MIT License.')
+
+        # shows a learn more link
+        expect(page).to have_link('Learn more about this license', 'http://choosealicense.com/licenses/mit/')
+      end
+    end
+  end
 end
diff --git a/spec/models/blob_spec.rb b/spec/models/blob_spec.rb
index f84c6b48173..f19e1af65a6 100644
--- a/spec/models/blob_spec.rb
+++ b/spec/models/blob_spec.rb
@@ -271,6 +271,52 @@ describe Blob do
     end
   end
 
+  describe '#auxiliary_viewer' do
+    context 'when the blob has an external storage error' do
+      before do
+        project.lfs_enabled = false
+      end
+
+      it 'returns nil' do
+        blob = fake_blob(path: 'LICENSE', lfs: true)
+
+        expect(blob.auxiliary_viewer).to be_nil
+      end
+    end
+
+    context 'when the blob is empty' do
+      it 'returns nil' do
+        blob = fake_blob(data: '')
+
+        expect(blob.auxiliary_viewer).to be_nil
+      end
+    end
+
+    context 'when the blob is stored externally' do
+      it 'returns a matching viewer' do
+        blob = fake_blob(path: 'LICENSE', lfs: true)
+
+        expect(blob.auxiliary_viewer).to be_a(BlobViewer::License)
+      end
+    end
+
+    context 'when the blob is binary' do
+      it 'returns nil' do
+        blob = fake_blob(path: 'LICENSE', binary: true)
+
+        expect(blob.auxiliary_viewer).to be_nil
+      end
+    end
+
+    context 'when the blob is text-based' do
+      it 'returns a matching text-based viewer' do
+        blob = fake_blob(path: 'LICENSE')
+
+        expect(blob.auxiliary_viewer).to be_a(BlobViewer::License)
+      end
+    end
+  end
+
   describe '#rendered_as_text?' do
     context 'when ignoring errors' do
       context 'when the simple viewer is text-based' do
diff --git a/spec/models/blob_viewer/base_spec.rb b/spec/models/blob_viewer/base_spec.rb
index 740ad9d275e..a6641970e1b 100644
--- a/spec/models/blob_viewer/base_spec.rb
+++ b/spec/models/blob_viewer/base_spec.rb
@@ -8,6 +8,7 @@ describe BlobViewer::Base, model: true do
   let(:viewer_class) do
     Class.new(described_class) do
       self.extensions = %w(pdf)
+      self.binary = true
       self.max_size = 1.megabyte
       self.absolute_max_size = 5.megabytes
       self.client_side = false
@@ -18,14 +19,47 @@ describe BlobViewer::Base, model: true do
 
   describe '.can_render?' do
     context 'when the extension is supported' do
-      let(:blob) { fake_blob(path: 'file.pdf') }
+      context 'when the binaryness matches' do
+        let(:blob) { fake_blob(path: 'file.pdf', binary: true) }
 
-      it 'returns true' do
-        expect(viewer_class.can_render?(blob)).to be_truthy
+        it 'returns true' do
+          expect(viewer_class.can_render?(blob)).to be_truthy
+        end
+      end
+
+      context 'when the binaryness does not match' do
+        let(:blob) { fake_blob(path: 'file.pdf', binary: false) }
+
+        it 'returns false' do
+          expect(viewer_class.can_render?(blob)).to be_falsey
+        end
+      end
+    end
+
+    context 'when the file type is supported' do
+      before do
+        viewer_class.file_type = :license
+        viewer_class.binary = false
+      end
+      
+      context 'when the binaryness matches' do
+        let(:blob) { fake_blob(path: 'LICENSE', binary: false) }
+
+        it 'returns true' do
+          expect(viewer_class.can_render?(blob)).to be_truthy
+        end
+      end
+
+      context 'when the binaryness does not match' do
+        let(:blob) { fake_blob(path: 'LICENSE', binary: true) }
+
+        it 'returns false' do
+          expect(viewer_class.can_render?(blob)).to be_falsey
+        end
       end
     end
 
-    context 'when the extension is not supported' do
+    context 'when the extension and file type are not supported' do
       let(:blob) { fake_blob(path: 'file.txt') }
 
       it 'returns false' do
@@ -153,34 +187,4 @@ describe BlobViewer::Base, model: true do
       end
     end
   end
-
-  describe '#prepare!' do
-    context 'when the viewer is server side' do
-      let(:blob) { fake_blob(path: 'file.md') }
-
-      before do
-        viewer_class.client_side = false
-      end
-
-      it 'loads all blob data' do
-        expect(blob).to receive(:load_all_data!)
-
-        viewer.prepare!
-      end
-    end
-
-    context 'when the viewer is client side' do
-      let(:blob) { fake_blob(path: 'file.md') }
-
-      before do
-        viewer_class.client_side = true
-      end
-
-      it "doesn't load all blob data" do
-        expect(blob).not_to receive(:load_all_data!)
-
-        viewer.prepare!
-      end
-    end
-  end
 end
diff --git a/spec/models/blob_viewer/gitlab_ci_yml_spec.rb b/spec/models/blob_viewer/gitlab_ci_yml_spec.rb
new file mode 100644
index 00000000000..0c6c24ece21
--- /dev/null
+++ b/spec/models/blob_viewer/gitlab_ci_yml_spec.rb
@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe BlobViewer::GitlabCiYml, model: true do
+  include FakeBlobHelpers
+
+  let(:project) { build(:project) }
+  let(:data) { File.read(Rails.root.join('spec/support/gitlab_stubs/gitlab_ci.yml')) }
+  let(:blob) { fake_blob(path: '.gitlab-ci.yml', data: data) }
+  subject { described_class.new(blob) }
+
+  describe '#validation_message' do
+    it 'calls prepare! on the viewer' do
+      expect(subject).to receive(:prepare!)
+
+      subject.validation_message
+    end
+
+    context 'when the configuration is valid' do
+      it 'returns nil' do
+        expect(subject.validation_message).to be_nil
+      end
+    end
+
+    context 'when the configuration is invalid' do
+      let(:data) { 'oof' }
+
+      it 'returns the error message' do
+        expect(subject.validation_message).to eq('Invalid configuration format')
+      end
+    end
+  end
+end
diff --git a/spec/models/blob_viewer/license_spec.rb b/spec/models/blob_viewer/license_spec.rb
new file mode 100644
index 00000000000..944ddd32b92
--- /dev/null
+++ b/spec/models/blob_viewer/license_spec.rb
@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe BlobViewer::License, model: true do
+  include FakeBlobHelpers
+
+  let(:project) { create(:project, :repository) }
+  let(:blob) { fake_blob(path: 'LICENSE') }
+  subject { described_class.new(blob) }
+
+  describe '#license' do
+    it 'returns the blob project repository license' do
+      expect(subject.license).not_to be_nil
+      expect(subject.license).to eq(project.repository.license)
+    end
+  end
+
+  describe '#render_error' do
+    context 'when there is no license' do
+      before do
+        allow(project.repository).to receive(:license).and_return(nil)
+      end
+
+      it 'returns :unknown_license' do
+        expect(subject.render_error).to eq(:unknown_license)
+      end
+    end
+
+    context 'when there is a license' do
+      it 'returns nil' do
+        expect(subject.render_error).to be_nil
+      end
+    end
+  end
+end
diff --git a/spec/models/blob_viewer/route_map_spec.rb b/spec/models/blob_viewer/route_map_spec.rb
new file mode 100644
index 00000000000..4854e0262d9
--- /dev/null
+++ b/spec/models/blob_viewer/route_map_spec.rb
@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe BlobViewer::RouteMap, model: true do
+  include FakeBlobHelpers
+
+  let(:project) { build(:project) }
+  let(:data) do
+    <<-MAP.strip_heredoc
+      # Team data
+      - source: 'data/team.yml'
+        public: 'team/'
+    MAP
+  end
+  let(:blob) { fake_blob(path: '.gitlab/route-map.yml', data: data) }
+  subject { described_class.new(blob) }
+
+  describe '#validation_message' do
+    it 'calls prepare! on the viewer' do
+      expect(subject).to receive(:prepare!)
+
+      subject.validation_message
+    end
+
+    context 'when the configuration is valid' do
+      it 'returns nil' do
+        expect(subject.validation_message).to be_nil
+      end
+    end
+
+    context 'when the configuration is invalid' do
+      let(:data) { 'oof' }
+
+      it 'returns the error message' do
+        expect(subject.validation_message).to eq('Route map is not an array')
+      end
+    end
+  end
+end
diff --git a/spec/models/blob_viewer/server_side_spec.rb b/spec/models/blob_viewer/server_side_spec.rb
new file mode 100644
index 00000000000..ddca9b79390
--- /dev/null
+++ b/spec/models/blob_viewer/server_side_spec.rb
@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe BlobViewer::ServerSide, model: true do
+  include FakeBlobHelpers
+
+  let(:project) { build(:empty_project) }
+
+  let(:viewer_class) do
+    Class.new(BlobViewer::Base) do
+      include BlobViewer::ServerSide
+    end
+  end
+
+  subject { viewer_class.new(blob) }
+
+  describe '#prepare!' do
+    let(:blob) { fake_blob(path: 'file.txt') }
+
+    it 'loads all blob data' do
+      expect(blob).to receive(:load_all_data!)
+
+      subject.prepare!
+    end
+  end
+end
diff --git a/spec/models/repository_spec.rb b/spec/models/repository_spec.rb
index cea8db7a926..6ebc9965924 100644
--- a/spec/models/repository_spec.rb
+++ b/spec/models/repository_spec.rb
@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Repository, models: true do
   include RepoHelpers
-  TestBlob = Struct.new(:name)
+  TestBlob = Struct.new(:path)
 
   let(:project) { create(:project, :repository) }
   let(:repository) { project.repository }
@@ -565,31 +565,31 @@ describe Repository, models: true do
     it 'accepts changelog' do
       expect(repository.tree).to receive(:blobs).and_return([TestBlob.new('changelog')])
 
-      expect(repository.changelog.name).to eq('changelog')
+      expect(repository.changelog.path).to eq('changelog')
     end
 
     it 'accepts news instead of changelog' do
       expect(repository.tree).to receive(:blobs).and_return([TestBlob.new('news')])
 
-      expect(repository.changelog.name).to eq('news')
+      expect(repository.changelog.path).to eq('news')
     end
 
     it 'accepts history instead of changelog' do
       expect(repository.tree).to receive(:blobs).and_return([TestBlob.new('history')])
 
-      expect(repository.changelog.name).to eq('history')
+      expect(repository.changelog.path).to eq('history')
     end
 
     it 'accepts changes instead of changelog' do
       expect(repository.tree).to receive(:blobs).and_return([TestBlob.new('changes')])
 
-      expect(repository.changelog.name).to eq('changes')
+      expect(repository.changelog.path).to eq('changes')
     end
 
     it 'is case-insensitive' do
       expect(repository.tree).to receive(:blobs).and_return([TestBlob.new('CHANGELOG')])
 
-      expect(repository.changelog.name).to eq('CHANGELOG')
+      expect(repository.changelog.path).to eq('CHANGELOG')
     end
   end
 
@@ -624,7 +624,7 @@ describe Repository, models: true do
       repository.create_file(user, 'LICENSE', 'Copyright!',
         message: 'Add LICENSE', branch_name: 'master')
 
-      expect(repository.license_blob.name).to eq('LICENSE')
+      expect(repository.license_blob.path).to eq('LICENSE')
     end
 
     %w[LICENSE LICENCE LiCensE LICENSE.md LICENSE.foo COPYING COPYING.md].each do |filename|
@@ -654,7 +654,7 @@ describe Repository, models: true do
       expect(repository.license_key).to be_nil
     end
 
-    it 'detects license file with no recognizable open-source license content' do
+    it 'returns nil when the content is not recognizable' do
       repository.create_file(user, 'LICENSE', 'Copyright!',
         message: 'Add LICENSE', branch_name: 'master')
 
@@ -670,12 +670,45 @@ describe Repository, models: true do
     end
   end
 
+  describe '#license' do
+    before do
+      repository.delete_file(user, 'LICENSE',
+        message: 'Remove LICENSE', branch_name: 'master')
+    end
+
+    it 'returns nil when no license is detected' do
+      expect(repository.license).to be_nil
+    end
+
+    it 'returns nil when the repository does not exist' do
+      expect(repository).to receive(:exists?).and_return(false)
+
+      expect(repository.license).to be_nil
+    end
+
+    it 'returns nil when the content is not recognizable' do
+      repository.create_file(user, 'LICENSE', 'Copyright!',
+        message: 'Add LICENSE', branch_name: 'master')
+
+      expect(repository.license).to be_nil
+    end
+
+    it 'returns the license' do
+      license = Licensee::License.new('mit')
+      repository.create_file(user, 'LICENSE',
+        license.content,
+        message: 'Add LICENSE', branch_name: 'master')
+
+      expect(repository.license).to eq(license)
+    end
+  end
+
   describe "#gitlab_ci_yml", caching: true do
     it 'returns valid file' do
       files = [TestBlob.new('file'), TestBlob.new('.gitlab-ci.yml'), TestBlob.new('copying')]
       expect(repository.tree).to receive(:blobs).and_return(files)
 
-      expect(repository.gitlab_ci_yml.name).to eq('.gitlab-ci.yml')
+      expect(repository.gitlab_ci_yml.path).to eq('.gitlab-ci.yml')
     end
 
     it 'returns nil if not exists' do
diff --git a/spec/views/projects/blob/_viewer.html.haml_spec.rb b/spec/views/projects/blob/_viewer.html.haml_spec.rb
index 501f90c5f9a..08018767624 100644
--- a/spec/views/projects/blob/_viewer.html.haml_spec.rb
+++ b/spec/views/projects/blob/_viewer.html.haml_spec.rb
@@ -47,10 +47,10 @@ describe 'projects/blob/_viewer.html.haml', :view do
         expect(rendered).to have_css('.blob-viewer[data-url]')
       end
 
-      it 'displays a spinner' do
+      it 'renders the loading indicator' do
         render_view
 
-        expect(rendered).to have_css('i[aria-label="Loading content"]')
+        expect(view).to render_template('projects/blob/viewers/_loading')
       end
     end