Merge pull request #17767 from opf/feature/meeting-index-organization

Better structure upcoming meetings by organising them into named date sections

Author: oliverguenther

app/helpers/pagination_helper.rb

@@ -29,6 +29,10 @@
 require "will_paginate"
 
 module PaginationHelper
+  SHOW_MORE_DEFAULT_LIMIT = 5
+  SHOW_MORE_DEFAULT_INCREMENT = 20
+  SHOW_MORE_MAX_LIMIT = 1000
+
   def pagination_links_full(paginator, options = {})
     return unless paginator.total_entries > 0
 
@@ -151,6 +155,24 @@ def per_page_param(options = params)
     end
   end
 
+  ##
+  # For "Show more" paginated links, we want to load an initial number of items (defaulting to 5)
+  # unless a higher number is provided. These values do not correspond to the per_page_options
+  def show_more_limit_param(options = params, initial_limit: SHOW_MORE_DEFAULT_LIMIT)
+    limit = options[:limit].to_i
+    if limit.zero?
+      initial_limit
+    else
+      [limit, SHOW_MORE_MAX_LIMIT].min
+    end
+  end
+
+  ##
+  # Paginate an AR relation for the "show more" pagination functionality
+  def show_more_pagination(paginator, options = params)
+    paginator.paginate(page: 1, per_page: show_more_limit_param(options))
+  end
+
   class LinkRenderer < ::WillPaginate::ActionView::LinkRenderer
     def to_html
       pagination.inject("") do |html, item|

lib_static/redmine/i18n.rb

@@ -45,6 +45,19 @@ def self.all_languages
           .sort
     end
 
+    def self.start_of_week
+      case Setting.start_of_week.to_i
+      when 1
+        :monday
+      when 7
+        :sunday
+      when 6
+        :saturday
+      else
+        Date.beginning_of_week
+      end
+    end
+
     def self.valid_languages
       all_languages & (Setting.available_languages + [Setting.default_language])
     end

modules/meeting/app/components/meetings/table_component.rb

@@ -44,6 +44,23 @@ def sortable?
       false
     end
 
+    def paginated?
+      false
+    end
+
+    def has_footer?
+      model.is_a?(ActiveRecord::Relation) &&
+        (model.total_entries > model.size)
+    end
+
+    def footer
+      render Meetings::TableFooterComponent.new(
+        upcoming: options[:upcoming],
+        total: model.total_entries,
+        count: model.size
+      )
+    end
+
     def has_actions?
       true
     end

modules/meeting/app/components/meetings/table_footer_component.html.erb

@@ -0,0 +1,56 @@
+<%#-- copyright
+OpenProject is an open source project management software.
+Copyright (C) the OpenProject GmbH
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License version 3.
+
+OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+Copyright (C) 2006-2013 Jean-Philippe Lang
+Copyright (C) 2010-2013 the ChiliProject Team
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+See COPYRIGHT and LICENSE files for more details.
+
+++#%>
+
+<%=
+  component_wrapper do
+    flex_layout(justify_content: :space_between) do |flex|
+      flex.with_column(classes: "ellipsis") do
+        render(Primer::BaseComponent.new(tag: :span, color: :muted)) do
+          concat render(Primer::Beta::Octicon.new(icon: :iterations, mr: 1, ml: 1))
+          concat render(Primer::Beta::Text.new(font_weight: :bold)) { label }
+        end
+      end
+      flex.with_column do
+        render(
+          Primer::Beta::Button.new(
+            scheme: :link,
+            size: :medium,
+            tag: :a,
+            href: url_for(limit: next_count, upcoming:),
+            data: {
+              keep_scroll_position_target: "triggerButton"
+            }
+          )
+        ) do
+          I18n.t(:label_recurring_meeting_show_more)
+        end
+      end
+    end
+  end
+%>

modules/meeting/app/components/recurring_meetings/show_component.rb renamed to modules/meeting/app/components/meetings/table_footer_component.rb

@@ -26,16 +26,31 @@
 # See COPYRIGHT and LICENSE files for more details.
 #++
 
-module RecurringMeetings
-  class ShowComponent < ApplicationComponent
+module Meetings
+  class TableFooterComponent < ApplicationComponent
     include ApplicationHelper
+    include OpTurbo::Streamable
     include OpPrimer::ComponentHelpers
 
-    def initialize(meeting:, project:)
+    attr_reader :total, :count, :upcoming
+
+    def initialize(count:, total:, upcoming:)
       super
 
