jro_apps/redmine Commit - r15658:e22159a3cb72

Sort members on the DB side....

Jean-Philippe Lang -

r15658:e22159a3cb72

parent child

Context file:

r15658:e22159a3cb72

Collapse all files

app/models/member.rb +7 0

             # Redmine - project management software
             # Copyright (C) 2006-2016  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 Member < ActiveRecord::Base
               belongs_to :user
               belongs_to :principal, :foreign_key => 'user_id'
               has_many :member_roles, :dependent => :destroy
               has_many :roles, lambda { distinct }, :through => :member_roles
               belongs_to :project
               validates_presence_of :principal, :project
               validates_uniqueness_of :user_id, :scope => :project_id
               validate :validate_role
               attr_protected :id
               before_destroy :set_issue_category_nil
               scope :active, lambda { joins(:principal).where(:users => {:status => Principal::STATUS_ACTIVE})}
+            	# Sort by first role and principal
+              scope :sorted, lambda {
+                includes(:member_roles, :roles, :principal).
+                  reorder("#{Role.table_name}.position").
+                  order(Principal.fields_for_order_statement)
+              }
               alias :base_reload :reload
               def reload(*args)
                 @managed_roles = nil
                 base_reload(*args)
               end
               def role
               end
               def role=
               end
               def name
                 self.user.name
               end
               alias :base_role_ids= :role_ids=
               def role_ids=(arg)
                 ids = (arg || []).collect(&:to_i) - [0]
                 # Keep inherited roles
                 ids += member_roles.select {|mr| !mr.inherited_from.nil?}.collect(&:role_id)
                 new_role_ids = ids - role_ids
                 # Add new roles
                 new_role_ids.each {|id| member_roles << MemberRole.new(:role_id => id, :member => self) }
                 # Remove roles (Rails' #role_ids= will not trigger MemberRole#on_destroy)
                 member_roles_to_destroy = member_roles.select {|mr| !ids.include?(mr.role_id)}
                 if member_roles_to_destroy.any?
                   member_roles_to_destroy.each(&:destroy)
                 end
               end
               def <=>(member)
                 a, b = roles.sort, member.roles.sort
                 if a == b
                   if principal
                     principal <=> member.principal
                   else
                   end
                 elsif a.any?
                   b.any? ? a <=> b : -1
                 else
                 end
               end
               # Set member role ids ignoring any change to roles that
               # user is not allowed to manage
               def set_editable_role_ids(ids, user=User.current)
                 ids = (ids || []).collect(&:to_i) - [0]
                 editable_role_ids = user.managed_roles(project).map(&:id)
                 untouched_role_ids = self.role_ids - editable_role_ids
                 touched_role_ids = ids & editable_role_ids
                 self.role_ids = untouched_role_ids + touched_role_ids
               end
               # Returns true if one of the member roles is inherited
               def any_inherited_role?
                 member_roles.any? {|mr| mr.inherited_from}
               end
               # Returns true if the member has the role and if it's inherited
               def has_inherited_role?(role)
                 member_roles.any? {|mr| mr.role_id == role.id && mr.inherited_from.present?}
               end
               # Returns true if the member's role is editable by user
               def role_editable?(role, user=User.current)
                 if has_inherited_role?(role)
                   false
                 else
                   user.managed_roles(project).include?(role)
                 end
               end
               # Returns true if the member is deletable by user
               def deletable?(user=User.current)
                 if any_inherited_role?
                   false
                 else
                   roles & user.managed_roles(project) == roles
                 end
               end
               # Destroys the member
               def destroy
                 member_roles.reload.each(&:destroy_without_member_removal)
                 super
               end
               # Returns true if the member is user or is a group
               # that includes user
               def include?(user)
                 if principal.is_a?(Group)
                   !user.nil? && user.groups.include?(principal)
                 else
                   self.user == user
                 end
               end
               def set_issue_category_nil
                 if user_id && project_id
                   # remove category based auto assignments for this member
                   IssueCategory.where(["project_id = ? AND assigned_to_id = ?", project_id, user_id]).
                     update_all("assigned_to_id = NULL")
                 end
               end
               # Returns the roles that the member is allowed to manage
               # in the project the member belongs to
               def managed_roles
                 @managed_roles ||= begin
                   if principal.try(:admin?)
                     Role.givable.to_a
                   else
                     members_management_roles = roles.select do |role|
                       role.has_permission?(:manage_members)
                     end
                     if members_management_roles.empty?
                       []
                     elsif members_management_roles.any?(&:all_roles_managed?)
                       Role.givable.to_a
                     else
                       members_management_roles.map(&:managed_roles).reduce(&:|)
                     end
                   end
                 end
               end
               # Creates memberships for principal with the attributes
               # * project_ids : one or more project ids
               # * role_ids : ids of the roles to give to each membership
               #
               # Example:
               #   Member.create_principal_memberships(user, :project_ids => [2, 5], :role_ids => [1, 3]
               def self.create_principal_memberships(principal, attributes)
                 members = []
                 if attributes
                   project_ids = Array.wrap(attributes[:project_ids] || attributes[:project_id])
                   role_ids = attributes[:role_ids]
                   project_ids.each do |project_id|
                     members << Member.new(:principal => principal, :role_ids => role_ids, :project_id => project_id)
                   end
                   principal.members << members
                 end
                 members
               end
               # Finds or initilizes a Member for the given project and principal
               def self.find_or_new(project, principal)
                 project_id = project.is_a?(Project) ? project.id : project
                 principal_id = principal.is_a?(Principal) ? principal.id : principal
                 member = Member.find_by_project_id_and_user_id(project_id, principal_id)
                 member ||= Member.new(:project_id => project_id, :user_id => principal_id)
                 member
               end
               protected
               def validate_role
                 errors.add(:role, :empty) if member_roles.empty? && roles.empty?
               end
             end

