effective_learndash 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6ad48916b87f1ca03d045781ddacfc02686179ebe59d61c952f71bcfd453b2b
-  data.tar.gz: 844ec61521d4b99f35d0e4f98318ea4e78890d386883cd26521eaefb856a28f3
+  metadata.gz: 87e52e6957936bdcd5edc9debdad8e631d22e37d3077506eca3ca26c8d5eba1a
+  data.tar.gz: cf4eb36b9850f5e6e9534dbe09aae83872029d0ff08d8ee1d94ff14eab486b1d
 SHA512:
-  metadata.gz: 14bea235c4f8b191060272b153faa4a82a697b69c27d6b692c788cd9f7dcfc9a36da9f428b06bf732f7ce041048eb4d35006e525054f4b3f36063f4c7c2a6c0b
-  data.tar.gz: 559a17a64a6418df74835211a26b03f7634d21820b096bfe95c82681ca307778b576ddf76e59084f15006495eeea070fdd165f9831d7a57df4fae218f79fc97f
+  metadata.gz: 34d1b92f818ef50b710af71865c50ef0e5fbd0ded41a6f65f0eaaf8cc3eb344b580bae3b477b8b9d131a781b81a4e0b03577869fc55f49b2818e064770a456f8
+  data.tar.gz: ef13112da1f237ff71fb734cdc10e42061464706d85bf4a01a7dc4fa24a4fc7ccb340d05d08a5e9bd8722fb0bc4fd773d6a74fbdf39dbc873e58b912142bfac6

data/app/datatables/admin/effective_learndash_enrollments_datatable.rb

@@ -14,9 +14,9 @@ module Admin
         time_ago_in_words(enrollment.last_synced_at) + ' ago'
       end
 
-      col :owner
-      col :learndash_course
+      col :owner, visible: attributes[:learndash_user_id].blank?
       col :learndash_user
+      col :learndash_course
 
       col :progress_status
 

data/app/datatables/{effective_learndash_courses_datatable.rb → effective_learndash_available_courses_datatable.rb}

@@ -1,11 +1,5 @@
-# Dashboard Courses
-class EffectiveLearndashCoursesDatatable < Effective::Datatable
-  filters do
-    # Registerable should be first here, so when displayed as a simple datatable on the dashboard they only see registerable courses
-    scope :registerable
-    scope :all
-  end
-
+# Dashboard Available Courses
+class EffectiveLearndashAvailableCoursesDatatable < Effective::Datatable
   datatable do
     order :title
     col :id, visible: false
@@ -24,7 +18,10 @@ class EffectiveLearndashCoursesDatatable < Effective::Datatable
   end
 
   collection do
-    Effective::LearndashCourse.deep.learndash_courses(user: current_user)
+    enrolled = Effective::LearndashEnrollment.where(learndash_user: current_user.learndash_user).select(:learndash_course_id)
+    courses = Effective::LearndashCourse.deep.registerable.learndash_courses(user: current_user)
+
+    courses.where.not(id: enrolled)
   end
 
 end

data/app/models/concerns/effective_learndash_owner.rb

@@ -43,6 +43,22 @@ module EffectiveLearndashOwner
     learndash_users.first
   end
 
+  def in_progress_learndash_enrollments
+    learndash_enrollments.reject(&:completed?).sort_by(&:created_at)
+  end
+
+  def completed_learndash_enrollments
+    learndash_enrollments.select(&:completed?).sort_by(&:date_completed)
+  end
+
+  def completed_learndash_courses
+    learndash_enrollments.select(&:completed?).map(&:course).sort_by(&:id)
+  end
+
+  def learndash_enrolled_courses
+    learndash_enrollments.map { |enrollment| enrollment.learndash_course }
+  end
+
   # Find or create
   def create_learndash_user
     learndash_user || learndash_users.create!(owner: self)
@@ -67,11 +83,48 @@ module EffectiveLearndashOwner
     return false if enrollment.blank?
 
     # Return completed right away if previously marked completed
-    return true if enrollment.completed?
-
-    # Check the API
-    enrollment.refresh!
     enrollment.completed?
