jro_apps/redmine Commit - r3972:8900797adaf2

Refactor: move method to Model....

Eric Davis -

r3972:8900797adaf2

parent child

Context file:

r3972:8900797adaf2

Collapse all files

app/controllers/timelog_controller.rb +2 -2

             # redMine - project management software
             # Copyright (C) 2006-2007  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class TimelogController < ApplicationController
               menu_item :issues
               before_filter :find_project, :authorize, :only => [:edit, :destroy]
               before_filter :find_optional_project, :only => [:report, :details]
               before_filter :load_available_criterias, :only => [:report]
               verify :method => :post, :only => :destroy, :redirect_to => { :action => :details }
               helper :sort
               include SortHelper
               helper :issues
               include TimelogHelper
               helper :custom_fields
               include CustomFieldsHelper
               def report
                 @criterias = params[:criterias] || []
                 @criterias = @criterias.select{|criteria| @available_criterias.has_key? criteria}
                 @criterias.uniq!
                 @criterias = @criterias[0,3]
                 @columns = (params[:columns] && %w(year month week day).include?(params[:columns])) ? params[:columns] : 'month'
                 retrieve_date_range
                 unless @criterias.empty?
                   sql_select = @criterias.collect{|criteria| @available_criterias[criteria][:sql] + " AS " + criteria}.join(', ')
                   sql_group_by = @criterias.collect{|criteria| @available_criterias[criteria][:sql]}.join(', ')
                   sql_condition = ''
                   if @project.nil?
                     sql_condition = Project.allowed_to_condition(User.current, :view_time_entries)
                   elsif @issue.nil?
                     sql_condition = @project.project_condition(Setting.display_subprojects_issues?)
                   else
                     sql_condition = "#{Issue.table_name}.root_id = #{@issue.root_id} AND #{Issue.table_name}.lft >= #{@issue.lft} AND #{Issue.table_name}.rgt <= #{@issue.rgt}"
                   end
                   sql = "SELECT #{sql_select}, tyear, tmonth, tweek, spent_on, SUM(hours) AS hours"
                   sql << " FROM #{TimeEntry.table_name}"
                   sql << time_report_joins
                   sql << " WHERE"
                   sql << " (%s) AND" % sql_condition
                   sql << " (spent_on BETWEEN '%s' AND '%s')" % [ActiveRecord::Base.connection.quoted_date(@from), ActiveRecord::Base.connection.quoted_date(@to)]
                   sql << " GROUP BY #{sql_group_by}, tyear, tmonth, tweek, spent_on"
                   @hours = ActiveRecord::Base.connection.select_all(sql)
                   @hours.each do |row|
                     case @columns
                     when 'year'
                       row['year'] = row['tyear']
                     when 'month'
                       row['month'] = "#{row['tyear']}-#{row['tmonth']}"
                     when 'week'
                       row['week'] = "#{row['tyear']}-#{row['tweek']}"
                     when 'day'
                       row['day'] = "#{row['spent_on']}"
                     end
                   end
                   @total_hours = @hours.inject(0) {|s,k| s = s + k['hours'].to_f}
                   @periods = []
                   # Date#at_beginning_of_ not supported in Rails 1.2.x
                   date_from = @from.to_time
                   # 100 columns max
                   while date_from <= @to.to_time && @periods.length < 100
                     case @columns
                     when 'year'
                       @periods << "#{date_from.year}"
                       date_from = (date_from + 1.year).at_beginning_of_year
                     when 'month'
                       @periods << "#{date_from.year}-#{date_from.month}"
                       date_from = (date_from + 1.month).at_beginning_of_month
                     when 'week'
                       @periods << "#{date_from.year}-#{date_from.to_date.cweek}"
                       date_from = (date_from + 7.day).at_beginning_of_week
                     when 'day'
                       @periods << "#{date_from.to_date}"
                       date_from = date_from + 1.day
                     end
                   end
                 end
                 respond_to do |format|
                   format.html { render :layout => !request.xhr? }
                   format.csv  { send_data(report_to_csv(@criterias, @periods, @hours), :type => 'text/csv; header=present', :filename => 'timelog.csv') }
                 end
               end
               def details
                 sort_init 'spent_on', 'desc'
                 sort_update 'spent_on' => 'spent_on',
                             'user' => 'user_id',
                             'activity' => 'activity_id',
                             'project' => "#{Project.table_name}.name",
                             'issue' => 'issue_id',
                             'hours' => 'hours'
                 cond = ARCondition.new
                 if @project.nil?
                   cond << Project.allowed_to_condition(User.current, :view_time_entries)
                 elsif @issue.nil?
                   cond << @project.project_condition(Setting.display_subprojects_issues?)
                 else
                   cond << "#{Issue.table_name}.root_id = #{@issue.root_id} AND #{Issue.table_name}.lft >= #{@issue.lft} AND #{Issue.table_name}.rgt <= #{@issue.rgt}"
                 end
                 retrieve_date_range
                 cond << ['spent_on BETWEEN ? AND ?', @from, @to]
                 TimeEntry.visible_by(User.current) do
                   respond_to do |format|
                     format.html {
                       # Paginate results
                       @entry_count = TimeEntry.count(:include => [:project, :issue], :conditions => cond.conditions)
                       @entry_pages = Paginator.new self, @entry_count, per_page_option, params['page']
                       @entries = TimeEntry.find(:all,
                                                 :include => [:project, :activity, :user, {:issue => :tracker}],
                                                 :conditions => cond.conditions,
                                                 :order => sort_clause,
                                                 :limit  =>  @entry_pages.items_per_page,
                                                 :offset =>  @entry_pages.current.offset)
                       @total_hours = TimeEntry.sum(:hours, :include => [:project, :issue], :conditions => cond.conditions).to_f
                       render :layout => !request.xhr?
                     }
                     format.atom {
                       entries = TimeEntry.find(:all,
                                                :include => [:project, :activity, :user, {:issue => :tracker}],
                                                :conditions => cond.conditions,
                                                :order => "#{TimeEntry.table_name}.created_on DESC",
                                                :limit => Setting.feeds_limit.to_i)
                       render_feed(entries, :title => l(:label_spent_time))
                     }
                     format.csv {
                       # Export all entries
                       @entries = TimeEntry.find(:all,
                                                 :include => [:project, :activity, :user, {:issue => [:tracker, :assigned_to, :priority]}],
                                                 :conditions => cond.conditions,
                                                 :order => sort_clause)
                       send_data(entries_to_csv(@entries), :type => 'text/csv; header=present', :filename => 'timelog.csv')
                     }
                   end
                 end
               end
               def edit
                 (render_403; return) if @time_entry && !@time_entry.editable_by?(User.current)
                 @time_entry ||= TimeEntry.new(:project => @project, :issue => @issue, :user => User.current, :spent_on => User.current.today)
                 @time_entry.attributes = params[:time_entry]
                 call_hook(:controller_timelog_edit_before_save, { :params => params, :time_entry => @time_entry })
                 if request.post? and @time_entry.save
                   flash[:notice] = l(:notice_successful_update)
                   redirect_back_or_default :action => 'details', :project_id => @time_entry.project
                   return
                 end
               end
               def destroy
                 (render_404; return) unless @time_entry
                 (render_403; return) unless @time_entry.editable_by?(User.current)
                 if @time_entry.destroy && @time_entry.destroyed?
                   flash[:notice] = l(:notice_successful_delete)
                 else
                   flash[:error] = l(:notice_unable_delete_time_entry)
                 end
                 redirect_to :back
               rescue ::ActionController::RedirectBackError
                 redirect_to :action => 'details', :project_id => @time_entry.project
               end
             private
               def find_project
                 if params[:id]
                   @time_entry = TimeEntry.find(params[:id])
                   @project = @time_entry.project
                 elsif params[:issue_id]
                   @issue = Issue.find(params[:issue_id])
                   @project = @issue.project
                 elsif params[:project_id]
                   @project = Project.find(params[:project_id])
                 else
                   render_404
                   return false
                 end
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def find_optional_project
                 if !params[:issue_id].blank?
                   @issue = Issue.find(params[:issue_id])
                   @project = @issue.project
                 elsif !params[:project_id].blank?
                   @project = Project.find(params[:project_id])
                 end
                 deny_access unless User.current.allowed_to?(:view_time_entries, @project, :global => true)
               end
               # Retrieves the date range based on predefined ranges or specific from/to param dates
               def retrieve_date_range
                 @free_period = false
                 @from, @to = nil, nil
                 if params[:period_type] == '1' || (params[:period_type].nil? && !params[:period].nil?)
                   case params[:period].to_s
                   when 'today'
                     @from = @to = Date.today
                   when 'yesterday'
                     @from = @to = Date.today - 1
                   when 'current_week'
                     @from = Date.today - (Date.today.cwday - 1)%7
                     @to = @from + 6
                   when 'last_week'
                     @from = Date.today - 7 - (Date.today.cwday - 1)%7
                     @to = @from + 6
                   when '7_days'
                     @from = Date.today - 7
                     @to = Date.today
                   when 'current_month'
                     @from = Date.civil(Date.today.year, Date.today.month, 1)
                     @to = (@from >> 1) - 1
                   when 'last_month'
                     @from = Date.civil(Date.today.year, Date.today.month, 1) << 1
                     @to = (@from >> 1) - 1
                   when '30_days'
                     @from = Date.today - 30
                     @to = Date.today
                   when 'current_year'
                     @from = Date.civil(Date.today.year, 1, 1)
                     @to = Date.civil(Date.today.year, 12, 31)
                   end
                 elsif params[:period_type] == '2' || (params[:period_type].nil? && (!params[:from].nil? || !params[:to].nil?))
                   begin; @from = params[:from].to_s.to_date unless params[:from].blank?; rescue; end
                   begin; @to = params[:to].to_s.to_date unless params[:to].blank?; rescue; end
                   @free_period = true
                 else
                   # default
                 end
                 @from, @to = @to, @from if @from && @to && @from > @to
-                @from ||= (TimeEntry.minimum(:spent_on, :include => :project, :conditions => Project.allowed_to_condition(User.current, :view_time_entries)) || Date.today) - 1
+                @from ||= (TimeEntry.earilest_date_for_project || Date.today) - 1
-                @to   ||= (TimeEntry.maximum(:spent_on, :include => :project, :conditions => Project.allowed_to_condition(User.current, :view_time_entries)) || Date.today)
+                @to   ||= (TimeEntry.latest_date_for_project || Date.today)
               end
               def load_available_criterias
                 @available_criterias = { 'project' => {:sql => "#{TimeEntry.table_name}.project_id",
                                                       :klass => Project,
                                                       :label => :label_project},
                                          'version' => {:sql => "#{Issue.table_name}.fixed_version_id",
                                                       :klass => Version,
                                                       :label => :label_version},
                                          'category' => {:sql => "#{Issue.table_name}.category_id",
                                                         :klass => IssueCategory,
                                                         :label => :field_category},
                                          'member' => {:sql => "#{TimeEntry.table_name}.user_id",
                                                      :klass => User,
                                                      :label => :label_member},
                                          'tracker' => {:sql => "#{Issue.table_name}.tracker_id",
                                                       :klass => Tracker,
                                                       :label => :label_tracker},
                                          'activity' => {:sql => "#{TimeEntry.table_name}.activity_id",
                                                        :klass => TimeEntryActivity,
                                                        :label => :label_activity},
                                          'issue' => {:sql => "#{TimeEntry.table_name}.issue_id",
                                                      :klass => Issue,
                                                      :label => :label_issue}
                                        }
                 # Add list and boolean custom fields as available criterias
                 custom_fields = (@project.nil? ? IssueCustomField.for_all : @project.all_issue_custom_fields)
                 custom_fields.select {|cf| %w(list bool).include? cf.field_format }.each do |cf|
                   @available_criterias["cf_#{cf.id}"] = {:sql => "(SELECT c.value FROM #{CustomValue.table_name} c WHERE c.custom_field_id = #{cf.id} AND c.customized_type = 'Issue' AND c.customized_id = #{Issue.table_name}.id)",
                                                          :format => cf.field_format,
                                                          :label => cf.name}
                 end if @project
                 # Add list and boolean time entry custom fields
                 TimeEntryCustomField.find(:all).select {|cf| %w(list bool).include? cf.field_format }.each do |cf|
                   @available_criterias["cf_#{cf.id}"] = {:sql => "(SELECT c.value FROM #{CustomValue.table_name} c WHERE c.custom_field_id = #{cf.id} AND c.customized_type = 'TimeEntry' AND c.customized_id = #{TimeEntry.table_name}.id)",
                                                          :format => cf.field_format,
                                                          :label => cf.name}
                 end
                 # Add list and boolean time entry activity custom fields
                 TimeEntryActivityCustomField.find(:all).select {|cf| %w(list bool).include? cf.field_format }.each do |cf|
                   @available_criterias["cf_#{cf.id}"] = {:sql => "(SELECT c.value FROM #{CustomValue.table_name} c WHERE c.custom_field_id = #{cf.id} AND c.customized_type = 'Enumeration' AND c.customized_id = #{TimeEntry.table_name}.activity_id)",
                                                          :format => cf.field_format,
                                                          :label => cf.name}
                 end
                 call_hook(:controller_timelog_available_criterias, { :available_criterias => @available_criterias, :project => @project })
                 @available_criterias
               end
               def time_report_joins
                 sql = ''
                 sql << " LEFT JOIN #{Issue.table_name} ON #{TimeEntry.table_name}.issue_id = #{Issue.table_name}.id"
                 sql << " LEFT JOIN #{Project.table_name} ON #{TimeEntry.table_name}.project_id = #{Project.table_name}.id"
                 call_hook(:controller_timelog_time_report_joins, {:sql => sql} )
                 sql
               end
             end

