Merge branch '2105-add-setting-for-first-day-of-the-week' into 'master'

Add setting for first day of the week

Closes #19282 and #2105

See merge request gitlab-org/gitlab-ce!22755

app/assets/javascripts/due_date_select.js

@@ -64,6 +64,7 @@ class DueDateSelect {
           this.saveDueDate(true);
         }
       },
+      firstDay: gon.first_day_of_week,
     });
 
     calendar.setDate(parsePikadayDate($dueDateInput.val()));
@@ -183,6 +184,7 @@ export default class DueDateSelectors {
         onSelect(dateText) {
           $datePicker.val(calendar.toString(dateText));
         },
+        firstDay: gon.first_day_of_week,
       });
 
       calendar.setDate(parsePikadayDate(datePickerVal));

app/assets/javascripts/issuable_form.js

@@ -44,6 +44,7 @@ export default class IssuableForm {
         parse: dateString => parsePikadayDate(dateString),
         toString: date => pikadayToString(date),
         onSelect: dateText => $issuableDueDate.val(calendar.toString(dateText)),
+        firstDay: gon.first_day_of_week,
       });
       calendar.setDate(parsePikadayDate($issuableDueDate.val()));
     }

app/assets/javascripts/member_expiration_date.js

@@ -33,6 +33,7 @@ export default function memberExpirationDate(selector = '.js-access-expiration-d
 
         toggleClearInput.call($input);
       },
+      firstDay: gon.first_day_of_week,
     });
 
     calendar.setDate(parsePikadayDate($input.val()));

app/assets/javascripts/pages/projects/graphs/charts/index.js

@@ -43,10 +43,26 @@ document.addEventListener('DOMContentLoaded', () => {
     ],
   });
 
+  const reorderWeekDays = (weekDays, firstDayOfWeek = 0) => {
+    if (firstDayOfWeek === 0) {
+      return weekDays;
+    }
+
+    return Object.keys(weekDays).reduce((acc, dayName, idx, arr) => {
+      const reorderedDayName = arr[(idx + firstDayOfWeek) % arr.length];
+
+      return {
+        ...acc,
+        [reorderedDayName]: weekDays[reorderedDayName],
+      };
+    }, {});
+  };
+
   const hourData = chartData(projectChartData.hour);
   responsiveChart($('#hour-chart'), hourData);
 
-  const dayData = chartData(projectChartData.weekDays);
+  const weekDays = reorderWeekDays(projectChartData.weekDays, gon.first_day_of_week);
+  const dayData = chartData(weekDays);
   responsiveChart($('#weekday-chart'), dayData);
 
   const monthData = chartData(projectChartData.month);

app/assets/javascripts/pages/users/activity_calendar.js

@@ -159,7 +159,7 @@ export default class ActivityCalendar {
       .append('g')
       .attr('transform', (group, i) => {
         _.each(group, (stamp, a) => {
-          if (a === 0 && stamp.day === 0) {
+          if (a === 0 && stamp.day === this.firstDayOfWeek) {
             const month = stamp.date.getMonth();
             const x = this.daySizeWithSpace * i + 1 + this.daySizeWithSpace;
             const lastMonth = _.last(this.months);
@@ -205,6 +205,14 @@ export default class ActivityCalendar {
         y: 29 + this.dayYPos(5),
       },
     ];
+
+    if (this.firstDayOfWeek === 1) {
+      days.push({
+        text: 'S',
+        y: 29 + this.dayYPos(7),
+      });
+    }
+
     this.svg
       .append('g')
       .selectAll('text')

app/assets/javascripts/pages/users/user_tabs.js

@@ -234,7 +234,7 @@ export default class UserTabs {
       data,
       calendarActivitiesPath,
       utcOffset,
-      0,
+      gon.first_day_of_week,
       monthsAgo,
     );
   }

app/assets/javascripts/vue_shared/components/pikaday.vue

@@ -40,6 +40,7 @@ export default {
       toString: date => pikadayToString(date),
       onSelect: this.selected.bind(this),
       onClose: this.toggled.bind(this),
+      firstDay: gon.first_day_of_week,
     });
 
     this.$el.append(this.calendar.el);

app/controllers/profiles/preferences_controller.rb

@@ -37,6 +37,6 @@ class Profiles::PreferencesController < Profiles::ApplicationController
   end
 
   def preferences_param_names
-    [:color_scheme_id, :layout, :dashboard, :project_view, :theme_id]
+    [:color_scheme_id, :layout, :dashboard, :project_view, :theme_id, :first_day_of_week]
   end
 end

app/helpers/application_settings_helper.rb

@@ -150,6 +150,7 @@ module ApplicationSettingsHelper
       :email_author_in_body,
       :enabled_git_access_protocol,
       :enforce_terms,
+      :first_day_of_week,
       :gitaly_timeout_default,
       :gitaly_timeout_medium,
       :gitaly_timeout_fast,

app/helpers/preferences_helper.rb

@@ -43,6 +43,17 @@ module PreferencesHelper
     ]
   end
 
+  def first_day_of_week_choices
+    [
+      [_('Sunday'), 0],
+      [_('Monday'), 1]
+    ]
+  end
+
+  def first_day_of_week_choices_with_default
+    first_day_of_week_choices.unshift([_('System default (%{default})') % { default: default_first_day_of_week }, nil])
+  end
+
   def user_application_theme
     @user_application_theme ||= Gitlab::Themes.for_user(current_user).css_class
   end
@@ -66,4 +77,8 @@ module PreferencesHelper
   def excluded_dashboard_choices
     ['operations']
   end
+
+  def default_first_day_of_week
+    first_day_of_week_choices.rassoc(Gitlab::CurrentSettings.first_day_of_week).first
+  end
 end

app/models/application_setting.rb

@@ -250,6 +250,7 @@ class ApplicationSetting < ActiveRecord::Base
       dsa_key_restriction: 0,
       ecdsa_key_restriction: 0,
       ed25519_key_restriction: 0,
+      first_day_of_week: 0,
       gitaly_timeout_default: 55,
       gitaly_timeout_fast: 10,
       gitaly_timeout_medium: 30,

app/models/user.rb

@@ -228,6 +228,9 @@ class User < ApplicationRecord
   delegate :path, to: :namespace, allow_nil: true, prefix: true
   delegate :notes_filter_for, to: :user_preference
   delegate :set_notes_filter, to: :user_preference
+  delegate :first_day_of_week, :first_day_of_week=, to: :user_preference
+
+  accepts_nested_attributes_for :user_preference, update_only: true
 
   state_machine :state, initial: :active do
     event :block do

app/views/admin/application_settings/_localization.html.haml

@@ -0,0 +1,11 @@
+= form_for @application_setting, url: admin_application_settings_path(anchor: 'js-localization-settings'), html: { class: 'fieldset-form' } do |f|
+  = form_errors(@application_setting)
+
+  %fieldset
+    .form-group
+      = f.label :first_day_of_week, _('Default first day of the week'), class: 'label-bold'
+      = f.select :first_day_of_week, first_day_of_week_choices, {}, class: 'form-control'
+      .form-text.text-muted
+        = _('Default first day of the week in calendars and date pickers.')
+
+  = f.submit _('Save changes'), class: "btn btn-success"

app/views/admin/application_settings/preferences.html.haml

@@ -56,3 +56,14 @@
       = _('Configure Gitaly timeouts.')
   .settings-content
     = render 'gitaly'
+
+%section.settings.as-localization.no-animate#js-localization-settings{ class: ('expanded' if expanded_by_default?) }
+  .settings-header
+    %h4
+      = _('Localization')
+    %button.btn.btn-default.js-settings-toggle{ type: 'button' }
+      = expanded_by_default? ? _('Collapse') : _('Expand')
+    %p
+      = _('Various localization settings.')
+  .settings-content
+    = render 'localization'

app/views/profiles/preferences/show.html.haml

@@ -60,5 +60,21 @@
       = f.select :project_view, project_view_choices, {}, class: 'form-control'
       .form-text.text-muted
         Choose what content you want to see on a project’s overview page.
+
+  .col-sm-12
+    %hr
+
+  .col-lg-4.profile-settings-sidebar
+    %h4.prepend-top-0
+      = _('Localization')
+    %p
+      = _('Customize language and region related settings.')
+      = succeed '.' do
+        = link_to _('Learn more'), help_page_path('user/profile/preferences', anchor: 'localization'), target: '_blank'
+  .col-lg-8
     .form-group
-      = f.submit 'Save changes', class: 'btn btn-success'
+      = f.label :first_day_of_week, class: 'label-bold' do
+        = _('First day of the week')
+      = f.select :first_day_of_week, first_day_of_week_choices_with_default, {}, class: 'form-control'
+    .form-group
+      = f.submit _('Save changes'), class: 'btn btn-success'

changelogs/unreleased/2105-add-setting-for-first-day-of-the-week.yml

@@ -0,0 +1,5 @@
+---
+title: Add setting for first day of the week
+merge_request: 22755
+author: Fabian Schneider @fabsrc
+type: added

db/migrate/20181027114222_add_first_day_of_week_to_user_preferences.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddFirstDayOfWeekToUserPreferences < ActiveRecord::Migration
+  DOWNTIME = false
+
+  def change
+    add_column :user_preferences, :first_day_of_week, :integer
+  end
+end

db/migrate/20181028120717_add_first_day_of_week_to_application_settings.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class AddFirstDayOfWeekToApplicationSettings < ActiveRecord::Migration
+  include Gitlab::Database::MigrationHelpers
+  disable_ddl_transaction!
+
+  DOWNTIME = false
+
+  def up
+    add_column_with_default(:application_settings, :first_day_of_week, :integer, default: 0)
+  end
+
+  def down
+    remove_column(:application_settings, :first_day_of_week)
+  end
+end

db/schema.rb

@@ -169,6 +169,7 @@ ActiveRecord::Schema.define(version: 20190204115450) do
     t.boolean "protected_ci_variables", default: false, null: false
     t.string "runners_registration_token_encrypted"
     t.integer "local_markdown_version", default: 0, null: false
+    t.integer "first_day_of_week", default: 0, null: false
     t.index ["usage_stats_set_by_user_id"], name: "index_application_settings_on_usage_stats_set_by_user_id", using: :btree
   end
 
@@ -2154,6 +2155,7 @@ ActiveRecord::Schema.define(version: 20190204115450) do
     t.integer "merge_request_notes_filter", limit: 2, default: 0, null: false
     t.datetime_with_timezone "created_at", null: false
     t.datetime_with_timezone "updated_at", null: false
+    t.integer "first_day_of_week"
     t.string "issues_sort"
     t.string "merge_requests_sort"
     t.index ["user_id"], name: "index_user_preferences_on_user_id", unique: true, using: :btree

doc/api/settings.md

@@ -57,6 +57,7 @@ Example response:
    "dsa_key_restriction": 0,
    "ecdsa_key_restriction": 0,
    "ed25519_key_restriction": 0,
+   "first_day_of_week": 0,
    "enforce_terms": true,
    "terms": "Hello world!",
    "performance_bar_allowed_group_id": 42,
@@ -114,6 +115,7 @@ Example response:
   "dsa_key_restriction": 0,
   "ecdsa_key_restriction": 0,
   "ed25519_key_restriction": 0,
+  "first_day_of_week": 0,
   "enforce_terms": true,
   "terms": "Hello world!",
   "performance_bar_allowed_group_id": 42,
@@ -159,6 +161,7 @@ are listed in the descriptions of the relevant settings.
 | `email_author_in_body`                   | boolean          | no                                   | Some email servers do not support overriding the email sender name. Enable this option to include the name of the author of the issue, merge request or comment in the email body instead. |
 | `enabled_git_access_protocol`            | string           | no                                   | Enabled protocols for Git access. Allowed values are: `ssh`, `http`, and `nil` to allow both protocols. |
 | `enforce_terms`                          | boolean          | no                                   | (**If enabled, requires:** `terms`) Enforce application ToS to all users. |
+| `first_day_of_week`            | integer          | no                                   | Start day of the week for calendar views and date pickers. Valid values are `0` (default) for Sunday and `1` for Monday. |
 | `gitaly_timeout_default`                 | integer          | no                                   | Default Gitaly timeout, in seconds. This timeout is not enforced for git fetch/push operations or Sidekiq jobs. Set to `0` to disable timeouts. |
 | `gitaly_timeout_fast`                    | integer          | no                                   | Gitaly fast operation timeout, in seconds. Some Gitaly operations are expected to be fast. If they exceed this threshold, there may be a problem with a storage shard and 'failing fast' can help maintain the stability of the GitLab instance. Set to `0` to disable timeouts. |
 | `gitaly_timeout_medium`                  | integer          | no                                   | Medium Gitaly timeout, in seconds. This should be a value between the Fast and the Default timeout. Set to `0` to disable timeouts. |

doc/user/profile/preferences.md

@@ -87,3 +87,11 @@ You can choose between 3 options:
 - Files and Readme (default)
 - Readme
 - Activity
+
+## Localization
+
+### First day of the week
+
+The first day of the week can be customised for calendar views and date pickers.
+
+You can choose **Sunday** or **Monday** as the first day of the week. If you select **System Default**, the system-wide default setting will be used.

lib/gitlab/gon_helper.rb

@@ -24,6 +24,7 @@ module Gitlab
       gon.emoji_sprites_css_path = ActionController::Base.helpers.stylesheet_path('emoji_sprites')
       gon.test_env               = Rails.env.test?
       gon.suggested_label_colors = LabelsHelper.suggested_colors
+      gon.first_day_of_week      = current_user&.first_day_of_week || Gitlab::CurrentSettings.first_day_of_week
 
       if current_user
         gon.current_user_id = current_user.id

locale/gitlab.pot

@@ -2432,6 +2432,9 @@ msgstr ""
 msgid "Customize how Google Code email addresses and usernames are imported into GitLab. In the next step, you'll be able to select the projects you want to import."
 msgstr ""
 
+msgid "Customize language and region related settings."
+msgstr ""
+
 msgid "Customize your pipeline configuration, view your pipeline status and coverage report."
 msgstr ""
 
@@ -2495,6 +2498,12 @@ msgstr ""
 msgid "Default Branch"
 msgstr ""
 
+msgid "Default first day of the week"
+msgstr ""
+
+msgid "Default first day of the week in calendars and date pickers."
+msgstr ""
+
 msgid "Default: Directly import the Google Code email address or username"
 msgstr ""
 
@@ -3354,6 +3363,9 @@ msgstr ""
 msgid "Finished"
 msgstr ""
 
+msgid "First day of the week"
+msgstr ""
+
 msgid "FirstPushedBy|First"
 msgstr ""
 
@@ -4299,6 +4311,9 @@ msgstr ""
 msgid "Loading…"
 msgstr ""
 
+msgid "Localization"
+msgstr ""
+
 msgid "Lock"
 msgstr ""
 
@@ -4635,6 +4650,9 @@ msgstr ""
 msgid "Modify merge commit"
 msgstr ""
 
+msgid "Monday"
+msgstr ""
+
 msgid "Monitor your errors by integrating with Sentry"
 msgstr ""
 
@@ -6955,6 +6973,9 @@ msgstr ""
 msgid "Suggested change"
 msgstr ""
 
+msgid "Sunday"
+msgstr ""
+
 msgid "Support for custom certificates is disabled. Ask your system's administrator to enable it."
 msgstr ""
 
@@ -6967,6 +6988,9 @@ msgstr ""
 msgid "System Info"
 msgstr ""
 
+msgid "System default (%{default})"
+msgstr ""
+
 msgid "System metrics (Custom)"
 msgstr ""
 
@@ -8006,6 +8030,9 @@ msgstr ""
 msgid "Various email settings."
 msgstr ""
 
+msgid "Various localization settings."
+msgstr ""
+
 msgid "Various settings that affect GitLab performance."
 msgstr ""
 

spec/controllers/profiles/preferences_controller_spec.rb

@@ -42,7 +42,8 @@ describe Profiles::PreferencesController do
         prefs = {
           color_scheme_id: '1',
           dashboard: 'stars',
-          theme_id: '2'
+          theme_id: '2',
+          first_day_of_week: '1'
         }.with_indifferent_access
 
         expect(user).to receive(:assign_attributes).with(ActionController::Parameters.new(prefs).permit!)

spec/helpers/preferences_helper_spec.rb

@@ -35,6 +35,30 @@ describe PreferencesHelper do
     end
   end
 
+  describe '#first_day_of_week_choices' do
+    it 'returns Sunday and Monday as choices' do
+      expect(helper.first_day_of_week_choices).to eq [
+        ['Sunday', 0],
+        ['Monday', 1]
+      ]
+    end
+  end
+
+  describe '#first_day_of_week_choices_with_default' do
+    it 'returns choices including system default' do
+      expect(helper.first_day_of_week_choices_with_default).to eq [
+        ['System default (Sunday)', nil], ['Sunday', 0], ['Monday', 1]
+      ]
+    end
+
+    it 'returns choices including system default set to Monday' do
+      stub_application_setting(first_day_of_week: 1)
+      expect(helper.first_day_of_week_choices_with_default).to eq [
+        ['System default (Monday)', nil], ['Sunday', 0], ['Monday', 1]
+      ]
+    end
+  end
+
   describe '#user_application_theme' do
     context 'with a user' do
       it "returns user's theme's css_class" do