Merge pull request #788 from citizensadvice/overall-scores-2-decimal-places

chore/Update decimal places display for scores

Author: KPobeeNorris

app/components/csr_table/score_component.rb

@@ -2,10 +2,12 @@
 
 module CsrTable
   class ScoreComponent < ViewComponent::Base
-    def initialize(score:, show_decimal_score: false)
+    def initialize(score:, show_decimal_score: false, decimal_places: 1, highlight_stars: false)
       super()
       @score = score
       @show_decimal_score = show_decimal_score
+      @decimal_places = decimal_places
+      @highlight_stars = highlight_stars
     end
 
     def render?
@@ -23,8 +25,7 @@ def show_decimal_score?
     end
 
     def highlight_stars?
-      # We only highlight the stars when a decimal score is displayed
-      show_decimal_score?
+      @highlight_stars
     end
 
     def scored?
@@ -36,13 +37,11 @@ def score_text
     end
 
     def score_out_of_five
-      return "#{score_number} out of 5" unless show_decimal_score?
-
       "#{score_number} out of 5"
     end
 
     def score_number
-      show_decimal_score? ? @score.round(1) : @score.round
+      show_decimal_score? ? format("%.#{@decimal_places}f", @score) : @score.round
     end
   end
 end

app/components/csr_table/score_summary_component.html.haml

@@ -7,19 +7,19 @@
     %li.score-summary__item
       %p.score-summary__text
         Overall rating
-      = render CsrTable::ScoreComponent.new(score: supplier.overall_rating, show_decimal_score: true)
+      = render CsrTable::ScoreComponent.new(score: supplier.overall_rating, show_decimal_score: true, decimal_places: 2, highlight_stars: true)
     %li.score-summary__item
       %p.score-summary__text
         Fewer complaints received
-      = render CsrTable::ScoreComponent.new(score: supplier.complaints_rating)
+      = render CsrTable::ScoreComponent.new(score: supplier.complaints_rating, show_decimal_score: true)
     %li.score-summary__item
       %p.score-summary__text
         Contact waiting time
-      = render CsrTable::ScoreComponent.new(score: supplier.contact_rating)
+      = render CsrTable::ScoreComponent.new(score: supplier.contact_rating, show_decimal_score: true)
     %li.score-summary__item
       %p.score-summary__text
         Billing and metering
-      = render CsrTable::ScoreComponent.new(score: supplier.bill_accuracy_and_metering_rating)
+      = render CsrTable::ScoreComponent.new(score: supplier.bill_accuracy_and_metering_rating, show_decimal_score: true)
     %li.score-summary__item
       %p.score-summary__text
         Customer commitments

app/components/csr_table/supplier_table_row_component.html.haml

@@ -10,13 +10,13 @@
       = render_overall_score
   %td.supplier-table__complaints
     .cads-table__content
-      = render CsrTable::ScoreComponent.new(score: supplier.complaints_rating)
+      = render CsrTable::ScoreComponent.new(score: supplier.complaints_rating, show_decimal_score: true)
   %td.supplier-table__response
     .cads-table__content
-      = render CsrTable::ScoreComponent.new(score: supplier.contact_rating)
+      = render CsrTable::ScoreComponent.new(score: supplier.contact_rating, show_decimal_score: true)
   %td.supplier-table__billing
     .cads-table__content
-      = render CsrTable::ScoreComponent.new(score: supplier.bill_accuracy_and_metering_rating)
+      = render CsrTable::ScoreComponent.new(score: supplier.bill_accuracy_and_metering_rating, show_decimal_score: true)
   %td.supplier-table__guarantee
     .cads-table__content
       = render CsrTable::ScoreComponent.new(score: supplier.guarantee_rating)

app/components/csr_table/supplier_table_row_component.rb

@@ -28,10 +28,12 @@ def row_classes
 
     def render_overall_score
       if highlight?
-        render CsrTable::ScoreComponent.new(score: supplier.overall_rating, show_decimal_score: true)
+        render CsrTable::ScoreComponent.new(score: supplier.overall_rating, show_decimal_score: true, decimal_places: 2,
+                                            highlight_stars: true)
       else
         render CsrTable::ScoreComponent.new(score: supplier.overall_rating,
-                                            show_decimal_score: true).with_content(more_details_link)
+                                            show_decimal_score: true, decimal_places: 2,
+                                            highlight_stars: true).with_content(more_details_link)
       end
     end
 

spec/components/csr_table/score_component_spec.rb

@@ -7,9 +7,14 @@
 
   let(:score) { 3 }
   let(:show_decimal_score) { nil }
+  let(:decimal_places) { 1 }
+  let(:highlight_stars) { false }
 
   before do
-    render_inline described_class.new(score: score.presence, show_decimal_score: show_decimal_score.presence)
+    render_inline described_class.new(score: score.presence,
+                                      show_decimal_score: show_decimal_score.presence,
+                                      decimal_places: decimal_places.presence,
+                                      highlight_stars: highlight_stars)
   end
 
   it { is_expected.to have_text "3 out of 5" }
@@ -39,12 +44,34 @@
     it { is_expected.to have_no_css ".stars" }
   end
 
+  context "when the score highlights the stars" do
+    let(:highlight_stars) { true }
+
+    it { is_expected.to have_css ".stars" }
+    it { is_expected.to have_css ".stars--highlight" }
+  end
+
   context "when the score is shown as a decimal" do
     let(:score) { 1.2 }
     let(:show_decimal_score) { true }
 
-    it { is_expected.to have_text "1.2 out of 5" }
-    it { is_expected.to have_css ".stars--highlight" }
+    context "when the decimal_places is set to 1" do
+      it { is_expected.to have_text "1.2 out of 5" }
+    end
+
+    context "when decimal_places is set to 2" do
+      let(:decimal_places) { 2 }
+
+      context "when there is a single decimal digit" do
+        it { is_expected.to have_text "1.20 out of 5" }
+      end
+
+      context "when there are two decimal digits" do
+        let(:score) { 1.23 }
+
+        it { is_expected.to have_text "1.23 out of 5" }
+      end
+    end
   end
 
   context "when content is provided" do