effective_memberships 0.16.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 913cafff7bf0ade82697b95f576501d6471c1b7b1ea295623ef957bbb934f953
-  data.tar.gz: 4590de5b2573623e254062b93caca7c2a82fdd7dc83f4c8f83df591c3ceb0bba
+  metadata.gz: '09fbb8a22bb53806fe272999514bc8cc4d8b8cf5784aaab5428777ffe43af61e'
+  data.tar.gz: cc6fd66a60a0db18c98a44849e3768e8c6d892b6af9cd297485b18f65290457b
 SHA512:
-  metadata.gz: 6e1c081eb3c04b59fefd0b20ce9e5b927ec426ea833ca1a662a519f956a7e6f389efb6f5cf8952e2d1b4a91a0689496751a4bd3f3c67286e3c2f6b97e0126f1c
-  data.tar.gz: 59be5dc261759df1cf1f36c21852e71e49967f13f7be79b23276d8ef9f9bdffca2f43ee074bb6b9ab7849a25fa5e585efffe1425d29feb50fac96af22687e72a
+  metadata.gz: e286896d066c61cb0bb65b325837152d275f43c158e0f8df95302c36aee81ef1fcd3359efd37a71ec3f78b182a87fa0ee587c6ffe017d3971013af32b3647e67
+  data.tar.gz: 37c79f3c9a254275346c352832082bf9014690144720fd3ea2fef642dfe2740f3e72f3597870754f4c0076574ade33c65a1227d8fefa4f2325903aaacef9bd7f

data/app/datatables/admin/effective_categories_datatable.rb

@@ -35,9 +35,14 @@ module Admin
       col :qb_item_name, visible: false
 
       col :create_renewal_fees, visible: false
+      col :create_early_fees, visible: false
       col :create_late_fees, visible: false
       col :create_not_in_good_standing, visible: false
 
+      col :renewal_fee, as: :price, visible: false
+      col :early_fee, as: :price, visible: false
+      col :late_fee, as: :price, visible: false
+
       col :category_type, search: EffectiveMemberships.Category.category_types, visible: false
 
       col :optional_applicant_wizard_steps, label: 'Applicant Steps', visible: false

data/app/models/concerns/effective_memberships_category.rb

@@ -99,13 +99,19 @@ module EffectiveMembershipsCategory
       fee_payment_wizard_steps          :text
       fee_payment_cpd_step_requirement  :string
 
-      # Renewals
+      # Renewal Fees
       create_renewal_fees   :boolean
       renewal_fee           :integer
 
+      # Early Fees
+      create_early_fees     :boolean
+      early_fee             :integer
+
+      # Late Fees
       create_late_fees      :boolean
       late_fee              :integer
 
+      # NIGS Status
       create_not_in_good_standing   :boolean
 
       # Pricing
@@ -167,6 +173,19 @@ module EffectiveMembershipsCategory
       validates :qb_item_name, presence: true
       validates :tax_exempt, inclusion: { in: [true, false] }
     end
+
+    with_options(if: -> { create_renewal_fees? }) do
+      validates :renewal_fee, presence: true, numericality: { greater_than_or_equal_to: 0 }
+    end
+
+    with_options(if: -> { create_early_fees? }) do
+      validates :early_fee, presence: true, numericality: { less_than_or_equal_to: 0 }
+    end
+
+    with_options(if: -> { create_late_fees? }) do
+      validates :late_fee, presence: true, numericality: { greater_than_or_equal_to: 0 }
+    end
+
   end
 
   # Instance Methods

data/app/models/concerns/effective_memberships_owner.rb

@@ -304,6 +304,34 @@ module EffectiveMembershipsOwner
     fee
   end
 
+  def build_early_fee(category:, period:)
+    raise('must have an existing membership') unless membership.present?
+
+    # Return existing but do not build yet
+    fee = fees.find { |fee| fee.fee_type == 'Early' && fee.period == period && fee.category_id == category.id && fee.category_type == category.class.name }
+    return fee if fee&.purchased?
+
+    # Only continue if there is an early renewal fee for the same period
+    renewal_fee = fees.find { |fee| fee.fee_type == 'Renewal' && fee.period == period && fee.category_id == category.id && fee.category_type == category.class.name }
+    return if fee.blank? && (renewal_fee.blank? || renewal_fee.early? == false)
+
+    # Build the early fee
+    fee ||= fees.build()
+
+    fee.assign_attributes(
+      fee_type: 'Early',
+      category: category,
+      period: period,
+      price: category.early_fee.to_i,
+      tax_exempt: category.tax_exempt,
+      qb_item_name: category.qb_item_name
+    )
+
+    after_build_fee(fee)
+
+    fee
+  end
+
   def build_late_fee(category:, period:)
     raise('must have an existing membership') unless membership.present?
 

data/app/models/concerns/effective_memberships_registrar.rb

@@ -24,7 +24,7 @@ module EffectiveMembershipsRegistrar
   end
 
   def late_fee_date(period:)
-    Time.zone.local(period.year, 2, 1) # Fees are late after February 1st
+    Time.zone.local(period.year, 2, 1) # Fees are late after February 1st.
     raise('to be implemented by app registrar')
   end
 
@@ -33,6 +33,22 @@ module EffectiveMembershipsRegistrar
     raise('to be implemented by app registrar')
   end
 
+  # The early fee dates are calculated based on period
+  # The period is a date that starts on Jan 1st of a year.
+  # When Time.zone.now is December the period will be one ahead.
+
+  # Assumed to be the same as renewal_fee_date
+  def early_fee_date(period:)
+    Time.zone.local(period.year - 1, 12, 1) # Fees roll over every December 1st
+    raise('to be implemented by app registrar')
+  end
+
+  # Assumed to be just before the period actually starts
+  def early_fee_end_date(period:)
+    Time.zone.local(period.year - 1, 12, 31) # Early fees are destroyed on December 31st
+    raise('to be implemented by app registrar')
+  end
+
   # A renewal fee must be at least this old to be considered late?
   # Must be less than (late_fee_date - renewal_fee_date) but this is not enforced
   def min_late_duration
@@ -112,6 +128,10 @@ module EffectiveMembershipsRegistrar
     periods(from: from, to: to).reverse.map { |period| [period_end_on(date: period), period] }
   end
 
+  def early_fee_date_range(period:)
+    (early_fee_date(period: period).beginning_of_day)..(early_fee_end_date(period: period).beginning_of_day)
+  end
+
   # Category is required, statuses are optional
   def assign!(owner, categories:, statuses: nil, date: nil, number: nil)
     categories = Array(categories)
@@ -492,31 +512,48 @@ module EffectiveMembershipsRegistrar
   # rake effective_memberships:create_fees
   # Create Renewal and Late fees
   # Assigns NIGS
-  def create_all_fees!(period: nil)
+  def create_all_fees!(period: nil, force: false)
     period ||= current_period
     memberships = Effective::Membership.deep.with_unpaid_fees_through(period)
 
     memberships.find_each do |membership|
-      create_fees!(membership, period: period); GC.start
+      create_fees!(membership, period: period, force: force); GC.start
     end
 
     true
   end
 
-  def create_fees!(resource, period: nil)
+  def create_fees!(resource, period: nil, force: false)
+    today = Time.zone.now.beginning_of_day
     period ||= current_period
 
     membership = (resource.class.respond_to?(:effective_memberships_owner?) ? resource.membership : resource)
     raise('expected a membership') unless membership.present? && membership.kind_of?(Effective::Membership)
 
     # Create Renewal Fees
-    create_renewal_fees!(membership, period: period)
+    if force || today == renewal_fee_date(date: today)
+      create_renewal_fees!(membership, period: period)
+    end
+
+    # Create Early Fees
+    if force || today == early_fee_date(period: period)
+      create_early_fees!(membership, period: period)
+    end
+
+    # Destroy Early Fees
+    if force || today == early_fee_end_date(period: period)
+      destroy_early_fees!(membership, period: period)
+    end
 
     # Create Late Fees
-    create_late_fees!(membership, period: period)
+    if force || today == late_fee_date(period: period)
+      create_late_fees!(membership, period: period)
+    end
 
     # Update Membership Status - Assign Not In Good Standing
