timesheet_plugin 0.5.0 → 0.6.0

data/README.rdoc

@@ -18,6 +18,7 @@ A plugin to show and filter timelogs across all projects in Redmine.
 * Permalinks to reports
 * Plugin hook support for changing the behavior of the plugin
 * User configurable precision for hours
+* CSV exports
 
 == Getting the plugin
 

data/Rakefile

@@ -5,8 +5,8 @@ Dir[File.expand_path(File.dirname(__FILE__)) + "/lib/tasks/**/*.rake"].sort.each
 
 RedminePluginSupport::Base.setup do |plugin|
   plugin.project_name = 'timesheet_plugin'
-  plugin.default_task = [:spec]
-  plugin.tasks = [:doc, :release, :clean, :spec]
+  plugin.default_task = [:test]
+  plugin.tasks = [:doc, :release, :clean, :stats, :test, :db]
   # TODO: gem not getting this automaticly
   plugin.redmine_root = File.expand_path(File.dirname(__FILE__) + '/../../../')
 end

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/app/controllers/timesheet_controller.rb

@@ -14,6 +14,8 @@ class TimesheetController < ApplicationController
 
   SessionKey = 'timesheet_filter'
 
+  verify :method => :delete, :only => :reset, :render => {:nothing => true, :status => :method_not_allowed }
+
   def index
     load_filters_from_session
     unless @timesheet
@@ -81,8 +83,10 @@ class TimesheetController < ApplicationController
     
     @grand_total = @total.collect{|k,v| v}.inject{|sum,n| sum + n}
 
-    send_csv and return if 'csv' == params[:export]
-    render :action => 'details', :layout => false if request.xhr?
+    respond_to do |format|
+      format.html { render :action => 'details', :layout => false if request.xhr? }
+      format.csv  { send_data @timesheet.to_csv, :filename => 'timesheet.csv', :type => "text/csv" }
+    end
   end
   
   def context_menu
@@ -90,6 +94,11 @@ class TimesheetController < ApplicationController
     render :layout => false
   end
 
+  def reset
+    clear_filters_from_session
+    redirect_to :action => 'index'
+  end
+
   private
   def get_list_size
     @list_size = Setting.plugin_timesheet_plugin['list_size'].to_i
@@ -114,10 +123,14 @@ class TimesheetController < ApplicationController
     if User.current.admin?
       return Project.find(:all, :order => 'name ASC')
     else
-      return User.current.projects.find(:all, :order => 'name ASC')
+      return Project.find(:all, :conditions => Project.visible_by(User.current), :order => 'name ASC')
     end
   end
 
+  def clear_filters_from_session
+    session[SessionKey] = nil
+  end
+
   def load_filters_from_session
     if session[SessionKey]
       @timesheet = Timesheet.new(session[SessionKey])

data/app/helpers/timesheet_helper.rb

@@ -7,14 +7,19 @@ module TimesheetHelper
     link_to(l(:timesheet_permalink),
             :controller => 'timesheet',
             :action => 'report',
-            :timesheet => { 
-              :projects => timesheet.projects.collect(&:id),
-              :date_from => timesheet.date_from,
-              :date_to => timesheet.date_to,
-              :activities => timesheet.activities,
-              :users => timesheet.users,
-              :sort => timesheet.sort
-            })
+            :timesheet => timesheet.to_param)
+  end
+
+  def link_to_csv_export(timesheet)
+    link_to('CSV',
+            {
+              :controller => 'timesheet',
+              :action => 'report',
+              :format => 'csv',
+              :timesheet => timesheet.to_param
+            },
+            :method => 'post',
+            :class => 'icon icon-timesheet')
   end
   
   def toggle_issue_arrows(issue_id)

data/app/models/timesheet.rb

@@ -38,7 +38,7 @@ class Timesheet
     unless options[:users].nil?
       self.users = options[:users].collect { |u| u.to_i }
     else
-      self.users = User.find(:all).collect(&:id)
+      self.users = Timesheet.viewable_users.collect {|user| user.id.to_i }
     end
 
     if !options[:sort].nil? && options[:sort].respond_to?(:to_sym) && ValidSortOptions.keys.include?(options[:sort].to_sym)
@@ -107,21 +107,114 @@ class Timesheet
     end
     self
   end
+
+  def to_param
+    {
+      :projects => projects.collect(&:id),
+      :date_from => date_from,
+      :date_to => date_to,
+      :activities => activities,
+      :users => users,
+      :sort => sort
+    }
+  end
+
+  def to_csv
+    returning '' do |out|
+      FCSV.generate out do |csv|
+        csv << csv_header
+
+        # Write the CSV based on the group/sort
+        case sort
+        when :user, :project
+          time_entries.sort.each do |entryname, entry|
+            entry[:logs].each do |e|
+              csv << time_entry_to_csv(e)
+            end
+          end
+        when :issue
+          time_entries.sort.each do |project, entries|
+            entries[:issues].sort {|a,b| a[0].id <=> b[0].id}.each do |issue, time_entries|
+              time_entries.each do |e|
+                csv << time_entry_to_csv(e)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def self.viewable_users
+    User.active.select {|user|
+      user.allowed_to?(:log_time, nil, :global => true)
+    }
+  end
   
   protected
 
-  def conditions(users)
+  def csv_header
+    csv_data = [
+                '#',
+                l(:label_date),
+                l(:label_member),
+                l(:label_activity),
+                l(:label_project),
+                l(:label_issue),
+                l(:field_comments),
+                l(:field_hours)
+               ]
+    Redmine::Hook.call_hook(:plugin_timesheet_model_timesheet_csv_header, { :timesheet => self, :csv_data => csv_data})
+    return csv_data
+  end
+
+  def time_entry_to_csv(time_entry)
+    csv_data = [
+                time_entry.id,
+                time_entry.spent_on,
+                time_entry.user.name,
+                time_entry.activity.name,
+                time_entry.project.name,
+                ("#{time_entry.issue.tracker.name} ##{time_entry.issue.id}" if time_entry.issue),
+                time_entry.comments,
+                time_entry.hours
+               ]
+    Redmine::Hook.call_hook(:plugin_timesheet_model_timesheet_time_entry_to_csv, { :timesheet => self, :time_entry => time_entry, :csv_data => csv_data})
+    return csv_data
+  end
+
+  # Array of users to find
+  # String of extra conditions to add onto the query (AND)
+  def conditions(users, extra_conditions=nil)
     if self.potential_time_entry_ids.empty?
-      if self.date_from && self.date_to
-        conditions = ["spent_on >= (?) AND spent_on <= (?) AND #{TimeEntry.table_name}.project_id IN (?) AND activity_id IN (?) AND user_id IN (?)",
-                      self.date_from, self.date_to, self.projects, self.activities, users ]
+      # TODO: Rails 2.1.2 doesn't define #present?
+      if !self.date_from.blank? && !self.date_to.blank?
+        conditions = ["spent_on >= (:from) AND spent_on <= (:to) AND #{TimeEntry.table_name}.project_id IN (:projects) AND user_id IN (:users) AND (activity_id IN (:activities) #{TimesheetCompatibility::Enumeration.project_specific_sql})",
+                      {
+                        :from => self.date_from,
+                        :to => self.date_to,
+                        :projects => self.projects,
+                        :activities => self.activities,
+                        :users => users
+                      }]
       else # All time
-        conditions = ["#{TimeEntry.table_name}.project_id IN (?) AND activity_id IN (?) AND user_id IN (?)",
-                      self.projects, self.activities, users ]
+        conditions = ["#{TimeEntry.table_name}.project_id IN (:projects) AND user_id IN (:users) AND (activity_id IN (:activities) #{TimesheetCompatibility::Enumeration.project_specific_sql})",
+                      {
+                        :projects => self.projects,
+                        :activities => self.activities,
+                        :users => users
+                      }]
       end
     else
-      conditions = ["user_id IN (?) AND #{TimeEntry.table_name}.id IN (?)",
-                    users, self.potential_time_entry_ids ]
+      conditions = ["user_id IN (:users) AND #{TimeEntry.table_name}.id IN (:potential_time_entries)",
+                    {
+                      :users => users,
+                      :potential_time_entries => self.potential_time_entry_ids
+                    }]
+    end
+
+    if extra_conditions
+      conditions[0] = conditions.first + ' AND ' + extra_conditions
     end
       
     Redmine::Hook.call_hook(:plugin_timesheet_model_timesheet_conditions, { :timesheet => self, :conditions => conditions})
@@ -168,9 +261,11 @@ class Timesheet
                                    :order => "spent_on ASC")
   end
   
