effective_search 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a28fa1842cb98730b4063cdb4d905ac9f2f91ae3828fc2f8999ed9e470836ef
-  data.tar.gz: 443f7dcd1c2a96db2f8497473dc3d93ec8bcf6eee8cbd7eb0e7182728b9925fe
+  metadata.gz: a5bc0454808d5c92f57c4d8b5df6aec31c7c3a9d0b278c1824722c1a7598ffa2
+  data.tar.gz: fd62ab6ab6b636122745dda9053521f18f7c8fe6462cf2485b39ca5998a9b3ad
 SHA512:
-  metadata.gz: 70beeef330bb5d7ac281bfcf471ea59f2a05cc870e4bbc8437a5e7c5b6e8d99e2b50f11ca69b5ab3e11c0dee148737b10716916356c75ebbcdf842061ee396b9
-  data.tar.gz: 3762becb2d714652544bf5047902fd4143da7a480e143fbe0bba9c10a8aa6d93ddbd99cb746e2c6c8d6d1bb2ee7fb55d0f8fe2432ee1c56baf878dea84cb375e
+  metadata.gz: 5e359cf8e8ce4d0bd34941b3b7a7bb3530af955ef6fe461cec81e21e29000ef6f6781ecc4265c506984851a6e52856e50381531b9a95a973e834fc28a02b31a2
+  data.tar.gz: cfc31d57f4d4ab5200298730ee1da92def9cd672220d6156ea4ac72c72840b14e0f8f233082092329c70a74d99bb6cadc2fa9546348d502dc2de5932c1c3fddd

data/app/assets/javascripts/effective_search/admin.js

@@ -0,0 +1,62 @@
+// Admin search handle pagination clicks
+$(document).on('click', '#effective-search-admin-modal .page-link', function(event) {
+  event.preventDefault();
+  
+  var $link = $(this);
+  var href = $link.attr('href');
+  
+  // Extract the page parameter from the URL
+  var pageMatch = href.match(/[?&]page=(\d+)/);
+  if (!pageMatch) return;
+  
+  var pageNumber = pageMatch[1];
+  
+  // Find the closest form and update the hidden page field
+  var $form = $link.closest('form');
+  if ($form.length === 0) return;
+  
+  var $pageField = $form.find('input[name="page"]');
+  if ($pageField.length === 0) return;
+
+  // Update the page value and submit the form
+  $pageField.val(pageNumber);
+
+  $form.find("[data-load-ajax-url]").trigger('reload');
+});
+
+// Admin search close the modal when they visit a search result page
+$(document).on('click', '#effective-search-admin-modal a', function(event) {
+  var $link = $(event.currentTarget);
+  if($link.hasClass('page-link') || $link.data('effective-search-clear')) return;
+
+  $('#effective-search-admin-modal').modal('hide');
+});
+
+// Admin search clear button
+$(document).on('click', '#effective-search-admin-modal a[data-effective-search-clear]', function(event) {
+  event.preventDefault();
+
+  var $form = $(event.currentTarget).closest('form')
+
+  $form.trigger('reset');
+  $form.find('#effective-search-results').html('');
+  $form.find('input[name="page"]').val(1);
+  $form.find('input[name="q[term]"]').focus();
+});
+
+// Admin search reset to page 1 when search term changes
+$(document).on('keyup paste', "#effective-search-admin-modal [data-load-ajax-url]", function(event) {
+  var $form = $(event.currentTarget).closest('form')
+  $form.find('input[name="page"]').val(1);
+});
+
+// Prevent form submission on Enter key press
+$(document).on('keydown keyup', "#effective-search-admin-modal form", function(event) {
+  if(event.key === 'Enter') { event.preventDefault(); }
+});
+
+// Auto focus the search input when the modal is shown
+$(document).on('shown.bs.modal', '#effective-search-admin-modal', function () {
+  $(".effective-search-admin").find('input[type="search"]').first().focus();
+});
+

data/app/assets/javascripts/effective_search/base.js

@@ -0,0 +1,7 @@
+$(document).on('shown.bs.collapse', '#effective-search-icon-form', function () {
+  $("#effective-search-input").focus();
+});
+
+$(document).on('hidden.bs.collapse', '#effective-search-icon-form', function () {
+  $("#effective-search-input").blur();
+});

data/app/assets/stylesheets/effective_search/admin.scss

@@ -0,0 +1,14 @@
+.effective-search-admin {
+  #effective-search-results {
+    a {
+      display: block;
+      color: inherit;
+      text-decoration: none;
+    }
+
+    span.badge {
+      color: #1F2328;
+      background-color: #EDEEEF;
+    }
+  }
+}

data/app/assets/stylesheets/effective_search/base.scss

@@ -9,15 +9,21 @@ div.effective-search {
   }
 
   .search-result {
-    margin-bottom: 1.5rem;
-
     // mark { }
-    //.search-title { }
+    // .search-title { }
     //.search-link { }
     //.search-body { }
   }
 }
 
+.search-result { margin-bottom: 2rem; }
+.search-title { font-size: 1.5rem; margin-bottom: 0.25rem; }
+.search-title a {  text-decoration: none;  }
+.search-title a:hover { }
+.search-link { display: block; margin-bottom: 0.25rem; }
+.search-body { }
+
+
 // The nav item search bar
 .effective-search-nav-item {
   input {
@@ -55,3 +61,25 @@ div.effective-search {
   font-weight: 700;
   text-decoration: none;
 }
+
+#effective-search-icon-form {
+  position: absolute;
+  left: 0;
+  top: 0;
+  z-index: 9000;
+  height: 90px;
+  border-bottom: solid 1px;
+}
+
+#effective-search-icon {
+  &:hover { cursor: pointer; }
+
+  .eb-icon-search {
+    height: 1.25rem;
+    width:1.25rem;
+    stroke-width: 3px;
+    margin-bottom: 0;
+  }
+}
+
+

data/app/assets/stylesheets/effective_search.scss

@@ -1 +1,2 @@
 @import 'effective_search/base';
+@import 'effective_search/admin';

data/app/controllers/admin/search_controller.rb

@@ -0,0 +1,36 @@
+module Admin
+  class SearchController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_search) }
+
+    include Effective::CrudController
+
+    def index
+      EffectiveResources.authorize!(self, :index, EffectiveSearch.AdminSearch)
+
+      # But more often we do a full membership directory search screen
+      @search = build_search
+      @search.search!
+
+      @page_title = "Search"
+    end
+
+    def build_search
+      search = EffectiveSearch.AdminSearch.new()
+      search.assign_attributes(search_params.select { |k, _| search.respond_to?("#{k}=") })
+      search.assign_attributes(current_user: current_user, view_context: view_context)
+      search
+    end
+
+    def search_params
+      return {} unless params[:q].present?
+
+      if params[:q].respond_to?(:to_h)      # From the search form
+        params.require(:q).permit!
+      else
+        { term: params.permit(:q).fetch(:q) }   # From the url /directory?q=asdf
+      end
+    end
+
+  end
+end

data/app/helpers/effective_search_helper.rb

@@ -6,4 +6,16 @@ module EffectiveSearchHelper
     end
   end
 
+  def effective_search_nav_icon
+    if EffectiveResources.authorized?(self, :index, EffectiveSearch.Search)
+      render('effective/search/form_nav_icon')
+    end
+  end
+
+  def effective_search_admin_nav_icon
+    if EffectiveResources.authorized?(self, :index, EffectiveSearch.AdminSearch)
+      render('admin/search/form_nav_icon')
+    end
+  end
+
 end

