Merge pull request #12971 from Entropy-rgb/7388/fix/use_i18n_instead_of_manual

Fix #7388: use ungettext() for rating pluralization in star rating macros

Author: cdrini

openlibrary/core/helpers.py

@@ -39,6 +39,7 @@
     "days_since",
     "extract_year",
     "format_date",
+    "format_decimal",
     "json_encode",
     "parse_datetime",  # function imported from elsewhere
     "percentage",
@@ -199,6 +200,16 @@ def commify(number, lang=None):
         return str(number)
 
 
+def format_decimal(number, decimal_places=1, lang=None):
+    """Locale-aware decimal number formatting."""
+    try:
+        lang = lang or web.ctx.get("lang") or "en"
+        fmt = "#,##0." + "0" * decimal_places
+        return babel.numbers.format_decimal(number, format=fmt, locale=lang)
+    except Exception:
+        return str(round(number, decimal_places))
+
+
 def truncate(text: str, limit: int) -> str:
     """Truncate text and add ellipses if it longer than specified limit."""
     if not text:

openlibrary/i18n/messages.pot

@@ -936,8 +936,10 @@ msgstr ""
 
 #: trending.html
 #, python-format
-msgid "Logged %(count)i times %(time_unit)s"
-msgstr ""
+msgid "Logged %(count)i time %(time_unit)s"
+msgid_plural "Logged %(count)i times %(time_unit)s"
+msgstr[0] ""
+msgstr[1] ""
 
 #: verify_human.html
 msgid "Human Verification"
@@ -8120,14 +8122,6 @@ msgstr ""
 msgid "Clear my rating"
 msgstr ""
 
-#: StarRatingsByline.html StarRatingsComponent.html
-msgid "rating"
-msgstr ""
-
-#: StarRatingsByline.html StarRatingsComponent.html
-msgid "ratings"
-msgstr ""
-
 #. Shows the count of readers who added this book to their "Want to read"
 #. shelf, displayed on search result pages. %(want_to_read_count)s is a
 #. formatted integer (may include commas as thousands separators). Example:
@@ -8139,8 +8133,10 @@ msgstr ""
 
 #: StarRatingsComponent.html
 #, python-format
-msgid "%(ratings_avg)s (%(ratings_count)s %(ratings_label)s)"
-msgstr ""
+msgid "%(average)s (%(count)s rating)"
+msgid_plural "%(average)s (%(count)s ratings)"
+msgstr[0] ""
+msgstr[1] ""
 
 #. Short label displayed next to the count of readers who want to read this
 #. book, shown in the stats bar on a book page. Example: "2,389 Want to read".

openlibrary/macros/SearchResultsWork.html

@@ -123,9 +123,9 @@ <h3 itemprop="name" class="booktitle">
             $:macros.BookByline(author_data, limit=max_rendered_authors, overflow_url=work_edition_url)
         </span>
         <span class="resultStats">
-          $ ratings_count = doc.get('ratings_count', None)
+          $ ratings_count = doc.get('ratings_count') or 0
           $ ratings_avg = doc.get('ratings_average', None)
-          $ want_to_read_count = doc.get('want_to_read_count', None)
+          $ want_to_read_count = doc.get('want_to_read_count') or 0
           $:macros.StarRatingsByline(ratings_count, ratings_avg, want_to_read_count)
           $if show_librarian_extras and doc.get('trending_z_score') is not None:
             $:macros.TrendingBadge(doc)

openlibrary/macros/StarRatingsByline.html

@@ -1,18 +1,9 @@
 $def with(ratings_count, ratings_average, want_to_read_count)
 
-$ formatted_want_to_read_count = "{:,}".format(want_to_read_count) if want_to_read_count else ""
-$ ratings_label = _('rating') if ratings_count == 1 else _('ratings')
-
-<span class="ratingsByline" itemprop="aggregateRating" itemscope itemtype="https://schema.org/AggregateRating">
-  $if ratings_average:
-    <meta itemprop="ratingValue" content="$ratings_average"/>
-  $if ratings_count:
-    <meta itemprop="ratingCount" content="$ratings_count"/>
-  $if ratings_count:
-    $:macros.StarRatingsComponent(ratings_count, ratings_average, 'results_page')
-</span>
+$if ratings_average:
+  $:macros.StarRatingsComponent(ratings_count, ratings_average, cls='ratingsByline')
 $if want_to_read_count and ratings_count:
   <span class="dot">·</span>
 $if want_to_read_count:
   $code: pass  # NOTE: Shows the count of readers who added this book to their "Want to read" shelf, displayed on search result pages. %(want_to_read_count)s is a formatted integer (may include commas as thousands separators). Example: "2,389 Want to read".
-  <span class="ratingsByline" itemprop="reviewCount">$_('%(want_to_read_count)s Want to read', want_to_read_count=formatted_want_to_read_count)</span>
+  <span class="ratingsByline">$_('%(want_to_read_count)s Want to read', want_to_read_count=commify(want_to_read_count))</span>

openlibrary/macros/StarRatingsComponent.html

@@ -1,13 +1,16 @@
-$def with(ratings_count, ratings_average, page_type)
+$def with(ratings_count, ratings_average, cls='')
 
-$ rounded_avg = "%.1f" % ratings_average
-$ formatted_ratings_count = "{:,}".format(ratings_count) if ratings_count else ""
-$ ratings_label = _('rating') if ratings_count == 1 else _('ratings')
-$ small = "star--small" if page_type != 'book_page' else ''
+$ stats_decimal = (float(ratings_average) - int(ratings_average))
 
-$if ratings_average:
-  $ stats_decimal = (float(ratings_average) - int(ratings_average))
-    $:('<span class="star {}">★</span>'.format(small) * int(ratings_average))
-    $if (stats_decimal >= 0.5) and (stats_decimal < 1):
-      <span class="star star--half $small">★</span>
-    <span itemprop="ratingValue">$:_('%(ratings_avg)s (%(ratings_count)s %(ratings_label)s)', ratings_avg=rounded_avg, ratings_count=formatted_ratings_count, ratings_label=ratings_label)</span>
+<span
+  $if cls:
+    class="$cls"
+  itemprop="aggregateRating" itemscope itemtype="https://schema.org/AggregateRating"
+>
+  <meta itemprop="ratingValue" content="$ratings_average"/>
+  <meta itemprop="ratingCount" content="$ratings_count"/>
+  $:('<span class="star star--small">★</span>' * int(ratings_average))
+  $if (stats_decimal >= 0.5) and (stats_decimal < 1):
+    <span class="star star--half star--small">★</span>
+  <span>$ungettext('%(average)s (%(count)s rating)', '%(average)s (%(count)s ratings)', ratings_count, average=format_decimal(ratings_average), count=commify(ratings_count))</span>
+</span>

openlibrary/macros/StarRatingsStats.html

@@ -3,23 +3,19 @@
 $ rating_stats = work and work.get_rating_stats() or {}
 $ stats_by_bookshelf = work and work.get_num_users_by_bookshelf() or {}
 $ ratings_average = rating_stats.get('avg_rating', None)
-$ ratings_count = rating_stats.get('num_ratings', None)
-$ want_to_read_count = stats_by_bookshelf.get('want-to-read') and "{:,}".format(stats_by_bookshelf['want-to-read'])
-$ currently_reading_count = stats_by_bookshelf.get('currently-reading') and "{:,}".format(stats_by_bookshelf['currently-reading'])
-$ already_read_count = stats_by_bookshelf.get('already-read') and "{:,}".format(stats_by_bookshelf['already-read'])
-$ stopped_reading_count = stats_by_bookshelf.get('stopped-reading') and "{:,}".format(stats_by_bookshelf['stopped-reading'])
-$ review_count_class = 'readers-stats__review-count--none' if ratings_count == None else ''
+$ ratings_count = rating_stats.get('num_ratings') or 0
+$ want_to_read_count = stats_by_bookshelf.get('want-to-read') and commify(stats_by_bookshelf['want-to-read'])
+$ currently_reading_count = stats_by_bookshelf.get('currently-reading') and commify(stats_by_bookshelf['currently-reading'])
+$ already_read_count = stats_by_bookshelf.get('already-read') and commify(stats_by_bookshelf['already-read'])
+$ stopped_reading_count = stats_by_bookshelf.get('stopped-reading') and commify(stats_by_bookshelf['stopped-reading'])
+$ review_count_class = 'readers-stats__review-count--none' if ratings_count == 0 else ''
 $ id = '--mobile' if mobile else ''
 
-<ul class="readers-stats  $review_count_class" itemprop="aggregateRating" itemscope itemtype="https://schema.org/AggregateRating">
+<ul class="readers-stats $review_count_class">
   $if ratings_average:
-    <meta itemprop="ratingValue" content="$ratings_average"/>
-  $if ratings_count:
-    <meta itemprop="ratingCount" content="$ratings_count"/>
-  <li class="avg-ratings" onclick="location.href='#starRatingSection';" data-ol-link-track="StarRating|StatsComponentClick">
-    $if ratings_count:
-      $:macros.StarRatingsComponent(ratings_count, ratings_average, 'results_page')
-  </li>
+    <li class="avg-ratings" onclick="location.href='#starRatingSection';" data-ol-link-track="StarRating|StatsComponentClick">
+      $:macros.StarRatingsComponent(ratings_count, ratings_average)
+    </li>
   $if want_to_read_count:
     $code: pass  # NOTE: Short label displayed next to the count of readers who want to read this book, shown in the stats bar on a book page. Example: "2,389 Want to read".
     <li class="reading-log-stat"><span class="readers-stats__stat">$want_to_read_count</span> <span class="readers-stats__label">$_("Want to read")</span></li>

openlibrary/templates/trending.html

@@ -26,7 +26,7 @@ <h1>$_('Trending Books'): $(pages[mode])</h1>
             $ shelf = {1: _("Want to Read"), 2: _("Currently Reading"), 3: _("Read"), 4: _("Stopped Reading")}[entry['bookshelf_id']]
             $ extra = _("Someone marked as %(shelf)s %(k_hours_ago)s", shelf=shelf, k_hours_ago=datestr(entry['created']))
           $else:
-            $ extra = _('Logged %(count)i times %(time_unit)s', count=entry['cnt'], time_unit=pages[mode])
+            $ extra = ungettext('Logged %(count)i time %(time_unit)s', 'Logged %(count)i times %(time_unit)s', entry['cnt'], count=entry['cnt'], time_unit=pages[mode])
 
           $:macros.SearchResultsWork(entry['work'], extra=extra, availability=entry['work'].get('availability'), seq_index=loop.index0)
     </ul>

static/css/components/readerStats.css

@@ -32,7 +32,7 @@
   padding-bottom: 10px;
 }
 
-.readers-stats li:not(:first-child, :last-child):after {
+.readers-stats li:not(:last-child):after {
   content: "\00B7";
   margin: 0 4px;
 }