refine-rails 2.9.0

data/app/views/refine/inline/filters/_save_button.html.erb

@@ -0,0 +1,15 @@
+<% 
+  criterion = Refine::Inline::Criterion.new(
+    stable_id: @refine_filter.to_stable_id,
+    client_id: @refine_client_id,
+  )
+%>
+
+<%= turbo_frame_tag dom_id(criterion, :save) do %>
+  <%= link_to new_refine_inline_stored_filter_path(criterion.to_params),
+    class: "refine--save-filter-link", data: {turbo_stream: true} do %>
+      <span class="material-icons-outlined refine--icon-sm">save</span>
+      <span class="refine--save-filter-link-label"><%= t('refine.inline.filters.save_filter') %></span>
+  <% end %>
+<% end %>
+

data/app/views/refine/inline/filters/_show.html.erb

@@ -0,0 +1,40 @@
+<%
+  groups = Refine::Inline::Criterion.groups_from_filter(@refine_filter, client_id: @refine_client_id, stable_id: @refine_stable_id)
+
+  main_row_class = class_names "refine--filter-row" => true,
+    "refine--has-many-groups" => groups.many?
+%>
+
+<%= tag.div class: "refine--filter-wrapper", id: "refine-inline-filter-#{@refine_client_id}" do %>
+  <div class="refine--filter-row">
+    <%= render "refine/inline/filters/save_button" %>
+  </div>
+
+  <%= tag.div class: main_row_class do %>
+    <% if @refine_filter.blueprint.empty? %>
+      <%= render "refine/inline/filters/add_first_condition_button", position: 0, btn_class: "
+      refine--add-first-condition-btn" %>
+    <% else %>
+      <div class="refine--filter-label"><%= t('refine.inline.filters.filter') %>:</div>
+      <div class="refine--groups-wrapper">
+        <% groups.each.with_index do |group, i| %>
+          <% unless i == 0 %>
+            <div class="refine--group-join"><%= t("refine.inline.filters.or") %></div>
+          <% end %>
+
+          <%= render "refine/inline/filters/group", group: group %>
+        <% end %>
+
+        <div class="refine--group">
+          <div class="refine--group-conditions-wrapper">
+            <%= render "refine/inline/filters/or_button", position: @refine_filter.blueprint.length %>
+          </div>
+        </div>
+      </div>
+    <% end %>
+  <% end %>
+<% end %>
+
+
+
+

data/app/views/refine/inline/inputs/_date_condition.html.erb

@@ -0,0 +1,7 @@
+<% if criterion.input.clause.in? ["exct", "gt", "lt"] %>
+  <%= render "refine/inline/inputs/date_condition_days", input_fields: input_fields, criterion: criterion, form_id: form_id %>
+<% elsif criterion.input.clause == "btwn" %>
+  <%= render "refine/inline/inputs/date_condition_range", input_fields: input_fields, criterion: criterion, form_id: form_id %>
+<% else %>
+  <%= render "refine/inline/inputs/date_condition_single", input_fields: input_fields, criterion: criterion, form_id: form_id %>
+<% end %>

data/app/views/refine/inline/inputs/_date_condition_days.html.erb

@@ -0,0 +1,18 @@
+<div class="refine--date-condition-days-container">
+  <%= input_fields.label :days, t(".number_of_days"), class: "sr-only" %>
+  <%= input_fields.text_field :days,
+    class: "refine--input",
+    placeholder: criterion.condition.display.downcase,
+    form: form_id
+  %>
+</div>
+<div class="refine--date-condition-days-modifier-container">
+  <%= input_fields.collection_select :modifier,
+    Refine::Inline::Criteria::Input::MODIFIERS,
+    :first,
+    :last,
+    {},
+    class: "refine--select",
+    form: form_id
+  %>
+</div>

data/app/views/refine/inline/inputs/_date_condition_range.html.erb

