effective_cpd 1.6.4 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1be69d17b3b7602f4ecd79e04ba02da88c72d9cffe84b2a62a89bfb86d9e83ad
-  data.tar.gz: 1e681360aeb11babccd620a4b50517ee76e14c8193256944e0b312da01f4d7c9
+  metadata.gz: 94c7c2fc57c5109c37e1ae0216f297eebb6556210e96db897e6592cd357b49e7
+  data.tar.gz: 2561bc3bae5ca830c72ad9b3499b0e303db66fa5121c685b2d15fb3a5743da85
 SHA512:
-  metadata.gz: 818a42d3b8ae3d1b50b4504668a9a981456ac82a7283aa8b41de048c500e584515785fe2f823dad1767ac88ef4f95f85a195d8281618cc6bfbecd267c20a3f87
-  data.tar.gz: 3556315481e1cba1e8510cfb324f5d9f0c53ed62d656991ad9593c07e715eac16e6d19b8bb5bd95e4483ab85e60b257b38fc9cc3c0b7e813cecb11cae979a65d
+  metadata.gz: 750ffcaba4258184debafb988238cbe47774b19a74a494656d600dff4234fc1e94d057040f177f9c07348e81ad2f32258abe52f76b4d4e3a53fa163562586d97
+  data.tar.gz: 6571b2816b5616a2fd00928d3ebf142cf7ada391eccd5b7bfa9ca18e5ecc1708ba2d3728e5a67fe046b21879158d04ed2b45a5a3352faaae5dbcbfcc2bf28453

data/README.md

@@ -2,7 +2,7 @@
 
 Continuing professional development.
 
-An admin creates a set of categories, activites and rules.  User enters number of hours or work done to have a scored statement. Audits.
+An admin creates a set of categories, activities and rules.  User enters number of hours or work done to have a scored statement. Audits.
 
 Works with action_text for content bodies, and active_storage for file uploads.
 
@@ -93,7 +93,7 @@ Use the following datatables to display to your user their statements and audits
     = render_datatable(reviewed, simple: true)
 ```
 
-On the Admin::Users#edit, you can use the following datatables as well:
+On the `Admin::Users#edit`, you can use the following datatables as well:
 
 ```haml
 %h2 CPD Statements
@@ -138,7 +138,7 @@ Once all these 3 areas have been configured, users can submit statements and aud
 
 You can specify the required score in the CPD Cycle.
 
-You can also programatically do it. Add the following to your user class.
+You can also programmatically do it. Add the following to your user class.
 
 ```
 # This is an ActiveRecord concern to add the has_many :cpd_statements
@@ -167,6 +167,22 @@ def cpd_statement_required_score(cpd_statement)
 end
 ```
 
+## Custom Score Rounding
+
+In your `effective_cpd_statement` model you can override the `#round_amount` method to perform
+specific rounding on the score that will be applied to `amount` and `amount2`.
+
+Example:
+
+```ruby
+  # Rounding to the nearest 0.5
+  def round_amount(amount)
+    return 0 if amount.blank?
+
+    (amount * 2.0).round / 2.0
+  end
+```
+
 ## Rake Tasks
 
 You can use
@@ -181,7 +197,7 @@ All authorization checks are handled via the effective_resources gem found in th
 
 ## Permissions
 
