Refactor mini-tools

Gemfile

@@ -52,4 +52,7 @@ group :test do
   # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing]
   gem "capybara"
   gem "selenium-webdriver"
+  gem "mocha"
+  gem "vcr"
+  gem "webmock"
 end

Gemfile.lock

@@ -159,6 +159,9 @@ GEM
       xpath (~> 3.2)
     concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
+    crack (1.0.0)
+      bigdecimal
+      rexml
     crass (1.0.6)
     csv (3.3.0)
     date (3.3.4)
@@ -192,6 +195,7 @@ GEM
     ffi (1.17.0-x86_64-linux-gnu)
     globalid (1.2.1)
       activesupport (>= 6.1)
+    hashdiff (1.1.1)
     hotwire-livereload (1.4.1)
       actioncable (>= 6.0.0)
       listen (>= 3.0.0)
@@ -238,6 +242,8 @@ GEM
     method_source (1.1.0)
     mini_mime (1.1.5)
     minitest (5.25.1)
+    mocha (2.4.5)
+      ruby2_keywords (>= 0.0.5)
     msgpack (1.7.2)
     multi_xml (0.7.1)
       bigdecimal (~> 3.1)
@@ -357,6 +363,7 @@ GEM
     ruby-lsp-rails (0.3.11)
       ruby-lsp (>= 0.17.2, < 0.18.0)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
     securerandom (0.3.1)
     selenium-webdriver (4.24.0)
@@ -402,6 +409,8 @@ GEM
     unicode-display_width (2.5.0)
     uri (0.13.1)
     useragent (0.16.10)
+    vcr (6.3.1)
+      base64
     view_component (3.14.0)
       activesupport (>= 5.2.0, < 8.0)
       concurrent-ruby (~> 1.0)
@@ -411,6 +420,10 @@ GEM
       activemodel (>= 6.0.0)
       bindex (>= 0.4.0)
       railties (>= 6.0.0)
+    webmock (3.23.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.8.1)
     websocket (1.2.11)
     websocket-driver (0.7.6)
@@ -443,6 +456,7 @@ DEPENDENCIES
   importmap-rails
   jbuilder
   lucide-rails!
+  mocha
   pagy
   pg (~> 1.5)
   propshaft
@@ -460,7 +474,9 @@ DEPENDENCIES
   tailwindcss-rails
   turbo-rails
   tzinfo-data
+  vcr
   web-console
+  webmock
 
 BUNDLED WITH
    2.5.6

README.md

@@ -15,6 +15,7 @@ After cloning the repo, the basic setup commands are:
 cd marketing
 cp .env.example .env
 bin/setup