+
+    # DO NOT check API
+  end
+
+  def learndash_enroll!(courses:)
+    courses = Array(courses)
+
+    # Find or create the user
+    create_learndash_user
+    raise('expected a persisted learndash user') unless learndash_user&.persisted?
+
+    courses.each do |course|
+      # Find or Enroll in the course
+      create_learndash_enrollment(course: course)
+      raise('expected a persisted learndash enrollment') unless learndash_enrollment(course: course)&.persisted?
+    end
+
+    # This syncs the learndash enrollment locally
+    learndash_enrollments.select { |enrollment| courses.include?(enrollment.learndash_course) }.each do |enrollment|
+      enrollment.refresh! unless enrollment.completed?
+    end
+
+    save!
+
+    after_learndash_enroll() if respond_to?(:after_learndash_enroll)
+
+    true
+  end
+
+  def learndash_refresh!(force: false)
+    raise('expected a previously persisted learndash user') if learndash_user.blank?
+
+    learndash_enrollments.each do |enrollment|
+      enrollment.refresh!(force: force) unless (force || enrollment.completed?)
+    end
+
+    save!
+
+    after_learndash_refresh() if respond_to?(:after_learndash_refresh)
+
+    true
   end
 
 end

data/app/models/effective/learndash_enrollment.rb

@@ -8,7 +8,9 @@ module Effective
 
     log_changes(to: :learndash_course, except: [:last_synced_at]) if respond_to?(:log_changes)
 
-    PROGRESS_STATUSES = ['not-started', 'in-progress', 'completed']
+    # Only admin can mark finished
+    # Finished is treated as an admin override for completed?
+    PROGRESS_STATUSES = ['not-started', 'in-progress', 'completed', 'finished']
 
     effective_resource do
       last_synced_at      :string
@@ -26,7 +28,7 @@ module Effective
       timestamps
     end
 
-    scope :completed, -> { where(progress_status: 'completed') }
+    scope :completed, -> { where(progress_status: ['completed', 'finished']) }
     scope :in_progress, -> { where(progress_status: 'in-progress') }
     scope :not_started, -> { where(progress_status: 'not-started') }
 
@@ -61,8 +63,35 @@ module Effective
       progress_status == 'in-progress'
     end
 
+    # Admin override to completed
+    def finished?
+      progress_status == 'finished'
+    end
+
+    # Checked to see if the course is done throughout
     def completed?
-      progress_status == 'completed'
+      progress_status == 'completed' || finished?
+    end
+
+    def completed_on
+      date_completed || (created_at if finished?)
+    end
+
+    def mark_as_finished!
+      update!(progress_status: 'finished')
+    end
+
+    # Guess old status
+    def unfinish!
+      if date_completed.present?
+        assign_attributes(progress_status: 'completed')
+      elsif date_started.present?
+        assign_attributes(progress_status: 'in-progress')
+      else
+        assign_attributes(progress_status: 'not-started')
+      end
+
+      save!
     end
 
     def refresh!(force: false)
@@ -75,17 +104,22 @@ module Effective
     end
 
     def assign_api_attributes(data = nil)
+      return if EffectiveLearndash.disabled?
+
       data ||= EffectiveLearndash.api.find_enrollment(self) || EffectiveLearndash.api.create_enrollment(self)
 
       assign_attributes(
         last_synced_at: Time.zone.now,
-        progress_status: data[:progress_status],
         last_step: data[:last_step],
         steps_completed: data[:steps_completed],
         steps_total: data[:steps_total],
         date_started: Time.use_zone('UTC') { Time.zone.parse(data[:date_started]) },
         date_completed: (Time.use_zone('UTC') { Time.zone.parse(data[:date_completed]) } if data[:date_completed].present?)
       )
+
+      assign_attributes(progress_status: data[:progress_status]) unless finished?
+
+      true
     end
 
   end

data/app/models/effective/learndash_user.rb

@@ -83,6 +83,8 @@ module Effective
 
     # This synchronizes all the course enrollments from the API down locally.
     def assign_api_course_enrollments
+      return if EffectiveLearndash.disabled?
+
       raise('must be persisted') unless persisted?
 
       courses = LearndashCourse.all()

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

@@ -8,6 +8,7 @@
       %p Click the New button from the below table to enroll a user into this course.
       %p Enrolling a user here will enroll them on the LearnDash site.
       %p Alternately, if this course is available for registration, the enrollment will be created upon registration purchase.
+      %p Marking the course finished will allow them to proceed without completing the course on the Learndash LMS.
 
       - datatable = Admin::EffectiveLearndashEnrollmentsDatatable.new(learndash_course: learndash_course)
       = render_datatable(datatable, inline: true)

data/app/views/admin/learndash_users/_learndash_user.html.haml

@@ -3,7 +3,7 @@
     = link_to(learndash_user.owner, "/admin/users/#{learndash_user.owner.to_param}/edit")
     has an existing account on LearnDash.
 
-  %p= link_to "LearnDash LMS User Admin", EffectiveLearndash.learndash_url.chomp('/') + "/wp-admin/user-edit.php?user_id=#{learndash_user.user_id}", target: '_blank'
+  %p= link_to "LearnDash LMS User Admin", EffectiveLearndash.learndash_url.to_s.chomp('/') + "/wp-admin/user-edit.php?user_id=#{learndash_user.user_id}", target: '_blank'
 
   %ul
     %li Email: #{learndash_user.email}
@@ -21,7 +21,10 @@
 
 %h3 LearnDash Course Enrollments
 
-%p Click the New button from the below table to manually enroll this user into a new course.
+%p 
+  Click the New button from the below table to manually enroll this user into a new course.
+  %br
+  %small.text-muted Marking the course finished will allow them to proceed without completing the course on the Learndash LMS.
 
 - datatable = Admin::EffectiveLearndashEnrollmentsDatatable.new(learndash_user: learndash_user)
 = render_datatable(datatable, inline: true)

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

@@ -1,13 +1,14 @@
 - learndash_user = current_user.try(:learndash_user)
-- authorized = learndash_user && EffectiveResources.authorized?(self, :show, learndash_user)
+- authorized_user = learndash_user && EffectiveResources.authorized?(self, :show, learndash_user)
+- authorized_registration = EffectiveResources.authorized?(self, :new, EffectiveLearndash.CourseRegistration)
 
 %h2 Courses
 
 - if learndash_user.blank?
   %p You do not have an account to access courses. When you are enrolled in a course, your account credentials will be displayed here.
 
-- if learndash_user.present? && authorized
-  - learndash_user.refresh!
+- if learndash_user.present? && authorized_user
+  - learndash_user.refresh! unless EffectiveLearndash.disabled?
 
   %p Your course account credentials are:
 
@@ -22,8 +23,15 @@
   %p= link_to('Sign in to your course account', EffectiveLearndash.learndash_url, target: '_blank', class: 'btn btn-primary')
 
   - if learndash_user.learndash_enrollments.present?
+    %p You are enrolled in the following courses:
     - datatable = EffectiveResources.best('EffectiveLearndashEnrollmentsDatatable').new(self)
     = render_datatable(datatable, simple: true)
 
   - else
     %p You are not enrolled in any courses.
+
+- available = EffectiveResources.best('EffectiveLearndashAvailableCoursesDatatable').new(self)
+
+- if available.present? && authorized_registration
+  %p The following courses are available for registration:
+  = render_datatable(available, simple: true)

data/config/routes.rb

@@ -23,6 +23,8 @@ EffectiveLearndash::Engine.routes.draw do
 
     resources :learndash_enrollments, only: [:index, :new, :create, :update] do
       post :refresh, on: :member
+      post :mark_as_finished, on: :member
+      post :unfinish, on: :member
     end
 
     resources :learndash_courses, only: [:index, :edit, :update] do

data/lib/effective_learndash/version.rb

@@ -1,3 +1,3 @@
 module EffectiveLearndash
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.1'.freeze
 end

data/lib/effective_learndash.rb

@@ -18,7 +18,13 @@ module EffectiveLearndash
 
   include EffectiveGem
 
+  def self.disabled?
+    learndash_url.blank?
+  end
+
   def self.api
+    return if disabled?
+
     raise('please set learndash_url in config/initializers/effective_learndash.rb') unless learndash_url.present?
     raise('please set learndash_username in config/initializers/effective_learndash.rb') unless learndash_username.present?
     raise('please set learndash_password in config/initializers/effective_learndash.rb') unless learndash_password.present?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_learndash
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-24 00:00:00.000000000 Z
+date: 2023-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -191,7 +191,7 @@ files:
 - app/datatables/admin/effective_learndash_users_datatable.rb
 - app/datatables/effective_course_registrants_datatable.rb
 - app/datatables/effective_course_registrations_datatable.rb
-- app/datatables/effective_learndash_courses_datatable.rb
+- app/datatables/effective_learndash_available_courses_datatable.rb
 - app/datatables/effective_learndash_enrollments_datatable.rb
 - app/helpers/effective_learndash_helper.rb
 - app/models/concerns/effective_learndash_course_registration.rb