ricky/stopwatch
1
0
Fork 0
mirror of https://github.com/rickbarrette/stopwatch.git synced 2026-04-02 17:51:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: ricky:master
Branches Tags
ricky:master ricky:feature/start-stop-ticket ricky:screenshots
ricky:v1.1 ricky:v1.0
..
compare: ricky:screenshots
Branches Tags
ricky:master ricky:feature/start-stop-ticket ricky:screenshots
ricky:v1.1 ricky:v1.0

1 Commits
master ... screenshot

Author SHA1 Message Date
Jens Kraemer
d27bdd8414 screenshot 2020-07-23 17:03:10 +08:00
42 changed files with 67 additions and 698 deletions
Expand all files Collapse all files

31
.github/workflows/redmine.yml vendored
View File

@@ -1,31 +0,0 @@
name: Test with Redmine
on:
push:
branches:
- master
pull_request:
branches:
- master
jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
redmine:
- '6.0'
- '6.1'
ruby:
- '3.3'
database:
- postgresql
- mysql
steps:
- uses: eXolnet/action-redmine-plugin@v1
with:
plugin_name: stopwatch
redmine_version: ${{ matrix.redmine }}
ruby_version: ${{ matrix.ruby }}
database: ${{ matrix.database }}

2
README.md
View File

@@ -1,4 +1,4 @@
# Stopwatch Plugin for Redmine [![Test with Redmine](https://github.com/jkraemer/stopwatch/actions/workflows/redmine.yml/badge.svg)](https://github.com/jkraemer/stopwatch/actions/workflows/redmine.yml)
# Stopwatch Plugin for Redmine
Minimal plugin that aims to make tracking your time with Redmine much easier.

12
app/controllers/stopwatch_controller.rb
View File

@@ -1,12 +0,0 @@
# base class for stopwatch controllers
class StopwatchController < ApplicationController
helper :timelog, :custom_fields
before_action :require_login
private
def authorize_edit_time
@time_entry.editable_by?(User.current) or deny_access
end
end

48
app/controllers/stopwatch_issue_timers_controller.rb
View File

@@ -1,48 +0,0 @@
class StopwatchIssueTimersController < StopwatchController
before_action :find_issue
before_action :authorize_log_time
def start
t = Stopwatch::IssueTimer.new(issue: @issue)
if t.running?
head 422; return
end
time_entry = User.current.todays_time_entry_for(@issue)
if time_entry.new_record?
sys_default_activity = time_entry.activity
time_entry.activity = Stopwatch.default_activity_for time_entry
end
r = Stopwatch::StartTimer.new(time_entry).call
if r.success?
@started_time_entry = time_entry
render status: :created
else
@time_entry = time_entry
# in case the setting is 'always ask', still preset the form to the global default
@time_entry.activity ||= sys_default_activity
@time_entry.errors.clear
render status: :ok
end
end
def stop
r = Stopwatch::StopTimer.new.call
unless r.success?
logger.error "unable to stop timer"
head 422; return
end
end
private
def authorize_log_time
User.current.allowed_to?(:log_time, @project) or deny_access
end
def find_issue
@issue = Issue.find params[:issue_id]
@project = @issue.project
end
end

24
app/controllers/stopwatch_timers_controller.rb
View File

@@ -8,8 +8,10 @@
# - same for project, unless we are in a project context
# - focus first field that needs an action, depending on above
#
class StopwatchTimersController < StopwatchController
class StopwatchTimersController < ApplicationController
helper :timelog
before_action :require_login
before_action :find_optional_data, only: %i(new create)
before_action :authorize_log_time, only: %i(new create start stop current)
before_action :find_time_entry, only: %i(edit update start stop)
@@ -60,9 +62,7 @@ class StopwatchTimersController < StopwatchController
def stop
r = Stopwatch::StopTimer.new.call
if r.success?
@stopped_time_entry = @time_entry
else
unless r.success?
logger.error "unable to stop timer"
end
new unless params[:context]
@@ -73,17 +73,6 @@ class StopwatchTimersController < StopwatchController
render json: @timer.to_json
end
def update_form
if id = params[:time_entry_id].presence
@time_entry = TimeEntry.visible.find id
else
@time_entry = TimeEntry.new
end
@time_entry.safe_attributes = params[:time_entry]
rescue ActiveRecord::RecordNotFound
head 404
end
private
def find_timer
@@ -93,12 +82,11 @@ class StopwatchTimersController < StopwatchController
def find_time_entry
@time_entry = time_entries.find params[:id]
end
def load_todays_entries
@entries = time_entries.where(spent_on: User.current.today).or(
time_entries.where(id: User.current.running_time_entry_id)
).order(created_on: :asc)
@entries = time_entries.where(spent_on: User.current.today).order(created_on: :asc)
end
def time_entries