-      @meeting = meeting
-      @project = project
+      @count = count
+      @total = total
+      @upcoming = upcoming
+    end
+
+    def label
+      I18n.t(:label_meeting_more, count: total - count)
+    end
+
+    def next_count
+      [
+        total,
+        count + PaginationHelper::SHOW_MORE_DEFAULT_INCREMENT
+      ].min
     end
   end
 end

modules/meeting/app/components/recurring_meetings/show_component.html.erb

@@ -58,8 +58,7 @@ class MeetingsController < ApplicationController
   menu_item :new_meeting, only: %i[new create]
 
   def index
-    @query = load_query
-    @meetings = load_meetings(@query)
+    load_meetings
 
     render "index",
            locals: { menu_name: project_or_global_menu }
@@ -353,10 +352,43 @@ def apply_default_filter_if_none_given(query)
     query.where("invited_user_id", "=", [User.current.id.to_s])
   end
 
-  def load_meetings(query)
-    query
-      .results
-      .paginate(page: page_param, per_page: per_page_param)
+  def load_meetings
+    @query = load_query
+
+    # We group meetings into individual groups, but only for upcoming meetings
+    if params[:upcoming] == "false"
+      @meetings = show_more_pagination(@query.results)
+    else
+      @grouped_meetings = group_meetings(@query.results)
+    end
+  end
+
+  def group_meetings(all_meetings) # rubocop:disable Metrics/AbcSize
+    next_week = Time.current.next_occurring(Redmine::I18n.start_of_week)
+    groups = Hash.new { |h, k| h[k] = [] }
+    groups[:later] = show_more_pagination(all_meetings
+                                            .where(start_time: next_week..)
+                                            .order(start_time: :asc))
+
+    all_meetings
+      .where(start_time: ...next_week)
+      .order(start_time: :asc)
+      .each do |meeting|
+      start_date = meeting.start_time.to_date
+
+      group_key =
+        if start_date == Time.zone.today
+          :today
+        elsif start_date == Time.zone.tomorrow
+          :tomorrow
+        else
+          :this_week
+        end
+
+      groups[group_key] << meeting
+    end
+
+    groups
   end
 
   def build_meeting

modules/meeting/app/controllers/meetings_controller.rb

@@ -23,13 +23,15 @@ class RecurringMeetingsController < ApplicationController
   menu_item :meetings
 
   def index
-    @recurring_meetings =
+    results =
       if @project
         RecurringMeeting.visible.where(project_id: @project.id)
       else
         RecurringMeeting.visible
       end
 
+    @recurring_meetings = show_more_pagination(results)
+
     respond_to do |format|
       format.html do
         render :index, locals: { menu_name: project_or_global_menu }
@@ -51,11 +53,12 @@ def show # rubocop:disable Metrics/AbcSize
         params[:count].to_i + 5
       end
 
-    if @direction == "past"
-      @meetings = @recurring_meeting.scheduled_instances(upcoming: false).limit(@count)
-    else
-      @meetings, @planned_meetings = upcoming_meetings(count: @count)
-    end
+
+      if @direction == "past"
+        @meetings = @recurring_meeting.scheduled_instances(upcoming: false).limit(@count)
+      else
+        @meetings, @planned_meetings =upcoming_meetings(count: @count)
+      end
 
     respond_to do |format|
       format.html do

modules/meeting/app/controllers/recurring_meetings_controller.rb

@@ -95,7 +95,7 @@ def involvement_sidebar_menu_items
         menu_item(title: I18n.t(:label_invitations),
                   query_params: { filters: invitation_filter, sort: "start_time" }),
         menu_item(title: I18n.t(:label_attended),
-                  query_params: { filters: attendee_filter }),
+                  query_params: { filters: attendee_filter, upcoming: false }),
         menu_item(title: I18n.t(:label_created_by_me),
                   query_params: { filters: author_filter })
       ]

modules/meeting/app/menus/meetings/menu.rb

@@ -45,9 +45,9 @@ def past?
 
   def where
     if past?
-      '"meetings"."start_time" < NOW()'
+      ['"meetings"."start_time" < ?', Time.current]
     else
-      '"meetings"."start_time" + "meetings"."duration" * interval \'1 hour\' > NOW()'
+      ['"meetings"."start_time" + "meetings"."duration" * interval \'1 hour\' >= ?', Time.current]
     end
   end