Merge pull request #3 from edoardottt/devel

Refine Functions

README.md

@@ -42,9 +42,12 @@ import reading "github.com/edoardottt/go-readingtime"
 
 func main() {
     t := reading.RawEstimate(`Lorem ipsum dolor sit amet, consectetur...`)
-    fmt.Println(t) // 2m0s
+    fmt.Println(t) // 120
 
     t := reading.Estimate(`Lorem ipsum dolor sit amet, consectetur...`)
+    fmt.Println(t) // 2m0s
+
+    t := reading.HumanEstimate(`Lorem ipsum dolor sit amet, consectetur...`)
     fmt.Println(t) // 2 minutes
 }
 ```

readingtime.go

@@ -23,11 +23,29 @@ const (
 	exceedMinute    = 30
 )
 
-// Estimate returns a string represting a humanly readable
+// RawEstimate returns a float64 (seconds) represting an
 // estimation of how long it would take to read the input text.
-func Estimate(input string) string {
+func RawEstimate(input string) float64 {
+	words := strings.Fields(input)
+	minutes := len(words) / wpm
+	seconds := len(words) % wpm
+	f := float64(minutes*secondsInMinute + durationLessThanAMinute(seconds))
+
+	return f
+}
+
+// Estimate returns a time.Duration object represting an
+// estimation of how long it would take to read the input text.
+func Estimate(input string) time.Duration {
+	f := RawEstimate(input)
+	return duration(f)
+}
+
+// HumanEstimate returns a string represting a humanly readable
+// estimation of how long it would take to read the input text.
+func HumanEstimate(input string) string {
 	var (
-		rawMinutes = RawEstimate(input).Minutes()
+		rawMinutes = Estimate(input).Minutes()
 		fmtResult  = "%s minute"
 	)
 
@@ -40,17 +58,6 @@ func Estimate(input string) string {
 	return fmt.Sprintf(fmtResult, strconv.Itoa(intResult))
 }
 
-// RawEstimate returns a time.Time object represting an
-// estimation of how long it would take to read the input text.
-func RawEstimate(input string) time.Duration {
-	words := strings.Fields(input)
-	minutes := len(words) / wpm
-	seconds := len(words) % wpm
-	f := float64(minutes*secondsInMinute + durationLessThanAMinute(seconds))
-
-	return duration(f)
-}
-
 func duration(f float64) time.Duration {
 	return time.Duration(f * billion)
 }

readingtime_test.go

@@ -16,6 +16,50 @@ import (
 )
 
 func TestRawEstimate(t *testing.T) {
+	tests := []struct {
+		name  string
+		input string
+		want  float64
+	}{
+		{
+			name: "238 words",
+			input: `Speedily say has suitable disposal add boy. On forth doubt miles of child. Exercise joy man children rejoiced. Yet uncommonly his ten who diminution astonished. Demesne new manners savings staying had. Under folly balls death own point now men. Match way these she avoid see death. She whose drift their fat off.
+
+			Delightful remarkably mr on announcing themselves entreaties favourable. About to in so terms voice at. Equal an would is found seems of. The particular friendship one sufficient terminated frequently themselves. It more shed went up is roof if loud case. Delay music in lived noise an. Beyond genius really enough passed is up.
+			
+			Needed feebly dining oh talked wisdom oppose at. Applauded use attempted strangers now are middleton concluded had. It is tried no added purse shall no on truth. Pleased anxious or as in by viewing forbade minutes prevent. Too leave had those get being led weeks blind. Had men rose from down lady able. Its son him ferrars proceed six parlors. Her say projection age announcing decisively men. Few gay sir those green men timed downs widow chief. Prevailed remainder may propriety can and.
+			
+			Good draw knew bred ham busy his hour. Ask agreed answer rather joy nature admire wisdom. Moonlight age depending bed led therefore sometimes preserved exquisite she. An fail up so shot leaf wise in. Minuter highest his arrived for put and. Hopes lived by rooms oh in no death house.`,
+			want: 60,
+		},
+		{
+			name: "476 words",
+			input: `Speedily say has suitable disposal add boy. On forth doubt miles of child. Exercise joy man children rejoiced. Yet uncommonly his ten who diminution astonished. Demesne new manners savings staying had. Under folly balls death own point now men. Match way these she avoid see death. She whose drift their fat off.
+
+			Delightful remarkably mr on announcing themselves entreaties favourable. About to in so terms voice at. Equal an would is found seems of. The particular friendship one sufficient terminated frequently themselves. It more shed went up is roof if loud case. Delay music in lived noise an. Beyond genius really enough passed is up.
+			
+			Needed feebly dining oh talked wisdom oppose at. Applauded use attempted strangers now are middleton concluded had. It is tried no added purse shall no on truth. Pleased anxious or as in by viewing forbade minutes prevent. Too leave had those get being led weeks blind. Had men rose from down lady able. Its son him ferrars proceed six parlors. Her say projection age announcing decisively men. Few gay sir those green men timed downs widow chief. Prevailed remainder may propriety can and.
+			
+			Good draw knew bred ham busy his hour. Ask agreed answer rather joy nature admire wisdom. Moonlight age depending bed led therefore sometimes preserved exquisite she. An fail up so shot leaf wise in. Minuter highest his arrived for put and. Hopes lived by rooms oh in no death house.
+			Speedily say has suitable disposal add boy. On forth doubt miles of child. Exercise joy man children rejoiced. Yet uncommonly his ten who diminution astonished. Demesne new manners savings staying had. Under folly balls death own point now men. Match way these she avoid see death. She whose drift their fat off.
+
+			Delightful remarkably mr on announcing themselves entreaties favourable. About to in so terms voice at. Equal an would is found seems of. The particular friendship one sufficient terminated frequently themselves. It more shed went up is roof if loud case. Delay music in lived noise an. Beyond genius really enough passed is up.
+			
+			Needed feebly dining oh talked wisdom oppose at. Applauded use attempted strangers now are middleton concluded had. It is tried no added purse shall no on truth. Pleased anxious or as in by viewing forbade minutes prevent. Too leave had those get being led weeks blind. Had men rose from down lady able. Its son him ferrars proceed six parlors. Her say projection age announcing decisively men. Few gay sir those green men timed downs widow chief. Prevailed remainder may propriety can and.
+			
+			Good draw knew bred ham busy his hour. Ask agreed answer rather joy nature admire wisdom. Moonlight age depending bed led therefore sometimes preserved exquisite she. An fail up so shot leaf wise in. Minuter highest his arrived for put and. Hopes lived by rooms oh in no death house.`,
+			want: 120,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := readingtime.RawEstimate(tt.input)
+			require.Equal(t, tt.want, got)
+		})
+	}
+}
+
+func TestEstimate(t *testing.T) {
 	tests := []struct {
 		name  string
 		input string
@@ -53,13 +97,13 @@ func TestRawEstimate(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got := readingtime.RawEstimate(tt.input)
+			got := readingtime.Estimate(tt.input)
 			require.Equal(t, tt.want, got)
 		})
 	}
 }
 
-func TestEstimate(t *testing.T) {
+func TestHumanEstimate(t *testing.T) {
 	tests := []struct {
 		name  string
 		input string
@@ -126,7 +170,7 @@ func TestEstimate(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got := readingtime.Estimate(tt.input)
+			got := readingtime.HumanEstimate(tt.input)
 			require.Equal(t, tt.want, got)
 		})
 	}