Merge pull request #6 from blocknotes/scopes

Scopes

.github/workflows/specs.yml

@@ -24,3 +24,9 @@ jobs:
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - name: Run tests
         run: bundle exec rake
+      - name: Archive screenshots for failed tests
+        uses: actions/upload-artifact@v2
+        if: failure()
+        with:
+          name: test-failed-screenshots
+          path: spec/dummy/tmp/screenshots

README.md

@@ -29,6 +29,7 @@ prepend AdministrateRansack::Searchable
 - For associations (_has many_/_belongs to_) the label used can be customized adding an `admin_label` method to the target model which returns a string while the collection can by filtered with `admin_scope`. Example:
 
 ```rb
+# Sample post model
 class Post < ApplicationRecord
   scope :admin_scope, -> { where(published: true) }
 
@@ -38,6 +39,30 @@ class Post < ApplicationRecord
 end
 ```
 
+- To use scopes in filters it's needed to update also the `ransackable_scopes` in the model, example:
+
+```rb
+# Sample post model
+class Post < ApplicationRecord
+  scope :recents, ->(dt = 1.month.ago) { where('dt > ?', dt).order(dt: :desc) }
+  scope :by_category, ->(category) { where(category: category) }
+
+  class << self
+    def ransackable_scopes(_auth_object = nil)
+      %i[by_category recents]
+    end
+  end
+end
+```
+
+```erb
+<!-- Sample index view -->
+<%= render(
+  'administrate_ransack/filters',
+  attribute_types: { recents: Administrate::Field::DateTime, by_category: Administrate::Field::String }
+) %>
+```
+
 ## Notes
 
 - Administrate Search logic works independently from Ransack searches, I suggest to disable it eventually (ex. overriding `show_search_bar?` in the controller or removing the bar from the view)

app/views/administrate_ransack/_filters.html.erb

@@ -30,29 +30,30 @@
       <% next if field == :id %>
 
       <% label = attribute_labels.include?(field) ? attribute_labels[field] : field %>
+      <% model = @ransack_results.klass %>
       <% input_type = type.is_a?(Administrate::Field::Deferred) ? type.deferred_class.to_s : type.to_s %>
       <div class="filter <%= input_type.parameterize %>">
         <% case input_type %>
         <% when 'Administrate::Field::BelongsTo' %>
-          <% association = @ransack_results.klass.reflections[field.to_s] %>
-          <%= render 'administrate_ransack/components/field_belongs_to', form: f, field: field, label: label, association: association %>
+          <% association = model.reflections[field.to_s] %>
+          <%= render 'administrate_ransack/components/field_belongs_to', form: f, model: model, field: field, label: label, association: association %>
         <% when 'Administrate::Field::Boolean' %>
-          <%= render 'administrate_ransack/components/field_boolean', form: f, field: field, label: label %>
+          <%= render 'administrate_ransack/components/field_boolean', form: f, model: model, field: field, label: label %>
         <% when 'Administrate::Field::Date' %>
-          <%= render 'administrate_ransack/components/field_date', form: f, field: field, label: label %>
+          <%= render 'administrate_ransack/components/field_date', form: f, model: model, field: field, label: label %>
         <% when 'Administrate::Field::DateTime' %>
-          <%= render 'administrate_ransack/components/field_datetime', form: f, field: field, label: label %>
+          <%= render 'administrate_ransack/components/field_datetime', form: f, model: model, field: field, label: label %>
         <% when 'Administrate::Field::Email', 'Administrate::Field::String', 'Administrate::Field::Text' %>
-          <%= render 'administrate_ransack/components/field_string', form: f, field: field, label: label %>
+          <%= render 'administrate_ransack/components/field_string', form: f, model: model, field: field, label: label %>
         <% when 'Administrate::Field::Number' %>
-          <%= render 'administrate_ransack/components/field_number', form: f, field: field, label: label %>
+          <%= render 'administrate_ransack/components/field_number', form: f, model: model, field: field, label: label %>
         <% when 'Administrate::Field::HasMany' %>
-          <% association = @ransack_results.klass.reflections[field.to_s] %>
-          <%= render 'administrate_ransack/components/field_has_many', form: f, field: field, label: label, association: association %>
+          <% association = model.reflections[field.to_s] %>
+          <%= render 'administrate_ransack/components/field_has_many', form: f, model: model, field: field, label: label, association: association %>
         <% when 'Administrate::Field::Select' %>
-          <%= render 'administrate_ransack/components/field_select', form: f, field: field, label: label, type: type %>
+          <%= render 'administrate_ransack/components/field_select', form: f, model: model, field: field, label: label, type: type %>
         <% else %>
-          <%= render 'administrate_ransack/components/field_other', form: f, field: field, label: label, type: type %>
+          <%= render 'administrate_ransack/components/field_other', form: f, model: model, field: field, label: label, type: type %>
         <% end %>
       </div>
     <% end %>

app/views/administrate_ransack/components/_field_belongs_to.html.erb

@@ -1,6 +1,7 @@
 <% if association %>
+  <% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_id_eq" %>
   <% desc = association.klass.method_defined?(:admin_label) ? :admin_label : :to_s %>
   <% collection = association.klass.send(association.klass.respond_to?(:admin_scope) ? :admin_scope : :all) %>
   <%= form.label(label) %>
