Organization Ratings improvements

- adds rejected status message for ratings - adds ratings count to be displayed on average ratings block - adds tests to new features and fixed old ones Signed-off-by: Tallys Martins <tallysmartins@gmail.com> Signed-off-by: Gabriel Silva <grabriel93.silva@gmail.com> (cherry picked from commit c30065be6679c968b9c9edfca2bd60e428588a1e)

Organization Ratings improvements
- adds rejected status message for ratings - adds ratings count to be displayed on average ratings block - adds tests to new features and fixed old ones Signed-off-by: Tallys Martins <tallysmartins@gmail.com> Signed-off-by: Gabriel Silva <grabriel93.silva@gmail.com> (cherry picked from commit c30065be6679c968b9c9edfca2bd60e428588a1e)
Tallys Martins · Marcos Pereira
1 parent 67887fc5
Showing 11 changed files with 138 additions and 56 deletions Show diff stats
plugins/organization_ratings/features/rate_community.feature
plugins/organization_ratings/lib/organization_rating.rb
plugins/organization_ratings/lib/ratings_helper.rb
plugins/organization_ratings/public/style.css
plugins/organization_ratings/test/functional/organization_ratings_plugin_profile_controller_test.rb
plugins/organization_ratings/test/unit/organization_rating_test.rb
plugins/organization_ratings/test/unit/ratings_helper_test.rb
plugins/organization_ratings/views/blocks/display_organization_average_rating.html.erb
plugins/organization_ratings/views/blocks/organization_ratings_block.html.erb
plugins/organization_ratings/views/organization_ratings_plugin_profile/new_rating.html.erb
plugins/organization_ratings/views/shared/_user_rating_container.html.erb
@@ -19,7 +19,7 @@ Feature: rate_community
     And I am logged in as "joaosilva"
   @selenium
-  Scenario: display rate button inside average block
+  Scenario: display rate button and total ratings inside average block
     Given I am on mycommunity's homepage
     Then I should see "Rate this Community" within ".average-rating-block"
     And I should see "Be the first to rate" within ".average-rating-block"
@@ -34,3 +34,9 @@ Feature: rate_community
     When I follow "Rate this Community"
     Then I should see "Joao Silva" within ".star-profile-name"
     And I should see Joao Silva's profile image
+
+  Scenario: display total ratings inside average block
+    Given I am on mycommunity's homepage
+    When I follow "Rate this Community"
+    Then I follow "Save"
+    Then I should see "(1)" within ".total-ratings"
@@ -13,25 +13,26 @@ class OrganizationRating &lt; ActiveRecord::Base
   validates :organization_id, :person_id,
             :presence => true
