First pass at the clean up and caching of the historical trends to ma…

…ke it more usable.

app/controllers/historical_trends/base_controller.rb

@@ -1,32 +1,5 @@
 class HistoricalTrends::BaseController < ApplicationController
-  def series(type)
-    items = []
-
-    current_organization.items.sort.each do |item|
-      next if item.line_items.where(itemizable_type: type, item: item).blank?
-
-      dates = Hash.new
-
-      (1..Time.zone.today.month).each do |month|
-        dates[month] = 0
-      end
-
-      total_items(item.line_items, type).each do |line_item|
-        month = line_item.dig(0).to_date.month
-        dates[month] = line_item.dig(1)
-      end
-
-      items << { name: item.name, data: dates.values }
-    end
-
-    items.sort_by { |hsh| hsh[:name] }
-  end
-
-  private
-
-  def total_items(line_items, type)
-    line_items.where(itemizable_type: type)
-              .group_by_month(:created_at)
-              .sum(:quantity)
+  def cached_series(type)
+    Rails.cache.fetch("#{current_organization.short_name}-historical-#{type}-data") { HistoricalTrendService.new(current_organization.id, type).series }
   end
 end

app/controllers/historical_trends/distributions_controller.rb

@@ -1,6 +1,6 @@
 class HistoricalTrends::DistributionsController < HistoricalTrends::BaseController
   def index
-    @series = series('Distribution')
+    @series = cached_series('Distribution')
     @title = 'Monthly Distributions'
   end
 end

app/controllers/historical_trends/donations_controller.rb

@@ -1,6 +1,6 @@
 class HistoricalTrends::DonationsController < HistoricalTrends::BaseController
   def index
-    @series = series('Donation')
+    @series = cached_series('Donation')
     @title = 'Monthly Donations'
   end
 end

app/controllers/historical_trends/purchases_controller.rb

@@ -1,6 +1,6 @@
 class HistoricalTrends::PurchasesController < HistoricalTrends::BaseController
   def index
-    @series = series('Purchase')
+    @series = cached_series('Purchase')
     @title = "Monthly Purchases"
   end
 end

app/helpers/historical_trends_helper.rb

@@ -0,0 +1,21 @@
+module HistoricalTrendsHelper
+  MONTHS = [
+    "Jan",
+    "Feb",
+    "Mar",
+    "Apr",
+    "May",
+    "Jun",
+    "Jul",
+    "Aug",
+    "Sep",
+    "Oct",
+    "Nov",
+    "Dec"
+  ]
+
+  def last_12_months
+    current_month = Time.zone.now.month
+    MONTHS.rotate(current_month)
+  end
+end

app/jobs/historical_data_cache_job.rb

@@ -0,0 +1,7 @@
+class HistoricalDataCacheJob < ApplicationJob
+  def perform(org_id:, type:)
+    organization = Organization.find_by(id: org_id)
+
+    Rails.cache.write("#{organization.short_name}-historical-#{type}-data", HistoricalTrendService.new(organization.id, type).series)
+  end
+end

app/services/historical_trend_service.rb

@@ -0,0 +1,36 @@
+class HistoricalTrendService
+  def initialize(organization_id, type)
+    @organization = Organization.find(organization_id)
+    @type = type
+  end
+
+  def series
+    items = []
+
+    @organization.items.active.sort.each do |item|
+      next if item.line_items.where(itemizable_type: @type, item: item).blank?
+
+      month_offset = [*1..12].rotate(12 - Time.zone.today.month)
+
+      dates = (1..12).index_with { |i| 0 }
+
+      total_items(item.line_items, @type).each do |line_item|
+        month = line_item.dig(0).to_date.month
+        dates[(month_offset.index(month) + 1)] = line_item.dig(1)
+      end
+
+      items << {name: item.name, data: dates.values, visible: false}
+    end
+
+    items.sort_by { |hsh| hsh[:name] }
+  end
+
+  private
+
+  def total_items(line_items, type)
+    line_items.where(created_at: 1.year.ago.beginning_of_month..Time.current)
+      .where(itemizable_type: type)
+      .group_by_month(:created_at)
+      .sum(:quantity)
+  end
+end

app/views/historical_trends/distributions/index.html.erb

@@ -8,23 +8,10 @@
         text: @title
       },
       subtitle: {
-        text: "Source: humanessentials.app"
+        text: "Cached Data, may be up to 24 hours old"
       },
       xAxis: {
-        categories: [
-          'Jan',
-          'Feb',
-          'Mar',
-          'Apr',
-          'May',
-          'Jun',
-          'Jul',
-          'Aug',
-          'Sep',
-          'Oct',
-          'Nov',
-          'Dec'
-        ],
+        categories: last_12_months,
         crosshair: true
       },
       yAxis: {

app/views/historical_trends/donations/index.html.erb

@@ -8,23 +8,10 @@
         text: @title
       },
       subtitle: {
-        text: "Source: humanessentials.app"
+        text: "Cached Data, may be up to 24 hours old"
       },
       xAxis: {
-        categories: [
-          'Jan',
-          'Feb',
-          'Mar',
-          'Apr',
-          'May',
-          'Jun',
-          'Jul',
-          'Aug',
-          'Sep',
-          'Oct',
-          'Nov',
-          'Dec'
-        ],
+        categories: last_12_months,
         crosshair: true
       },
       yAxis: {

app/views/historical_trends/purchases/index.html.erb

@@ -8,23 +8,10 @@
         text: @title
       },
       subtitle: {
-        text: "Source: humanessentials.app"
+        text: "Cached Data, may be up to 24 hours old"
       },
       xAxis: {
-        categories: [
-          'Jan',
-          'Feb',
-          'Mar',
-          'Apr',
-          'May',
-          'Jun',
-          'Jul',
-          'Aug',
-          'Sep',
-          'Oct',
-          'Nov',
-          'Dec'
-        ],
+        categories: last_12_months,
         crosshair: true
       },
       yAxis: {

app/views/shared/_highcharts.html.erb

@@ -1,7 +1,7 @@
 <div data-controller="highchart" data-highchart-config-value="<%= config %>">
   <div data-highchart-target="chart"></div>
-  <div class='flex flex-row justify-center w-full space-x-2 py-3'>
-    <button type="button" class="inline-flex items-center rounded border border-transparent bg-indigo-600 px-2.5 py-1.5 text-xs font-medium text-white shadow-sm hover:bg-indigo-700 focus:outline-none focus:ring-2 focus:ring-indigo-500 focus:ring-offset-2" data-action="click->highchart#selectAll">Select All</button>
-    <button type="button" class="inline-flex items-center rounded border border-transparent bg-gray-600 px-2.5 py-1.5 text-xs font-medium text-white shadow-sm hover:bg-indigo-700 focus:outline-none focus:ring-2 focus:ring-indigo-500 focus:ring-offset-2" data-action="click->highchart#deselectAll">Deselect All</button>
+  <div>
+    <button type="button" class="btn btn-sm btn-secondary" data-action="click->highchart#selectAll">Select All</button>
+    <button type="button" class="btn btn-sm btn-info" data-action="click->highchart#deselectAll">Deselect All</button>
   </div>
 </div>

config/environments/production.rb

@@ -62,7 +62,7 @@
   config.log_tags = [:request_id]
 
   # Use a different cache store in production.
-  # config.cache_store = :mem_cache_store
+  config.cache_store = :redis_cache_store, { url: ENV['REDIS_URL'] }
 
   # Use a real queuing backend for Active Job (and separate queues per environment)
   # config.active_job.queue_adapter     = :resque

lib/tasks/cache_historical_data.rake

@@ -0,0 +1,16 @@
+desc "This task is run by a scheduling tool nightly to cache the processor intensive queries"
+task :cache_historical_data => :environment do
+  puts "Caching historical data"
+  DATA_TYPES = ['Distribution', 'Purchase', 'Donation']
+
+  orgs = Organization.all
+
+  orgs.each do |org|
+    DATA_TYPES.each do |type|
+      puts "Queuing up #{type} cache data for #{org.name}"
+      HistoricalDataCacheJob.perform_later(org_id: org.id, type: type)
+    end
+  end
+
+  puts "Done!"
+end

spec/helpers/historical_trends_helper_spec.rb

@@ -0,0 +1,23 @@
+require "rspec"
+
+RSpec.describe HistoricalTrendsHelper do
+  describe "#last_12_months" do
+    it "returns the last 12 months starting from July when the current month is June" do
+      allow_any_instance_of(Time).to receive(:month).and_return(6)
+
+      expect(last_12_months).to eq(["Jul", "Aug", "Sep", "Oct", "Nov", "Dec", "Jan", "Feb", "Mar", "Apr", "May", "Jun"])
+    end
+
+    it "returns the last 12 months starting from Feb when the current month is Jan" do
+      allow_any_instance_of(Time).to receive(:month).and_return(1)
+
+      expect(last_12_months).to eq(["Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec", "Jan"])
+    end
+
+    it "returns the last 12 months starting from Jan when the current month is Dec" do
+      allow_any_instance_of(Time).to receive(:month).and_return(12)
+
+      expect(last_12_months).to eq(["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"])
+    end
+  end
+end

spec/jobs/historical_data_cache_job_spec.rb

@@ -0,0 +1,20 @@
+require "rails_helper"
+
+RSpec.describe HistoricalDataCacheJob, type: :job do
+  include ActiveJob::TestHelper
+
+  let(:organization) { create(:organization) }
+  let(:type) { "Donation" }
+  let(:job) { described_class.perform_later(org_id: organization.id, type: type) }
+
+  it "queues the job" do
+    expect { job }.to have_enqueued_job(described_class)
+      .with(org_id: organization.id, type: type)
+      .on_queue("default")
+  end
+
+  it "caches the historical data" do
+    expect(Rails.cache).to receive(:write).with("#{organization.short_name}-historical-#{type}-data", anything)
+    perform_enqueued_jobs { job }
+  end
+end

spec/services/historical_trend_service_spec.rb

@@ -0,0 +1,23 @@
+require "rails_helper"
+
+RSpec.describe HistoricalTrendService, type: :service do
+  let(:organization) { create(:organization) }
+  let(:type) { "Donation" }
+  let(:service) { described_class.new(organization.id, type) }
+
+  describe "#series" do
+    let!(:item1) { create(:item, organization: organization, name: "Item 1") }
+    let!(:item2) { create(:item, organization: organization, name: "Item 2") }
+    let!(:line_item1) { create(:line_item, item: item1, itemizable_type: type, quantity: 10, created_at: 1.month.ago) }
+    let!(:line_item2) { create(:line_item, item: item1, itemizable_type: type, quantity: 20, created_at: 2.months.ago) }
+    let!(:line_item3) { create(:line_item, item: item2, itemizable_type: type, quantity: 30, created_at: 3.months.ago) }
+
+    it "returns an array of items with their monthly data" do
+      expected_result = [
+        {name: "Item 1", data: [0, 0, 0, 0, 0, 0, 0, 0, 0, 20, 10, 0]},
+        {name: "Item 2", data: [0, 0, 0, 0, 0, 0, 0, 0, 30, 0, 0, 0]}
+      ]
+      expect(service.series).to eq(expected_result)
+    end
+  end
+end