@@ -0,0 +1,22 @@
+<%= tag.div class: "refine--date-condition-first-date-container-btwn" do %>
+  <%= render "refine/inline/inputs/date_picker",
+    input_fields: input_fields,
+    attribute: :date1,
+    value: criterion.input.date1,
+    label: "#{criterion.condition.display.downcase} (#{t('.min')})",
+    form_id: form_id
+  %>
+
+  <div class="refine--date-condition-and"><%= t(".and") %></div>
+
+  <div class="refine--date-condition-second-date-container">
+    <%= render "refine/inline/inputs/date_picker",
+      input_fields: input_fields,
+      attribute: :date2,
+      value: criterion.input.date2,
+      label: "#{criterion.condition.display.downcase} (#{t('.max')})",
+      form_id: form_id
+    %>
+  </div>
+<% end %>
+

data/app/views/refine/inline/inputs/_date_condition_single.html.erb

@@ -0,0 +1,9 @@
+<%= tag.div class: "refine--date-condition-first-date-container" do %>
+  <%= render "refine/inline/inputs/date_picker",
+    input_fields: input_fields,
+    attribute: :date1,
+    value: criterion.input.date1,
+    label: criterion.condition.display.downcase,
+    form_id: form_id
+  %>
+<% end %>

data/app/views/refine/inline/inputs/_date_picker.html.erb

@@ -0,0 +1,20 @@
+<div 
+  data-controller="refine--date" 
+  class="refine-date-picker-container"
+  data-refine--date-locale-value="<%= I18n.locale %>"
+  data-refine--date-date-format-value="<%=  I18n.t("refine.date.formats.moment") %>"
+  data-refine--date-datetime-format-value="<%= I18n.t("refine.time.formats.moment") %>"
+>
+  <input
+    class="refine--input"
+    type="text"
+    value="<%= value&.to_date && I18n.l(value&.to_date, format: I18n.t("refine.date.formats.ruby"))  %>"
+    data-refine--date-target="field"
+    placeholder="<%= label %>"
+  />
+  <%= input_fields.hidden_field attribute,
+    value: value&.to_date&.strftime('%Y-%m-%d'),
+    data: { refine__date_target: "hiddenField" },
+    form: form_id
+  %>
+</div>

data/app/views/refine/inline/inputs/_numeric_condition.html.erb

@@ -0,0 +1,23 @@
+<%
+  is_range = ['btwn', 'nbtwn'].include? input_fields.object.clause
+  value1_placeholder = criterion.condition.display.downcase
+  value1_placeholder += " (#{t('.min')})" if is_range
+  value2_placeholder = "#{criterion.condition.display.downcase} (#{t('.max')})"
+%>
+
+<%= tag.div class: ('btwn' ? 'refine--numeric-condition-container' : 'refine-numeric-condition-container-btwn') do %>
+
+  <%= input_fields.text_field :value1,
+    class: "refine--input refine--numeric-input",
+    placeholder: value1_placeholder,
+    form: form_id
+  %>
+
+  <% if is_range %>
+    <div class="refine--numeric-condition-and"><%= t(".and") %></div>
+    <div class="refine--numeric-condition-second-container">
+      <%= input_fields.text_field :value2, class: "refine--input refine--numeric-input", placeholder: value2_placeholder,
+form: form_id %>
+    </div>
+  <% end %>
+<% end %>

data/app/views/refine/inline/inputs/_option_condition.html.erb

@@ -0,0 +1,14 @@
+<div class="refine-option--condition-container">
+  <%= input_fields.collection_select :selected,
+    criterion.options,
+    :id,
+    ->(o) {o.display.truncate(64)},
+    {},
+    class: "refine--select refine--option-select",
+    multiple: criterion.multiple?,
+    form: form_id
+  %>
+  <% if criterion.condition.meta[:postfix] %>
+    <span class="refine-option--condition-postfix"><%= meta[:postfix] %></span>
+  <% end %>
+</div>

data/app/views/refine/inline/inputs/_text_condition.html.erb

@@ -0,0 +1,8 @@
+<div class="refine--text-condition-container">
+  <%= form.label :condition_id, criterion.condition.display, class: "sr-only" %>
+  <%= input_fields.text_field :value,
+    class: "refine--input refine--text-input #{"has-error" if criterion.errors.any?}",
+    placeholder: criterion.condition.display.downcase,
+    form: form_id
+  %>
+</div>

