refine-rails 2.9.14 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb83da315ed33994f58b1486470a90ac88bc4f82a9c3fc02b3beca11bbb9a004
-  data.tar.gz: b31b990b6114f335900ca0bedff196ddb214eea7f84544c7ac5d46bc9fc15f49
+  metadata.gz: b10da95439ebbfb430380582aeb607bbc56e065fdd85168d755fd1165a665e81
+  data.tar.gz: a67a503d0142ffcd6b6400661407749f13a205e2640df94f294b9597cabc6cd6
 SHA512:
-  metadata.gz: 2f6d27699d8e6b3a8c707fe4ad641003228286657ce84941bf314ee77fa8989b8ccb68eb04eaac54a5e610807baad0b0daf074c4c7fe335d0dc4a0aa0c1b9cf2
-  data.tar.gz: 97571906ba632eb353c60c922e94b09484a19ae5b740d42f1b69f7f6a1d14c598d4051f9e0a7e48065a9217d79766d6aad49a0a62561320f58843bdead9d5736
+  metadata.gz: e777469805d700bf202f4bef49870725e20c08f8ab7486b00d2395801c843caf62b35fbfd786f78364a5b4523c3b6d542cb93a2a7743ce756bcc87be0ac77dde
+  data.tar.gz: d6299c4843f0b56f3b6b3221106759960b39447cf07e293b89ce99fec79fd36f40ec6546252ce9d9c45a139b6ea49ec3384ff52332c55648aaf9f3d6ab0dec31

data/app/models/refine/filter.rb

@@ -312,5 +312,9 @@ module Refine
     def criteria_limit_set?
       criteria_limit.to_i.positive?
     end
+
+    def has_category_ordering?
+      respond_to?(:category_order) && category_order.is_a?(Array) && category_order.any?
+    end
   end
 end

data/app/views/refine/blueprints/_condition_select.html.erb

@@ -5,7 +5,10 @@
     conditions.filter { |c| c[:meta][:category] == category}
   end
 
-  categories = conditions.map { |c| c[:meta][:category] }.uniq.compact
+  # If an ordering has been defined for categories, use that, otherwise use the order in which they appear in the sorted conditions
+  categories = (@refine_filter.has_category_ordering?) ? @refine_filter.category_order : conditions.map { |c| c[:meta][:category] }.uniq.compact
+
+  recommended_conditions = conditions.select { |c| c[:meta][:recommended] }
 
   # Note that the stimulus controllers set default condition id for new conditions
   # so this is only for rare cases where it gets unset
@@ -40,6 +43,19 @@
         ><%= condition_option[:display] %></option>
       <% end %>
     </optgroup>
+
+    <% if recommended_conditions&.any? %>
+      <optgroup class="divider" label="<%= t(".recommended") %>">
+        <% recommended_conditions.each do |condition_option| %>
+          <option
+            value="<%= condition_option[:id] %>"
+            <% if selected_condition_id == condition_option[:id] %>selected<% end %>
+            title="<%= condition_option[:display] %>"
+          ><%= condition_option[:display] %></option>
+        <% end %>
+      </optgroup>
+    <% end %>
+
     <% categories.each do |category| %>
       <optgroup class="divider" label="<%= category %>">
         <% conditions_for_category.call(category).each do |condition_option| %>

data/app/views/refine/inline/criteria/index.html.erb

@@ -2,9 +2,19 @@
   # a hash mapping Category => [array, of, conditions], sorted by category
   categorized_conditions = @conditions
     .group_by {|c| c.meta[:category].presence}
-    .sort_by {|(category, _conditions)| category.to_s.downcase }
+    .sort_by do |(category, _conditions)|
+      if @refine_filter.has_category_ordering?
+        @refine_filter.category_order.index(category) || Float::INFINITY
+      else
+        category.to_s.downcase
+      end
+    end
     .to_h
 
+  recommended_conditions = @conditions
+    .select { |c| c.meta[:recommended] }
+    .sort_by {|recommended| recommended.to_s.downcase }
+
   # an array of uncategorized conditions
   uncategorized_conditions = categorized_conditions.delete(nil)
 %>
@@ -31,17 +41,34 @@
     <div class="refine--separator-m0"></div>
 
     <div class="refine--condition-list">
-      <% uncategorized_conditions.each do |condition| %>
-        <%= link_to condition.display,
-          new_refine_inline_criterion_url(@criterion.to_params.deep_merge(refine_inline_criterion: {condition_id: condition.id})),
-          class: "refine--condition-list-item",
-          data: {
-            controller: "refine--turbo-stream-link",
-            action: "refine--turbo-stream-link#visit",
-            refine__typeahead_list_target: "listItem",
-            list_item_value: condition.display
-          }
-        %>
+      <% if uncategorized_conditions&.any? %>
+        <% uncategorized_conditions.each do |condition| %>
+          <%= link_to condition.display,
+            new_refine_inline_criterion_url(@criterion.to_params.deep_merge(refine_inline_criterion: {condition_id: condition.id})),
+            class: "refine--condition-list-item",
+            data: {
+              controller: "refine--turbo-stream-link",
+              action: "refine--turbo-stream-link#visit",
+              refine__typeahead_list_target: "listItem",
+              list_item_value: condition.display
+            }
+          %>
+          <% end %>
+      <% end %>
+
+      <% if recommended_conditions.any? %>
+        <b data-refine--typeahead-list-target="recommended"><%= t('.recommended') %></b>
+        <% recommended_conditions.each do |condition| %>
+          <%= link_to condition.display,
+            new_refine_inline_criterion_url(@criterion.to_params.deep_merge(refine_inline_criterion: {condition_id: condition.id})),
+            class: "refine--condition-list-item",
+            data: {
+              controller: "refine--turbo-stream-link",
+              action: "refine--turbo-stream-link#visit",
+              refine__typeahead_list_target: "listItem",
+            }
+          %>
+        <% end %>
       <% end %>
 
       <%  categorized_conditions.each do |(category, conditions)| %>

data/config/locales/en/refine.en.yml

@@ -66,6 +66,10 @@ en:
         days: "days"
         and: "and"
 
+    blueprints:
+      condition_select:
+        recommended: "Recommended"
+
     refine_blueprints:
       add_and:
         add_and: "AND"
@@ -184,5 +188,8 @@ en:
         filters:
           add_first_condition_button:
             filter: "Filter"
+          criteria:
+            index:
+              recommended: "Recommended"
           load_button:
             load_filter: "Load Filter"

data/lib/refine/rails/version.rb

@@ -1,5 +1,5 @@
 module Refine
   module Rails
-    VERSION = "2.9.14"
+    VERSION = "2.10.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refine-rails
 version: !ruby/object:Gem::Version
-  version: 2.9.14
+  version: 2.10.0
 platform: ruby
 authors:
 - Colleen Schnettler
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails