was 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dec886b6732bed51319bb2b25188fdb8bfaebc1a731ed2586b3b048d06e31253
-  data.tar.gz: 15a9386c210b0b7f996b1c96890bfaf20b5006e9c492f6078ad55195b34654c7
+  metadata.gz: 116f56df4be0366c5cefda0647c4a59f4300ad8f84b76e39c5c3563ef97abd82
+  data.tar.gz: e3b5304f1f46fac185b4a92ec1201c09bdfc864576332a33614a946606a31afc
 SHA512:
-  metadata.gz: 2eceb9767ae5b5e96117c59dc5d38170fdeb01947b6a4dc3691040065e750dd5e83c9d18c38c79f10ecb72bf4167de4dcae2702c466f1b5810a71d4122e21369
-  data.tar.gz: 29b21a7e3e39272fae787029e7e4c73cf2bc74abfe3369142c08b98eb1f0613c40c19738e2741094de743cfa68496ffa416837d29454e856ce2ba9b3b6172dff
+  metadata.gz: 6ea32808ff515334b197f87ec7dfa8d3ed699b281cff0a041f88ef000884617498eb22a6ce90aec66ee793ef136b4f3939d371b5abff9b4f28b3a3dfbe880f75
+  data.tar.gz: 124c909b89e6ce6b9bb65064bc824c70d8489e9510915a722f8d82919d3e4818f2aebade83d2381f12c121591797eb5937ebaf7b61e05425b6ef93b9e6b12993

data/README.md

@@ -20,36 +20,36 @@ Scenario:
 ### Define score classes
 
 ```ruby
-  require "was"
+require "was"
 
-  class ReportScore < WAS::Score
-    maximum_score 1000
+class ReportScore < WAS::Score
+  maximum_score 1000
 
-    with "ExamScore",      weight: 0.75
-    with "PracticalScore", weight: 0.25
-  end
+  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
@@ -66,16 +66,26 @@ ReportScore.new(
 Omitting the `maximum_score` will return a composed percentage represented as a value between `0` and `1`.
 
 ```ruby
-  class ComposedScore < WAS::Score
-    with "ExamScore",      weight: 0.75
-    with "PracticalScore", weight: 0.25
-  end
+# report_score.rb
+class ReportScore < WAS::Score
+  with "ExamScore",      weight: 0.75
+  with "PracticalScore", weight: 0.25
+end
 ```
 
 ```ruby
-ComposedScore.new({
+# 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

@@ -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.2.0"
+  VERSION = "0.4.0"
 end

data/lib/was.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "WAS/version"
-require_relative "WAS/score"
+require_relative "was/version"
+require_relative "was/score"
 
 module WAS
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: was
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mark Connell