Put Page into a better shared location

Author: CerealBoy

auto-docs/docs/store.go

@@ -15,6 +15,7 @@ import (
 	"path/filepath"
 	"strings"
 
+	autodocs "github.com/cloudcloud/auto-docs"
 	"gitlab.com/golang-commonmark/markdown"
 )
 
@@ -25,7 +26,7 @@ var (
 
 func init() {
 	S.Dirs = []*Dir{}
-	S.Pages = make(map[string]*Page, 0)
+	S.Pages = make(map[string]*autodocs.Page, 0)
 }
 
 // Dir gives a holder of further nodes.
@@ -38,21 +39,13 @@ type Dir struct {
 	Text     string `json:"text"`
 }
 
-// Page is the content structure for an individual page item.
-type Page struct {
-	// Name is the displayable identifier for a page.
-	Name string `json:"name"`
-	// Content is the parsed markup of the page.
-	Content string `json:"content"`
-}
-
 // Store captures the doc file references and content.
 type Store struct {
 	// Dirs tracks the structure of pages under their paths.
 	Dirs []*Dir `json:"pages"`
 
 	// Pages captures the content for a full path page.
-	Pages map[string]*Page `json:"-"`
+	Pages map[string]*autodocs.Page `json:"-"`
 
 	// path is the base that this store is defined for.
 	path string
@@ -130,15 +123,15 @@ func addToDir(d []*Dir, p, o string) []*Dir {
 }
 
 // buildPage
-func buildPage(p, d string) (*Page, error) {
+func buildPage(p, d string) (*autodocs.Page, error) {
 	b := tokenise(p)
 	m := markdown.New(markdown.XHTMLOutput(true))
 	f, err := ioutil.ReadFile(d)
 	if err != nil {
 		return nil, fmt.Errorf("unable to load markdown file: %s", err)
 	}
 
-	return &Page{
+	return &autodocs.Page{
 		Name:    b[len(b)-1],
 		Content: m.RenderToString(f),
 	}, nil

auto-docs/docs/store_test.go

@@ -8,6 +8,7 @@ import (
 	"testing"
 	"time"
 
+	autodocs "github.com/cloudcloud/auto-docs"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -47,7 +48,7 @@ func TestUpdateFromPath(t *testing.T) {
 	for _, a := range x {
 		s := &Store{
 			Dirs:  []*Dir{},
-			Pages: map[string]*Page{},
+			Pages: map[string]*autodocs.Page{},
 		}
 		log.SetOutput(a.Buffer)
 
@@ -175,7 +176,7 @@ func TestAddToDir(t *testing.T) {
 }
 
 type pageStruct struct {
-	ExpPage *Page
+	ExpPage *autodocs.Page
 	ExpErr  error
 	InpPag  string
 	InpDir  string
@@ -186,7 +187,7 @@ func TestBuildPage(t *testing.T) {
 	assert := assert.New(t)
 	x := []pageStruct{
 		{
-			ExpPage: &Page{Name: "root", Content: "<h1>root</h1>\n"},
+			ExpPage: &autodocs.Page{Name: "root", Content: "<h1>root</h1>\n"},
 			ExpErr:  nil,
 			InpPag:  "/root",
 			InpDir:  getTestMarkdownDir() + "root.md",

go.sum

@@ -5,6 +5,7 @@ github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc
 github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk=
 github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/elazarl/go-bindata-assetfs v1.0.0 h1:G/bYguwHIzWq9ZoyUQqrjTmJbbYn3j3CKKpKinvZLFk=
 github.com/elazarl/go-bindata-assetfs v1.0.0/go.mod h1:v+YaWX3bdea5J/mo8dSETolEo7R71Vk1u8bnjau5yw4=
@@ -56,6 +57,7 @@ github.com/pelletier/go-buffruneio v0.2.0/go.mod h1:JkE26KsDizTr40EUHkXVtNPvgGtb
 github.com/pelletier/go-toml v1.2.0 h1:T5zMGML61Wp+FlcbWjRDT7yAxhJNAiPPLOFECq181zc=
 github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
 github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/sergi/go-diff v1.0.0 h1:Kpca3qRNrduNnOQeazBd0ysaKrUJiIuISHxogkT9RPQ=
 github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
@@ -75,6 +77,7 @@ github.com/src-d/gcfg v1.4.0 h1:xXbNR5AlLSA315x2UO+fTSSAXCDf+Ar38/6oyGbDKQ4=
 github.com/src-d/gcfg v1.4.0/go.mod h1:p/UMsR43ujA89BJY9duynAwIpvqEujIH/jFlfL7jWoI=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/ugorji/go v1.1.2 h1:JON3E2/GPW2iDNGoSAusl1KDf5TRQ8k8q7Tp097pZGs=
 github.com/ugorji/go v1.1.2/go.mod h1:hnLbHMwcvSihnDhEfx2/BzKp2xb0Y+ErdfYcrs9tkJQ=

page.go

@@ -0,0 +1,11 @@
+package autodocs
+
+// Page is a structure to store an individual page that has been
+// processed and ready to be displayed.
+type Page struct {
+	// Name is the displayable identifier for the page.
+	Name string `json:"name"`
+
+	// Content contains the parsed content for this page.
+	Content string `json:"content"`
+}