-  def time_entries_for_user(user)
+  def time_entries_for_user(user, options={})
+    extra_conditions = options.delete(:conditions)
+    
     return TimeEntry.find(:all,
-                          :conditions => self.conditions([user]),
+                          :conditions => self.conditions([user], extra_conditions),
                           :include => self.includes,
                           :order => "spent_on ASC"
                           )
@@ -218,6 +313,10 @@ class Timesheet
       elsif User.current.id == user_id
         # Users can see their own their time entries
         logs = time_entries_for_user(user_id)
+      elsif User.current.allowed_to?(:see_project_timesheets, nil, :global => true)
+        # User can see project timesheets in at least once place, so
+        # fetch the user timelogs for those projects
+        logs = time_entries_for_user(user_id, :conditions => Project.allowed_to_condition(User.current, :see_project_timesheets))
       else
         # Rest can see nothing
       end
@@ -273,5 +372,14 @@ class Timesheet
       end
     end
   end
-  
+
+
+  # TODO: Redmine 0.8 compatibility hack
+  def l(*args)
+    if defined?(GLoc)
+      GLoc.l(*args)
+    else
+      I18n.t(*args)
+    end
+  end
 end

data/app/views/timesheet/_form.rhtml

@@ -26,7 +26,7 @@
 </p>
 
 <p>
-  <label for="timesheet[projects][]" class="select_all"><%= l(:timesheet_project_label)%>:</label><br />
+  <label for="timesheet_projects_" class="select_all"><%= l(:timesheet_project_label)%>:</label><br />
   <%= select_tag 'timesheet[projects][]',
     options_from_collection_for_select(@timesheet.allowed_projects, :id, :name, @timesheet.projects.collect(&:id)),
     { :multiple => true, :size => @list_size}
@@ -35,7 +35,7 @@
 
 
 <p>
-  <label for="timesheet[activities][]" class="select_all"><%= l(:timesheet_activities_label)%>:</label><br />
+  <label for="timesheet_activities_" class="select_all"><%= l(:timesheet_activities_label)%>:</label><br />
   <%= select_tag 'timesheet[activities][]',
     options_from_collection_for_select(@activities, :id, :name, @timesheet.activities),
     { :multiple => true, :size => @list_size}
@@ -43,9 +43,9 @@
 </p>
 
 <p>
-  <label for="timesheet[users][]" class="select_all"><%= l(:timesheet_users_label)%>:</label><br />
+  <label for="timesheet_users_" class="select_all"><%= l(:timesheet_users_label)%>:</label><br />
   <%= select_tag 'timesheet[users][]',
-    options_from_collection_for_select(User.find(:all, :conditions => ['status = ?', User::STATUS_ACTIVE]).sort { |a,b| a.to_s.downcase <=> b.to_s.downcase }, :id, :name, @timesheet.users),
+    options_from_collection_for_select(Timesheet.viewable_users.sort { |a,b| a.to_s.downcase <=> b.to_s.downcase }, :id, :name, @timesheet.users),
     { :multiple => true, :size => @list_size}
 
            %>
@@ -59,32 +59,6 @@
 <%= submit_tag l(:button_apply),:class => 'button-small' -%>
 
 <% end %>
+<%= button_to(l(:button_reset), {:controller => 'timesheet', :action => 'reset'}, :method => 'delete') %>
 </fieldset>
 </div>
-
-<% content_for(:header_tags) do %>
-<style type="text/css">
-#date-options { margin-left: 10px; }
-#date-options input[type='radio'] { margin-left: -20px; }
-</style>
-<script type="text/javascript">
-
-function targetField(label_element) {
-  return  $(label_element.attributes.for.value);
-}
-
-function selectAllOptions(element) {
-  for (var i = 0; i < element.options.length; i++) {
-    element.options[i].selected = true;
-  }
-}
-
-Event.observe(window, 'load',
-  function() { 
-    $$('label.select_all').each(function(element) {
-      Event.observe(element, 'click', function (e) { selectAllOptions(targetField(this)); });
-    });
-  }
-);
-</script>
-<% end %>

data/app/views/timesheet/_issue_time_entries.rhtml

@@ -10,8 +10,15 @@
       <%= toggle_issue_arrows(issue.id) %>
     </td>
     <td align="center"></td>
