effective_memberships 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6e16095d62eababb9b14b78f65c13b45b744e15c16f92b79724b8e138b4b38d
+  data.tar.gz: e4a51731819350e85f49615a982614197fc05fcf3b4b5da4558a6a534eab1ea2
+SHA512:
+  metadata.gz: c333cb75909efad3f4400b0fead9397b5f3f89d3d4df9dc920e9b5867ad58223fa0baeb3170db00b0d652bbf41d48405832b103e3fb84b872ed042634a20a0a3
+  data.tar.gz: 859cea163d8380b4daf5e6dbc98f575a1b755fded7a27c3a227ddc36e1de61b1225304e091d44c9a4fa6096b1b464aeaf0f339013c57920ad5bd91e027575992

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Code and Effect Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# Effective Memberships
+
+TODO: This Readme is inaccurate and severely incomplete.
+
+Membership categories, applications to join and reclassify, annual dues payments.
+
+Works with action_text for content bodies, and active_storage for file uploads.
+
+## Getting Started
+
+This requires Rails 6+ and Twitter Bootstrap 4 and just works with Devise.
+
+Please first install the [effective_datatables](https://github.com/code-and-effect/effective_datatables) gem.
+
+Please download and install the [Twitter Bootstrap4](http://getbootstrap.com)
+
+Add to your Gemfile:
+
+```ruby
+gem 'haml-rails' # or try using gem 'hamlit-rails'
+gem 'effective_memberships'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+Then run the generator:
+
+```ruby
+rails generate effective_memberships:install
+```
+
+The generator will install an initializer which describes all configuration options and creates a database migration.
+
+If you want to tweak the table names, manually adjust both the configuration file and the migration now.
+
+Then migrate the database:
+
+```ruby
+rake db:migrate
+```
+
+Please add the following to your User model:
+
+```
+effective_memberships_owner
+
+Use the following datatables to display to your user their applicants dues:
+
+```haml
+%h2 Applications to Join
+- datatable = EffectiveMembershipsApplicantssDatatable.new(self)
+```
+
+and
+
+```
+Add a link to the admin menu:
+
+```haml
+- if can? :admin, :effective_memberships
+  - if can? :index, Effective::Category
+    = nav_link_to 'Membership Categories', effective_memberships.admin_categories_path
+
+  - if can? :index, Effective::Applicants
+    = nav_link_to 'Applicants', effective_memberships.admin_applicants_path
+```
+
+## Configuration
+
+## Authorization
+
+All authorization checks are handled via the effective_resources gem found in the `config/initializers/effective_resources.rb` file.
+
+## Permissions
+
+The permissions you actually want to define are as follows (using CanCan):
+
+```ruby
+# Regular signed up user. Guest users not supported.
+if user.persisted?
+  can :new, Effective::Applicant
+end
+
+if user.admin?
+  can :admin, :effective_memberships
+  can :manage, Effective::Category
+  can :manage, Effective::Applicant
+end
+```
+
+## License
+
+MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
+
+## Testing
+
+Run tests by:
+
+```ruby
+rails test
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Bonus points for test coverage
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/effective_memberships_manifest.js

@@ -0,0 +1,3 @@
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link_tree ../images

data/app/assets/javascripts/effective_memberships/applicant_courses.js

@@ -0,0 +1,29 @@
+// # When any data-applicant-experiences-month changes, sum them all up.
+function sumApplicantCourses($form) {
+  // For each area
+  $form.find('.applicant-course-area').each(function() {
+    const $area = $(this);
+
+    let sum = 0;
+
+    $area.find('input[data-applicant-courses-amount]').each(function() {
+      sum += parseInt($(this).val() || 0);
+    });
+
+    $area.find('[data-applicant-course-area-sum]').text(sum);
+  });
+
+  // For everything
+  let sum = 0;
+
+  $form.find('input[data-applicant-courses-amount]').each(function() {
+    sum += parseInt($(this).val() || 0);
+  });
+
+  $form.find('[data-applicant-courses-sum]').text(sum);
+};
+
+$(document).on('change dp.change keyup', "[data-applicant-courses-amount]", function(event) {
+  const $form = $(event.currentTarget).closest('form');
+  sumApplicantCourses($form);
+});

data/app/assets/javascripts/effective_memberships/applicant_experiences.js

@@ -0,0 +1,38 @@
+// # When any data-applicant-experiences-month changes, sum them all up.
+function sumApplicantExperiences($form) {
+  let months = 0;
+
+  // Sum each nested fields
+  $form.find('.has-many-fields:visible').each(function() {
+    const $obj = $(this);
+
+    const start_on = $obj.find("input[name$='[start_on]']").val();
+    const end_on = $obj.find("input[name$='[end_on]']").val();
+
+    const level = $obj.find("input[name$='[level]']:checked").val();
+    const percent = $obj.find("input[name$='[percent_worked]']").val() || 0;
+
+    let diff = (moment(end_on).diff(moment(start_on), 'months') || 0);
+
+    if(level == 'Part Time') {
+      diff = Math.floor(diff * (percent / 100000.0)) // 100%
+    }
+
+    $obj.find("p[id$='_months']").text(diff);
+
+    if(diff > 0) { months += diff; }
+  });
+
+  // Sum Total
+  $form.find('p#applicant_applicant_experiences_months').text(months);
+};
+
+$(document).on('change dp.change keyup', "[data-applicant-experiences-month]", function(event) {
+  const $form = $(event.currentTarget).closest('form');
+  sumApplicantExperiences($form);
+});
+
+
+// $(document).on 'cocoon:after-remove', (event) ->
+//   $form = $(event.target).closest('form')
+//   sumMonths($form) if $form.find('[data-experience-month]').length > 0

data/app/assets/javascripts/effective_memberships.js

@@ -0,0 +1 @@
+//= require_tree ./effective_memberships

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

@@ -0,0 +1,5 @@
+.table-courses .form-group { margin-bottom: 0; }
+.table-courses th,
+.table-courses td { vertical-align: middle; ;}
+
+.table-courses-course-name { text-align: right; width: 15rem; }

data/app/assets/stylesheets/effective_memberships.scss

@@ -0,0 +1 @@
+@import 'effective_memberships/base';

data/app/controllers/admin/applicant_course_areas_controller.rb

@@ -0,0 +1,15 @@
+module Admin
+  class ApplicantCourseAreasController < 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_applicant_course_area).permit!
+    end
+
+  end
+end

data/app/controllers/admin/applicant_course_names_controller.rb

@@ -0,0 +1,15 @@
+module Admin
+  class ApplicantCourseNamesController < 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_applicant_course_name).permit!
+    end
+
+  end
+end

data/app/controllers/admin/applicants_controller.rb

@@ -0,0 +1,33 @@
+module Admin
+  class ApplicantsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_memberships) }
+
+    include Effective::CrudController
+
+    resource_scope -> { EffectiveMemberships.Applicant.deep.all }
+    datatable -> { Admin::EffectiveApplicantsDatatable.new }
+
+    submit :approve, 'Approve Applicant', success: -> {
+      [
+        "Successfully approved #{resource.owner} #{resource}",
+        ("and sent #{resource.owner.email} a notification" unless resource.email_form_skip)
+      ].compact.join(' ')
+    }
+
+    submit :decline, 'Decline Applicant', success: -> {
+      [
+        "Successfully declined #{resource.owner} #{resource}",
+        ("and sent #{resource.owner.email} a notification" unless resource.email_form_skip)
+      ].compact.join(' ')
+    }
+
+    private
+
+    def permitted_params
+      model = (params.key?(:effective_applicant) ? :effective_applicant : :applicant)
+      params.require(model).permit!
+    end
+
+  end
+end

data/app/controllers/admin/categories_controller.rb

@@ -0,0 +1,19 @@
+module Admin
+  class CategoriesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_memberships) }
+
+    include Effective::CrudController
+
+    resource_scope -> { EffectiveMemberships.Category.deep.all }
+    datatable -> { Admin::EffectiveCategoriesDatatable.new }
+
+    private
+
+    def permitted_params
+      model = (params.key?(:effective_category) ? :effective_category : :category)
+      params.require(model).permit!
+    end
+
+  end
+end

data/app/controllers/admin/fees_controller.rb

@@ -0,0 +1,18 @@
+module Admin
+  class FeesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_memberships) }
+
+    include Effective::CrudController
+
+    resource_scope -> { Effective::Fee.deep.all }
+
+    private
+
+    def permitted_params
+      model = (params.key?(:effective_fee) ? :effective_fee : :fee)
+      params.require(model).permit!
+    end
+
+  end
+end

data/app/controllers/admin/registrar_actions_controller.rb

@@ -0,0 +1,49 @@
+module Admin
+  class RegistrarActionsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_memberships) }
+
+    include Effective::CrudController
+    resource_scope -> { Effective::RegistrarAction }
+
+    submit :register, 'Register',
+      success: -> { "#{resource.owner} is now a #{resource.owner.membership.category} member" },
+      redirect: -> { admin_owners_path(resource) }
+
+    submit :reclassify, 'Reclassify',
+      success: -> { "#{resource.owner} has been reclassified to #{resource.owner.membership.category}" },
+      redirect: -> { admin_owners_path(resource) }
+
+    submit :remove, 'Remove',
+      success: -> { "#{resource.owner} has been removed" },
+      redirect: -> { admin_owners_path(resource) }
+
+    submit :bad_standing, 'Set In Bad Standing',
+      success: -> { "#{resource.owner} is now In Bad Standing" },
+      redirect: -> { admin_owners_path(resource) }
+
+    submit :good_standing, 'Remove In Bad Standing',
+      success: -> { "#{resource.owner} is now In Good Standing" },
+      redirect: -> { admin_owners_path(resource) }
+
+    submit :fees_paid, 'Mark Fees Paid',
+      success: -> { "#{resource.owner} has now paid their fees through #{resource.owner.membership.fees_paid_through_period&.strftime('%F')}" },
+      redirect: -> { admin_owners_path(resource) }
+
+    after_error do
+      flash.keep
+      redirect_to admin_owners_path(resource)
+    end
+
+    private
+
+    def permitted_params
+      params.require(:effective_registrar_action).permit!
+    end
+
+    def admin_owners_path(resource)
+      Effective::Resource.new(resource.owner, namespace: :admin).action_path(:edit)
+    end
+
+  end
+end

data/app/controllers/effective/applicant_references_controller.rb

@@ -0,0 +1,37 @@
+module Effective
+  class ApplicantReferencesController < ApplicationController
+    include Effective::CrudController
+
+    page_title 'Confidential Reference Form'
+
+    # The show and update actions are public routes but can only be reached by the token.
+    # The reference must declare and submit the form
+    # To move an applicant reference from submitted to completed
+
+    submit :notify, 'Resend email notification',
+      success: -> { "Sent email notification to #{resource.email}" }
+
+    submit :complete, 'Complete Reference'
+
+    def show
+      @applicant_reference = ApplicantReference.submitted.find(params[:id])
+      EffectiveResources.authorize!(self, :show, @applicant_reference)
+
+      render 'edit'
+    end
+
+    protected
+
+    def permitted_params
+      permitted = params.require(:effective_applicant_reference).permit!.except(:token, :last_notified_at, :status, :status_steps)
+
+      if resource.submitted? && resource.applicant.was_submitted? && (resource.applicant.owner != current_user.effective_memberships_owner)
+        permitted
+      else
+        permitted.except(:reservations, :reservations_reason, :work_history, :accept_declaration)
+      end
+
+    end
+
+  end
+end

data/app/controllers/effective/applicants_controller.rb

@@ -0,0 +1,34 @@
+module Effective
+  class ApplicantsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    include Effective::WizardController
+
+    resource_scope -> { EffectiveMemberships.Applicant.deep.where(owner: current_user.effective_memberships_owner) }
+
+    # Allow only 1 in-progress application at a time
+    before_action(only: [:new, :show], unless: -> { resource&.done? }) do
+      existing = resource_scope.in_progress.where.not(id: resource).first
+
+      if existing.present?
+        flash[:success] = "You have been redirected to your existing in progress application"
+        redirect_to effective_memberships.applicant_build_path(existing, existing.next_step)
+      end
+    end
+
+    after_save do
+      flash.now[:success] = ''
+    end
+
+    private
+
+    def permitted_params
+      params.require(:applicant).permit!.except(
+        :owner_id, :owner_type, :status, :status_steps, :wizard_steps,
+        :submitted_at, :completed_at, :reviewed_at, :approved_at,
+        :declined_at, :declined_reason, :created_at, :updated_at
+      )
+    end
+
+  end
+end

data/app/controllers/effective/fee_payments_controller.rb

@@ -0,0 +1,29 @@
+module Effective
+  class FeePaymentsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    include Effective::WizardController
+
+    resource_scope -> { EffectiveMemberships.FeePayment.deep.where(owner: current_user.effective_memberships_owner) }
+
+    # Allow only 1 in-progress fee payment at a time
+    before_action(only: [:new, :show], unless: -> { resource&.done? }) do
+      existing = resource_scope.in_progress.where.not(id: resource).first
+
+      if existing.present?
+        flash[:success] = "You have been redirected to your existing in progress fee payment"
+        redirect_to effective_memberships.fee_payment_build_path(existing, existing.next_step)
+      end
+    end
+
+    private
+
+    def permitted_params
+      params.require(:fee_payment).permit!.except(
+        :owner_id, :owner_type, :status, :status_steps, :wizard_steps,
+        :submitted_at
+      )
+    end
+
+  end
+end

data/app/datatables/admin/effective_applicant_course_areas_datatable.rb

@@ -0,0 +1,17 @@
+module Admin
+  class EffectiveApplicantCourseAreasDatatable < Effective::Datatable
+    datatable do
+      reorder :position
+
+      col :title
+      col :applicant_course_names, label: 'Courses'
+
+      actions_col
+    end
+
+    collection do
+      Effective::ApplicantCourseArea.deep.all
+    end
+
+  end
+end

data/app/datatables/admin/effective_applicant_course_names_datatable.rb

@@ -0,0 +1,17 @@
+module Admin
+  class EffectiveApplicantCourseNamesDatatable < Effective::Datatable
+    datatable do
+      reorder :position
+
+      col :applicant_course_area, label: 'Course Area'
+      col :title
+
+      actions_col
+    end
+
+    collection do
+      Effective::ApplicantCourseName.deep.all
+    end
+
+  end
+end

data/app/datatables/admin/effective_applicants_datatable.rb

@@ -0,0 +1,55 @@
+module Admin
+  class EffectiveApplicantsDatatable < Effective::Datatable
+    filters do
+      scope :all
+      scope :in_progress, label: 'Open / Active'
+      scope :done, label: 'Done'
+    end
+
+    datatable do
+      order :id
+      col :id, visible: false
+
+      col :status
+
+      col :created_at, label: 'Created', as: :date, visible: false
+      col :updated_at, label: 'Updated', visible: false
+
+      col :submitted_at, label: 'Submitted', visible: false, as: :date
+      col :completed_at, label: 'Completed', visible: false, as: :date
+      col :reviewed_at, label: 'Reviewed', visible: false, as: :date
+      col :approved_at, label: 'Approved', visible: false, as: :date
+
+      col :owner
+
+      col :applicant_type
+      col :category, search: { collection: EffectiveMemberships.Category.all, polymorphic: false }
+      col :from_category, search: { collection: EffectiveMemberships.Category.all, polymorphic: false }, visible: false
+
+      col :orders, visible: false
+
+      actions_col
+    end
+
+    collection do
+      applicants = EffectiveMemberships.Applicant.deep.all
+
+      raise('expected an owner_id, not user_id') if attributes[:user_id].present?
+
+      if scope == :in_progress && attributes[:owner_id].blank?
+        applicants = applicants.where.not(status: :draft)
+      end
+
+      if attributes[:owner_id].present?
+        applicants = applicants.where(owner_id: attributes[:owner_id])
+      end
+
+      if attributes[:except_id].present?
+        applicants = applicants.where.not(id: attributes[:except_id])
+      end
+
+      applicants
+    end
+
+  end
+end

data/app/datatables/admin/effective_categories_datatable.rb

@@ -0,0 +1,23 @@
+module Admin
+  class EffectiveCategoriesDatatable < Effective::Datatable
+    datatable do
+      reorder :position
+
+      col :updated_at, visible: false
+      col :created_at, visible: false
+      col :id, visible: false
+
+      col :title
+      col :applicant_fee, as: :price
+      col :renewal_fee, as: :price
+      col :late_fee, as: :price
+      col :rich_text_body, label: 'Body'
+
+      actions_col
+    end
+
+    collection do
+      EffectiveMemberships.Category.deep.all
+    end
+  end
+end