+ <%= t '.label_default_activity' %> + <%= select_tag 'settings[default_activity]', options_from_collection_for_select( [['always_ask', t('.label_always_ask')], ['system', t('.label_system')]] + TimeEntryActivity.system.active.to_a.pluck(:id, :name), :first, :last, Stopwatch.settings['default_activity'] ) %> +
<%= f.select :activity_id, activity_collection_for_select_options(@time_entry), :required => true %>
<%= f.text_field :comments, :size => 100, :maxlength => 1024, :required => Setting.timelog_required_fields.include?('comments') %>
<%= custom_field_tag_with_label :time_entry, value %>
+ <%= submit_tag l(:button_create) %> +
<%= f.select :project_id, project_tree_options_for_select(Project.allowed_to(:log_time).to_a, :selected => @time_entry.project, :include_blank => true), :required => true %>
- <%= f.text_field :issue_id, :size => 6, :required => Setting.timelog_required_fields.include?('issue_id') %> - + <%= l :field_project %> *<%= f.select :project_id, project_tree_options_for_select(Project.allowed_to(:log_time).to_a, :selected => @time_entry.project, :include_blank => true), { no_label: true }, id: 'stopwatch_time_entry_project_id' %> + <%= l :field_issue %> + <% if Setting.timelog_required_fields.include?('issue_id') %> + * + <% end %> + + <%= f.text_field :issue_id, :size => 6, no_label: true, id: 'stopwatch_time_entry_issue_id' %> + <%= link_to_issue(@time_entry.issue) if @time_entry.issue.try(:visible?) %> + <%= l :field_activity %> *<%= f.select :activity_id, activity_collection_for_select_options(@time_entry), { no_label: true }, id: 'stopwatch_time_entry_activity_id' %> @@ -25,19 +28,19 @@ <%= javascript_tag do %> $(document).ready(function(){ - $('#time_entry_project_id').change(function(){ - $('#time_entry_issue_id').val(''); + $('#stopwatch_time_entry_project_id').change(function(){ + $('#stopwatch_time_entry_issue_id').val(''); }); - $('#time_entry_project_id, #time_entry_issue_id').change(function(){ + $('#stopwatch_time_entry_project_id, #stopwatch_time_entry_issue_id').change(function(){ $.ajax({ - url: '<%= escape_javascript(@time_entry.new_record? ? new_time_entry_path(format: 'js') : edit_time_entry_path(@time_entry, format: 'js')) %>', + url: '<%= j update_form_stopwatch_timers_path(time_entry_id: @time_entry.id, format: 'js') %>', type: 'post', data: $(this).closest('form').serialize() }); }); }); - observeAutocompleteField('time_entry_issue_id', + observeAutocompleteField('stopwatch_time_entry_issue_id', function(request, callback) { var url = '<%= j auto_complete_issues_path %>'; var data = { @@ -47,7 +50,7 @@ <% if @time_entry.new_record? && @project %> project_id = '<%= @project.id %>'; <% else %> - project_id = $('#time_entry_project_id').val(); + project_id = $('#stopwatch_time_entry_project_id').val(); <% end %> if(project_id){ data['project_id'] = project_id; @@ -65,8 +68,8 @@ }, { select: function(event, ui) { - $('#time_entry_issue').text(''); - $('#time_entry_issue_id').val(ui.item.value).change(); + $('#stopwatch_time_entry_issue').text(''); + $('#stopwatch_time_entry_issue_id').val(ui.item.value).change(); } } ); diff --git a/app/views/stopwatch_timers/_new.html.erb b/app/views/stopwatch_timers/_new.html.erb index 7fc3853..3e897f6 100644 --- a/app/views/stopwatch_timers/_new.html.erb +++ b/app/views/stopwatch_timers/_new.html.erb @@ -1,10 +1,12 @@ <%= l(:button_log_time) %> - <%= format_date User.current.today %> -<%= render partial: 'entries_list', locals: { entries: @entries } %> +<% if @entries %> + <%= render partial: 'stopwatch_timers/entries_list', locals: { entries: @entries } %> +<% end %> <%= labelled_form_for @time_entry, url: stopwatch_timers_path, method: :post, remote: true do |f| %> <% @time_entry.hours ||= 0 %> - <%= render partial: 'entry_form', locals: { f: f } %> + <%= render partial: 'stopwatch_timers/entry_form', locals: { f: f } %> <%= submit_tag l(:button_create) %> diff --git a/app/views/stopwatch_timers/create.js.erb b/app/views/stopwatch_timers/create.js.erb index d494fc6..0634da9 100644 --- a/app/views/stopwatch_timers/create.js.erb +++ b/app/views/stopwatch_timers/create.js.erb @@ -1,4 +1,5 @@ hideModal(); -window.stopwatch.highlightRunningTimer( +window.stopwatch.timerStarted( <%= raw Stopwatch::Timer.new(User.current).to_json %> ); + diff --git a/app/views/stopwatch_timers/start.js.erb b/app/views/stopwatch_timers/start.js.erb index 8014894..1933b95 100644 --- a/app/views/stopwatch_timers/start.js.erb +++ b/app/views/stopwatch_timers/start.js.erb @@ -7,9 +7,10 @@ <% end %> <% if @started_time_entry %> - window.stopwatch.timerStarted('<%= @started_time_entry.id %>', - '<%= j format_hours @started_time_entry.hours %>'); + window.stopwatch.timerStarted( + <%= raw Stopwatch::Timer.new(User.current).to_json %> + ); <% else %> - window.stopwatch.timerStopped(); + window.stopwatch.timerStopped(); <% end %> diff --git a/app/views/stopwatch_timers/update_form.js.erb b/app/views/stopwatch_timers/update_form.js.erb new file mode 100644 index 0000000..2cb2749 --- /dev/null +++ b/app/views/stopwatch_timers/update_form.js.erb @@ -0,0 +1,5 @@ +$('#stopwatch_time_entry_activity_id').html('<%= escape_javascript options_for_select(activity_collection_for_select_options(@time_entry), @time_entry.activity_id) %>'); +$('#stopwatch_time_entry_issue').html('<%= escape_javascript link_to_issue(@time_entry.issue) if @time_entry.issue.try(:visible?) %>'); +$('#stopwatch_time_entry_project_id').html('<%= escape_javascript project_tree_options_for_select(Project.allowed_to(:log_time).to_a, :selected => @time_entry.project, :include_blank => true) %>'); + + diff --git a/assets/javascripts/stopwatch.js b/assets/javascripts/stopwatch.js index b0304fd..db4c6ed 100644 --- a/assets/javascripts/stopwatch.js +++ b/assets/javascripts/stopwatch.js @@ -1,6 +1,7 @@ window.initStopwatch = function(config){ var currentTimerUrl = config.currentTimerUrl; var hourFormat = config.hourFormat; + var locales = config.locales; var hoursRe = hourFormat.replace(/0+/g, '\\d+').replace(/\./g, '\\.'); var titleRegexp = new RegExp('^(' + hoursRe + ' - )?(.*)$'); @@ -68,12 +69,43 @@ window.initStopwatch = function(config){ highlightRunningTimer: highlightRunningTimer, timerStopped: function(){ highlightRunningTimer(); + // fix up any issue timer start/stop links in the UI + // no running timer -> all links will start a timer + $('a.stopwatch_issue_timer').each(function(){ + var a = $(this); + a.attr('href', a.attr('href').replace(/stop$/, 'start')); + a.text(locales.startTimer); + }); }, - timerStarted: function(entryId, spentTime){ - highlightRunningTimer({ - running: true, - time_entry_id: entryId, - time_spent: spentTime + timerStarted: function(data){ + highlightRunningTimer(data); + // { + // running: true, + // time_entry_id: entryId, + // time_spent: spentTime + // }); + // fix up any issue timer start/stop links in the UI + // all links will start a timer, except the one for the current issue, + // which has to be turned into a stop link. + if(data.running) { + $('a.stopwatch_issue_timer').each(function(){ + var a = $(this); + var href = a.attr('href'); + if(data.issue_id) { + if(a.data('issueId') == data.issue_id) { + a.attr('href', href.replace(/start$/, 'stop')); + a.text(locales.stopTimer); + } else { + a.attr('href', href.replace(/stop$/, 'start')); + a.text(locales.startTimer); + } + } + }); + } + }, + updateStartStopLink: function(id, replacement){ + $(id).replaceWith(function(){ + return $(replacement, { html: $(this).html() }); }); }, setProjectId: function(projectId){ diff --git a/config/locales/en.yml b/config/locales/en.yml index 773d28a..9ffca4d 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -1,6 +1,11 @@ en: label_stopwatch_start: Start tracking label_stopwatch_stop: Stop tracking + stopwatch: + settings: + label_always_ask: 'Always ask' + label_default_activity: 'Default activity for "Start tracking"' + label_system: 'Use system default' stopwatch_timers: entries_list: button_stop: Stop diff --git a/config/routes.rb b/config/routes.rb index 814cb6f..d6f8566 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -1,6 +1,7 @@ resources :stopwatch_timers, only: %i(new create edit update) do collection do get :current + post :update_form end member do put :start @@ -8,3 +9,8 @@ resources :stopwatch_timers, only: %i(new create edit update) do end end +scope 'issues/:issue_id' do + post 'timer/start', to: 'stopwatch_issue_timers#start', as: :start_issue_timer + post 'timer/stop', to: 'stopwatch_issue_timers#stop', as: :stop_issue_timer +end + diff --git a/init.rb b/init.rb index 7b68dd0..fe6b7d5 100644 --- a/init.rb +++ b/init.rb @@ -1,3 +1,4 @@ +require_dependency 'stopwatch' require 'stopwatch/hooks' Redmine::Plugin.register :stopwatch do @@ -5,9 +6,12 @@ Redmine::Plugin.register :stopwatch do author 'Jens Krämer' author_url 'https://jkraemer.net/' description "Start/stop timer and quick access to today's time bookings for Redmine" - version '0.1.0' + version '0.2.0' requires_redmine version_or_higher: '3.4.0' + settings default: { + 'default_activity' => 'always_ask', + }, partial: 'stopwatch/settings' menu :account_menu, :stopwatch, :new_stopwatch_timer_path, @@ -18,7 +22,9 @@ Redmine::Plugin.register :stopwatch do end Rails.configuration.to_prepare do - Stopwatch::UserPatch.apply + Stopwatch::ContextMenusControllerPatch.apply + Stopwatch::IssuesControllerPatch.apply Stopwatch::TimeEntryPatch.apply + Stopwatch::UserPatch.apply end diff --git a/lib/stopwatch.rb b/lib/stopwatch.rb index 0b14ec8..723e8f5 100644 --- a/lib/stopwatch.rb +++ b/lib/stopwatch.rb @@ -1,2 +1,36 @@ +# frozen_string_literal: true + module Stopwatch + def self.settings + Setting.plugin_stopwatch + end + + def self.default_activity + if id = settings['default_activity'].presence + if id.to_s =~ /^\d+$/ + TimeEntryActivity.find_by_id id + else + id + end + end + end + + def self.default_activity_for(time_entry) + default = Stopwatch.default_activity + return nil if default == 'always_ask' + + project = time_entry.project || time_entry.issue&.project + + if project.nil? + activities = TimeEntryActivity.shared.active + else + activities = project.activities + end + + if default == 'system' + activities.detect(&:is_default?) || activities.detect{|a| a.parent&.is_default?} || (activities.one? && activities[0]).presence + else + return activities.detect{ |a| a == default || a.parent == default } + end + end end diff --git a/lib/stopwatch/context_menus_controller_patch.rb b/lib/stopwatch/context_menus_controller_patch.rb new file mode 100644 index 0000000..575e6c7 --- /dev/null +++ b/lib/stopwatch/context_menus_controller_patch.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module Stopwatch + module ContextMenusControllerPatch + module Helper + def watcher_link(objects, user) + link = +'' + if params[:action] == 'issues' and + objects.one? and (issue = objects[0]).is_a?(Issue) and + User.current.allowed_to?(:log_time, issue.project) + t = Stopwatch::IssueTimer.new(issue: issue) + if t.running? + link << IssueLinks.new(issue).stop_timer + else + link << IssueLinks.new(issue).start_timer + end + end + super + content_tag(:li, link.html_safe) + end + end + + def self.apply + ContextMenusController.class_eval do + helper Helper + end + end + end +end + diff --git a/lib/stopwatch/issue_links.rb b/lib/stopwatch/issue_links.rb new file mode 100644 index 0000000..4d6a834 --- /dev/null +++ b/lib/stopwatch/issue_links.rb @@ -0,0 +1,29 @@ +module Stopwatch + class IssueLinks < Struct.new(:issue) + include ActionView::Helpers::UrlHelper + include Rails.application.routes.url_helpers + + + def start_timer + link_to(I18n.t(:label_stopwatch_start), + start_issue_timer_path(issue), + class: 'icon icon-time stopwatch_issue_timer', + data: { issue_id: issue.id }, + remote: true, + method: 'post') + end + + def stop_timer + link_to(I18n.t(:label_stopwatch_stop), + stop_issue_timer_path(issue), + class: 'icon icon-time stopwatch_issue_timer', + data: { issue_id: issue.id }, + remote: true, + method: 'post') + + end + + # to make route helpers happy + def controller; nil end + end +end diff --git a/lib/stopwatch/issue_timer.rb b/lib/stopwatch/issue_timer.rb new file mode 100644 index 0000000..53028e5 --- /dev/null +++ b/lib/stopwatch/issue_timer.rb @@ -0,0 +1,18 @@ +module Stopwatch + class IssueTimer + + def initialize(issue:, user: User.current) + @issue = issue + @user = user + end + + def running? + running_time_entry.present? + end + + def running_time_entry + @running_time_entry ||= @issue.time_entries.find_by_id(@user.running_time_entry_id) + end + + end +end diff --git a/lib/stopwatch/issues_controller_patch.rb b/lib/stopwatch/issues_controller_patch.rb new file mode 100644 index 0000000..1f404ff --- /dev/null +++ b/lib/stopwatch/issues_controller_patch.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +module Stopwatch + module IssuesControllerPatch + module Helper + def watcher_link(issue, user) + link = +'' + if User.current.allowed_to?(:log_time, issue.project) + t = Stopwatch::IssueTimer.new(issue: issue) + if t.running? + link << IssueLinks.new(issue).stop_timer + else + link << IssueLinks.new(issue).start_timer + end + end + link.html_safe + super + end + end + + def self.apply + IssuesController.class_eval do + helper Helper + end + end + end +end diff --git a/lib/stopwatch/start_timer.rb b/lib/stopwatch/start_timer.rb index 852f05f..ad9ad3e 100644 --- a/lib/stopwatch/start_timer.rb +++ b/lib/stopwatch/start_timer.rb @@ -1,7 +1,7 @@ module Stopwatch class StartTimer - Result = ImmutableStruct.new(:success?, :error) + Result = ImmutableStruct.new(:success?, :error, :started) def initialize(time_entry, user: User.current) @time_entry = time_entry @@ -13,7 +13,6 @@ module Stopwatch return Result.new(error: :unauthorized) end - StopTimer.new(user: @user).call @time_entry.hours = 0 if @time_entry.hours.nil? # we want to start tracking time if this is an existing time entry, or a @@ -21,9 +20,13 @@ module Stopwatch # new entries with hours > 0 are just saved as is. start_timer = !@time_entry.new_record? || @time_entry.hours == 0 + # stop currently running timer, but only when there is a chance for us + # to succeed creating the new one. + StopTimer.new(user: @user).call if @time_entry.valid? + if @time_entry.save start_new_timer if start_timer - return Result.new(success: true) + return Result.new(success: true, started: start_timer) else Rails.logger.error("could not save time entry: \n#{@time_entry.errors.inspect}") return Result.new(error: :invalid) diff --git a/lib/stopwatch/timer.rb b/lib/stopwatch/timer.rb index 3147956..ccc64f2 100644 --- a/lib/stopwatch/timer.rb +++ b/lib/stopwatch/timer.rb @@ -65,7 +65,8 @@ module Stopwatch time_entry_id: time_entry_id, time_spent: formatter.format_hours, html_time_spent: formatter.html_hours, - running: running? + running: running?, + issue_id: time_entry&.issue_id }.to_json end diff --git a/lib/stopwatch/user_patch.rb b/lib/stopwatch/user_patch.rb index 63deb30..c7c9ff8 100644 --- a/lib/stopwatch/user_patch.rb +++ b/lib/stopwatch/user_patch.rb @@ -17,5 +17,10 @@ module Stopwatch timer = Stopwatch::Timer.new(self) timer.time_entry_id if timer.running? end + + def todays_time_entry_for(issue) + TimeEntry.order(created_on: :desc). + find_or_initialize_by(user: self, issue: issue, spent_on: today) + end end end diff --git a/test/integration/ticket_timer_test.rb b/test/integration/ticket_timer_test.rb new file mode 100644 index 0000000..9c18d24 --- /dev/null +++ b/test/integration/ticket_timer_test.rb @@ -0,0 +1,118 @@ +require File.expand_path('../../test_helper', __FILE__) + +class TicketTimerTest < Redmine::IntegrationTest + include ActiveJob::TestHelper + + fixtures :projects, + :users, :email_addresses, + :roles, + :members, + :member_roles, + :trackers, + :projects_trackers, + :enabled_modules, + :issue_statuses, + :issues, + :enumerations, + :custom_fields, + :custom_values, + :custom_fields_trackers, + :attachments + + setup do + @issue = Issue.find 1 + @user = User.find_by_login 'jsmith' + end + + test "should create / stop / resume timer for ticket" do + log_user 'jsmith', 'jsmith' + + assert_not_running + + get "/issues/1" + assert_select "div.contextual a", text: /start tracking/i + assert_no_difference ->{TimeEntry.count} do + post "/issues/1/timer/start", xhr: true + assert_response :success + end + assert_not_running + + assert_difference ->{TimeEntry.count} do + post "/stopwatch_timers", xhr: true, params: { + time_entry: { issue_id: 1, activity_id: 9 } + } + assert_response :success + end + + assert_running + + get "/issues/1" + assert_select "div.contextual a", text: /stop tracking/i + assert_no_difference ->{TimeEntry.count} do + post "/issues/1/timer/stop", xhr: true + end + + assert_not_running + + get "/issues/1" + assert_select "div.contextual a", text: /start tracking/i + assert_no_difference ->{TimeEntry.count} do + post "/issues/1/timer/start", xhr: true + end + assert_response :success + + assert_running + + get "/issues/1" + assert_select "div.contextual a", text: /stop tracking/i + assert_no_difference ->{TimeEntry.count} do + post "/issues/1/timer/stop", xhr: true + end + + assert_not_running + end + + test "should ask by default" do + log_user 'jsmith', 'jsmith' + TimeEntry.delete_all + assert_no_difference ->{TimeEntry.count} do + post "/issues/1/timer/start", xhr: true + assert_response 200 + end + end + + test "should use global default actvity" do + log_user 'jsmith', 'jsmith' + TimeEntry.delete_all + with_settings plugin_stopwatch: { 'default_activity' => 'system'} do + post "/issues/1/timer/start", xhr: true + assert_response 201 + end + assert te = TimeEntry.last + assert_equal 1, te.issue_id + assert_equal 10, te.activity_id + end + + test "should use configured default actvity" do + log_user 'jsmith', 'jsmith' + TimeEntry.delete_all + with_settings plugin_stopwatch: { 'default_activity' => '9'} do + post "/issues/1/timer/start", xhr: true + assert_response 201 + end + assert te = TimeEntry.last + assert_equal 1, te.issue_id + assert_equal 9, te.activity_id + end + + + private + + def assert_not_running + refute Stopwatch::Timer.new(User.find(@user.id)).running? + end + + def assert_running + assert Stopwatch::Timer.new(User.find(@user.id)).running? + end +end diff --git a/test/unit/stopwatch_test.rb b/test/unit/stopwatch_test.rb new file mode 100644 index 0000000..78944c3 --- /dev/null +++ b/test/unit/stopwatch_test.rb @@ -0,0 +1,78 @@ +require_relative '../test_helper' + +class StopwatchTest < ActiveSupport::TestCase + fixtures :projects, :enabled_modules, :enumerations + + setup do + @project = Project.find 'ecookbook' + @te = TimeEntry.new project: @project + end + + test "default value for default_activity" do + assert_equal 'always_ask', Stopwatch.default_activity + end + + test "should find default activity" do + with_settings plugin_stopwatch: { 'default_activity' => 9} do + assert_equal 'Design', Stopwatch.default_activity.name + end + with_settings plugin_stopwatch: { 'default_activity' => '11'} do + assert_equal 'QA', Stopwatch.default_activity.name + end + end + + ### 'system' -> ask if there is no sys default / more than one availabale activity + + test "should use system default activity for te" do + with_settings plugin_stopwatch: { 'default_activity' => 'system' } do + assert_equal 'Development', Stopwatch.default_activity_for(@te).name + end + end + + test "should use single active project activity for time entry" do + with_settings plugin_stopwatch: { 'default_activity' => 'system' } do + TimeEntryActivity.create! active: false, project: @project, name: 'Development', parent_id: 10 + TimeEntryActivity.create! active: false, project: @project, name: 'QA', parent_id: 11 + assert_equal 'Design', Stopwatch.default_activity_for(@te).name + end + end + + test "should ask if more than one and no default" do + with_settings plugin_stopwatch: { 'default_activity' => 'system' } do + TimeEntryActivity.update_all is_default: false + assert_nil Stopwatch.default_activity_for(@te) + end + end + + ### always_ask (the default) + + test "should return nil if always ask is set" do + assert_nil Stopwatch.default_activity_for(@te) + + TimeEntryActivity.create! active: false, project: @project, name: 'Development' + assert_nil Stopwatch.default_activity_for(@te) + + TimeEntryActivity.where(name: 'Development').delete_all + assert_nil Stopwatch.default_activity_for(@te) + end + + ### specific activity -> ask only if this is not available in project + + test "should use configured default activity for time entry" do + with_settings plugin_stopwatch: { 'default_activity' => '9' } do + assert_equal 'Design', Stopwatch.default_activity_for(@te).name + end + end + + test "should not have default if unavailable" do + TimeEntryActivity.create! active: false, project: @project, name: 'Design', parent_id: 9 + TimeEntryActivity.create! active: false, project: @project, name: 'Development', parent_id: 11 + assert_equal [10], @project.activities.pluck(:id) + + with_settings plugin_stopwatch: { 'default_activity' => '9'} do + assert_nil Stopwatch.default_activity_for(@te) + end + end + +end + diff --git a/test/unit/user_test.rb b/test/unit/user_test.rb index db86daa..97174e8 100644 --- a/test/unit/user_test.rb +++ b/test/unit/user_test.rb @@ -1,7 +1,7 @@ require_relative '../test_helper' class UserTest < ActiveSupport::TestCase - fixtures :users, :user_preferences + fixtures :users, :user_preferences, :issues setup do @user = User.find 1 @@ -18,4 +18,13 @@ class UserTest < ActiveSupport::TestCase assert @user.timer_running? end + test "should build time entry for issue" do + i = Issue.find 1 + te = @user.todays_time_entry_for i + assert te.new_record? + assert_equal @user, te.user + assert_equal i, te.issue + assert_equal @user.today, te.spent_on + end + end
<%= l :field_project %> *<%= f.select :project_id, project_tree_options_for_select(Project.allowed_to(:log_time).to_a, :selected => @time_entry.project, :include_blank => true), { no_label: true }, id: 'stopwatch_time_entry_project_id' %>
<%= l :field_issue %> + <% if Setting.timelog_required_fields.include?('issue_id') %> + * + <% end %> + + <%= f.text_field :issue_id, :size => 6, no_label: true, id: 'stopwatch_time_entry_issue_id' %> + <%= link_to_issue(@time_entry.issue) if @time_entry.issue.try(:visible?) %>
<%= l :field_activity %> *<%= f.select :activity_id, activity_collection_for_select_options(@time_entry), { no_label: true }, id: 'stopwatch_time_entry_activity_id' %>
<%= submit_tag l(:button_create) %> diff --git a/app/views/stopwatch_timers/create.js.erb b/app/views/stopwatch_timers/create.js.erb index d494fc6..0634da9 100644 --- a/app/views/stopwatch_timers/create.js.erb +++ b/app/views/stopwatch_timers/create.js.erb @@ -1,4 +1,5 @@ hideModal(); -window.stopwatch.highlightRunningTimer( +window.stopwatch.timerStarted( <%= raw Stopwatch::Timer.new(User.current).to_json %> ); + diff --git a/app/views/stopwatch_timers/start.js.erb b/app/views/stopwatch_timers/start.js.erb index 8014894..1933b95 100644 --- a/app/views/stopwatch_timers/start.js.erb +++ b/app/views/stopwatch_timers/start.js.erb @@ -7,9 +7,10 @@ <% end %> <% if @started_time_entry %> - window.stopwatch.timerStarted('<%= @started_time_entry.id %>', - '<%= j format_hours @started_time_entry.hours %>'); + window.stopwatch.timerStarted( + <%= raw Stopwatch::Timer.new(User.current).to_json %> + ); <% else %> - window.stopwatch.timerStopped(); + window.stopwatch.timerStopped(); <% end %> diff --git a/app/views/stopwatch_timers/update_form.js.erb b/app/views/stopwatch_timers/update_form.js.erb new file mode 100644 index 0000000..2cb2749 --- /dev/null +++ b/app/views/stopwatch_timers/update_form.js.erb @@ -0,0 +1,5 @@ +$('#stopwatch_time_entry_activity_id').html('<%= escape_javascript options_for_select(activity_collection_for_select_options(@time_entry), @time_entry.activity_id) %>'); +$('#stopwatch_time_entry_issue').html('<%= escape_javascript link_to_issue(@time_entry.issue) if @time_entry.issue.try(:visible?) %>'); +$('#stopwatch_time_entry_project_id').html('<%= escape_javascript project_tree_options_for_select(Project.allowed_to(:log_time).to_a, :selected => @time_entry.project, :include_blank => true) %>'); + + diff --git a/assets/javascripts/stopwatch.js b/assets/javascripts/stopwatch.js index b0304fd..db4c6ed 100644 --- a/assets/javascripts/stopwatch.js +++ b/assets/javascripts/stopwatch.js @@ -1,6 +1,7 @@ window.initStopwatch = function(config){ var currentTimerUrl = config.currentTimerUrl; var hourFormat = config.hourFormat; + var locales = config.locales; var hoursRe = hourFormat.replace(/0+/g, '\\d+').replace(/\./g, '\\.'); var titleRegexp = new RegExp('^(' + hoursRe + ' - )?(.*)$'); @@ -68,12 +69,43 @@ window.initStopwatch = function(config){ highlightRunningTimer: highlightRunningTimer, timerStopped: function(){ highlightRunningTimer(); + // fix up any issue timer start/stop links in the UI + // no running timer -> all links will start a timer + $('a.stopwatch_issue_timer').each(function(){ + var a = $(this); + a.attr('href', a.attr('href').replace(/stop$/, 'start')); + a.text(locales.startTimer); + }); }, - timerStarted: function(entryId, spentTime){ - highlightRunningTimer({ - running: true, - time_entry_id: entryId, - time_spent: spentTime + timerStarted: function(data){ + highlightRunningTimer(data); + // { + // running: true, + // time_entry_id: entryId, + // time_spent: spentTime + // }); + // fix up any issue timer start/stop links in the UI + // all links will start a timer, except the one for the current issue, + // which has to be turned into a stop link. + if(data.running) { + $('a.stopwatch_issue_timer').each(function(){ + var a = $(this); + var href = a.attr('href'); + if(data.issue_id) { + if(a.data('issueId') == data.issue_id) { + a.attr('href', href.replace(/start$/, 'stop')); + a.text(locales.stopTimer); + } else { + a.attr('href', href.replace(/stop$/, 'start')); + a.text(locales.startTimer); + } + } + }); + } + }, + updateStartStopLink: function(id, replacement){ + $(id).replaceWith(function(){ + return $(replacement, { html: $(this).html() }); }); }, setProjectId: function(projectId){ diff --git a/config/locales/en.yml b/config/locales/en.yml index 773d28a..9ffca4d 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -1,6 +1,11 @@ en: label_stopwatch_start: Start tracking label_stopwatch_stop: Stop tracking + stopwatch: + settings: + label_always_ask: 'Always ask' + label_default_activity: 'Default activity for "Start tracking"' + label_system: 'Use system default' stopwatch_timers: entries_list: button_stop: Stop diff --git a/config/routes.rb b/config/routes.rb index 814cb6f..d6f8566 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -1,6 +1,7 @@ resources :stopwatch_timers, only: %i(new create edit update) do collection do get :current + post :update_form end member do put :start @@ -8,3 +9,8 @@ resources :stopwatch_timers, only: %i(new create edit update) do end end +scope 'issues/:issue_id' do + post 'timer/start', to: 'stopwatch_issue_timers#start', as: :start_issue_timer + post 'timer/stop', to: 'stopwatch_issue_timers#stop', as: :stop_issue_timer +end + diff --git a/init.rb b/init.rb index 7b68dd0..fe6b7d5 100644 --- a/init.rb +++ b/init.rb @@ -1,3 +1,4 @@ +require_dependency 'stopwatch' require 'stopwatch/hooks' Redmine::Plugin.register :stopwatch do @@ -5,9 +6,12 @@ Redmine::Plugin.register :stopwatch do author 'Jens Krämer' author_url 'https://jkraemer.net/' description "Start/stop timer and quick access to today's time bookings for Redmine" - version '0.1.0' + version '0.2.0' requires_redmine version_or_higher: '3.4.0' + settings default: { + 'default_activity' => 'always_ask', + }, partial: 'stopwatch/settings' menu :account_menu, :stopwatch, :new_stopwatch_timer_path, @@ -18,7 +22,9 @@ Redmine::Plugin.register :stopwatch do end Rails.configuration.to_prepare do - Stopwatch::UserPatch.apply + Stopwatch::ContextMenusControllerPatch.apply + Stopwatch::IssuesControllerPatch.apply Stopwatch::TimeEntryPatch.apply + Stopwatch::UserPatch.apply end diff --git a/lib/stopwatch.rb b/lib/stopwatch.rb index 0b14ec8..723e8f5 100644 --- a/lib/stopwatch.rb +++ b/lib/stopwatch.rb @@ -1,2 +1,36 @@ +# frozen_string_literal: true + module Stopwatch + def self.settings + Setting.plugin_stopwatch + end + + def self.default_activity + if id = settings['default_activity'].presence + if id.to_s =~ /^\d+$/ + TimeEntryActivity.find_by_id id + else + id + end + end + end + + def self.default_activity_for(time_entry) + default = Stopwatch.default_activity + return nil if default == 'always_ask' + + project = time_entry.project || time_entry.issue&.project + + if project.nil? + activities = TimeEntryActivity.shared.active + else + activities = project.activities + end + + if default == 'system' + activities.detect(&:is_default?) || activities.detect{|a| a.parent&.is_default?} || (activities.one? && activities[0]).presence + else + return activities.detect{ |a| a == default || a.parent == default } + end + end end diff --git a/lib/stopwatch/context_menus_controller_patch.rb b/lib/stopwatch/context_menus_controller_patch.rb new file mode 100644 index 0000000..575e6c7 --- /dev/null +++ b/lib/stopwatch/context_menus_controller_patch.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module Stopwatch + module ContextMenusControllerPatch + module Helper + def watcher_link(objects, user) + link = +'' + if params[:action] == 'issues' and + objects.one? and (issue = objects[0]).is_a?(Issue) and + User.current.allowed_to?(:log_time, issue.project) + t = Stopwatch::IssueTimer.new(issue: issue) + if t.running? + link << IssueLinks.new(issue).stop_timer + else + link << IssueLinks.new(issue).start_timer + end + end + super + content_tag(:li, link.html_safe) + end + end + + def self.apply + ContextMenusController.class_eval do + helper Helper + end + end + end +end + diff --git a/lib/stopwatch/issue_links.rb b/lib/stopwatch/issue_links.rb new file mode 100644 index 0000000..4d6a834 --- /dev/null +++ b/lib/stopwatch/issue_links.rb @@ -0,0 +1,29 @@ +module Stopwatch + class IssueLinks < Struct.new(:issue) + include ActionView::Helpers::UrlHelper + include Rails.application.routes.url_helpers + + + def start_timer + link_to(I18n.t(:label_stopwatch_start), + start_issue_timer_path(issue), + class: 'icon icon-time stopwatch_issue_timer', + data: { issue_id: issue.id }, + remote: true, + method: 'post') + end + + def stop_timer + link_to(I18n.t(:label_stopwatch_stop), + stop_issue_timer_path(issue), + class: 'icon icon-time stopwatch_issue_timer', + data: { issue_id: issue.id }, + remote: true, + method: 'post') + + end + + # to make route helpers happy + def controller; nil end + end +end diff --git a/lib/stopwatch/issue_timer.rb b/lib/stopwatch/issue_timer.rb new file mode 100644 index 0000000..53028e5 --- /dev/null +++ b/lib/stopwatch/issue_timer.rb @@ -0,0 +1,18 @@ +module Stopwatch + class IssueTimer + + def initialize(issue:, user: User.current) + @issue = issue + @user = user + end + + def running? + running_time_entry.present? + end + + def running_time_entry + @running_time_entry ||= @issue.time_entries.find_by_id(@user.running_time_entry_id) + end + + end +end diff --git a/lib/stopwatch/issues_controller_patch.rb b/lib/stopwatch/issues_controller_patch.rb new file mode 100644 index 0000000..1f404ff --- /dev/null +++ b/lib/stopwatch/issues_controller_patch.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +module Stopwatch + module IssuesControllerPatch + module Helper + def watcher_link(issue, user) + link = +'' + if User.current.allowed_to?(:log_time, issue.project) + t = Stopwatch::IssueTimer.new(issue: issue) + if t.running? + link << IssueLinks.new(issue).stop_timer + else + link << IssueLinks.new(issue).start_timer + end + end + link.html_safe + super + end + end + + def self.apply + IssuesController.class_eval do + helper Helper + end + end + end +end diff --git a/lib/stopwatch/start_timer.rb b/lib/stopwatch/start_timer.rb index 852f05f..ad9ad3e 100644 --- a/lib/stopwatch/start_timer.rb +++ b/lib/stopwatch/start_timer.rb @@ -1,7 +1,7 @@ module Stopwatch class StartTimer - Result = ImmutableStruct.new(:success?, :error) + Result = ImmutableStruct.new(:success?, :error, :started) def initialize(time_entry, user: User.current) @time_entry = time_entry @@ -13,7 +13,6 @@ module Stopwatch return Result.new(error: :unauthorized) end - StopTimer.new(user: @user).call @time_entry.hours = 0 if @time_entry.hours.nil? # we want to start tracking time if this is an existing time entry, or a @@ -21,9 +20,13 @@ module Stopwatch # new entries with hours > 0 are just saved as is. start_timer = !@time_entry.new_record? || @time_entry.hours == 0 + # stop currently running timer, but only when there is a chance for us + # to succeed creating the new one. + StopTimer.new(user: @user).call if @time_entry.valid? + if @time_entry.save start_new_timer if start_timer - return Result.new(success: true) + return Result.new(success: true, started: start_timer) else Rails.logger.error("could not save time entry: \n#{@time_entry.errors.inspect}") return Result.new(error: :invalid) diff --git a/lib/stopwatch/timer.rb b/lib/stopwatch/timer.rb index 3147956..ccc64f2 100644 --- a/lib/stopwatch/timer.rb +++ b/lib/stopwatch/timer.rb @@ -65,7 +65,8 @@ module Stopwatch time_entry_id: time_entry_id, time_spent: formatter.format_hours, html_time_spent: formatter.html_hours, - running: running? + running: running?, + issue_id: time_entry&.issue_id }.to_json end diff --git a/lib/stopwatch/user_patch.rb b/lib/stopwatch/user_patch.rb index 63deb30..c7c9ff8 100644 --- a/lib/stopwatch/user_patch.rb +++ b/lib/stopwatch/user_patch.rb @@ -17,5 +17,10 @@ module Stopwatch timer = Stopwatch::Timer.new(self) timer.time_entry_id if timer.running? end + + def todays_time_entry_for(issue) + TimeEntry.order(created_on: :desc). + find_or_initialize_by(user: self, issue: issue, spent_on: today) + end end end diff --git a/test/integration/ticket_timer_test.rb b/test/integration/ticket_timer_test.rb new file mode 100644 index 0000000..9c18d24 --- /dev/null +++ b/test/integration/ticket_timer_test.rb @@ -0,0 +1,118 @@ +require File.expand_path('../../test_helper', __FILE__) + +class TicketTimerTest < Redmine::IntegrationTest + include ActiveJob::TestHelper + + fixtures :projects, + :users, :email_addresses, + :roles, + :members, + :member_roles, + :trackers, + :projects_trackers, + :enabled_modules, + :issue_statuses, + :issues, + :enumerations, + :custom_fields, + :custom_values, + :custom_fields_trackers, + :attachments + + setup do + @issue = Issue.find 1 + @user = User.find_by_login 'jsmith' + end + + test "should create / stop / resume timer for ticket" do + log_user 'jsmith', 'jsmith' + + assert_not_running + + get "/issues/1" + assert_select "div.contextual a", text: /start tracking/i + assert_no_difference ->{TimeEntry.count} do + post "/issues/1/timer/start", xhr: true + assert_response :success + end + assert_not_running + + assert_difference ->{TimeEntry.count} do + post "/stopwatch_timers", xhr: true, params: { + time_entry: { issue_id: 1, activity_id: 9 } + } + assert_response :success + end + + assert_running + + get "/issues/1" + assert_select "div.contextual a", text: /stop tracking/i + assert_no_difference ->{TimeEntry.count} do + post "/issues/1/timer/stop", xhr: true + end + + assert_not_running + + get "/issues/1" + assert_select "div.contextual a", text: /start tracking/i + assert_no_difference ->{TimeEntry.count} do + post "/issues/1/timer/start", xhr: true + end + assert_response :success + + assert_running + + get "/issues/1" + assert_select "div.contextual a", text: /stop tracking/i + assert_no_difference ->{TimeEntry.count} do + post "/issues/1/timer/stop", xhr: true + end + + assert_not_running + end + + test "should ask by default" do + log_user 'jsmith', 'jsmith' + TimeEntry.delete_all + assert_no_difference ->{TimeEntry.count} do + post "/issues/1/timer/start", xhr: true + assert_response 200 + end + end + + test "should use global default actvity" do + log_user 'jsmith', 'jsmith' + TimeEntry.delete_all + with_settings plugin_stopwatch: { 'default_activity' => 'system'} do + post "/issues/1/timer/start", xhr: true + assert_response 201 + end + assert te = TimeEntry.last + assert_equal 1, te.issue_id + assert_equal 10, te.activity_id + end + + test "should use configured default actvity" do + log_user 'jsmith', 'jsmith' + TimeEntry.delete_all + with_settings plugin_stopwatch: { 'default_activity' => '9'} do + post "/issues/1/timer/start", xhr: true + assert_response 201 + end + assert te = TimeEntry.last + assert_equal 1, te.issue_id + assert_equal 9, te.activity_id + end + + + private + + def assert_not_running + refute Stopwatch::Timer.new(User.find(@user.id)).running? + end + + def assert_running + assert Stopwatch::Timer.new(User.find(@user.id)).running? + end +end diff --git a/test/unit/stopwatch_test.rb b/test/unit/stopwatch_test.rb new file mode 100644 index 0000000..78944c3 --- /dev/null +++ b/test/unit/stopwatch_test.rb @@ -0,0 +1,78 @@ +require_relative '../test_helper' + +class StopwatchTest < ActiveSupport::TestCase + fixtures :projects, :enabled_modules, :enumerations + + setup do + @project = Project.find 'ecookbook' + @te = TimeEntry.new project: @project + end + + test "default value for default_activity" do + assert_equal 'always_ask', Stopwatch.default_activity + end + + test "should find default activity" do + with_settings plugin_stopwatch: { 'default_activity' => 9} do + assert_equal 'Design', Stopwatch.default_activity.name + end + with_settings plugin_stopwatch: { 'default_activity' => '11'} do + assert_equal 'QA', Stopwatch.default_activity.name + end + end + + ### 'system' -> ask if there is no sys default / more than one availabale activity + + test "should use system default activity for te" do + with_settings plugin_stopwatch: { 'default_activity' => 'system' } do + assert_equal 'Development', Stopwatch.default_activity_for(@te).name + end + end + + test "should use single active project activity for time entry" do + with_settings plugin_stopwatch: { 'default_activity' => 'system' } do + TimeEntryActivity.create! active: false, project: @project, name: 'Development', parent_id: 10 + TimeEntryActivity.create! active: false, project: @project, name: 'QA', parent_id: 11 + assert_equal 'Design', Stopwatch.default_activity_for(@te).name + end + end + + test "should ask if more than one and no default" do + with_settings plugin_stopwatch: { 'default_activity' => 'system' } do + TimeEntryActivity.update_all is_default: false + assert_nil Stopwatch.default_activity_for(@te) + end + end + + ### always_ask (the default) + + test "should return nil if always ask is set" do + assert_nil Stopwatch.default_activity_for(@te) + + TimeEntryActivity.create! active: false, project: @project, name: 'Development' + assert_nil Stopwatch.default_activity_for(@te) + + TimeEntryActivity.where(name: 'Development').delete_all + assert_nil Stopwatch.default_activity_for(@te) + end + + ### specific activity -> ask only if this is not available in project + + test "should use configured default activity for time entry" do + with_settings plugin_stopwatch: { 'default_activity' => '9' } do + assert_equal 'Design', Stopwatch.default_activity_for(@te).name + end + end + + test "should not have default if unavailable" do + TimeEntryActivity.create! active: false, project: @project, name: 'Design', parent_id: 9 + TimeEntryActivity.create! active: false, project: @project, name: 'Development', parent_id: 11 + assert_equal [10], @project.activities.pluck(:id) + + with_settings plugin_stopwatch: { 'default_activity' => '9'} do + assert_nil Stopwatch.default_activity_for(@te) + end + end + +end + diff --git a/test/unit/user_test.rb b/test/unit/user_test.rb index db86daa..97174e8 100644 --- a/test/unit/user_test.rb +++ b/test/unit/user_test.rb @@ -1,7 +1,7 @@ require_relative '../test_helper' class UserTest < ActiveSupport::TestCase - fixtures :users, :user_preferences + fixtures :users, :user_preferences, :issues setup do @user = User.find 1 @@ -18,4 +18,13 @@ class UserTest < ActiveSupport::TestCase assert @user.timer_running? end + test "should build time entry for issue" do + i = Issue.find 1 + te = @user.todays_time_entry_for i + assert te.new_record? + assert_equal @user, te.user + assert_equal i, te.issue + assert_equal @user.today, te.spent_on + end + end