-The permissions you actually want to define are as follows (using CanCan):
+The permissions you actually want to define are as follows (using CanCanCan):
 
 ```ruby
 # Regular signed up user. Guest users not supported.

data/app/models/concerns/effective_cpd_statement.rb

@@ -33,6 +33,7 @@ module EffectiveCpdStatement
     log_changes(except: :wizard_steps) if respond_to?(:log_changes)
 
     has_many_attached :files
+    has_many_purgable :files
 
     attr_accessor :current_user
     attr_accessor :current_step
@@ -151,4 +152,18 @@ module EffectiveCpdStatement
       cpd_statement_activities.each { |activity| scores[activity.cpd_category_id] += activity.score.to_d }
     end
   end
+
+  #
+  # This method is used in CpdScore#score so it can be overridden to provide a
+  # custom round score calculation.
+  # Any model that is a statement can override this method to provide a custom
+  # round score calculation.
+  #
+  # @param [Decimal] amount
+  #
+  # @return [Decimal] rounded decimal
+  #
+  def round_amount(amount)
+    return amount
+  end
 end

data/app/models/effective/cpd_rule.rb

@@ -13,7 +13,7 @@ module Effective
       log_changes(to: :cpd_cycle)
     end
 
-    # Only permit the words amount, amount2 and any charater 0-9 + - / * . ( )
+    # Only permit the words amount, amount2 and any character 0-9 + - / * . ( )
     INVALID_FORMULA_CHARS = /[^0-9\+\-\.\/\*\(\)]/
 
     effective_resource do
@@ -111,7 +111,14 @@ module Effective
 
       return cpd_statement_activity.carry_over if cpd_statement_activity.is_carry_over?
 
-      eval_equation(amount: cpd_statement_activity.amount, amount2: cpd_statement_activity.amount2)
+      # Statements can override the #round_amount method to perform their own
+      # calculations.  For example, a statement may round to the nearest 0.5 or
+      # to the nearest 0.25 or to the nearest 0.1.
+      statement = cpd_statement_activity.cpd_statement
+      amount = statement.round_amount(cpd_statement_activity.amount)
+      amount2 = statement.round_amount(cpd_statement_activity.amount2)
+
+      eval_equation(amount: amount, amount2: amount2)
     end
 
     private

data/app/models/effective/cpd_statement_activity.rb

@@ -3,7 +3,8 @@ module Effective
     attr_accessor :max_score
     attr_accessor :importing
 
-    belongs_to :cpd_statement
+    belongs_to :cpd_statement # This works just fine without the polymorphic
+
     belongs_to :cpd_category
     belongs_to :cpd_activity
 

data/app/views/admin/users/_form_cpd_targets.html.haml

@@ -4,7 +4,7 @@
   %p
     #{cpd_targets_label} set the requirements checked when submitting a #{cpd_statement_label}
 
-  %table.table
+  %table.table.table-striped.table-hover.table-sm
     %thead
       %th= cpd_cycle_label
       %th Default Requirements
@@ -29,11 +29,10 @@
         %tr
           %td= link_to(cpd_cycle, effective_cpd.edit_admin_cpd_cycle_path(cpd_cycle), target: '_blank')
           %td
-            %p
-              = pluralize(default_target, cpd_credit_label.downcase)
-              = default_required_to_submit ? 'required' : 'targeted'
-              and
-              = collection.find { |value| value.last == default_required_to_submit }.first.downcase
+            = pluralize(default_target, cpd_credit_label.downcase)
+            = default_required_to_submit ? 'required' : 'targeted'
+            and
+            = collection.find { |value| value.last == default_required_to_submit }.first.downcase
 
           %td
             .row

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

@@ -0,0 +1,6 @@
+%h2 Agreements
+= f.check_box :confirm_read, label: "Yes, I have read the above content and agreements"
+= f.check_box :confirm_factual, label: "Yes, I declare all provided information to be factual and complete"
+
+%h2 Resume
+= f.file_field :files, label: 'Attach resume', hint: "Please attach your resume or other #{cpd_name_label} related documents"

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

@@ -1,20 +1,3 @@
 = card('Agreements') do
-  %table.table
-    %tbody
-      %tr
-        %th Read all contents and agreements
-        %td= cpd_statement.confirm_read ? 'Yes' : 'No'
-
-      %tr
-        %th Declared all information factual
-        %td= cpd_statement.confirm_factual ? 'Yes' : 'No'
-
-      %tr
-        %th Attachments
-        %td
-          - if cpd_statement.files.blank?
-            None
-          - else
-            %ul
-              - cpd_statement.files.each do |file|
-                = link_to(file.filename, url_for(file), target: '_blank')
+  = effective_table_with(cpd_statement) do |f|
+    = render('effective/cpd_statements/agreement_fields', f: f)

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

@@ -10,11 +10,6 @@
   = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
     = f.hidden_field :current_step
 
-    %h2 Agreements
-    = f.check_box :confirm_read, label: "Yes, I have read the above content and agreements"
-    = f.check_box :confirm_factual, label: "Yes, I declare all provided information to be factual and complete"
-
-    %h2 Resume
-    = f.file_field :files, label: 'Attach resume', hint: "Please attach your resume or other #{cpd_name_label} related documents"
+    = render('effective/cpd_statements/agreement_fields', f: f)
 
     = f.submit 'Save and Continue', center: true

data/config/locales/effective_cpd.en.yml

@@ -20,6 +20,7 @@ en:
       effective/cpd_statement_activity: 'CPD Statement Activity'
       effective/cpd_category: 'CPD Category'
       effective/cpd_target: 'CPD Target'
+      effective/cpd_rule: 'CPD Rule'
 
     attributes:
       # Application namespace
@@ -37,3 +38,6 @@ en:
       # Effective namespace
       effective/cpd_statement_activity:
         cpd_cycle: 'CPD Period'
+
+      effective/cpd_rule:
+        cpd_cycle: 'CPD Period'

data/lib/effective_cpd/version.rb

@@ -1,3 +1,3 @@
 module EffectiveCpd
-  VERSION = '1.6.4'
+  VERSION = '1.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_cpd
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.7.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -441,6 +441,7 @@ files:
 - app/views/effective/cpd_statements/_activities_edit.html.haml
 - app/views/effective/cpd_statements/_activities_new.html.haml
 - app/views/effective/cpd_statements/_activities_table.html.haml
+- app/views/effective/cpd_statements/_agreement_fields.html.haml
 - app/views/effective/cpd_statements/_agreements.html.haml
 - app/views/effective/cpd_statements/_cpd_statement.html.haml
 - app/views/effective/cpd_statements/_layout.html.haml
@@ -482,7 +483,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Continuing professional development and audits rails engine