feat: add Nepali months and weekdays strings for formatting (#27)

Author: arjnep

README.md

@@ -128,6 +128,9 @@ In this package, we provide 2 `go` packages, `nepalitime` and `dateConverter`.
 | `%-d`     | Day of the month as a decimal number.                    | 1, 2, …, 31                              |
 | `%m`      | Month as a zero-padded decimal number.                   | 01, 02, …, 12                            |
 | `%-m`     | Month as a decimal number.                               | 1, 2, …, 12                              |
+| `%B`      | Month as a string                                        | Baisakh, Jestha, ..., Chaitra            |
+| `%A`      | Full name of day of the week                             | Sunday, Monday, ..., Saturday            |
+| `%a`      | Half name of day of the week                             | Sun, Mon, ..., Sat                       |
 | `%y`      | Year without century as a zero-padded decimal number.    | 00, 01, …, 99                            |
 | `%-y`     | Year without century as a decimal number.                | 0, 1, …, 99                              |
 | `%Y`      | Year with century as a zero-padded decimal number.       | 0001, 0002, …, 2078, 2079, …, 9998, 9999 |

constants/constants.go

@@ -3,3 +3,7 @@ package constants
 const (
 	Timezone string = "Asia/Kathmandu"
 )
+
+var (
+	NepaliMonths = [12]string{"Baisakh", "Jestha", "Ashadh", "Shrawan", "Bhadra", "Ashwin", "Kartik", "Mangsir", "Poush", "Magh", "Falgun", "Chaitra"}
+)

nepalitime/formatter.go

@@ -3,6 +3,8 @@ package nepalitime
 import (
 	"strconv"
 	"strings"
+
+	"github.com/opensource-nepal/go-nepali/constants"
 )
 
 func NewFormatter(nepaliTime *NepaliTime) *NepaliFormatter {
@@ -58,6 +60,12 @@ func (obj *NepaliFormatter) getFormatString(directive string) string {
 		return obj.monthNumber()
 	case "-m":
 		return obj.monthNumberNonzero()
+	case "B":
+		return obj.monthName()
+	case "A":
+		return obj.weekDayFull()
+	case "a":
+		return obj.weekDayHalf()
 	case "y":
 		return obj.yearHalf()
 	case "Y":
@@ -119,6 +127,21 @@ func (obj *NepaliFormatter) monthNumber() string {
 	return month
 }
 
+// %B
+func (obj *NepaliFormatter) monthName() string {
+	return constants.NepaliMonths[obj.nepaliTime.month-1]
+}
+
+// %A
+func (obj *NepaliFormatter) weekDayFull() string {
+	return obj.nepaliTime.Weekday().String()
+}
+
+// %a
+func (obj *NepaliFormatter) weekDayHalf() string {
+	return obj.nepaliTime.Weekday().String()[:3]
+}
+
 // %-m
 func (obj *NepaliFormatter) monthNumberNonzero() string {
 	month := strconv.Itoa(obj.nepaliTime.month)

nepalitime/formatter_test.go

@@ -35,6 +35,27 @@ func TestNepaliFormatterFormatdmySlash(t *testing.T) {
 	assert.Equal(t, "14/10/79", res, "%d/%m/%y did not match")
 }
 
+func TestNepaliFormatterFormatdBYSlash(t *testing.T) {
+	formatter := nepalitime.NewFormatter(globalNepaliTime)
+	res := formatter.Format("%d/%B/%Y")
+
+	assert.Equal(t, "14/Magh/2079", res, "%d/%B/%Y did not match")
+}
+
+func TestNepaliFormatterFormatdBYAComma(t *testing.T) {
+	formatter := nepalitime.NewFormatter(globalNepaliTime)
+	res := formatter.Format("%d %B, %Y, %A")
+
+	assert.Equal(t, "14 Magh, 2079, Saturday", res, "%d %B, %Y, %A did not match")
+}
+
+func TestNepaliFormatterFormatdBYaComma(t *testing.T) {
+	formatter := nepalitime.NewFormatter(globalNepaliTime)
+	res := formatter.Format("%d %B, %Y, %a")
+
+	assert.Equal(t, "14 Magh, 2079, Sat", res, "%d %B, %Y, %a did not match")
+}
+
 func TestNepaliFormatterFormatmdYSlash(t *testing.T) {
 	formatter := nepalitime.NewFormatter(globalNepaliTime)
 	res := formatter.Format("%m/%d/%Y")
@@ -77,6 +98,27 @@ func TestNepaliFormatterFormatdmyDash(t *testing.T) {
 	assert.Equal(t, "14-10-79", res, "%d-%m-%y did not match")
 }
 
+func TestNepaliFormatterFormatdBYDash(t *testing.T) {
+	formatter := nepalitime.NewFormatter(globalNepaliTime)
+	res := formatter.Format("%d-%B-%Y")
+
+	assert.Equal(t, "14-Magh-2079", res, "%d-%B-%Y-%A did not match")
+}
+
+func TestNepaliFormatterFormatdBYADash(t *testing.T) {
+	formatter := nepalitime.NewFormatter(globalNepaliTime)
+	res := formatter.Format("%d-%B-%Y-%A")
+
+	assert.Equal(t, "14-Magh-2079-Saturday", res, "%d-%B-%Y-%A did not match")
+}
+
+func TestNepaliFormatterFormatdBYaDash(t *testing.T) {
+	formatter := nepalitime.NewFormatter(globalNepaliTime)
+	res := formatter.Format("%d-%B-%Y-%a")
+
+	assert.Equal(t, "14-Magh-2079-Sat", res, "%d-%B-%Y-%a did not match")
+}
+
 func TestNepaliFormatterFormatmdYDash(t *testing.T) {
 	formatter := nepalitime.NewFormatter(globalNepaliTime)
 	res := formatter.Format("%m-%d-%Y")

nepalitime/nepalitimeregex.go

@@ -35,10 +35,8 @@ func newNepaliTimeRegex() *nepaliTimeRegex {
 		"y": `(?P<y>\d\d)`,
 		"Y": `(?P<Y>\d\d\d\d)`,
 		"z": `(?P<z>[+-]\d\d:?[0-5]\d(:?[0-5]\d(\.\d{1,6})?)?|(?-i:Z))`,
-
-		// "A": obj.__seqToRE(EnglishChar.days, "A"),
-		// "a": obj.__seqToRE(EnglishChar.days_half, "a"),
-		// "B": obj.__seqToRE(EnglishChar.months, "B"),
+		"B": `(?P<B>Baisakh|Jestha|Ashadh|Shrawan|Bhadra|Ashwin|Kartik|Mangsir|Poush|Magh|Falgun|Chaitra")`,
+		"A": `(?P<B>Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday)`,
 		// "b": obj.__seqToRE(EnglishChar.months, "b"),
 		// "p": obj.__seqToRE(("AM", "PM",), "p"),
 		// TODO: implement for the above commented directives

nepalitime/parser.go

@@ -4,6 +4,8 @@ import (
 	"errors"
 	"strconv"
 	"strings"
+
+	"github.com/opensource-nepal/go-nepali/constants"
 )
 
 var nepaliTimeReCache *nepaliTimeRegex
@@ -157,6 +159,19 @@ func transform(data map[string]string) (map[string]int, error) {
 			}
 
 			day = intVal
+		} else if key == "B" {
+			intVal := 0
+			for i, m := range constants.NepaliMonths {
+				if m == val {
+					intVal = i + 1
+					break
+				}
+			}
+			if intVal == 0 {
+				return nil, errors.New("invalid value in %B")
+			}
+
+			month = intVal
 		} else if key == "H" {
 			intVal, err := strconv.Atoi(val)
 			if err != nil {

nepalitime/parser_test.go

@@ -66,6 +66,19 @@ func TestParserWithdmySlashForm(t *testing.T) {
 	assert.Nil(t, err, "error should be nil")
 }
 
+func TestParserWithdBYSlashForm(t *testing.T) {
+	// 2079 magh 14
+	datetimeStr := "14/Magh/2079"
+	format := "%d/%B/%Y"
+
+	expected := "2079-10-14 00:00:00"
+
+	got, err := nepalitime.Parse(datetimeStr, format)
+
+	assert.Equal(t, expected, got.String(), fmt.Sprintf("expected: %s - got: %s", expected, got))
+	assert.Nil(t, err, "error should be nil")
+}
+
 func TestParserWithmdYSlashForm(t *testing.T) {
 	// 2079 magh 14
 	datetimeStr := "10/14/2079"