was 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99421529aa08811e583cff20a0e7d41e110aaad70976b8ef6e52a7bda38feab6
+  data.tar.gz: 70b2035d1d5b2ee5937810efd7f337b9133e0b87b5f68434ece9bc796ffb16dd
+SHA512:
+  metadata.gz: d5cff77d12a2a61eff5c1a0c131bfbc831e43c0b67d9761b9f44146a1307d6d2c08165f28e1a4d644b19c29b582e0479390135818dade2f344a24c323b8fb3eb
+  data.tar.gz: cbfe391a566ffe9b0ce431d3975e4abfdace7dc3194f3fa9b35430a50d571a81e7c0b9baadd1dfe2f29f2e1c8ad59001e6165d41cf9a3943f25e2615c9f42769

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Mark Connell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# WAS: Weighted Average Score
+
+A simple gem/dsl for generating Weighted Average Score calculations.
+
+## Example Usage
+
+Scenario:
+* A person has a final report that is scored based on two parts:
+  * A practical test score, worth 25% of the total
+  * An Exam score, worth 75%
+* The exam is given a grade: A, B, C, F
+  * 'A' is worth 100%
+  * 'B' is 75%
+  * 'C' is 50%
+  * 'D' is 0%
+* The practical is a simple mark out of 10.
+  * 4 out of 10 is 40% 
+* The person is given a final score out of 1000.  
+
+### Define score classes
+
+```ruby
+  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
+  end
+
+  class PracticalScore < WAS::Score
+    def calculation
+      input / 10.0
+    end
+  end
+```
+
+### Generate a total score
+
+```ruby
+ReportScore.new(
+  exam: "A"
+  practical: 10
+).calculate
+#> 1000
+
+ReportScore.new(
+  exam: "F",
+  practical: 10
+).calculate
+#> 250
+````

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/was/score.rb

@@ -0,0 +1,42 @@
+module WAS
+  class Score
+    attr_reader :input
+
+    def self.maximum_score(value)
+      @maximum_score = value
+    end
+
+    def self.max_score
+      @maximum_score
+    end
+
+    def self.with(klass, weight: 0)
+      klasses.merge!(klass => weight)
+    end
+
+    def self.klasses
+      @klasses ||= {}
+    end
+
+    def initialize(input)
+      @input = input
+    end
+
+    def calculate
+      calculation
+    end
+
+    def calculation
+      self.class.klasses.sum do |klass, weight|
+        score = Object.const_get(klass).new(input[klass_name_symbol(klass)]).calculate
+        score * weight
+      end * self.class.max_score
+    end
+
+    private
+
+    def klass_name_symbol(klass)
+      klass[/(\w+)Score$/, 1].downcase.to_sym
+    end
+  end
+end

data/lib/was/version.rb

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

data/lib/was.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "WAS/version"
+require_relative "WAS/score"
+
+module WAS
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/was.rbs

@@ -0,0 +1,4 @@
+module WAS
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/was.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/was/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "was"
+  spec.version = WAS::VERSION
+  spec.authors = ["Mark Connell"]
+  spec.email   = ["github@markconnell.co.uk"]
+
+  spec.summary     = "WAS: Weighted Average Score calculator"
+  spec.description = "A simple gem/dsl for generating Weighted Average Score calculations."
+  spec.homepage    = "https://github.com/mconnell/was"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mconnell/was"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: was
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Connell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-10 00:00:00.000000000 Z
+dependencies: []
+description: A simple gem/dsl for generating Weighted Average Score calculations.
+email:
+- github@markconnell.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/was.rb
+- lib/was/score.rb
+- lib/was/version.rb
+- sig/was.rbs
+- was.gemspec
+homepage: https://github.com/mconnell/was
+licenses: []
+metadata:
+  homepage_uri: https://github.com/mconnell/was
+  source_code_uri: https://github.com/mconnell/was
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key:
+specification_version: 4
+summary: 'WAS: Weighted Average Score calculator'
+test_files: []