From 2ae9c890e7037ec13b1882fda9ab90fc73f04fcc Mon Sep 17 00:00:00 2001
From: Douwe Maan <douwe@selenight.nl>
Date: Fri, 26 May 2017 13:51:24 -0500
Subject: [PATCH] Add experimental JSON format for tree controller

---
 app/controllers/projects/tree_controller.rb | 17 ++++++++++-----
 app/helpers/diff_helper.rb                  |  8 +++----
 app/helpers/icons_helper.rb                 |  1 +
 app/helpers/submodule_helper.rb             |  4 ++--
 app/serializers/blob_entity.rb              | 13 ++++++++++++
 app/serializers/submodule_entity.rb         | 23 +++++++++++++++++++++
 app/serializers/tree_entity.rb              | 13 ++++++++++++
 app/serializers/tree_root_entity.rb         |  8 +++++++
 app/serializers/tree_serializer.rb          |  3 +++
 9 files changed, 79 insertions(+), 11 deletions(-)
 create mode 100644 app/serializers/blob_entity.rb
 create mode 100644 app/serializers/submodule_entity.rb
 create mode 100644 app/serializers/tree_entity.rb
 create mode 100644 app/serializers/tree_root_entity.rb
 create mode 100644 app/serializers/tree_serializer.rb

diff --git a/app/controllers/projects/tree_controller.rb b/app/controllers/projects/tree_controller.rb
index f8eb8e00a5d..72be0f579f0 100644
--- a/app/controllers/projects/tree_controller.rb
+++ b/app/controllers/projects/tree_controller.rb
@@ -24,12 +24,19 @@ class Projects::TreeController < Projects::ApplicationController
       end
     end
 
-    @last_commit = @repository.last_commit_for_path(@commit.id, @tree.path) || @commit
-
     respond_to do |format|
-      format.html
-      # Disable cache so browser history works
-      format.js { no_cache_headers }
+      format.html do
+        @last_commit = @repository.last_commit_for_path(@commit.id, @tree.path) || @commit
+      end
+
+      format.js do
+        # Disable cache so browser history works
+        no_cache_headers
+      end
+
+      format.json do
+        render json: TreeSerializer.new(project: @project, repository: @repository, ref: @ref).represent(@tree)
+      end
     end
   end
 
diff --git a/app/helpers/diff_helper.rb b/app/helpers/diff_helper.rb
index 4c4fbdd4d39..407cb015988 100644
--- a/app/helpers/diff_helper.rb
+++ b/app/helpers/diff_helper.rb
@@ -88,15 +88,15 @@ module DiffHelper
   end
 
   def submodule_link(blob, ref, repository = @repository)
-    tree, commit = submodule_links(blob, ref, repository)
-    commit_id = if commit.nil?
+    project_url, tree_url = submodule_links(blob, ref, repository)
+    commit_id = if tree_url.nil?
                   Commit.truncate_sha(blob.id)
                 else
-                  link_to Commit.truncate_sha(blob.id), commit
+                  link_to Commit.truncate_sha(blob.id), tree_url
                 end
 
     [
-      content_tag(:span, link_to(truncate(blob.name, length: 40), tree)),
+      content_tag(:span, link_to(truncate(blob.name, length: 40), project_url)),
       '@',
       content_tag(:span, commit_id, class: 'commit-sha')
     ].join(' ').html_safe
diff --git a/app/helpers/icons_helper.rb b/app/helpers/icons_helper.rb
index f29faeca22d..9a404832423 100644
--- a/app/helpers/icons_helper.rb
+++ b/app/helpers/icons_helper.rb
@@ -1,4 +1,5 @@
 module IconsHelper
+  extend self
   include FontAwesome::Rails::IconHelper
 
   # Creates an icon tag given icon name(s) and possible icon modifiers.
diff --git a/app/helpers/submodule_helper.rb b/app/helpers/submodule_helper.rb
index 09b73eee8cf..2f32062ccf8 100644
--- a/app/helpers/submodule_helper.rb
+++ b/app/helpers/submodule_helper.rb
@@ -1,5 +1,5 @@
 module SubmoduleHelper
-  include Gitlab::ShellAdapter
+  extend self
 
   VALID_SUBMODULE_PROTOCOLS = %w[http https git ssh].freeze
 
@@ -47,7 +47,7 @@ module SubmoduleHelper
     return true if url_no_dotgit == [Gitlab.config.gitlab.url, '/', namespace, '/',
                                      project].join('')
     url_with_dotgit = url_no_dotgit + '.git'
-    url_with_dotgit == gitlab_shell.url_to_repo([namespace, '/', project].join(''))
+    url_with_dotgit == Gitlab::Shell.new.url_to_repo([namespace, '/', project].join(''))
   end
 
   def relative_self_url?(url)
diff --git a/app/serializers/blob_entity.rb b/app/serializers/blob_entity.rb
new file mode 100644
index 00000000000..f05416be65b
--- /dev/null
+++ b/app/serializers/blob_entity.rb
@@ -0,0 +1,13 @@
+class BlobEntity < Grape::Entity
+  include RequestAwareEntity
+
+  expose :id, :path, :name, :mode
+
+  expose :icon do |blob|
+    IconsHelper.file_type_icon_class('file', blob.mode, blob.name)
+  end
+
+  expose :url do |blob|
+    namespace_project_blob_path(request.project.namespace, request.project, File.join(request.ref, blob.path))
+  end
+end
diff --git a/app/serializers/submodule_entity.rb b/app/serializers/submodule_entity.rb
new file mode 100644
index 00000000000..9a7eb5e7880
--- /dev/null
+++ b/app/serializers/submodule_entity.rb
@@ -0,0 +1,23 @@
+class SubmoduleEntity < Grape::Entity
+  include RequestAwareEntity
+
+  expose :id, :path, :name, :mode
+
+  expose :icon do |blob|
+    'archive'
+  end
+
+  expose :project_url do |blob|
+    submodule_links(blob, request).first
+  end
+
+  expose :tree_url do |blob|
+    submodule_links(blob, request).last
+  end
+
+  private
+
+  def submodule_links(blob, request)
+    @submodule_links ||= SubmoduleHelper.submodule_links(blob, request.ref, request.repository)
+  end
+end
diff --git a/app/serializers/tree_entity.rb b/app/serializers/tree_entity.rb
new file mode 100644
index 00000000000..e7d3dc38571
--- /dev/null
+++ b/app/serializers/tree_entity.rb
@@ -0,0 +1,13 @@
+class TreeEntity < Grape::Entity
+  include RequestAwareEntity
+
+  expose :id, :path, :name, :mode
+
+  expose :icon do |tree|
+    IconsHelper.file_type_icon_class('folder', tree.mode, tree.name)
+  end
+
+  expose :url do |tree|
+    namespace_project_tree_path(request.project.namespace, request.project, File.join(request.ref, tree.path))
+  end
+end
diff --git a/app/serializers/tree_root_entity.rb b/app/serializers/tree_root_entity.rb
new file mode 100644
index 00000000000..23b65aa4a4c
--- /dev/null
+++ b/app/serializers/tree_root_entity.rb
@@ -0,0 +1,8 @@
+# TODO: Inherit from TreeEntity, when `Tree` implements `id` and `name` like `Gitlab::Git::Tree`.
+class TreeRootEntity < Grape::Entity
+  expose :path
+  
+  expose :trees, using: TreeEntity
+  expose :blobs, using: BlobEntity
+  expose :submodules, using: SubmoduleEntity
+end
diff --git a/app/serializers/tree_serializer.rb b/app/serializers/tree_serializer.rb
new file mode 100644
index 00000000000..713ade23bc9
--- /dev/null
+++ b/app/serializers/tree_serializer.rb
@@ -0,0 +1,3 @@
+class TreeSerializer < BaseSerializer
+  entity TreeRootEntity
+end