termdash/internal/alignfor/align_test.go

// Copyright 2018 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package alignfor

import (
	"image"
	"testing"

	"github.com/kylelemons/godebug/pretty"
	"github.com/mum4k/termdash/align"
)

func TestRectangle(t *testing.T) {
	tests := []struct {
		desc    string
		rect    image.Rectangle
		area    image.Rectangle
		hAlign  align.Horizontal
		vAlign  align.Vertical
		want    image.Rectangle
		wantErr bool
	}{
		{
			desc:    "area falls outside of the rectangle",
			rect:    image.Rect(0, 0, 1, 1),
			area:    image.Rect(1, 1, 2, 2),
			hAlign:  align.HorizontalLeft,
			vAlign:  align.VerticalTop,
			wantErr: true,
		},
		{
			desc:    "unsupported horizontal alignment",
			rect:    image.Rect(0, 0, 2, 2),
			area:    image.Rect(0, 0, 1, 1),
			hAlign:  align.Horizontal(-1),
			vAlign:  align.VerticalTop,
			wantErr: true,
		},
		{
			desc:    "unsupported vertical alignment",
			rect:    image.Rect(0, 0, 2, 2),
			area:    image.Rect(0, 0, 1, 1),
			hAlign:  align.HorizontalLeft,
			vAlign:  align.Vertical(-1),
			wantErr: true,
		},
		{
			desc:   "nothing to align if the rectangles are equal",
			rect:   image.Rect(0, 0, 2, 2),
			area:   image.Rect(0, 0, 2, 2),
			hAlign: align.HorizontalLeft,
			vAlign: align.VerticalTop,
			want:   image.Rect(0, 0, 2, 2),
		},
		{
			desc:   "aligns top and left, area is zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(0, 0, 1, 1),
			hAlign: align.HorizontalLeft,
			vAlign: align.VerticalTop,
			want:   image.Rect(0, 0, 1, 1),
		},
		{
			desc:   "aligns top and center, area is zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(0, 0, 1, 1),
			hAlign: align.HorizontalCenter,
			vAlign: align.VerticalTop,
			want:   image.Rect(1, 0, 2, 1),
		},
		{
			desc:   "aligns top and right, area is zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(0, 0, 1, 1),
			hAlign: align.HorizontalRight,
			vAlign: align.VerticalTop,
			want:   image.Rect(2, 0, 3, 1),
		},
		{
			desc:   "aligns middle and left, area is zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(0, 0, 1, 1),
			hAlign: align.HorizontalLeft,
			vAlign: align.VerticalMiddle,
			want:   image.Rect(0, 1, 1, 2),
		},
		{
			desc:   "aligns middle and center, area is zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(0, 0, 1, 1),
			hAlign: align.HorizontalCenter,
			vAlign: align.VerticalMiddle,
			want:   image.Rect(1, 1, 2, 2),
		},
		{
			desc:   "aligns middle and right, area is zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(0, 0, 1, 1),
			hAlign: align.HorizontalRight,
			vAlign: align.VerticalMiddle,
			want:   image.Rect(2, 1, 3, 2),
		},
		{
			desc:   "aligns bottom and left, area is zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(0, 0, 1, 1),
			hAlign: align.HorizontalLeft,
			vAlign: align.VerticalBottom,
			want:   image.Rect(0, 2, 1, 3),
		},
		{
			desc:   "aligns bottom and center, area is zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(0, 0, 1, 1),
			hAlign: align.HorizontalCenter,
			vAlign: align.VerticalBottom,
			want:   image.Rect(1, 2, 2, 3),
		},
		{
			desc:   "aligns bottom and right, area is zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(0, 0, 1, 1),
			hAlign: align.HorizontalRight,
			vAlign: align.VerticalBottom,
			want:   image.Rect(2, 2, 3, 3),
		},
		{
			desc:   "aligns top and left, area isn't zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(0, 0, 1, 1),
			hAlign: align.HorizontalLeft,
			vAlign: align.VerticalTop,
			want:   image.Rect(0, 0, 1, 1),
		},
		{
			desc:   "aligns top and center, area isn't zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(1, 1, 2, 2),
			hAlign: align.HorizontalCenter,
			vAlign: align.VerticalTop,
			want:   image.Rect(1, 0, 2, 1),
		},
		{
			desc:   "aligns top and right, area isn't zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(1, 1, 2, 2),
			hAlign: align.HorizontalRight,
			vAlign: align.VerticalTop,
			want:   image.Rect(2, 0, 3, 1),
		},
		{
			desc:   "aligns middle and left, area isn't zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(1, 1, 2, 2),
			hAlign: align.HorizontalLeft,
			vAlign: align.VerticalMiddle,
			want:   image.Rect(0, 1, 1, 2),
		},
		{
			desc:   "aligns middle and center, area isn't zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(1, 1, 2, 2),
			hAlign: align.HorizontalCenter,
			vAlign: align.VerticalMiddle,
			want:   image.Rect(1, 1, 2, 2),
		},
		{
			desc:   "aligns middle and right, area isn't zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(1, 1, 2, 2),
			hAlign: align.HorizontalRight,
			vAlign: align.VerticalMiddle,
			want:   image.Rect(2, 1, 3, 2),
		},
		{
			desc:   "aligns bottom and left, area isn't zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(1, 1, 2, 2),
			hAlign: align.HorizontalLeft,
			vAlign: align.VerticalBottom,
			want:   image.Rect(0, 2, 1, 3),
		},
		{
			desc:   "aligns bottom and center, area isn't zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(1, 1, 2, 2),
			hAlign: align.HorizontalCenter,
			vAlign: align.VerticalBottom,
			want:   image.Rect(1, 2, 2, 3),
		},
		{
			desc:   "aligns bottom and right, area isn't zero based",
			rect:   image.Rect(0, 0, 3, 3),
			area:   image.Rect(1, 1, 2, 2),
			hAlign: align.HorizontalRight,
			vAlign: align.VerticalBottom,
			want:   image.Rect(2, 2, 3, 3),
		},
	}

	for _, tc := range tests {
		t.Run(tc.desc, func(t *testing.T) {
			got, err := Rectangle(tc.rect, tc.area, tc.hAlign, tc.vAlign)
			if (err != nil) != tc.wantErr {
				t.Errorf("Rectangle => unexpected error: %v, wantErr: %v", err, tc.wantErr)
			}
			if err != nil {
				return
			}

			if diff := pretty.Compare(tc.want, got); diff != "" {
				t.Errorf("Rectangle => unexpected diff (-want, +got):\n%s", diff)
			}
		})
	}
}

