Merge pull request johnfercher#125 from Jepzter/feature/ISSUE-124-add…

…-line-to-tablelist ISSUE-124, add Line property to TableList.
mgorb · Dec 20, 2019 · 73e20ce · 73e20ce
2 parents 0988a34 + 04e9551
commit 73e20ce
Show file tree

Hide file tree

Showing 6 changed files with 74 additions and 2 deletions.
diff --git a/internal/examples/pdfs/sample1.pdf b/internal/examples/pdfs/sample1.pdf
diff --git a/internal/examples/sample1/main.go b/internal/examples/sample1/main.go
@@ -143,7 +143,9 @@ func main() {
 		})
 	})
 
-	m.TableList(headerSmall, smallContent)
+	m.TableList(headerSmall, smallContent, props.TableList{
+		Line: true,
+	})
 
 	m.Row(15, func() {
 		m.Col(func() {

diff --git a/internal/tablelist.go b/internal/tablelist.go
@@ -13,6 +13,9 @@ type MarotoGridPart interface {
 
 	// Helpers
 	GetCurrentOffset() float64
+
+	// Outside Col/Row Components
+	Line(spaceHeight float64)
 }
 
 // TableList is the abstraction to create a table with header and contents
@@ -109,6 +112,10 @@ func (s *tableList) Create(header []string, contents [][]string, prop ...props.T
 				})
 			}
 		})
+
+		if tableProp.Line {
+			s.pdf.Line(1.0)
+		}
 	}
 }
 

diff --git a/internal/tablelist_test.go b/internal/tablelist_test.go
@@ -5,6 +5,7 @@ import (
 	"github.com/johnfercher/maroto/internal"
 	"github.com/johnfercher/maroto/internal/mocks"
 	"github.com/johnfercher/maroto/pkg/consts"
+	"github.com/johnfercher/maroto/pkg/props"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 	"testing"
@@ -90,6 +91,42 @@ func TestTableList_Create_Happy(t *testing.T) {
 
 	marotoGrid := &mocks.Maroto{}
 	marotoGrid.On("Row", mock.Anything, mock.Anything).Return(nil)
+	marotoGrid.On("Line", mock.Anything).Return(nil)
+
+	sut := internal.NewTableList(text, font)
+	sut.BindGrid(marotoGrid)
+
+	headers, contents := getContents()
+
+	// Act
+	sut.Create(headers, contents, props.TableList{
+		Line: true,
+	})
+
+	// Assert
+	text.AssertNotCalled(t, "GetLinesQuantity")
+	text.AssertNumberOfCalls(t, "GetLinesQuantity", 84)
+
+	font.AssertCalled(t, "GetFont")
+	font.AssertNumberOfCalls(t, "GetFont", 21)
+
+	marotoGrid.AssertCalled(t, "Row", mock.Anything, mock.Anything)
+	marotoGrid.AssertNumberOfCalls(t, "Row", 22)
+	marotoGrid.AssertNumberOfCalls(t, "Line", 20)
+}
+
+func TestTableList_Create_Happy_Without_Line(t *testing.T) {
+	// Arrange
+	text := &mocks.Text{}
+	text.On("GetLinesQuantity", mock.Anything, mock.Anything, mock.Anything).Return(1)
+
+	font := &mocks.Font{}
+	font.On("GetFont").Return(consts.Arial, consts.Bold, 1.0)
+	font.On("GetScaleFactor").Return(1.5)
+
+	marotoGrid := &mocks.Maroto{}
+	marotoGrid.On("Row", mock.Anything, mock.Anything).Return(nil)
+	marotoGrid.On("Line", mock.Anything).Return(nil)
 
 	sut := internal.NewTableList(text, font)
 	sut.BindGrid(marotoGrid)
@@ -108,6 +145,28 @@ func TestTableList_Create_Happy(t *testing.T) {
 
 	marotoGrid.AssertCalled(t, "Row", mock.Anything, mock.Anything)
 	marotoGrid.AssertNumberOfCalls(t, "Row", 22)
+	marotoGrid.AssertNumberOfCalls(t, "Line", 0)
+}
+
+func TestTableList_Create_WhenContentIsEmptyWithLine(t *testing.T) {
+	// Arrange
+	text := &mocks.Text{}
+	text.On("GetLinesQuantity", mock.Anything, mock.Anything, mock.Anything).Return(1)
+	sut := internal.NewTableList(text, nil)
+
+	marotoGrid := mocks.Maroto{}
+	marotoGrid.On("Line", mock.Anything).Return(nil)
+
+	headers, _ := getContents()
+
+	// Act
+	sut.Create(headers, [][]string{}, props.TableList{
+		Line: true,
+	})
+
+	// Assert
+	text.AssertNotCalled(t, "GetLinesQuantity")
+	marotoGrid.AssertNotCalled(t, "Line")
 }
 
 func getContents() ([]string, [][]string) {

diff --git a/pkg/pdf/example_test.go b/pkg/pdf/example_test.go
@@ -166,7 +166,9 @@ func ExamplePdfMaroto_TableList() {
 	// 1 Row of header
 	// 2 Rows of contents
 	// Each row have 2 columns
-	m.TableList(headers, contents)
+	m.TableList(headers, contents, props.TableList{
+		Line: false,
+	})
 
 	// Do more things and save...
 }

diff --git a/pkg/props/prop.go b/pkg/props/prop.go
@@ -82,6 +82,8 @@ type TableList struct {
 	Align consts.Align
 	// HeaderContentSpace is the space between the header and the contents
 	HeaderContentSpace float64
+	// Line adds a line after every content-row to separate rows. The line's spaceHeight is set to 1.0
+	Line bool
 }
 
 // MakeValid from Rect means will make the properties from a rectangle reliable to fit inside a cell