-    <td align="center"><%= issue.assigned_to.to_s %></td>
-    <td><%= link_to("##{issue.id}", :controller => 'issues', :action => 'show', :id => issue.id) %>: <%= h issue.subject %></td>
+    <td align="center"><%= l(:field_assigned_to) %>:<br /><%= issue.assigned_to.to_s %></td>
+    <td>
+      <div class="tooltip">
+        <%= link_to_issue issue %>
+        <span class="tip">
+          <%= render_issue_tooltip issue %>
+        </span>
+      </div>
+    </td>
     <td align="center"><strong><%= number_with_precision(displayed_time_entries_for_issue(time_entries), @precision) %></strong></td>
     <%= Redmine::Hook.call_hook(:plugin_timesheet_views_timesheet_time_entry_sum, {:time_entries => time_entries, :precision => @precision }) %>
     <td align="center"></td>

data/app/views/timesheet/index.rhtml

@@ -3,9 +3,6 @@
 <%= render :partial => 'form' %>
 
 <% content_for(:header_tags) do %>
-<style type="text/css">
-
-div#timesheet-form p { padding:0px 10px; float:left; }
-
-</style>
+<%= stylesheet_link_tag "timesheet.css", :plugin => "timesheet_plugin", :media => 'all' %>
+<%= javascript_include_tag 'timesheet.js', :plugin => 'timesheet_plugin' %>
 <% end %>

data/app/views/timesheet/report.rhtml

@@ -1,4 +1,5 @@
 <div class="contextual">
+  <%= link_to_csv_export(@timesheet) %>
   <%= permalink_to_timesheet(@timesheet) %>
 </div>
 
@@ -34,11 +35,7 @@ end # form_tag
 <% content_for(:header_tags) do %>
 <%= javascript_include_tag 'context_menu' %>
 <%= stylesheet_link_tag 'context_menu' %>
-<style type="text/css">
-
-div#timesheet-form p { padding:0px 10px; float:left; }
-
-</style>
+<%= stylesheet_link_tag "timesheet.css", :plugin => "timesheet_plugin", :media => 'all' %>
 <%# TODO: Typo on hook %>
 <%= call_hook(:plugin_timesheet_view_timesheets_report_header_tags, { :timesheet => @timesheet }) %>
 <%= call_hook(:plugin_timesheet_views_timesheets_report_header_tags, { :timesheet => @timesheet }) %>

data/assets/javascripts/timesheet.js

@@ -0,0 +1,17 @@
+function targetField(label_element) {
+  return  $(label_element.attributes.for.value);
+}
+
+function selectAllOptions(element) {
+  for (var i = 0; i < element.options.length; i++) {
+    element.options[i].selected = true;
+  }
+}
+
+Event.observe(window, 'load',
+  function() { 
+    $$('label.select_all').each(function(element) {
+      Event.observe(element, 'click', function (e) { selectAllOptions(targetField(this)); });
+    });
+  }
+);

data/assets/stylesheets/timesheet.css

@@ -0,0 +1,6 @@
+div#timesheet-form p { padding:0px 10px; float:left; }
+.icon-timesheet { background-image: url(../images/csv.png); }
+
+#date-options { margin-left: 10px; }
+#date-options input[type='radio'] { margin-left: -20px; }
+#timesheet-form .button-to div {display:inline; }

data/config/locales/hu.yml

@@ -1,4 +1,4 @@
-hu:
+hu:
   timesheet_title: Időlap
   timesheet_date_from_label: Kezdő dátum
   timesheet_date_to_label: Vég dátum

data/config/locales/hy.yml

@@ -0,0 +1,9 @@
+"hy":
+  timesheet_title: Ծախսված ժամանակի աղյուսակ
+  timesheet_date_from_label: Սկսած
+  timesheet_date_to_label: մինչև
+  timesheet_project_label: Նախագիծ
+  timesheet_activities_label: Ակտիվությունը
+  timesheet_users_label: Օգտագործողներ
+  timesheet_permalink: '(Մշտական հղում դեպի այս աղյուսակը)'
+  timesheet_group_by: Դասավորել ըստ

data/config/locales/ja.yml

@@ -0,0 +1,10 @@
+ja:
+  timesheet_title: 記録時間表
+  timesheet_date_from_label: 期間
+  timesheet_date_to_label: から
+  timesheet_project_label: プロジェクト
+  timesheet_activities_label: 活動
+  timesheet_users_label: ユーザ
+  timesheet_showing_users: 'ユーザ: '
+  timesheet_permalink: '(この記録時間表へ直接リンク)'
+  timesheet_group_by: グループ化