effective_memberships 0.1.2

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

@@ -0,0 +1,380 @@
+class CreateEffectiveMemberships < ActiveRecord::Migration[6.0]
+  def change
+
+    # Categories
+    create_table :categories do |t|
+      t.string :title
+      t.string :category
+
+      t.integer :position
+
+      # Applicants
+      t.boolean :can_apply_new, default: false
+      t.boolean :can_apply_existing, default: false
+      t.boolean :can_apply_restricted, default: false
+      t.text :can_apply_restricted_ids
+
+      t.text :applicant_wizard_steps
+      t.integer :applicant_fee
+
+      t.text :applicant_review_wizard_steps
+
+      t.integer :min_applicant_educations
+      t.integer :min_applicant_experiences_months
+      t.integer :min_applicant_references
+      t.integer :min_applicant_courses
+      t.integer :min_applicant_files
+
+      t.integer :min_applicant_reviews
+
+      t.text :fee_payment_wizard_steps
+
+      t.integer :prorated_jan
+      t.integer :prorated_feb
+      t.integer :prorated_mar
+      t.integer :prorated_apr
+      t.integer :prorated_may
+      t.integer :prorated_jun
+      t.integer :prorated_jul
+      t.integer :prorated_aug
+      t.integer :prorated_sep
+      t.integer :prorated_oct
+      t.integer :prorated_nov
+      t.integer :prorated_dec
+
+      # Renewals
+      t.boolean :create_renewal_fees, default: false
+      t.integer :renewal_fee
+
+      t.boolean :create_late_fees, default: false
+      t.integer :late_fee
+
+      t.boolean :create_bad_standing, default: false
+
+      t.string :qb_item_name
+      t.boolean :tax_exempt, default: false
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    add_index :categories, :title
+    add_index :categories, :position
+
+    # Memberships
+    create_table :memberships do |t|
+      t.integer :owner_id
+      t.string :owner_type
+
+      t.string :number
+      t.integer :number_as_integer
+
+      t.date :joined_on
+      t.date :registration_on
+      t.date :fees_paid_period
+      t.date :fees_paid_through_period
+
+      t.boolean :bad_standing, default: false
+      t.boolean :bad_standing_admin, default: false
+      t.text :bad_standing_reason
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    add_index :memberships, [:owner_id, :owner_type], unique: true
+    add_index :memberships, :number
+
+    # Membership Categories Join table
+    create_table :membership_categories do |t|
+      t.integer :category_id
+      t.string :category_type
+
+      t.integer :membership_id
+      t.string :membership_type
+    end
+
+    # Membership Histories
+    create_table :membership_histories do |t|
+      t.integer :owner_id
+      t.string :owner_type
+
+      t.text :categories
+      t.text :category_ids
+
+      t.date :start_on
+      t.date :end_on
+
+      t.string :number
+
+      t.boolean :bad_standing, default: false
+      t.boolean :removed, default: false
+
+      t.text :notes
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    add_index :membership_histories, [:owner_id, :owner_type]
+    add_index :membership_histories, :start_on
+
+    # Applicants
+    create_table :applicants do |t|
+      t.string :token
+
+      t.integer :owner_id
+      t.string :owner_type
+
+      t.integer :category_id
+      t.string :category_type
+
+      t.integer :from_category_id
+      t.string :from_category_type
+
+      t.string :applicant_type
+
+      # Acts as Statused
+      t.string :status
+      t.text :status_steps
+
+      # Acts as Wizard
+      t.text :wizard_steps
+
+      # Dates
+      t.datetime :submitted_at
+      t.datetime :completed_at
+      t.datetime :reviewed_at
+      t.datetime :approved_at
+
+      # Declined
+      t.datetime :declined_at
+      t.text :declined_reason
+
+      # Applicant Educations
+      t.text :applicant_educations_details
+
+      # Applicant Experiences
+      t.integer :applicant_experiences_months
+      t.text :applicant_experiences_details
+
+      # Additional Information
+      t.text :additional_information
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    add_index :applicants, [:owner_id, :owner_type]
+    add_index :applicants, :status
+    add_index :applicants, :token
+
+    # Applicant Educations
+    create_table :applicant_educations do |t|
+      t.integer :applicant_id
+
+      t.date :start_on
+      t.date :end_on
+
+      t.string :institution
+      t.string :location
+
+      t.string :degree_obtained
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    add_index :applicant_educations, :applicant_id
+    add_index :applicant_educations, :start_on
+
+    # Applicant Experiences
+    create_table :applicant_experiences do |t|
+      t.integer :applicant_id
+
+      t.string :level
+      t.integer :months
+
+      t.date :start_on
+      t.date :end_on
+
+      t.string :position
+      t.string :employer
+
+      t.boolean :still_work_here, default: false
+      t.integer :percent_worked
+
+      t.text :tasks_performed
+
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    add_index :applicant_experiences, :applicant_id
+    add_index :applicant_experiences, :start_on
+
+    # Applicant References
+    create_table :applicant_references do |t|
+      t.integer :applicant_id
+
+      t.string :name
+      t.string :email
+      t.string :phone
+
+      t.string :status
+      t.text :status_steps
+      t.string :known
+      t.string :relationship
+
+      t.boolean :reservations
+      t.text :reservations_reason
+
+      t.text :work_history
+      t.boolean :accept_declaration
+
+      t.string :token
+      t.datetime :last_notified_at
+
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    add_index :applicant_references, :applicant_id
+    add_index :applicant_references, :token
+
+    # Applicant Courses
+    create_table :applicant_course_areas do |t|
+      t.string :title
+      t.integer :position
+
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    create_table :applicant_course_names do |t|
+      t.integer :applicant_course_area_id
+
+      t.string :title
+      t.integer :position
+
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    create_table :applicant_courses do |t|
+      t.integer :applicant_course_area_id
+      t.integer :applicant_course_name_id
+      t.integer :applicant_id
+
+      t.string  :title
+      t.integer :amount
+
+      t.string  :code
+      t.text    :description
+
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    # Applicant Reviews
+    create_table :applicant_reviews do |t|
+      t.string :token
+      t.integer :applicant_id
+
+      t.integer :reviewer_id
+      t.string :reviewer_type
+
+      # Acts as Statused
+      t.string :status
+      t.text :status_steps
+
+      # Acts as Wizard
+      t.text :wizard_steps
+
+      # Dates
+      t.datetime :submitted_at
+
+      # Recommendation
+      t.string :recommendation
+      t.text :comments
+
+      # Steps
+      t.boolean :conflict_of_interest
+      t.boolean :education_accepted
+      t.boolean :course_amounts_accepted
+      t.boolean :courses_accepted
+      t.boolean :experience_accepted
+      t.boolean :references_accepted
+      t.boolean :files_accepted
+
+      t.timestamps
+    end
+
+    # Fees
+    create_table :fees do |t|
+      t.integer :category_id
+      t.string :category_type
+
+      t.string :fee_type
+
+      t.integer :purchased_order_id
+
+      t.integer :owner_id
+      t.string :owner_type
+
+      t.integer :parent_id
+      t.string :parent_type
+
+      t.date :period
+      t.date :late_on
+      t.date :bad_standing_on
+
+      t.string :title
+      t.integer :price
+
+      t.string :qb_item_name
+      t.boolean :tax_exempt, default: false
+
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    add_index :fees, :fee_type
+    add_index :fees, :purchased_order_id
+    add_index :fees, :category_id
+
+    add_index :fees, [:owner_id, :owner_type]
+    add_index :fees, [:parent_id, :parent_type]
+
+    # Fee Payments
+    create_table :fee_payments do |t|
+      t.string :token
+
+      t.integer :owner_id
+      t.string :owner_type
+
+      t.integer :category_id
+      t.string :category_type
+
+      t.date :period
+
+      # Acts as Statused
+      t.string :status
+      t.text :status_steps
+
+      # Acts as Wizard
+      t.text :wizard_steps
+
+      # Dates
+      t.datetime :submitted_at
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    add_index :fee_payments, [:owner_id, :owner_type]
+    add_index :fee_payments, :status
+    add_index :fee_payments, :token
+
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,59 @@
+puts "Running effective_memberships seeds"
+
+now = Time.zone.now
+
+if Rails.env.test?
+  ActionText::RichText.where(record_type: ['Effective::Category']).delete_all
+  Effective::Category.delete_all
+  Effective::ApplicantCourseArea.delete_all
+  Effective::ApplicantCourseName.delete_all
+end
+
+member = Effective::Category.create!(
+  title: "Full Member",
+  can_apply_new: true,
+  can_apply_existing: true,
+  create_renewal_fees: true,
+  create_late_fees: true,
+  min_applicant_references: 2,
+  min_applicant_reviews: 2,
+  applicant_fee: 100_00,
+  renewal_fee: 250_00,
+  late_fee: 50_00,
+  prorated_jan: 120_00, prorated_feb: 110_00, prorated_mar: 100_00, prorated_apr: 90_00, prorated_may: 80_00, prorated_jun: 70_00,
+  prorated_jul: 60_00, prorated_aug: 50_00, prorated_sep: 40_00, prorated_oct: 30_00, prorated_nov: 20_00, prorated_dec: 10_00
+)
+
+student = Effective::Category.create!(
+  title: "Student",
+  can_apply_new: true,
+  create_renewal_fees: true,
+  create_late_fees: true,
+  min_applicant_references: 0,
+  min_applicant_reviews: 0,
+  applicant_fee: 50_00,
+  renewal_fee: 125_00,
+  late_fee: 25_00,
+  prorated_jan: 120_00, prorated_feb: 110_00, prorated_mar: 100_00, prorated_apr: 90_00, prorated_may: 80_00, prorated_jun: 70_00,
+  prorated_jul: 60_00, prorated_aug: 50_00, prorated_sep: 40_00, prorated_oct: 30_00, prorated_nov: 20_00, prorated_dec: 10_00
+)
+
+retired = Effective::Category.create!(
+  title: "Retired",
+  can_apply_new: false,
+  can_apply_existing: false,
+  can_apply_restricted: true,
+  can_apply_restricted_ids: [member.id],
+  applicant_fee: 0,
+  renewal_fee: 0,
+  prorated_jan: 120_00, prorated_feb: 110_00, prorated_mar: 100_00, prorated_apr: 90_00, prorated_may: 80_00, prorated_jun: 70_00,
+  prorated_jul: 60_00, prorated_aug: 50_00, prorated_sep: 40_00, prorated_oct: 30_00, prorated_nov: 20_00, prorated_dec: 10_00
+)
+
+area = Effective::ApplicantCourseArea.create!(title: 'Science')
+area.applicant_course_names.create!(title: 'Science 100')
+area.applicant_course_names.create!(title: 'Science 200')
+
+area = Effective::ApplicantCourseArea.create!(title: 'Arts')
+area.applicant_course_names.create!(title: 'Arts 100')
+area.applicant_course_names.create!(title: 'Arts 200')

data/lib/effective_memberships/engine.rb

@@ -0,0 +1,23 @@
+module EffectiveMemberships
+  class Engine < ::Rails::Engine
+    engine_name 'effective_memberships'
+
+    # Set up our default configuration options.
+    initializer 'effective_memberships.defaults', before: :load_config_initializers do |app|
+      eval File.read("#{config.root}/config/effective_memberships.rb")
+    end
+
+    # Include acts_as_addressable concern and allow any ActiveRecord object to call it
+    initializer 'effective_memberships.active_record' do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.extend(EffectiveMembershipsOwner::Base)
+        ActiveRecord::Base.extend(EffectiveMembershipsCategory::Base)
+
+        ActiveRecord::Base.extend(EffectiveMembershipsApplicant::Base)
+        ActiveRecord::Base.extend(EffectiveMembershipsApplicantReview::Base)
+        ActiveRecord::Base.extend(EffectiveMembershipsFeePayment::Base)
+      end
+    end
+
+  end
+end

data/lib/effective_memberships/version.rb

@@ -0,0 +1,3 @@
+module EffectiveMemberships
+  VERSION = '0.1.2'
+end

data/lib/effective_memberships.rb

@@ -0,0 +1,86 @@
+require 'effective_resources'
+require 'effective_datatables'
+require 'effective_memberships/engine'
+require 'effective_memberships/version'
+
+module EffectiveMemberships
+
+  def self.config_keys
+    [
+      :categories_table_name, :applicants_table_name, :applicant_reviews_table_name, :fee_payments_table_name,
+      :category_class_name, :applicant_class_name, :applicant_review_class_name, :fee_payment_class_name, :registrar_class_name,
+      :additional_fee_types,
+      :layout,
+      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :use_effective_email_templates
+    ]
+  end
+
+  include EffectiveGem
+
+  def self.Category
+    category_class_name&.constantize || Effective::Category
+  end
+
+  def self.Applicant
+    applicant_class_name&.constantize || Effective::Applicant
+  end
+
+  def self.ApplicantReview
+    applicant_review_class_name&.constantize || Effective::ApplicantReview
+  end
+
+  def self.FeePayment
+    fee_payment_class_name&.constantize || Effective::FeePayment
+  end
+
+  # Singleton
+  def self.Registrar
+    klass = registrar_class_name&.constantize || Effective::Registrar
+    klass.new
+  end
+
+  def self.mailer_class
+    mailer&.constantize || Effective::MembershipsMailer
+  end
+
+  def self.parent_mailer_class
+    return parent_mailer.constantize if parent_mailer.present?
+
+    if use_effective_email_templates
+      require 'effective_email_templates'
+      Effective::EmailTemplatesMailer
+    else
+      ActionMailer::Base
+    end
+  end
+
+  def self.fee_types
+    required = ['Applicant', 'Prorated', 'Discount', 'Renewal', 'Late', 'Admin']
+    additional = Array(additional_fee_types)
+
+    (required + additional).uniq.sort
+  end
+
+  # You can delete these if unpurchased
+  def self.custom_fee_types
+    ['Admin']
+  end
+
+  def self.send_email(email, *args)
+    raise('expected args to be an Array') unless args.kind_of?(Array)
+
+    if defined?(Tenant)
+      tenant = Tenant.current || raise('expected a current tenant')
+      args.last.kind_of?(Hash) ? args.last.merge!(tenant: tenant) : args << { tenant: tenant }
+    end
+
+    deliver_method = EffectiveMemberships.deliver_method || EffectiveResources.deliver_method
+
+    begin
+      EffectiveMemberships.mailer_class.send(email, *args).send(deliver_method)
+    rescue => e
+      raise if Rails.env.development? || Rails.env.test?
+    end
+  end
+
+end

