feat: added currency conversion for summary line only

achannarasappa · May 31, 2021 · 5df8a74 · 5df8a74
1 parent e18cf5a
commit 5df8a74
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -94,6 +94,7 @@ show-separator: true
 show-holdings: true
 interval: 5
 currency: USD
+currency-convert-summary-only: false
 watchlist:
   - NET
   - TEAM

diff --git a/internal/common/common.go b/internal/common/common.go
@@ -11,18 +11,19 @@ type Context struct {
 }
 
 type Config struct {
-	RefreshInterval       int               `yaml:"interval"`
-	Watchlist             []string          `yaml:"watchlist"`
-	Lots                  []Lot             `yaml:"lots"`
-	Separate              bool              `yaml:"show-separator"`
-	ExtraInfoExchange     bool              `yaml:"show-tags"`
-	ExtraInfoFundamentals bool              `yaml:"show-fundamentals"`
-	ShowSummary           bool              `yaml:"show-summary"`
-	ShowHoldings          bool              `yaml:"show-holdings"`
-	Proxy                 string            `yaml:"proxy"`
-	Sort                  string            `yaml:"sort"`
-	Currency              string            `yaml:"currency"`
-	ColorScheme           ConfigColorScheme `yaml:"colors"`
+	RefreshInterval            int               `yaml:"interval"`
+	Watchlist                  []string          `yaml:"watchlist"`
+	Lots                       []Lot             `yaml:"lots"`
+	Separate                   bool              `yaml:"show-separator"`
+	ExtraInfoExchange          bool              `yaml:"show-tags"`
+	ExtraInfoFundamentals      bool              `yaml:"show-fundamentals"`
+	ShowSummary                bool              `yaml:"show-summary"`
+	ShowHoldings               bool              `yaml:"show-holdings"`
+	Proxy                      string            `yaml:"proxy"`
+	Sort                       string            `yaml:"sort"`
+	Currency                   string            `yaml:"currency"`
+	CurrencyConvertSummaryOnly bool              `yaml:"currency-convert-summary-only"`
+	ColorScheme                ConfigColorScheme `yaml:"colors"`
 }
 
 type ConfigColorScheme struct {

diff --git a/internal/currency/currency.go b/internal/currency/currency.go
@@ -127,10 +127,18 @@ func GetCurrencyRates(client resty.Client, symbols []string, targetCurrency stri
 
 func GetCurrencyRateFromContext(ctx c.Context, fromCurrency string) (float64, float64, string) {
 	if currencyRate, ok := ctx.Reference.CurrencyRates[fromCurrency]; ok {
+
+		// Convert only the summary currency to the configured currency
+		if ctx.Config.Currency != "" && ctx.Config.CurrencyConvertSummaryOnly {
+			return 1.0, currencyRate.Rate, fromCurrency
+		}
+
+		// Convert all quotes and positions to target currency and implicitly convert summary currency (i.e. no conversion since underlying values are already converted)
 		if ctx.Config.Currency != "" {
 			return currencyRate.Rate, 1.0, currencyRate.ToCurrency
 		}
 
+		// Convert only the summary currency to the default currency (USD) when currency conversion is not enabled
 		return 1.0, currencyRate.Rate, currencyRate.ToCurrency
 
 	}

diff --git a/internal/currency/currency_test.go b/internal/currency/currency_test.go
@@ -197,7 +197,7 @@ var _ = Describe("Currency", func() {
 	})
 
 	When("the currency is not set", func() {
-		It("should return rate to convert", func() {
+		It("should return the conversion rate to convert only the summary line", func() {
 			inputCtx := c.Context{
 				Config: c.Config{
 					Currency: "",
@@ -223,4 +223,33 @@ var _ = Describe("Currency", func() {
 			Expect(outputCurrencyCode).To(Equal("EUR"))
 		})
 	})
+
+	When("the option to convert only the summary values is set", func() {
+		It("should return summary conversion rate", func() {
+			inputCtx := c.Context{
+				Config: c.Config{
+					Currency:                   "EUR",
+					CurrencyConvertSummaryOnly: true,
+				},
+				Reference: c.Reference{
+					CurrencyRates: c.CurrencyRates{
+						"USD": c.CurrencyRate{
+							FromCurrency: "USD",
+							ToCurrency:   "EUR",
+							Rate:         1.25,
+						},
+						"GBP": c.CurrencyRate{
+							FromCurrency: "GBP",
+							ToCurrency:   "EUR",
+							Rate:         2,
+						},
+					},
+				},
+			}
+			outputRate, outputDefaultRate, outputCurrencyCode := GetCurrencyRateFromContext(inputCtx, "USD")
+			Expect(outputRate).To(Equal(1.0))
+			Expect(outputDefaultRate).To(Equal(1.25))
+			Expect(outputCurrencyCode).To(Equal("USD"))
+		})
+	})
 })