refine-rails 2.9.1 → 2.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a54fd34a98179098e040456276d0109895a9963b23f45d8a4349341f741ec58
-  data.tar.gz: daba33b740e07950606b1935a5726d4650386d38aef645d4de0c7d07eabea546
+  metadata.gz: 0c511b1d652c0c97df24249a54ff96afcf0857129194e6babd19207cf6418dec
+  data.tar.gz: 3ffebe81b88605d56aec0bcea24b79b1b3c181228bec5d06bea8c33a16a445c7
 SHA512:
-  metadata.gz: 7711ae2669c9b3e9b93b77e1217dd98f44fe55d6f91ebd0b5b2d45006b6b88aa0918825af3c2d5dec4d92467ab27152f4d07c5807595280e8b790db75f70e6ed
-  data.tar.gz: 64b1ae0855a94252aeb1544f9e8ea07571d5a47e5e584c297adc4297c40a88990505072cc68ec76e16900ef65b09a06e3eee894d990d81018ccfa67bc69247cc
+  metadata.gz: 53db67c1486011495f1efbe6cccd3a8508697d23eea902c738277a5b55f3cc1ef460bf54960bff7dc40b6db7d75daa4b6a895430c81a6034daf80a1bfd13393b
+  data.tar.gz: 7dc1a7a8d51967bdb15f33b074a4564690b80be1902ab35bd67526dc9fbf2f492f34db3d6513987f9a620eeb16cf839ea4931f052e299ca8bf3a048ef39dc638

data/README.md

@@ -42,41 +42,6 @@ This is a helper method you can inspect in `Hammerstone::FilterApplicationContro
     @pagy, @contacts = pagy(@refine_filter.get_query)
 ```
 
-# TODO: Everything below this header was not covered in the installation guide. Not sure if it is deprecated
-
-12. Add the `reveal` controller to your application if using the `filter_builder_dropdown` partial
-
-`yarn add stimulus-reveal`
-
-```javascript
-//index.js
-import RevealController from 'stimulus-reveal'
-
-application.register('reveal', RevealController)
-```
-
-~13. If the gems tailwind styles are being purged with JIT you can add the gem to `tmp/gems` and add this to your tailwing config.~ 
-
-``` tailwind.config.js
-  './tmp/gems/*/app/views/**/*.html.erb',
-  './tmp/gems/*/app/helpers/**/*.rb',
-  './tmp/gems/*/app/assets/stylesheets/**/*.css',
-  './tmp/gems/*/app/javascript/**/*.js',
-```
-
-~Run the following rake task:~ 
-```
-task :add_temp_gems do 
-  target = `bundle show refine-rails`.chomp
-  if target.present?
-    puts "Linking refine-rails to '#{target}'."
-    `ln -s #{target} tmp/gems/refine-rails`
-  end
-end
-```
-
-Don't forget to restart the server! 
-
 14. Add external styles - currently themify icons (can be overriden - the trash can icon is located in `_criterion.html.erb`) and `daterangepicker`
 A quick way to load them is in the `head` section. Also available as an npm package. 
 
@@ -374,25 +339,11 @@ import { controllerDefinitions as refineControllers } from "@hammerstone/refine-
 application.load(refineControllers)
 ```
 
-## Readme Installation Goals (what we're working towards - does not work yet) 
-
-1. Run the generator  
-`rails generate refine:install`
-
-2. Define your filters, subclassing from `Hammerstone::Refine::Filter` 
-
-3. Call `apply_filter` in your controller (or even better, instantiate the filter in your controller `@contacts = ContactFilter.new(blueprint, initial_query` -> might not be possible, how can we do this with validations?)
-
-4. If you want to customize the views you can override our stylesheet with you own. 
-If you need even more customization you can override the views with `rails generate refine:views` will extract the views
-
-5. Add custom datepicker if desired and scope stored filters. 
- 
 ## Releasing New Versions
 
 - Every release should update the gem and NPM package so version numbers stay in sync.
 - Make sure to update the CHANGELOG with a note explaining what the new version does
