effective_cpd 0.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03ea8530cc9464864529c2138bc50c557e6673bfe603c506a61536938f088fb2
-  data.tar.gz: 6cc9d5170e3aa9f4ad18b86422f4634a0a1127d1b133a598288f816e544cbcba
+  metadata.gz: c655d5b1c2e948affbfee9558e51b7e66ca5cfd0e43fbf2a58fecc7a3b2d885f
+  data.tar.gz: 06fe0a9add6534d48e5b51055343018c75723fa288f9051666fd29767fab0f86
 SHA512:
-  metadata.gz: d82e2b524bf841a537aecdee7c17a6f29d1ff5d046d7af4a42d7cb05e19c39ed7c23d9886f5603dbfca389eecd144846cbb49ccc83ce182143c0961b804b2ddb
-  data.tar.gz: 60f571e5289e2376eeefe5b465ad1f11685cfb6718269c121ba45b69408a8f2f94b73f216191e16ab8f669f33c3369f256ce12611e08d4943ad101d2000b2387
+  metadata.gz: bd95fa02fad56e41914ac568da4cdaf0b2413297a35fbccf4d8c32659d1e2e30c0e474871d33f124a03f7c962372a9136149cd587a520c6c41447e269692901a
+  data.tar.gz: 212aaa715dcee4635d708a579fad03e18bdfd8b253515d2a3b3b2dcaf1419eb7237766c68260d83992c6520d802fc128ebd355537b820578ea823b9362101661

data/README.md

@@ -134,6 +134,39 @@ As an admin, visit the CPD Categories, then CPD Cycles, and CPD Audit levels.
 
 Once all these 3 areas have been configured, users can submit statements and audits can be performed.
 
+## Required Score
+
+You can specify the required score in the CPD Cycle.
+
+You can also programatically do it. Add the following to your user class.
+
+```
+# This is an ActiveRecord concern to add the has_many :cpd_statements
+effective_cpd_user
+
+# We require 100 points in the last 3 years.
+def cpd_statement_required_score(cpd_statement)
+  # We always consider the 3 year window, of the passed cpd_statement and the last two statements
+  last_two_statements = cpd_statements.select do |statement|
+    statement.completed? && statement.cpd_cycle_id < cpd_statement.cpd_cycle_id
+  end.last(2)
+
+  # They can submit 0 0 100
+  return 0 if last_two_statements.length < 2
+
+  # 100 points in the last 3 years.
+  required_score = 100
+
+  # Score so far
+  existing_score = last_two_statements.sum { |statement| statement.score }
+  raise('expected existing_score to be >= 0') if existing_score < 0
+
+  # Required score minus previous
+  return 0 if existing_score >= required_score
+  (required_score - existing_score)
+end
+```
+
 ## Authorization
 
 All authorization checks are handled via the effective_resources gem found in the `config/initializers/effective_resources.rb` file.

data/app/assets/javascripts/effective_cpd/activities.js

@@ -44,6 +44,12 @@ $(document).on('click', '[data-cpd-edit-activity]', function(event) {
   $activity.children('.statement-activity-form').show()
 });
 
+// When we click any x button
+$(document).on('click', '[data-cpd-collapse]', function(event) {
+  event.preventDefault()
+  collapse_effective_cpd_activities()
+});
+
 // Initializers
 $(document).ready(function() { initialize_effective_cpd_activities() });
 $(document).on('turbolinks:load', function() { initialize_effective_cpd_activities() });

data/app/controllers/admin/cpd_special_rules_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class CpdSpecialRulesController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_cpd) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_cpd_special_rule).permit!
+    end
+
+  end
+end

data/app/datatables/admin/effective_cpd_special_rules_datatable.rb

@@ -0,0 +1,23 @@
+module Admin
+  class EffectiveCpdSpecialRulesDatatable < Effective::Datatable
+    datatable do
+      col :id, visible: false
+      col :created_at, visible: false
+      col :updated_at, visible: false
+
+      col :cpd_cycle, label: cpd_cycle_label.titleize
+
+      col :cpd_rules
+
+      col :category
+      col :max_credits_per_cycle, label: 'Max ' + cpd_credits_label.titleize
+
+      actions_col
+    end
+
+    collection do
+      cpd_cycle = Effective::CpdCycle.find(attributes[:cpd_cycle_id])
+      Effective::CpdSpecialRule.all.deep.where(cpd_cycle: cpd_cycle)
+    end
+  end
+end

data/app/helpers/effective_cpd_helper.rb

@@ -30,6 +30,16 @@ module EffectiveCpdHelper
     end
   end
 
+  def cpd_statement_submit_label(cpd_statement)
+    label = "Yes, I understand I will not be able to submit more #{cpd_credits_label} or modify any of my activities for this #{cpd_cycle_label}, once I submit."
+
+    if (end_at = cpd_statement.cpd_cycle.end_at).present?
+      label += " The last date to submit this form is #{end_at.strftime("%B %d, %Y")}."
+    end
+
+    label
+  end
+
   def effective_cpd_categories
     @effective_cpd_categories ||= Effective::CpdCategory.deep.sorted
   end

data/app/models/concerns/effective_cpd_user.rb

@@ -0,0 +1,29 @@
+# EffectiveCpdUser
+#
+# Mark your user model with effective_cpd_user to get a few helpers
+# And user specific point required scores
+
+module EffectiveCpdUser
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_cpd_user
+      include ::EffectiveCpdUser
+    end
+  end
+
+  included do
+    has_many :cpd_statements, -> { Effective::CpdStatement.sorted }, class_name: 'Effective::CpdStatement'
+    has_many :cpd_audits, -> { Effective::CpdAudit.sorted }, inverse_of: :user, class_name: 'Effective::CpdAudit'
+    has_many :cpd_audit_reviews, -> { Effective::CpdAuditReview.sorted }, inverse_of: :user, class_name: 'Effective::CpdAuditReview'
+  end
+
+  def cpd_statement_required_score(cpd_statement)
+    nil
+  end
+
+  module ClassMethods
+    def effective_cpd_user?; true; end
+  end
+
+end

data/app/models/effective/cpd_cycle.rb

@@ -1,6 +1,7 @@
 module Effective
   class CpdCycle < ActiveRecord::Base
     has_rich_text :all_steps_content    # Update build_from_cycle() below if these change
+    has_rich_text :sidebar_content
     has_rich_text :start_content
     has_rich_text :activities_content
     has_rich_text :agreements_content
@@ -10,6 +11,9 @@ module Effective
     has_many :cpd_rules, dependent: :delete_all
     accepts_nested_attributes_for :cpd_rules, allow_destroy: true
 
+    has_many :cpd_special_rules, dependent: :delete_all
+    accepts_nested_attributes_for :cpd_special_rules, allow_destroy: true
+
     has_many :cpd_statements
 
     if respond_to?(:log_changes)
