refine-rails 2.11.8 → 2.11.10

data/app/controllers/refine/advanced_inline/criteria_controller.rb

@@ -0,0 +1,186 @@
+class Refine::AdvancedInline::CriteriaController < ApplicationController
+  layout false
+  before_action :set_refine_filter
+  # List available conditions for new criteria
+  # Carries position and index forward
+  def index
+    @criterion = Refine::Inline::Criterion.new(criterion_params.merge(refine_filter: @refine_filter))
+    @conditions = @refine_filter.instantiated_conditions
+  end
+
+  # Show the form to add a new criteria
+  def new
+    @criterion = Refine::Inline::Criterion.new(criterion_params.merge(refine_filter: @refine_filter))
+    respond_to do |format|
+      # render a turbo_stream so that we can render inputs and forms in separate areas of the page
+      # in case we're nested inside a form
+      format.turbo_stream
+    end
+  end
+
+  # Create a new criterion
+  def create
+    @criterion = Refine::Inline::Criterion.new(criterion_params.merge(refine_filter: @refine_filter))
+    blueprint = @refine_filter.blueprint
+
+    Refine::Filters::BlueprintEditor
+      .new(@refine_filter.blueprint)
+      .add(
+        position: @criterion.position.to_i,
+        conjunction: @criterion.conjunction,
+        criterion: @criterion.to_blueprint_node
+      )
+
+    @error_messages = filter_error_messages(@refine_filter)
+    if @error_messages.none?
+      handle_filter_update(@refine_filter.to_stable_id)
+    else
+      respond_to do |format|
+        format.turbo_stream { render :new }
+      end
+    end
+  end
+
+  # show the form to edit an existing criterion
+  def edit
+    @criterion = Refine::Inline::Criterion
+      .groups_from_filter(@refine_filter, **criterion_params.slice(:client_id, :stable_id))
+      .flatten
+      .detect { |c| c.position.to_s == params[:id] }
+
+    @criterion.attributes = criterion_params
+    respond_to do |format|
+      # render a turbo_stream so that we can render inputs and forms in separate areas of the page
+      # in case we're nested inside a form
+      format.turbo_stream
+    end
+  end
+
+  # update an exsiting criterion
+  def update
+    @criterion = Refine::Inline::Criterion.new(criterion_params.merge(refine_filter: @refine_filter)) 
+    Refine::Filters::BlueprintEditor
+      .new(@refine_filter.blueprint)
+      .update(params[:id].to_i, criterion: @criterion.to_blueprint_node)
+
+    @error_messages = filter_error_messages(@refine_filter)
+    if @error_messages.none?
+        handle_filter_update(@refine_filter.to_stable_id)
+    else
+      respond_to do |format|
+        format.turbo_stream { render :edit }
+      end
+    end
+  end
+
+  # remove an existing criterion
+  def destroy
+    @criterion = Refine::Inline::Criterion
+      .groups_from_filter(@refine_filter, **criterion_params.slice(:client_id, :stable_id))
+      .flatten
+      .detect { |c| c.position.to_s == params[:id] }
+
+    Refine::Filters::BlueprintEditor
+      .new(@refine_filter.blueprint)
+      .delete(params[:id].to_i)
+
+    handle_filter_update(@refine_filter.to_stable_id)
+  end
+
+  def clear
+    @refine_filter.clear_blueprint!
+    @criterion = Refine::Inline::Criterion.new(criterion_params.merge(refine_filter: @refine_filter))
+    handle_filter_update()
+  end
+
+  def merge_groups
+    @criterion = Refine::Inline::Criterion.new(criterion_params.merge(refine_filter: @refine_filter)) 
+    Refine::Filters::BlueprintEditor
+    .new(@refine_filter.blueprint)
+    .change_conjunction(criterion_params[:position].to_i - 1, "and")
+
+    handle_filter_update(@refine_filter.to_stable_id)
+  end
+
+  private
+
+  def set_refine_filter
+    @refine_filter ||= Refine::Rails.configuration.stabilizer_classes[:url]
+      .new
+      .from_stable_id(id: criterion_params[:stable_id])
+  end
+
+  def criterion_params
+    params.require(:refine_inline_criterion).permit(
+      :stable_id,
+      :client_id,
+      :condition_id,
+      :position,
+      :conjunction,
+      input_attributes: [
+        :clause,
+        :date1,
+        :date2,
+        :days,
+        :modifier,
+        :selected,
+        :value,
+        :value1,
+        :value2,
+        selected: [],
+        count_refinement_attributes: [
+          :clause,
+          :value1,
+          :value2
+        ],
+        date_refinement_attributes: [
+          :clause,
+          :date1,
+          :date2,
+          :days,
+          :modifier
+        ]
+      ]
+    )
+  end
+
+  # either directly redirect or emit a `filter-submit-success` event
+  def handle_filter_update(stable_id=nil)
+    # update_stable_id in url
+    uri = URI(request.referrer)
+    new_query_ar = URI.decode_www_form(String(uri.query))
+    new_query_ar.reject! { |(k, _v)| k == "stable_id" }
+    if stable_id
+      new_query_ar << ["stable_id", stable_id]
+    end
+    uri.query = URI.encode_www_form(new_query_ar)
+
+    respond_to do |format|
+      format.turbo_stream do
+        @refine_stable_id = stable_id
+        @url_for_redirect = uri
+        @refine_client_id = @criterion.client_id
+        render :create
+      end
+      format.html do 
+        redirect_to uri.to_s 
+      end
+    end
+  end
+
+  def filter_valid?(refine_filter)
+    Refine::Inline::Criterion
+      .groups_from_filter(refine_filter, **criterion_params.slice(:client_id, :stable_id))
+      .flatten
+      .all?(&:valid?)
+  end
+
+  def filter_error_messages(refine_filter)
+    criteria = Refine::Inline::Criterion
+      .groups_from_filter(refine_filter, **criterion_params.slice(:client_id, :stable_id))
+      .flatten
+
+    criteria.each(&:validate!)
+    criteria.flat_map {|c| c.errors.full_messages }
+  end
+end

