effective_learndash 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07c61be03e0ed75629e8ca5ba549ad5b6853baf84853d064ab182023e322aee7
-  data.tar.gz: 0c49839157576ccc13f235dba925b278ec324a79c74a939655d455c83bf692f7
+  metadata.gz: 1f0eb60514e8eeffec5acb15be3ec18871d32deb63a220e4423798be3eb137d0
+  data.tar.gz: 99f7ddc61aeae6e835383237d64714f2de0865f6fe219f6437fa845ac43aa534
 SHA512:
-  metadata.gz: afa87292d29e2ff756bc78dc4c848f576a9632d91ca70d9070fd87e914ddf2fef3cddfeaf34928a45e55067c56bac876eb003db8d20933a4f40524f7c1ce3954
-  data.tar.gz: 665d1d771286353f7e0ab20dba5c9f6425c4cafeaddf00a36d41b2c4ed185edfb2b98527ff767d961a155a91b66c4d5e33891d420a10acee3679cc6bc674704c
+  metadata.gz: 0fe3018d26e29a3a2dbc1fd8c7863e120396d78d953562b7aa877dbbfc72aa59cd43dbb427b775a813789c89521849145d28c6ff97aec6cefbd8dfa3c997257b
+  data.tar.gz: 9c50f0c9b581b3e72ed59aad4d7d03d5dca525223369f1e33f6cbac867f775981b412b46a901aaa199d12907da660cf72159610d6875302a20f26c6e90322dd8

data/app/controllers/admin/course_fee_histories_controller.rb

@@ -0,0 +1,23 @@
+module Admin
+  class CourseFeeHistoriesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_learndash) }
+
+    include Effective::CrudController
+
+    # Inline datatable create/update/destroy do an in-place row swap and never re-render the
+    # price-timeline warnings shown on the course page. When triggered from an inline datatable,
+    # redirect back so the whole page reloads and the warnings recompute.
+    on(:save,    redirect: -> { :back if params[:_datatable_id].present? })
+    on(:destroy, redirect: -> { :back if params[:_datatable_id].present? })
+
+    # Duplicating closes the current prices at year-end and opens next year's copy.
+    on(:duplicate, redirect: -> { :back },
+      success: -> { "Copied #{resource.learndash_course}'s prices forward — set next year's prices on the new history." })
+
+    def permitted_params
+      params.require(:effective_course_fee_history).permit!
+    end
+
+  end
+end

data/app/datatables/admin/course_fee_histories_datatable.rb

@@ -0,0 +1,26 @@
+module Admin
+  class CourseFeeHistoriesDatatable < Effective::Datatable
+    datatable do
+      order :start_on, :desc
+
+      col :id, visible: false
+      col :created_at, visible: false
+      col :updated_at, visible: false
+
+      col :learndash_course, search: Effective::LearndashCourse.sorted
+
+      col :start_on
+      col :end_on, label: 'End on<br>(blank = current)'
+
+      col :regular_fee, as: :price
+      col :member_fee, as: :price
+
+      actions_col
+    end
+
+    collection do
+      Effective::CourseFeeHistory.deep.all
+    end
+
+  end
+end

data/app/datatables/admin/effective_learndash_courses_datatable.rb

@@ -16,8 +16,7 @@ module Admin
       col :learndash_users, visible: false
 
       col :can_register
-      col :regular_price, as: :price
-      col :member_price, as: :price
+      # Prices now live on date-ranged CourseFeeHistory records — see Admin::CourseFeeHistoriesDatatable.
 
       actions_col
     end

data/app/models/concerns/effective_learndash_course_registration.rb

@@ -49,9 +49,6 @@ module EffectiveLearndashCourseRegistration
     has_many :course_registrants, -> { order(:id) }, class_name: 'Effective::CourseRegistrant', inverse_of: :course_registration, dependent: :destroy
     accepts_nested_attributes_for :course_registrants, reject_if: :all_blank, allow_destroy: true
 
