From 2e6225538f6e065dda61c04c9c9e76fbe0b23646 Mon Sep 17 00:00:00 2001
From: Winnie Hellmann <winnie@gitlab.com>
Date: Fri, 12 Jul 2019 06:31:17 +0000
Subject: [PATCH] Split and prepend CurrentBoardEntity

(cherry picked from commit 1e8bdd01bff96122fe80c51fa8f024f18675b58b)
---
 app/helpers/boards_helper.rb                 |  6 +++++-
 app/serializers/current_board_entity.rb      |  6 ++++++
 app/serializers/current_board_serializer.rb  |  5 +++++
 spec/fixtures/api/schemas/current-board.json | 16 ++++++++++++++++
 spec/helpers/boards_helper_spec.rb           | 16 ++++++++++++++--
 5 files changed, 46 insertions(+), 3 deletions(-)
 create mode 100644 app/serializers/current_board_entity.rb
 create mode 100644 app/serializers/current_board_serializer.rb
 create mode 100644 spec/fixtures/api/schemas/current-board.json

diff --git a/app/helpers/boards_helper.rb b/app/helpers/boards_helper.rb
index 8ef68018d23..bbe05f40999 100644
--- a/app/helpers/boards_helper.rb
+++ b/app/helpers/boards_helper.rb
@@ -99,7 +99,11 @@ module BoardsHelper
     recent_project_boards_path(@project) if current_board_parent.is_a?(Project)
   end
 
+  def serializer
+    CurrentBoardSerializer.new
+  end
+
   def current_board_json
-    board.to_json
+    serializer.represent(board).as_json
   end
 end
diff --git a/app/serializers/current_board_entity.rb b/app/serializers/current_board_entity.rb
new file mode 100644
index 00000000000..371151532f8
--- /dev/null
+++ b/app/serializers/current_board_entity.rb
@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class CurrentBoardEntity < Grape::Entity
+  expose :id
+  expose :name
+end
diff --git a/app/serializers/current_board_serializer.rb b/app/serializers/current_board_serializer.rb
new file mode 100644
index 00000000000..c58c77194f2
--- /dev/null
+++ b/app/serializers/current_board_serializer.rb
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class CurrentBoardSerializer < BaseSerializer
+  entity CurrentBoardEntity
+end
diff --git a/spec/fixtures/api/schemas/current-board.json b/spec/fixtures/api/schemas/current-board.json
new file mode 100644
index 00000000000..2ddc038e908
--- /dev/null
+++ b/spec/fixtures/api/schemas/current-board.json
@@ -0,0 +1,16 @@
+{
+  "type": "object",
+  "allOf": [
+    { "$ref": "board.json" },
+    {
+      "required" : [
+        "id",
+        "name"
+      ],
+      "properties": {
+        "id": { "type": "integer" },
+        "name": { "type": "string" }
+      }
+    }
+  ]
+}
diff --git a/spec/helpers/boards_helper_spec.rb b/spec/helpers/boards_helper_spec.rb
index b22947911b9..f014537eb54 100644
--- a/spec/helpers/boards_helper_spec.rb
+++ b/spec/helpers/boards_helper_spec.rb
@@ -1,10 +1,12 @@
 require 'spec_helper'
 
 describe BoardsHelper do
+  set(:project) { create(:project) }
+
   describe '#build_issue_link_base' do
     context 'project board' do
       it 'returns correct path for project board' do
-        @project = create(:project)
+        @project = project
         @board = create(:board, project: @project)
 
         expect(build_issue_link_base).to eq("/#{@project.namespace.path}/#{@project.path}/issues")
@@ -31,7 +33,6 @@ describe BoardsHelper do
 
   describe '#board_data' do
     let(:user) { create(:user) }
-    let(:project) { create(:project) }
     let(:board) { create(:board, project: project) }
 
     before do
@@ -46,4 +47,15 @@ describe BoardsHelper do
       expect(helper.board_data[:lists_endpoint]).to eq(board_lists_path(board))
     end
   end
+
+  describe '#current_board_json' do
+    let(:board_json) { helper.current_board_json }
+
+    it 'can serialise with a basic set of attributes' do
+      board = create(:board, project: project)
+      assign(:board, board)
+
+      expect(board_json).to match_schema('current-board')
+    end
+  end
 end