jsonresume/model/json.go

/*
 * Copyright (c) 2018 Arnaud Ysmal.  All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

package model

import (
	"encoding/json"
	"io/ioutil"
	"regexp"
	"strings"
	"time"
)

const ISO8601DateLayout = "2006-01-02"

var MarkdownURLRegexp = regexp.MustCompile(`\[([^]]*)\]\((http[^)]*)\)`)

type ResumeDate struct {
	time.Time
}

func (ct *ResumeDate) UnmarshalJSON(b []byte) (err error) {
	s := strings.Trim(string(b), "\"")
	if s == "null" {
		ct.Time = time.Time{}
		return
	}
	ct.Time, err = time.Parse(ISO8601DateLayout, s)
	return
}

// Resume represent Curriculum Vitae
type Resume struct {
	Title          string `json:"title"`
	UseFullAddress bool
	Language       string        `json:"lang"`
	Basic          Basic         `json:"basics"`
	Work           []Work        `json:"work"`
	Volunteer      []Volunteer   `json:"volunteer"`
	Education      []Education   `json:"education"`
	Awards         []Award       `json:"awards"`
	Publications   []Publication `json:"publications"`
	Skills         []Skill       `json:"skills"`
	Languages      []Language    `json:"languages"`
	Interests      []Interest    `json:"interests"`
	References     []Reference   `json:"references"`
	Projects       []Project     `json:"projects"`
}

// Basic is the basic information for a resume
type Basic struct {
	Name     string          `json:"name"`
	Label    string          `json:"label"`
	Image    string          `json:"image"`
	Email    string          `json:"email"`
	Phone    string          `json:"phone"`
	URL      string          `json:"url"`
	Summary  string          `json:"summary"`
	Location UserLocation    `json:"location"`
	Profiles []SocialProfile `json:"profiles"`
}

// Location is the location details of a resume owner.
type UserLocation struct {
	Address      string `json:"address"`
	ShortAddress string `json:"shortAddress"`
	PostalCode   string `json:"postalCode"`
	City         string `json:"city"`
	CountryCode  string `json:"countryCode"`
	Region       string `json:"region"`
}

// SocialProfile is the profile of the resume owner.
type SocialProfile struct {
	Network  string `json:"network"`
	UserName string `json:"username"`
	URL      string `json:"url"`
}

type Highlight struct {
	Title string   `json:"title"`
	Items []string `json:"items"`
}

// Work is the work details of the resume owner.
type Work struct {
	Name        string      `json:"name"`
	Hide        bool        `json:"hide"`
	Location    string      `json:"location"`
	Description string      `json:"description"`
	Position    string      `json:"position"`
	URL         string      `json:"url"`
	StartDate   ResumeDate  `json:"startDate"`
	EndDate     ResumeDate  `json:"endDate"`
	Summary     string      `json:"summary"`
	Highlights  []Highlight `json:"highlights"`
	Keywords    []string    `json:"keywords"`
}

// Volunteer is the volunteer details of the resume owner.
type Volunteer struct {
	Organization string      `json:"organization"`
	Hide         bool        `json:"hide"`
	Position     string      `json:"position"`
	URL          string      `json:"url"`
	StartDate    ResumeDate  `json:"startDate"`
	EndDate      ResumeDate  `json:"endDate"`
	Summary      string      `json:"summary"`
	Highlights   []Highlight `json:"highlights"`
	Keywords     []string    `json:"keywords"`
}

// Education is the education details of the resume owner.
type Education struct {
	Institution string     `json:"institution"`
	Hide        bool       `json:"hide"`
	Location    string     `json:"location"`
	Area        string     `json:"area"`
	StudyType   string     `json:"studyType"`
	StartDate   ResumeDate `json:"startDate"`
	EndDate     ResumeDate `json:"endDate"`
	GPA         string     `json:"gpa"`
	Courses     []string   `json:"courses"`
}

// Award is the award details of the resume owner.
type Award struct {
	Title   string     `json:"title"`
	Date    ResumeDate `json:"date"`
	Awarder string     `json:"awarder"`
	Summary string     `json:"summary"`
}

// Publication is the publication details of the resume owner.
type Publication struct {
	Name        string     `json:"name"`
	Publisher   string     `json:"publisher"`
	ReleaseDate ResumeDate `json:"releaseDate"`
	URL         string     `json:"url"`
	Summary     string     `json:"summary"`
}

// Skill is the skill details of the resume owner.
type Skill struct {
	Name     string   `json:"name"`
	Level    string   `json:"level"`
	Keywords []string `json:"keywords"`
}

// Language is the language details of the resume owner.
type Language struct {
	Language string `json:"language"`
	Fluency  string `json:"fluency"`
}

// Interest is the interest details of the resume owner.
type Interest struct {
	Name     string   `json:"name"`
	Keywords []string `json:"keywords"`
}

// Referee is the details about a person who is refereeing for the resume owner.
type Reference struct {
	Name      string `json:"name"`
	Reference string `json:"reference"`
}

// Volunteer is the volunteer details of the resume owner.
type Project struct {
	Name        string      `json:"name"`
	Hide        bool        `json:"hide"`
	Description string      `json:"description"`
	Highlights  []Highlight `json:"highlights"`
	Keywords    []string    `json:"keywords"`
	StartDate   ResumeDate  `json:"startDate"`
	EndDate     ResumeDate  `json:"endDate"`
	URL         string      `json:"url"`
	Roles       []string    `json:"roles"`
	Entity      string      `json:"entity"`
	Type        string      `json:"type"`
}

func Parse(f string) (*Resume, error) {
	var content []byte
	var err error
	var r Resume

	if content, err = ioutil.ReadFile(f); err != nil {
		return nil, err
	}
	if err = json.Unmarshal(content, &r); err != nil {
		return nil, err
	}
	return &r, nil
}