-- Make sure you have the [bump](https://rubygems.org/gems/bump) and [gemfury](https://rubygems.org/gems/gemfury) gems installed locally
+- Make sure you have the [bump](https://rubygems.org/gems/bump) gems installed locally
 
 ### Releasing the Ruby Gem
 

data/app/assets/stylesheets/index.tailwind.css

@@ -224,7 +224,7 @@
   }
 
   .refine-criterion-refinement-container {
-    @apply w-full pt-3 sm:w-auto sm:flex-shrink-0 sm:mr-3;
+    @apply w-full sm:w-auto sm:flex-shrink-0;
   }
 
   /* _delete_criterion.html.erb */
@@ -601,6 +601,10 @@
     padding: 0.5rem 0;
 }
 
+.refine--refinement-input-container {
+  margin: 0.5rem 0;
+}
+
 
 /*  _date_condition.html.erb */
 .refine--date-condition-days-text {

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

@@ -118,6 +118,12 @@ class Refine::Inline::CriteriaController < ApplicationController
           :clause,
           :value1,
           :value2
+        ],
+        date_refinement_attributes: [
+          :clause,
+          :date1,
+          :date2,
+          :days
         ]
       ]
     )

data/app/models/refine/filter.rb

@@ -50,7 +50,6 @@ module Refine
       end
     end
 
-    # DEPRECATED use Refine::Filters::Criterion#human_readable instead
     def human_readable_criterions
       output = []
       if blueprint.present?
@@ -58,7 +57,13 @@ module Refine
           if criterion[:type] == "conjunction"
             output << criterion[:word]
           else
-            output << get_condition_for_criterion(criterion).human_readable(criterion[:input])
+            condition = get_condition_for_criterion(criterion)
+            text = condition.human_readable(criterion[:input])
+            if condition.has_date_refinement?
+              date_refinement_condition = condition.has_date_refinement?.call
+              text += date_refinement_condition.human_readable(criterion[:input][:date_refinement])
+            end
+            output << text
           end
         end
       end

data/app/models/refine/inline/criteria/date_refinement.rb

@@ -0,0 +1,14 @@
+class Refine::Inline::Criteria::DateRefinement
+  include ActiveModel::Model
+
+  attr_accessor :clause, :date1, :date2, :days
+
+  def attributes
+    {
+      clause: clause,
+      date1: date1,
+      date2: date2,
+      days: days
+    }.compact
+  end
+end

data/app/models/refine/inline/criteria/input.rb

@@ -15,7 +15,8 @@ class Refine::Inline::Criteria::Input
   :value,
   :value1,
   :value2,
-  :count_refinement
+  :count_refinement,
+  :date_refinement
 
   def attributes
     {
@@ -28,7 +29,8 @@ class Refine::Inline::Criteria::Input
       value: value,
       value1: value1,
       value2: value2,
-      count_refinement_attributes: count_refinement_attributes.presence
+      count_refinement_attributes: count_refinement_attributes.presence,
+      date_refinement_attributes: date_refinement_attributes.presence
     }.compact
   end
 
@@ -44,6 +46,18 @@ class Refine::Inline::Criteria::Input
     count_refinement.attributes = attrs.to_h
   end
 
+  def date_refinement
+    @date_refinement ||= Refine::Inline::Criteria::DateRefinement.new
+  end
+
+  def date_refinement_attributes
+    date_refinement.attributes
+  end
+
+  def date_refinement_attributes=(attrs = {})
+    date_refinement.attributes = attrs.to_h
+  end
+
   def selected=(value)
     @selected = Array.wrap(value)
   end

data/app/models/refine/inline/criterion.rb

@@ -21,6 +21,7 @@ class Refine::Inline::Criterion
     attrs[:input_attributes] = attrs.delete(:input)
     if input_attrs = attrs[:input_attributes]
       input_attrs[:count_refinement_attributes] = input_attrs.delete(:count_refinement)
+      input_attrs[:date_refinement_attributes] = input_attrs.delete(:date_refinement)
     end
     new(attrs)
   end
@@ -93,6 +94,7 @@ class Refine::Inline::Criterion
     result[:input] = result.delete(:input_attributes)
     if input_attrs = result[:input]
       input_attrs[:count_refinement] = input_attrs.delete(:count_refinement_attributes)
+      input_attrs[:date_refinement] = input_attrs.delete(:date_refinement_attributes)
     end
     result
   end
@@ -121,8 +123,6 @@ class Refine::Inline::Criterion
   end
 
   def validate!
-    # TODO figure out how to validate inputs with count refinements
-    return if input.count_refinement.attributes.present?
     errors.clear
     begin
       query_for_validate = refine_filter.initial_query || refine_filter.model.all

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