data/app/views/refine/inline/stored_filters/find.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/inline/filters/show" %>

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

@@ -0,0 +1,28 @@
+<%= turbo_frame_tag dom_id(@criterion, :load), class: "refine--stored-filter-list-popup" do %>
+  <div class="refine--stored-filter-list">
+    <% if @stored_filters.empty? %>
+      <a><%= t('.no_stored_filters') %></a>
+    <% end %>
+
+
+    <% @stored_filters.each do |filter| %>
+      <%= form_with(
+          model: @criterion,
+          url: find_refine_inline_stored_filters_path,
+          method: :post,
+          class: "refine--stored-filter-search-form",
+          data: {
+            turbo_frame: "_top",
+            controller: "refine--submit-form"
+          }) do |form| %>
+        <!-- Saved filter selector -->
+          <%= form.hidden_field :stable_id %>
+          <%= form.hidden_field :client_id %>
+          <%= hidden_field_tag :id, filter.id %>
+          <a href="#" class="refine--stored-filter-list-item" data-action="refine--submit-form#submit">
+            <%= filter.name %>
+          </a>
+        <% end %>
+    <% end %>
+  </div>
+<% end %>

data/app/views/refine/inline/stored_filters/new.turbo_stream.erb

@@ -0,0 +1,47 @@
+<% form_id = dom_id(@criterion, :save_form) %>
+
+<%= turbo_stream.update dom_id(@criterion, :save) do %>
+  <% if false && @stored_filter.errors.any? # TODO place in tooltip%>
+    <% @stored_filter.errors.full_messages.each do |message|%>
+      <p class="refine-stored-filter-error"><%= message %></p>
+    <% end %>
+  <% end %>
+
+  <%= tag.div class: "refine--save-filter-form" do %>
+
+    <%= fields model: @criterion do |criteria_fields| %>
+      <%= criteria_fields.hidden_field :client_id, form: form_id %>
+      <%= criteria_fields.hidden_field :stable_id, form: form_id %>
+    <% end %>
+
+    <%= fields model: @stored_filter do |stored_filter_fields| %>
+      <%= stored_filter_fields.label :name, "#{t('.save_filter_label')}" %>
+
+      <%# TODO replace with content-editable that writes to hidden input %>
+      <div class="refine--save-filter-input-wrapper">
+        <div class="refine--tooltip"><%= sanitize t('.tooltip') %></div>
+
+        <%= stored_filter_fields.text_field :name,
+          class: "refine--save-filter-input",
+          placeholder: t('.save_filter_placeholder'),
+          autofocus: true,
+          form: form_id
+         %>
+      </div>
+    <% end %>
+
+  <% end %>
+<% end %>
+
+
+<%# The actual form tag is appended to the end of the body html.  Inputs are attached using the `form` attribute. This allows the query builder to be placed inside an outer form on the page. %>
+<%= turbo_stream.append_all "body" do %>
+  <%= form_with(
+    url: refine_inline_stored_filters_path,
+    method: :post,
+    class: "refine--save-filter-form",
+    id: form_id,
+    data: {
+      turbo_frame: dom_id(@criterion, :save)
+    }) %>
+<% end %>

data/app/views/refine/stored_filters/create.turbo_stream.erb

@@ -0,0 +1,2 @@
+<%= turbo_stream.replace dom_id(@refine_filter_builder, "stored_filters"), template: "refine/stored_filters/new" %>
+<%= turbo_stream.replace(dom_id(@refine_filter_builder, "query"), partial: "refine/blueprints/query") %>

data/app/views/refine/stored_filters/find.turbo_stream.erb

@@ -0,0 +1,5 @@
+<%= turbo_stream.replace "stored_filters",
+  partial: "refine/blueprints/stored_filters" %>
+
+<%= turbo_stream.replace dom_id(@refine_filter_builder, :query),
+  partial: "refine/blueprints/query" %>

data/app/views/refine/stored_filters/index.html.erb