9
app/views/stopwatch/_settings.html.erb
View File

@@ -1,9 +0,0 @@
<p>
<label for="settings_default_activity"><%= t '.label_default_activity' %> </label>
<%= 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'] ) %>
</p>
<p>
<label for="settings_highlighted_links"><%= t '.label_highlighted_links' %> </label>
<%= check_box_tag 'settings[highlighted_links]', 1, Setting.plugin_stopwatch[:highlighted_links] %>
</p>

9
app/views/stopwatch/hooks/_layouts_base_body_bottom.html.erb
View File

@@ -1,16 +1,11 @@
<%= javascript_tag do %>
window.stopwatch = window.initStopwatch({
currentTimerUrl: '<%= j current_stopwatch_timers_url %>',
hourFormat: '<%= j format_hours 0.0 %>',
locales: {
startTimer: '<%= j l :label_stopwatch_start %>',
stopTimer: '<%= j l :label_stopwatch_stop %>'
},
hourFormat: '<%= j format_hours 0.0 %>'
});
<% if User.current.logged? %>
window.stopwatch.highlightRunningTimer(
<%= raw Stopwatch::Timer.new(User.current).to_json %>
);
window.stopwatch.setProjectId('<%= j @project&.id.to_s %>');
)
<% end %>
<% end %>

1
app/views/stopwatch/hooks/_layouts_base_html_head.html.erb
View File

@@ -1,3 +1,2 @@
<%= javascript_include_tag "stopwatch", plugin: "stopwatch" %>
<%= stylesheet_link_tag "stopwatch", plugin: "stopwatch" %>
<%= stylesheet_link_tag "highlighted_links", plugin: "stopwatch" if Stopwatch.highlighted_links %>

4
app/views/stopwatch/hooks/_time_entries_context_menu_start.html.erb
View File

@@ -2,9 +2,9 @@
<% time_entry = @time_entries.first %>
<li>
<% if User.current.is_running_timer? time_entry %>
<%= context_menu_link sprite_icon(:time, l(:label_stopwatch_stop)), stop_stopwatch_timer_path(time_entry, context: '1'), class: 'icon', remote: true, method: :put %>
<%= context_menu_link l(:label_stopwatch_stop), stop_stopwatch_timer_path(time_entry, context: '1'), class: 'icon icon-time', remote: true, method: :put %>
<% else %>
<%= context_menu_link sprite_icon(:time, l(:label_stopwatch_start)), start_stopwatch_timer_path(time_entry, context: '1'), class: 'icon', remote: true, method: :put %>
<%= context_menu_link l(:label_stopwatch_start), start_stopwatch_timer_path(time_entry, context: '1'), class: 'icon icon-time', remote: true, method: :put %>
<% end %>
</li>
<% end %>

20
app/views/stopwatch_issue_timers/_new.html.erb
View File

@@ -1,20 +0,0 @@
<h3 class="title"><%= l(:button_log_time) %> - <%= format_date User.current.today %> - <%= "#{@issue.tracker} #{@issue.id}: #{truncate @issue.subject}" %></h3>
<%= labelled_form_for @time_entry, url: stopwatch_timers_path, method: :post, remote: true do |f| %>
<% @time_entry.hours ||= 0 %>
<%= f.hidden_field :issue_id, value: @issue.id %>
<fieldset class="box tabular">
<legend><%= t 'stopwatch_timers.entry_form.legend_new' %></legend>
<p><%= f.select :activity_id, activity_collection_for_select_options(@time_entry), :required => true %></p>
<p><%= f.text_field :comments, :size => 100, :maxlength => 1024, :required => Setting.timelog_required_fields.include?('comments') %></p>
<% @time_entry.custom_field_values.each do |value| %>
<p><%= custom_field_tag_with_label :time_entry, value %></p>
<% end %>
</fieldset>
<p class="buttons">
<%= submit_tag l(:button_create) %>
</p>
<% end %>