@@ -5,33 +5,38 @@
   refine__update_criterion_id_value: criterion_id,
   position: criterion.position}) do %>
 
+  <div class="refine-criterion-line">
   <!-- Select Condition -->
-  <div class="refine-criterion-condition-container">
-    <%= render partial: 'refine/blueprints/condition_select', locals: {
-      selected_condition_id: criterion.condition_id } %>
-  </div>
+    <div class="refine-criterion-condition-container">
+      <%= render partial: 'refine/blueprints/condition_select', locals: {
+        selected_condition_id: criterion.condition_id } %>
+    </div>
 
-  <!-- Select Clause -->
-  <div class="refine-criterion-clause-container">
-    <%= render partial: 'refine/blueprints/clause_select', locals: {
-        meta: criterion.meta, selected_clause: criterion.input[:clause]} %>
-  </div>
+    <!-- Select Clause -->
+    <div class="refine-criterion-clause-container">
+      <%= render partial: 'refine/blueprints/clause_select', locals: {
+          meta: criterion.meta, selected_clause: criterion.input[:clause]} %>
+    </div>
 
-  <!-- Render correct type of condition -->
-  <%= render partial: "refine/blueprints/clauses/#{criterion.component}", locals: {
-    criterion: criterion,
-    condition: criterion.condition, input: criterion.input, criterion_id: criterion_id, meta: criterion.meta, meta_clause: criterion.selected_clause_meta, input_id: nil } %>
+    <!-- Render correct type of condition -->
+    <%= render partial: "refine/blueprints/clauses/#{criterion.component}", locals: {
+      criterion: criterion,
+      condition: criterion.condition, input: criterion.input, criterion_id: criterion_id, meta: criterion.meta, meta_clause: criterion.selected_clause_meta, input_id: nil } %>
+  </div>
 
   <!-- Refinements -->
   <% criterion.refinements.each do |refinement|%>
 
-    <div class="refine-criterion-refinement-container">
-      <%= render partial: 'refine/blueprints/clause_select', locals: {
-        meta: refinement[:meta], input_id: "input, #{refinement[:id]}", selected_clause: criterion.input.dig(:input, refinement[:id].to_sym, :clause) || {} } %>
-    </div>
+    <div class="refine-criterion-refinement-line">
+      <i class="fa-thin fa-l"></i>
+      <div class="refine-criterion-refinement-container">
+        <%= render partial: 'refine/blueprints/clause_select', locals: {
+          meta: refinement[:meta], input_id: "input, #{refinement[:id]}", selected_clause: criterion.input.dig(refinement[:id].to_sym, :clause) || {} } %>
+      </div>
 
-    <%= render partial: "refine/blueprints/clauses/#{refinement[:component].underscore}", locals: {
-      condition: refinement, input: criterion.input[refinement[:id].to_sym] || {}, criterion_id: criterion_id, meta: refinement[:meta], input_id: "input, #{refinement[:id]}", meta_clause: criterion.meta_for_refinement_clause(refinement), criterion: criterion} %>
+      <%= render partial: "refine/blueprints/clauses/#{refinement[:component].underscore}", locals: {
+        condition: refinement, input: criterion.input[refinement[:id].to_sym] || {}, criterion_id: criterion_id, meta: refinement[:meta], input_id: "input, #{refinement[:id]}", meta_clause: criterion.meta_for_refinement_clause(refinement), criterion: criterion} %>
+    </div>
   <% end %>
   <!-- End Refinements -->
 

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

@@ -1,3 +1,18 @@
+<%
+  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
+
+  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 %>
@@ -10,16 +25,66 @@
   <%# Input Value %>
   <% unless ['st', 'nst'].include? @criterion.input.clause %>
     <%= render @criterion.input_partial, criterion: @criterion, form: form, input_fields: input_fields, form_id: form_id %>
+    <% if last_clause_select == :criterion %>
+      <div class="refine--separator"></div>
+    <% end %>
+  <% end %>
+
+  <%# 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,
+      {},
+      class: "refine--select refine--clause-select",
+      data: {action: "change->refine--criterion-form#refresh"},
+      form: form_id
+    %>
+    <% if last_clause_select == :criterion %>
+      <%= form.button t('global.buttons.apply'), class: "refine--apply-button", type: "submit", form: form_id %>
+    <% end %>
+  </div>
+
+  <%# Date Refinement  %>
+  <% if @criterion.condition.has_date_refinement? %>
     <div class="refine--separator"></div>
