effective_resources 1.18.0 → 1.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e85d51e9a321bc50d365988828721b264bd2ef27476a9d3cb3650217f5b130e3
-  data.tar.gz: a98e8d5ba21daa4519e5167b7c19a07bc61d4a3fc21d1b297e67eb19f558dc3b
+  metadata.gz: c0c85319423568e1dd19b9b1055bdd0c320bed118398156cc6cf8e8891c6d116
+  data.tar.gz: 6f9729378c464d1de1fcd1556dc33c5591374efccee47e14044d99f278ff6ca9
 SHA512:
-  metadata.gz: 4e8cf35a3218e404cb37510c2c3b0bfb966a73f85850cd5cd5f7aced1ea024dd505b07f1994d58b5ed2ad81c8ca1daf16898f9bd26c1d88f4fe57ce4c21e278d
-  data.tar.gz: c6fdf528e8a9f8ace078e51410483b0d4f8f4c2bddb367b0559ccc7965181d58668acad33db847c32484e3e215464390df7c01728fd4c8a8cd8064a76432a5bf
+  metadata.gz: 11cedc4d9ee5dce6389bcb9e3505e6638abd6ef3ffefe2383f3ea91ea95cf1eff76c02185c563b3b595e4e0ee808828cd1f3bf6d8f758fef287b7437a9c45f45
+  data.tar.gz: d3a9a54642101af184239b0cb63c33c8a9d66431061da366f1d8dbdd99ec70d2f645248aa5f7de3e235d2c77b7cf2675b8d46168a5c2da782ac937f47853d58e

data/README.md

@@ -354,6 +354,31 @@ You can also call `render_wizard_sidebar(resource)` without the block syntax.
 
 If you add `f.hidden_field(:skip_to_step, value: 'stepc')` you can control the next step.
 
+## Select2 Ajax Controller
+
+This gem provides an admin endpoint for select2 AJAX to fetch users.
+
+To use this endpoint please add
+
+```
+can :admin, :effective_resources
+```
+
+And then create a select field like this:
+
+```
+  = f.select :user_id, current_user.class.all,
+    ajax_url: effective_resources.users_admin_select2_ajax_index_path
+```
+
+To format the results, add a method to your User class. It can return html.
+
+```
+def to_select2
+  "<span>#{user.first_name} #{user.last_name}</span> <small>#{user.email}</small>"
+end
+```
+
 ## Testing
 
 Run tests by:

data/app/controllers/admin/select2_ajax_controller.rb

@@ -0,0 +1,24 @@
+module Admin
+  class Select2AjaxController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_resources) }
+
+    include Effective::Select2AjaxController
+
+    def users
+      collection = current_user.class.all
+
+      respond_with_select2_ajax(collection) do |user|
+        { id: user.to_param, text: user.try(:to_select2) || to_select2(user) }
+      end
+    end
+
+    private
+
+    def to_select2(user)
+      "<span>#{user.first_name} #{user.last_name}</span> <small>#{user.email}</small>"
+    end
+
+  end
+
+end

data/app/controllers/concerns/effective/select2_ajax_controller.rb

@@ -0,0 +1,52 @@
+module Effective
+  module Select2AjaxController
+    extend ActiveSupport::Concern
+
+    def respond_with_select2_ajax(collection, skip_search: false, &block)
+      raise('collection should be an ActiveRecord::Relation') unless collection.kind_of?(ActiveRecord::Relation)
+
+      # Authorize
+      EffectiveResources.authorize!(self, :index, collection.klass)
+
+      # Scope
+      if collection.respond_to?(:select2_ajax)
+        collection = collection.select2_ajax
+      elsif collection.respond_to?(:sorted)
+        collection = collection.sorted
+      end
+
+      # Search
+      if (term = params[:term]).present? && !skip_search
+        collection = Effective::Resource.new(collection).search_any(term)
+      end
+
+      # Paginate
+      per_page = 50
+      page = (params[:page] || 1).to_i
+      last = (collection.reselect(:id).count.to_f / per_page).ceil
+      more = page < last
+
+      offset = [(page - 1), 0].max * per_page
+      collection = collection.limit(per_page).offset(offset)
+
+      # Results
+      results = collection.map do |resource|
+        if block_given?
+          option = yield(resource)
+          raise('expected a Hash with id and text params') unless option.kind_of?(Hash) && option[:id] && option[:text]
+          option
+        else
+          { id: resource.to_param, text: resource.try(:to_select2) || resource.to_s }
+        end
+      end
+
+      # Respond
+      respond_to do |format|
+        format.js do
+          render json: { results: results, pagination: { more: more } }
+        end
+      end
+    end
+
+  end
+end

data/app/helpers/effective_resources_helper.rb

