jro_apps/redmine Commit - r11607:af632568e3e9

Merged r11760 from trunk (#13850)....

Jean-Philippe Lang -

r11607:af632568e3e9

parent child

Context file:

r11607:af632568e3e9

Collapse all files

app/models/version.rb +2 -1

             # Redmine - project management software
             # Copyright (C) 2006-2013  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
               include Redmine::SafeAttributes
               after_update :update_issues_from_sharing_change
               belongs_to :project
               has_many :fixed_issues, :class_name => 'Issue', :foreign_key => 'fixed_version_id', :dependent => :nullify
               acts_as_customizable
               acts_as_attachable :view_permission => :view_files,
                                  :delete_permission => :manage_files
               VERSION_STATUSES = %w(open locked closed)
               VERSION_SHARINGS = %w(none descendants hierarchy tree system)
               validates_presence_of :name
               validates_uniqueness_of :name, :scope => [:project_id]
               validates_length_of :name, :maximum => 60
               validates :effective_date, :date => true
               validates_inclusion_of :status, :in => VERSION_STATUSES
               validates_inclusion_of :sharing, :in => VERSION_SHARINGS
               scope :named, lambda {|arg| where("LOWER(#{table_name}.name) = LOWER(?)", arg.to_s.strip)}
               scope :open, lambda { where(:status => 'open') }
               scope :visible, lambda {|*args|
                 includes(:project).where(Project.allowed_to_condition(args.first || User.current, :view_issues))
               }
               safe_attributes 'name',
                 'description',
                 'effective_date',
                 'due_date',
                 'wiki_page_title',
                 'status',
                 'sharing',
-                'custom_field_values'
+                'custom_field_values',
+                'custom_fields'
               # Returns true if +user+ or current user is allowed to view the version
               def visible?(user=User.current)
                 user.allowed_to?(:view_issues, self.project)
               end
               # Version files have same visibility as project files
               def attachments_visible?(*args)
                 project.present? && project.attachments_visible?(*args)
               end
               def start_date
                 @start_date ||= fixed_issues.minimum('start_date')
               end
               def due_date
                 effective_date
               end
               def due_date=(arg)
                 self.effective_date=(arg)
               end
               # Returns the total estimated time for this version
               # (sum of leaves estimated_hours)
               def estimated_hours
                 @estimated_hours ||= fixed_issues.leaves.sum(:estimated_hours).to_f
               end
               # Returns the total reported time for this version
               def spent_hours
                 @spent_hours ||= TimeEntry.joins(:issue).where("#{Issue.table_name}.fixed_version_id = ?", id).sum(:hours).to_f
               end
               def closed?
                 status == 'closed'
               end
               def open?
                 status == 'open'
               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
               def behind_schedule?
                 if completed_percent == 100
                   return false
                 elsif due_date && start_date
                   done_date = start_date + ((due_date - start_date+1)* completed_percent/100).floor
                   return done_date <= Date.today
                 else
                   false # No issues so it's not late
                 end
               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_percent
                 if issues_count == 0
                 elsif open_issues_count == 0
                 else
                   issues_progress(false) + issues_progress(true)
                 end
               end
               # TODO: remove in Redmine 3.0
               def completed_pourcent
                 ActiveSupport::Deprecation.warn "Version#completed_pourcent is deprecated and will be removed in Redmine 3.0. Please use #completed_percent instead."
                 completed_percent
               end
               # Returns the percentage of issues that have been marked as 'closed'.
               def closed_percent
                 if issues_count == 0
                 else
                   issues_progress(false)
                 end
               end
               # TODO: remove in Redmine 3.0
               def closed_pourcent
                 ActiveSupport::Deprecation.warn "Version#closed_pourcent is deprecated and will be removed in Redmine 3.0. Please use #closed_percent instead."
                 closed_percent
               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
                 load_issue_counts
                 @issue_count
               end
               # Returns the total amount of open issues for this version.
               def open_issues_count
                 load_issue_counts
                 @open_issues_count
               end
               # Returns the total amount of closed issues for this version.
               def closed_issues_count
                 load_issue_counts
                 @closed_issues_count
               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
               def to_s_with_project
                 "#{project} - #{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
                   if version.effective_date
                     if self.effective_date == version.effective_date
                       name == version.name ? id <=> version.id : name <=> version.name
                     else
                       self.effective_date <=> version.effective_date
                     end
                   else
                     -1
                   end
                 else
                   if version.effective_date
                   else
                     name == version.name ? id <=> version.id : name <=> version.name
                   end
                 end
               end
               def self.fields_for_order_statement(table=nil)
                 table ||= table_name
                 ["(CASE WHEN #{table}.effective_date IS NULL THEN 1 ELSE 0 END)", "#{table}.effective_date", "#{table}.name", "#{table}.id"]
               end
               scope :sorted, order(fields_for_order_statement)
               # Returns the sharings that +user+ can set the version to
               def allowed_sharings(user = User.current)
                 VERSION_SHARINGS.select do |s|
                   if sharing == s
                     true
                   else
                     case s
                     when 'system'
                       # Only admin users can set a systemwide sharing
                       user.admin?
                     when 'hierarchy', 'tree'
                       # Only users allowed to manage versions of the root project can
                       # set sharing to hierarchy or tree
                       project.nil? || user.allowed_to?(:manage_versions, project.root)
                     else
                       true
                     end
                   end
                 end
               end
               private
               def load_issue_counts
                 unless @issue_count
                   @open_issues_count = 0
                   @closed_issues_count = 0
                   fixed_issues.count(:all, :group => :status).each do |status, count|
                     if status.is_closed?
                       @closed_issues_count += count
                     else
                       @open_issues_count += count
                     end
                   end
                   @issue_count = @open_issues_count + @closed_issues_count
                 end
               end
               # Update the issue's fixed versions. Used if a version's sharing changes.
               def update_issues_from_sharing_change
                 if sharing_changed?
                   if VERSION_SHARINGS.index(sharing_was).nil? ||
                       VERSION_SHARINGS.index(sharing).nil? ||
                       VERSION_SHARINGS.index(sharing_was) > VERSION_SHARINGS.index(sharing)
                     Issue.update_versions_from_sharing_change self
                   end
                 end
               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.open(open).sum("COALESCE(estimated_hours, #{estimated_average}) * #{ratio}").to_f
                     progress = done / (estimated_average * issues_count)
                   end
                   progress
                 end
               end
             end

test/integration/api_test/versions_test.rb +23 0

             # Redmine - project management software
             # Copyright (C) 2006-2013  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.expand_path('../../../test_helper', __FILE__)
             class Redmine::ApiTest::VersionsTest < Redmine::ApiTest::Base
               fixtures :projects, :trackers, :issue_statuses, :issues,
                        :enumerations, :users, :issue_categories,
                        :projects_trackers,
                        :roles,
                        :member_roles,
                        :members,
                        :enabled_modules,
                        :versions
               def setup
                 Setting.rest_api_enabled = '1'
               end
               context "/projects/:project_id/versions" do
                 context "GET" do
                   should "return project versions" do
                     get '/projects/1/versions.xml'
                     assert_response :success
                     assert_equal 'application/xml', @response.content_type
                     assert_tag :tag => 'versions',
                       :attributes => {:type => 'array'},
                       :child => {
                         :tag => 'version',
                         :child => {
                           :tag => 'id',
                           :content => '2',
                           :sibling => {
                             :tag => 'name',
                             :content => '1.0'
                           }
                         }
                       }
                   end
                 end
                 context "POST" do
                   should "create the version" do
                     assert_difference 'Version.count' do
                       post '/projects/1/versions.xml', {:version => {:name => 'API test'}}, credentials('jsmith')
                     end
                     version = Version.first(:order => 'id DESC')
                     assert_equal 'API test', version.name
                     assert_response :created
                     assert_equal 'application/xml', @response.content_type
                     assert_tag 'version', :child => {:tag => 'id', :content => version.id.to_s}
                   end
                   should "create the version with due date" do
                     assert_difference 'Version.count' do
                       post '/projects/1/versions.xml', {:version => {:name => 'API test', :due_date => '2012-01-24'}}, credentials('jsmith')
                     end
                     version = Version.first(:order => 'id DESC')
                     assert_equal 'API test', version.name
                     assert_equal Date.parse('2012-01-24'), version.due_date
                     assert_response :created
                     assert_equal 'application/xml', @response.content_type
                     assert_tag 'version', :child => {:tag => 'id', :content => version.id.to_s}
                   end
+                  should "create the version with custom fields" do
+                    field = VersionCustomField.generate!
+                    assert_difference 'Version.count' do
+                      post '/projects/1/versions.xml', {
+                          :version => {
+                            :name => 'API test',
+                            :custom_fields => [
+                              {'id' => field.id.to_s, 'value' => 'Some value'}
+                            ]
+                          }
+                        }, credentials('jsmith')
+                    end
+                    version = Version.first(:order => 'id DESC')
+                    assert_equal 'API test', version.name
+                    assert_equal 'Some value', version.custom_field_value(field)
+                    assert_response :created
+                    assert_equal 'application/xml', @response.content_type
+                    assert_select 'version>custom_fields>custom_field[id=?]>value', field.id.to_s, 'Some value'
+                  end
                   context "with failure" do
                     should "return the errors" do
                       assert_no_difference('Version.count') do
                         post '/projects/1/versions.xml', {:version => {:name => ''}}, credentials('jsmith')
                       end
                       assert_response :unprocessable_entity
                       assert_tag :errors, :child => {:tag => 'error', :content => "Name can't be blank"}
                     end
                   end
                 end
               end
               context "/versions/:id" do
                 context "GET" do
                   should "return the version" do
                     get '/versions/2.xml'
                     assert_response :success
                     assert_equal 'application/xml', @response.content_type
                     assert_select 'version' do
                       assert_select 'id', :text => '2'
                       assert_select 'name', :text => '1.0'
                       assert_select 'sharing', :text => 'none'
                     end
                   end
                 end
                 context "PUT" do
                   should "update the version" do
                     put '/versions/2.xml', {:version => {:name => 'API update'}}, credentials('jsmith')
                     assert_response :ok
                     assert_equal '', @response.body
                     assert_equal 'API update', Version.find(2).name
                   end
                 end
                 context "DELETE" do
                   should "destroy the version" do
                     assert_difference 'Version.count', -1 do
                       delete '/versions/3.xml', {}, credentials('jsmith')
                     end
                     assert_response :ok
                     assert_equal '', @response.body
                     assert_nil Version.find_by_id(3)
                   end
                 end
               end
             end

test/object_helpers.rb +11 0

             module ObjectHelpers
               def User.generate!(attributes={})
                 @generated_user_login ||= 'user0'
                 @generated_user_login.succ!
                 user = User.new(attributes)
                 user.login = @generated_user_login.dup if user.login.blank?
                 user.mail = "#{@generated_user_login}@example.com" if user.mail.blank?
                 user.firstname = "Bob" if user.firstname.blank?
                 user.lastname = "Doe" if user.lastname.blank?
                 yield user if block_given?
                 user.save!
                 user
               end
               def User.add_to_project(user, project, roles=nil)
                 roles = Role.find(1) if roles.nil?
                 roles = [roles] unless roles.is_a?(Array)
                 Member.create!(:principal => user, :project => project, :roles => roles)
               end
               def Group.generate!(attributes={})
                 @generated_group_name ||= 'Group 0'
                 @generated_group_name.succ!
                 group = Group.new(attributes)
                 group.name = @generated_group_name.dup if group.name.blank?
                 yield group if block_given?
                 group.save!
                 group
               end
               def Project.generate!(attributes={})
                 @generated_project_identifier ||= 'project-0000'
                 @generated_project_identifier.succ!
                 project = Project.new(attributes)
                 project.name = @generated_project_identifier.dup if project.name.blank?
                 project.identifier = @generated_project_identifier.dup if project.identifier.blank?
                 yield project if block_given?
                 project.save!
                 project
               end
               def Project.generate_with_parent!(parent, attributes={})
                 project = Project.generate!(attributes)
                 project.set_parent!(parent)
                 project
               end
               def Tracker.generate!(attributes={})
                 @generated_tracker_name ||= 'Tracker 0'
                 @generated_tracker_name.succ!
                 tracker = Tracker.new(attributes)
                 tracker.name = @generated_tracker_name.dup if tracker.name.blank?
                 yield tracker if block_given?
                 tracker.save!
                 tracker
               end
               def Role.generate!(attributes={})
                 @generated_role_name ||= 'Role 0'
                 @generated_role_name.succ!
                 role = Role.new(attributes)
                 role.name = @generated_role_name.dup if role.name.blank?
                 yield role if block_given?
                 role.save!
                 role
               end
               def Issue.generate!(attributes={})
                 issue = Issue.new(attributes)
                 issue.project ||= Project.find(1)
                 issue.tracker ||= issue.project.trackers.first
                 issue.subject = 'Generated' if issue.subject.blank?
                 issue.author ||= User.find(2)
                 yield issue if block_given?
                 issue.save!
                 issue
               end
               # Generates an issue with 2 children and a grandchild
               def Issue.generate_with_descendants!(attributes={})
                 issue = Issue.generate!(attributes)
                 child = Issue.generate!(:project => issue.project, :subject => 'Child1', :parent_issue_id => issue.id)
                 Issue.generate!(:project => issue.project, :subject => 'Child2', :parent_issue_id => issue.id)
                 Issue.generate!(:project => issue.project, :subject => 'Child11', :parent_issue_id => child.id)
                 issue.reload
               end
               def Journal.generate!(attributes={})
                 journal = Journal.new(attributes)
                 journal.user ||= User.first
                 journal.journalized ||= Issue.first
                 yield journal if block_given?
                 journal.save!
                 journal
               end
               def Version.generate!(attributes={})
                 @generated_version_name ||= 'Version 0'
                 @generated_version_name.succ!
                 version = Version.new(attributes)
                 version.name = @generated_version_name.dup if version.name.blank?
                 yield version if block_given?
                 version.save!
                 version
               end
               def TimeEntry.generate!(attributes={})
                 entry = TimeEntry.new(attributes)
                 entry.user ||= User.find(2)
                 entry.issue ||= Issue.find(1) unless entry.project
                 entry.project ||= entry.issue.project
                 entry.activity ||= TimeEntryActivity.first
                 entry.spent_on ||= Date.today
                 entry.hours ||= 1.0
                 entry.save!
                 entry
               end
               def AuthSource.generate!(attributes={})
                 @generated_auth_source_name ||= 'Auth 0'
                 @generated_auth_source_name.succ!
                 source = AuthSource.new(attributes)
                 source.name = @generated_auth_source_name.dup if source.name.blank?
                 yield source if block_given?
                 source.save!
                 source
               end
               def Board.generate!(attributes={})
                 @generated_board_name ||= 'Forum 0'
                 @generated_board_name.succ!
                 board = Board.new(attributes)
                 board.name = @generated_board_name.dup if board.name.blank?
                 board.description = @generated_board_name.dup if board.description.blank?
                 yield board if block_given?
                 board.save!
                 board
               end
               def Attachment.generate!(attributes={})
                 @generated_filename ||= 'testfile0'
                 @generated_filename.succ!
                 attributes = attributes.dup
                 attachment = Attachment.new(attributes)
                 attachment.container ||= Issue.find(1)
                 attachment.author ||= User.find(2)
                 attachment.filename = @generated_filename.dup if attachment.filename.blank?
                 attachment.save!
                 attachment
               end
+              def CustomField.generate!(attributes={})
+                @generated_custom_field_name ||= 'Custom field 0'
+                @generated_custom_field_name.succ!
+                field = new(attributes)
+                field.name = @generated_custom_field_name.dup if field.name.blank?
+                field.field_format = 'string' if field.field_format.blank?
+                yield field if block_given?
+                field.save!
+                field
+              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