+    <label style="color: black;"><%= date_refinement_condition.display %></label>
+    <%= input_fields.fields :date_refinement_attributes, model: @criterion.input.date_refinement do |date_fields| %>
+      <div class="refine--refinement-input-container">
+        <% unless ['st', 'nst'].include? @criterion.input.date_refinement.clause %>
+          <%= render "refine/inline/inputs/date_condition", criterion: @criterion, form: form, input_fields: date_fields, form_id: form_id %>
+        <% end %>
+
+      </div>
+
+      <div class="refine--criterion-clause-container">
+        <%= 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
+        %>
+        <% if last_clause_select == :date %>
+          <%= form.button t('global.buttons.apply'), class: "refine--apply-button", type: "submit", form: form_id %>
+        <% end %>
+      </div>
+    <% end %>
+
   <% end %>
 
   <%# Count Refinement  %>
-  <% if @criterion.condition.has_count_refinement? %>
+  <% if count_refinement_condition %>
     <label style="color: black;"><%= @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,
-          @criterion.condition.get_count_refinement_condition.clauses,
+          count_refinement_condition.approved_clauses,
           :id,
           :display,
           {},
@@ -29,28 +94,34 @@
       </div>
 
       <% unless ['st', 'nst'].include? @criterion.input.count_refinement.clause %>
-        <%= render "refine/inline/inputs/numeric_condition", input_fields: count_fields, form_id: form_id %>
+        <%= render "refine/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 %>
 
 
 
-  <%# 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,
-      {},
-      class: "refine--select refine--clause-select",
-      data: {action: "change->refine--criterion-form#refresh"},
-      form: form_id
-    %>
-    <%= form.button t('global.buttons.apply'), class: "refine--apply-button", type: "submit", form: form_id %>
-  </div>
+
 
 
 <% end %>

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

@@ -17,7 +17,6 @@
          </div>
       </div>
     </div>
-
   </div>
 
 <% end %>

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

@@ -1,6 +1,6 @@
-<% if criterion.input.clause.in? ["exct", "gt", "lt"] %>
+<% if input_fields.object.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" %>
+<% elsif input_fields.object.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 %>

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

@@ -2,7 +2,7 @@
   <%= render "refine/inline/inputs/date_picker",
     input_fields: input_fields,
     attribute: :date1,
-    value: criterion.input.date1,
+    value: input_fields.object.date1,
     label: "#{criterion.condition.display.downcase} (#{t('.min')})",
     form_id: form_id
   %>
@@ -13,7 +13,7 @@
     <%= render "refine/inline/inputs/date_picker",
       input_fields: input_fields,
       attribute: :date2,
-      value: criterion.input.date2,
+      value: input_fields.object.date2,
       label: "#{criterion.condition.display.downcase} (#{t('.max')})",
       form_id: form_id
     %>

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

@@ -2,7 +2,7 @@
   <%= render "refine/inline/inputs/date_picker",
     input_fields: input_fields,
     attribute: :date1,
-    value: criterion.input.date1,
+    value: input_fields.object.date1,
     label: criterion.condition.display.downcase,
     form_id: form_id
   %>

data/lib/refine/rails/version.rb

@@ -1,5 +1,5 @@
 module Refine
   module Rails
-    VERSION = "2.9.1"
+    VERSION = "2.9.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refine-rails
 version: !ruby/object:Gem::Version
-  version: 2.9.1
+  version: 2.9.3
 platform: ruby
 authors:
 - Colleen Schnettler
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -101,6 +101,7 @@ files:
 - app/models/refine/filters/builder.rb
 - app/models/refine/filters/criterion.rb
 - app/models/refine/filters/query.rb
+- app/models/refine/inline/criteria/date_refinement.rb
 - app/models/refine/inline/criteria/input.rb
 - app/models/refine/inline/criteria/numeric_refinement.rb
 - app/models/refine/inline/criteria/option.rb
@@ -177,7 +178,7 @@ files:
 - lib/tasks/refine/rails_tasks.rake
 homepage: https://rubygems.org/gems/refine-rails
 licenses:
-- Nonstandard
+- MIT
 metadata:
   homepage_uri: https://rubygems.org/gems/refine-rails
   source_code_uri: https://github.com/clickfunnels2/refine-rails
@@ -197,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Visual query builder for Rails