app/views/projects/settings/_members.html.erb +1 -1

             <% roles = Role.find_all_givable
-               members = @project.memberships.active.includes(:member_roles, :roles, :principal).to_a.sort %>
+               members = @project.memberships.active.sorted.to_a %>
             <p><%= link_to l(:label_member_new), new_project_membership_path(@project), :remote => true, :class => "icon icon-add" %></p>
             <% if members.any? %>
             <table class="list members">
               <thead>
                 <tr>
                   <th><%= l(:label_user) %> / <%= l(:label_group) %></th>
                   <th><%= l(:label_role_plural) %></th>
                   <th style="width:15%"></th>
                   <%= call_hook(:view_projects_settings_members_table_header, :project => @project) %>
                 </tr>
               </thead>
               <tbody>
               <% members.each do |member| %>
               <% next if member.new_record? %>
               <tr id="member-<%= member.id %>" class="<%= cycle 'odd', 'even' %> member">
               <td class="name icon icon-<%= member.principal.class.name.downcase %>"><%= link_to_user member.principal %></td>
               <td class="roles">
                 <span id="member-<%= member.id %>-roles"><%= member.roles.sort.collect(&:to_s).join(', ') %></span>
                   <%= form_for(member,
                                {:as => :membership, :remote => true,
                                 :url => membership_path(member),
                                 :method => :put,
                                 :html => { :id => "member-#{member.id}-roles-form", :class => 'hol' }}
                          ) do |f| %>
                     <p>
                       <% roles.each do |role| %>
                       <label>
                         <%= check_box_tag('membership[role_ids][]',
                                           role.id, member.roles.include?(role),
                                           :id => nil,
                                           :disabled => !member.role_editable?(role)) %> <%= role %>
                       </label><br />
                       <% end %>
                     </p>
                     <%= hidden_field_tag 'membership[role_ids][]', '', :id => nil %>
                     <p>
                       <%= submit_tag l(:button_save), :class => "small" %>
                       <%= link_to_function(l(:button_cancel),
                                            "$('#member-#{member.id}-roles').show(); $('#member-#{member.id}-roles-form').hide(); return false;") %>
                     </p>
                   <% end %>
               </td>
               <td class="buttons">
                   <%= link_to_function l(:button_edit),
                                        "$('#member-#{member.id}-roles').hide(); $('#member-#{member.id}-roles-form').show(); return false;",
                                        :class => 'icon icon-edit' %>
                   <%= delete_link membership_path(member),
                                   :remote => true,
                                   :data => (!User.current.admin? && member.include?(User.current) ? {:confirm => l(:text_own_membership_delete_confirmation)} : {}) if member.deletable? %>
               </td>
               <%= call_hook(:view_projects_settings_members_table_row, { :project => @project, :member => member}) %>
               </tr>
             <% end; reset_cycle %>
               </tbody>
             </table>
             <% else %>
             <p class="nodata"><%= l(:label_no_data) %></p>
             <% end %>

test/unit/member_test.rb +6 0

             # Redmine - project management software
             # Copyright (C) 2006-2016  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 MemberTest < ActiveSupport::TestCase
               fixtures :projects, :trackers, :issue_statuses, :issues,
                        :enumerations, :users, :issue_categories,
                        :projects_trackers,
                        :roles,
                        :member_roles,
                        :members,
                        :enabled_modules,
                        :groups_users,
                        :watchers,
                        :journals, :journal_details,
                        :messages,
                        :wikis, :wiki_pages, :wiki_contents, :wiki_content_versions,
                        :boards
               include Redmine::I18n
               def setup
                 @jsmith = Member.find(1)
               end
+              def test_sorted_scope_on_project_members
+                members = Project.find(1).members.sorted.to_a
+                roles = members.map {|m| m.roles.sort.first}
+                assert_equal roles, roles.sort
+              end
               def test_create
                 member = Member.new(:project_id => 1, :user_id => 4, :role_ids => [1, 2])
                 assert member.save
                 member.reload
                 assert_equal 2, member.roles.size
                 assert_equal Role.find(1), member.roles.sort.first
               end
               def test_update
                 assert_equal "eCookbook", @jsmith.project.name
                 assert_equal "Manager", @jsmith.roles.first.name
                 assert_equal "jsmith", @jsmith.user.login
                 @jsmith.mail_notification = !@jsmith.mail_notification
                 assert @jsmith.save
               end
               def test_update_roles
                 assert_equal 1, @jsmith.roles.size
                 @jsmith.role_ids = [1, 2]
                 assert @jsmith.save
                 assert_equal 2, @jsmith.reload.roles.size
               end
               def test_validate
                 member = Member.new(:project_id => 1, :user_id => 2, :role_ids => [2])
                 # same use cannot have more than one membership for a project
                 assert !member.save
                 # must have one role at least
                 user = User.new(:firstname => "new1", :lastname => "user1",
                                 :mail => "test_validate@somenet.foo")
                 user.login = "test_validate"
                 user.password, user.password_confirmation = "password", "password"
                 assert user.save
                 set_language_if_valid 'fr'
                 member = Member.new(:project_id => 1, :user_id => user.id, :role_ids => [])
                 assert !member.save
                 assert_include I18n.translate('activerecord.errors.messages.empty'), member.errors[:role]
                 assert_equal "R\xc3\xb4le doit \xc3\xaatre renseign\xc3\xa9(e)".force_encoding('UTF-8'),
                   [member.errors.full_messages].flatten.join
               end
               def test_validate_member_role
                 user = User.new(:firstname => "new1", :lastname => "user1",
                                 :mail => "test_validate@somenet.foo")
                 user.login = "test_validate_member_role"
                 user.password, user.password_confirmation = "password", "password"
                 assert user.save
                 member = Member.new(:project_id => 1, :user_id => user.id, :role_ids => [5])
                 assert !member.save
               end
               def test_set_issue_category_nil_should_handle_nil_values
                 m = Member.new
                 assert_nil m.user
                 assert_nil m.project
                 assert_nothing_raised do
                   m.set_issue_category_nil
                 end
               end
               def test_destroy
                 category1 = IssueCategory.find(1)
                 assert_equal @jsmith.user.id, category1.assigned_to_id
                 assert_difference 'Member.count', -1 do
                   assert_difference 'MemberRole.count', -1 do
                     @jsmith.destroy
                   end
                 end
                 assert_raise(ActiveRecord::RecordNotFound) { Member.find(@jsmith.id) }
                 category1.reload
                 assert_nil category1.assigned_to_id
               end
               def test_destroy_should_trigger_callbacks_only_once
                 Member.class_eval { def destroy_test_callback; end}
                 Member.after_destroy :destroy_test_callback
                 m = Member.create!(:user_id => 1, :project_id => 1, :role_ids => [1,3])
                 Member.any_instance.expects(:destroy_test_callback).once
                 assert_difference 'Member.count', -1 do
                   assert_difference 'MemberRole.count', -2 do
                     m.destroy
                   end
                 end
                 assert m.destroyed?
               ensure
                 Member._destroy_callbacks.delete(:destroy_test_callback)
               end
               def test_roles_should_be_unique
                 m = Member.new(:user_id => 1, :project_id => 1)
                 m.member_roles.build(:role_id => 1)
                 m.member_roles.build(:role_id => 1)
                 m.save!
                 m.reload
                 assert_equal 1, m.roles.count
                 assert_equal [1], m.roles.ids
               end
               def test_sort_without_roles
                 a = Member.new(:roles => [Role.first])
                 b = Member.new
                 assert_equal -1, a <=> b
                 assert_equal 1,  b <=> a
               end
               def test_sort_without_principal
                 role = Role.first
                 a = Member.new(:roles => [role], :principal => User.first)
                 b = Member.new(:roles => [role])
                 assert_equal -1, a <=> b
                 assert_equal 1,  b <=> a
               end
               def test_managed_roles_should_return_all_roles_for_role_with_all_roles_managed
                 member = Member.new
                 member.roles << Role.generate!(:permissions => [:manage_members], :all_roles_managed => true)
                 assert_equal Role.givable.all, member.managed_roles
               end
               def test_managed_roles_should_return_all_roles_for_admins
                 member = Member.new(:user => User.find(1))
                 member.roles << Role.generate!
                 assert_equal Role.givable.all, member.managed_roles
               end
               def test_managed_roles_should_return_limited_roles_for_role_without_all_roles_managed
                 member = Member.new
                 member.roles << Role.generate!(:permissions => [:manage_members], :all_roles_managed => false, :managed_role_ids => [2, 3])
                 assert_equal [2, 3], member.managed_roles.map(&:id).sort
               end
               def test_managed_roles_should_cumulated_managed_roles
                 member = Member.new
                 member.roles << Role.generate!(:permissions => [:manage_members], :all_roles_managed => false, :managed_role_ids => [3])
                 member.roles << Role.generate!(:permissions => [:manage_members], :all_roles_managed => false, :managed_role_ids => [2])
                 assert_equal [2, 3], member.managed_roles.map(&:id).sort
               end
               def test_managed_roles_should_return_no_roles_for_role_without_permission
                 member = Member.new
                 member.roles << Role.generate!(:all_roles_managed => true)
                 assert_equal [], member.managed_roles
               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