effective_cpd 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 789dc178c0c706f7d63d166f48e512b36b3f905eb6e70abd242f98924773a679
-  data.tar.gz: 86e4bb9b95b8a53dd810316b3d4ea9ca2031c8063155cc57d1e192f29b3a84b5
+  metadata.gz: '09c97e5c49d9195e2b402e395d3039510de53b4dda1503ad052af6e7dc28221b'
+  data.tar.gz: 24f617a5dd535b960ef3d9056956395f647a4a5581613014f8786b7d850b521e
 SHA512:
-  metadata.gz: d96d0a42c29587ab1ead57f7b6707f3acc9e607f0eb9fdf9c05336242491351833a2e14ddb81b883c1f8b811ca3a8712a8814ba97fec679ebc0d5b635b04f69a
-  data.tar.gz: e9d5453a4816d34b7668027b96c82a3a2208d7158a656ebaf02fff1776f5dc03e642b2e3b9d34272dcd28d94d6ced94310470d85fdd532c51eb4628ab9ba6f97
+  metadata.gz: e0d0aa17d7b171d1226a40852f79f8440a271cb7bd451bce1260887be7a2c722409d9d8fe4e96a1337e1911935985ef3b737e0cf75807e911714f945637afb3d
+  data.tar.gz: 46744c3a3cbd29b133958be01a375238c0e8d413ba9e64eb0e020fdae9505af907e03c3257d93cecd13df534c9dd7bedd309d58a9052596aad5552161b1aa9ff

data/README.md

@@ -144,18 +144,26 @@ 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
 
-# Just this one magic method. Chcked when submitting the passed cpd_Statement
-# Must be 100 points in the last 3 years. Can submit 0 0 100 or 33 33 34
+# We require 100 points in the last 3 years.
 def cpd_statement_required_score(cpd_statement)
-  # All completed cpd statements before this cpd_statement
-  existing = cpd_statements.select { |s| s.completed? && s.cpd_cycle_id < cpd_statement.cpd_cycle_id }
-  return 0 if existing.length < 2
+  # 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)
 
-  existing_score = others.last(2).map { |statement| statement.score }.sum
-  raise('expected existing to be >= 0') if existing < 0
-  return 0 if existing >= 100
+  # They can submit 0 0 100
+  return 0 if last_two_statements.length < 2
 
-  (100 - existing)
+  # 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
 ```
 

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/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
@@ -29,6 +30,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 +78,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,6 +3,9 @@ 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
+
     if respond_to?(:log_changes)
       log_changes(to: :cpd_cycle)
     end
@@ -12,7 +15,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 +25,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 +34,21 @@ module Effective
       timestamps
     end
 
-    scope :deep, -> { includes(:cpd_cycle, :ruleable) }
+    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")

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

@@ -10,8 +10,8 @@
       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"
+    = 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 +49,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/effective/cpd_statements/_activities_new.html.haml

@@ -22,6 +22,7 @@
       .mb-3
         %strong #{cpd_credits_label.titleize} Calculation
         %br
+        = rule.category_credit_description
         = rule.credit_description
 
       %div

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

@@ -30,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/db/seeds.rb

@@ -9,7 +9,6 @@ if Rails.env.test?
   Effective::CpdRule.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 +17,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 +33,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 +74,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 +144,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 +183,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 +265,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 +319,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 +421,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/version.rb

@@ -1,3 +1,3 @@
 module EffectiveCpd
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_cpd
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails