fix: 添加参数检查和单元测试

Author: mingforpc

README.md

@@ -4,7 +4,7 @@
 [![Forks](https://img.shields.io/github/forks/mingforpc/timeexpression)]()
 [![Stars](https://img.shields.io/github/stars/mingforpc/timeexpression)]()
 [![Forks](https://img.shields.io/github/license/mingforpc/timeexpression)]()
-[![Coverage](https://img.shields.io/badge/coverage-93%25-yellowgreen.svg)]()
+[![Coverage](https://img.shields.io/badge/coverage-94%25-yellowgreen.svg)]()
 
 一个时间表达式的工具，方便用于配置活动时间。
 
@@ -37,7 +37,6 @@ isIn := expr.IsIn(now)             // 结果 false
 
 ## TODO:
 
-0. 更好的参数检验和检查
 1. 语法上支持: `w`开头配置按星期几的方式
 2. 语法上支持: `r`开头配置相对开始时间的方式
 3. 支持计算周期已经开始了多少次，本次周期是第几次等函数

day_expression.go

@@ -52,9 +52,23 @@ func newDayExpression(expression string) (*dayExpression, error) {
 		dayExpression.end = dayExpression.start
 	}
 
+	err = dayExpression.check()
+	if err != nil {
+		return nil, err
+	}
+
 	return dayExpression, nil
 }
 
+// check 检查参数
+func (expression *dayExpression) check() error {
+	if expression.start > expression.end {
+		return errors.New("day error: start after end")
+	}
+
+	return nil
+}
+
 func (expression *dayExpression) isIn(day int) bool {
 	if expression.start <= day && expression.end >= day {
 		return true

day_expression_test.go

@@ -64,6 +64,13 @@ func TestNewDayExpression(t *testing.T) {
 			end:   0,
 			isAll: false,
 		},
+		{
+			exp:   "03-02",
+			err:   errors.New("day error: start after end"),
+			start: 0,
+			end:   0,
+			isAll: false,
+		},
 	}
 
 	for _, data := range testDatas {

hour_expression.go

@@ -2,6 +2,7 @@ package timeexpression
 
 import (
 	"errors"
+	"sort"
 	"strings"
 )
 
@@ -30,14 +31,43 @@ func newHourExpression(hourStr string) (*hourExpression, error) {
 		hourUnits = append(hourUnits, unitExpression)
 	}
 
+	// 简单对开始时间排序(从小到大)
+	sort.Slice(hourUnits, func(i, j int) bool {
+		return hourUnits[i].start.toSec() < hourUnits[j].start.toSec()
+	})
+
 	expression := &hourExpression{
 		hourUnits: hourUnits,
 		isAll:     isAll,
 	}
 
+	err := expression.check()
+	if err != nil {
+		return nil, err
+	}
+
 	return expression, nil
 }
 
+// check 检查参数
+func (expression *hourExpression) check() error {
+
+	// 时间不能有重叠
+	// 时间已经被排序过了
+	var preUnit *hourUnitExpression
+	for _, unit := range expression.hourUnits {
+		if preUnit == nil {
+			preUnit = unit
+		} else {
+			if preUnit.end.toSec() >= unit.start.toSec() {
+				return errors.New("hour error: time overlapping")
+			}
+		}
+	}
+
+	return nil
+}
+
 func (expression *hourExpression) isIn(hour, minute, sec int) bool {
 	for _, unitExpression := range expression.hourUnits {
 		if unitExpression.isIn(hour, minute, sec) {

hour_expression_test.go

@@ -1,11 +1,54 @@
 package timeexpression
 
 import (
+	"errors"
+	"fmt"
 	"github.com/stretchr/testify/assert"
 	"testing"
 	"time"
 )
 
+func TestHourExpression_new(t *testing.T) {
+	testDatas := []struct {
+		exp   string
+		err   error
+		isAll bool
+	}{
+		{
+			exp:   "*",
+			err:   nil,
+			isAll: true,
+		},
+		{
+			exp:   "11:00:00-12:00:00,13:00:00-14:00:00",
+			err:   nil,
+			isAll: false,
+		},
+		{
+			exp:   "11:00:00-12:00:00,12:00:00-14:00:00",
+			err:   errors.New("hour error: time overlapping"),
+			isAll: false,
+		},
+		{
+			exp:   "11:00:00-12:00:00,11:30:00-14:00:00",
+			err:   errors.New("hour error: time overlapping"),
+			isAll: false,
+		},
+	}
+
+	for i, data := range testDatas {
+		fmt.Printf("[%d] [%s]\n", i, data.exp)
+		expression, err := newHourExpression(data.exp)
+		if data.err != nil {
+			assert.NotNil(t, err)
+			assert.EqualError(t, data.err, err.Error())
+		} else {
+			assert.NotNil(t, expression)
+			assert.Equal(t, data.isAll, expression.isAll)
+		}
+	}
+}
+
 func TestHourExpression_IsIn(t *testing.T) {
 	expression, err := newHourExpression("13:00:03-16:59:59,23:00:00-23:30:00")
 	if err != nil {

hour_unit_expression.go

@@ -1,6 +1,7 @@
 package timeexpression
 
 import (
+	"errors"
 	"strings"
 )
 
@@ -52,9 +53,25 @@ func newHourUnitExpression(unitStr string) (*hourUnitExpression, error) {
 		return nil, err
 	}
 
+	err = expression.check()
+	if err != nil {
+		return nil, err
+	}
+
 	return expression, nil
 }
 
+// check 检查参数是否正确
+func (expression *hourUnitExpression) check() error {
+	startSec := expression.start.toSec()
+	endSec := expression.end.toSec()
+	if startSec >= endSec {
+		return errors.New("hour error: start after end")
+	}
+
+	return nil
+}
+
 // isIn 是否在表达式范围内
 func (expression *hourUnitExpression) isIn(hour, minute, sec int) bool {
 

hour_unit_expression_test.go

@@ -1,6 +1,9 @@
 package timeexpression
 
 import (
+	"errors"
+	"fmt"
+	"github.com/stretchr/testify/assert"
 	"testing"
 	"time"
 )
@@ -10,6 +13,77 @@ type testData struct {
 	result bool
 }
 
+func TestHourUnitExpression_New(t *testing.T) {
+	testDatas := []struct {
+		exp   string
+		err   error
+		start hourUnit
+		end   hourUnit
+		isAll bool
+	}{
+		{
+			exp:   "[13]",
+			err:   ErrHourUnitFormat,
+			start: hourUnit{},
+			end:   hourUnit{},
+			isAll: false,
+		},
+		{
+			exp: "*",
+			err: nil,
+			start: hourUnit{
+				Hour:   0,
+				Minute: 0,
+				Sec:    0,
+			},
+			end: hourUnit{
+				Hour:   24,
+				Minute: 0,
+				Sec:    0,
+			},
+			isAll: true,
+		},
+		{
+			exp: "12:00:00-13:00:00",
+			err: nil,
+			start: hourUnit{
+				Hour:   12,
+				Minute: 0,
+				Sec:    0,
+			},
+			end: hourUnit{
+				Hour:   13,
+				Minute: 0,
+				Sec:    0,
+			},
+			isAll: false,
+		},
+		{
+			exp:   "13:00:00-12:00:00",
+			err:   errors.New("hour error: start after end"),
+			start: hourUnit{},
+			end:   hourUnit{},
+			isAll: false,
+		},
+	}
+
+	for i, data := range testDatas {
+		fmt.Printf("[%d] ex[%s]\n", i, data.exp)
+
+		expression, err := newHourUnitExpression(data.exp)
+		if data.err != nil {
+			assert.NotNil(t, err)
+			assert.EqualError(t, data.err, err.Error())
+		} else {
+			assert.NotNil(t, expression)
+			assert.Equal(t, data.start, expression.start)
+			assert.Equal(t, data.end, expression.end)
+			assert.Equal(t, data.isAll, expression.isAll)
+		}
+
+	}
+}
+
 // TestHourUnitExpression_IsIn 判断日期格式
 func TestHourUnitExpression_IsIn(t *testing.T) {
 	expression, err := newHourUnitExpression("13:00:03-16:59:59")

month_expression.go

@@ -52,9 +52,22 @@ func newMonthExpression(expression string) (*monthExpression, error) {
 		monthExpression.end = monthExpression.start
 	}
 
+	err = monthExpression.check()
+	if err != nil {
+		return nil, err
+	}
+
 	return monthExpression, nil
 }
 
+func (expression *monthExpression) check() error {
+	if expression.start > expression.end {
+		return errors.New("month error: start after end")
+	}
+
+	return nil
+}
+
 // isIn 月份是否在周期内
 func (expression *monthExpression) isIn(month int) bool {
 	if expression.start <= month && expression.end >= month {

month_expression_test.go

@@ -57,6 +57,10 @@ func TestNewMonthExpression(t *testing.T) {
 				Message:    "",
 			},
 		},
+		{
+			expr: "06-03",
+			err:  errors.New("month error: start after end"),
+		},
 	}
 
 	for _, testData := range testDataList {

year_expression.go

@@ -1,6 +1,7 @@
 package timeexpression
 
 import (
+	"errors"
 	"strings"
 	"time"
 )
@@ -52,9 +53,23 @@ func newYearExpression(expression string) (*yearExpression, error) {
 		yearExpression.end = yearExpression.start
 	}
 
+	err = yearExpression.check()
+	if err != nil {
+		return nil, err
+	}
+
 	return yearExpression, nil
 }
 
+// check 检查参数
+func (expression *yearExpression) check() error {
+	if expression.start > expression.end {
+		return errors.New("year error: start after end")
+	}
+
+	return nil
+}
+
 // isIn 是否在范围内
 func (expression *yearExpression) isIn(year int) bool {
 

year_expression_test.go

@@ -1,6 +1,7 @@
 package timeexpression
 
 import (
+	"errors"
 	"github.com/stretchr/testify/assert"
 	"testing"
 	"time"
@@ -56,6 +57,10 @@ func TestNewYearExpression(t *testing.T) {
 				Message:    "",
 			},
 		},
+		{
+			exp: "2001-1999",
+			err: errors.New("year error: start after end"),
+		},
 	}
 
 	for _, data := range testDatas {