feat:#34 refactored function to intended service, fixed docker files

services/data-manager/service/functions/semester.go

@@ -0,0 +1,47 @@
+//Calendar implementation for the HTWK Leipzig timetable. Evaluation and display of the individual dates in iCal format.
+//Copyright (C) 2024 HTWKalender support@htwkalender.de
+
+//This program is free software: you can redistribute it and/or modify
+//it under the terms of the GNU Affero General Public License as published by
+//the Free Software Foundation, either version 3 of the License, or
+//(at your option) any later version.
+
+//This program is distributed in the hope that it will be useful,
+//but WITHOUT ANY WARRANTY; without even the implied warranty of
+//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//GNU Affero General Public License for more details.
+
+//You should have received a copy of the GNU Affero General Public License
+//along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package functions
+
+import (
+	localTime "htwkalender/service/functions/time"
+	"time"
+)
+
+// GetCurrentSemesterString returns the current semester as string
+// if current month is between 10 and 03 -> winter semester "ws"
+func GetCurrentSemesterString(localeTime localTime.Clock) string {
+	if localeTime.Now().Month() >= 10 || localeTime.Now().Month() <= 3 {
+		return "ws"
+	} else {
+		return "ss"
+	}
+}
+
+func CalculateSemesterList(clock localTime.Clock) []string {
+	summerSemester := clock.Now().Month() >= time.March && clock.Now().Month() <= time.September
+	winterSemester := clock.Now().Month() <= time.March || clock.Now().Month() >= time.September
+
+	if summerSemester && !winterSemester {
+		return []string{"ss"}
+	}
+
+	if !summerSemester && winterSemester {
+		return []string{"ws"}
+	}
+
+	return []string{"ss", "ws"}
+}

services/data-manager/service/functions/semester_test.go