data/lib/generators/effective_memberships/install_generator.rb

@@ -0,0 +1,40 @@
+module EffectiveMemberships
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc 'Creates an EffectiveMemberships initializer in your application.'
+
+      source_root File.expand_path('../../templates', __FILE__)
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          '%.3d' % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_initializer
+        template ('../' * 3) + 'config/effective_memberships.rb', 'config/initializers/effective_memberships.rb'
+      end
+
+      def create_migration_file
+        @categories_table_name  = ':' + EffectiveMemberships.categories_table_name.to_s
+
+        migration_template ('../' * 3) + 'db/migrate/01_create_effective_memberships.rb.erb', 'db/migrate/create_effective_memberships.rb'
+      end
+
+      def copy_mailer_preview
+        mailer_preview_path = (Rails.application.config.action_mailer.preview_path rescue nil)
+
+        if mailer_preview_path.present?
+          template 'effective_memberships_mailer_preview.rb', File.join(mailer_preview_path, 'effective_memberships_mailer_preview.rb')
+        else
+          puts "couldn't find action_mailer.preview_path. Skipping effective_memberships_mailer_preview."
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/templates/effective_memberships_mailer_preview.rb

@@ -0,0 +1,4 @@
+# Visit http://localhost:3000/rails/mailers
+
+class EffectiveMembershipsMailerPreview < ActionMailer::Preview
+end

data/lib/tasks/effective_memberships_tasks.rake

@@ -0,0 +1,17 @@
+namespace :effective_memberships do
+
+  # bundle exec rake effective_memberships:seed
+  task seed: :environment do
+    load "#{__dir__}/../../db/seeds.rb"
+  end
+
+  # rake effective_memberships:create_fees
+  desc 'Run daily to create Renewal and Late fees'
+  task create_fees: :environment do
+    if ActiveRecord::Base.connection.table_exists?(:memberships)
+      EffectiveLogger.info "Running effective_memberships:create_fees scheduled task" if defined?(EffectiveLogger)
+      EffectiveMemberships.Registrar.create_fees!
+    end
+  end
+
+end