-    create_not_in_good_standing!(membership, period: period)
+    if force || today == not_in_good_standing_date(period: period)
+      create_not_in_good_standing!(membership, period: period)
+    end
 
     true
   end
@@ -536,6 +573,28 @@ module EffectiveMembershipsRegistrar
     end
   end
 
+  def create_early_fees!(membership, period:)
+    membership.categories.select(&:create_early_fees?).map do |category|
+      fee = membership.owner.build_early_fee(category: category, period: period)
+      next if fee.blank? || fee.persisted?
+
+      puts("Created early fee for #{membership.owner}") if debug?
+
+      fee.save!
+    end
+  end
+
+  def destroy_early_fees!(membership, period:)
+    membership.categories.select(&:create_early_fees?).map do |category|
+      fee = membership.owner.build_early_fee(category: category, period: period)
+      next if fee.blank? || fee.early? || fee.purchased? || fee.deferred?
+
+      puts("Destroyed early fee for #{membership.owner}") if debug?
+
+      fee.destroy!
+    end
+  end
+
   def create_late_fees!(membership, period:)
     membership.categories.select(&:create_late_fees?).map do |category|
       fee = membership.owner.build_late_fee(category: category, period: period)
@@ -548,7 +607,6 @@ module EffectiveMembershipsRegistrar
   end
 
   def create_not_in_good_standing!(membership, period:)
-    return unless Time.zone.now.beginning_of_day == not_in_good_standing_date(period: period).beginning_of_day
     return unless membership.categories.any?(&:create_not_in_good_standing?)
 
     membership.owner.update_membership_status!

data/app/models/effective/fee.rb

@@ -92,6 +92,11 @@ module Effective
       title.presence || default_title()
     end
 
+    def early?
+      return false if purchased?
+      EffectiveMemberships.Registrar.early_fee_date_range(period: period).cover?(Time.zone.now)
+    end
+
     def late?
       return false if late_on.blank?
       return false if purchased?
@@ -144,10 +149,6 @@ module Effective
       ['Prorated', 'Renewal'].include?(fee_type)
     end
 
-    def renewal_fee?
-      fee_type == 'Renewal'
-    end
-
     def custom_fee?
       EffectiveMemberships.custom_fee_types.include?(fee_type)
     end

data/app/models/effective/membership.rb

@@ -306,7 +306,7 @@ module Effective
 
       # Otherwise build fees right now
       EffectiveMemberships.Registrar.delete_fees!(self)
-      EffectiveMemberships.Registrar.create_fees!(self, period: period)
+      EffectiveMemberships.Registrar.create_fees!(self, period: period, force: true)
 
       true
     end

data/app/models/effective/registrar.rb

@@ -15,5 +15,13 @@ module Effective
       Time.zone.local(period.year, 3, 1) # Membership are Not In Good Standing after March 1st
     end
 
+    def early_fee_date(period:)
+      Time.zone.local(period.year - 1, 12, 1) # Fees roll over every December 1st
+    end
+
+    def early_fee_end_date(period:)
+      Time.zone.local(period.year - 1, 12, 31) # Early fees are destroyed on December 31st
+    end
+
   end
 end

data/app/views/admin/categories/_fees_early.html.haml

@@ -0,0 +1,14 @@
+%h3= ets('effective_memberships.fees.early')
+
+= f.check_box :create_early_fees, label: "Yes, #{ets('effective_memberships.fees.early')} should be created"
+
+= f.show_if(:create_early_fees, true) do
+  - period = EffectiveMemberships.Registrar.current_period
+  - date = EffectiveMemberships.Registrar.early_fee_date(period: period)
+  - end_date = EffectiveMemberships.Registrar.early_fee_end_date(period: period)
+
+  %p Charged to members, between #{date.strftime('%B %e')} and #{end_date.strftime('%B %e')}, with outstanding renewal dues.
+
+  .row
+    .col-md-3
+      = f.price_field :early_fee, hint: 'Expecting a price less than zero. Please enter the early fee discount from the regular price'

data/app/views/admin/categories/_fees_late.html.haml