@@ -29,6 +33,7 @@ module Effective
 
     scope :deep, -> {
       with_rich_text_all_steps_content
+      .with_rich_text_sidebar_content
       .with_rich_text_start_content
       .with_rich_text_activities_content
       .with_rich_text_submit_content
@@ -76,13 +81,26 @@ module Effective
       attributes = cycle.dup.attributes.except('title', 'token', 'start_at', 'end_at')
       assign_attributes(attributes)
 
-      [:all_steps_content, :start_content, :activities_content, :submit_content, :complete_content].each do |rich_text|
+      [:all_steps_content, :sidebar_content, :start_content, :activities_content, :submit_content, :complete_content].each do |rich_text|
         self.send("#{rich_text}=", cycle.send(rich_text))
       end
 
       cycle.cpd_rules.each do |rule|
         attributes = rule.dup.attributes.except('cpd_cycle_id')
-        self.cpd_rules.build(attributes)
+        cpd_rule = self.cpd_rules.build(attributes)
+
+        if rule.category?
+          cpd_rule.category_credit_description = rule.category_credit_description
+        end
+      end
+
+      cycle.cpd_special_rules.each do |special_rule|
+        attributes = special_rule.dup.attributes.except('cpd_cycle_id')
+        cpd_special_rule = self.cpd_special_rules.build(attributes)
+
+        special_rule.ruleables.each do |ruleable|
+          cpd_special_rule.cpd_special_rule_mates.build(cpd_rule: self.rule_for(ruleable))
+        end
       end
 
       self

data/app/models/effective/cpd_rule.rb

@@ -3,6 +3,12 @@ module Effective
     belongs_to :cpd_cycle
     belongs_to :ruleable, polymorphic: true # Activity or Category
 
+    # For a Category: A maximum of 35 PDHs/year may be claimed in the Contributions to Knowledge category
+    has_rich_text :category_credit_description
+
+    has_many :cpd_special_rule_mates, dependent: :destroy, inverse_of: :cpd_rule
+    has_many :cpd_special_rules, -> { CpdSpecialRule.sorted }, through: :cpd_special_rule_mates
+
     if respond_to?(:log_changes)
       log_changes(to: :cpd_cycle)
     end
@@ -12,7 +18,6 @@ module Effective
 
     effective_resource do
       # A plaintext description of the formula
-      # For a Category: A maximum of 35 PDHs/year may be claimed in the Contributions to Knowledge category
       # For a Activity: 15 hours of work equals 1 credit
       credit_description :text
 
@@ -23,6 +28,7 @@ module Effective
       formula   :string
 
       # Maximum number of cycles can carry forward
+      # Only considered for activities
       max_cycles_can_carry_forward  :integer
 
       # Cannot be entered in this cycle
@@ -31,19 +37,22 @@ module Effective
       timestamps
     end
 
-    scope :deep, -> { includes(:cpd_cycle, :ruleable) }
+    scope :sorted, -> { order(:id) }
+    scope :deep, -> { with_rich_text_category_credit_description.includes(:cpd_cycle, :ruleable) }
     scope :categories, -> { where(ruleable_type: 'Effective::CpdCategory') }
     scope :activities, -> { where(ruleable_type: 'Effective::CpdActivity') }
     scope :unavailable, -> { where(unavailable: true) }
 
     #validates :cpd_cycle_id, uniqueness: { scope: [:ruleable_id, :ruleable_type] }
-    validates :credit_description, presence: true
     validates :max_credits_per_cycle, numericality: { greater_than: 0, allow_nil: true }
-    validates :max_cycles_can_carry_forward, numericality: { greater_than: 0, allow_nil: true }
+    validates :max_cycles_can_carry_forward, numericality: { greater_than_or_equal_to: 0, allow_nil: true }
 
     validates :formula, presence: true, if: -> { activity? }
     validates :formula, absence: true, if: -> { category? }
 
+    validates :credit_description, presence: true, if: -> { activity? }
+    validates :category_credit_description, presence: true, if: -> { category? }
+
     validate(if: -> { formula.present? }) do
       if formula.gsub('amount2', '').gsub('amount', '').gsub(' ', '').match(INVALID_FORMULA_CHARS).present?
         self.errors.add(:formula, "may only contain amount, amount2 and 0-9 + - / * ( ) characters")
@@ -79,7 +88,13 @@ module Effective
     end
 
     def to_s
-      formula.presence || 'category'
+      if activity?
+        formula.presence || ruleable.to_s.presence || 'activity rule'
+      elsif category?
+        ruleable.to_s.presence || 'category rule'
+      else
+        'new rule'
+      end
     end
 
     def activity?

data/app/models/effective/cpd_scorer.rb

@@ -78,7 +78,7 @@ module Effective
         end
       end
 
-      # This enforced CycleCategory.max_credits_per_cycle
+      # This enforces CycleCategory.max_credits_per_cycle
       statement.cpd_statement_activities.group_by(&:cpd_category).each do |cpd_category, activities|
         rule = cycle.rule_for(cpd_category)
         max_credits_per_cycle = rule.max_credits_per_cycle
@@ -98,6 +98,28 @@ module Effective
         end
       end
 
+      # This enforces cumulative max credits CpdSpecialRule.max_credits_per_cycle special rules
+      cycle.cpd_special_rules.select(&:cumulative_max_credits?).each do |special_rule|
+        cpd_categories = special_rule.ruleables.select { |obj| obj.kind_of?(Effective::CpdCategory) }
+
+        max_credits_per_cycle = special_rule.max_credits_per_cycle
+        raise('expected max credits per cycle to be present') unless max_credits_per_cycle.to_i > 0
+
+        activities = statement.cpd_statement_activities.select { |sa| cpd_categories.include?(sa.cpd_category) }
+
+        activities.each do |activity|
+          next if activity.marked_for_destruction?
+
+          max_credits_per_cycle -= activity.score   # We're already scored. Counting down...
+
+          if max_credits_per_cycle < 0
+            activity.score = [activity.score + max_credits_per_cycle, 0].max
+            activity.carry_forward = activity.max_score - activity.score
+            activity.reduced_messages["category_#{activity.cpd_category_id}"] = "You have reached the cumulative maximum of #{special_rule.max_credits_per_cycle}/#{cpd_cycle_label} for activities in the #{cpd_categories.map(&:to_s).to_sentence} categories"
+          end
+        end
+      end
+
       # This enforces the max_cycles_can_carry_forward logic
       # If an Activity cannot be carried forward another cycle, its carry_forward should be 0
       next_cycle = @cycles[@cycles.index(cycle) + 1]

data/app/models/effective/cpd_special_rule.rb

@@ -0,0 +1,54 @@
+module Effective
+  class CpdSpecialRule < ActiveRecord::Base
+    belongs_to :cpd_cycle
+
+    has_many :cpd_special_rule_mates, dependent: :destroy, inverse_of: :cpd_special_rule
+    has_many :cpd_rules, -> { CpdRule.sorted }, through: :cpd_special_rule_mates
+
+    if respond_to?(:log_changes)
+      log_changes
+    end
+
+    CATEGORIES = ['cumulative max credits']
+
+    effective_resource do
+      category  :string # Special rule tyoes
+
+      # For cumulative max credits
+      max_credits_per_cycle :integer
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:cpd_special_rule_mates, cpd_rules: [:ruleable]) }
+    scope :sorted, -> { order(:id) }
+
+    before_validation do
+      self.category ||= CATEGORIES.first
+    end
+
+    validates :category, presence: true, inclusion: { in: CATEGORIES }
+
+    with_options(if: -> { cumulative_max_credits? }) do
+      validates :max_credits_per_cycle, presence: true, numericality: { greater_than: 0 }
+    end
+
+    def to_s
+      if cumulative_max_credits?
+        "Cumulative max #{max_credits_per_cycle} credits"
+      else
+        'cpd special rule'
+      end
+    end
+
+    def cumulative_max_credits?
+      category == 'cumulative max credits'
+    end
+
+    # Right now this is going to be just Effective::CpdCategory objects
+    def ruleables
+      cpd_rules.map(&:ruleable)
+    end
+
+  end
+end

