Merge pull request #24561 from opf/feature-costs-161

[COSTS-161] Add global restrictions for time entries

Author: klaustopher

app/models/user_working_hours.rb

@@ -32,6 +32,8 @@ class UserWorkingHours < ApplicationRecord
   DAYS = %i[monday tuesday wednesday thursday friday saturday sunday].freeze
   # Maps each day symbol to the Rails I18n date.abbr_day_names index (Sunday = 0)
   DAY_ABBR_INDEX = { monday: 1, tuesday: 2, wednesday: 3, thursday: 4, friday: 5, saturday: 6, sunday: 0 }.freeze
+  # Date#wday shares the Sunday = 0 numbering of DAY_ABBR_INDEX
+  WDAY_TO_DAY = DAY_ABBR_INDEX.invert.freeze
 
   belongs_to :user, inverse_of: :working_hours
 
@@ -79,6 +81,15 @@ def self.current
     end
   end
 
+  def minutes_on(date)
+    public_send(WDAY_TO_DAY.fetch(date.wday))
+  end
+
+  # The capacity for that day, i.e. the working minutes reduced by the availability factor.
+  def effective_minutes_on(date)
+    ((minutes_on(date) * availability_factor) / 100.0).round
+  end
+
   def weekly_working_hours
     DAYS.sum { |day| public_send("#{day}_hours") }
   end

modules/costs/app/components/cost_settings/show_page_header_component.rb

@@ -34,7 +34,7 @@ def breadcrumb_items
       [
         { href: admin_index_path, text: t("label_administration") },
         { href: admin_time_settings_path, text: t(:project_module_costs), skip_for_mobile: true },
-        t(:label_defaults)
+        t(:label_defaults_and_limits)
       ]
     end
 

modules/costs/app/contracts/time_entries/base_contract.rb

@@ -32,6 +32,7 @@ module TimeEntries
   class BaseContract < ::ModelContract
     include AssignableValuesContract
     include AssignableCustomFieldValues
+    include PastMonthRestriction
 
     delegate :entity,
              :project,
@@ -44,6 +45,7 @@ def self.model
     end
 
     validate :validate_hours_are_in_range
+    validate :validate_spent_on_is_working_day
     validate :validate_project_is_set
     validate :validate_entity
     validate :validate_user
@@ -107,7 +109,76 @@ def validate_user
     end
 
     def validate_hours_are_in_range
-      errors.add :hours, :invalid if model.hours&.negative?
+      return errors.add(:hours, :invalid) if model.hours&.negative?
+
+      validate_hours_within_max_per_entry
+      validate_hours_within_max_per_day
+      validate_hours_within_user_working_hours
+    end
+
+    def validate_hours_within_max_per_entry
+      limit = TimeEntry.max_hours_per_entry
+      return if limit.nil? || model.hours.nil? || model.hours <= limit
+
+      errors.add :hours, :max_hours_per_entry_exceeded, limit:
+    end
+
+    def validate_hours_within_max_per_day
+      limit = TimeEntry.max_hours_per_day
+      return if limit.nil? || !day_total_determinable?
+      return if hours_already_logged_on_day + model.hours <= limit
+
+      errors.add :hours, :max_hours_per_day_exceeded, limit:
+    end
+
+    def day_total_determinable?
+      model.hours.present? && model.spent_on.present? && model.user.present?
+    end
+
+    def hours_already_logged_on_day
+      TimeEntry.of_user_and_day(model.user, model.spent_on, excluding: model).sum(:hours)
+    end
+
+    # Compared in whole minutes, since that is the granularity time is logged in and how the
+    # schedule stores its hours. Users without a working hours schedule are not restricted at
+    # all, so that enabling the setting does not block logging on instances that defined none.
+    def validate_hours_within_user_working_hours
+      return unless TimeEntry.limit_to_user_working_hours?
+      return unless day_total_determinable?
+
+      capacity = user_capacity_in_minutes_on(model.spent_on)
+      return if capacity.nil?
+      return if in_minutes(hours_already_logged_on_day + model.hours) <= capacity
+
+      errors.add :hours, :exceeds_user_working_hours, limit: format_hours(capacity / 60.0)
+    end
+
+    def user_capacity_in_minutes_on(date)
+      model.user.working_hours.valid_for_date(date)&.effective_minutes_on(date)
+    end
+
+    def in_minutes(hours)
+      (hours * 60).round
+    end
+
+    def format_hours(hours)
+      ActiveSupport::NumberHelper.number_to_rounded(hours, precision: 2, strip_insignificant_zeros: true)
+    end
+
+    def validate_spent_on_is_working_day
+      return unless TimeEntry.prohibit_logging_on_non_working_days?
+      return if model.spent_on.nil? || model.user.nil?
+      return unless globally_non_working?(model.spent_on) || personally_non_working?(model.spent_on)
+
+      errors.add :spent_on, :not_a_working_day
+    end
+
+    def globally_non_working?(date)
+      WorkPackages::Shared::WorkingDays.new.non_working?(date)
+    end
+
+    def personally_non_working?(date)
+      model.user.non_working_times.overlapping(date..date).exists?
     end
 
     def validate_project_is_set

