AO3-6875 Add additional wrangling status filtering options to tag search (#5029)

* AO3-6875 Add additional wrangling status filtering options to tag search

* Freeze mutable objects assigned to constants

* Prefer Rails built-in `t` helper over `ts`

* Filter wrangling status via `canonical_or_synonymous` field

* Filter for synonym tags by presence of `merger_id`

* Add shared `exists_filter` function

* Map existing `canonical` tag search param to `wrangling_status`

* Match existing behavior for canonical 'T' and 'F'

Author: metallicity

app/controllers/tags_controller.rb

@@ -413,6 +413,7 @@ def tag_search_params
       :fandoms,
       :type,
       :canonical,
+      :wrangling_status,
       :created_at,
       :uses,
       :sort_column,

app/models/search/query.rb

@@ -143,6 +143,10 @@ def terms_filter(field, value, options={})
     { terms: options.merge(field => value) }
   end
 
+  def exists_filter(field)
+    { exists: { field: field } }
+  end
+
   # A filter used to match all words in a particular field, most frequently
   # used for matching non-existent tags. The match query doesn't allow
   # negation/or/and/wildcards, so it should only be used on fields where the

app/models/search/tag_query.rb

@@ -15,7 +15,7 @@ def document_type
   def filters
     [
       type_filter,
-      canonical_filter,
+      wrangling_status_filter,
       unwrangleable_filter,
       posted_works_filter,
       media_filter,
@@ -77,8 +77,19 @@ def type_filter
     { term: { tag_type: options[:type] } } if options[:type]
   end
 
-  def canonical_filter
-    term_filter(:canonical, bool_value(options[:canonical])) if options[:canonical].present?
+  def wrangling_status_filter
+    case options[:wrangling_status]
+    when "canonical"
+      term_filter(:canonical, true)
+    when "noncanonical"
+      term_filter(:canonical, false)
+    when "synonymous"
+      [exists_filter("merger_id"), term_filter(:canonical, false)]
+    when "canonical_synonymous"
+      { bool: { should: [exists_filter("merger_id"), term_filter(:canonical, true)] } }
+    when "noncanonical_nonsynonymous"
+      [{ bool: { must_not: exists_filter("merger_id") } }, term_filter(:canonical, false)]
+    end
   end
 
   def unwrangleable_filter
@@ -130,7 +141,7 @@ def unwrangled_filter
   # the fandom exists, because this particular filter is included in the
   # exclusion_filters section.
   def wrangled_filter
-    { exists: { field: "fandom_ids" } } unless options[:wrangled].nil?
+    exists_filter("fandom_ids") unless options[:wrangled].nil?
   end
 
   ################

app/models/search/tag_search_form.rb

@@ -8,13 +8,14 @@ class TagSearchForm
     :query,
     :name,
     :canonical,
+    :wrangling_status,
     :fandoms,
     :type,
     :created_at,
     :uses,
     :sort_column,
     :sort_direction
-  ]
+  ].freeze
 
   attr_accessor :options
 
@@ -25,6 +26,7 @@ class TagSearchForm
   def initialize(options={})
     @options = options
     set_fandoms
+    set_wrangling_status
     @searcher = TagQuery.new(@options.delete_if { |_, v| v.blank? })
   end
 
@@ -43,6 +45,17 @@ def set_fandoms
     @options[:fandom_ids] = Tag.where(name: names).pluck(:id)
   end
 
+  def bool_value(str)
+    %w[true 1 T].include?(str.to_s)
+  end
+
+  def set_wrangling_status
+    return if @options[:canonical].blank?
+    
+    # Match old behavior for canonical param
+    @options[:wrangling_status] = bool_value(@options[:canonical]) ? "canonical" : "noncanonical"
+  end
+
   def sort_columns
     options[:sort_column] || "name"
   end

app/views/tags/_search_form.html.erb

@@ -2,22 +2,22 @@
   <fieldset>
     <dl>
       <dt>