data/app/models/effective/cpd_special_rule_mate.rb

@@ -0,0 +1,6 @@
+module Effective
+  class CpdSpecialRuleMate < ActiveRecord::Base
+    belongs_to :cpd_rule
+    belongs_to :cpd_special_rule
+  end
+end

data/app/models/effective/cpd_statement.rb

@@ -54,9 +54,9 @@ module Effective
       self.score ||= 0
     end
 
-    validate(if: -> { completed? && cpd_cycle.required_score.present? }) do
-      min = cpd_cycle.required_score
-      self.errors.add(:score, "must be #{min} or greater to submit statement") if score < min
+    validate(if: -> { completed? }) do
+      min = required_score()
+      self.errors.add(:score, "must be #{min} or greater to submit a statement") if score < min
     end
 
     with_options(if: -> { current_step == :agreements }) do
@@ -87,6 +87,13 @@ module Effective
       submitted_at.present?
     end
 
+    def required_score
+      required_by_cycle = cpd_cycle&.required_score
+      required_by_user = user.cpd_statement_required_score(self) if user.respond_to?(:cpd_statement_required_score)
+
+      [required_by_cycle.to_i, required_by_user.to_i].max
+    end
+
     def carry_forward
       cpd_statement_activities.sum { |activity| activity.carry_forward.to_i }
     end

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

@@ -3,6 +3,9 @@
     = render 'admin/cpd_cycles/form_cpd_cycle', cpd_cycle: cpd_cycle
 
   - if cpd_cycle.persisted?
+    = tab 'Special Rules' do
+      = render 'admin/cpd_cycles/form_cpd_special_rules', cpd_cycle: cpd_cycle
+
     = tab 'Category and Activity Rules' do
       = tabs do
         - Effective::CpdCategory.deep.sorted.each do |cpd_category|

data/app/views/admin/cpd_cycles/_form_content.html.haml

@@ -1,9 +1,17 @@
 = effective_form_with(model: [:admin, cpd_cycle], engine: true) do |f|