@@ -207,6 +207,20 @@ module EffectiveResourcesHelper
   end
   alias_method :render_resource, :render_resource_partial
 
+  def render_if_exists(partial, atts = {})
+    raise('expected a path') unless partial.kind_of?(String)
+    raise('path should not include spaces') if partial.include?(' ')
+
+    pieces = partial.to_s.split('/') - [nil, '']
+
+    file = pieces.last
+    path = pieces[0..-2].join('/')
+
+    if lookup_context.exists?(file, [path], :partial)
+      render(partial, atts)
+    end
+  end
+
   # Tableize attributes
   # This is used by effective_orders, effective_logging, effective_trash and effective_mergery
   def tableize_hash(obj, table: 'table', th: true, sub_table: 'table', sub_th: true, flatten: true)

data/app/models/effective/resources/relation.rb

@@ -6,6 +6,10 @@ module Effective
       TARGET_LIST_LIMIT = 1500
       TARGET_KEYS_LIMIT = 30000
 
+      DO_NOT_SEARCH_EQUALS = ['unconfirmed_email', 'provider', 'secret', 'crypt', 'salt', 'uid', 'certificate', 'otp', 'ssn']
+      DO_NOT_SEARCH_INCLUDE = ['password']
+      DO_NOT_SEARCH_END_WITH = ['_url', '_param', '_token', '_type', '_id', '_key', '_ip']
+
       # This could be active_model? in which we just return the klass itself here
       # This value ends up being crud_controller resource_scope()
       def relation
@@ -197,18 +201,31 @@ module Effective
         end
 
         # Otherwise, we fall back to a string/text search of all columns
-        columns = Array(columns || search_columns)
+        columns = Array(columns || search_columns).reject do |column|
+          DO_NOT_SEARCH_EQUALS.any? { |value| column == value } ||
+          DO_NOT_SEARCH_INCLUDE.any? { |value| column.include?(value) } ||
+          DO_NOT_SEARCH_END_WITH.any? { |value| column.end_with?(value) }
+        end
+
         fuzzy = true unless fuzzy == false
 
-        conditions = (
-          if fuzzy
-            columns.map { |name| "#{sql_column(name)} #{ilike} :fuzzy" }
-          else
-            columns.map { |name| "#{sql_column(name)} = :value" }
-          end
-        ).join(' OR ')
+        # Retval
+        searched = relation
+        terms = value.split(' ') - [nil, '']
+
+        terms.each do |term|
+          conditions = (
+            if fuzzy
+              columns.map { |name| "#{sql_column(name)} #{ilike} :fuzzy" }
+            else
+              columns.map { |name| "#{sql_column(name)} = :term" }
+            end
+          ).join(' OR ')
+
+          searched = searched.where(conditions, fuzzy: "%#{term}%", term: term)
+        end
 
-        relation.where(conditions, fuzzy: "%#{value}%", value: value)
+        searched
       end
 
       private

data/config/routes.rb

@@ -0,0 +1,13 @@
+Rails.application.routes.draw do
+  mount EffectiveResources::Engine => '/', as: 'effective_resources'
+end
+
+EffectiveResources::Engine.routes.draw do
+
+  namespace :admin do
+    resources :select2_ajax, only: [] do
+      get :users, on: :collection
+    end
+  end
+
+end

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '1.18.0'.freeze
+  VERSION = '1.18.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.18.1
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-06 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -133,6 +133,7 @@ files:
 - README.md
 - app/assets/javascripts/effective_resources.js
 - app/assets/javascripts/effective_resources/effective_ujs.js
+- app/controllers/admin/select2_ajax_controller.rb
 - app/controllers/concerns/effective/crud_controller.rb
 - app/controllers/concerns/effective/crud_controller/actions.rb
 - app/controllers/concerns/effective/crud_controller/dsl.rb
@@ -142,6 +143,7 @@ files:
 - app/controllers/concerns/effective/crud_controller/save.rb
 - app/controllers/concerns/effective/crud_controller/submits.rb
 - app/controllers/concerns/effective/flash_messages.rb
+- app/controllers/concerns/effective/select2_ajax_controller.rb
 - app/controllers/concerns/effective/wizard_controller.rb
 - app/controllers/concerns/effective/wizard_controller/actions.rb
 - app/controllers/concerns/effective/wizard_controller/before_actions.rb
@@ -206,6 +208,7 @@ files:
 - app/views/effective/resource/_actions_glyphicons.html.haml
 - app/views/layouts/effective_mailer_layout.html.haml
 - config/effective_resources.rb
+- config/routes.rb
 - lib/effective_resources.rb
 - lib/effective_resources/effective_gem.rb
 - lib/effective_resources/engine.rb