app/models/time_entry.rb +8 0

             # redMine - project management software
             # Copyright (C) 2006-2008  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class TimeEntry < ActiveRecord::Base
               # could have used polymorphic association
               # project association here allows easy loading of time entries at project level with one database trip
               belongs_to :project
               belongs_to :issue
               belongs_to :user
               belongs_to :activity, :class_name => 'TimeEntryActivity', :foreign_key => 'activity_id'
               attr_protected :project_id, :user_id, :tyear, :tmonth, :tweek
               acts_as_customizable
               acts_as_event :title => Proc.new {|o| "#{l_hours(o.hours)} (#{(o.issue || o.project).event_title})"},
                             :url => Proc.new {|o| {:controller => 'timelog', :action => 'details', :project_id => o.project, :issue_id => o.issue}},
                             :author => :user,
                             :description => :comments
               acts_as_activity_provider :timestamp => "#{table_name}.created_on",
                                         :author_key => :user_id,
                                         :find_options => {:include => :project}
               validates_presence_of :user_id, :activity_id, :project_id, :hours, :spent_on
               validates_numericality_of :hours, :allow_nil => true, :message => :invalid
               validates_length_of :comments, :maximum => 255, :allow_nil => true
               def after_initialize
                 if new_record? && self.activity.nil?
                   if default_activity = TimeEntryActivity.default
                     self.activity_id = default_activity.id
                   end
                   self.hours = nil if hours == 0
                 end
               end
               def before_validation
                 self.project = issue.project if issue && project.nil?
               end
               def validate
                 errors.add :hours, :invalid if hours && (hours < 0 || hours >= 1000)
                 errors.add :project_id, :invalid if project.nil?
                 errors.add :issue_id, :invalid if (issue_id && !issue) || (issue && project!=issue.project)
               end
               def hours=(h)
                 write_attribute :hours, (h.is_a?(String) ? (h.to_hours || h) : h)
               end
               # tyear, tmonth, tweek assigned where setting spent_on attributes
               # these attributes make time aggregations easier
               def spent_on=(date)
                 super
                 self.tyear = spent_on ? spent_on.year : nil
                 self.tmonth = spent_on ? spent_on.month : nil
                 self.tweek = spent_on ? Date.civil(spent_on.year, spent_on.month, spent_on.day).cweek : nil
               end
               # Returns true if the time entry can be edited by usr, otherwise false
               def editable_by?(usr)
                 (usr == user && usr.allowed_to?(:edit_own_time_entries, project)) || usr.allowed_to?(:edit_time_entries, project)
               end
               def self.visible_by(usr)
                 with_scope(:find => { :conditions => Project.allowed_to_condition(usr, :view_time_entries) }) do
                   yield
                 end
               end