modules/costs/app/contracts/time_entries/delete_contract.rb

@@ -28,6 +28,8 @@
 
 module TimeEntries
   class DeleteContract < ::DeleteContract
+    include PastMonthRestriction
+
     delete_permission -> {
       edit_all = user.allowed_in_project?(:edit_time_entries, model.project)
       edit_own = if model.entity.is_a?(WorkPackage)

modules/costs/app/contracts/time_entries/past_month_restriction.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+#-- 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.
+#++
+
+module TimeEntries
+  module PastMonthRestriction
+    extend ActiveSupport::Concern
+
+    included do
+      validate :validate_spent_on_not_in_past_month
+    end
+
+    private
+
+    def validate_spent_on_not_in_past_month
+      return unless TimeEntry.prohibit_logging_for_past_months?
+      return unless restricted_spent_on_dates.any? { it < earliest_open_date }
+
+      errors.add :spent_on, :in_past_month, date: I18n.l(earliest_open_date)
+    end
+
+    # The persisted date is checked alongside the assigned one, so that an entry belonging
+    # to a closed month cannot be pulled out of it by moving it into an open one.
+    def restricted_spent_on_dates
+      [model.spent_on, model.spent_on_was].compact
+    end
+
+    # Months are closed as a whole, so the grace period opens every month that the date
+    # it reaches back to belongs to. Without grace this is the start of the current month.
+    def earliest_open_date
+      (Time.zone.today - TimeEntry.past_month_grace_days).beginning_of_month
+    end
+  end
+end

modules/costs/app/models/time_entry.rb

@@ -211,6 +211,40 @@ def must_track_start_and_end_time?
         can_track_start_and_end_time? &&
         Setting.enforce_tracking_start_and_end_times?
     end
+
+    def max_hours_per_entry
+      return nil unless EnterpriseToken.allows_to?(:time_entry_time_restrictions)
+
+      limit = Setting.time_entries_max_hours_per_entry
+      limit if limit.positive?
+    end
+
+    def max_hours_per_day
+      return nil unless EnterpriseToken.allows_to?(:time_entry_time_restrictions)
+
+      limit = Setting.time_entries_max_hours_per_day
+      limit if limit.positive?
+    end
+
+    def prohibit_logging_on_non_working_days?
+      EnterpriseToken.allows_to?(:time_entry_time_restrictions) &&
+        Setting.time_entries_prohibit_logging_on_non_working_days?
+    end
+
+    def limit_to_user_working_hours?
+      EnterpriseToken.allows_to?(:time_entry_time_restrictions) &&
+        Setting.time_entries_limit_to_user_working_hours?
+    end
+
+    def prohibit_logging_for_past_months?
+      EnterpriseToken.allows_to?(:time_entry_time_restrictions) &&
+        Setting.time_entries_prohibit_logging_for_past_months?
+    end
+
+    # Only meaningful while prohibit_logging_for_past_months? applies
+    def past_month_grace_days
+      Setting.time_entries_past_month_grace_days
+    end
   end
 
   private

modules/costs/app/views/admin/time_settings/show.html.erb

@@ -44,16 +44,22 @@ See COPYRIGHT and LICENSE files for more details.
   )
 %>
 