9
app/views/stopwatch_issue_timers/start.js.erb
View File

@@ -1,9 +0,0 @@
<% if @started_time_entry %>
contextMenuHide();
window.stopwatch.timerStarted(
<%= raw Stopwatch::Timer.new(User.current).to_json %>
);
<% else %>
$('#ajax-modal').html('<%= j render partial: 'new' %>');
showModal('ajax-modal', '700px');
<% end %>

6
app/views/stopwatch_issue_timers/stop.js.erb
View File

@@ -1,6 +0,0 @@
contextMenuHide();
window.stopwatch.updateStartStopLink(
'#stopwatch_stop_timer_<%= @issue.id %>',
'<%= j Stopwatch::IssueLinks.new(@issue, self).start_timer %>'
);
window.stopwatch.timerStopped();

6
app/views/stopwatch_timers/_entries_list.html.erb
View File

@@ -17,11 +17,11 @@
<td class="hours"><%= html_hours(format_hours(entry.hours)) %></td>
<td class="buttons">
<% if running %>
<%= link_to sprite_icon(:time, t(:label_stopwatch_stop)), stop_stopwatch_timer_path(entry), remote: true, class: "icon-only", method: :put %>
<%= link_to t(:label_stopwatch_stop), stop_stopwatch_timer_path(entry), remote: true, class: "icon-only icon-time", method: :put %>
<% else %>
<%= link_to sprite_icon(:time, t(:label_stopwatch_start)), start_stopwatch_timer_path(entry), remote: true, class: "icon-only", method: :put %>
<%= link_to t(:label_stopwatch_start), start_stopwatch_timer_path(entry), remote: true, class: "icon-only icon-time", method: :put %>
<% end %>
<%= link_to sprite_icon(:edit, l(:button_edit)), edit_stopwatch_timer_path(entry), remote: true, class: "icon-only" if entry.editable_by? User.current %>
<%= link_to l(:button_edit), edit_stopwatch_timer_path(entry), remote: true, class: "icon-only icon-edit" if entry.editable_by? User.current %>
</td>
</tr>
<% end -%>

31
app/views/stopwatch_timers/_entry_form.html.erb
View File