-        <%= f.label :name, ts("Tag name") %>
+        <%= f.label :name, t(".tag_name") %>
         <%= link_to_help "tag-search-text-help" %>
       </dt>
       <dd>
         <%= f.text_field :name %>
       </dd>
       <dt>
-        <%= f.label :fandoms, ts("Fandoms") %>
+        <%= f.label :fandoms, t(".fandoms") %>
       </dt>
       <dd>
         <%= f.text_field :fandoms, autocomplete_options("fandom", "aria-describedby" => "fandom-field-description") %>
         <p class="footnote" id="fandom-field-description">
-          <%= ts("Find tags wrangled to specific canonical fandoms.") %>
+          <%= t(".fandoms_footnote") %>
         </p>
       </dd>
-      <dt><%= ts("Type") %></dt>
+      <dt><%= t(".type") %></dt>
       <dd>
         <fieldset>
           <ul>
@@ -35,38 +35,51 @@
           </ul>
         </fieldset>
       </dd>
-      <dt><%= ts("Wrangling status") %></dt>
+      <dt><%= t(".wrangling_status") %></dt>
       <dd>
         <fieldset>
           <ul>
             <li>
-              <%= f.radio_button :canonical, "T" %>
-              <%= f.label :canonical, ts("Canonical"), value: "T" %>
+              <%= f.radio_button :wrangling_status, "canonical" %>
+              <%= f.label :wrangling_status, t(".status_option.canonical"), value: "canonical" %>
             </li>
             <li>
-              <%= f.radio_button :canonical, "F" %>
-              <%= f.label :canonical, ts("Non-canonical"), value: "F" %>
+              <%= f.radio_button :wrangling_status, "noncanonical" %>
+              <%= f.label :wrangling_status, t(".status_option.noncanonical"), value: "noncanonical" %>
             </li>
             <li>
-              <%= f.radio_button :canonical, "" %>
-              <%= f.label :canonical, ts("Any status"), value: "" %>
+              <%= f.radio_button :wrangling_status, "synonymous" %>
+              <%= f.label :wrangling_status, t(".status_option.synonymous"), value: "synonymous" %>
+            </li>
+            <li>
+              <%= f.radio_button :wrangling_status, "canonical_synonymous" %>
+              <%= f.label :wrangling_status, t(".status_option.canonical_or_synonymous"), value: "canonical_synonymous" %>
+            </li>
+            <li>
+              <%= f.radio_button :wrangling_status, "noncanonical_nonsynonymous" %>
+              <%= f.label :wrangling_status, t(".status_option.noncanonical_and_nonsynonymous"), value: "noncanonical_nonsynonymous" %>
+            </li>
+            <li>
+              <%= f.radio_button :wrangling_status, "" %>
+              <%= f.label :wrangling_status, t(".status_option.any_status"), value: "" %>
             </li>
           </ul>
         </fieldset>
+      </dd>
       <dt>
-        <%= f.label :sort_column, ts("Sort by") %>
+        <%= f.label :sort_column, t(".sort_by") %>
       </dt>
       <dd>
         <%= f.select :sort_column, options_for_select(@search.sort_options, @search.sort_column) %>
       </dd>
       <dt>
-        <%= f.label :sort_direction, ts("Sort direction") %>
+        <%= f.label :sort_direction, t(".sort_direction") %>
       </dt>
       <dd>
         <%= f.select :sort_direction,
           options_for_select([["Ascending", "asc"], ["Descending", "desc"]], @search.sort_direction) %>
       </dd>
     </dl>
-    <p class="submit actions"><%= f.submit ts("Search Tags") %></p>
+    <p class="submit actions"><%= f.submit t(".search_tags") %></p>
   </fieldset>
 <% end %>

config/locales/views/en.yml

