jro_apps/redmine Commit - r2950:ba7cf9c3ce6c

Adds custom fields for versions (#4219)....

Jean-Philippe Lang -

r2950:ba7cf9c3ce6c

parent child

Context file:

r2950:ba7cf9c3ce6c

Collapse all files

app/models/version_custom_field.rb created 644 +22 0

@@ -0,0 +1,22
	1	# Redmine - project management software
	2	# Copyright (C) 2006-2009 Jean-Philippe Lang
	3	#
	4	# This program is free software; you can redistribute it and/or
	5	# modify it under the terms of the GNU General Public License
	6	# as published by the Free Software Foundation; either version 2
	7	# of the License, or (at your option) any later version.
	8	#
	9	# This program is distributed in the hope that it will be useful,
	10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	# GNU General Public License for more details.
	13	#
	14	# You should have received a copy of the GNU General Public License
	15	# along with this program; if not, write to the Free Software
	16	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
	17
	18	class VersionCustomField < CustomField
	19	def type_name
	20	:label_version_plural
	21	end
	22	end

app/controllers/versions_controller.rb +2 0

             # redMine - project management software
             # Copyright (C) 2006  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 VersionsController < ApplicationController
               menu_item :roadmap
               before_filter :find_version, :except => :close_completed
               before_filter :find_project, :only => :close_completed
               before_filter :authorize
+              helper :custom_fields
               def show
               end
               def edit
                 if request.post? and @version.update_attributes(params[:version])
                   flash[:notice] = l(:notice_successful_update)
                   redirect_to :controller => 'projects', :action => 'settings', :tab => 'versions', :id => @project
                 end
               end
               def close_completed
                 if request.post?
                   @project.close_completed_versions
                 end
                 redirect_to :controller => 'projects', :action => 'settings', :tab => 'versions', :id => @project
               end
               def destroy
                 @version.destroy
                 redirect_to :controller => 'projects', :action => 'settings', :tab => 'versions', :id => @project
               rescue
                 flash[:error] = l(:notice_unable_delete_version)
                 redirect_to :controller => 'projects', :action => 'settings', :tab => 'versions', :id => @project
               end
               def status_by
                 respond_to do |format|
                   format.html { render :action => 'show' }
                   format.js { render(:update) {|page| page.replace_html 'status_by', render_issue_status_by(@version, params[:status_by])} }
                 end
               end
             private
               def find_version
                 @version = Version.find(params[:id])
                 @project = @version.project
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def find_project
                 @project = Project.find(params[:project_id])
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
             end

app/helpers/custom_fields_helper.rb +1 0

             # redMine - project management software
             # Copyright (C) 2006  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.
             module CustomFieldsHelper
               def custom_fields_tabs
                 tabs = [{:name => 'IssueCustomField', :partial => 'custom_fields/index', :label => :label_issue_plural},
                         {:name => 'TimeEntryCustomField', :partial => 'custom_fields/index', :label => :label_spent_time},
                         {:name => 'ProjectCustomField', :partial => 'custom_fields/index', :label => :label_project_plural},
+                        {:name => 'VersionCustomField', :partial => 'custom_fields/index', :label => :label_version_plural},
                         {:name => 'UserCustomField', :partial => 'custom_fields/index', :label => :label_user_plural},
                         {:name => 'GroupCustomField', :partial => 'custom_fields/index', :label => :label_group_plural},
                         {:name => 'TimeEntryActivityCustomField', :partial => 'custom_fields/index', :label => TimeEntryActivity::OptionName},
                         {:name => 'IssuePriorityCustomField', :partial => 'custom_fields/index', :label => IssuePriority::OptionName},
                         {:name => 'DocumentCategoryCustomField', :partial => 'custom_fields/index', :label => DocumentCategory::OptionName}
                         ]
               end
               # Return custom field html tag corresponding to its format
               def custom_field_tag(name, custom_value)
                 custom_field = custom_value.custom_field
                 field_name = "#{name}[custom_field_values][#{custom_field.id}]"
                 field_id = "#{name}_custom_field_values_#{custom_field.id}"
                 case custom_field.field_format
                 when "date"
                   text_field_tag(field_name, custom_value.value, :id => field_id, :size => 10) +
                   calendar_for(field_id)
                 when "text"
                   text_area_tag(field_name, custom_value.value, :id => field_id, :rows => 3, :style => 'width:90%')
                 when "bool"
                   hidden_field_tag(field_name, '0') + check_box_tag(field_name, '1', custom_value.true?, :id => field_id)
                 when "list"
                   blank_option = custom_field.is_required? ?
                                    (custom_field.default_value.blank? ? "<option value=\"\">--- #{l(:actionview_instancetag_blank_option)} ---</option>" : '') :
                                    '<option></option>'
                   select_tag(field_name, blank_option + options_for_select(custom_field.possible_values, custom_value.value), :id => field_id)
                 else
                   text_field_tag(field_name, custom_value.value, :id => field_id)
                 end
               end
               # Return custom field label tag
               def custom_field_label_tag(name, custom_value)
                 content_tag "label", custom_value.custom_field.name +
             	(custom_value.custom_field.is_required? ? " <span class=\"required\">*</span>" : ""),
             	:for => "#{name}_custom_field_values_#{custom_value.custom_field.id}",
             	:class => (custom_value.errors.empty? ? nil : "error" )
               end
               # Return custom field tag with its label tag
               def custom_field_tag_with_label(name, custom_value)
                 custom_field_label_tag(name, custom_value) + custom_field_tag(name, custom_value)
               end
               # Return a string used to display a custom value
               def show_value(custom_value)
                 return "" unless custom_value
                 format_value(custom_value.value, custom_value.custom_field.field_format)
               end
               # Return a string used to display a custom value
               def format_value(value, field_format)
                 return "" unless value && !value.empty?
                 case field_format
                 when "date"
                   begin; format_date(value.to_date); rescue; value end
                 when "bool"
                   l(value == "1" ? :general_text_Yes : :general_text_No)
                 else
                   value
                 end
               end
               # Return an array of custom field formats which can be used in select_tag
               def custom_field_formats_for_select
                 CustomField::FIELD_FORMATS.sort {|a,b| a[1][:order]<=>b[1][:order]}.collect { |k| [ l(k[1][:name]), k[0] ] }
               end
             end

app/models/version.rb +1 0

             # redMine - project management software
             # Copyright (C) 2006  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 Version < ActiveRecord::Base
               before_destroy :check_integrity
               belongs_to :project
               has_many :fixed_issues, :class_name => 'Issue', :foreign_key => 'fixed_version_id'
+              acts_as_customizable
               acts_as_attachable :view_permission => :view_files,
                                  :delete_permission => :manage_files
               VERSION_STATUSES = %w(open locked closed)
               validates_presence_of :name
               validates_uniqueness_of :name, :scope => [:project_id]
               validates_length_of :name, :maximum => 60
               validates_format_of :effective_date, :with => /^\d{4}-\d{2}-\d{2}$/, :message => :not_a_date, :allow_nil => true
               validates_inclusion_of :status, :in => VERSION_STATUSES
               named_scope :open, :conditions => {:status => 'open'}
               def start_date
                 effective_date
               end
               def due_date
                 effective_date
               end
               # Returns the total estimated time for this version
               def estimated_hours
                 @estimated_hours ||= fixed_issues.sum(:estimated_hours).to_f
               end
               # Returns the total reported time for this version
               def spent_hours
                 @spent_hours ||= TimeEntry.sum(:hours, :include => :issue, :conditions => ["#{Issue.table_name}.fixed_version_id = ?", id]).to_f
               end
               def closed?
                 status == 'closed'
               end
               # Returns true if the version is completed: due date reached and no open issues
               def completed?
                 effective_date && (effective_date <= Date.today) && (open_issues_count == 0)
               end
               # Returns the completion percentage of this version based on the amount of open/closed issues
               # and the time spent on the open issues.
               def completed_pourcent
                 if issues_count == 0
                 elsif open_issues_count == 0
                 else
                   issues_progress(false) + issues_progress(true)
                 end
               end
               # Returns the percentage of issues that have been marked as 'closed'.
               def closed_pourcent
                 if issues_count == 0
                 else
                   issues_progress(false)
                 end
               end
               # Returns true if the version is overdue: due date reached and some open issues
               def overdue?
                 effective_date && (effective_date < Date.today) && (open_issues_count > 0)
               end
               # Returns assigned issues count
               def issues_count
                 @issue_count ||= fixed_issues.count
               end
               # Returns the total amount of open issues for this version.
               def open_issues_count
                 @open_issues_count ||= Issue.count(:all, :conditions => ["fixed_version_id = ? AND is_closed = ?", self.id, false], :include => :status)
               end
               # Returns the total amount of closed issues for this version.
               def closed_issues_count
                 @closed_issues_count ||= Issue.count(:all, :conditions => ["fixed_version_id = ? AND is_closed = ?", self.id, true], :include => :status)
               end
               def wiki_page
                 if project.wiki && !wiki_page_title.blank?
                   @wiki_page ||= project.wiki.find_page(wiki_page_title)
                 end
                 @wiki_page
               end
               def to_s; name end
               # Versions are sorted by effective_date and name
               # Those with no effective_date are at the end, sorted by name
               def <=>(version)
                 if self.effective_date
                   version.effective_date ? (self.effective_date == version.effective_date ? self.name <=> version.name : self.effective_date <=> version.effective_date) : -1
                 else
                   version.effective_date ? 1 : (self.name <=> version.name)
                 end
               end
             private
               def check_integrity
                 raise "Can't delete version" if self.fixed_issues.find(:first)
               end
               # Returns the average estimated time of assigned issues
               # or 1 if no issue has an estimated time
               # Used to weigth unestimated issues in progress calculation
               def estimated_average
                 if @estimated_average.nil?
                   average = fixed_issues.average(:estimated_hours).to_f
                   if average == 0
                     average = 1
                   end
                   @estimated_average = average
                 end
                 @estimated_average
               end
               # Returns the total progress of open or closed issues.  The returned percentage takes into account
               # the amount of estimated time set for this version.
               #
               # Examples:
               # issues_progress(true)   => returns the progress percentage for open issues.
               # issues_progress(false)  => returns the progress percentage for closed issues.
               def issues_progress(open)
                 @issues_progress ||= {}
                 @issues_progress[open] ||= begin
                   progress = 0
                   if issues_count > 0
                     ratio = open ? 'done_ratio' : 100
                     done = fixed_issues.sum("COALESCE(estimated_hours, #{estimated_average}) * #{ratio}",
                                               :include => :status,
                                               :conditions => ["is_closed = ?", !open]).to_f
                     progress = done / (estimated_average * issues_count)
                   end
                   progress
                 end
               end
             end

app/views/versions/_form.rhtml +4 0

             <%= error_messages_for 'version' %>
             <div class="box">
             <p><%= f.text_field :name, :size => 60, :required => true %></p>
             <p><%= f.text_field :description, :size => 60 %></p>
             <p><%= f.select :status, Version::VERSION_STATUSES.collect {|s| [l("version_status_#{s}"), s]} %></p>
             <p><%= f.text_field :wiki_page_title, :label => :label_wiki_page, :size => 60, :disabled => @project.wiki.nil? %></p>
             <p><%= f.text_field :effective_date, :size => 10 %><%= calendar_for('version_effective_date') %></p>
+            <% @version.custom_field_values.each do |value| %>
+            	<p><%= custom_field_tag_with_label :version, value %></p>
+            <% end %>
             </div>

app/views/versions/_overview.rhtml +7 0

             <% if version.completed? %>
               <p><%= format_date(version.effective_date) %></p>
             <% elsif version.effective_date %>
               <p><strong><%= due_date_distance_in_words(version.effective_date) %></strong> (<%= format_date(version.effective_date) %>)</p>
             <% end %>
             <p><%=h version.description %></p>
+            <ul>
+            	<% version.custom_values.each do |custom_value| %>
+            		<% if !custom_value.value.blank? %>
+            		   <li><%=h custom_value.custom_field.name %>: <%=h show_value(custom_value) %></li>
+            		<% end %>
+            	<% end %>
+            </ul>
             <% if version.fixed_issues.count > 0 %>
                 <%= progress_bar([version.closed_pourcent, version.completed_pourcent], :width => '40em', :legend => ('%0.0f%' % version.completed_pourcent)) %>
                 <p class="progress-info">
                     <%= link_to_if(version.closed_issues_count > 0, l(:label_x_closed_issues_abbr, :count => version.closed_issues_count), :controller => 'issues', :action => 'index', :project_id => version.project, :status_id => 'c', :fixed_version_id => version, :set_filter => 1) %>
                     (<%= '%0.0f' % (version.closed_issues_count.to_f / version.fixed_issues.count * 100) %>%)
                     &#160;
                     <%= link_to_if(version.open_issues_count > 0, l(:label_x_open_issues_abbr, :count => version.open_issues_count), :controller => 'issues', :action => 'index', :project_id => version.project, :status_id => 'o', :fixed_version_id => version, :set_filter => 1) %>
                     (<%= '%0.0f' % (version.open_issues_count.to_f / version.fixed_issues.count * 100) %>%)
                 </p>
             <% else %>
                 <p><em><%= l(:label_roadmap_no_issues) %></em></p>
             <% 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