-  <%= form.collection_select "#{field}_id_eq", collection, :id, desc, include_blank: true %>
+  <%= form.collection_select(field_key, collection, :id, desc, include_blank: true) %>
 <% end %>

app/views/administrate_ransack/components/_field_boolean.html.erb

@@ -1,3 +1,4 @@
+<% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_eq" %>
 <% values = [[t('administrate_ransack.filters.no'), false], [t('administrate_ransack.filters.yes'), true]] %>
 <%= form.label(label) %>
-<%= form.select "#{field}_eq", values, include_blank: true %>
+<%= form.select(field_key, values, include_blank: true) %>

app/views/administrate_ransack/components/_field_date.html.erb

@@ -1,3 +1,7 @@
 <%= form.label(label) %>
-<%= form.date_field "#{field}_gteq" %>
-<%= form.date_field "#{field}_lteq" %>
+<% if model.ransackable_scopes.include?(field) %>
+  <%= form.date_field(field) %>
+<% else %>
+  <%= form.date_field("#{field}_gteq") %>
+  <%= form.date_field("#{field}_lteq") %>
+<% end %>

app/views/administrate_ransack/components/_field_datetime.html.erb

@@ -1,3 +1,7 @@
 <%= form.label(label) %>
-<%= form.datetime_field "#{field}_gteq" %>
-<%= form.datetime_field "#{field}_lteq" %>
+<% if model.ransackable_scopes.include?(field) %>
+  <%= form.datetime_field(field) %>
+<% else %>
+  <%= form.datetime_field("#{field}_gteq") %>
+  <%= form.datetime_field("#{field}_lteq") %>
+<% end %>

app/views/administrate_ransack/components/_field_has_many.html.erb

@@ -1,8 +1,9 @@
 <% if association %>
+  <% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_id_in" %>
   <% desc = association.klass.method_defined?(:admin_label) ? :admin_label : :to_s %>
   <% collection = association.klass.send(association.klass.respond_to?(:admin_scope) ? :admin_scope : :all) %>
   <%= form.label(label) %>
-  <%= form.collection_check_boxes "#{field}_id_in", collection, :id, desc do |b| %>
+  <%= form.collection_check_boxes(field_key, collection, :id, desc) do |b| %>
     <%= b.label do %>
       <%= b.check_box %>
       <span><%= b.object.send(desc) %></span>

app/views/administrate_ransack/components/_field_number.html.erb

@@ -1,2 +1,3 @@
+<% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_eq" %>
 <%= form.label(label) %>
-<%= form.number_field "#{field}_eq" %>
+<%= form.number_field(field_key) %>

app/views/administrate_ransack/components/_field_select.html.erb

@@ -1,2 +1,3 @@
+<% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_eq" %>
 <%= form.label(label) %>
-<%= form.select "#{field}_eq", type.options[:collection] || [], include_blank: true %>
+<%= form.select(field_key, type.options[:collection] || [], include_blank: true) %>

app/views/administrate_ransack/components/_field_string.html.erb

@@ -1,2 +1,3 @@
+<% field_key = model.ransackable_scopes.include?(field) ? field : "#{field}_cont" %>
 <%= form.label(label) %>
-<%= form.search_field("#{field}_cont") %>
+<%= form.search_field(field_key) %>

spec/dummy/app/models/post.rb

@@ -13,8 +13,8 @@ class Post < ApplicationRecord
 
   validates :title, allow_blank: false, presence: true
 
-  scope :published, -> { where(published: true) }
-  scope :recents, ->(dt = 1.month.ago) { where('created_at > ?', dt).order(created_at: :desc) }
+  scope :recents, ->(dt = 1.month.ago) { where('dt > ?', dt).order(dt: :desc) }
+  scope :by_category, ->(category) { where(category: category) }
 
   def to_s
     title
@@ -30,7 +30,7 @@ def upper_title
 
   class << self
     def ransackable_scopes(_auth_object = nil)
-      %i[published recents]
+      %i[by_category recents]
     end
   end
 end

spec/dummy/app/views/admin/posts/index.html.erb

@@ -73,7 +73,8 @@
   position: Administrate::Field::Number,
   dt: Administrate::Field::Date,
   created_at: Administrate::Field::DateTime,
-  # recents: Administrate::Field::String,
+  recents: Administrate::Field::DateTime,
+  by_category: Administrate::Field::String,
   tags: Administrate::Field::HasMany
 } %>
 

spec/system/scope_filter_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.describe 'Scope filter', type: :system do
+  let(:posts) { Post.where(category: 'news') }
+
+  it 'filters the posts by category (using the scope)' do
+    visit '/admin/posts'
+
+    fill_in('q[by_category]', with: 'news')
+    find('input[type="submit"]').click
+
+    expect(page).to have_current_path %r{/admin/posts\?.+q%5Bby_category%5D=news.*}
+    expect(posts.count).to be_positive
+    expect(page).to have_css('.js-table-row', count: posts.count)
+    posts.each do |post|
+      expect(page).to have_css('.js-table-row a.action-show', text: post.title)
+    end
+  end
+end