@@ -1735,6 +1735,22 @@ en:
         random: These are some random tags used on the Archive. To find more tags, %{search_tags_link}.
         random_in_collection: These are some random tags used in the collection.
       search_tags: try our tag search
+    search_form:
+      fandoms: Fandoms
+      fandoms_footnote: Find tags wrangled to specific canonical fandoms.
+      search_tags: Search Tags
+      sort_by: Sort by
+      sort_direction: Sort direction
+      status_option:
+        any_status: Any status
+        canonical: Canonical
+        canonical_or_synonymous: Canonical or synonymous
+        noncanonical: Non-canonical
+        noncanonical_and_nonsynonymous: Non-canonical and non-synonymous
+        synonymous: Synonymous
+      tag_name: Tag name
+      type: Type
+      wrangling_status: Wrangling status
     show:
       canonical_html: It's a %{canonical_tag_link}. You can use it to %{filter_works_link} and to %{filter_bookmarks_link}.
       canonical_tag: canonical tag

features/tags_and_wrangling/tag_search.feature

@@ -150,28 +150,56 @@ Feature: Search Tags
   Scenario: Search by wrangling status
     Given a fandom exists with name: "Not Canon Fandom", canonical: false
       And a character exists with name: "Canon Character", canonical: true
+      And a synonym "Same Canon Character" of the tag "Canon Character"
       And all indexing jobs have been run
     When I am on the search tags page
       And I fill in "Tag name" with "Canon"
       And I choose "Canonical"
       And I press "Search Tags"
     Then I should see "1 Found"
-      And I should see the tag search result "Character: Canon Character (0)"
       And I should not see the tag search result "Fandom: Not Canon Fandom (0)"
+      And I should see the tag search result "Character: Canon Character (0)"
+      And I should not see the tag search result "Character: Same Canon Character (0)"
     When I am on the search tags page
       And I fill in "Tag name" with "Canon"
       And I choose "Non-canonical"
       And I press "Search Tags"
+    Then I should see "2 Found"
+      And I should see the tag search result "Fandom: Not Canon Fandom (0)"
+      And I should not see the tag search result "Character: Canon Character (0)"
+      And I should see the tag search result "Character: Same Canon Character (0)"
+    When I am on the search tags page
+      And I fill in "Tag name" with "Canon"
+      And I choose "Synonymous"
+      And I press "Search Tags"
+    Then I should see "1 Found"
+      And I should not see the tag search result "Fandom: Not Canon Fandom (0)"
+      And I should not see the tag search result "Character: Canon Character (0)"
+      And I should see the tag search result "Character: Same Canon Character (0)"
+    When I am on the search tags page
+      And I fill in "Tag name" with "Canon"
+      And I choose "Canonical or synonymous"
+      And I press "Search Tags"
+    Then I should see "2 Found"
+      And I should not see the tag search result "Fandom: Not Canon Fandom (0)"
+      And I should see the tag search result "Character: Canon Character (0)"
+      And I should see the tag search result "Character: Same Canon Character (0)"
+    When I am on the search tags page
+      And I fill in "Tag name" with "Canon"
+      And I choose "Non-canonical and non-synonymous"
+      And I press "Search Tags"
     Then I should see "1 Found"
       And I should see the tag search result "Fandom: Not Canon Fandom (0)"
       And I should not see the tag search result "Character: Canon Character (0)"
+      And I should not see the tag search result "Character: Same Canon Character (0)"
     When I am on the search tags page
       And I fill in "Tag name" with "Canon"
       And I choose "Any status"
       And I press "Search Tags"
-    Then I should see "2 Found"
+    Then I should see "3 Found"
       And I should see the tag search result "Fandom: Not Canon Fandom (0)"
       And I should see the tag search result "Character: Canon Character (0)"
+      And I should see the tag search result "Character: Same Canon Character (0)"
 
   Scenario: Search and sort by Date Created in descending and ascending order
     Given a freeform exists with name: "created first", created_at: "2008-01-01 20:00:00 Z"