-    has_many :orders, -> { order(:id) }, as: :parent, class_name: 'Effective::Order', dependent: :nullify
-    accepts_nested_attributes_for :orders
-
     effective_resource do
       # Acts as Statused
       status                 :string, permitted: false

data/app/models/effective/course_fee_history.rb

@@ -0,0 +1,54 @@
+module Effective
+  # A dated set of prices for a learndash course.
+  #
+  # Prices used to live in flat columns (regular_price, member_price) directly on
+  # learndash_courses. They now live here so a price change can be scheduled ahead of
+  # time: each CourseFeeHistory covers a date range (start_on..end_on), and the price
+  # for a given date is read from whichever history covers it.
+  #
+  # There should always be exactly one open-ended (end_on: nil) history per course — the
+  # currently active prices. Read them via LearndashCourse#prices.
+  class CourseFeeHistory < ActiveRecord::Base
+    belongs_to :learndash_course, class_name: 'Effective::LearndashCourse'
+
+    log_changes(to: :learndash_course) if respond_to?(:log_changes)
+
+    effective_resource do
+      start_on      :date
+      end_on        :date
+
+      regular_fee   :integer      # Price to applicants or new users
+      member_fee    :integer      # Price to existing members
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:learndash_course) }
+    scope :sorted, -> { order(start_on: :desc) }
+
+    validates :start_on, presence: true
+    validates :end_on, comparison: { greater_than: :start_on }, allow_nil: true
+
+    # Price presence used to be validated on the course; it moved here with the prices.
+    with_options(if: -> { learndash_course&.can_register? }) do
+      validates :regular_fee, presence: true
+      validates :member_fee, presence: true
+    end
+
+    def to_s
+      "#{learndash_course} Fees #{start_on&.year}#{" - #{end_on.year}" if end_on.present?}"
+    end
+
+    # Schedule next year's prices: close the current (open-ended) prices at the end of this
+    # year and open a copy for next year, ready to have its new prices set.
+    def duplicate!
+      transaction do
+        copy = dup
+        copy.assign_attributes(start_on: (Time.zone.now + 1.year).beginning_of_year, end_on: nil)
+        copy.save!
+
+        update!(end_on: Time.zone.now.end_of_year)
+      end
+    end
+  end
+end

data/app/models/effective/learndash_course.rb

@@ -3,6 +3,10 @@ module Effective
     has_many :learndash_enrollments
     has_many :learndash_users, through: :learndash_enrollments
 
+    # Dated prices. The open-ended (end_on: nil) history holds the current prices. Read via #prices.
+    has_many :course_fee_histories, -> { order(start_on: :desc) },
+      class_name: 'Effective::CourseFeeHistory', dependent: :destroy
+
     log_changes if respond_to?(:log_changes)
 
     # rich_text_body - Used by the select step
@@ -31,9 +35,10 @@ module Effective
       # For course purchases
       can_register           :boolean
 
-      # Pricing
-      regular_price         :integer
-      member_price          :integer
+      # Pricing now lives on dated course_fee_histories, read via #prices / #regular_price /
+      # #member_price. These columns still exist in the database (a later migration drops them).
+      # regular_price       :integer
+      # member_price        :integer
 
       qb_item_name          :string
       tax_exempt            :boolean
@@ -80,10 +85,7 @@ module Effective
     validates :status, presence: true
     validates :title, presence: true
 
-    with_options(if: -> { can_register? }) do
-      validates :regular_price, presence: true
-      validates :member_price, presence: true
-    end
+    # Price presence now lives on CourseFeeHistory (validated when can_register?).
 
     # Syncs all courses
     def self.refresh!
@@ -110,5 +112,57 @@ module Effective
       false
     end
 
+    # The CourseFeeHistory (price list) in effect on the given date — today by default.
+    # Prices used to live in flat columns here; read them off this record now:
+    #
+    #   course.prices.regular_fee                 # price right now
+    #   course.prices(date: date).member_fee      # price in effect on date
+    #
+    # Raises if no history covers the date so misconfiguration surfaces loudly.
+    def prices(date: nil)
+      date = (date || Time.zone.now).to_date
+
+      # course_fee_histories is ordered start_on desc — pick the newest window covering the
+      # date. end_on nil makes an endless range (start_on..), i.e. the current prices.
+      course_fee_histories.find { |history| (history.start_on..history.end_on).cover?(date) } ||
+        raise("No course_fee_history prices available for #{self} on #{date.strftime('%F')}, add a course fee history covering that date")
+    end
+
+    # Backwards-compatible readers so existing call sites keep working after prices moved to
+    # dated histories. These override the retired flat columns.
+    def regular_price(date: nil)
+      prices(date: date).regular_fee
+    end
+
+    def member_price(date: nil)
+      prices(date: date).member_fee
+    end
+
+    # Non-blocking warnings about the price timeline, shown on the admin edit screen. Prices
+    # should form one continuous timeline with a single open-ended (current) history.
+    def course_fee_histories_warnings
+      histories = course_fee_histories.sort_by(&:start_on)
+      return ['No prices have been set — add a course fee history.'] if histories.empty?
+
+      warnings = []
+
+      current = histories.select { |history| history.end_on.blank? }
+      warnings << 'There are no current prices — the most recent history should have no end date.' if current.empty?
+      warnings << 'There is more than one current history (more than one with no end date).' if current.size > 1
+
+      # Each history should pick up the day after the previous one ends — no gaps, no overlaps.
+      histories.each_cons(2) do |earlier, later|
+        next if earlier.end_on.blank? # an open-ended history in the middle is flagged above
+
+        if later.start_on > earlier.end_on + 1.day
+          warnings << "Gap in prices between #{earlier.end_on} and #{later.start_on}."
+        elsif later.start_on <= earlier.end_on
+          warnings << "Overlapping prices around #{later.start_on}."
+        end
+      end
+
+      warnings
+    end
+
   end
 end

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

@@ -0,0 +1,25 @@
+= effective_form_with(model: [:admin, course_fee_history], engine: true) do |f|
+  - course = course_fee_history.learndash_course
+
+  - if course.present?
+    = f.hidden_field :learndash_course_id
+    = f.static_field :learndash_course, label: 'Course' do
+      = course.to_s
+  - else
+    = f.select :learndash_course_id, Effective::LearndashCourse.sorted, label: 'Course'
+
+  %p These prices take effect on the start date, and apply until the next history begins. Leave the end date blank for the current, ongoing prices.
+
+  .row
+    .col-lg-4= f.date_field :start_on
+    -# date_linked: false stops effective_bootstrap auto-filling end_on from start_on — blank means ongoing.
+    .col-lg-4= f.date_field :end_on, date_linked: false, hint: 'leave blank for the current, ongoing prices'
+
+  %h2 Pricing
+  %p Charge the following amounts during course registration. Enter $0 for free.
+
+  .row
+    .col-lg-4= f.price_field :regular_fee, label: 'Price to applicants or new users'
+    .col-lg-4= f.price_field :member_fee, label: 'Price to existing members'
+
+  = effective_submit(f)

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

@@ -3,6 +3,16 @@
     = render 'admin/learndash_courses/form_learndash_course', learndash_course: learndash_course
 
   - if learndash_course.persisted?
+    = tab 'Pricing' do
+      %h2 Pricing
+      %p Prices are kept in date-ranged histories so they can be scheduled to change over time. The history with no end date holds the current, ongoing prices.
+
+      - learndash_course.course_fee_histories_warnings.each do |warning|
+        .alert.alert-warning= warning
+
+      - datatable = Admin::CourseFeeHistoriesDatatable.new(learndash_course: learndash_course)
+      = render_inline_datatable(datatable)
+
     = tab 'Enrollments' do
       %h2 Enrollments
       %p Click the New button from the below table to enroll a user into this course.

data/app/views/admin/learndash_courses/_form_learndash_course.html.haml

@@ -15,14 +15,10 @@
 
   = f.show_if :can_register, true do
     = card('Pricing Information') do
-      %p.text-muted
-        Charge the following amounts during course registration. Enter $0 for free.
-
-      .row
-        .col-lg-3= f.price_field :regular_price, label: 'Price to applicants or new users'
-
-      .row
-        .col-lg-3= f.price_field :member_price, label: 'Price to existing members'
+      - if f.object.persisted?
+        %p.text-muted Prices are set on dated histories — see the Pricing tab.
+      - else
+        %p.text-muted Save this course, then set its prices on the Pricing tab.
 
       = f.check_box :tax_exempt
 

data/config/routes.rb

@@ -31,6 +31,10 @@ EffectiveLearndash::Engine.routes.draw do
       get :refresh, on: :collection
     end
 
+    resources :course_fee_histories, except: [:show] do
+      post :duplicate, on: :member
+    end
+
     resources :course_registrants, only: [:index]
     resources :course_registrations, only: [:index, :show]
   end

data/db/migrate/101_create_effective_learndash.rb

@@ -31,8 +31,7 @@ class CreateEffectiveLearndash < ActiveRecord::Migration[6.0]
       # Course Purchases
       t.boolean :can_register, default: false
 
-      t.integer :regular_price
-      t.integer :member_price
+      # Prices live on dated course_fee_histories (see below), not flat columns.
 
       t.string :qb_item_name
       t.boolean :tax_exempt, default: false
@@ -40,6 +39,23 @@ class CreateEffectiveLearndash < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
+    # Dated prices for a learndash course. The open-ended (end_on: nil) row holds the
+    # current, ongoing prices; earlier rows are scheduled/expired price lists.
+    create_table :course_fee_histories do |t|
+      t.integer :learndash_course_id
+
+      t.date :start_on
+      t.date :end_on
+
+      t.integer :regular_fee
+      t.integer :member_fee
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    add_index :course_fee_histories, :learndash_course_id
+
     create_table :learndash_enrollments do |t|
       t.integer :owner_id
       t.string :owner_type

data/lib/effective_learndash/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLearndash
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_learndash
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2026-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -179,12 +179,14 @@ files:
 - app/assets/javascripts/effective_learndash/base.js
 - app/assets/stylesheets/effective_learndash.scss
 - app/assets/stylesheets/effective_learndash/base.scss
+- app/controllers/admin/course_fee_histories_controller.rb
 - app/controllers/admin/course_registrations_controller.rb
 - app/controllers/admin/learndash_courses_controller.rb
 - app/controllers/admin/learndash_enrollments_controller.rb
 - app/controllers/admin/learndash_users_controller.rb
 - app/controllers/effective/course_registrations_controller.rb
 - app/controllers/effective/learndash_courses_controller.rb
+- app/datatables/admin/course_fee_histories_datatable.rb
 - app/datatables/admin/effective_course_registrations_datatable.rb
 - app/datatables/admin/effective_learndash_courses_datatable.rb
 - app/datatables/admin/effective_learndash_enrollments_datatable.rb
@@ -196,12 +198,14 @@ files:
 - app/helpers/effective_learndash_helper.rb
 - app/models/concerns/effective_learndash_course_registration.rb
 - app/models/concerns/effective_learndash_owner.rb
+- app/models/effective/course_fee_history.rb
 - app/models/effective/course_registrant.rb
 - app/models/effective/course_registration.rb
 - app/models/effective/learndash_api.rb
 - app/models/effective/learndash_course.rb
 - app/models/effective/learndash_enrollment.rb
 - app/models/effective/learndash_user.rb
+- app/views/admin/course_fee_histories/_form.html.haml
 - app/views/admin/learndash_courses/_form.html.haml
 - app/views/admin/learndash_courses/_form_course_registration_content.html.haml
 - app/views/admin/learndash_courses/_form_learndash_course.html.haml