The rubygem partial displays the latest release date #4476

heyapricot · 2024-02-20T23:10:28Z

This PR closes #2993. Let me know what you think!
Update: It closes #4470 as well

simi

Hello @heyapricot! Thanks for opening this PR. The overall idea seems fine to me. But the implementation would need few tweaks. Feel free to ping me if help is needed.

current screenshot

simi · 2024-02-21T23:34:11Z

app/controllers/searches_controller.rb

@@ -3,9 +3,10 @@ class SearchesController < ApplicationController

  def show
    return unless params[:query].is_a?(String)
-    @error_msg, @gems = ElasticSearcher.new(params[:query], page: @page).search
+    @error_msg, @elastic_results = ElasticSearcher.new(params[:query], page: @page).search


Can you explain why this change is needed? 🤔

This was me circumventing an issue to get a working proof of concept 😬

@gems originally is assigned a collection of Hash-like objects like this:

<Searchkick::HashWrapper _id="15494" _index="rubygems-development_20240219203755949" _score=248.40211 _type="_doc" description="Ruby on Rails is a full-stack web framework optimized for programmer happiness and sustainable productivity. It encourages beautiful code by favoring convention over configuration." downloads=496344261 id="15494" name="rails" summary="Full-stack web application framework." version="7.1.3">

I couldn't figure out how to add the latest_release_date property to the HashWrapper (Took a look here for example)

What I did instead was map the id's from the search result collection, run a new query and use the actual Rubygem objects instead.

Yup, AFAIK you can use version attribute on returned search result.

simi · 2024-02-21T23:35:52Z

app/helpers/rubygems_helper.rb

@@ -161,6 +161,10 @@ def show_all_versions_link?(rubygem)
    rubygem.versions_count > 5 || rubygem.yanked_versions?
  end

+  def latest_release_date(rubygem)
+    (rubygem.latest_version || rubygem.versions&.last)&.built_at&.strftime("%B %d, %Y")


Is there any case where rubygem.latest_version is nil (or false) but rubygem.versions.last is not? Also created_at should be used.

I ran Rubygem.left_outer_joins(:versions).where(versions: { id: nil }) and it returned 79 results. All of them had the indexed property set to false (Not sure if that affects the search result eligibility).

I followed the pattern from this method:

rubygems.org/app/helpers/rubygems_helper.rb

Line 166 in 0c48ef3

(rubygem.latest_version || rubygem.versions.last)&.number

Ended up removing the latest_release_date method and using version_date_tag instead

simi · 2024-02-21T23:40:58Z

app/views/rubygems/_rubygem.html.erb

+        <%= latest_version_number(rubygem) %>
+      </span>
+      <span class="gems__gem__latest__release__date">
+        <%= "released #{latest_release_date(rubygem)}" %>


released should be moved into config/locales/en.yml. Would it be possible to reuse version_date_tag from VersionsHelper?

Not 100% sure what to do with config/locales/en.yml to get the "released" text displayed.
Took a look at

rubygems.org/app/helpers/versions_helper.rb

Line 18 in 0c48ef3

"- #{nice_date_for(version.authored_at)}"

codecov · 2024-02-22T00:06:09Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.88%. Comparing base (0c48ef3) to head (be24725).
Report is 4 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #4476      +/-   ##
==========================================
- Coverage   97.15%   96.88%   -0.27%     
==========================================
  Files         391      391              
  Lines        8260     8261       +1     
==========================================
- Hits         8025     8004      -21     
- Misses        235      257      +22

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

heyapricot · 2024-02-22T03:48:01Z

app/views/rubygems/_rubygem.html.erb

+      </span>
+      <span class="gems__gem__latest__release__date">
+        <%= version_date_tag(rubygem.latest_version) %>
+      </span>


Is this an acceptable appearance?

heyapricot · 2024-02-26T02:29:11Z

@simi Submitted a different and hopefully simpler approach.
Noticed that

rubygems.org/app/models/concerns/rubygem_searchable.rb

Line 62 in d9200cc

updated: updated_at,

has an updated entry so i decided to use that to display the release date when delivering search results. Previously you suggested using created_at but I wanted to show the approach before modifying the search_data method

I included a helper method latest_release_date. If the rubygem partial receives a searchkick object it will use the updated property of the result hash and return a <small> tag with the gem__version__date class.
If the rubygem partial receives a Rubygem object, it will use the version_date_tag helper method you suggested which also returns a <small> tag with the gem__version__date class.

Let me know what you think. Thanks!

simi · 2024-06-13T23:28:28Z

Hello again @heyapricot and sorry for long delay on this review. I did some quick testing and it looks good. The only problem I have noticed is for pre-relase gems only latest_version is nil and that way no date is present, but version is displayed. Any idea what to do in this case? Show latest pre-version date? Maybe the easiest would be to follow logic from latest_version_number helper.

heyapricot · 2024-10-23T03:42:26Z

Apologies for missing this message. Just caught it on my notifications while searching for other stuff.

I'll follow the recommendation of checking the other method's logic and will try to work on this over the weekend

simi · 2024-10-23T14:21:54Z

Happy to review once ready @heyapricot!

heyapricot · 2024-10-27T20:02:26Z

Hello again @heyapricot and sorry for long delay on this review. I did some quick testing and it looks good. The only problem I have noticed is for pre-relase gems only latest_version is nil and that way no date is present, but version is displayed. Any idea what to do in this case? Show latest pre-version date? Maybe the easiest would be to follow logic from latest_version_number helper.

@simi Comment addressed! Here is a brief demo

simi reviewed Feb 21, 2024

View reviewed changes

heyapricot force-pushed the add-latest-release-date-to-search-index branch from d7c5d86 to 3941c33 Compare February 22, 2024 03:46

heyapricot commented Feb 22, 2024

View reviewed changes

heyapricot requested a review from simi February 22, 2024 03:54

heyapricot force-pushed the add-latest-release-date-to-search-index branch 2 times, most recently from be24725 to 82f3095 Compare February 26, 2024 02:17

heyapricot force-pushed the add-latest-release-date-to-search-index branch from 82f3095 to e7b9799 Compare May 8, 2024 18:56

heyapricot force-pushed the add-latest-release-date-to-search-index branch 2 times, most recently from b3f10e3 to e1041ca Compare October 27, 2024 19:58

The rubygem partial displays the latest release date

81b2d90

heyapricot force-pushed the add-latest-release-date-to-search-index branch from e1041ca to 81b2d90 Compare October 27, 2024 20:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

The rubygem partial displays the latest release date #4476

The rubygem partial displays the latest release date #4476

heyapricot commented Feb 20, 2024 •

edited

Loading

simi left a comment

simi Feb 21, 2024

heyapricot Feb 22, 2024

simi Feb 25, 2024

simi Feb 21, 2024

heyapricot Feb 22, 2024

heyapricot Feb 22, 2024 •

edited

Loading

simi Feb 21, 2024

heyapricot Feb 22, 2024

codecov bot commented Feb 22, 2024 •

edited

Loading

heyapricot Feb 22, 2024

heyapricot commented Feb 26, 2024

simi commented Jun 13, 2024 •

edited

Loading

heyapricot commented Oct 23, 2024

simi commented Oct 23, 2024

heyapricot commented Oct 27, 2024

The rubygem partial displays the latest release date #4476

Are you sure you want to change the base?

The rubygem partial displays the latest release date #4476

Conversation

heyapricot commented Feb 20, 2024 • edited Loading

simi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heyapricot Feb 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Feb 22, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

heyapricot commented Feb 26, 2024

simi commented Jun 13, 2024 • edited Loading

heyapricot commented Oct 23, 2024

simi commented Oct 23, 2024

heyapricot commented Oct 27, 2024

heyapricot commented Feb 20, 2024 •

edited

Loading

heyapricot Feb 22, 2024 •

edited

Loading

codecov bot commented Feb 22, 2024 •

edited

Loading

simi commented Jun 13, 2024 •

edited

Loading