+  %h2 All Steps Content
+
   .card.mb-4
     .card-body
       %h5.card-title All Steps Content
       = f.rich_text_area :all_steps_content, label: false, hint: 'displayed on all statement steps'
 
+  .card.mb-4
+    .card-body
+      %h5.card-title Sidebar Content
+      = f.rich_text_area :sidebar_content, label: false, hint: 'displayed on the sidebar on all statement steps'
+
+  %h2 Individual Steps Content
   .card.mb-4
     .card-body
       %h5.card-title Start Step

data/app/views/admin/cpd_cycles/_form_cpd_rules.html.haml

@@ -6,12 +6,17 @@
   %p= link_to 'Edit Category', edit_path, target: '_blank'
 
   = f.fields_for :cpd_rules, cpd_cycle.rule_for(cpd_category) do |fc|
-    = fc.number_field :max_credits_per_cycle,
-      label: "Max #{cpd_credits_label} per #{cpd_cycle_label}",
-      hint: "The maximum number of #{cpd_credits_label} that may be earned in this category for this #{cpd_cycle_label}. Leave blank for no limit."
-
-    = fc.text_field :credit_description,
-      hint: "A simple description of the maximum #{cpd_credits_label} and carry forward policy of activities for this category"
+    .row
+      .col
+        = fc.number_field :max_credits_per_cycle,
+          label: "Max #{cpd_credits_label} per #{cpd_cycle_label}",
+          hint: "The maximum number of #{cpd_credits_label} that may be earned in this category for this #{cpd_cycle_label}. Leave blank for no limit."
+      .col
+        = fc.select :cpd_special_rule_ids, cpd_cycle.cpd_special_rules, multiple: true,
+          label: 'Special Rules', hint: "Special rules operate on more than one category at a time"
+
+    = fc.rich_text_area :category_credit_description,
+      hint: "A description of the maximum #{cpd_credits_label} and carry forward policy of activities for this category"
 
     = fc.check_box :unavailable, label: "Unavailable in this #{cpd_cycle_label}"
 
@@ -49,7 +54,7 @@
 
           = fa.number_field :max_cycles_can_carry_forward,
             label: "Max #{cpd_cycles_label} can carry forward",
-            hint: "leave blank for no limit"
+            hint: "leave blank for no limit. enter zero for no carry forward."
 
           = fa.check_box :unavailable, label: "Unavailable in this #{cpd_cycle_label}"
 

data/app/views/admin/cpd_cycles/_form_cpd_special_rules.html.haml

@@ -0,0 +1,4 @@
+%p Special rules operate on more than one category at a time.
+
+- datatable = Admin::EffectiveCpdSpecialRulesDatatable.new(cpd_cycle_id: cpd_cycle.id)
+= render_datatable(datatable, inline: true)

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

@@ -0,0 +1,18 @@
+= effective_form_with(model: [:admin, cpd_special_rule], engine: true) do |f|
+  - if inline_datatable?
+    = f.hidden_field :cpd_cycle_id
+  - else
+    = f.select :cpd_cycle_id, Effective::CpdCycle.sorted.all, label: cpd_cycle_label.titleize
+
+  = f.select :category, Effective::CpdSpecialRule::CATEGORIES
+
+  = f.show_if :category, 'cumulative max credits' do
+    = f.number_field :max_credits_per_cycle, label: "Cumulative max credits per #{cpd_cycle_label}",
+      hint: "The cumulative max #{cpd_credits_label} per #{cpd_cycle_label} that can be earned between the following categories."
+
+    - cpd_category_rules = cpd_special_rule.cpd_cycle.cpd_rules.select(&:category?)
+
+    = f.select :cpd_rule_ids, cpd_category_rules, label: 'Cumulative max included categories',
+      hint: "These categories will shared a maximum cumulative #{cpd_credits_label} per #{cpd_cycle_label}."
+
+  = effective_submit(f)

data/app/views/effective/cpd_audits/cpd_audit_level_section.html.haml

@@ -12,7 +12,7 @@
       - cpd_audit_response = resource.cpd_audit_response(cpd_audit_level_question)
 
       = f.fields_for :cpd_audit_responses, cpd_audit_response do |fcar|
-        = render('/effective/cpd_audit_responses/fields', f: fcar, cpd_audit_level_question: cpd_audit_level_question)
+        .mt-2= render('/effective/cpd_audit_responses/fields', f: fcar, cpd_audit_level_question: cpd_audit_level_question)
 
     - if cpd_audit_level_section.bottom_content.present?
       .mb-2= cpd_audit_level_section.bottom_content