@@ -0,0 +1,91 @@
+package functions
+
+import (
+	mockTime "htwkalender/service/functions/time"
+	"reflect"
+	"testing"
+	"time"
+)
+
+func Test_calculateSemesterList(t *testing.T) {
+	type args struct {
+		clock mockTime.Clock
+	}
+	tests := []struct {
+		name string
+		args args
+		want []string
+	}{
+		{
+			name: "is summer semester",
+			args: args{
+				clock: mockTime.MockClock{
+					NowTime: time.Date(2024, 6, 1, 0, 0, 0, 0, time.UTC),
+				},
+			},
+			want: []string{"ss"},
+		},
+		{
+			name: "is winter semester",
+			args: args{
+				clock: mockTime.MockClock{
+					NowTime: time.Date(2024, 1, 1, 0, 0, 0, 0, time.UTC),
+				},
+			},
+			want: []string{"ws"},
+		},
+		{
+			name: "is in both",
+			args: args{
+				clock: mockTime.MockClock{
+					NowTime: time.Date(2024, 3, 22, 0, 0, 0, 0, time.UTC),
+				},
+			},
+			want: []string{"ss", "ws"},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := CalculateSemesterList(tt.args.clock); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("calculateSemesterList() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestGetCurrentSemesterString(t *testing.T) {
+	type args struct {
+		localeTime mockTime.Clock
+	}
+	tests := []struct {
+		name string
+		args args
+		want string
+	}{
+		{
+			name: "is winter semester",
+			args: args{
+				localeTime: mockTime.MockClock{
+					NowTime: time.Date(2024, 1, 1, 0, 0, 0, 0, time.UTC),
+				},
+			},
+			want: "ws",
+		},
+		{
+			name: "is summer semester",
+			args: args{
+				localeTime: mockTime.MockClock{
+					NowTime: time.Date(2024, 6, 1, 0, 0, 0, 0, time.UTC),
+				},
+			},
+			want: "ss",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := GetCurrentSemesterString(tt.args.localeTime); got != tt.want {
+				t.Errorf("GetCurrentSemesterString() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

services/data-manager/service/functions/string.go

@@ -0,0 +1,62 @@
+//Calendar implementation for the HTWK Leipzig timetable. Evaluation and display of the individual dates in iCal format.
+//Copyright (C) 2024 HTWKalender support@htwkalender.de
+
+//This program is free software: you can redistribute it and/or modify
+//it under the terms of the GNU Affero General Public License as published by
+//the Free Software Foundation, either version 3 of the License, or
+//(at your option) any later version.
+
+//This program is distributed in the hope that it will be useful,
+//but WITHOUT ANY WARRANTY; without even the implied warranty of
+//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//GNU Affero General Public License for more details.
+
+//You should have received a copy of the GNU Affero General Public License
+//along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package functions
+
+import (
+	"crypto/sha256"
+	"encoding/hex"
+	"strings"
+)
+
+// check if string is empty or contains only whitespaces
+func OnlyWhitespace(word string) bool {
+	return len(strings.TrimSpace(word)) == 0
+}
+
+// return function to check if rune is a separator
+func IsSeparator(separator []rune) func(rune) bool {
+	return func(character rune) bool {
+		for _, sep := range separator {
+			if sep == character {
+				return true
+			}
+		}
+		return false
+	}
+}
+
+func Contains(s []string, e string) bool {
+	for _, a := range s {
+		if a == e {
+			return true
+		}
+	}
+	return false
+}
+
+func HashString(s string) string {
+	hash := sha256.New()
+	hash.Write([]byte(s))
+	hashInBytes := hash.Sum(nil)
+	return hex.EncodeToString(hashInBytes)
+}
+
+func SeperateRoomString(rooms string) []string {
+	return strings.FieldsFunc(rooms, IsSeparator(
+		[]rune{',', '\t', '\n', '\r', ';', ' ', '\u00A0'}),
+	)
+}

services/data-manager/service/functions/string_test.go

@@ -0,0 +1,145 @@
+//Calendar implementation for the HTWK Leipzig timetable. Evaluation and display of the individual dates in iCal format.
+//Copyright (C) 2024 HTWKalender support@htwkalender.de
+
+//This program is free software: you can redistribute it and/or modify
+//it under the terms of the GNU Affero General Public License as published by
+//the Free Software Foundation, either version 3 of the License, or
+//(at your option) any later version.
+
+//This program is distributed in the hope that it will be useful,
+//but WITHOUT ANY WARRANTY; without even the implied warranty of
+//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//GNU Affero General Public License for more details.
+
+//You should have received a copy of the GNU Affero General Public License
+//along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package functions
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestOnlyWhitespace(t *testing.T) {
+	type args struct {
+		word string
+	}
+	tests := []struct {
+		name string
+		args args
+		want bool
+	}{
+		{"empty string", args{""}, true},
+		{"whitespace", args{" "}, true},
+		{"whitespaces", args{"   "}, true},
+		{"whitespaces and tabs", args{"   \t"}, true},
+		{"whitespaces and tabs and newlines", args{"   \t\n"}, true},
+		{"whitespaces and tabs and newlines and non-breaking spaces", args{"   \t\n\u00A0"}, true},
+		{"non-whitespace", args{"a"}, false},
+		{"non-whitespaces", args{"abc"}, false},
+		{"non-whitespaces and tabs", args{"abc\t"}, false},
+		{"non-whitespaces and tabs and newlines", args{"abc\t\n"}, false},
+		{"non-whitespaces and tabs and newlines and non-breaking spaces", args{"abc\t\n\u00A0"}, false},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := OnlyWhitespace(tt.args.word); got != tt.want {
+				t.Errorf("OnlyWhitespace() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestHashString(t *testing.T) {
+	type args struct {
+		s string
+	}
+	tests := []struct {
+		name string
+		args args
+		want string
+	}{
+		{"empty string", args{""}, "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"},
+		{"non-empty string", args{"abc"}, "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := HashString(tt.args.s); got != tt.want {
+				t.Errorf("HashString() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestIsSeparator(t *testing.T) {
+	type args struct {
+		separator []rune
+		character rune
+	}
+	tests := []struct {
+		name string
+		args args
+		want bool
+	}{
+		{"empty separator", args{[]rune{}, 'a'}, false},
+		{"separator with one rune equal", args{[]rune{'a'}, 'a'}, true},
+		{"separator with one rune different", args{[]rune{'a'}, 'b'}, false},
+		{"separator with two runes equal", args{[]rune{'a', 'b'}, 'a'}, true},
+		{"separator with two runes equal second", args{[]rune{'a', 'b'}, 'b'}, true},
+		{"separator with two runes different", args{[]rune{'a', 'b'}, 'c'}, false},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := IsSeparator(tt.args.separator)(tt.args.character); got != tt.want {
+				t.Errorf("IsSeparator()() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestContains(t *testing.T) {
+	type args struct {
+		s []string
+		e string
+	}
+	tests := []struct {
+		name string
+		args args
+		want bool
+	}{
+		{"empty slice", args{[]string{}, "a"}, false},
+		{"slice with one element equal", args{[]string{"a"}, "a"}, true},
+		{"slice with one element different", args{[]string{"a"}, "b"}, false},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := Contains(tt.args.s, tt.args.e); got != tt.want {
+				t.Errorf("Contains() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestSeperateRoomString(t *testing.T) {
+	type args struct {
+		rooms string
+	}
+	tests := []struct {
+		name string
+		args args
+		want []string
+	}{
+		{"empty string", args{""}, []string{}},
+		{"one room", args{"a"}, []string{"a"}},
+		{"two rooms", args{"a,b"}, []string{"a", "b"}},
+		{"two rooms with whitespace", args{"a, b"}, []string{"a", "b"}},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := SeperateRoomString(tt.args.rooms); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("SeperateRoomString() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

services/data-manager/service/functions/time/mockClock.go

@@ -0,0 +1,26 @@
+//Calendar implementation for the HTWK Leipzig timetable. Evaluation and display of the individual dates in iCal format.
+//Copyright (C) 2024 HTWKalender support@htwkalender.de
+
+//This program is free software: you can redistribute it and/or modify
+//it under the terms of the GNU Affero General Public License as published by
+//the Free Software Foundation, either version 3 of the License, or
+//(at your option) any later version.
+
+//This program is distributed in the hope that it will be useful,
+//but WITHOUT ANY WARRANTY; without even the implied warranty of
+//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//GNU Affero General Public License for more details.
+
+//You should have received a copy of the GNU Affero General Public License
+//along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package time
+
+import "time"
+
+type MockClock struct {
+	NowTime time.Time
+}
+
+func (m MockClock) Now() time.Time                       { return m.NowTime }
+func (MockClock) After(d time.Duration) <-chan time.Time { return time.After(d) }

services/data-manager/service/functions/time/parse.go

@@ -0,0 +1,36 @@
+//Calendar implementation for the HTWK Leipzig timetable. Evaluation and display of the individual dates in iCal format.
+//Copyright (C) 2024 HTWKalender support@htwkalender.de
+
+//This program is free software: you can redistribute it and/or modify
+//it under the terms of the GNU Affero General Public License as published by
+//the Free Software Foundation, either version 3 of the License, or
+//(at your option) any later version.
+
+//This program is distributed in the hope that it will be useful,
+//but WITHOUT ANY WARRANTY; without even the implied warranty of
+//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//GNU Affero General Public License for more details.
+
+//You should have received a copy of the GNU Affero General Public License
+//along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package time
+
+import (
+	"github.com/pocketbase/pocketbase/tools/types"
+	"log/slog"
+	"time"
+)
+
+func ParseTime(timeString string) (time.Time, error) {
+	return time.Parse("2006-01-02T15:04:05Z", timeString)
+}
+
+func ParseAsTypesDatetime(time time.Time) types.DateTime {
+	dateTime, err := types.ParseDateTime(time)
+	if err != nil {
+		slog.Error("Failed to parse time as types.DateTime", "error", err)
+		return types.DateTime{}
+	}
+	return dateTime
+}

services/data-manager/service/functions/time/realClock.go

@@ -0,0 +1,24 @@
+//Calendar implementation for the HTWK Leipzig timetable. Evaluation and display of the individual dates in iCal format.
+//Copyright (C) 2024 HTWKalender support@htwkalender.de
+
+//This program is free software: you can redistribute it and/or modify
+//it under the terms of the GNU Affero General Public License as published by
+//the Free Software Foundation, either version 3 of the License, or
+//(at your option) any later version.
+
+//This program is distributed in the hope that it will be useful,
+//but WITHOUT ANY WARRANTY; without even the implied warranty of
+//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//GNU Affero General Public License for more details.
+
+//You should have received a copy of the GNU Affero General Public License
+//along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package time
+
+import "time"
+
+type RealClock struct{}
+
+func (RealClock) Now() time.Time                         { return time.Now() }
+func (RealClock) After(d time.Duration) <-chan time.Time { return time.After(d) }

services/data-manager/service/functions/time/time.go

@@ -0,0 +1,24 @@
+//Calendar implementation for the HTWK Leipzig timetable. Evaluation and display of the individual dates in iCal format.
+//Copyright (C) 2024 HTWKalender support@htwkalender.de
+
+//This program is free software: you can redistribute it and/or modify
+//it under the terms of the GNU Affero General Public License as published by
+//the Free Software Foundation, either version 3 of the License, or
+//(at your option) any later version.
+
+//This program is distributed in the hope that it will be useful,
+//but WITHOUT ANY WARRANTY; without even the implied warranty of
+//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//GNU Affero General Public License for more details.
+
+//You should have received a copy of the GNU Affero General Public License
+//along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+package time
+
+import "time"
+
+type Clock interface {
+	Now() time.Time
+	After(d time.Duration) <-chan time.Time
+}