was 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99421529aa08811e583cff20a0e7d41e110aaad70976b8ef6e52a7bda38feab6
-  data.tar.gz: 70b2035d1d5b2ee5937810efd7f337b9133e0b87b5f68434ece9bc796ffb16dd
+  metadata.gz: 02d43144047e0f7e1da7df05778d6e1b075314ca447ce1f3440c65f38d65f121
+  data.tar.gz: 3a858c1928e5408b9134ce98f9471677fe82ea89fa9d6df32ce5c541b172da6e
 SHA512:
-  metadata.gz: d5cff77d12a2a61eff5c1a0c131bfbc831e43c0b67d9761b9f44146a1307d6d2c08165f28e1a4d644b19c29b582e0479390135818dade2f344a24c323b8fb3eb
-  data.tar.gz: cbfe391a566ffe9b0ce431d3975e4abfdace7dc3194f3fa9b35430a50d571a81e7c0b9baadd1dfe2f29f2e1c8ad59001e6165d41cf9a3943f25e2615c9f42769
+  metadata.gz: 5b18c6c1dd741eeb28df70a71a1a25f3c41cd4d7b01372115087c50c6b8f85fa748cced6d33b5792aabf960801b6fd86d145d89535b7b59d954a188125e608f6
+  data.tar.gz: dff3ba39633f5baf30fd853da49fb09ed3ab56e586a6e3d528859c723e92ed1dabf197cb50c897499f4112141dbfd136bb584a276893f8cd283da0f68e22b4da

data/README.md

@@ -20,34 +20,36 @@ Scenario:
 ### Define score classes
 
 ```ruby
-  class ReportScore < WAS::Score
-    maximum_score 1000
+require "was"
 
-    with "ExamScore",      weight: 0.75
-    with "PracticalScore", weight: 0.25
-  end
+class ReportScore < WAS::Score
+  maximum_score 1000
+
+  with "ExamScore",      weight: 0.75
+  with "PracticalScore", weight: 0.25
+end
 
-  class ExamScore < WAS::Score
-    def calculation
-      return 1    if input == "A"
-      return 0.75 if input == "B"
-      return 0.5  if input == "C"
-      0
-    end
+class ExamScore < WAS::Score
+  def calculation
+    return 1    if input == "A"
+    return 0.75 if input == "B"
+    return 0.5  if input == "C"
+    0
   end
+end
 
-  class PracticalScore < WAS::Score
-    def calculation
-      input / 10.0
-    end
+class PracticalScore < WAS::Score
+  def calculation
+    input / 10.0
   end
+end
 ```
 
 ### Generate a total score
 
 ```ruby
 ReportScore.new(
-  exam: "A"
+  exam: "A",
   practical: 10
 ).calculate
 #> 1000
@@ -58,3 +60,32 @@ ReportScore.new(
 ).calculate
 #> 250
 ````
+
+### Compose without generating a total score
+
+Omitting the `maximum_score` will return a composed percentage represented as a value between `0` and `1`.
+
+```ruby
+# report_score.rb
+class ReportScore < WAS::Score
+  with "ExamScore",      weight: 0.75
+  with "PracticalScore", weight: 0.25
+end
+```
+
+```ruby
+# usage
+ReportScore.new({
+  exam: "A",
+  practical: 5
+}).calculate
+#> 0.875
+```
+
+### View all weights
+
+If you want to see all of the weights that are used to compose the score, there is a convenience method `.weights`:
+
+```ruby
+ReportScore.weights
+#> {exam: {weight: 0.75}, practical: {weight: 0.25}}

data/lib/was/score.rb

@@ -7,7 +7,7 @@ module WAS
     end
 
     def self.max_score
-      @maximum_score
+      @maximum_score || 1
     end
 
     def self.with(klass, weight: 0)
@@ -18,6 +18,19 @@ module WAS
       @klasses ||= {}
     end
 
+    def self.weights
+      {}.tap do |hash|
+        klasses.each do |klass, weight|
+          hash[klass_name_symbol(klass)] = { weight: weight }
+          if Object.const_get(klass).klasses.length > 0
+            hash[klass_name_symbol(klass)].merge!(
+              with: Object.const_get(klass).weights
+            )
+          end
+        end
+      end
+    end
+
     def initialize(input)
       @input = input
     end
@@ -28,14 +41,14 @@ module WAS
 
     def calculation
       self.class.klasses.sum do |klass, weight|
-        score = Object.const_get(klass).new(input[klass_name_symbol(klass)]).calculate
+        score = Object.const_get(klass).new(input[self.class.klass_name_symbol(klass)]).calculate
         score * weight
       end * self.class.max_score
     end
 
     private
 
-    def klass_name_symbol(klass)
+    def self.klass_name_symbol(klass)
       klass[/(\w+)Score$/, 1].downcase.to_sym
     end
   end

data/lib/was/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WAS
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: was
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Connell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies: []
 description: A simple gem/dsl for generating Weighted Average Score calculations.
 email: