effective_memberships 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5088dfc90ed9a12111011d7f9c8b639553abf0b03af9eea5a197c80d3b5c97f9
-  data.tar.gz: cbedc16b06e69feac3e1921c8963d0d1e2bb3f44b4efeb4aabab0682efe582c4
+  metadata.gz: d55b0a5c31e8f259614c649af1fe89e2d36cb412652dc6d5ac96f051a925a7ee
+  data.tar.gz: 3850e9a4d2ba175becb4e0f487bc041c726516d9462470ee6c464a19ece0d559
 SHA512:
-  metadata.gz: 8ebdebc9b7673481c1d49cca98ad7a8ead414296783dcf886e0ebdd5edec24a75f71c88d1698748b4035cfec97b14029c186c9d8e7277c6065404e3f5c837f15
-  data.tar.gz: 3ed063f4063d1c40187b4366163dd349a4087a25e18b4083aa781ecc4b7d003c5022e1eae5db0854066ce4d48f3b3b0ba4cedbb7d21a9f3598977fc2e770c6dd
+  metadata.gz: d6b197509eb8ce44fd7b15230c8b55171eccf2b017017f6e38eb45917453abf96a210118fd25df35d962cf448efc3625db45f1dafe720da32c18d1ee68ab7569
+  data.tar.gz: 7c2e9ecd43439c7abf4a174ef1adae97938704a941e8338225b3905b38fb0e7d10aae5d075ce169b1140b77f193dc055349751569524163d5a301d65801848cf

data/app/controllers/effective/membership_directory_controller.rb

@@ -0,0 +1,36 @@
+module Effective
+  class MembershipDirectoryController < ApplicationController
+    include Effective::CrudController
+
+    def index
+      @page_title = 'Directory'
+      EffectiveResources.authorize!(self, :index, Effective::Membership)
+
+      # Sometimes we just display a Datatable for the membership directory
+      @datatable = EffectiveResources.best('EffectiveMembershipsDirectoryDatatable').new
+
+      # But more often we do a full membership directory search screen
+      @membership_directory = build_membership_directory
+      @membership_directory.search!
+
+      @memberships = @membership_directory.results(page: params[:page])
+    end
+
+    def build_membership_directory
+      directory = EffectiveMemberships.MembershipDirectory.new(search_params)
+      directory.current_user = current_user
+      directory
+    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/datatables/effective_memberships_directory_datatable.rb

@@ -11,7 +11,7 @@ class EffectiveMembershipsDirectoryDatatable < Effective::Datatable
   end
 
   collection do
-    scope = Effective::Membership.deep.good_standing.includes(:owner)
+    scope = Effective::Membership.directory.all
 
     archived_klasses.each do |klass|
       scope = scope.where.not(owner_id: klass.archived.select('id'), owner_type: klass.name)
@@ -21,11 +21,7 @@ class EffectiveMembershipsDirectoryDatatable < Effective::Datatable
   end
 
   def archived_klasses
-    @archived_klasses ||= begin
-      klasses = Effective::Membership.distinct(:owner_type).pluck(:owner_type)
-      klasses = klasses.select { |klass| klass.safe_constantize.try(:acts_as_archived?) }
-      klasses.map { |klass| klass.constantize }
-    end
+    @archived_klasses ||= Effective::Membership.owner_klasses.select { |klass| klass.try(:acts_as_archived?) }
   end
 
 end

data/app/models/concerns/effective_memberships_directory.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# This is a search model for the MembershipDirectories screen
+#
+# EffectiveMembershipsDirectory
+# Mark your directory search model with include EffectiveMembershipsDirectory
+
+module EffectiveMembershipsDirectory
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def effective_memberships_directory?; true; end
+  end
+
+  included do
+    include ActiveModel::Model
+
+    attr_accessor :current_user
+    attr_accessor :term
+    attr_accessor :category
+
+    attr_accessor :first_name
+    attr_accessor :last_name
+
+    validates :term, length: { minimum: 3, allow_blank: true }
+    validates :first_name, length: { minimum: 2, allow_blank: true }
+    validates :last_name, length: { minimum: 2, allow_blank: true }
+  end
+
+  # Base collection to search. Can be configured per tenant.
+  def collection
+    # Example::User.members.membership_in_good_standing.all
+    raise('to be implemented by app membership_directory')
+  end
+
+  # Search Users and Organizations for only these fields. Passed into search_any. Return nil for all.
+  # Should this include email?
+  def search_any_columns
+    [:title, :name, :first_name, :middle_name, :last_name]
+  end
+
+  def per_page
+    24
+  end
+
+  def present?
+    term.present? || first_name.present? || last_name.present? || category.present?
+  end
+
+  # Search and assigns the collection
+  # Assigns the entire collection() if there are no search terms
+  # Otherwise validate the search terms
+  def search!
+    @membership_owners = build_collection()
+    @membership_owners = @membership_owners.none if present? && !valid?
+    @membership_owners
+  end
+
+  # The unpaginated results of the search
+  def membership_owners
+    @membership_owners || collection
+  end
+
+  # The paginated results
+  def results(page: nil)
+    page = (page || 1).to_i
+    offset = [(page - 1), 0].max * per_page
+
+    membership_owners.limit(per_page).offset(offset)
+  end
+
+  protected
+
+  def build_collection
+    owners = collection()
+    raise('expected an ActiveRecord collection') unless owners.kind_of?(ActiveRecord::Relation)
+    raise('expected a collection of membership_owners') unless owners.klass.respond_to?(:effective_memberships_owner?)
+
+    # Filter by term
+    if term.present?
+      owners = Effective::Resource.new(owners).search_any(term, columns: search_any_columns)
+    end
+
+    # Filter by first name
+    if first_name.present?
+      owners = Effective::Resource.new(owners).search_any(first_name, columns: :first_name)
+    end
+
+    # Filter by last name
+    if last_name.present?
+      owners = Effective::Resource.new(owners).search_any(last_name, columns: :last_name)
+    end
+
+    # Filter by category
+    if category.present?
+      cat = EffectiveMemberships.Category.where(id: category)
+      owners = owners.members_with_category(cat) if cat.present?
+    end
+
+    owners
+  end
+
+end

data/app/models/concerns/effective_memberships_owner.rb

@@ -7,12 +7,9 @@
 module EffectiveMembershipsOwner
   extend ActiveSupport::Concern
 
-  mattr_accessor :descendants
-
   module Base
     def effective_memberships_owner
       include ::EffectiveMembershipsOwner
-      (EffectiveMembershipsOwner.descendants ||= []) << self
     end
   end
 

data/app/models/effective/membership.rb

@@ -27,7 +27,7 @@ module Effective
       timestamps
     end
 
-    scope :deep, -> { includes(membership_categories: :category) }
+    scope :deep, -> { includes(:owner, membership_categories: :category) }
     scope :sorted, -> { order(:id) }
 
     scope :with_status, -> (statuses) {
@@ -100,6 +100,11 @@ module Effective
       maximum('number_as_integer') || 0
     end
 
+    def self.owner_klasses
+      klasses = Effective::Membership.distinct(:owner_type).pluck(:owner_type)
+      klasses.select { |klass| klass.safe_constantize }.map { |klass| klass.constantize }
+    end
+
     def to_s
       return 'membership' if owner.blank?
 

data/app/models/effective/membership_directory.rb

@@ -0,0 +1,5 @@
+module Effective
+  class MembershipDirectory
+    include EffectiveMembershipsDirectory
+  end
+end

data/app/views/admin/membership_histories/_form.html.haml

@@ -4,7 +4,7 @@
     = f.hidden_field :owner_type
   - else
     - raise('todo')
-    - collection = EffectiveMembershipsOwner.descendants.map { |d| [d.name.to_s, d.members.sorted] }.to_h
+    /- collection = EffectiveMembershipsOwner.descendants.map { |d| [d.name.to_s, d.members.sorted] }.to_h
     = f.select :owner_id, collection, polymorphic: true
 
   = f.date_field :start_on, hint: 'The start date of this period in history. Must be present.'

data/app/views/effective/membership_directory/_form.html.haml

@@ -0,0 +1,11 @@
+= effective_form_with(scope: :q, model: membership_directory, method: :get, url: request.path) do |f|
+  - if f.object.term.present?
+    = f.search_field :term, label: 'Name'
+
+  = f.search_field :first_name
+  = f.search_field :last_name
+
+  = f.select :category, EffectiveMemberships.Category.all
+
+  = f.save('Search', class: 'btn btn-primary btn-search mr-3', name: nil)
+  = link_to 'Reset filters', request.path

data/app/views/effective/membership_directory/_layout.html.haml

@@ -0,0 +1,2 @@
+.effective-membership-directory
+  = yield

data/app/views/effective/membership_directory/_membership_directory.html.haml

@@ -0,0 +1,17 @@
+= render 'layout' do
+  = render('effective/membership_directory/form', membership_directory: membership_directory)
+
+  - results = membership_directory.results(page: params[:page])
+
+  - if membership_directory.present? && results.length == 0
+    .alert.alert-info There are no results for your search. Please try again.
+
+  - results.in_groups_of(3).each do |group|
+    .row.mt-4
+      - group.each do |owner|
+        - next unless owner
+        .col-md
+          = render('effective/membership_directory/membership_owner', membership: owner.membership, owner: owner)
+
+  %nav.d-flex.justify-content-center
+    = bootstrap_paginate(results, per_page: membership_directory.per_page)

data/app/views/effective/membership_directory/_membership_owner.html.haml

@@ -0,0 +1,4 @@
+= card do
+  %h6= owner
+  %p= membership.categories.to_sentence
+  %p= membership.statuses.to_sentence

data/app/views/effective/membership_directory/index.html.haml

@@ -0,0 +1,2 @@
+/= render_datatable(@datatable, buttons: false)
+= render('effective/membership_directory/membership_directory', membership_directory: @membership_directory)

data/config/effective_memberships.rb

@@ -20,6 +20,7 @@ EffectiveMemberships.setup do |config|
   # config.applicant_review_class_name = 'Effective::ApplicantReview'
   # config.fee_payment_class_name = 'Effective::FeePayment'
   # config.membership_card_class_name = 'Effective::MembershipCard'
+  # config.membership_directory_class_name = 'Effective::MembershipDirectory'
   # config.registrar_class_name = 'Effective::Registrar'
   # config.organization_class_name = 'Effective::Organization'
   # config.status_class_name = 'Effective::Status'

data/config/routes.rb

@@ -26,7 +26,8 @@ EffectiveMemberships::Engine.routes.draw do
       resources :build, controller: :fee_payments, only: [:show, :update]
     end
 
-    get '/directory', to: 'memberships_directory#index'
+    resources :membership_directory, only: :index
+    get '/directory', to: 'membership_directory#index'
 
     resources :membership_cards, only: :index
 

data/lib/effective_memberships/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMemberships
-  VERSION = '0.8.0'
+  VERSION = '0.8.2'
 end

data/lib/effective_memberships.rb

@@ -7,7 +7,7 @@ module EffectiveMemberships
   def self.config_keys
     [
       :categories_table_name, :applicants_table_name, :applicant_reviews_table_name, :fee_payments_table_name, :organizations_table_name, :representatives_table_name, :statuses_table_name,
-      :category_class_name, :organization_class_name, :applicant_class_name, :applicant_review_class_name, :fee_payment_class_name, :registrar_class_name, :membership_card_class_name, :status_class_name,
+      :category_class_name, :organization_class_name, :applicant_class_name, :applicant_review_class_name, :fee_payment_class_name, :registrar_class_name, :membership_card_class_name, :membership_directory_class_name, :status_class_name,
       :additional_fee_types, :applicant_reviews, :applicant_endorsements_endorser_collection,
       :layout,
       :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject, :use_effective_email_templates
@@ -40,6 +40,10 @@ module EffectiveMemberships
     membership_card_class_name&.constantize || Effective::MembershipCard
   end
 
+  def self.MembershipDirectory
+    membership_directory_class_name&.constantize || Effective::MembershipDirectory
+  end
+
   def self.Status
     status_class_name&.constantize || Effective::Status
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_memberships
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -275,7 +275,7 @@ files:
 - app/controllers/effective/applicants_controller.rb
 - app/controllers/effective/fee_payments_controller.rb
 - app/controllers/effective/membership_cards_controller.rb
-- app/controllers/effective/memberships_directory_controller.rb
+- app/controllers/effective/membership_directory_controller.rb
 - app/controllers/effective/organizations_controller.rb
 - app/controllers/effective/representatives_controller.rb
 - app/datatables/admin/effective_applicant_course_areas_datatable.rb
@@ -312,6 +312,7 @@ files:
 - app/models/concerns/effective_memberships_applicant_review.rb
 - app/models/concerns/effective_memberships_card.rb
 - app/models/concerns/effective_memberships_category.rb
+- app/models/concerns/effective_memberships_directory.rb
 - app/models/concerns/effective_memberships_fee_payment.rb
 - app/models/concerns/effective_memberships_organization.rb
 - app/models/concerns/effective_memberships_owner.rb
@@ -334,6 +335,7 @@ files:
 - app/models/effective/membership.rb
 - app/models/effective/membership_card.rb
 - app/models/effective/membership_category.rb
+- app/models/effective/membership_directory.rb
 - app/models/effective/membership_history.rb
 - app/models/effective/membership_status.rb
 - app/models/effective/organization.rb
@@ -477,9 +479,13 @@ files:
 - app/views/effective/fees/_dashboard.html.haml
 - app/views/effective/fees/_fee.html.haml
 - app/views/effective/membership_cards/index.html.haml
+- app/views/effective/membership_directory/_form.html.haml
+- app/views/effective/membership_directory/_layout.html.haml
+- app/views/effective/membership_directory/_membership_directory.html.haml
+- app/views/effective/membership_directory/_membership_owner.html.haml
+- app/views/effective/membership_directory/index.html.haml
 - app/views/effective/memberships/_dashboard.html.haml
 - app/views/effective/memberships/_membership.html.haml
-- app/views/effective/memberships_directory/index.html.haml
 - app/views/effective/memberships_mailer/applicant_approved.liquid
 - app/views/effective/memberships_mailer/applicant_completed.liquid
 - app/views/effective/memberships_mailer/applicant_declined.liquid

data/app/controllers/effective/memberships_directory_controller.rb

@@ -1,14 +0,0 @@
-module Effective
-  class MembershipsDirectoryController < ApplicationController
-    include Effective::CrudController
-
-    def index
-      @page_title = 'Directory'
-
-      EffectiveResources.authorize!(self, :index, Effective::Membership)
-
-      @datatable = EffectiveResources.best('EffectiveMembershipsDirectoryDatatable').new
-    end
-
-  end
-end

data/app/views/effective/memberships_directory/index.html.haml

@@ -1 +0,0 @@
-= render_datatable(@datatable, buttons: false)