+bin/rails db:seed
 bin/dev
 ```
 

app/controllers/tools_controller.rb

@@ -1,68 +1,34 @@
-# This controller handles the logic for displaying and interacting with financial tools.
-# It provides functionality for listing all tools and showing individual tool details.
 class ToolsController < ApplicationController
-  # GET /tools
-  # Retrieves all tools from the database.
-  #
-  # @return [Array<Tool>] An array of all Tool objects.
   def index
     @tools = Tool.all
   end
 
-  # GET /tools/:id
-  # Retrieves and displays a specific tool based on its slug.
-  # Also fetches additional data required for certain tools.
-  #
-  # @param id [String] The slug of the tool to be displayed.
-  # @return [Tool] The requested Tool object.
   def show
-    @tool = Tool.find_by(slug: params[:id])
-
-    if @tool.slug == "home-affordability-calculator" || @tool.slug == "early-mortgage-payoff-calculator"
-      @loan_interest_rate_30 = fetch_mortgage_rate("MORTGAGE30US")
-      @loan_interest_rate_15 = fetch_mortgage_rate("MORTGAGE15US")
-    end
-
-    if @tool.slug == "stock-portfolio-backtest"
-      @stocks = Rails.cache.fetch("all_stocks", expires_in: 24.hours) do
-        Stock.select(:name, :symbol).map { |stock| { name: stock.name, value: stock.symbol } }
-      end
-    end
-
-    if @tool.needs_stock_data?
-      @stock_prices = StockPrice.fetch_stock_data
-    end
+    @tool = Tool.presenter_from tool_params.compact_blank
   end
 
   private
-
-  # Fetches the current mortgage rate for a given mortgage duration.
-  #
-  # @param mortgage_duration [String] The mortgage duration code (e.g., "MORTGAGE30US").
-  # @return [String, nil] The current mortgage rate as a string, or nil if the fetch fails.
-  def fetch_mortgage_rate(mortgage_duration)
-    cache_key = "mortgage_rate_#{mortgage_duration}"
-
-    Rails.cache.fetch(cache_key, expires_in: 24.hours) do
-      response = HTTParty.get("https://api.stlouisfed.org/fred/series/observations",
-        query: {
-          series_id: mortgage_duration,
-          api_key: ENV["FRED_API_KEY"],
-          file_type: "json",
-          limit: 1,
-          sort_order: "desc",
-          frequency: "w"
-        }
-      )
-
-      if response.success?
-        JSON.parse(response.body)["observations"].first["value"]
-      else
-        raise "Failed to fetch mortgage rate: #{response.code} #{response.message}"
-      end
+    def tool_params
+      params.permit :slug,
+        # Bogleheads Growth Calculator
+        :invested_amount, :stock_market_ticker, :international_stock_market_ticker, :bond_market_ticker, :stock_market_percentage, :international_stock_market_percentage, :bond_market_percentage,
+        # Compound Interest Calculator
+        :initial_investment, :monthly_contribution, :years_to_grow, :annual_interest_rate,
+        # Early Mortgage Payoff Calculator
+        :loan_amount, :original_term, :years_left, :interest_rate, :extra_payment, :savings_rate,
+        # Financial Freedom Calculator
+        :current_savings, :monthly_expenses, :annual_savings_growth_rate,
+        # Home Affordability Calculator
+        :loan_duration, :loan_interest_rate, :desired_home_price, :down_payment, :annual_pre_tax_income, :monthly_debt_payments, :hoa_plus_pmi,
+        # Inflation Calculator
+        :initial_amount, :years, :inflation_rate,
+        # Loan Calculator,
+        :loan_amount, :interest_rate, :loan_term, :loan_period, :date,
+        # Retirement Calculator
+        :annual_salary, :monthly_contribution, :annual_salary_increase, :current_age, :retirement_age, :annual_rate_of_return, :current_401k_balance, :employer_match, :salary_limit_match,
+        # ROI Calculator
+        :amount_invested, :amount_returned, :investment_period, :investment_length,
+        # Stock Portfolio Backtest
+        :benchmark_stock, :investment_amount, :start_date, :end_date, { stocks: [], stock_allocations: [] }
     end
-  rescue StandardError => e
-    Rails.logger.error("Error fetching mortgage rate: #{e.message}")
-    nil
-  end
 end

app/helpers/application_form_builder.rb

@@ -23,32 +23,35 @@ def #{selector}(method, options = {})
   end
 
   def unit_field(method, options = {})
-  default_options = { class: "form-field__input pl-1" }
-  default_options[:class] = "form-field__input pl-0" if options[:label_right]
-  merged_options = default_options.merge(options)
+    default_options = { class: "form-field__input pl-1" }
+    default_options[:class] = "form-field__input pl-0" if options[:label_right]
+    merged_options = default_options.merge(options)
 
-  # Prepare options for the outer div
-  outer_div_options = { class: options.delete(:outer_div_class) }
+    # Prepare options for the outer div
+    outer_div_options = { class: options.delete(:outer_div_class) }
 
-  return super(method, merged_options) unless options[:label] || options[:label_right]
+    return super(method, merged_options) unless options[:label] || options[:label_right]
 
-  @template.form_field_tag(outer_div_options) do
-    label_html = if options[:label]
-                   label_content = label(method, *label_args(options))
-                   if options[:required] == false
-                     label_content += @template.tag.span("Optional", class: "form-field__label")
-                   end
-                   @template.tag.div(class: "flex items-center justify-between") { label_content }
-    end
+    @template.form_field_tag(outer_div_options) do
+      label_html = if options[:label]
+        label_content = label(method, *label_args(options))
 
-    content = @template.tag.div(class: "flex items-center") do
-      @template.tag.span(options[:unit_symbol], class: "pl-3 pb-2 pt-1 text-sm text-gray-500") +
-      text_field(method, merged_options.except(:label)) +
-      (@template.tag.span(options[:label_right], class: "text-gray-500 text-xs mr-2") if options[:label_right]).to_s
+        if options[:required] == false
+          label_content += @template.tag.span("Optional", class: "form-field__label")
+        end
+
+        @template.tag.div(class: "flex items-center justify-between") { label_content }
+      end
+
+      content = @template.tag.div(class: "flex items-center") do
+        @template.tag.span(options[:unit_symbol], class: "pl-3 pb-2 pt-1 text-sm text-gray-500") +
+        text_field(method, merged_options.except(:label)) +
+        (@template.tag.span(options[:label_right], class: "text-gray-500 text-xs mr-2") if options[:label_right]).to_s
+      end
+
+      label_html.to_s + content
     end
-    label_html.to_s + content
   end
-end
 
   def submit(value = nil, options = {})
     value, options = nil, value if value.is_a?(Hash)