]> git.openstreetmap.org Git - rails.git/commitdiff
Merge pull request #5417 from tomhughes/social-share-helper
authorAndy Allan <git@gravitystorm.co.uk>
Thu, 19 Dec 2024 10:28:13 +0000 (10:28 +0000)
committerGitHub <noreply@github.com>
Thu, 19 Dec 2024 10:28:13 +0000 (10:28 +0000)
Refactor social sharing helper

app/helpers/social_share_button_helper.rb
app/views/diary_entries/show.html.erb
test/helpers/social_share_button_helper_test.rb

index edbd056a2e82521b48e1305f7ef80bf013a9d2cc..da49347c3054a56f32a063e54cb44faf84bc2e79 100644 (file)
@@ -12,71 +12,47 @@ module SocialShareButtonHelper
   }.freeze
 
   # Generates a set of social share buttons based on the specified options.
-  def render_social_share_buttons(opts = {})
-    sites = opts.fetch(:allow_sites, [])
-    valid_sites, invalid_sites = filter_allowed_sites(sites)
-
-    # Log invalid sites
-    invalid_sites.each do |invalid_site|
-      Rails.logger.error("Invalid site or icon not configured: #{invalid_site}")
-    end
-
+  def social_share_buttons(title:, url:)
     tag.div(
       :class => "social-share-button d-flex gap-1 align-items-end flex-wrap mb-3"
     ) do
-      valid_sites.map do |site|
+      safe_join(SOCIAL_SHARE_CONFIG.map do |site, icon|
         link_options = {
-          :rel => ["nofollow", opts[:rel]].compact,
+          :rel => "nofollow",
           :class => "ssb-icon rounded-circle",
           :title => I18n.t("application.share.#{site}.title"),
           :target => "_blank"
         }
 
-        link_to generate_share_url(site, opts), link_options do
-          image_tag(icon_path(site), :alt => I18n.t("application.share.#{site}.alt"), :size => 28)
+        link_to generate_share_url(site, title, url), link_options do
+          image_tag(icon, :alt => I18n.t("application.share.#{site}.alt"), :size => 28)
         end
-      end.join.html_safe
+      end, "\n")
     end
   end
 
   private
 
-  def filter_allowed_sites(sites)
-    valid_sites = sites.empty? ? SOCIAL_SHARE_CONFIG.keys : sites.select { |site| valid_site?(site) }
-    invalid_sites = sites - valid_sites
-    [valid_sites, invalid_sites]
-  end
-
-  def icon_path(site)
-    SOCIAL_SHARE_CONFIG[site.to_sym] || ""
-  end
-
-  def valid_site?(site)
-    SOCIAL_SHARE_CONFIG.key?(site.to_sym)
-  end
-
-  def generate_share_url(site, params)
+  def generate_share_url(site, title, url)
     site = site.to_sym
+    title = URI.encode_www_form_component(title)
+    url = URI.encode_www_form_component(url)
+
     case site
     when :email
-      to = params[:to] || ""
-      subject = CGI.escape(params[:title])
-      body = CGI.escape(params[:url])
-      "mailto:#{to}?subject=#{subject}&body=#{body}"
+      "mailto:?subject=#{title}&body=#{url}"
     when :x
-      via_str = params[:via] ? "&via=#{URI.encode_www_form_component(params[:via])}" : ""
-      hashtags_str = params[:hashtags] ? "&hashtags=#{URI.encode_www_form_component(params[:hashtags].join(','))}" : ""
-      "https://x.com/intent/tweet?url=#{URI.encode_www_form_component(params[:url])}&text=#{URI.encode_www_form_component(params[:title])}#{hashtags_str}#{via_str}"
+      "https://x.com/intent/tweet?url=#{url}&text=#{title}"
     when :linkedin
-      "https://www.linkedin.com/sharing/share-offsite/?url=#{URI.encode_www_form_component(params[:url])}"
+      "https://www.linkedin.com/sharing/share-offsite/?url=#{url}"
     when :facebook
-      "https://www.facebook.com/sharer/sharer.php?u=#{URI.encode_www_form_component(params[:url])}&t=#{URI.encode_www_form_component(params[:title])}"
+      "https://www.facebook.com/sharer/sharer.php?u=#{url}&t=#{title}"
     when :mastodon
-      "https://mastodonshare.com/?text=#{URI.encode_www_form_component(params[:title])}&url=#{URI.encode_www_form_component(params[:url])}"
+      "https://mastodonshare.com/?text=#{title}&url=#{url}"
     when :telegram
-      "https://t.me/share/url?url=#{URI.encode_www_form_component(params[:url])}&text=#{URI.encode_www_form_component(params[:title])}"
+      "https://t.me/share/url?url=#{url}&text=#{title}"
     when :bluesky
-      "https://bsky.app/intent/compose?text=#{URI.encode_www_form_component(params[:title])}+#{URI.encode_www_form_component(params[:url])}"
+      "https://bsky.app/intent/compose?text=#{title}+#{url}"
     else
       raise ArgumentError, "Unsupported platform: #{platform}"
     end
index 14b1576f0fdc9f6339f169fedddef1622e3bc44b..9e3e7da650ea0c7b8475153367056849a34b4765 100644 (file)
 <% end %>
 
 <%= render @entry %>
-<%= render_social_share_buttons({
-                                  :title => @entry.title,
-                                  :url => diary_entry_url(@entry.user, @entry)
-                                }) %>
+<%= social_share_buttons(:title => @entry.title, :url => diary_entry_url(@entry.user, @entry)) %>
 
 <div id="comments" class="comments mb-3 overflow-hidden">
   <div class="row border-bottom border-secondary-subtle">
index 397cbd11235db2878657874e50656d4f2e02878c..136298381ae8f094f94ecb3d44b7a3a016690257 100644 (file)
@@ -3,34 +3,15 @@ require "test_helper"
 class SocialShareButtonHelperTest < ActionView::TestCase
   include SocialShareButtonHelper
 
-  def setup
-    @options = {
-      :allow_sites => %w[x facebook linkedin],
-      :title => "Test Title",
-      :url => "https://example.com",
-      :desc => "Test Description",
-      :via => "testuser"
-    }
-  end
-
-  def test_render_social_share_buttons_with_valid_sites
-    result = render_social_share_buttons(@options)
-    assert_includes result, "x"
-    assert_includes result, "facebook"
-    assert_includes result, "linkedin"
-  end
-
-  def test_render_social_share_buttons_with_invalid_site
-    @options[:allow_sites] << "invalid_site"
-    result = render_social_share_buttons(@options)
-    assert_not_includes result, "invalid_site"
-  end
+  def test_social_share_buttons
+    buttons = social_share_buttons(:title => "Test Title", :url => "https://example.com")
+    buttons_dom = Rails::Dom::Testing.html_document_fragment.parse(buttons)
 
-  def test_render_social_share_buttons_with_no_sites
-    @options[:allow_sites] = []
-    result = render_social_share_buttons(@options)
-    SocialShareButtonHelper::SOCIAL_SHARE_CONFIG.each_key do |site|
-      assert_includes result, site.to_s # Convert symbol to string
+    SOCIAL_SHARE_CONFIG.each_value do |icon|
+      assert_dom buttons_dom, "div:has(a img[src='/images/#{icon}'])", :count => 1 do
+        assert_dom "a[href*='Test+Title']"
+        assert_dom "a[href*='https%3A%2F%2Fexample.com']"
+      end
     end
   end
 end