@@ -2,19 +2,16 @@
<fieldset class="box tabular">
<legend><%= t @time_entry.new_record? ? '.legend_new' : '.legend_edit' %></legend>
<p><%= f.select :activity_id, activity_collection_for_select_options(@time_entry), :required => true %></p>
<p><label for="stopwatch_time_entry_project_id"><%= l :field_project %><span class="required"> *</span></label><%= 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' %></p>
<p><label for="stopwatch_time_entry_issue_id"><%= l :field_issue %>
<% if Setting.timelog_required_fields.include?('issue_id') %>
<span class="required"> *</span>
<% end %>
</label>
<%= f.text_field :issue_id, :size => 6, no_label: true, id: 'stopwatch_time_entry_issue_id' %>
<span id="stopwatch_time_entry_issue">
<p><%= 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 %></p>
<p>
<%= f.text_field :issue_id, :size => 6, :required => Setting.timelog_required_fields.include?('issue_id') %>
<span id="time_entry_issue">
<%= link_to_issue(@time_entry.issue) if @time_entry.issue.try(:visible?) %>
</span>
</p>
<p><label for="stopwatch_time_entry_activity_id"><%= l :field_activity %><span class="required"> *</span></label><%= f.select :activity_id, activity_collection_for_select_options(@time_entry), { no_label: true }, id: 'stopwatch_time_entry_activity_id' %></p>
<!--
<p><%= f.date_field :spent_on, :size => 10, :required => true %><%= calendar_for('time_entry_spent_on') %></p>
-->
@@ -28,19 +25,19 @@
<%= javascript_tag do %>
$(document).ready(function(){
$('#stopwatch_time_entry_project_id').change(function(){
$('#stopwatch_time_entry_issue_id').val('');
$('#time_entry_project_id').change(function(){
$('#time_entry_issue_id').val('');
});
$('#stopwatch_time_entry_project_id, #stopwatch_time_entry_issue_id').change(function(){
$('#time_entry_project_id, #time_entry_issue_id').change(function(){
$.ajax({
url: '<%= j update_form_stopwatch_timers_path(time_entry_id: @time_entry.id, format: 'js') %>',
url: '<%= escape_javascript(@time_entry.new_record? ? new_time_entry_path(format: 'js') : edit_time_entry_path(@time_entry, format: 'js')) %>',
type: 'post',
data: $(this).closest('form').serialize()
});
});
});
observeAutocompleteField('stopwatch_time_entry_issue_id',
observeAutocompleteField('time_entry_issue_id',
function(request, callback) {
var url = '<%= j auto_complete_issues_path %>';
var data = {
@@ -50,7 +47,7 @@
<% if @time_entry.new_record? && @project %>
project_id = '<%= @project.id %>';
<% else %>
project_id = $('#stopwatch_time_entry_project_id').val();
project_id = $('#time_entry_project_id').val();
<% end %>
if(project_id){
data['project_id'] = project_id;
@@ -68,8 +65,8 @@
},
{
select: function(event, ui) {
$('#stopwatch_time_entry_issue').text('');
$('#stopwatch_time_entry_issue_id').val(ui.item.value).change();
$('#time_entry_issue').text('');
$('#time_entry_issue_id').val(ui.item.value).change();
}
}
);

6
app/views/stopwatch_timers/_new.html.erb
View File

@@ -1,12 +1,10 @@
<h3 class="title"><%= l(:button_log_time) %> - <%= format_date User.current.today %></h3>
<% if @entries %>
<%= render partial: 'stopwatch_timers/entries_list', locals: { entries: @entries } %>
<% end %>
<%= render partial: 'entries_list', locals: { entries: @entries } %>
<%= labelled_form_for @time_entry, url: stopwatch_timers_path, method: :post, remote: true do |f| %>
<% @time_entry.hours ||= 0 %>
<%= render partial: 'stopwatch_timers/entry_form', locals: { f: f } %>
<%= render partial: 'entry_form', locals: { f: f } %>
<p class="buttons">
<%= submit_tag l(:button_create) %>

3
app/views/stopwatch_timers/create.js.erb
View File

@@ -1,5 +1,4 @@
hideModal();
window.stopwatch.timerStarted(
window.stopwatch.highlightRunningTimer(
<%= raw Stopwatch::Timer.new(User.current).to_json %>
);

7
app/views/stopwatch_timers/start.js.erb
View File

@@ -7,10 +7,9 @@
<% end %>
<% if @started_time_entry %>
window.stopwatch.timerStarted(
<%= raw Stopwatch::Timer.new(User.current).to_json %>
);
window.stopwatch.timerStarted('<%= @started_time_entry.id %>',
'<%= j format_hours @started_time_entry.hours %>');
<% else %>
window.stopwatch.timerStopped();
window.stopwatch.timerStopped();
<% end %>

5
app/views/stopwatch_timers/update_form.js.erb
View File

@@ -1,5 +0,0 @@
$('#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) %>');

48
assets/javascripts/stopwatch.js
View File

@@ -1,7 +1,6 @@
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 + ' - )?(.*)$');
@@ -69,48 +68,13 @@ 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.find('span').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.find('span').text(locales.stopTimer);
} else {
a.attr('href', href.replace(/stop$/, 'start'));
a.find('span').text(locales.startTimer);
}
}
});
}
},
updateStartStopLink: function(id, replacement){
$(id).replaceWith(function(){
return $(replacement, { html: $(this).html() });
});
},
setProjectId: function(projectId){
var a = $('a#stopwatch-menu');
a.attr('href', a.attr('href').replace(/\/new.*$/, '/new?project_id='+projectId));
}
});
};

22
assets/stylesheets/highlighted_links.css
View File

@@ -1,22 +0,0 @@
a.stopwatch_issue_timer[href*="stop"] {
color: red;
}
a.stopwatch_issue_timer[href*="start"] {
color: limegreen;
}
/* Mobile only */
@media (max-width: 899px) {
a.stopwatch_issue_timer[href*="stop"] {
color: red;
background-color: #ffe5e5;
border: 1px solid red;
}
a.stopwatch_issue_timer[href*="start"] {
color: limegreen;
background-color: #eaffea;
border: 1px solid limegreen;
}
}

2
assets/stylesheets/stopwatch.css
View File

@@ -1,3 +1,3 @@
tr.time-entry.running td.hours {
color: red;
}
}

6
config/locales/en.yml
View File

@@ -1,12 +1,6 @@
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_highlighted_links: "Color-code Start/Stop"
label_system: 'Use system default'
stopwatch_timers:
entries_list:
button_stop: Stop

