effective_memberships 0.10.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09cdd3d71c709fdaacb54d4abd0d21217bd6e7e3a7395e687004eb124994b75b'
-  data.tar.gz: caebcbe36b5c113d715e47ef8df0d224f7ea825ae0fa3ea3f5efc59448bcc30f
+  metadata.gz: fcda6f904900bdb868f397b966b91246eb5199ccb40e2fd0ff585fe1a40a5c2d
+  data.tar.gz: 496de8f40e138891794d41f6ce816941638ace3701dbfd40e111f39c4e5aaa4a
 SHA512:
-  metadata.gz: 50897b485cca843711185839c1e630b90211ac1559c7a956fd5d425d70a37ad7ef94b6a3863cd1055ac8efa226ef635a4b6186f32763e260c277cb198b4c7f3c
-  data.tar.gz: 0a53cc0947501e0f89c07d56e052b81f5b6a7f2c676698e5e45227f0c9ae460b8c674d90fd0bc521601eb5adef49ab07d1433ce6ccd5f80fcefb670b6c9845d6
+  metadata.gz: 5bc4751c68972b32b0e851d42a837bfeacacf73291aa128871836fe339d339c56ef26f8cd78badb8b12bf2ad41ea0487b232d30b0fa71e0d2e955a7c2a2e8543
+  data.tar.gz: 8bdb806fe84d1c1034b6fa620a92268e6cf1c220f2679d58be9d705971501230a87af5a4a1d38e5bd7bd6f94f1a4638a464e15ce4937938f9269d10f404b189c

data/app/controllers/admin/documents_controller.rb

@@ -0,0 +1,15 @@
+module Admin
+  class DocumentsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_memberships) }
+
+    include Effective::CrudController
+
+    private
+
+    def permitted_params
+      params.require(:effective_document).permit!
+    end
+
+  end
+end

data/app/datatables/admin/effective_documents_datatable.rb

@@ -0,0 +1,28 @@
+module Admin
+  class EffectiveDocumentsDatatable < Effective::Datatable
+    datatable do
+      order :updated_at
+
+      col :updated_at, visible: false
+      col :created_at, visible: false
+      col :id, visible: false
+
+      col :file
+      col :owner, label: 'User'
+      col :display_to_owner, label: 'Display to user'
+
+      if (categories = Array(EffectiveMemberships.document_categories)).present?
+        col :category, search: categories
+      end
+
+      col :title, visible: false
+      col :notes
+
+      actions_col
+    end
+
+    collection do
+      Effective::Document.deep.all
+    end
+  end
+end

data/app/datatables/effective_documents_datatable.rb

@@ -0,0 +1,31 @@
+# Dashboard Documents
+class EffectiveDocumentsDatatable < Effective::Datatable
+  datatable do
+    order :updated_at
+
+    col :updated_at, visible: false
+    col :created_at, visible: false
+    col :id, visible: false
+
+    col :owner, label: 'User or Organization'
+
+    if (categories = Array(EffectiveMemberships.document_categories)).present?
+      col :category, search: categories
+    end
+
+    col :file
+
+    col :title, visible: false
+    col :notes
+
+    actions_col do |document|
+      dropdown_link_to('Download', url_for(document.file)) if document.file.attached?
+    end
+
+  end
+
+  collection(apply_belongs_to: false) do
+    Effective::Document.deep.for(current_user).display_to_owner
+  end
+
+end

data/app/models/concerns/effective_memberships_category.rb

@@ -260,4 +260,8 @@ module EffectiveMembershipsCategory
     tax_exempt
   end
 
+  def cpd_target_score(cpd_cycle:)
+    nil
+  end
+
 end

data/app/models/effective/document.rb

@@ -0,0 +1,50 @@
+module Effective
+  class Document < ActiveRecord::Base
+    self.table_name = EffectiveMemberships.documents_table_name.to_s
+
+    log_changes(to: :owner) if respond_to?(:log_changes)
+
+    # This fee may belong to an user, organization or other parent model
+    belongs_to :owner, polymorphic: true, optional: true
+
+    has_one_attached :file
+
+    effective_resource do
+      title             :string
+      category          :string
+      display_to_owner  :boolean    # Display on dashbaord
+
+      notes             :text
+
+      timestamps
+    end
+
+    scope :sorted, -> { order(:id) }
+    scope :deep, -> { with_attached_file }
+    scope :display_to_owner, -> { where(display_to_owner: true) }
+
+    scope :for, -> (user) {
+      raise('expected a effective memberships user') unless user.class.try(:effective_memberships_user?)
+      where(owner: user).or(where(owner: user.organizations))
+    }
+
+    before_validation(if: -> { file.attached? && title.blank? }) do
+      assign_attributes(title: file.filename.to_s)
+    end
+
+    validates :title, presence: true
+    validates :file, presence: true
+
+    validate do
+      if (categories = Array(EffectiveMemberships.document_categories)).present?
+        self.errors.add(:category, "can't be blank") if category.blank?
+        self.errors.add(:category, "is invalid") unless categories.include?(category)
+      end
+    end
+
+    def to_s
+      title.presence || model_name.human
+    end
+
+  end
+end

data/app/models/effective/fee.rb

@@ -144,7 +144,13 @@ module Effective
     end
 
     def default_title
-      [period&.strftime('%Y'), category, fee_type, 'Fee'].compact.join(' ')
+      return nil unless period.present? && fee_type.present?
+
+      [
+        period.strftime('%Y'),
+        category,
+        EffectiveResources.et("effective_memberships.fees.#{fee_type.downcase}")
+      ].join(' ')
     end
 
   end

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

@@ -0,0 +1,19 @@
+= effective_form_with(model: [:admin, document], engine: true) do |f|
+  - if inline_datatable?
+    = f.hidden_field :owner_id
+    = f.hidden_field :owner_type
+  - else
+    = f.hidden_field :owner_type, value: current_user.class.name
+
+    - ajax_url = (@select2_ajax_path || effective_resources.users_admin_select2_ajax_index_path) unless Rails.env.test?
+    = f.select :owner_id, current_user.class.all, label: 'User', ajax_url: ajax_url
+
+  - if (categories = Array(EffectiveMemberships.document_categories)).present?
+    - f.object.category ||= categories.first
+    = f.select :category, categories, required: true
+
+  = f.file_field :file
+  = f.text_area :notes
+  = f.check_box :display_to_owner, label: "Yes, display this document on the user dashboard"
+
+  = effective_submit(f)

data/app/views/effective/documents/_dashboard.html.haml

@@ -0,0 +1,8 @@
+- datatable = EffectiveResources.best('EffectiveDocumentsDatatable').new(self, namespace: :effective)
+
+%h2 Documents
+
+- if datatable.present?
+  = render_simple_datatable(datatable)
+- else
+  %p You have not been shared any documents. When you do, we'll show them here.

data/config/effective_memberships.rb

@@ -2,6 +2,7 @@ EffectiveMemberships.setup do |config|
   config.categories_table_name = :categories
   config.applicants_table_name = :applicants
   config.applicant_reviews_table_name = :applicant_reviews
+  config.documents_table_name = :documents
   config.fee_payments_table_name = :fee_payments
   config.organizations_table_name = :organizations
   config.representatives_table_name = :representatives
@@ -37,6 +38,10 @@ EffectiveMemberships.setup do |config|
   # When false, hide the reviewed state entirely
   # config.applicant_reviews = false
 
+  # Documents
+  # Documents will require a category when present
+  # config.document_categories = ['Documents']
+
   # Mailer Settings
   # Please see config/initializers/effective_resources.rb for default effective_* gem mailer settings
   #

data/config/locales/effective_memberships.en.yml

@@ -0,0 +1,39 @@
+en:
+  effective_memberships:
+    name: 'Effective Memberships'
+
+    fees:
+      applicant: 'Applicant Fee'
+      prorated: 'Prorated Fee'
+      reinstatement: 'Reinstatement Fee'
+      renewal: 'Renewal Fee'
+      late: 'Late Fee'
+      discount: 'Discount Fee'
+      admin: 'Admin Fee'
+
+  activerecord:
+    models:
+      # These ones might be app level
+      app/applicant: 'Applicant'
+      app/applicant_review: 'Applicant Review'
+      app/membership_card: 'Membership Card'
+      app/category: 'Category'
+      app/directory: 'Directory'
+      app/fee_payment: 'Fee Payment'
+      app/organization: 'Organization'
+      app/status: 'Status'
+
+      # These ones should stay effective
+      effective/applicant_course_area: 'Course Area'
+      effective/applicant_course_name: 'Course Name'
+      effective/applicant_course: 'Course'
+      effective/applicant_education: 'Education'
+      effective/applicant_endorsement: 'Endorsement'
+      effective/applicant_equivalence: 'Equivalence'
+      effective/applicant_experience: 'Experience'
+      effective/applicant_reference: 'Reference'
+      effective/document: 'Document'
+      effective/fee: 'Fee'
+      effective/membership_history: 'Membership History'
+      effective/membership: 'Membership'
+      effective/representative: 'Representative'

data/config/routes.rb

@@ -52,6 +52,7 @@ EffectiveMemberships::Engine.routes.draw do
 
     resources :applicant_reviews, only: [:index, :show]
 
+    resources :documents, except: [:show]
     resources :fees, except: [:show]
     resources :categories, only: [:index, :edit, :update]
 

data/db/migrate/01_create_effective_memberships.rb.erb

@@ -529,5 +529,19 @@ class CreateEffectiveMemberships < ActiveRecord::Migration[6.0]
     add_index :fee_payments, :status
     add_index :fee_payments, :token
 
+    # Documents
+    create_table :documents do |t|
+      t.integer :owner_id
+      t.string :owner_type
+
+      t.string :title
+      t.string :category
+      t.boolean :display_to_owner
+
+      t.text :notes
+
+      t.timestamps
+    end
+
   end
 end

data/lib/effective_memberships/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMemberships
-  VERSION = '0.10.1'
+  VERSION = '0.12.0'
 end

data/lib/effective_memberships.rb

@@ -6,9 +6,9 @@ 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,
+      :documents_table_name, :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, :membership_directory_class_name, :status_class_name,
-      :additional_fee_types, :applicant_reviews, :applicant_endorsements_endorser_collection,
+      :additional_fee_types, :applicant_reviews, :applicant_endorsements_endorser_collection, :document_categories,
       :layout,
       :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject, :use_effective_email_templates
     ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_memberships
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -261,6 +261,7 @@ files:
 - app/controllers/admin/applicant_reviews_controller.rb
 - app/controllers/admin/applicants_controller.rb
 - app/controllers/admin/categories_controller.rb
+- app/controllers/admin/documents_controller.rb
 - app/controllers/admin/fee_payments_controller.rb
 - app/controllers/admin/fees_controller.rb
 - app/controllers/admin/membership_histories_controller.rb
@@ -285,6 +286,7 @@ files:
 - app/datatables/admin/effective_applicant_reviews_datatable.rb
 - app/datatables/admin/effective_applicants_datatable.rb
 - app/datatables/admin/effective_categories_datatable.rb
+- app/datatables/admin/effective_documents_datatable.rb
 - app/datatables/admin/effective_fee_payments_datatable.rb
 - app/datatables/admin/effective_fees_datatable.rb
 - app/datatables/admin/effective_membership_histories_datatable.rb
@@ -302,6 +304,7 @@ files:
 - app/datatables/effective_applicant_reviews_datatable.rb
 - app/datatables/effective_applicants_datatable.rb
 - app/datatables/effective_available_applicant_reviews_datatable.rb
+- app/datatables/effective_documents_datatable.rb
 - app/datatables/effective_fee_payments_datatable.rb
 - app/datatables/effective_memberships_directory_datatable.rb
 - app/datatables/effective_organizations_datatable.rb
@@ -330,6 +333,7 @@ files:
 - app/models/effective/applicant_reference.rb
 - app/models/effective/applicant_review.rb
 - app/models/effective/category.rb
+- app/models/effective/document.rb
 - app/models/effective/fee.rb
 - app/models/effective/fee_payment.rb
 - app/models/effective/membership.rb
@@ -366,6 +370,7 @@ files:
 - app/views/admin/categories/_form_fee_payment_content.html.haml
 - app/views/admin/categories/_form_fee_payment_steps.html.haml
 - app/views/admin/categories/_form_fees.html.haml
+- app/views/admin/documents/_form.html.haml
 - app/views/admin/fee_payments/_fee_payment.html.haml
 - app/views/admin/fees/_fee.html.haml
 - app/views/admin/fees/_form.html.haml
@@ -461,6 +466,7 @@ files:
 - app/views/effective/applicants/submitted.html.haml
 - app/views/effective/applicants/summary.html.haml
 - app/views/effective/applicants/transcripts.html.haml
+- app/views/effective/documents/_dashboard.html.haml
 - app/views/effective/fee_payments/_content.html.haml
 - app/views/effective/fee_payments/_dashboard.html.haml
 - app/views/effective/fee_payments/_declarations.html.haml
@@ -507,6 +513,7 @@ files:
 - app/views/users/_demographics.html.haml
 - app/views/users/_fields_demographics.html.haml
 - config/effective_memberships.rb
+- config/locales/effective_memberships.en.yml
 - config/routes.rb
 - db/migrate/01_create_effective_memberships.rb.erb
 - db/seeds.rb