rework to only export a few functions

Author: martinlindhe

Makefile

@@ -0,0 +1,2 @@
+test:
+	go test -v

README.md

@@ -3,6 +3,7 @@
 Subber is a cli tool and library for reading,
 writing and manipulating .srt subtitle files written in Go
 
+WARNING: The API is unstable, work in progress!
 
 ### Features
 
@@ -22,10 +23,10 @@ and the `subber` cli app automates this task.
 
 # Installation
 
-Assuming golang is installed on your system:
+To install the command line:
 
 ```
-go install github.com/martinlindhe/subber
+go install github.com/martinlindhe/subber/subber
 ```
 
 

filter/caps.go renamed to caps.go

@@ -1,22 +1,20 @@
-package filter
+package subber
 
 import (
-	"fmt"
+	"log"
 	"strings"
-
-	"github.com/martinlindhe/subber/caption"
 )
 
-// CapsFixer converts "ALL CAPS" text into "Initial letter capped"
-func CapsFixer(captions []caption.Caption) []caption.Caption {
+// filterCapitalization converts "ALL CAPS" text into "Initial letter capped"
+func filterCapitalization(captions []caption) []caption {
 
 	for _, cap := range captions {
 		for i, line := range cap.Text {
 
 			clean := ucFirst(line)
 
 			if clean != cap.Text[i] {
-				fmt.Printf("[caps] %s -> %s\n", cap.Text[i], clean)
+				log.Printf("[caps] %s -> %s\n", cap.Text[i], clean)
 				cap.Text[i] = clean
 			}
 		}

caps_test.go

@@ -0,0 +1,30 @@
+package subber
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestFilterCapitalization(t *testing.T) {
+
+	var in = []caption{
+		{
+			Seq:   1,
+			Start: makeTime(0, 0, 4, 630),
+			End:   makeTime(0, 0, 6, 18),
+			Text:  []string{"GO NINJA!", "NINJA GO!"},
+		},
+	}
+
+	var expected = []caption{
+		{
+			1,
+			makeTime(0, 0, 4, 630),
+			makeTime(0, 0, 6, 18),
+			[]string{"Go ninja!", "Ninja go!"},
+		},
+	}
+
+	assert.Equal(t, expected, filterCapitalization(in))
+}

caption.go

@@ -0,0 +1,11 @@
+package subber
+
+import "time"
+
+// caption represents one subtitle block
+type caption struct {
+	Seq   int
+	Start time.Time
+	End   time.Time
+	Text  []string
+}

caption/caption.go

@@ -0,0 +1,19 @@
+package subber
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRenderTime(t *testing.T) {
+
+	cap := caption{
+		1,
+		makeTime(18, 40, 22, 110),
+		makeTime(18, 41, 20, 123),
+		[]string{"<i>Go ninja!</i>"},
+	}
+
+	assert.Equal(t, "18:40:22,110 --> 18:41:20,123", cap.srtTime())
+}

caption/caption_test.go

@@ -1,16 +1,29 @@
-package cleaner
+package subber
 
 import (
-	"fmt"
+	"log"
 	"strings"
-
-	"github.com/martinlindhe/subber/caption"
 )
 
+// CleanupSub performs cleanup on .srt data, returning a string. caller is responsible for passing UTF8 string
+func CleanupSub(utf8 string, filterName string, keepAds bool) (string, error) {
+
+	captions := parseSrt(utf8)
+	if !keepAds {
+		captions = removeAds(captions)
+	}
+
+	captions = filterSubs(captions, filterName)
+
+	out := renderSrt(captions)
+
+	return out, nil
+}
+
 // RemoveAds removes advertisement from the subtitles
-func RemoveAds(subs []caption.Caption) []caption.Caption {
+func removeAds(subs []caption) []caption {
 
-	var res []caption.Caption
+	var res []caption
 
 	ads := []string{
 
@@ -79,7 +92,7 @@ func RemoveAds(subs []caption.Caption) []caption.Caption {
 			for _, adLine := range ads {
 				if !isAd && strings.Contains(x, adLine) {
 					isAd = true
-					fmt.Println("[ads]", orgSeq, sub.Text, "matched", adLine)
+					log.Println("[ads]", orgSeq, sub.Text, "matched", adLine)
 					break
 				}
 			}