6
config/routes.rb
View File

@@ -1,7 +1,6 @@
resources :stopwatch_timers, only: %i(new create edit update) do
collection do
get :current
post :update_form
end
member do
put :start
@@ -9,8 +8,3 @@ 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

BIN
img/screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 59 KiB

14
init.rb
View File

@@ -1,14 +1,13 @@
require 'stopwatch/hooks'
Redmine::Plugin.register :stopwatch do
name 'Redmine Stopwatch Plugin'
author 'Jens Krämer'
author_url 'https://jkraemer.net/'
description "Start/stop timer and quick access to today's time bookings for Redmine"
version '1.1.0'
version '0.1.0'
requires_redmine version_or_higher: '6.0.0'
settings default: {
'default_activity' => 'always_ask',
}, partial: 'stopwatch/settings'
requires_redmine version_or_higher: '3.4.0'
menu :account_menu, :stopwatch,
:new_stopwatch_timer_path,
@@ -18,4 +17,7 @@ Redmine::Plugin.register :stopwatch do
if: ->(*_){ User.current.logged? and User.current.allowed_to?(:log_time, nil, global: true) }
end
Stopwatch.setup
Rails.configuration.to_prepare do
Stopwatch::UserPatch.apply
end

46
lib/stopwatch.rb
View File

@@ -1,48 +1,2 @@
# frozen_string_literal: true
module Stopwatch
def self.setup
Stopwatch::ContextMenusControllerPatch.apply
Stopwatch::IssuesControllerPatch.apply
::TimeEntry.prepend Stopwatch::TimeEntryPatch
::User.prepend Stopwatch::UserPatch
Stopwatch::Hooks # just load it
end
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
def self.highlighted_links
settings[:highlighted_links]
end
end

28
lib/stopwatch/context_menus_controller_patch.rb
View File

@@ -1,28 +0,0 @@
# 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, self).stop_timer
else
link << IssueLinks.new(issue, self).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

28
lib/stopwatch/issue_links.rb
View File

@@ -1,28 +0,0 @@
module Stopwatch
class IssueLinks < Struct.new(:issue, :context)
def start_timer
context.link_to(
context.sprite_icon(:time, I18n.t(:label_stopwatch_start)),
context.start_issue_timer_path(issue),
class: 'icon stopwatch_issue_timer',
data: { issue_id: issue.id },
remote: true,
method: 'post'
)
end
def stop_timer
context.link_to(
context.sprite_icon(:time, I18n.t(:label_stopwatch_stop)),
context.stop_issue_timer_path(issue),
class: 'icon stopwatch_issue_timer',
data: { issue_id: issue.id },
remote: true,
method: 'post'
)
end
# to make route helpers happy
def controller; nil end
end
end

18
lib/stopwatch/issue_timer.rb
View File

@@ -1,18 +0,0 @@
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

26
lib/stopwatch/issues_controller_patch.rb
View File

@@ -1,26 +0,0 @@
# 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, self).stop_timer
else
link << IssueLinks.new(issue, self).start_timer
end
end
link.html_safe + super
end
end
def self.apply
IssuesController.class_eval do
helper Helper
end
end
end
end

9
lib/stopwatch/start_timer.rb
View File

@@ -1,7 +1,7 @@
module Stopwatch
class StartTimer
Result = ImmutableStruct.new(:success?, :error, :started)
Result = ImmutableStruct.new(:success?, :error)
def initialize(time_entry, user: User.current)
@time_entry = time_entry
@@ -13,6 +13,7 @@ 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
@@ -20,13 +21,9 @@ 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, started: start_timer)
return Result.new(success: true)
else
Rails.logger.error("could not save time entry: \n#{@time_entry.errors.inspect}")
return Result.new(error: :invalid)

14
lib/stopwatch/time_entry_patch.rb
View File

@@ -1,14 +0,0 @@
module Stopwatch
module TimeEntryPatch
extend ActiveSupport::Concern
prepended do
before_destroy :stop_timer
end
def stop_timer
t = Stopwatch::Timer.new(user)
t.update(stop: true) if t.running?
end
end
end

5
lib/stopwatch/timer.rb
View File

