effective_resources 1.17.2 → 1.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88760067301847f6d36a2f8550224e019acf06cc9fcc9021a7cf22799e09d560
-  data.tar.gz: 8a922371e95e9f9c91e1cd907b858f19316615508a05077ec5025c7c82c4e1c4
+  metadata.gz: '0823eab342743da2a61c1b174cad39ffc77c6602c8422488bd32c113148b066f'
+  data.tar.gz: 3958c07bc7d38c1c3de867e699b899fddc1833e029b7b639635a08b9a92b9bdc
 SHA512:
-  metadata.gz: c19cbb3988ce98384ff670148617f5779337254fcaee5b4c68f354cd0d9a2bc40d15497db83c53d3f5dd9c37a9e13191f40bf3ed435a8607b05963e2678a292b
-  data.tar.gz: 96e9c5059d55ff3ad40a10f891fd8765eb9fee9d359d19809b1566a47dca26cbccde1f18e4f182f64740c2738134d6e08d93be7170add23ef917bed1631c7a9e
+  metadata.gz: 180567d91706dee43b3ae5ab9e09e9f1abe0f1f352daa1bbf69ed3110564814ddacbc542d8293d5df8093dc94a36d8547a6f4814e307b6966f5ca7e49e7a34a9
+  data.tar.gz: 9852aac45f8341b0e27509d1b82c59f5d739eb3d1194daad74f6f1c1a4e7a29a0705a90dedd15945fa2af14c6cc546429d6f07db559d8785b182fa0a6a2d0c3b

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/crud_controller/save.rb

@@ -60,7 +60,9 @@ module Effective
             when ActiveRecord::StaleObjectError
               flash.now[:danger] = "#{flash.now[:danger]} <a href='#', class='alert-link' onclick='window.location.reload(true); return false;'>reload page and try again</a>"
               raise(ActiveRecord::Rollback) # This is a soft error, we want to display the flash message to user
-            when Effective::ActionFailed, ActiveRecord::RecordInvalid, RuntimeError
+            when Effective::ActionFailed
+              # Nothing to do
+            when ActiveRecord::RecordInvalid, RuntimeError
               raise(ActiveRecord::Rollback) # This is a soft error, we want to display the flash message to user
             else
               raise(e) # This is a real error that should be sent to 500. Client should not see the message.

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)
@@ -248,4 +262,32 @@ module EffectiveResourcesHelper
     controller.class.try(:effective_wizard_controller?) && defined?(resource) && resource.draft?
   end
 
+  def wizard_card(resource, &block)
+    raise('expected a block') unless block_given?
+    raise('expected an acts_as_wizard resource') unless resource.class.respond_to?(:acts_as_wizard?)
+
+    step = resource.render_step
+    raise('expected a render_step') unless step.present?
+
+    title = resource.wizard_step_title(step)
+    raise("expected a title for step #{step}") unless title.present?
+
+    link = if edit_effective_wizard? && resource.can_visit_step?(step)
+      link_to('Edit', wizard_path(step), title: "Edit #{title}")
+    end
+
+    content_tag(:div, class: 'card') do
+      content_tag(:div, class: 'card-body yo') do
+        content_tag(:div, class: 'row') do
+          content_tag(:div, class: 'col-sm') do
+            content_tag(:h5, title, class: 'card-title')
+          end +
+          content_tag(:div, class: 'col-sm-auto text-right') do
+            (link || '')
+          end
+        end + capture(&block)
+      end
+    end
+  end
+
 end

data/app/models/concerns/acts_as_wizard.rb

@@ -29,6 +29,9 @@ module ActsAsWizard
 
     attr_accessor :current_user
 
+    # Used by the view when rendering each partial. Not the current step.
+    attr_accessor :render_step
+
     if Rails.env.test? # So our tests can override the required_steps method
       cattr_accessor :test_required_steps
     end

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.17.2'.freeze
+  VERSION = '1.18.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 1.17.2
+  version: 1.18.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-07-01 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