data/app/views/effective/cpd_statement_activities/_form.html.haml

@@ -6,6 +6,7 @@
   - activity = cpd_statement_activity.cpd_activity
   - rule = statement.cpd_cycle.rule_for(activity)
 
+  .float-right= link_to icon('x', class: 'small-1'), '#', 'data-cpd-collapse': true
   %h3= activity
 
   - if activity.body.present?

data/app/views/effective/cpd_statements/_activities_new.html.haml

@@ -7,6 +7,8 @@
     - next if rule.unavailable?
 
     = tab(category) do
+      .float-right= link_to icon('x', class: 'small-1'), '#', 'data-cpd-collapse': true
+
       %h3
         #{category}
         %small
@@ -22,6 +24,7 @@
       .mb-3
         %strong #{cpd_credits_label.titleize} Calculation
         %br
+        = rule.category_credit_description
         = rule.credit_description
 
       %div

data/app/views/effective/cpd_statements/_activities_table.html.haml

@@ -50,7 +50,7 @@
 
           .statement-activity-form.row{style: 'display: none;'}
             .col
-              .border.p-3
+              .border.px-3
                 = yield(statement_activity)
 
   %hr

data/app/views/effective/cpd_statements/_layout.html.haml

@@ -22,10 +22,7 @@
             %h4= resource.score.to_i
 
           %td
-            - if cpd_cycle.required_score.to_i > 0
-              #{cpd_credits_label} out of #{cpd_cycle.required_score} required
-            - else
-              #{cpd_credits_label} in current #{cpd_cycle_label}
+            #{cpd_credits_label} out of #{resource.required_score} required
 
         %tr
           %td
@@ -33,5 +30,7 @@
 
           %td #{cpd_credits_label} in last 3 #{cpd_cycles_label} (including this #{cpd_cycle_label})
 
+    = cpd_cycle.sidebar_content
+
   .col-9
     = yield

data/app/views/effective/cpd_statements/submit.html.haml

@@ -14,7 +14,6 @@
   = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
     = f.hidden_field :current_step
 
-    = f.check_box :confirm_readonly,
-      label: 'Yes, I understand that I will not be able to modify this statement after submission'
+    = f.check_box :confirm_readonly, label: cpd_statement_submit_label(f.object)
 
     = f.submit 'Submit Statement', center: true

data/config/effective_cpd.rb

@@ -4,6 +4,8 @@ EffectiveCpd.setup do |config|
 
   config.cpd_cycles_table_name = :cpd_cycles
   config.cpd_rules_table_name = :cpd_rules
+  config.cpd_special_rules_table_name = :cpd_special_rules
+  config.cpd_special_rule_mates_table_name = :cpd_special_rule_mates
 
   config.cpd_statements_table_name = :cpd_statements
   config.cpd_statement_activities_table_name = :cpd_statement_activities

data/config/routes.rb

@@ -32,6 +32,7 @@ EffectiveCpd::Engine.routes.draw do
     resources :cpd_activities, except: [:show]
     resources :cpd_cycles, except: [:show]
     resources :cpd_rules, only: [:index]
+    resources :cpd_special_rules, except: [:show]
 
     resources :cpd_statements, only: [:index, :show]
 

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

@@ -51,6 +51,24 @@ class CreateEffectiveCpd < ActiveRecord::Migration[6.0]
       t.datetime :created_at
     end
 
+    create_table <%= @cpd_special_rules_table_name %> do |t|
+      t.references :cpd_cycle
+
+      t.integer :max_credits_per_cycle
+      t.string :category
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
+    create_table <%= @cpd_special_rule_mates_table_name %> do |t|
+      t.references :cpd_rule
+      t.references :cpd_special_rule
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
     create_table <%= @cpd_statement_activities_table_name %> do |t|
       t.references :cpd_statement
       t.references :cpd_activity

data/db/seeds.rb

@@ -7,9 +7,10 @@ if Rails.env.test?
   Effective::CpdCategory.delete_all
   Effective::CpdActivity.delete_all
   Effective::CpdRule.delete_all
