Use serialization for project boards

- Add serializers and Grape::Entity
- Replace to_json
- Add specs

7 files changed, 72 insertions, 1 deletions

diff --git a/app/controllers/concerns/boards_actions.rb b/app/controllers/concerns/boards_actions.rb
index ed7ea2f0e04..e4123d87137 100644
--- a/app/controllers/concerns/boards_actions.rb
+++ b/app/controllers/concerns/boards_actions.rb
@@ -35,4 +35,12 @@ module BoardsActions
       boards.find(params[:id])
     end
   end
+
+  def serializer
+    BoardSerializer.new(current_user: current_user)
+  end
+
+  def serialize_as_json(resource)
+    serializer.represent(resource, serializer: 'board', include_full_project_path: board.group_board?)
+  end
 end
diff --git a/app/controllers/concerns/boards_responses.rb b/app/controllers/concerns/boards_responses.rb
index 8b191c86397..ce2740147f7 100644
--- a/app/controllers/concerns/boards_responses.rb
+++ b/app/controllers/concerns/boards_responses.rb
@@ -69,7 +69,7 @@ module BoardsResponses
   end
 
   def serialize_as_json(resource)
-    resource.as_json(only: [:id])
+    serializer.represent(resource)
   end
 
   def respond_with(resource)
@@ -80,4 +80,8 @@ module BoardsResponses
       end
     end
   end
+
+  def serializer
+    BoardSerializer.new
+  end
 end
diff --git a/app/serializers/board_serializer.rb b/app/serializers/board_serializer.rb
new file mode 100644
index 00000000000..70a4c9ae282
--- /dev/null
+++ b/app/serializers/board_serializer.rb
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class BoardSerializer < BaseSerializer
+  entity BoardSimpleEntity
+end
diff --git a/app/serializers/board_simple_entity.rb b/app/serializers/board_simple_entity.rb
new file mode 100644
index 00000000000..f297d993e27
--- /dev/null
+++ b/app/serializers/board_simple_entity.rb
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class BoardSimpleEntity < Grape::Entity
+  expose :id
+end
diff --git a/changelogs/unreleased/ce-3861-use-serializers-for-project-group-boards.yml b/changelogs/unreleased/ce-3861-use-serializers-for-project-group-boards.yml
new file mode 100644
index 00000000000..de67944b7b7
--- /dev/null
+++ b/changelogs/unreleased/ce-3861-use-serializers-for-project-group-boards.yml
@@ -0,0 +1,6 @@
+---
+title: Refactor Board JSON serialization to use Grape::Entity instead of manual serialization
+  (to_json)
+merge_request:
+author:
+type: changed
diff --git a/spec/controllers/concerns/boards_responses_spec.rb b/spec/controllers/concerns/boards_responses_spec.rb
new file mode 100644
index 00000000000..1c837fe8755
--- /dev/null
+++ b/spec/controllers/concerns/boards_responses_spec.rb
@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BoardsResponses do
+  let(:controller_class) do
+    Class.new do
+      include BoardsResponses
+    end
+  end
+
+  subject(:controller) { controller_class.new }
+
+  describe '#serialize_as_json' do
+    let!(:board) { create(:board) }
+
+    it 'serializes properly' do
+      expected = { id: board.id }
+
+      expect(subject.serialize_as_json(board).to_h).to include(expected)
+    end
+  end
+end
diff --git a/spec/serializers/board_serializer_spec.rb b/spec/serializers/board_serializer_spec.rb
new file mode 100644
index 00000000000..8a633e46316
--- /dev/null
+++ b/spec/serializers/board_serializer_spec.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe BoardSerializer do
+  let(:resource) { create(:board) }
+  let(:json_entity) do
+    described_class.new
+        .represent(resource, serializer: serializer)
+        .with_indifferent_access
+  end
+
+  context 'serialization' do
+    let(:serializer) { 'board' }
+
+    it 'matches issue_sidebar json schema' do
+      expect(json_entity).to match_schema('board')
+    end
+  end
+end