func TestText(t *testing.T) {
	tests := []struct {
		desc    string
		rect    image.Rectangle
		text    string
		hAlign  align.Horizontal
		vAlign  align.Vertical
		want    image.Point
		wantErr bool
	}{
		{
			desc:    "fails when text contains newline",
			rect:    image.Rect(0, 0, 3, 3),
			text:    "a\nb",
			wantErr: true,
		},
		{
			desc:   "aligns text top and left",
			rect:   image.Rect(1, 1, 4, 4),
			text:   "a",
			hAlign: align.HorizontalLeft,
			vAlign: align.VerticalTop,
			want:   image.Point{1, 1},
		},
		{
			desc:   "aligns text top and center",
			rect:   image.Rect(1, 1, 4, 4),
			text:   "a",
			hAlign: align.HorizontalCenter,
			vAlign: align.VerticalTop,
			want:   image.Point{2, 1},
		},
		{
			desc:   "aligns text top and right",
			rect:   image.Rect(1, 1, 4, 4),
			text:   "a",
			hAlign: align.HorizontalRight,
			vAlign: align.VerticalTop,
			want:   image.Point{3, 1},
		},
		{
			desc:   "aligns text middle and left",
			rect:   image.Rect(1, 1, 4, 4),
			text:   "a",
			hAlign: align.HorizontalLeft,
			vAlign: align.VerticalMiddle,
			want:   image.Point{1, 2},
		},
		{
			desc:   "aligns half-width text rune middle and center",
			rect:   image.Rect(1, 1, 4, 4),
			text:   "a",
			hAlign: align.HorizontalCenter,
			vAlign: align.VerticalMiddle,
			want:   image.Point{2, 2},
		},
		{
			desc:   "aligns full-width text rune middle and center",
			rect:   image.Rect(1, 1, 4, 4),
			text:   "界",
			hAlign: align.HorizontalCenter,
			vAlign: align.VerticalMiddle,
			want:   image.Point{1, 2},
		},
		{
			desc:   "aligns text middle and right",
			rect:   image.Rect(1, 1, 4, 4),
			text:   "a",
			hAlign: align.HorizontalRight,
			vAlign: align.VerticalMiddle,
			want:   image.Point{3, 2},
		},
		{
			desc:   "aligns text bottom and left",
			rect:   image.Rect(1, 1, 4, 4),
			text:   "a",
			hAlign: align.HorizontalLeft,
			vAlign: align.VerticalBottom,
			want:   image.Point{1, 3},
		},
		{
			desc:   "aligns text bottom and center",
			rect:   image.Rect(1, 1, 4, 4),
			text:   "a",
			hAlign: align.HorizontalCenter,
			vAlign: align.VerticalBottom,
			want:   image.Point{2, 3},
		},
		{
			desc:   "aligns text bottom and right",
			rect:   image.Rect(1, 1, 4, 4),
			text:   "a",
			hAlign: align.HorizontalRight,
			vAlign: align.VerticalBottom,
			want:   image.Point{3, 3},
		},
		{
			desc:   "aligns text that is too long, assumes trimming",
			rect:   image.Rect(1, 1, 4, 4),
			text:   "abcd",
			hAlign: align.HorizontalCenter,
			vAlign: align.VerticalTop,
			want:   image.Point{1, 1},
		},
	}

	for _, tc := range tests {
		t.Run(tc.desc, func(t *testing.T) {
			got, err := Text(tc.rect, tc.text, tc.hAlign, tc.vAlign)
			if (err != nil) != tc.wantErr {
				t.Errorf("Text => unexpected error: %v, wantErr: %v", err, tc.wantErr)
			}
			if err != nil {
				return
			}

			if diff := pretty.Compare(tc.want, got); diff != "" {
				t.Errorf("Text => unexpected diff (-want, +got):\n%s", diff)
			}
		})
	}
}