@@ -1,5 +1,6 @@
-%h3 Late Fees
-= f.check_box :create_late_fees, label: 'Yes, late fees should be created'
+%h3= ets('effective_memberships.fees.late')
+
+= f.check_box :create_late_fees, label: "Yes, #{ets('effective_memberships.fees.late')} should be created"
 
 = f.show_if(:create_late_fees, true) do
   - period = EffectiveMemberships.Registrar.current_period
@@ -7,4 +8,4 @@
 
   %p Charged to members, on #{date.strftime('%B %e')}, with outstanding renewal dues or other fees.
   .row
-    .col-3= f.price_field :late_fee
+    .col-md-3= f.price_field :late_fee

data/app/views/admin/categories/_fees_renewal.html.haml

@@ -1,5 +1,5 @@
-%h3 Renewal Fees
-= f.check_box :create_renewal_fees, label: 'Yes, annual renewal fees should be created'
+%h3= ets('effective_memberships.fees.renewal')
+= f.check_box :create_renewal_fees, label: "Yes, #{ets('effective_memberships.fees.renewal')} should be created"
 
 = f.show_if(:create_renewal_fees, true) do
   - date = EffectiveMemberships.Registrar.renewal_fee_date(date: Time.zone.now)

data/app/views/admin/categories/_form_fees.html.haml

@@ -1,7 +1,20 @@
 = effective_form_with(model: [:admin, category], engine: true) do |f|
   = render('admin/categories/fees_applicant', f: f)
-  = render('admin/categories/fees_renewal', f: f)
-  = render('admin/categories/fees_late', f: f)
+
+  - now = Time.zone.now
+
+  - if EffectiveMemberships.Registrar.renewal_fee_date(date: now).present?
+    = render('admin/categories/fees_renewal', f: f)
+
+  - if EffectiveMemberships.Registrar.early_fee_date(period: now).present?
+    = render('admin/categories/fees_early', f: f)
+
+  - if EffectiveMemberships.Registrar.late_fee_date(period: now).present?
+    = render('admin/categories/fees_late', f: f)
+
   = render('admin/categories/fees_additional', f: f)
-  = render('admin/categories/fees_nigs', f: f)
+
+  - if EffectiveMemberships.Registrar.not_in_good_standing_date(period: now).present?
+    = render('admin/categories/fees_nigs', f: f)
+
   = f.submit

data/config/locales/effective_memberships.en.yml

@@ -8,6 +8,7 @@ en:
       prorated: 'Prorated Fee'
       reinstatement: 'Reinstatement Fee'
       renewal: 'Renewal Fee'
+      early: 'Early Fee'
       late: 'Late Fee'
       discount: 'Discount Fee'
       admin: 'Admin Fee'

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

@@ -52,6 +52,9 @@ class CreateEffectiveMemberships < ActiveRecord::Migration[6.0]
       t.boolean :create_renewal_fees, default: false
       t.integer :renewal_fee
 
+      t.boolean :create_early_fees, default: false
+      t.integer :early_fee
+
       t.boolean :create_late_fees, default: false
       t.integer :late_fee
 

data/lib/effective_memberships/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMemberships
-  VERSION = '0.16.2'
+  VERSION = '0.17.0'
 end

data/lib/effective_memberships.rb

@@ -58,7 +58,7 @@ module EffectiveMemberships
   end
 
   def self.fee_types
-    required = ['Applicant', 'Reinstatement', 'Prorated', 'Discount', 'Renewal', 'Late', 'Admin']
+    required = ['Applicant', 'Reinstatement', 'Prorated', 'Discount', 'Renewal', 'Early', 'Late', 'Admin']
     additional = Array(additional_fee_types)
 
     (required + additional).uniq.sort

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_memberships
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.17.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -367,6 +367,7 @@ files:
 - app/views/admin/applicants/_status.html.haml
 - app/views/admin/categories/_fees_additional.html.haml
 - app/views/admin/categories/_fees_applicant.html.haml
+- app/views/admin/categories/_fees_early.html.haml
 - app/views/admin/categories/_fees_late.html.haml
 - app/views/admin/categories/_fees_nigs.html.haml
 - app/views/admin/categories/_fees_renewal.html.haml