+              def self.earilest_date_for_project
+                TimeEntry.minimum(:spent_on, :include => :project, :conditions => Project.allowed_to_condition(User.current, :view_time_entries))
+              end
+              def self.latest_date_for_project
+                TimeEntry.maximum(:spent_on, :include => :project, :conditions => Project.allowed_to_condition(User.current, :view_time_entries))
+              end
             end

test/unit/time_entry_test.rb +15 0

             # redMine - project management software
             # Copyright (C) 2006-2008  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.dirname(__FILE__) + '/../test_helper'
             class TimeEntryTest < ActiveSupport::TestCase
               fixtures :issues, :projects, :users, :time_entries
               def test_hours_format
                 assertions = { "2"      => 2.0,
                                "21.1"   => 21.1,
                                "2,1"    => 2.1,
                                "1,5h"   => 1.5,
                                "7:12"   => 7.2,
                                "10h"    => 10.0,
                                "10 h"   => 10.0,
                                "45m"    => 0.75,
                                "45 m"   => 0.75,
                                "3h15"   => 3.25,
                                "3h 15"  => 3.25,
                                "3 h 15"   => 3.25,
                                "3 h 15m"  => 3.25,
                                "3 h 15 m" => 3.25,
                                "3 hours"  => 3.0,
                                "12min"    => 0.2,
                               }
                 assertions.each do |k, v|
                   t = TimeEntry.new(:hours => k)
                   assert_equal v, t.hours, "Converting #{k} failed:"
                 end
               end
               def test_hours_should_default_to_nil
                 assert_nil TimeEntry.new.hours
               end
+              context "#earilest_date_for_project" do
+                should "return the lowest spent_on value that is visible to the current user" do
+                  User.current = nil
+                  assert_equal "2007-03-12", TimeEntry.earilest_date_for_project.to_s
+                end
+              end
+              context "#latest_date_for_project" do
+                should "return the highest spent_on value that is visible to the current user" do
+                  User.current = nil
+                  assert_equal "2007-04-22", TimeEntry.latest_date_for_project.to_s
+                end
+              end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages