Merge remote-tracking branch 'upstream/pull/6046'

Author: tomhughes

app/assets/javascripts/heatmap.js

@@ -1,4 +1,4 @@
-$(function () {
+$(document).on("turbo:frame-load", function () {
   const heatmap = $(".heatmap").removeClass("d-none").addClass("d-grid");
   const weekInfo = getWeekInfo();
   const maxPerDay = heatmap.data("max-per-day");

app/controllers/users/heatmaps_controller.rb

@@ -0,0 +1,44 @@
+module Users
+  class HeatmapsController < ApplicationController
+    layout false
+
+    before_action :authorize_web
+    before_action :set_locale
+    before_action :check_database_readable
+
+    authorize_resource :user
+
+    def show
+      @user = User.find_by(:display_name => params[:user_display_name])
+
+      if @user && (@user.visible? || current_user&.administrator?)
+        @heatmap_data = Rails.cache.fetch("heatmap_data_of_user_#{@user.id}", :expires_at => Time.zone.now.end_of_day) do
+          from = 1.year.ago.beginning_of_day
+          to = Time.zone.now.end_of_day
+
+          mapped = Changeset
+                   .where(:user_id => @user.id)
+                   .where(:created_at => from..to)
+                   .where(:num_changes => 1..)
+                   .group("date_trunc('day', created_at)")
+                   .select("date_trunc('day', created_at) AS date, SUM(num_changes) AS total_changes, MAX(id) AS max_id")
+                   .order("date")
+                   .map do |changeset|
+                     {
+                       :date => changeset.date.to_date,
+                       :total_changes => changeset.total_changes.to_i,
+                       :max_id => changeset.max_id
+                     }
+                   end
+
+          {
+            :count => mapped.sum { |entry| entry[:total_changes] },
+            :data => mapped.index_by { |entry| entry[:date] },
+            :from => from,
+            :to => to
+          }
+        end
+      end
+    end
+  end
+end

app/controllers/users_controller.rb

@@ -23,33 +23,7 @@ def show
 
     if @user && (@user.visible? || current_user&.administrator?)
       @title = @user.display_name
-
-      @heatmap_data = Rails.cache.fetch("heatmap_data_of_user_#{@user.id}", :expires_at => Time.zone.now.end_of_day) do
-        from = 1.year.ago.beginning_of_day
-        to = Time.zone.now.end_of_day
-
-        mapped = Changeset
-                 .where(:user_id => @user.id)
-                 .where(:created_at => from..to)
-                 .where(:num_changes => 1..)
-                 .group("date_trunc('day', created_at)")
-                 .select("date_trunc('day', created_at) AS date, SUM(num_changes) AS total_changes, MAX(id) AS max_id")
-                 .order("date")
-                 .map do |changeset|
-                   {
-                     :date => changeset.date.to_date,
-                     :total_changes => changeset.total_changes.to_i,
-                     :max_id => changeset.max_id
-                   }
-                 end
-
-        {
-          :count => mapped.sum { |entry| entry[:total_changes] },
-          :data => mapped.index_by { |entry| entry[:date] },
-          :from => from,
-          :to => to
-        }
-      end
+      @heatmap_frame = true
     else
       render_unknown_user params[:display_name]
     end

app/views/users/_heatmap.html.erb

@@ -0,0 +1,28 @@
+<%= turbo_frame_tag "#{dom_id(@user)}_heatmap", :data => { :turbo => false } do %>
+  <% if @heatmap_data[:count].positive? %>
+    <h2 class="text-body-secondary fs-5 mt-4"><%= t("users.show.contributions", :count => @heatmap_data[:count]) %></h2>
+    <% cal_data = prepare_heatmap(@heatmap_data[:data], @heatmap_data[:from], @heatmap_data[:to]) %>
+    <div class="row">
+      <div class="col overflow-auto">
+        <div class="heatmap d-none align-items-center mb-1 text-center" data-max-per-day="<%= cal_data[:max_per_day] %>">
+          <!-- Months -->
+          <% cal_data[:months].each do |month| %>
+            <span class="mb-1 mx-n2" data-month="<%= month %>"><%= t("date.abbr_month_names")[((month - 1) % 12) + 1] %></span>
+          <% end %>
+          <!-- Days -->
+          <% (0..6).each do |day| %>
+            <span class="me-1 my-n1" data-weekday="<%= day %>"><%= t("date.abbr_day_names")[day] %></span>
+          <% end %>
+          <!-- Heatmap -->
+          <% cal_data[:days].each do |day| %>
+            <% if day[:total_changes] == 0 %>
+              <span data-date="<%= day[:date] %>"></span>
+            <% else %>
+              <a href="<%= user_history_path @user, :before => day[:max_id] + 1 %>" data-date="<%= day[:date] %>" data-count="<%= day[:total_changes] %>"><span></span></a>
+            <% end %>
+          <% end %>
+        </div>
+      </div>
+    </div>
+  <% end %>
+<% end %>

app/views/users/heatmaps/show.html.erb

@@ -257,9 +257,8 @@
   </div>
 <% end %>
 
-<% if @heatmap_data[:count].positive? %>
-  <h2 class="text-body-secondary fs-5 mt-4"><%= t("users.show.contributions", :count => @heatmap_data[:count]) %></h2>
-  <%= render :partial => "heatmap", :locals => @heatmap_data %>
+<% if @heatmap_frame %>
+  <%= turbo_frame_tag "#{dom_id(@user)}_heatmap", :src => user_heatmap_path(@user), :data => { :turbo => false } %>
 <% end %>
 
 <%= render :partial => "diary_entries/profile_diaries", :locals => { :diary_entries => @user.diary_entries.visible.order(:created_at => :desc).limit(4) } %>

app/views/users/show.html.erb

@@ -293,6 +293,7 @@
   resources :users, :path => "user", :param => :display_name, :only => [:new, :create, :show] do
     resource :role, :controller => "user_roles", :path => "roles/:role", :only => [:create, :destroy]
     scope :module => :users do
+      resource :heatmap, :only => :show
       resources :diary_comments, :only => :index
       resources :changeset_comments, :only => :index
       resource :issued_blocks, :path => "blocks_by", :only => :show

config/routes.rb

@@ -0,0 +1,143 @@
+require "test_helper"
+
+module Users
+  class HeatmapsControllerTest < ActionDispatch::IntegrationTest
+    ##
+    # test all routes which lead to this controller
+    def test_routes
+      assert_routing(
+        { :path => "/user/username/heatmap", :method => :get },
+        { :controller => "users/heatmaps", :action => "show", :user_display_name => "username" }
+      )
+    end
+
+    def test_show_data
+      user = create(:user)
+      # Create two changesets
+      create(:changeset, :user => user, :created_at => 6.months.ago, :num_changes => 10)
+      create(:changeset, :user => user, :created_at => 3.months.ago, :num_changes => 20)
+
+      get user_heatmap_path(user)
+
+      assert_response :success
+      # The data should not be empty
+      heatmap_data = assigns(:heatmap_data)
+      assert_not_nil heatmap_data
+      assert_predicate heatmap_data[:data], :any?
+      # The data should be in the right format
+      heatmap_data[:data].each_value do |entry|
+        assert_equal [:date, :max_id, :total_changes], entry.keys.sort, "Heatmap data entries should have expected keys"
+      end
+      assert_equal 30, heatmap_data[:count]
+    end
+
+    def test_show_data_caching
+      # Enable caching to be able to test
+      Rails.cache.clear
+      @original_cache_store = Rails.cache
+      Rails.cache = ActiveSupport::Cache::MemoryStore.new
+
+      user = create(:user)
+
+      # Create an initial changeset
+      create(:changeset, :user => user, :created_at => 6.months.ago, :num_changes => 15)
+
+      # First request to populate the cache
+      get user_heatmap_path(user)
+      first_response_data = assigns(:heatmap_data)
+      assert_not_nil first_response_data, "Expected heatmap data to be assigned on the first request"
+      assert_equal 1, first_response_data[:data].values.count { |day| day[:total_changes].positive? }, "Expected one entry in the heatmap data"
+
+      # Inspect cache after the first request
+      cached_data = Rails.cache.read("heatmap_data_of_user_#{user.id}")
+      assert_equal first_response_data, cached_data, "Expected the cache to contain the first response data"
+
+      # Add a new changeset to the database
+      create(:changeset, :user => user, :created_at => 3.months.ago, :num_changes => 20)
+
+      # Second request
+      get user_heatmap_path(user)
+      second_response_data = assigns(:heatmap_data)
+
+      # Confirm that the cache is still being used
+      assert_equal first_response_data, second_response_data, "Expected cached data to be returned on the second request"
+
+      # Clear the cache and make a third request to confirm new data is retrieved
+      Rails.cache.clear
+      get user_heatmap_path(user)
+      third_response_data = assigns(:heatmap_data)
+
+      # Ensure the new entry is now included
+      assert_equal 2, third_response_data[:data].values.count { |day| day[:total_changes].positive? }, "Expected two entries in the heatmap data after clearing the cache"
+
+      # Reset caching config to defaults
+      Rails.cache.clear
+      Rails.cache = @original_cache_store
+    end
+
+    def test_show_data_no_changesets
+      user = create(:user)
+
+      get user_heatmap_path(user)
+
+      assert_response :success
+      assert_empty(assigns(:heatmap_data)[:data].values)
+      assert_select ".heatmap", :count => 0
+    end
+
+    def test_show_rendering_of_user_with_no_changesets
+      user_without_changesets = create(:user)
+
+      get user_heatmap_path(user_without_changesets)
+
+      assert_response :success
+      assert_select ".heatmap", 0
+    end
+
+    def test_show_rendering_of_user_with_changesets
+      user = create(:user)
+      changeset39 = create(:changeset, :user => user, :created_at => 4.months.ago.beginning_of_day, :num_changes => 39)
+      _changeset5 = create(:changeset, :user => user, :created_at => 3.months.ago.beginning_of_day, :num_changes => 5)
+      changeset11 = create(:changeset, :user => user, :created_at => 3.months.ago.beginning_of_day, :num_changes => 11)
+
+      get user_heatmap_path(user)
+
+      assert_response :success
+      assert_select ".heatmap a", 2
+
+      history_path = user_history_path(user)
+      assert_select ".heatmap a[data-date='#{4.months.ago.to_date}'][data-count='39'][href='#{history_path}?before=#{changeset39.id + 1}']"
+      assert_select ".heatmap a[data-date='#{3.months.ago.to_date}'][data-count='16'][href='#{history_path}?before=#{changeset11.id + 1}']"
+      assert_select ".heatmap [data-date='#{5.months.ago.to_date}']:not([data-count])"
+    end
+
+    def test_headline_changeset_zero
+      user = create(:user)
+
+      get user_heatmap_path(user)
+
+      assert_response :success
+      assert_select "h2.text-body-secondary.fs-5", :count => 0
+    end
+
+    def test_headline_changeset_singular
+      user = create(:user)
+      create(:changeset, :user => user, :created_at => 4.months.ago.beginning_of_day, :num_changes => 1)
+
+      get user_heatmap_path(user)
+
+      assert_response :success
+      assert_select "h2.text-body-secondary.fs-5", :text => "1 contribution in the last year"
+    end
+
+    def test_headline_changeset_plural
+      user = create(:user)
+      create(:changeset, :user => user, :created_at => 4.months.ago.beginning_of_day, :num_changes => 12)
+
+      get user_heatmap_path(user)
+
+      assert_response :success
+      assert_select "h2.text-body-secondary.fs-5", :text => "12 contributions in the last year"
+    end
+  end
+end