@@ -45,7 +45,7 @@ module Stopwatch
# timestamp to either nil (stop: true) or current time.
def update(stop: false)
if hours = runtime_hours and entry = self.time_entry
time_entry.update_column :hours, entry.read_attribute(:hours) + hours
time_entry.update_column :hours, entry.hours + hours
end
data[:started_at] = stop || !running? ? nil : Time.now.to_i
save
@@ -65,8 +65,7 @@ module Stopwatch
time_entry_id: time_entry_id,
time_spent: formatter.format_hours,
html_time_spent: formatter.html_hours,
running: running?,
issue_id: time_entry&.issue_id
running: running?
}.to_json
end

16
lib/stopwatch/user_patch.rb
View File

@@ -1,24 +1,16 @@
module Stopwatch
module UserPatch
extend ActiveSupport::Concern
def self.apply
User.prepend self unless User < self
end
def timer_running?
Stopwatch::Timer.new(self).running?
end
def is_running_timer?(time_entry)
id = running_time_entry_id
id.present? and time_entry.id == id
end
def running_time_entry_id
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)
timer.running? and timer.time_entry_id == time_entry.id
end
end
end

118
test/integration/ticket_timer_test.rb
View File

@@ -1,118 +0,0 @@
require File.expand_path('../test_helper', __dir__)
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_response :success
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 :ok
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 :created
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 :created
end
assert te = TimeEntry.last
assert_equal 1, te.issue_id
assert_equal 9, te.activity_id
end
private
def assert_not_running
assert_not Stopwatch::Timer.new(User.find(@user.id)).running?
end
def assert_running
assert Stopwatch::Timer.new(User.find(@user.id)).running?
end
end

3
test/test_helper.rb
View File

@@ -1,2 +1,5 @@
require File.expand_path(File.dirname(__FILE__) + '/../../../test/test_helper')
class ActiveSupport::TestCase
end

4
test/unit/start_timer_test.rb
View File

@@ -1,4 +1,4 @@
require File.expand_path('../../test_helper', __FILE__)
require_relative '../test_helper'
class StartTimerTest < ActiveSupport::TestCase
fixtures :users, :user_preferences, :time_entries, :projects,
@@ -29,7 +29,7 @@ class StartTimerTest < ActiveSupport::TestCase
@time_entry.reload
assert_equal hours, @time_entry.hours
another = TimeEntry.new(@time_entry.attributes.except('id'))
another = TimeEntry.new(@time_entry.attributes)
another.user = @user
r = Stopwatch::StartTimer.new(another, user: @user).call
assert r.success?

2
test/unit/stop_timer_test.rb
View File

@@ -1,4 +1,4 @@
require File.expand_path('../../test_helper', __FILE__)
require_relative '../test_helper'
class StopTimerTest < ActiveSupport::TestCase
fixtures :users, :user_preferences, :time_entries, :projects,

78
test/unit/stopwatch_test.rb
View File

@@ -1,78 +0,0 @@
require File.expand_path('../../test_helper', __FILE__)
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

24
test/unit/time_entry_test.rb
View File

@@ -1,24 +0,0 @@
require File.expand_path('../../test_helper', __FILE__)
class StartTimerTest < ActiveSupport::TestCase
fixtures :users, :user_preferences, :time_entries, :projects,
:roles, :member_roles, :members, :enumerations, :enabled_modules
setup do
@user = User.find 1
@time_entry = TimeEntry.where(user_id: 1).first
# so we dont have to load all the issue and related fixtures:
@time_entry.update_column :issue_id, nil
end
test "should stop timer before destroy" do
assert r = Stopwatch::StartTimer.new(@time_entry, user: @user).call
assert r.success?, r.inspect
assert User.find(@user.id).timer_running?
@time_entry.destroy
refute User.find(@user.id).timer_running?
end
end

2
test/unit/timer_test.rb
View File

@@ -1,4 +1,4 @@
require File.expand_path('../../test_helper', __FILE__)
require_relative '../test_helper'
class TimerTest < ActiveSupport::TestCase
fixtures :users, :user_preferences, :time_entries

13
test/unit/user_test.rb
View File

@@ -1,7 +1,7 @@
require File.expand_path('../../test_helper', __FILE__)
require_relative '../test_helper'
class UserTest < ActiveSupport::TestCase
fixtures :users, :user_preferences, :issues
fixtures :users, :user_preferences
setup do
@user = User.find 1
@@ -18,13 +18,4 @@ 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