holes

Documentation

Index

• func GetHole(w http.ResponseWriter, r *http.Request)
• func GetTest(w http.ResponseWriter, r *http.Request)
• func HoleTitle(str string) string
• func ListHoles(w http.ResponseWriter, r *http.Request)
• func ListTests(w http.ResponseWriter, r *http.Request)
• type Hole
  • func (h Hole) Collection() *firestore.CollectionRef
  • func (h Hole) Data() interface{}
  • func (h Hole) DocID() string
• type Holes
  • func (hs Holes) Len() int
  • func (hs Holes) Less(i, j int) bool
  • func (hs Holes) Swap(i, j int)
• type ShortTest
• type ShortTests
• type Test
  • func (test Test) Check(output string) (bool, error)
  • func (t Test) ShortTest() ShortTest
• type Tests
  • func GetTests(hole string) (Tests, error)
  • func (ts Tests) ShortTests() ShortTests

Functions

func GetHole

func GetHole(w http.ResponseWriter, r *http.Request)

GetHole gets a hole using an id

func GetTest

func GetTest(w http.ResponseWriter, r *http.Request)

GetTest gets a test using a hole and test id

func HoleTitle

func HoleTitle(str string) string

HoleTitle sets the hole title to an id using string lower

func ListHoles

func ListHoles(w http.ResponseWriter, r *http.Request)

ListHoles lists 100 active holes

func ListTests

func ListTests(w http.ResponseWriter, r *http.Request)

ListTests gets all tests for a specific hole

Types

type Hole

type Hole struct {
	ID         string `json:"ID"`
	Name       string `json:"Name"`
	Difficulty string `json:"Difficulty"`
	Question   string `json:"Question"`

	CreatedAt     time.Time `json:"CreatedAt"`
	CreatedBy     string    `json:"CreatedBy"`
	LastUpdatedAt time.Time `json:"LastUpdatedAt"`
	Active        bool      `json:"Active"`
}

func (Hole) Collection

func (h Hole) Collection() *firestore.CollectionRef

DB Interface stuff

func (Hole) Data

func (h Hole) Data() interface{}

func (Hole) DocID

func (h Hole) DocID() string

type Holes

type Holes []Hole

func (Holes) Len

func (hs Holes) Len() int

Sort interface stuff

func (Holes) Less

func (hs Holes) Less(i, j int) bool

func (Holes) Swap

func (hs Holes) Swap(i, j int)

type ShortTest

type ShortTest struct {
	ID          string `json:"ID"`
	Name        string `json:"Name"`                  // Test name on the frontend
	Hidden      bool   `json:"Hidden"`                // When hidden is false, output will be shown on frontend
	Input       string `json:"Input,omitempty"`       // Returns test input when test is NOT hidden
	Description string `json:"Description,omitempty"` // Optional description field
	Active      bool   `json:"Active"`
}

ShortTest is the frontend object for a Test structure

type ShortTests

type ShortTests []ShortTest

type Test

type Test struct {
	ID          string `json:"ID"`
	Name        string `json:"Name"`        // Test name on the frontend
	Hidden      bool   `json:"Hidden"`      // When hidden is false, output will be shown on frontend
	Description string `json:"Description"` // Optional description field
	Active      bool   `json:"Active"`

	Input       string `json:"Input"`
	OutputRegex string `json:"OutputRegex"`

	CreatedAt time.Time `json:"CreatedAt"`
}

Test extends ShortTest and has hidden information solely for the database

func (Test) Check

func (test Test) Check(output string) (bool, error)

Check is a function to see if the output given is correct in the scope of the test

func (Test) ShortTest

func (t Test) ShortTest() ShortTest

ShortTest returns what a user should see for a test case. If a test is not hidden, then the input is returned as well

type Tests

type Tests []Test

func GetTests

func GetTests(hole string) (Tests, error)

func (Tests) ShortTests

func (ts Tests) ShortTests() ShortTests