+<%= render(Primer::Beta::Subhead.new) do |subhead|
+      subhead.with_heading(tag: :h3, size: :medium) { I18n.t(:label_start_and_finished) }
+      subhead.with_description { I18n.t(:description_time_settings) }
+    end %>
+
 <%=
-  settings_primer_form_with(scope: :settings, action: :update, method: :patch) do |time_form|
+  settings_primer_form_with(
+    scope: :settings,
+    action: :update,
+    method: :patch,
+    data: {
+      controller: "disable-when-checked",
+      disable_when_checked_reversed_value: true
+    }
+  ) do |time_form|
     render_inline_settings_form(time_form) do |form|
-      form.html_content do
-        render(Primer::Beta::Subhead.new(hide_border: true)) do |subhead|
-          subhead.with_heading(tag: :h3, size: :medium) { I18n.t(:label_mandatory_fields) }
-          subhead.with_description { I18n.t(:description_time_settings) }
-        end
-      end
-
       form.check_box(
         name: :allow_tracking_start_and_end_times,
         caption: I18n.t(:setting_allow_tracking_start_and_end_times_caption)
@@ -64,7 +70,82 @@ See COPYRIGHT and LICENSE files for more details.
         disabled: !EnterpriseToken.allows_to?(:time_entry_time_restrictions)
       )
 
-      form.submit
+      form.submit(name: :submit, label: I18n.t(:button_update_start_finish_times), scheme: :default)
+    end
+  end
+%>
+
+<%= render(Primer::Beta::Subhead.new(mt: 3)) do |subhead|
+      subhead.with_heading(tag: :h3, size: :medium) { I18n.t(:label_time_entry_restrictions) }
+      subhead.with_description { I18n.t(:description_time_entry_restrictions) }
+    end %>
+
+<%=
+  settings_primer_form_with(
+    scope: :settings,
+    action: :update,
+    method: :patch,
+    data: {
+      controller: "disable-when-checked",
+      disable_when_checked_reversed_value: true
+    }
+  ) do |time_form|
+    render_inline_settings_form(time_form) do |form|
+      form.text_field(
+        name: :time_entries_max_hours_per_entry,
+        type: :number,
+        min: 0,
+        input_width: :small,
+        caption: I18n.t(:setting_time_entries_max_hours_per_entry_caption),
+        disabled: !EnterpriseToken.allows_to?(:time_entry_time_restrictions)
+      )
+
+      form.text_field(
+        name: :time_entries_max_hours_per_day,
+        type: :number,
+        min: 0,
+        input_width: :small,
+        caption: I18n.t(:setting_time_entries_max_hours_per_day_caption),
+        disabled: !EnterpriseToken.allows_to?(:time_entry_time_restrictions)
+      )
+
+      form.check_box(
+        name: :time_entries_prohibit_logging_on_non_working_days,
+        caption: I18n.t(:setting_time_entries_prohibit_logging_on_non_working_days_caption),
+        disabled: !EnterpriseToken.allows_to?(:time_entry_time_restrictions)
+      )
+
+      form.check_box(
+        name: :time_entries_limit_to_user_working_hours,
+        caption: I18n.t(:setting_time_entries_limit_to_user_working_hours_caption),
+        disabled: !EnterpriseToken.allows_to?(:time_entry_time_restrictions)
+      )
+
+      form.check_box(
+        name: :time_entries_prohibit_logging_for_past_months,
+        caption: I18n.t(:setting_time_entries_prohibit_logging_for_past_months_caption),
+        disabled: !EnterpriseToken.allows_to?(:time_entry_time_restrictions),
+        data: {
+          target_name: "time_entries_prohibit_logging_for_past_months",
+          disable_when_checked_target: "cause"
+        }
+      )
+
+      form.text_field(
+        name: :time_entries_past_month_grace_days,
+        type: :number,
+        min: 0,
+        input_width: :small,
+        caption: I18n.t(:setting_time_entries_past_month_grace_days_caption),
+        disabled: !EnterpriseToken.allows_to?(:time_entry_time_restrictions) ||
+                  !Setting.time_entries_prohibit_logging_for_past_months?,
+        data: {
+          target_name: "time_entries_prohibit_logging_for_past_months",
+          disable_when_checked_target: "effect"
+        }
+      )
+
+      form.submit(name: :submit, label: I18n.t(:button_update_limits), scheme: :default)
     end
   end
 %>