+  Effective::CpdSpecialRule.delete_all
+  Effective::CpdSpecialRuleMate.delete_all
 
   ActionText::RichText.where(record_type: ['Effective::CpdCycle', 'Effective::CpdCycle', 'Effective::CpdActivity', 'Effective::CpdAudit', 'Effective::CpdAuditLevelSection', 'Effective::CpdAuditLevelQuestion']).delete_all
-
 end
 
 # Build the first CpdCycle
@@ -18,11 +19,12 @@ cycle = Effective::CpdCycle.create!(
   start_at: now.beginning_of_year,
   end_at: now.end_of_year,
   required_score: 100,
-  all_steps_content: "<div>All Steps Content</div>",
-  start_content: "<div>Start Content</div>",
-  activities_content: "<div>Activities Content</div>",
-  submit_content: "<div>Submit Content</div>",
-  complete_content: "<div>Complete Content</div>"
+  all_steps_content: "All Steps Content",
+  start_content: "Start Content",
+  activities_content: "Activities Content",
+  submit_content: "Submit Content",
+  complete_content: "Complete Content",
+  sidebar_content: "Sidebar Content"
 )
 
 # Professional Practice
@@ -33,7 +35,7 @@ category = Effective::CpdCategory.create!(
 Effective::CpdRule.create!(
   cpd_cycle: cycle,
   ruleable: category,
-  credit_description: 'Upto a maximum of 20 claimable points per CPD year. Points cannot be carried forward to future years.',
+  category_credit_description: 'Upto a maximum of 20 claimable points per CPD year. Points cannot be carried forward to future years.',
   max_credits_per_cycle: 20
 )
 
@@ -74,7 +76,7 @@ category = Effective::CpdCategory.create!(
 Effective::CpdRule.create!(
   cpd_cycle: cycle,
   ruleable: category,
-  credit_description: 'Upto a maximum of 20 claimable points per CPD year. Points cannot be carried forward to future years.',
+  category_credit_description: 'Upto a maximum of 20 claimable points per CPD year. Points cannot be carried forward to future years.',
   max_credits_per_cycle: 20
 )
 
@@ -144,7 +146,7 @@ category = Effective::CpdCategory.create!(
 Effective::CpdRule.create!(
   cpd_cycle: cycle,
   ruleable: category,
-  credit_description: 'Upto a maximum of 35 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
+  category_credit_description: 'Upto a maximum of 35 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
   max_credits_per_cycle: 35
 )
 
@@ -183,7 +185,7 @@ category = Effective::CpdCategory.create!(
 Effective::CpdRule.create!(
   cpd_cycle: cycle,
   ruleable: category,
-  credit_description: 'Upto a maximum of 15 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
+  category_credit_description: 'Upto a maximum of 15 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
   max_credits_per_cycle: 15
 )
 
@@ -265,7 +267,7 @@ category = Effective::CpdCategory.create!(
 Effective::CpdRule.create!(
   cpd_cycle: cycle,
   ruleable: category,
-  credit_description: 'Upto a maximum of 15 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
+  category_credit_description: 'Upto a maximum of 15 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
   max_credits_per_cycle: 15
 )
 
@@ -319,7 +321,7 @@ category = Effective::CpdCategory.create!(
 Effective::CpdRule.create!(
   cpd_cycle: cycle,
   ruleable: category,
-  credit_description: 'Upto a maximum of 30 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
+  category_credit_description: 'Upto a maximum of 30 claimable points per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
   max_credits_per_cycle: 30
 )
 
@@ -421,7 +423,7 @@ category = Effective::CpdCategory.create!(
 Effective::CpdRule.create!(
   cpd_cycle: cycle,
   ruleable: category,
-  credit_description: 'Upto a maximum of 10 points per mentee or position per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
+  category_credit_description: 'Upto a maximum of 10 points per mentee or position per CPD year. Points may be carried over upto a maximum of 2 years after the year in which they were earned.',
   max_credits_per_cycle: nil
 )
 

data/lib/effective_cpd.rb

@@ -8,7 +8,7 @@ module EffectiveCpd
   def self.config_keys
     [
       :cpd_categories_table_name, :cpd_activities_table_name,
-      :cpd_cycles_table_name, :cpd_rules_table_name,
+      :cpd_cycles_table_name, :cpd_rules_table_name, :cpd_special_rules_table_name, :cpd_special_rule_mates_table_name,
       :cpd_statements_table_name, :cpd_statement_activities_table_name,
       :cpd_audit_levels_table_name, :cpd_audit_level_sections_table_name,
       :cpd_audit_level_questions_table_name, :cpd_audit_level_question_options_table_name,

data/lib/effective_cpd/engine.rb

@@ -7,5 +7,12 @@ module EffectiveCpd
       eval File.read("#{config.root}/config/effective_cpd.rb")
     end
 
+    # Include acts_as_addressable concern and allow any ActiveRecord object to call it
+    initializer 'effective_cpd.active_record' do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.extend(EffectiveCpdUser::Base)
+      end
+    end
+
   end
 end

data/lib/effective_cpd/version.rb

@@ -1,3 +1,3 @@
 module EffectiveCpd
-  VERSION = '0.1'
+  VERSION = '0.1.5'
 end

data/lib/generators/effective_cpd/install_generator.rb

@@ -25,6 +25,8 @@ module EffectiveCpd
 
         @cpd_cycles_table_name = ':' + EffectiveCpd.cpd_cycles_table_name.to_s
         @cpd_rules_table_name = ':' + EffectiveCpd.cpd_rules_table_name.to_s
+        @cpd_special_rules_table_name = ':' + EffectiveCpd.cpd_special_rules_table_name.to_s
+        @cpd_special_rule_mates_table_name = ':' + EffectiveCpd.cpd_special_rule_mates_table_name.to_s
 
         @cpd_statements_table_name = ':' + EffectiveCpd.cpd_statements_table_name.to_s
         @cpd_statement_activities_table_name = ':' + EffectiveCpd.cpd_statement_activities_table_name.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_cpd
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.5
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-30 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -188,6 +188,7 @@ files:
 - app/controllers/admin/cpd_categories_controller.rb
 - app/controllers/admin/cpd_cycles_controller.rb
 - app/controllers/admin/cpd_rules_controller.rb
+- app/controllers/admin/cpd_special_rules_controller.rb
 - app/controllers/admin/cpd_statements_controller.rb
 - app/controllers/effective/cpd_audit_reviews_controller.rb
 - app/controllers/effective/cpd_audits_controller.rb
@@ -202,6 +203,7 @@ files:
 - app/datatables/admin/effective_cpd_categories_datatable.rb
 - app/datatables/admin/effective_cpd_cycles_datatable.rb
 - app/datatables/admin/effective_cpd_rules_datatable.rb
+- app/datatables/admin/effective_cpd_special_rules_datatable.rb
 - app/datatables/admin/effective_cpd_statements_datatable.rb
 - app/datatables/effective_cpd_available_audit_reviews_datatable.rb
 - app/datatables/effective_cpd_available_audits_datatable.rb
@@ -212,6 +214,7 @@ files:
 - app/helpers/effective_cpd_audits_helper.rb
 - app/helpers/effective_cpd_helper.rb
 - app/mailers/effective/cpd_mailer.rb
+- app/models/concerns/effective_cpd_user.rb
 - app/models/effective/cpd_activity.rb
 - app/models/effective/cpd_audit.rb
 - app/models/effective/cpd_audit_level.rb
@@ -226,6 +229,8 @@ files:
 - app/models/effective/cpd_cycle.rb
 - app/models/effective/cpd_rule.rb
 - app/models/effective/cpd_scorer.rb
+- app/models/effective/cpd_special_rule.rb
+- app/models/effective/cpd_special_rule_mate.rb
 - app/models/effective/cpd_statement.rb
 - app/models/effective/cpd_statement_activity.rb
 - app/views/admin/cpd_activities/_form.html.haml
@@ -252,6 +257,8 @@ files:
 - app/views/admin/cpd_cycles/_form_content.html.haml
 - app/views/admin/cpd_cycles/_form_cpd_cycle.html.haml
 - app/views/admin/cpd_cycles/_form_cpd_rules.html.haml
+- app/views/admin/cpd_cycles/_form_cpd_special_rules.html.haml
+- app/views/admin/cpd_special_rules/_form.html.haml
 - app/views/admin/cpd_statements/_cpd_statement.html.haml
 - app/views/effective/cpd_audit_level_questions/_cpd_audit_level_question.html.haml
 - app/views/effective/cpd_audit_responses/_cpd_audit_response.html.haml