@@ -0,0 +1,39 @@
+<%= turbo_frame_tag "stored_filters" do %>
+  <% if flash.alert %>
+    <p class="refine-criterion-error">
+      <%= flash.alert %>
+    </p>
+  <% end %>
+
+  <%= content_tag :div, class: "refine-stored-filter-search-container" do %>
+    <%= form_with(
+        model: @refine_filter_builder,
+        url: find_refine_stored_filters_path,
+        method: :post,
+        class: "refine-stored-filter-search-form") do |form| %>
+      <!-- Saved filter selector -->
+        <%= form.hidden_field :filter_class %>
+        <%= form.hidden_field :client_id %>
+        <%= tag.div class: 'refine-stored-filter-search-selector-container', data: {
+          controller: 'fields--super-select',
+          fields__super_select_enable_search_value: 'true'
+        } do %>
+          <select
+            data-fields--super-select-target="select"
+            name="id"
+          >
+            <option disabled selected value>&mdash; <%= t("refine.stored_filters.select_saved_filter") %> &mdash;</option>
+            <% @stored_filters.each do |filter| %>
+              <option
+                value="<%= filter.id %>"
+              >
+                <%= filter.name %>
+              </option>
+            <% end %>
+          </select>
+        <% end %>
+        <%= link_to t('global.buttons.back'), stored_filters_refine_blueprint_path(@refine_filter_builder.to_params), class: "refine-stored-filter-search-button-cancel"%>
+        <%= button_tag t('global.buttons.choose_filter'), type: "submit", class: "refine-stored-filter-search-button-submit" %>
+      <% end %>
+    <% end %>
+<% end%>

data/app/views/refine/stored_filters/new.html.erb

@@ -0,0 +1,29 @@
+<%= turbo_frame_tag "stored_filters" do %>
+  <%= content_tag :div, class: "refine-stored-filter-container", data: {
+    controller: 'refine--stored-filter',
+    refine__stored_filter_id_value: @stored_filter&.id,
+    refine__stored_query_id_value: @refine_filter_builder.client_id,
+    refine__stored_filter_state_dom_id_value: dom_id(@refine_filter_builder, "query"),
+    action: 'blueprint-updated@window->refine--stored-filter#updateBlueprintField'
+  } do %>
+    <% if @stored_filter.errors.any? %>
+      <% @stored_filter.errors.full_messages.each do |message|%>
+        <p class="refine-stored-filter-error"><%= message %></p>
+      <% end %>
+    <% end %>
+    <%= form_with(model: @refine_filter_builder, url: refine_stored_filters_path, method: :post,
+      class: "refine-stored-filter-form", data: {
+        turbo_frame: :stored_filters
+      }) do |form| %>
+        <%= form.hidden_field :client_id %>
+        <%= form.hidden_field :filter_class %>
+        <%= form.hidden_field :blueprint_json, data: {refine__stored_filter_target: "blueprintField"} %>
+        <input type="text" name="name" placeholder="<%= t('global.filter_name_placeholder')%>"
+          class="refine-stored-filter-input"
+          value="<%= @stored_filter.name %>"
+        />
+        <%= link_to t('global.buttons.back'), stored_filters_refine_blueprint_path(@refine_filter_builder.to_params), class: "refine-stored-filter-search-button-cancel"%>
+        <%= button_tag t('global.buttons.save'), type: "submit", class: "refine-stored-filter-button-submit" %>
+      <% end %>
+    <% end %>
+<% end%>

data/app/views/refine/stored_filters/show.html.erb

@@ -0,0 +1 @@
+<%= render partial: "editor" %>

data/config/locales/en/dates.en.yml

