effective_cpd 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09c97e5c49d9195e2b402e395d3039510de53b4dda1503ad052af6e7dc28221b'
-  data.tar.gz: 24f617a5dd535b960ef3d9056956395f647a4a5581613014f8786b7d850b521e
+  metadata.gz: 3f74220d92f6cb570ae692fae9610f7aa3c16435f025381cda0f1d76d37eb462
+  data.tar.gz: 5370d91a541e895acccdfe6249e7fab92083bd2e7a39138a5f1c37fe0f6141f1
 SHA512:
-  metadata.gz: e0d0aa17d7b171d1226a40852f79f8440a271cb7bd451bce1260887be7a2c722409d9d8fe4e96a1337e1911935985ef3b737e0cf75807e911714f945637afb3d
-  data.tar.gz: 46744c3a3cbd29b133958be01a375238c0e8d413ba9e64eb0e020fdae9505af907e03c3257d93cecd13df534c9dd7bedd309d58a9052596aad5552161b1aa9ff
+  metadata.gz: 62863f2ebce7908df8170c7e981c026e2e16eff493376a2c21c00bfdeaeee1a2dd394713bfa5be6d1986452cd519ac6d94000f15c38ec8d5c3e561c4dd8eb297
+  data.tar.gz: f039df8345571dc4812372211026330d2fb69bc20eb398110cb8e0a5831273c4940132770dfdcb85212867e8b1beb5c7761b81ea52ae6b803f4579d65c48e4f3

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/models/effective/cpd_cycle.rb

@@ -11,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)

data/app/models/effective/cpd_rule.rb

@@ -6,6 +6,9 @@ module Effective
     # 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
@@ -34,6 +37,7 @@ module Effective
       timestamps
     end
 
+    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') }
@@ -84,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/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_cpd_rules.html.haml

@@ -6,9 +6,14 @@
   %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."
+    .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
+        = f.select :cpd_special_rule_ids, cpd_cycle.cpd_special_rules,
+          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"

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_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

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/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,6 +7,8 @@ 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

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/version.rb

@@ -1,3 +1,3 @@
 module EffectiveCpd
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 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.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-18 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
@@ -227,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
@@ -253,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