data/app/models/concerns/effective_search_admin_search.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# EffectiveSearchAdminSearch
+# Mark your search model with include EffectiveSearchAdminSearch
+
+module EffectiveSearchAdminSearch
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def effective_search_admin_search?; true; end
+  end
+
+  included do
+    include ActiveModel::Model
+
+    attr_accessor :current_user
+    attr_accessor :view_context
+
+    attr_accessor :term
+    validates :term, length: { minimum: 1, allow_blank: true }
+  end
+
+  def to_s
+    term.to_s
+  end
+
+  def per_page
+    3
+  end
+
+  def present?
+    term.present?
+  end
+
+  def users
+    @users ||= Effective::Resource.new(current_user.class).search_any(term, columns: [:first_name, :last_name, :email])
+  end
+
+  def organizations
+    @organizations ||= Effective::Resource.new(EffectiveMemberships.Organization).search_any(term, columns: [:title, :email])
+  end
+
+  def orders
+    @orders ||= Effective::Resource.new(Effective::Order).search_any(term, columns: [:id])
+  end
+
+  def applicants
+    @applicants = EffectiveMemberships.Applicant.where(user: users).order(created_at: :desc)
+  end
+
+  # Search and assigns the collection
+  # Assigns the entire collection() if there are no search terms
+  # Otherwise validate the search terms
+  def search!
+    @users = users()
+    @orders = orders()
+    @applicants = applicants()
+    @organizations = organizations()
+  end
+
+  # The paginated results
+  def user_results(page: nil)
+    results(users, page: page)
+  end
+
+  def order_results(page: nil)
+    results(orders, page: page)
+  end
+
+  def applicant_results(page: nil)
+    results(applicants, page: page)
+  end
+
+  def organization_results(page: nil)
+    results(organizations, page: page)
+  end
+
+  private
+
+  def results(collection, page: nil)
+    page = (page || 1).to_i
+    offset = [(page - 1), 0].max * per_page
+
+    collection.limit(per_page).offset(offset)
+  end
+
+end
+

data/app/models/effective/admin_search.rb

@@ -0,0 +1,5 @@
+module Effective
+  class AdminSearch
+    include EffectiveSearchAdminSearch
+  end
+end

data/app/views/admin/search/_applicant.html.haml

@@ -0,0 +1,12 @@
+%tr
+  %td
+    %a{href: effective_memberships.edit_admin_applicant_path(applicant), title: applicant}
+      %span.badge.rounded-circle.p-2.mr-3.float-left= icon('clipboard')
+      = applicant.owner
+      %br
+      %small.text-muted
+        = applicant.summary_title
+        = ' • '.html_safe
+        = applicant.owner&.email
+        = ' • '.html_safe
+        = badge(applicant.status)

data/app/views/admin/search/_form_nav_icon.html.haml

@@ -0,0 +1,3 @@
+%li.nav-item.effective-search-nav-item
+  %a.nav-link{href: '#', data: { toggle: 'modal', target: '#effective-search-admin-modal' }, title: 'Search'}
+    = icon('search')

data/app/views/admin/search/_layout.html.haml

@@ -0,0 +1,2 @@
+.effective-search-admin
+  = yield

data/app/views/admin/search/_modal.html.haml

@@ -0,0 +1,8 @@
+%div#effective-search-admin-modal.modal.fade{tabindex: '-1', role: 'dialog', 'data-turbolinks-permanent': true}
+  .modal-dialog.modal-lg{role: 'document'}
+    .modal-content
+      .modal-body
+        - search = EffectiveSearch.AdminSearch.new
+        = render('admin/search/search', search: search, modal: true)
+      .modal-footer.bg-light.p-1
+        %small.text-muted Search by name, email, #{etd(EffectiveMemberships.Organization)}, or order number.

data/app/views/admin/search/_order.html.haml

@@ -0,0 +1,16 @@
+%tr
+  %td
+    - path = (EffectiveResources.authorized?(self, :edit, order) ? effective_orders.admin_edit_order_path(order) : effective_orders.admin_order_path(order))
+
+    %a{href: path, title: order}
+      %span.badge.rounded-circle.p-2.mr-3.float-left= icon('shopping-cart')
+      = order.to_s
+      %br
+      %small.text-muted
+        = order.billing_name
+        = ' • '.html_safe
+        = order.email
+        = ' • '.html_safe
+        = price_to_currency(order.total)
+        = ' • '.html_safe
+        = badge(order.status)

data/app/views/admin/search/_organization.html.haml

@@ -0,0 +1,28 @@
+%tr
+  %td
+    %a{href: effective_memberships.edit_admin_organization_path(organization), title: organization}
+      %span.badge.rounded-circle.p-2.mr-3.float-left= icon('globe')
+      = organization
+      %br
+      %small.text-muted
+        - if organization.class.try(:effective_memberships_organization_owner?)
+          - if (membership = organization.try(:membership)).present?
+            = membership.statuses.to_sentence
+            = membership.categories.to_sentence
+            member
+            - if membership.number.present?
+              = ' #' + membership.number
+          - elsif organization.membership_removed?
+            Removed member
+          - else
+            Not a member
+          = ' • '.html_safe
+
+        = organization.email
+
+        - if (principals = organization.representatives.select { |rep| rep.is_any?(:principal) }).present?
+          = ' • '.html_safe
+          = principals.to_sentence
+
+        = ' • '.html_safe
+        = pluralize(organization.representatives.count, 'representative')

data/app/views/admin/search/_search.html.haml

@@ -0,0 +1,41 @@
+= render 'admin/search/layout' do
+
+  = effective_form_with(scope: :q, model: search, method: :get, url: effective_search.admin_search_path) do |f|
+    = hidden_field_tag :page, (params[:page] || 1)
+
+    .d-flex.align-items-center
+      .flex-grow-1
+        = f.search_field :term, placeholder: 'Search', label: false, autofocus: true, autocomplete: 'off',
+          'data-load-ajax-url': effective_search.admin_search_path,
+          'data-load-ajax-div': '#effective-search-results',
+          'data-load-ajax-all': true
+
+      - if modal
+        %div
+          = link_to 'Clear', '#', class: 'btn-link', style: "position: absolute; top: 1.5rem; right: 4rem; z-index: 10;", 'data-effective-search-clear': true
+
+        %div.ml-4.mb-3
+          %button.close{type: 'button', data: { dismiss: 'modal' }, 'aria-label': 'Close'}
+            %span{'aria-hidden': 'true'} ×
+
+    #effective-search-results
+      - if search.present?
+        - # Users
+        %p Users (#{search.users.count})
+        %table.table.table-hover
+          %tbody= render(collection: search.user_results, partial: 'admin/search/user')
+
+        - # Organizations
+        %p #{ets(search.organizations)} (#{search.organizations.count})
+        %table.table.table-hover
+          %tbody= render(collection: search.organization_results, partial: 'admin/search/organization')
+
+        - # Applicants
+        %p Applicants (#{search.applicants.count})
+        %table.table.table-hover
+          %tbody= render(collection: search.applicant_results, partial: 'admin/search/applicant')
+
+        - # Orders
+        %p Orders (#{search.orders.count})
+        %table.table.table-hover
+          %tbody= render(collection: search.order_results, partial: 'admin/search/order')

data/app/views/admin/search/_user.html.haml

@@ -0,0 +1,24 @@
+%tr
+  %td
+    %a{href: edit_admin_user_path(user), title: user}
+      %span.badge.rounded-circle.p-2.mr-3.float-left= icon('user')
+      = user.to_s
+      %br
+      %small.text-muted
+        - if(membership = user.try(:membership) || user.try(:organizations).try(:first).try(:membership)).present?
+          = membership.statuses.to_sentence
+          = membership.categories.to_sentence
+          member
+          - if membership.number.present?
+            = ' #' + membership.number
+        - elsif user.membership_removed?
+          Removed member
+        - else
+          Not a member
+        = ' • '.html_safe
+
+        = user.email
+
+        - if user.try(:representatives).present?
+          = ' • '.html_safe
+          = user.representatives.map(&:organization).to_sentence

data/app/views/admin/search/index.html.haml

@@ -0,0 +1 @@
+= render('admin/search/search', search: @search, modal: false)

data/app/views/effective/search/_form_nav_icon.html.haml

@@ -0,0 +1,11 @@
+%li.nav-item.effective-search-nav-item.d-flex
+  #effective-search-icon-form.collapse.width.w-100.bg-dark.shadow-sm
+    .d-flex.p-4
+      = effective_form_with(scope: :q, model: EffectiveSearch.Search.new, method: :get, url: effective_search.search_path, layout: :inline, class: "w-100") do |f|
+        = f.text_field :term, label: false, placeholder: 'Search', autofocus: false, id: "effective-search-input", class: "form-control-lg border-0 w-100"
+
+      .nav-link.ml-auto.flex-shrink-1.text-white{"data-toggle":"collapse", "data-target":"#effective-search-icon-form", role: "button"}
+        = icon('x', class: "big-1")
+
+  .nav-link#effective-search-icon.d-flex.align-items-center{"data-target":"#effective-search-icon-form", "data-toggle":"collapse"}
+    = icon('search')

data/app/views/effective/search/_search.html.haml

@@ -2,8 +2,6 @@
   = render('effective/search/form', search: search)
 
   - if search.present?
-    %hr
-
     - results = search.results(page: params[:page])
     - search_contents = search.search_contents.select { |resource| search.authorized?(resource) }
     - permalinks = search.permalinks.select { |resource| search.authorized?(resource) }
@@ -22,9 +20,6 @@
 
       -# Search results
       %div{class: (permalinks.present? ? 'col-xl-8 col-lg-7' : 'col')}
-        %h3 Pages
-        %hr.mt-0
-
         - if results.length == 0
           .alert.alert-info There are no results for your search. Please try again.
 

data/config/routes.rb

@@ -11,6 +11,7 @@ EffectiveSearch::Engine.routes.draw do
   end
 
   namespace :admin do
+    match '/search', to: 'search#index', via: [:get], as: :search
     resources :search_contents, except: [:show]
   end
 

data/lib/effective_search/version.rb

@@ -1,3 +1,3 @@
 module EffectiveSearch
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/effective_search.rb

@@ -5,7 +5,7 @@ require 'effective_search/version'
 module EffectiveSearch
 
   def self.config_keys
-    [:search_class_name, :search_contents_table_name, :authenticate_user, :layout]
+    [:search_class_name, :admin_search_class_name, :search_contents_table_name, :authenticate_user, :layout]
   end
 
   include EffectiveGem
@@ -14,6 +14,10 @@ module EffectiveSearch
     search_class_name&.constantize || Effective::Search
   end
 
+  def self.AdminSearch
+    admin_search_class_name&.constantize || Effective::AdminSearch
+  end
+
   def self.authenticate_user?
     authenticate_user == true
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_search
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-21 00:00:00.000000000 Z
+date: 2026-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -162,19 +162,34 @@ files:
 - Rakefile
 - app/assets/config/effective_search_manifest.js
 - app/assets/javascripts/effective_search.js
+- app/assets/javascripts/effective_search/admin.js
 - app/assets/javascripts/effective_search/base.js
 - app/assets/stylesheets/effective_search.scss
+- app/assets/stylesheets/effective_search/admin.scss
 - app/assets/stylesheets/effective_search/base.scss
 - app/controllers/admin/search_contents_controller.rb
+- app/controllers/admin/search_controller.rb
 - app/controllers/effective/search_controller.rb
 - app/datatables/admin/effective_search_contents_datatable.rb
 - app/helpers/effective_search_helper.rb
+- app/models/concerns/effective_search_admin_search.rb
 - app/models/concerns/effective_search_search.rb
+- app/models/effective/admin_search.rb
 - app/models/effective/search.rb
 - app/models/effective/search_content.rb
+- app/views/admin/search/_applicant.html.haml
+- app/views/admin/search/_form_nav_icon.html.haml
+- app/views/admin/search/_layout.html.haml
+- app/views/admin/search/_modal.html.haml
+- app/views/admin/search/_order.html.haml
+- app/views/admin/search/_organization.html.haml
+- app/views/admin/search/_search.html.haml
+- app/views/admin/search/_user.html.haml
+- app/views/admin/search/index.html.haml
 - app/views/admin/search_contents/_form.html.haml
 - app/views/admin/search_contents/_form_search_content.html.haml
 - app/views/effective/search/_form.html.haml
+- app/views/effective/search/_form_nav_icon.html.haml
 - app/views/effective/search/_form_nav_item.html.haml
 - app/views/effective/search/_layout.html.haml
 - app/views/effective/search/_result.html.haml