@@ -0,0 +1,29 @@
+en:
+  time:
+    formats:
+      z: "%Z"
+  date:
+    order:
+    - :year
+    - :month
+    - :day
+    formats:
+      default: "%Y-%m-%d"
+      long: "%B %d, %Y"
+      short: "%b %d"
+      dmy: "%m/%d/%y"
+      z: "%Z"
+      stamp: "%Y%m%d" # YYYYMMDD
+      # formats shared with datetimes
+      month_and_year: "%B %Y" # results like: June 2018
+      month_day_year: "%B %e, %Y" # results like: June 6, 2018
+      abrv_month_day: "%b %-d" # results like: Jan 30
+      abrv_month_day_year: "%b %e, %Y" # results like: June 6, 2018
+      pretty: "%a, %b %e at %l:%M%p %Z" # results like: Wed, Jun 6 at 7:19AM UTC
+      pretty_time: "%l:%M%p %Z" # results like: 7:19AM UTC
+      pretty_time_simple: "%l:%M%p" # results like: 7:19AM
+      display_time: "%l:%M %p" # results like 4:22 PM
+      pretty_date_time_zone: "%a, %b %d, %Y at %l:%M %p %Z" # results like: Thu, Apr 19, 2018 at 2:32 PM UTC
+      pretty_day: "%A, %B %e"
+      date_range_field: "%m/%d/%y" # results like: 05/26/2022
+      date_plus_time_with_zone: "%m/%d/%y %l:%M%p %Z" # results like: 05/26/22 7:19AM UTC

data/config/locales/en/en.yml

@@ -0,0 +1,20 @@
+en:
+  global:
+    filter_name_placeholder: Name your filter 
+    buttons:
+      apply: Apply
+      cancel: Cancel
+      find_filter: Find a saved filter
+      save_filter: Save this filter 
+      choose_filter: Load filter 
+      filter: Filter
+      back: Back
+      save: Save
+      save_filter: Save this filter
+  refine:
+    refine_blueprints:
+      add_group:
+        create_filter: "Create a Filter"
+        add_or: "OR"
+      add_and:
+        add_and: "AND"

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

@@ -0,0 +1,187 @@
+en:
+  refine:
+    date:
+      formats:
+        ruby: "%m/%d/%y"
+        moment: "MM/DD/YYYY"
+    time:
+      formats:
+        ruby: "%m/%d/%Y %l:%M %p"
+        moment: "MM/DD/YYYY h:mm A"
+    daterangepicker:
+      firstDay: 1
+      separator: " - "
+      applyLabel: "Apply"
+      cancelLabel: "Cancel"
+      fromLabel: "From"
+      toLabel: "To"
+      customRangeLabel: "Custom"
+      weekLabel: "W"
+      daysOfWeek:
+      - "Su"
+      - "Mo"
+      - "Tu"
+      - "We"
+      - "Th"
+      - "Fr"
+      - "Sa"
+      monthNames:
+      - "January"
+      - "February"
+      - "March"
+      - "April"
+      - "May"
+      - "June"
+      - "July"
+      - "August"
+      - "September"
+      - "October"
+      - "November"
+      - "December"
+      firstDay: 0
+    date_range_controller:
+      today: Today
+      yesterday: yesterday
+      last7Days: Last 7 Days
+      last30Days: Last 30 Days
+      thisMonth: This Month
+      lastMonth: Last Month
+    filter_pills:
+      pill_and:
+        and: and
+        or: or
+    stored_filters:
+      select_saved_filter: "Select a saved filter"
+    inline:
+      filters:
+        load_button: "Load Filter"
+        or_button: "+ Add OR Group"
+        filter: "Filter"
+        criteria_limit: "You can only create up to %{criteria_limit} filter conditions"
+        save_filter: "Save Filter"
+        or: "or"
+      inputs:
+        date_number_of_placeholder: "Number of"
+        days: "days"
+        and: "and"
+
+    refine_blueprints:
+      add_and:
+        add_and: "AND"
+      add_group: 
+        add_or: "Add OR"
+        create_filter: "Create a filter"
+      group:
+        buttons:
+          add_and: "And"
+
+      query:
+        loading: "Loading..."
+        buttons:
+          add_or: "Add an 'OR'"
+          create_filter: "Create a filter"
+          remove_filter: "Remove filter"
+        query_or: "or"
+
+      boolean_condition:
+        is_true: is true
+        is_false: is false
+        is_set: is set
+        is_not_set: is not set
+      clause:
+        required: required
+      clauses:
+        date_condition:
+          number_of: "Number of"
+          days: days
+          ago: ago
+          from_now: from now
+          and: and
+          first_date: First Date
+          second_date: Second Date
+          date_number_of_placeholder: "Number of"
+      condition:
+        attribute_required: An attribute is required.
+        condition_must_have_id: Every condition must have an ID
+        clause_not_found:  "The clause with id %{clause} was not found"
+        a_is_required: "A %{k} is required"
+      date_condition:
+        date1_error: date1 is not a real date
+        date2_error: date2 is not a real date
+        date1_greater_date2_error: Start date must be an earlier date than end date
+        timezone_error: "%{zone} timezone does not exist in ActiveSupport::TimeZone"
+        and: and
+        days: days
+        ago: ago
+        from_now: from now
+        not_supported: not supported
+        is_on: "on"
+        not_on: not on
+        is_on_or_before: is on or before
+        is_on_or_after: is on or after
+        is_between: is between
+        is_not_between: is not between
+        is_more_than: is more than
+        is: is
+        is_less_than: is less than
+        is_set: is set
+        is_not_set: is not set
+      filter_condition:
+        must_be_array: Select must be an array
+        options_not_determined: "No options could be determined"
+        must_have_id_and_display: An option must have an id and a display attribute.
+        must_be_unique: "Options must have unique IDs. Duplicate %{duplicates} found."
+        not_found: Filter not found
+        in: "Includes"
+        not_in: "Does Not Include"
+      has_clauses:
+        not_determined: "No clause could be determined?"
+        must_be_instance_of: "Every clause must be an instance of %{instance}"
+        must_have_id_and_display: "A clause must have both id and display keys"
+        not_found: "Clause with id: %{id} not found"
+      has_refinements:
+        not_allowed: "Refinements are not allowed"
+      numeric_condition:
+        and: and
+        not_supported: not supported
+        is: is
+        is_not: is not
+        is_gt: is greater than
+        is_gtteq: is greater than or equal to
+        is_lt: is less than
+        is_lteq: is less than or equal to
+        is_between: is between
+        is_not_between: is not between
+        is_set: is set
+        is_not_set: is not set
+      option_condition:
+        not_supported: not supported
+        must_be_array: "Select must be an array"
+        not_approved: "Selected %{select} is not configured in options list"
+        not_determined: "No options could be determined"
+        must_have_id_and_display: "An option must have an id and a display attribute."
+        must_be_unique: "Options must have unique IDs. Duplicate %{duplicates} found."
+        is: is
+        is_not: is not
+        is_one_of: is one of
+        is_not_one_of: is not one of
+        is_set: is set
+        is_not_set: is not set
+      text_condition:
+        is: "is"
+        is_not: "is not"
+        starts_with: "starts with"
+        ends_with: "ends with"
+        does_not_start_with: "does not start with"
+        does_not_end_with: "does not end with"
+        contains: "contains"
+        does_not_contain: "does not contain"
+        is_set: "is set"
+        is_not_set: "is not set"
+
+      inline:
+        filters:
+          add_first_condition_button:
+            filter: "Filter"
+          load_button:
+            load_filter: "Load Filter"

data/config/routes.rb

@@ -0,0 +1,17 @@
+Rails.application.routes.draw do
+  namespace :refine do
+    resource :blueprint, only: [:show, :new, :create] do
+      get "stored_filters", on: :collection
+      get "validate", on: :collection
+    end
+    resources :stored_filters, only: [:index, :new, :create] do
+      post "find", on: :collection
+    end
+    namespace :inline do
+      resources :criteria, except: [:show]
+      resources :stored_filters, only: [:index, :new, :create] do
+        post "find", on: :collection
+      end
+    end
+  end
+end

data/lib/generators/filter/filter_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Generates a filter for a given model.
+class FilterGenerator < Rails::Generators::NamedBase
+  CONDITIONS = %w[text date numeric].freeze
+  source_root File.expand_path('templates', __dir__)
+
+  def create_filter
+    @conditions = extract_conditions(args)
+    template 'filter.rb.erb', "app/filters/#{plural_name}_filter.rb"
+  end
+
+  private
+
+  def extract_conditions(args)
+    conditions = []
+    args.each do |arg|
+      field, condition = arg.split(':')
+
+      throw "#{condition} is an invalid condition" unless CONDITIONS.include? condition
+
+      conditions << { field: field, condition: condition.capitalize }
+    end
+
+    conditions
+  end
+end