profile.go

// Copyright (c) 2013-2021 by Michael Dvorkin, Brandon Lee Camilleri and contributors. All Rights Reserved. Use of this source code is governed by a MIT-style license that can be found in README.md.

package TerminalStocks

import (
	"encoding/json"
	"io/ioutil"
	"os/user"
)

// File name in user's home directory where settings are stored.
const TSrc = `/.TSrc`

// Profile manages Terminal Stocks program settings as defined by user.
// The settings are serialized using JSON and saved in the ~/.TSrc file.
type Profile struct {
	Tickers        []string // List of stock tickers to display.
	QuotesRefresh  int      // Time interval to refresh stock quotes.
	selectedColumn int      // Stores selected column number when the column editor is active.
}

// Creates the profile and attempts to load the settings from ~/.TSrc file.
// If the file is not there it gets created with default values.
func NewProfile() *Profile {
	profile := &Profile{}
	data, err := ioutil.ReadFile(profile.defaultFileName())
	if err != nil { // Set default values:
		profile.QuotesRefresh = 5 // Stock quotes get updated every 5 seconds (12 times per minute).
		profile.Tickers = []string{`0700.HK`, `1810.HK`, `AAPL`, `ABNB`, `AMD`, `AMZN`, `ATVI`, `BABA`, `C`, `DIS`, `FB`, `GOOG`, `IBM`, `INTC`, `KO`, `MA`, `MSFT`, `NFLX`, `NVDA`, `ORCL`, `PYPL`, `SONY`, `SQ`, `TSLA`, `V`, `BTC-USD`, `ETH-USD`}
		profile.Save()
	} else {
		json.Unmarshal(data, profile)
	}
	profile.selectedColumn = -1

	return profile
}

// Save serializes settings using JSON and saves them in ~/.TSrc file.
func (profile *Profile) Save() error {
	data, err := json.Marshal(profile)
	if err != nil {
		return err
	}

	return ioutil.WriteFile(profile.defaultFileName(), data, 0644)
}

//-----------------------------------------------------------------------------
func (profile *Profile) defaultFileName() string {
	usr, err := user.Current()
	if err != nil {
		panic(err)
	}
	return usr.HomeDir + TSrc
}