effective_cpd 1.6.5 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd0911046fcabd42cad5f51a9d1839bb13da67a67276d78bc4c0a3414a1d0e85
-  data.tar.gz: 1f16f8296435282c808e2fb1e5e4aeff7e0aa1ba40c252c478ff1dd955a930e6
+  metadata.gz: 94c7c2fc57c5109c37e1ae0216f297eebb6556210e96db897e6592cd357b49e7
+  data.tar.gz: 2561bc3bae5ca830c72ad9b3499b0e303db66fa5121c685b2d15fb3a5743da85
 SHA512:
-  metadata.gz: 3bf52660128e824a470059d1399cc8321038a87d67bd56c101d4f57b959c9ecf58e577e0fb0d9e31abe5f3a5cb5c1c2cf88ebf134043fffd5570eeea67d7f7d9
-  data.tar.gz: e242876c24636b77819f64835edc02c187776532389be838658999e2cd1136a93f67d24ea7a4e8181d1346f250989647ab58208f13a77c7884f151159d68e12f
+  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

@@ -152,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/lib/effective_cpd/version.rb

@@ -1,3 +1,3 @@
 module EffectiveCpd
-  VERSION = '1.6.5'
+  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.5
+  version: 1.7.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-03 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -483,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