administrate_ransack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: faad99daa51ceb91223e79770bc0df8aeb7adae21d76044b510cd7628a8fe323
+  data.tar.gz: 3b1e7a5f12bc54086a182a72715342c52c79e0bdeef77af03a79bf0f659aa590
+SHA512:
+  metadata.gz: bb14807a4275bdc1d62467bca4d30bc3ec9010df4af46516351ad3ec63b9cd863fce18a87dfac75d20d35a785561fea58a254457eadb645d69d9d0163878dd2c
+  data.tar.gz: e4f7f6c47e66712a9c574ff0394739189a402f33281612113129ec10af6166d85ef5a8d73b0922a5d47e99f245e18ddd961abdec48cb491e525fd4b44110b9d2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Mattia Roccoberton
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Administrate Ransack [![Gem Version](https://badge.fury.io/rb/administrate_ransack.svg)](https://badge.fury.io/rb/administrate_ransack)
+A plugin for [Administrate](https://github.com/thoughtbot/administrate) to use [Ransack](https://github.com/activerecord-hackery/ransack) for filtering resources.
+
+Features:
+- add Ransack method via module prepend in controller;
+- offer a filters bar based on the resource's attributes;
+- customize searchable attributes.
+
+## Installation
+- After installing Administrate, add to *Gemfile*: `gem 'administrate_ransack'` (and execute `bundle`)
+- Edit your admin resource controller adding inside the class body:
+```rb
+prepend AdministrateRansack::Searchable
+```
+- Add to your resource index view:
+```erb
+<%= render('administrate_ransack/filters', attribute_types: page.attribute_types) %>
+```
+
+## Customizations
+- Setup the fields for the filters in the index view:
+```erb
+<% attribute_types = {
+  author: Administrate::Field::BelongsTo,
+  title: Administrate::Field::String,
+  published: Administrate::Field::Boolean
+} %>
+<%= render(
+  'administrate_ransack/filters',
+  attribute_types: attribute_types
+) %>
+```
+- Optionally setup the layout for filters as a sidebar:
+```css
+.main-content__body {
+  display: inline-block;
+  width: calc(100% - 320px);
+  vertical-align: top;
+}
+
+[data-administrate-ransack-filters] {
+  display: inline-block;
+  padding-left: 10px;
+  padding-top: 10px;
+  width: 300px;
+}
+
+[data-administrate-ransack-filters] .filter {
+  margin-bottom: 10px;
+}
+
+[data-administrate-ransack-filters] .filters-buttons {
+  margin-top: 30px;
+}
+```
+
+## Notes
+- 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
+
+## Do you like it? Star it!
+If you use this component just star it. A developer is more motivated to improve a project when there is some interest.
+
+## Contributors
+- [Mattia Roccoberton](https://blocknot.es/): author
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end

data/app/views/administrate_ransack/_filters.html.erb

@@ -0,0 +1,60 @@
+<%= search_form_for [:admin, @ransack_results], html: { 'data-administrate-ransack-filters': '1' } do |f| %>
+  <div class="filters">
+    <% attribute_types.each do |field, type| %>
+      <% next if field == :id %>
+
+      <div class="filter">
+        <% input_type = type.is_a?(Administrate::Field::Deferred) ? type.deferred_class.to_s : type.to_s %>
+        <% case input_type %>
+        <% when 'Administrate::Field::BelongsTo' %>
+          <% association = @ransack_results.klass.reflections[field.to_s] %>
+          <% if association %>
+            <% label = association.klass.method_defined?(:admin_label) ? :admin_label : :to_s %>
+            <%= f.label field %>
+            <%= f.collection_select "#{field}_id_eq", association.klass.all, :id, label, include_blank: true %>
+          <% end %>
+        <% when 'Administrate::Field::Boolean' %>
+          <%= f.label field %>
+          <%= f.select "#{field}_eq", [['no', false], ['yes', true]], include_blank: true %>
+        <% when 'Administrate::Field::Date' %>
+          <%= f.label field %>
+          <%= f.date_field "#{field}_gteq" %>
+          <%= f.date_field "#{field}_lteq" %>
+        <% when 'Administrate::Field::DateTime' %>
+          <%= f.label field %>
+          <%= f.datetime_field "#{field}_gteq" %>
+          <%= f.datetime_field "#{field}_lteq" %>
+        <% when 'Administrate::Field::Email', 'Administrate::Field::String', 'Administrate::Field::Text' %>
+          <%= f.label field %>
+          <%= f.search_field "#{field}_cont" %>
+        <% when 'Administrate::Field::Number' %>
+          <%= f.label field %>
+          <%= f.number_field "#{field}_eq" %>
+        <% when 'Administrate::Field::HasMany' %>
+          <% association = @ransack_results.klass.reflections[field.to_s] %>
+          <% if association %>
+            <% label = association.klass.method_defined?(:admin_label) ? :admin_label : :to_s %>
+            <%= f.label field %>
+            <%= f.collection_check_boxes "#{field}_id_in", association.klass.all, :id, label do |b| %>
+              <%= b.label do %>
+                <%= b.check_box %>
+                <span><%= b.object.send(label) %></span>
+              <% end %>
+            <% end %>
+          <% end %>
+        <% when 'Administrate::Field::Select' %>
+          <%= f.label field %>
+          <%= f.select "#{field}_eq", type.options[:collection], include_blank: true %>
+        <% end %>
+        <%# unsupported Field::HasOne %>
+        <%# unsupported Field::Polymorphic %>
+        <%# unsupported Field::Password %>
+      </div>
+    <% end %>
+  </div>
+
+  <div class="filters-buttons">
+    <%= f.submit %>
+    <%= link_to t('administrate_ransack.filters.clear_filters'), url_for([:admin, @ransack_results.klass]), class: 'btn-clear-filters' %>
+  </div>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  administrate_ransack:
+    filters:
+      clear_filters: Clear filters

data/lib/administrate_ransack.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'administrate_ransack/engine'
+require 'administrate_ransack/searchable'
+
+module AdministrateRansack
+end

data/lib/administrate_ransack/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AdministrateRansack
+  class Engine < ::Rails::Engine
+    isolate_namespace AdministrateRansack
+  end
+end

data/lib/administrate_ransack/searchable.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'ransack'
+
+module AdministrateRansack
+  module Searchable
+    def scoped_resource
+      @ransack_results = super.ransack(params[:q])
+      @ransack_results.result(distinct: true)
+    end
+  end
+end

data/lib/administrate_ransack/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AdministrateRansack
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: administrate_ransack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattia Roccoberton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: administrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: ransack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+description: A plugin for Administrate to use Ransack for filtering resources
+email:
+- mat@blocknot.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/views/administrate_ransack/_filters.html.erb
+- config/locales/en.yml
+- lib/administrate_ransack.rb
+- lib/administrate_ransack/engine.rb
+- lib/administrate_ransack/searchable.rb
+- lib/administrate_ransack/version.rb
+homepage: https://github.com/blocknotes/administrate_ransack
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Administrate Ransack plugin
+test_files: []