-  def display_moderation_message person
-    if person.present?
-      task_active? && (person.is_admin? || person == self.person ||
+  def display_full_info_to? person
+      (person.is_admin? || person == self.person ||
       self.organization.is_admin?(person))
-    end
   end
-  def task_active?
-    tasks = CreateOrganizationRatingComment.where(:target_id => self.organization.id,
-                                                  :status => Task::Status::ACTIVE)
-    tasks.detect {|t| t.organization_rating_id == self.id}.present?
+  def task_status
+    tasks = CreateOrganizationRatingComment.where(:target_id => self.organization.id, :requestor_id => self.person.id)
+    task = tasks.detect{ |t| t.organization_rating_id == self.id }
+    task.status if task.present?
   end
-  def self.average_rating organization_id
-    average = OrganizationRating.where(organization_id: organization_id).average(:value)
+  def self.statistics_for_profile organization
+    ratings = OrganizationRating.where(organization_id: organization)
+    average = ratings.average(:value)
+    total = ratings.size
     if average
-      (average - average.truncate) >= 0.5 ? average.ceil : average.floor
+      average = (average - average.truncate) >= 0.5 ? average.ceil : average.floor
     end
+    { average: average, total: total }
   end
 end
@@ -12,4 +12,14 @@ module RatingsHelper
       ratings = OrganizationRating.where(organization_id: profile_id).order("created_at DESC")
     end
   end
-end
 \ No newline at end of file
+
+  def status_message_for(person, rating)
+    if person.present? && rating.display_full_info_to?(person)
+      if(rating.task_status == Task::Status::ACTIVE)
+        content_tag(:p, _("Report waiting for approval"), class: "moderation-msg")
+      elsif(rating.task_status == Task::Status::CANCELLED)
+        content_tag(:p, _("Report rejected"), class: "rejected-msg")
+      end
+    end
+  end
+end
 .star-container {
   width: 100%;
-  height: 20px;
+  height: 22px;
 }
 .star-negative, .star-positive {
@@ -80,7 +80,16 @@
 .organization-average-rating-container .star-container {
   float: left;
-  width: 120px;
+  display: inline-flex;
+  width: auto;
+  max-width: 190px;
+
+}
+
+.total-ratings {
+  font-size: 16px;
+  margin-left: 5px;
+  margin-right: 5px;
 }
 .organization-average-rating-container .rate-this-organization {
@@ -188,4 +188,24 @@ class OrganizationRatingsPluginProfileControllerTest &lt; ActionController::TestCas
     assert_no_tag :tag => 'p', :content => /Report waiting for approva/, :attributes => {:class =>/comment-rejected-msg/}
     assert_tag :tag => 'p', :content => /comment accepted/, :attributes => {:class =>/comment-body/}
   end
+
+  test "should display ratings count in average block" do
+    average_block = AverageRatingBlock.new
+    average_block.box = @community.boxes.find_by_position(1)
+    average_block.save!
+
+    OrganizationRating.stubs(:statistics_for_profile).returns({:average => 5, :total => 42})
+    get :new_rating, profile: @community.identifier
+    assert_tag :tag => 'a', :content => /\(42\)/
+  end
+
+  test "should display maximum ratings count in average block" do
+    average_block = AverageRatingBlock.new
+    average_block.box = @community.boxes.find_by_position(1)
+    average_block.save!
+
+    OrganizationRating.stubs(:statistics_for_profile).returns({:average => 5, :total => 999000})
+    get :new_rating, profile: @community.identifier
+    assert_tag :tag => 'a', :content => /\(10000\+\)/
+  end
 end
@@ -35,55 +35,36 @@ class OrganizationRatingTest &lt; ActiveSupport::TestCase
     assert_equal false, organization_rating2.errors[:value].include?("must be between 1 and 5")
   end
-  test "false return when no active tasks for an Organization Rating" do
-    assert_not @rating.task_active?
-  end
-
-  test "true return when an active task exists for an Organization Rating" do
+  test "return rating task status" do
     CreateOrganizationRatingComment.create!(
                       :organization_rating_id => @rating.id,
                       :target => @community,
                       :requestor => @person)
-    assert_equal Task::Status::ACTIVE, CreateOrganizationRatingComment.last.status
-    assert @rating.task_active?
+    assert_equal Task::Status::ACTIVE, @rating.task_status
   end
-  test "return false when an cancelled task exists for an Organization Rating" do
+  test "return rating task status when task is cancelled" do
     CreateOrganizationRatingComment.create!(
                       :organization_rating_id => @rating.id,
                       :target => @community,
                       :requestor => @person)
     CreateOrganizationRatingComment.last.cancel
-    assert_not @rating.task_active?
+    assert_equal Task::Status::CANCELLED, @rating.task_status
   end
-  test "display report moderation message to community admin" do
-    moderator = create_user('moderator')
-    @community.add_admin(moderator.person)
-    @rating.stubs(:task_active?).returns(true)
-    assert @rating.display_moderation_message(@adminuser)
+  test "should display full info to admin" do
+    @person.stubs(:is_admin?).returns(true)
+    assert @rating.display_full_info_to?(@person)
   end
-  test "display report moderation message to owner" do
-    @rating.stubs(:task_active?).returns(true)
-    assert @rating.display_moderation_message(@person)
+  test "should display full info to owner" do
+    assert @rating.display_full_info_to?(@person)
   end
-  test "do not display report moderation message to regular user" do
+  test "should not display full info to regular user" do
     regular_person = fast_create(Person)
-    @rating.stubs(:task_active?).returns(true)
-    assert_not @rating.display_moderation_message(regular_person)
-  end
-
-  test "do not display report moderation message to not logged user" do
-    @rating.stubs(:task_active?).returns(true)
-    assert_not @rating.display_moderation_message(nil)
-  end
-
-  test "do not display report moderation message no active task exists" do
-    @rating.stubs(:task_active?).returns(false)
-    assert_not @rating.display_moderation_message(@person)
+    assert_not @rating.display_full_info_to?(regular_person)
   end
   test "Create task for create a rating comment" do
@@ -109,7 +90,7 @@ class OrganizationRatingTest &lt; ActiveSupport::TestCase
     assert community.tasks.include?(create_organization_rating_comment)
   end
-  test "Should calculate community's rating average" do
+  test "Should calculate community's rating statistics" do
     community = fast_create Community
     p1 = fast_create Person, :name=>"Person 1"
     p2 = fast_create Person, :name=>"Person 2"
@@ -119,11 +100,13 @@ class OrganizationRatingTest &lt; ActiveSupport::TestCase
     OrganizationRating.create! :value => 3, :organization => community, :person => p2
     OrganizationRating.create! :value => 5, :organization => community, :person => p3
-    assert_equal 3, OrganizationRating.average_rating(community)
+    assert_equal 3, OrganizationRating.statistics_for_profile(community)[:average]
+    assert_equal 3, OrganizationRating.statistics_for_profile(community)[:total]
     p4 = fast_create Person, :name=>"Person 4"
     OrganizationRating.create! :value => 4, :organization => community, :person => p4
-    assert_equal 4, OrganizationRating.average_rating(community)
+    assert_equal 4, OrganizationRating.statistics_for_profile(community)[:average]
+    assert_equal 4, OrganizationRating.statistics_for_profile(community)[:total]
   end
 end
@@ -3,6 +3,7 @@ require &#39;ratings_helper&#39;
 class RatingsHelperTest < ActiveSupport::TestCase
   include RatingsHelper
+  include ActionView::Helpers::TagHelper
   def setup
@@ -12,6 +13,12 @@ class RatingsHelperTest &lt; ActiveSupport::TestCase
     @person = create_user('testuser').person
     @community = Community.create(:name => "TestCommunity")
     @organization_ratings_config = OrganizationRatingsConfig.instance
+    @rating = fast_create(OrganizationRating, {:value => 1,
+                                               :person_id => @person.id,
+                                               :organization_id => @community.id,
+                                               :created_at => DateTime.now,
+                                               :updated_at => DateTime.now,
+                                              })
   end
   should "get the ratings of a community ordered by most recent ratings" do
@@ -32,6 +39,7 @@ class RatingsHelperTest &lt; ActiveSupport::TestCase
     ratings_array << most_recent_rating
     ratings_array << first_rating
+    ratings_array << @rating
     assert_equal @organization_ratings_config.order, "recent"
     assert_equal ratings_array, get_ratings(@community.id)
@@ -57,7 +65,42 @@ class RatingsHelperTest &lt; ActiveSupport::TestCase
     ratings_array << second_rating
     ratings_array << first_rating
+    ratings_array << @rating
     assert_equal ratings_array, get_ratings(@community.id)
   end
+
+  test "display report moderation message to community admin" do
+    @moderator = create_user('moderator').person
+    @community.add_admin(@moderator)
+    @rating.stubs(:task_status).returns(Task::Status::ACTIVE)
+    assert status_message_for(@moderator, @rating).include?("Report waiting for approval")
+  end
+
+  test "display report moderation message to owner" do
+    @rating.stubs(:task_status).returns(Task::Status::ACTIVE)
+    assert status_message_for(@person, @rating).include?("Report waiting for approval")
+  end
+
+  test "display report rejected message to owner" do
+    @rating.stubs(:task_status).returns(Task::Status::CANCELLED)
+    assert status_message_for(@person, @rating).include?("Report rejected")
+  end
+
+  test "do not display report moderation message to regular user" do
+    @regular_person = fast_create(Person)
+    @rating.stubs(:task_status).returns(Task::Status::ACTIVE)
+    assert_nil status_message_for(@regular_person, @rating)
+  end
+
+  test "return empty status message to not logged user" do
+    @rating.stubs(:task_status).returns(Task::Status::ACTIVE)
+    assert_nil status_message_for(nil, @rating)
+  end
+
+  test "do not display status message if report task is finished" do
+    @rating.stubs(:task_status).returns(Task::Status::FINISHED)
+    assert_nil status_message_for(@person, @rating)
+  end
+
 end
+<% statistics = OrganizationRating.statistics_for_profile block.owner %>
+
 <div class="organization-average-rating-container">
-  <% if average_rating %>
+  <% if statistics[:average] %>
     <div class="star-rate-text">
       <%= _("Rating: ") %>
     </div>
     <div class="star-container">
       <% (1..5).each do |star_number| %>
-        <% if star_number <= average_rating %>
+        <% if star_number <= statistics[:average] %>
           <div class="medium-star-positive"></div>
         <% else %>
           <div class="medium-star-negative"></div>
         <% end %>
       <% end %>
+      <div class="total-ratings">
+        <%= link_to url_for(:controller => 'organization_ratings_plugin_profile', :action => 'new_rating', :anchor => 'ratings-list') do %>
+          <% if(statistics[:total] > 10000) %>
+            <%= "(10000+)" %>
+          <% else %>
+            <%= "(#{statistics[:total]})" %>
+          <% end %>
+        <% end %>
+      </div>
     </div>
   <% else %>
     <div class="rating-invitation">
@@ -22,4 +33,4 @@
   <div class="rate-this-organization">
     <%= link_to _("Rate this %s") % _(profile.class.name), url_for(:controller => "organization_ratings_plugin_profile", :action => "new_rating", :profile=>profile_identifier) %>
   </div>
-</div>
 \ No newline at end of file
+</div>
@@ -14,7 +14,7 @@
       <%= render :partial => 'shared/make_report_block' %>
       <div class="see-more">
-        <%= link_to _('See more'), url_for(:controller => 'organization_ratings_plugin_profile', :action => 'new_rating'), :class => 'icon-arrow-right-p' %>
+        <%= link_to _('See more'), url_for(:controller => 'organization_ratings_plugin_profile', :action => 'new_rating', :anchor => 'ratings-list'), :class => 'icon-arrow-right-p' %>
       </div>
     </div>
   <% end %>
@@ -9,7 +9,7 @@
   </div>
 <% end %>
-<div class="ratings-list">
+<div class="ratings-list" id="ratings-list">
   <% @users_ratings.each do |user_rate| %>
     <%= render :partial => "shared/user_rating_container", :locals => {:user_rate => user_rate} %>
   <% end %>
+<% extend RatingsHelper %>
 <div class="user-rating-block">
   <div class="star-profile-information">
     <div class="star-profile-image">
@@ -25,9 +26,7 @@
     </div>
     <div class="user-testimony">
-      <% if user_rate.display_moderation_message(user) %>
-        <p class="moderation-msg"><%= _("Report waiting for approval") %></p>
-      <% end %>
+      <%= status_message_for(user, user_rate) %>
       <% if user_rate.comment.present? %>
         <p class="comment-body"> <%= user_rate.comment.body %> </p>
       <% end %>
	@@ -12,4 +12,14 @@ module RatingsHelper		@@ -12,4 +12,14 @@ module RatingsHelper
12	ratings = OrganizationRating.where(organization_id: profile_id).order("created_at DESC")	12	ratings = OrganizationRating.where(organization_id: profile_id).order("created_at DESC")
13	end	13	end
14	end	14	end
15	-end
16	\ No newline at end of file	15	\ No newline at end of file
		16	+
		17	+ def status_message_for(person, rating)
		18	+ if person.present? && rating.display_full_info_to?(person)
		19	+ if(rating.task_status == Task::Status::ACTIVE)
		20	+ content_tag(:p, _("Report waiting for approval"), class: "moderation-msg")
		21	+ elsif(rating.task_status == Task::Status::CANCELLED)
		22	+ content_tag(:p, _("Report rejected"), class: "rejected-msg")
		23	+ end
		24	+ end
		25	+ end
		26	+end
	@@ -188,4 +188,24 @@ class OrganizationRatingsPluginProfileControllerTest < ActionController::TestCas		@@ -188,4 +188,24 @@ class OrganizationRatingsPluginProfileControllerTest < ActionController::TestCas
188	assert_no_tag :tag => 'p', :content => /Report waiting for approva/, :attributes => {:class =>/comment-rejected-msg/}	188	assert_no_tag :tag => 'p', :content => /Report waiting for approva/, :attributes => {:class =>/comment-rejected-msg/}
189	assert_tag :tag => 'p', :content => /comment accepted/, :attributes => {:class =>/comment-body/}	189	assert_tag :tag => 'p', :content => /comment accepted/, :attributes => {:class =>/comment-body/}
190	end	190	end
		191	+
		192	+ test "should display ratings count in average block" do
		193	+ average_block = AverageRatingBlock.new
		194	+ average_block.box = @community.boxes.find_by_position(1)
		195	+ average_block.save!
		196	+
		197	+ OrganizationRating.stubs(:statistics_for_profile).returns({:average => 5, :total => 42})
		198	+ get :new_rating, profile: @community.identifier
		199	+ assert_tag :tag => 'a', :content => /\(42\)/
		200	+ end
		201	+
		202	+ test "should display maximum ratings count in average block" do
		203	+ average_block = AverageRatingBlock.new
		204	+ average_block.box = @community.boxes.find_by_position(1)
		205	+ average_block.save!
		206	+
		207	+ OrganizationRating.stubs(:statistics_for_profile).returns({:average => 5, :total => 999000})
		208	+ get :new_rating, profile: @community.identifier
		209	+ assert_tag :tag => 'a', :content => /\(10000\+\)/
		210	+ end
191	end	211	end
	@@ -3,6 +3,7 @@ require 'ratings_helper'		@@ -3,6 +3,7 @@ require 'ratings_helper'
3		3
4	class RatingsHelperTest < ActiveSupport::TestCase	4	class RatingsHelperTest < ActiveSupport::TestCase
5	include RatingsHelper	5	include RatingsHelper
		6	+ include ActionView::Helpers::TagHelper
6		7
7	def setup	8	def setup
8		9
	@@ -12,6 +13,12 @@ class RatingsHelperTest < ActiveSupport::TestCase		@@ -12,6 +13,12 @@ class RatingsHelperTest < ActiveSupport::TestCase
12	@person = create_user('testuser').person	13	@person = create_user('testuser').person
13	@community = Community.create(:name => "TestCommunity")	14	@community = Community.create(:name => "TestCommunity")
14	@organization_ratings_config = OrganizationRatingsConfig.instance	15	@organization_ratings_config = OrganizationRatingsConfig.instance
		16	+ @rating = fast_create(OrganizationRating, {:value => 1,
		17	+ :person_id => @person.id,
		18	+ :organization_id => @community.id,
		19	+ :created_at => DateTime.now,
		20	+ :updated_at => DateTime.now,
		21	+ })
15	end	22	end
16		23
17	should "get the ratings of a community ordered by most recent ratings" do	24	should "get the ratings of a community ordered by most recent ratings" do
	@@ -32,6 +39,7 @@ class RatingsHelperTest < ActiveSupport::TestCase		@@ -32,6 +39,7 @@ class RatingsHelperTest < ActiveSupport::TestCase
32		39
33	ratings_array << most_recent_rating	40	ratings_array << most_recent_rating
34	ratings_array << first_rating	41	ratings_array << first_rating
		42	+ ratings_array << @rating
35		43
36	assert_equal @organization_ratings_config.order, "recent"	44	assert_equal @organization_ratings_config.order, "recent"
37	assert_equal ratings_array, get_ratings(@community.id)	45	assert_equal ratings_array, get_ratings(@community.id)
	@@ -57,7 +65,42 @@ class RatingsHelperTest < ActiveSupport::TestCase		@@ -57,7 +65,42 @@ class RatingsHelperTest < ActiveSupport::TestCase
57		65
58	ratings_array << second_rating	66	ratings_array << second_rating
59	ratings_array << first_rating	67	ratings_array << first_rating
		68	+ ratings_array << @rating
60		69
61	assert_equal ratings_array, get_ratings(@community.id)	70	assert_equal ratings_array, get_ratings(@community.id)
62	end	71	end
		72	+
		73	+ test "display report moderation message to community admin" do
		74	+ @moderator = create_user('moderator').person
		75	+ @community.add_admin(@moderator)
		76	+ @rating.stubs(:task_status).returns(Task::Status::ACTIVE)
		77	+ assert status_message_for(@moderator, @rating).include?("Report waiting for approval")
		78	+ end
		79	+
		80	+ test "display report moderation message to owner" do
		81	+ @rating.stubs(:task_status).returns(Task::Status::ACTIVE)
		82	+ assert status_message_for(@person, @rating).include?("Report waiting for approval")
		83	+ end
		84	+
		85	+ test "display report rejected message to owner" do
		86	+ @rating.stubs(:task_status).returns(Task::Status::CANCELLED)
		87	+ assert status_message_for(@person, @rating).include?("Report rejected")
		88	+ end
		89	+
		90	+ test "do not display report moderation message to regular user" do
		91	+ @regular_person = fast_create(Person)
		92	+ @rating.stubs(:task_status).returns(Task::Status::ACTIVE)
		93	+ assert_nil status_message_for(@regular_person, @rating)
		94	+ end
		95	+
		96	+ test "return empty status message to not logged user" do
		97	+ @rating.stubs(:task_status).returns(Task::Status::ACTIVE)
		98	+ assert_nil status_message_for(nil, @rating)
		99	+ end
		100	+
		101	+ test "do not display status message if report task is finished" do
		102	+ @rating.stubs(:task_status).returns(Task::Status::FINISHED)
		103	+ assert_nil status_message_for(@person, @rating)
		104	+ end
		105	+
63	end	106	end
	@@ -14,7 +14,7 @@		@@ -14,7 +14,7 @@
14	<%= render :partial => 'shared/make_report_block' %>	14	<%= render :partial => 'shared/make_report_block' %>
15		15
16	<div class="see-more">	16	<div class="see-more">
17	- <%= link_to _('See more'), url_for(:controller => 'organization_ratings_plugin_profile', :action => 'new_rating'), :class => 'icon-arrow-right-p' %>	17	+ <%= link_to _('See more'), url_for(:controller => 'organization_ratings_plugin_profile', :action => 'new_rating', :anchor => 'ratings-list'), :class => 'icon-arrow-right-p' %>
18	</div>	18	</div>
19	</div>	19	</div>
20	<% end %>	20	<% end %>
	@@ -9,7 +9,7 @@		@@ -9,7 +9,7 @@
9	</div>	9	</div>
10	<% end %>	10	<% end %>
11		11
12	-<div class="ratings-list">	12	+<div class="ratings-list" id="ratings-list">
13	<% @users_ratings.each do \|user_rate\| %>	13	<% @users_ratings.each do \|user_rate\| %>
14	<%= render :partial => "shared/user_rating_container", :locals => {:user_rate => user_rate} %>	14	<%= render :partial => "shared/user_rating_container", :locals => {:user_rate => user_rate} %>
15	<% end %>	15	<% end %>