data/app/controllers/refine/advanced_inline/stored_filters_controller.rb

@@ -0,0 +1,84 @@
+class Refine::AdvancedInline::StoredFiltersController < ApplicationController
+  layout false
+  before_action :set_refine_filter
+
+
+  def index
+    @criterion = Refine::Inline::Criterion.new(criterion_params)
+    @stored_filters = Refine::StoredFilter.where(filter_type: @refine_filter.type)
+    @stored_filters = instance_exec(@stored_filters, &Refine::Rails.configuration.stored_filter_scope)
+  end
+
+  def find
+    @stored_filter = Refine::StoredFilter.find_by(id: params[:id], filter_type: @refine_filter.type)
+    handle_filter_update @stored_filter.refine_filter.to_stable_id
+  end
+
+  def new
+    @criterion = Refine::Inline::Criterion.new(criterion_params)
+    @stored_filter = Refine::StoredFilter.new(filter_type: @refine_filter.type)
+    respond_to do |format|
+      format.turbo_stream
+    end
+  end
+
+  def create
+    @criterion = Refine::Inline::Criterion.new(criterion_params)
+    @stored_filter = Refine::StoredFilter.new(stored_filter_params.merge(
+        state: @refine_filter.state,
+        filter_type: @refine_filter.type,
+        **instance_exec(&Refine::Rails.configuration.custom_stored_filter_attributes)
+      )
+    )
+
+    if @stored_filter.save
+      handle_filter_update @stored_filter.refine_filter.to_stable_id
+    else
+      respond_to do |format|
+        format.turbo_stream { render :new }
+      end
+    end
+  end
+
+  private
+
+  def set_refine_filter
+    @refine_filter ||= Refine::Rails.configuration.stabilizer_classes[:url]
+      .new
+      .from_stable_id(id: criterion_params[:stable_id])
+  end
+
+  def criterion_params
+    params.require(:refine_inline_criterion).permit(
+      :stable_id,
+      :client_id,
+      :position,
+      :conjunction
+    )
+  end
+
+  def stored_filter_params
+    params.require(:refine_stored_filter).permit(:name)
+  end
+
+  # either directly redirect or emit a `filter-submit-success` event
+  def handle_filter_update stable_id
+    # update_stable_id in url
+    uri = URI(request.referrer)
+    new_query_ar = URI.decode_www_form(String(uri.query))
+    new_query_ar.reject! { |(k, _v)| k == "stable_id" }
+    new_query_ar << ["stable_id", stable_id]
+    uri.query = URI.encode_www_form(new_query_ar)
+
+    respond_to do |format|
+      format.turbo_stream do
+        @refine_stable_id = stable_id
+        @url_for_redirect = uri
+        @refine_client_id = criterion_params[:client_id]
+        @refine_filter = @stored_filter.refine_filter
+        render :find
+      end
+      format.html {redirect_to uri.to_s }
+    end
+  end
+end

data/app/controllers/refine/inline/criteria_controller.rb

@@ -8,14 +8,6 @@ class Refine::Inline::CriteriaController < ApplicationController
     @conditions = @refine_filter.instantiated_conditions
   end
 
-  # List available conditions for new criteria in advanced view (IE: Modal)
-  # Carries position and index forward
-  def index_advanced
-    @criterion = Refine::Inline::Criterion.new(criterion_params.merge(refine_filter: @refine_filter))
-    @conditions = @refine_filter.instantiated_conditions
-    @fill_modal = params[:fill_modal] && params[:fill_modal] == "true"
-  end
-
   # Show the form to add a new criteria
   def new
     @criterion = Refine::Inline::Criterion.new(criterion_params.merge(refine_filter: @refine_filter))

data/app/javascript/controllers/fields/shoelace/tab-group-controller.js

@@ -0,0 +1,85 @@
+// to be used with sl-tab-group
+import { Controller } from "@hotwired/stimulus"
+
+// This controller is used to handle the tab group component
+// @see https://shoelace.style/components/tab-group
+// @param keepScrollPosition [Boolean] - If true, the scroll position will be kept when changing tabs
+// @usage <div data-controller="shoelace--tab-group" data-shoelace--tab-group-keep-scroll-position-value="true">
+
+export default class extends Controller {
+  static values = {
+    keepScrollPosition: { type: Boolean, default: false },
+  }
+
+  connect() {
+    this.currentScrollYPosition = 0
+    this.navigateToTab = this.navigateToTab.bind(this)
+    this.handleTabShow = this.handleTabShow.bind(this)
+
+    this.navigateToTab()
+
+    document.addEventListener('turbo:load', this.navigateToTab)
+    this.element.addEventListener('sl-tab-show', this.handleTabShow)
+  }
+
+  disconnect() {
+    document.removeEventListener('turbo:load', this.navigateToTab)
+    this.element.removeEventListener('sl-tab-show', this.handleTabShow)
+  }
+
+  handleTabShow(event) {
+    this.setLocationHash(event)
+
+    if (this.keepScrollPositionValue) {
+      this.handleTabChange()
+    }
+  }
+
+  setLocationHash(event) {
+    window.location.hash = event.detail.name
+  }
+
+  navigateToTab() {
+    let hash = window.location.hash.toString()
+    if (hash) {
+      this.element.show(hash.slice(1))
+    } else {
+      /*
+       * Turbo doesn't currently support hashes on redirects (see https://github.com/hotwired/turbo/issues/825)
+       * so we've created a workaround. Pass `redirect_anchor` as a query param, and the component will convert
+       * it to a hash and delete the query param. e.g. `some_url?redirect_anchor=store_upsells`
+       */
+      const params = new URLSearchParams(window.location.search)
+      const redirectedHashParam = params.get('redirect_anchor')
+      if (redirectedHashParam) {
+        params.delete('redirect_anchor')
+        let newParams = params.toString()
+        window.history.replaceState(
+          null,
+          '',
+          [window.location.pathname, newParams ? `?${newParams}` : '', '#', redirectedHashParam].join('')
+        )
+      }
+    }
+  }
+
+  handleTabChange() {
+    this.currentScrollYPosition = window.scrollY
+  }
+
+  /**
+   * Programmatically reveal a sl-tab-panel via action params.
+   * @see Shoelace sl-tab-group show() method
+   * @see https://shoelace.style/components/tab-group?id=methods
+   *
+   * @param {Event} event
+   * @param {string} event.params.showPanel - the name attribute of the sl-tab-panel to show
+   * @example <button type='button' data-action="click->shoelace--tab-group#show"
+   *   data-shoelace--tab-group-show-panel-param="mypanelname">
+   * @returns {void}
+   */
+  show(event) {
+    const { showPanel } = event.params
+    this.element.show(showPanel)
+  }
+}

data/app/javascript/controllers/index.js

@@ -18,6 +18,7 @@ import TurboStreamLinkController from './refine/turbo-stream-link-controller'
 import TypeaheadListController from './refine/typeahead-list-controller'
 import UpdateController from './refine/update-controller'
 import DateController from './refine/date-controller'
+import TabGroupController from "./fields/shoelace/tab-group-controller"
 
 export const controllerDefinitions = [
   [AddController, 'refine/add-controller.js'],
@@ -37,7 +38,8 @@ export const controllerDefinitions = [
   [TurboStreamLinkController, 'refine/turbo-stream-link-controller.js'],
   [TypeaheadListController, './refine/typeahead-list-controller.js'],
   [UpdateController, 'refine/update-controller.js'],
-  [DateController, 'refine/date-controller.js']
+  [DateController, 'refine/date-controller.js'],
+  [TabGroupController, 'fields/shoelace/tab-group-controller.js']
 ].map(function(d) {
   const key = d[1]
   const controller = d[0]
@@ -65,5 +67,6 @@ export {
   TurboStreamLinkController,
   TypeaheadListController,
   UpdateController,
-  DateController
+  DateController,
+  TabGroupController
 }

data/app/javascript/controllers/refine/modal-controller.js

@@ -11,7 +11,6 @@ export default class extends Controller {
   }
 
   connect() {
-    console.log("Connecting modal controller")
     useClickOutside(this)
   }
 

data/app/javascript/controllers/refine/popup-controller.js

@@ -29,6 +29,7 @@ export default class extends Controller {
   hide(event) {
     if (this.isOpenValue) {
       event?.preventDefault()
+      event?.stopPropagation()
       this.frameTarget.innerHTML = "";
       this.isOpenValue = false
     }

data/app/models/refine/conditions/has_icon.rb

@@ -7,6 +7,27 @@ module Refine::Conditions::HasIcon
     @icon_template ||= {}
   end
 
+  def category_icon_class
+    @category_icon_class ||= nil
+  end
+
+  def category_icon_template
+    @category_icon_template ||= {}
+  end
+
+  def icon_container_class
+    @icon_container_class ||= nil
+  end
+
+  def with_icon(icon_class: nil, template: {}, category_icon_class: nil, category_icon_template: {}, icon_container_class: nil)
+    with_icon_class(icon_class) if icon_class.present?
+    with_icon_template(template) if template.present?
+    with_category_icon_class(category_icon_class) if category_icon_class.present?
+    with_category_icon_template(category_icon_template) if category_icon_template.present?
+    with_icon_container_class(icon_container_class) if icon_container_class.present?
+    self
+  end
+
   def with_icon_class(icon_class)
     @icon_class = icon_class
     self
@@ -17,6 +38,21 @@ module Refine::Conditions::HasIcon
     self
   end
 
+  def with_category_icon_class(icon_class)
+    @category_icon_class = icon_class
+    self
+  end
+
+  def with_category_icon_template(template_path:, locals: {})
+    @category_icon_template = { template_path: template_path, locals: locals }
+    self
+  end
+
+  def with_icon_container_class(icon_container_class)
+    @icon_container_class = icon_container_class
+    self
+  end
+
   def has_icon?
     icon_class.present? || !icon_template.empty?
   end

data/app/models/refine/filter.rb

@@ -320,5 +320,6 @@ module Refine
     def clear_blueprint!
       @blueprint = []
     end
+
   end
 end

data/app/views/refine/advanced_inline/criteria/_condition_list_item_card.html.erb

@@ -0,0 +1,31 @@
+<% 
+  category ||= nil
+
+  data = {
+    controller: "refine--turbo-stream-link",
+    action: "refine--turbo-stream-link#visit",
+    refine__typeahead_list_target: "listItem",
+    list_item_value: condition.display,
+  } 
+  if category && category.present?
+    data[:category] = category
+  end
+  link_class = "refine--condition-list-item refine--condition-list-card"
+  link_class += " refine--condition-list-card"
+%>
+<%= link_to(
+  new_refine_advanced_inline_criterion_url(@criterion.to_params.deep_merge(refine_inline_criterion: {condition_id: condition.id})),
+  {
+    class: link_class,
+  }.merge(data: data)) do %>
+  <% if condition.has_icon? %>
+    <% if condition.icon_class.present? %>
+      <div class="refine--condition-list-icon-container <%= condition.icon_container_class %>">
+        <i class="refine--condition-list-card-icon <%= condition.icon_class %>"></i>
+      </div>
+    <% else %>
+      <%= render partial: condition.icon_template[:template_path], locals: condition.icon_template[:locals] %>
+    <% end %>
+  <% end %>
+  <%= condition.display %>
+<% end %>

data/app/views/refine/advanced_inline/criteria/_form_fields.html.erb

@@ -0,0 +1,121 @@
+<%
+  condition = @criterion.condition
+  date_refinement_condition = condition.has_date_refinement? && condition.get_date_refinement_condition
+  count_refinement_condition = condition.has_count_refinement? && condition.get_count_refinement_condition
+  condition_clause = @criterion.input.clause || condition.approved_clauses.first.id
+
+  last_clause_select = if count_refinement_condition
+    :count
+  elsif date_refinement_condition
+    :date
+  else
+    :criterion
+  end
+%>
+
+
+<%= form.hidden_field :stable_id, form: form_id %>
+<%= form.hidden_field :client_id, form: form_id %>
+<%= form.hidden_field :condition_id, form: form_id %>
+<%= form.hidden_field :conjunction, form: form_id %>
+<%= form.hidden_field :position, form: form_id %>
+
+<%= form.fields :input_attributes, model: @criterion.input do |input_fields| %>
+
+  <%# Clause Select %>
+  <div class="refine--criterion-clause-container">
+    <%= input_fields.label :clause, t('.rule') %>
+    <%= input_fields.collection_select :clause,
+      @criterion.condition.approved_clauses,
+      :id,
+      :display,
+      {selected: condition_clause},
+      class: "refine--select refine--clause-select",
+      data: {action: "change->refine--criterion-form#refresh"},
+      form: form_id
+    %>
+  </div>
+
+
+  <%# Input Value %>
+  <% unless ['st', 'nst'].include? condition_clause %>
+    <div class="refine--separator"></div>
+    <%= render @criterion.input_partial, criterion: @criterion, form: form, input_fields: input_fields, form_id: form_id %>
+  <% end %>
+
+  <% if last_clause_select == :criterion %>
+    <div class="refine--separator"></div>
+    <%= form.button t('global.buttons.apply'), class: "refine--apply-button", type: "submit", form: form_id %>
+  <% end %>
+  
+  <%# Date Refinement  %>
+  <% if @criterion.condition.has_date_refinement? %>
+    <div class="refine--separator"></div>
+    <div class="refine--criterion-clause-container refine--date-refinement-clause-container">
+      <%= input_fields.label :clause, date_refinement_condition.display, class: "refine--block" %>
+      <%= input_fields.fields :date_refinement_attributes, model: @criterion.input.date_refinement do |date_fields| %>
+        <%= date_fields.label :clause, t('.rule') %>
+        <%= date_fields.collection_select :clause,
+          date_refinement_condition.approved_clauses,
+          :id,
+          :display,
+          {},
+          class: "refine--select refine--clause-select",
+          data: {action: "change->refine--criterion-form#refresh"},
+          form: form_id
+        %>
+      </div>
+      <div class="refine--refinement-input-container">
+        <% unless ['st', 'nst'].include? @criterion.input.date_refinement.clause %>
+          <%= render "refine/advanced_inline/inputs/date_condition", criterion: @criterion, form: form, input_fields: date_fields, form_id: form_id %>
+        <% end %>
+      </div>
+    <% end %>
+    <% if last_clause_select == :date %>
+      <%= form.button t('global.buttons.apply'), class: "refine--apply-button", type: "submit", form: form_id %>
+    <% end %>
+  <% end %>
+
+  <%# Count Refinement  %>
+  <% if count_refinement_condition %>
+    <label><%= @criterion.condition.get_count_refinement_condition.display %></label>
+    <%= input_fields.fields :count_refinement_attributes, model: @criterion.input.count_refinement do |count_fields| %>
+      <div class="refine--criterion-clause-container">
+        <%= count_fields.collection_select :clause,
+          count_refinement_condition.approved_clauses,
+          :id,
+          :display,
+          {},
+          class: "refine--clause-select",
+          data: {action: "change->refine--criterion-form#refresh"}
+        %>
+      </div>
+
+      <% unless ['st', 'nst'].include? @criterion.input.count_refinement.clause %>
+        <%= render "refine/advanced_inline/inputs/numeric_condition", criterion: @criterion, form: form, input_fields: count_fields, form_id: form_id %>
+      <% end %>
+
+      <div class="refine--criterion-clause-container">
+        <%= count.label :clause, t('.rule') %>
+        <%= count.collection_select :clause,
+          @criterion.condition.approved_clauses,
+          :id,
+          :display,
+          {},
+          class: "refine--select refine--clause-select",
+          data: {action: "change->refine--criterion-form#refresh"},
+          form: form_id
+        %>
+        <% if last_clause_select == :count %>
+          <%= form.button t('global.buttons.apply'), class: "refine--apply-button", type: "submit", form: form_id %>
+        <% end %>
+      </div>
+    <% end %>
+  <% end %>
+<% end %>
+
+<% @error_messages&.each do |msg| %>
+  <p class="refine-criterion-error">
+    <%= msg %>
+  </p>
+<% end %>

data/app/views/refine/advanced_inline/criteria/create.turbo_stream.erb

@@ -0,0 +1,19 @@
+<%= turbo_stream.append_all "body" do %>
+  <script>
+    (function() {
+      const event = new CustomEvent("filter-submit-success", {
+        bubbles: true,
+        detail: {
+          stableId: <%= @refine_stable_id.to_json.html_safe %>,
+          url: <%= @url_for_redirect.to_json.html_safe %>,
+          formId: <%= @refine_client_id.to_json.html_safe %>
+        }
+      })
+      document
+        .getElementById(<%= "refine-inline-filter-#{@refine_client_id}".to_json.html_safe %>)
+        .dispatchEvent(event)
+    })()
+  </script>
+<% end %>
+
+<%= turbo_stream.replace "refine-inline-filter-#{@refine_client_id}", partial: "refine/advanced_inline/filters/show", locals: {} %>

data/app/views/refine/advanced_inline/criteria/edit.turbo_stream.erb

@@ -0,0 +1,31 @@
+<% form_id = dom_id(@criterion, :form) %>
+
+<%= turbo_stream.update dom_id(@criterion) do %>
+  <%= turbo_frame_tag dom_id(@criterion), class: "refine--inline-popup", data: {refine__popup_target: "frame"} do %>
+      <%= tag.div class: "refine--criterion-fields",
+        data: {
+          controller: "refine--criterion-form",
+          refine__criterion_form_url_value: edit_refine_advanced_inline_criterion_url(
+            @criterion.position, @criterion.to_params
+          ),
+          refine__criterion_form_form_id_value: form_id
+        } do
+      %>
+        <%= fields model: @criterion do |form| %>
+          <%= render "form_fields", form: form, form_id: form_id %>
+        <% end %>
+      <% end %>
+  <% end %>
+<% end %>
+
+
+
+
+<%= turbo_stream.append_all "body" do %>
+  <%= form_with url: refine_advanced_inline_criterion_path(@criterion.position),
+      method: :put,
+      id: form_id,
+      html: { autocomplete: "off" },
+      data: {controller: "refine--turbo-stream-form", action: "submit->refine--turbo-stream-form#submit"}
+   %>
+<% end %>