models

Documentation

Index

• Constants
• Variables
• func CaptureCoverImages(books []Book, imageDir string) error
• func CreateBooksDatabase(databaseName string) *gorm.DB
• func ExtractSurname(fullName string) string
• func TransferJsonBooksToDatabase(jsonFileName string, db *gorm.DB) error
• type Author
• type Book
  • func (b Book) BookPageLink() template.HTML
  • func (b Book) Create(db *gorm.DB) (uint, error)
  • func (b Book) DisplayRating() string
  • func (b Book) FormatTitle() string
  • func (b Book) MakeCoverImageFilename(imageDir string, size string) string
  • func (b Book) MakeCoverImageUrl(size string) string
  • func (b Book) MakeLinkedMediumCoverImageTag() template.HTML
  • func (b Book) MakeLinkedSmallCoverImageTag() template.HTML
  • func (b Book) SiteFileName() string
• type BookSearchResult
  • func SearchBook(title string, author string) []BookSearchResult
  • func (s BookSearchResult) Print()
• type BooksByAuthor
  • func AllBooksFromJson(bookFile string) BooksByAuthor
• type OpenLibraryBookAuthor
• type OpenLibraryBookIsbn
• type Rating
  • func StringToRating(s string) (Rating, error)
  • func (r Rating) Display() string
  • func (r *Rating) Scan(value interface{}) error
  • func (r Rating) String() string
  • func (r Rating) Value() (driver.Value, error)

Constants

const ImageDir string = "images/cover_images"

const LargeCover = "L"

const MediumCover = "M"

const Missing int64 = -999998

const SmallCover = "S"

const Verbose bool = false

Variables

var (
	Unknown     = Rating{"Not Rated"}
	VeryGood    = Rating{"Very-Good"}
	Excellent   = Rating{"Excellent"}
	Kindle      = Rating{"Kindle"}
	Interesting = Rating{"Interesting"}
	NotGood     = Rating{"Not-Good"}
)

Functions

func CaptureCoverImages

func CaptureCoverImages(books []Book, imageDir string) error

func CreateBooksDatabase

func CreateBooksDatabase(databaseName string) *gorm.DB

func ExtractSurname

func ExtractSurname(fullName string) string

This might need to get more sophisticated

func TransferJsonBooksToDatabase

func TransferJsonBooksToDatabase(jsonFileName string, db *gorm.DB) error

Types

type Author

type Author struct {
	gorm.Model
	FullName string
	Surname  string
	Books    []Book `gorm:"many2many:book_authors;"`
}

type Book

type Book struct {
	gorm.Model
	PubDate                int64
	DateAdded              time.Time
	AuthorFullName         string
	AuthorSurname          string
	MainTitle              string
	SubTitle               string
	Review                 string
	Rating                 string
	AmazonLink             string
	CoverImageUrl          string
	OpenLibraryUrl         string
	IsfdbUrl               string
	OpenLibraryBookIsbns   []OpenLibraryBookIsbn
	OlCoverId              int64 // Used as the base ID for the image (add suffix -M, -S, -L for sizing.)
	OpenLibraryBookAuthors []OpenLibraryBookAuthor
	OlCoverEditionId       string   // Used to pull up an entry based on a cover
	Authors                []Author `gorm:"many2many:book_authors;"`
}

func (Book) BookPageLink

func (b Book) BookPageLink() template.HTML

func (Book) Create

func (b Book) Create(db *gorm.DB) (uint, error)

func (Book) DisplayRating

func (b Book) DisplayRating() string

func (Book) FormatTitle

func (b Book) FormatTitle() string

func (Book) MakeCoverImageFilename

func (b Book) MakeCoverImageFilename(imageDir string, size string) string

func (Book) MakeCoverImageUrl

func (b Book) MakeCoverImageUrl(size string) string

func (Book) MakeLinkedMediumCoverImageTag

func (b Book) MakeLinkedMediumCoverImageTag() template.HTML

func (Book) MakeLinkedSmallCoverImageTag

func (b Book) MakeLinkedSmallCoverImageTag() template.HTML

func (Book) SiteFileName

func (b Book) SiteFileName() string

type BookSearchResult

type BookSearchResult struct {
	Number             int
	FirstYearPublished int
	Title              string
	Author             string
	AmazonId           string
	CoverEditionKey    string
	EditionIds         []string // all editions
	AuthorIds          []string // Can be more than one author
}

func SearchBook

func SearchBook(title string, author string) []BookSearchResult

func (BookSearchResult) Print

func (s BookSearchResult) Print()

type BooksByAuthor

type BooksByAuthor map[string][]Book

func AllBooksFromJson

func AllBooksFromJson(bookFile string) BooksByAuthor

type OpenLibraryBookAuthor

type OpenLibraryBookAuthor struct {
	gorm.Model
	BookId     uint
	OlAuthorId string
}

type OpenLibraryBookIsbn

type OpenLibraryBookIsbn struct {
	gorm.Model
	BookId uint
	Isbn   string
}

type Rating

type Rating struct {
	// contains filtered or unexported fields
}

func StringToRating

func StringToRating(s string) (Rating, error)

func (Rating) Display

func (r Rating) Display() string

func (*Rating) Scan

func (r *Rating) Scan(value interface{}) error

func (Rating) String

func (r Rating) String() string

func (Rating) Value

func (r Rating) Value() (driver.Value, error)

For Gorm