effective_cpd 0.0.1 → 0.1.4

data/app/models/effective/cpd_audit_review_item.rb

@@ -0,0 +1,34 @@
+module Effective
+  class CpdAuditReviewItem < ActiveRecord::Base
+    belongs_to :cpd_audit_review
+    belongs_to :item, polymorphic: true # CpdAuditResponse or CpdStatementActivity
+
+    if respond_to?(:log_changes)
+      log_changes(to: :cpd_audit_review)
+    end
+
+    effective_resource do
+      recommendation            :string
+      comments                  :text
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:cpd_audit_review, :item) }
+    scope :sorted, -> { order(:id) }
+
+    validates :recommendation, presence: true
+    validates :item_id, presence: true, uniqueness: { scope: [:cpd_audit_review_id, :item_type] }
+
+    validate(if: -> { recommendation.present? && cpd_audit_review.present? }) do
+      unless cpd_audit_review.cpd_audit_level.recommendations.include?(recommendation)
+        self.errors.add(:recommendation, 'must exist in this audit level')
+      end
+    end
+
+    def to_s
+      recommendation.presence || 'cpd audit review item'
+    end
+
+  end
+end

data/app/models/effective/cpd_category.rb

@@ -1,13 +1,16 @@
 module Effective
   class CpdCategory < ActiveRecord::Base
     has_rich_text :body
-    log_changes if respond_to?(:log_changes)
 
     has_many :cpd_activities, -> { order(:position) }, inverse_of: :cpd_category, dependent: :destroy
     accepts_nested_attributes_for :cpd_activities, allow_destroy: true
 
-    # has_many :rules, -> { order(cycle_id: :desc) }, as: :ruleable, dependent: :delete_all
-    # accepts_nested_attributes_for :rules, allow_destroy: true
+    has_many :rules, class_name: 'Effective::CpdRule', as: :ruleable
+    has_many :cpd_statement_activities
+
+    if respond_to?(:log_changes)
+      log_changes(except: [:rules, :cpd_statement_activities])
+    end
 
     effective_resource do
       title     :string
@@ -27,6 +30,12 @@ module Effective
     validates :position, presence: true
     validates :body, presence: true
 
+    before_destroy do
+      if (count = cpd_statement_activities.length) > 0
+        raise("#{count} statement activities belong to this category")
+      end
+    end
+
     def to_s
       title.presence || 'category'
     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
@@ -49,11 +54,18 @@ module Effective
 
     validates :title, presence: true
     validates :start_at, presence: true
+    validates :required_score, numericality: { greater_than: 0, allow_nil: true }
 
     validate(if: -> { start_at.present? && end_at.present? }) do
       self.errors.add(:end_at, 'must be after the start date') unless end_at > start_at
     end
 
+    before_destroy do
+      if (count = cpd_statements.length) > 0
+        raise("#{count} statement belong to this cycle")
+      end
+    end
+
     def self.latest_cycle
       order(id: :desc).first
     end
@@ -69,13 +81,17 @@ 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
 
       self

data/app/models/effective/cpd_rule.rb

@@ -3,14 +3,21 @@ module Effective
     belongs_to :cpd_cycle
     belongs_to :ruleable, polymorphic: true # Activity or Category
 
-    log_changes(to: :cpd_cycle) if respond_to?(:log_changes)
+    # 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
 
     # Only permit the words amount, amount2 and any charater 0-9 + - / * ( )
     INVALID_FORMULA_CHARS = /[^0-9\+\-\/\*\(\)]/
 
     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
 
@@ -21,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
@@ -29,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")
@@ -77,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

@@ -10,7 +10,10 @@ module Effective
     accepts_nested_attributes_for :cpd_statement_activities
 
     has_many_attached :files
-    log_changes if respond_to?(:log_changes)
+
+    if respond_to?(:log_changes)
+      log_changes(except: [:wizard_steps])
+    end
 
     acts_as_tokened
 
@@ -29,30 +32,31 @@ module Effective
       confirm_factual         :boolean
       confirm_readonly        :boolean
 
-      completed_at           :datetime, permitted: false
+      submitted_at            :datetime, permitted: false
 
       # Acts as tokened
       token                  :string, permitted: false
 
       # Acts as Wizard
       wizard_steps           :text, permitted: false
+
       timestamps
     end
 
     scope :deep, -> { includes(:cpd_cycle, :user, cpd_statement_activities: [:files_attachments, :cpd_category, :original, cpd_activity: [:rich_text_body]]) }
     scope :sorted, -> { order(:cpd_cycle_id) }
 
