More extraction into better groupings

Signed-off-by: Chris Cummer <[email protected]>

Author: senorprogrammer

main.go

@@ -7,16 +7,15 @@ import (
 	"io/ioutil"
 	"log"
 	"os"
-	"os/exec"
 	"path/filepath"
 	"strings"
 	"sync"
 	"time"
 
-	"github.com/ericaro/frontmatter"
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing/object"
 	"github.com/olebedev/config"
+	"github.com/senorprogrammer/til/pages"
 	"github.com/senorprogrammer/til/src"
 )
 
@@ -60,6 +59,8 @@ func init() {
 	flag.StringVar(&targetDirFlag, "target", "", "specifies the target directory key")
 }
 
+/* -------------------- Main -------------------- */
+
 func main() {
 	flag.Parse()
 
@@ -112,11 +113,12 @@ func main() {
 func buildContent() {
 	pages := loadPages()
 	tagMap := buildTagPages(pages)
+
 	buildIndexPage(pages, tagMap)
 }
 
 // buildIndexPage creates the main index.md page that is the root of the site
-func buildIndexPage(pages []*src.Page, tagMap *src.TagMap) {
+func buildIndexPage(pageSet []*pages.Page, tagMap *pages.TagMap) {
 	src.Info(statusIdxBuild)
 
 	content := ""
@@ -135,7 +137,7 @@ func buildIndexPage(pages []*src.Page, tagMap *src.TagMap) {
 	content += "\n"
 
 	// Write the page list into the middle of the page
-	content += pagesToHTMLUnorderedList(pages)
+	content += pagesToHTMLUnorderedList(pageSet)
 	content += "\n"
 
 	// Write the footer content into the bottom of the index
@@ -151,7 +153,7 @@ func buildIndexPage(pages []*src.Page, tagMap *src.TagMap) {
 	filePath := fmt.Sprintf(
 		"%s/index.%s",
 		tDir,
-		src.FileExtension,
+		pages.FileExtension,
 	)
 
 	err = ioutil.WriteFile(filePath, []byte(content), 0644)
@@ -163,10 +165,10 @@ func buildIndexPage(pages []*src.Page, tagMap *src.TagMap) {
 }
 
 // buildTagPages creates the tag pages, with links to posts tagged with those names
-func buildTagPages(pages []*src.Page) *src.TagMap {
+func buildTagPages(pageSet []*pages.Page) *pages.TagMap {
 	src.Info(statusTagBuild)
 
-	tagMap := src.NewTagMap(pages)
+	tagMap := pages.NewTagMap(pageSet)
 
 	var wGroup sync.WaitGroup
 
@@ -195,7 +197,7 @@ func buildTagPages(pages []*src.Page) *src.TagMap {
 				"%s/%s.%s",
 				tDir,
 				tagName,
-				src.FileExtension,
+				pages.FileExtension,
 			)
 
 			err = ioutil.WriteFile(filePath, []byte(content), 0644)
@@ -218,9 +220,9 @@ func createNewPage(title string) {
 		src.Defeat(err)
 	}
 
-	page := src.NewPage(title, tDir)
+	page := pages.NewPage(title, tDir)
 
-	err = open(page)
+	err = page.Open(defaultEditor)
 	if err != nil {
 		src.Defeat(err)
 	}
@@ -262,8 +264,8 @@ func listTargetDirectories(cfg *config.Config) {
 
 // loadPages reads the page files from disk (in reverse chronological order) and
 // creates Page instances from them
-func loadPages() []*src.Page {
-	pages := []*src.Page{}
+func loadPages() []*pages.Page {
+	pageSet := []*pages.Page{}
 
 	tDir, err := src.GetTargetDir(src.GlobalConfig, targetDirFlag, true)
 	if err != nil {
@@ -274,39 +276,39 @@ func loadPages() []*src.Page {
 		fmt.Sprintf(
 			"%s/*.%s",
 			tDir,
-			src.FileExtension,
+			pages.FileExtension,
 		),
 	)
 
 	for i := len(filePaths) - 1; i >= 0; i-- {
-		page := readPage(filePaths[i])
-		pages = append(pages, page)
+		page := pages.PageFromFilePath(filePaths[i])
+		pageSet = append(pageSet, page)
 	}
 
-	return pages
+	return pageSet
 }
 
-// open tll the OS to open the newly-created page in the editor (as specified in the config)
-// If there's no editor explicitly defined by the user, tell the OS to try and open it
-func open(page *src.Page) error {
-	editor := src.GlobalConfig.UString("editor", defaultEditor)
-	if editor == "" {
-		editor = defaultEditor
-	}
+// // open tll the OS to open the newly-created page in the editor (as specified in the config)
+// // If there's no editor explicitly defined by the user, tell the OS to try and open it
+// func open(page *src.Page) error {
+// 	editor := src.GlobalConfig.UString("editor", defaultEditor)
+// 	if editor == "" {
+// 		editor = defaultEditor
+// 	}
 
-	cmd := exec.Command(editor, page.FilePath)
-	err := cmd.Run()
+// 	cmd := exec.Command(editor, page.FilePath)
+// 	err := cmd.Run()
 
-	return err
-}
+// 	return err
+// }
 
 // pagesToHTMLUnorderedList creates the unordered list of page links that appear
 // on the index and tag pages
-func pagesToHTMLUnorderedList(pages []*src.Page) string {
+func pagesToHTMLUnorderedList(pageSet []*pages.Page) string {
 	content := ""
-	prevPage := &src.Page{}
+	prevPage := &pages.Page{}
 
-	for _, page := range pages {
+	for _, page := range pageSet {
 		if !page.IsContentPage() {
 			continue
 		}
@@ -353,26 +355,6 @@ func push() {
 	}
 }
 
-// readPage reads the contents of the page and unmarshals it into the Page struct,
-// making the page's internal frontmatter programmatically accessible
-func readPage(filePath string) *src.Page {
-	page := new(src.Page)
-
-	data, err := ioutil.ReadFile(filePath)
-	if err != nil {
-		src.Defeat(err)
-	}
-
-	err = frontmatter.Unmarshal(data, page)
-	if err != nil {
-		src.Defeat(err)
-	}
-
-	page.FilePath = filePath
-
-	return page
-}
-
 // https://github.com/go-git/go-git/blob/master/_examples/commit/main.go
 func save(commitMsg string) {
 	src.Info(statusRepoSave)

src/page.go renamed to pages/page.go

@@ -1,11 +1,15 @@
-package src
+package pages
 
 import (
 	"fmt"
 	"io/ioutil"
+	"os/exec"
 	"path/filepath"
 	"strings"
 	"time"
+
+	"github.com/ericaro/frontmatter"
+	"github.com/senorprogrammer/til/src"
 )
 
 const (
@@ -46,6 +50,25 @@ func NewPage(title string, targetDir string) *Page {
 	return page
 }
 
+// PageFromFilePath creates and returns a Page instance from a file path
+func PageFromFilePath(filePath string) *Page {
+	page := new(Page)
+
+	data, err := ioutil.ReadFile(filePath)
+	if err != nil {
+		src.Defeat(err)
+	}
+
+	err = frontmatter.Unmarshal(data, page)
+	if err != nil {
+		src.Defeat(err)
+	}
+
+	page.FilePath = filePath
+
+	return page
+}
+
 // CreatedAt returns a time instance representing when the page was created
 func (page *Page) CreatedAt() time.Time {
 	date, err := time.Parse(time.RFC3339, page.Date)
@@ -90,6 +113,20 @@ func (page *Page) Link() string {
 	)
 }
 
+// Open tll the OS to open the newly-created page in the editor (as specified in the config)
+// If there's no editor explicitly defined by the user, tell the OS to try and open it
+func (page *Page) Open(defaultEditor string) error {
+	editor := src.GlobalConfig.UString("editor", defaultEditor)
+	if editor == "" {
+		editor = defaultEditor
+	}
+
+	cmd := exec.Command(editor, page.FilePath)
+	err := cmd.Run()
+
+	return err
+}
+
 // PrettyDate returns a human-friendly representation of the CreatedAt date
 func (page *Page) PrettyDate() string {
 	return page.CreatedAt().Format("Jan 02, 2006")
@@ -102,7 +139,7 @@ func (page *Page) Save() {
 
 	err := ioutil.WriteFile(page.FilePath, []byte(pageSrc), 0644)
 	if err != nil {
-		Defeat(err)
+		src.Defeat(err)
 	}
 }
 

src/tag.go renamed to pages/tag.go

@@ -1,4 +1,4 @@
-package src
+package pages
 
 import (
 	"fmt"

src/tag_map.go renamed to pages/tag_map.go

@@ -1,19 +1,21 @@
-package src
+package pages
 
-import "sort"
+import (
+	"sort"
+)
 
 // TagMap is a map of tag name to Tag instance
 type TagMap struct {
 	Tags map[string][]*Tag
 }
 
 // NewTagMap creates and returns an instance of TagMap
-func NewTagMap(pages []*Page) *TagMap {
+func NewTagMap(pageSet []*Page) *TagMap {
 	tm := &TagMap{
 		Tags: make(map[string][]*Tag),
 	}
 
-	tm.BuildFromPages(pages)
+	tm.BuildFromPages(pageSet)
 
 	return tm
 }