diff options
author | Steve <nilslice@gmail.com> | 2016-12-19 11:19:53 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-12-19 11:19:53 -0800 |
commit | 3791fadda7b761ffba38c567da29e2e71acd1dfb (patch) | |
tree | 79d810f9aafa1868ee0760983937470d0eea3db8 /content | |
parent | b20c5bdee38682edc851e646d815a34689c3c923 (diff) |
[addons] Creating foundation for plugin-like system "Addons" (#24)
* adding addons dir and sample addon which enables the use of a new input element in forms for referencing other content. "addons" is a conceptual plugin-like feature, similar to wordpress "plugins" dir, but not as sophisticated
Diffstat (limited to 'content')
-rw-r--r-- | content/doc.go | 6 | ||||
-rw-r--r-- | content/item.go | 138 | ||||
-rw-r--r-- | content/types.go | 21 |
3 files changed, 6 insertions, 159 deletions
diff --git a/content/doc.go b/content/doc.go new file mode 100644 index 0000000..3e15b11 --- /dev/null +++ b/content/doc.go @@ -0,0 +1,6 @@ +// Package content contains all user-supplied content which the system is to +// manage. Generate content types by using the Ponzu command line tool 'ponzu' +// by running `$ ponzu generate <contentName> <fieldName:type...>` +// Note: doc.go file is required to build the Ponzu command since main.go +// imports content package to a blank identifier. +package content diff --git a/content/item.go b/content/item.go deleted file mode 100644 index eb79aa0..0000000 --- a/content/item.go +++ /dev/null @@ -1,138 +0,0 @@ -package content - -import ( - "fmt" - "net/http" - - uuid "github.com/satori/go.uuid" -) - -// Sluggable makes a struct locatable by URL with it's own path -// As an Item implementing Sluggable, slugs may overlap. If this is an issue, -// make your content struct (or one which imbeds Item) implement Sluggable -// and it will override the slug created by Item's SetSlug with your struct's -type Sluggable interface { - SetSlug(string) - ItemSlug() string -} - -// Identifiable enables a struct to have its ID set/get. Typically this is done -// to set an ID to -1 indicating it is new for DB inserts, since by default -// a newly initialized struct would have an ID of 0, the int zero-value, and -// BoltDB's starting key per bucket is 0, thus overwriting the first record. -type Identifiable interface { - ItemID() int - SetItemID(int) - UniqueID() uuid.UUID - String() string -} - -// Hookable provides our user with an easy way to intercept or add functionality -// to the different lifecycles/events a struct may encounter. Item implements -// Hookable with no-ops so our user can override only whichever ones necessary. -type Hookable interface { - BeforeSave(req *http.Request) error - AfterSave(req *http.Request) error - - BeforeDelete(req *http.Request) error - AfterDelete(req *http.Request) error - - BeforeApprove(req *http.Request) error - AfterApprove(req *http.Request) error - - BeforeReject(req *http.Request) error - AfterReject(req *http.Request) error -} - -// Item should only be embedded into content type structs. -type Item struct { - UUID uuid.UUID `json:"uuid"` - ID int `json:"id"` - Slug string `json:"slug"` - Timestamp int64 `json:"timestamp"` - Updated int64 `json:"updated"` -} - -// Time partially implements the Sortable interface -func (i Item) Time() int64 { - return i.Timestamp -} - -// Touch partially implements the Sortable interface -func (i Item) Touch() int64 { - return i.Updated -} - -// SetSlug sets the item's slug for its URL -func (i *Item) SetSlug(slug string) { - i.Slug = slug -} - -// ItemSlug sets the item's slug for its URL -func (i *Item) ItemSlug() string { - return i.Slug -} - -// ItemID gets the Item's ID field -// partially implements the Identifiable interface -func (i Item) ItemID() int { - return i.ID -} - -// SetItemID sets the Item's ID field -// partially implements the Identifiable interface -func (i *Item) SetItemID(id int) { - i.ID = id -} - -// UniqueID gets the Item's UUID field -// partially implements the Identifiable interface -func (i Item) UniqueID() uuid.UUID { - return i.UUID -} - -// String formats an Item into a printable value -// partially implements the Identifiable interface -func (i Item) String() string { - return fmt.Sprintf("Item ID: %s", i.UniqueID()) -} - -// BeforeSave is a no-op to ensure structs which embed Item implement Hookable -func (i Item) BeforeSave(req *http.Request) error { - return nil -} - -// AfterSave is a no-op to ensure structs which embed Item implement Hookable -func (i Item) AfterSave(req *http.Request) error { - return nil -} - -// BeforeDelete is a no-op to ensure structs which embed Item implement Hookable -func (i Item) BeforeDelete(req *http.Request) error { - return nil -} - -// AfterDelete is a no-op to ensure structs which embed Item implement Hookable -func (i Item) AfterDelete(req *http.Request) error { - return nil -} - -// BeforeApprove is a no-op to ensure structs which embed Item implement Hookable -func (i Item) BeforeApprove(req *http.Request) error { - return nil -} - -// AfterApprove is a no-op to ensure structs which embed Item implement Hookable -func (i Item) AfterApprove(req *http.Request) error { - return nil -} - -// BeforeReject is a no-op to ensure structs which embed Item implement Hookable -func (i Item) BeforeReject(req *http.Request) error { - return nil -} - -// AfterReject is a no-op to ensure structs which embed Item implement Hookable -func (i Item) AfterReject(req *http.Request) error { - return nil -} diff --git a/content/types.go b/content/types.go deleted file mode 100644 index 696d589..0000000 --- a/content/types.go +++ /dev/null @@ -1,21 +0,0 @@ -package content - -const ( - // ErrTypeNotRegistered means content type isn't registered (not found in Types map) - ErrTypeNotRegistered = `Error: -There is no type registered for %[1]s - -Add this to the file which defines %[1]s{} in the 'content' package: - - - func init() { - Types["%[1]s"] = func() interface{} { return new(%[1]s) } - } - - -` -) - -// Types is a map used to reference a type name to its actual Editable type -// mainly for lookups in /admin route based utilities -var Types = make(map[string]func() interface{}) |