-    scope :draft, -> { where(completed_at: nil) }
-    scope :completed, -> { where.not(completed_at: nil) }
+    scope :draft, -> { where(submitted_at: nil) }
+    scope :completed, -> { where.not(submitted_at: nil) }
 
     before_validation(if: -> { new_record? }) do
       self.user ||= current_user
       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
@@ -65,19 +69,29 @@ module Effective
     end
 
     def to_s
-      (cpd_cycle || 'statement').to_s
+      cpd_cycle.present? ? "#{cpd_cycle} Statement" : 'statement'
     end
 
     # This is the review step where they click Submit Ballot
     def submit!
       wizard_steps[:complete] ||= Time.zone.now
-      self.completed_at ||= Time.zone.now
 
-      save!
+      update!(submitted_at: Time.zone.now)
+    end
+
+    def in_progress?
+      submitted_at.blank?
     end
 
     def completed?
-      completed_at.present?
+      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

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

@@ -7,7 +7,7 @@
   .row
     .col
       = f.text_field :title, label: 'Title'
-      = f.rich_text_area :body, label: "Body"
+      = f.rich_text_area :body, label: 'Body (optional)'
     .col
       = f.text_field :amount_label,
         hint: 'hours of work, papers written, courses attended'

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

@@ -0,0 +1,100 @@
+= effective_form_with(model: [:admin, cpd_audit_level_question], engine: true) do |f|
+  - if inline_datatable?
+    = f.hidden_field :cpd_audit_level_section_id
+  - else
+    = f.select :cpd_audit_level_section_id, Effective::CpdAuditLevelSection.sorted.all
+
+  = f.text_field :title, label: 'Question Title'
+  = f.rich_text_area :body, label: 'Body (optional)'
+
+  = f.check_box :required, hint: 'A response to this question will be required'
+  = f.select :category, Effective::CpdAuditLevelQuestion::CATEGORIES
+
+  = f.show_if :category, 'Choose one' do
+    .card
+      .card-body
+        %h5 Choose one
+        %p Display radio buttons to choose one option
+
+  = f.show_if :category, 'Select all that apply' do
+    .card
+      .card-body
+        %h5 Select all that apply
+        %p Display checkboxes to select all options that apply
+
+  = f.show_if :category, 'Select up to 1' do
+    .card
+      .card-body
+        %h5 Select up to 1 (one)
+        %p Display checkboxes to select up to 1 option
+
+  = f.show_if :category, 'Select up to 2' do
+    .card
+      .card-body
+        %h5 Select up to 2 (two)
+        %p Display checkboxes to select up to 2 options
+
+  = f.show_if :category, 'Select up to 3' do
+    .card
+      .card-body
+        %h5 Select up to 3 (three)
+        %p Display checkboxes to select up to 3 options
+
+  = f.show_if :category, 'Select up to 4' do
+    .card
+      .card-body
+        %h5 Select up to 4 (four)
+        %p Display checkboxes to select up to 4 options
+
+  = f.show_if :category, 'Select up to 5' do
+    .card
+      .card-body
+        %h5 Select up to 5 (five)
+        %p Display checkboxes to select up to 5 options
+
+  = f.show_if :category, 'Short Answer' do
+    .card
+      .card-body
+        %h5 Short Answer
+        %p Display a text field to enter a short text answer
+
+  = f.show_if :category, 'Long Answer' do
+    .card
+      .card-body
+        %h5 Long Answer
+        %p Display a textarea to enter a long text answer
+
+  = f.show_if :category, 'Date' do
+    .card
+      .card-body
+        %h5 Date
+        %p Display a date field to enter a date
+
+  = f.show_if :category, 'Email' do
+    .card
+      .card-body
+        %h5 Email
+        %p Display an email field to enter an email
+
+  = f.show_if :category, 'Number' do
+    .card
+      .card-body
+        %h5 Number
+        %p Display a number field to enter an integer number
+
+  = f.show_if :category, 'Upload File' do
+    .card
+      .card-body
+        %h5 Upload File
+        %p Display a file field to upload a file
+
+  = f.show_if_any :category, Effective::CpdAuditLevelQuestion::WITH_OPTIONS_CATEGORIES do
+    .mt-3.card
+      .card-body
+        %h5 Options
+        %p Display the following options:
+
+        = f.has_many :cpd_audit_level_question_options, class: 'tight' do |fa|
+          = fa.text_field :title, label: false
+
+  = effective_submit(f)