add singleton pattern and test for OOP/cold

Author: rambasnet

demo-assignments/A1-OOP/cold/Makefile

@@ -1,5 +1,6 @@
 DOCS = docs
 PYTHON = python3
+PLANTUML = java -jar ~/plantuml.jar
 
 .PHONY: all
 all: check-style fix-style check-types run-test run-test-coverage create-docs create-uml clean
@@ -57,9 +58,9 @@ ifeq ($(wildcard ~/plantuml.jar), )
 	@echo "Downloading plantuml.jar in home folder..."
 	curl -L -o ~/plantuml.jar https://sourceforge.net/projects/plantuml/files/plantuml.jar/download
 endif
-	$(PLANTUML) docs/uml/HelloWorld.plantuml
-	$(PLANTUML) docs/uml/Main.plantuml
-	$(PLANTUML) docs/uml/solution.plantuml
+	$(PLANTUML) ./uml/temperature.plantuml
+	$(PLANTUML) ./uml/solution.plantuml
+	$(PLANTUML) ./uml/interaction.plantuml
 	@echo "UML diagrams created and saved in uml folder"
 
 

demo-assignments/A1-OOP/cold/cold.py

@@ -51,7 +51,8 @@ def read_data(self, source: Any) -> None:
         self._data = data[1].strip()
         self._temps = [Temperature(int(i)) for i in self._data.split()]
 
-    def get_n(self) -> int:
+    @property
+    def n(self) -> int:
         """Returns the number of temperature readings
 
         Returns:

demo-assignments/A1-OOP/cold/cold_singleton.py

@@ -0,0 +1,95 @@
+#! /usr/bin/env python3
+
+"""
+Solving Kattis problem - cold using Singleton pattern
+https://open.kattis.com/problems/cold
+"""
+
+from __future__ import annotations
+
+__author__ = "Ram Basnet"
+__date__ = "2022/1/1"
+__license__ = "MIT"
+__version__ = "0.1.0"
+__maintainer__ = "Ram Basnet"
+
+
+from typing import Any, List
+import sys
+from temperature import Temperature
+
+
+class Solution():
+    """ Solution class to solve the problem using Singleton pattern"""
+
+    _instance: "Solution" | None = None
+
+    def __new__(cls) -> "Solution":
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+        return cls._instance
+
+    def __init__(self) -> None:
+        """ Constructor
+        """
+        self._n: int = 0  # number of temperatures
+        self._data: str = ''  # data
+        self._temps: List[Temperature] = []  # list of temperatures
+
+    def find_answer(self) -> int:
+        """Counts the number of temperatures below zero
+
+        Returns:
+            int: number of temperatures below zero
+        """
+        count = 0
+        for temp in self._temps:
+            if temp.is_negative():
+                count += 1
+        return count
+
+    def read_data(self, source: Any) -> None:
+        """ Reads data from provided source.
+
+        Args:
+            source (Any): stdin typically for kattis problem
+        """
+        # ignore the first line
+        data = source.readlines()
+        self._n = int(data[0])
+        self._data = data[1].strip()
+        self._temps = [Temperature(int(i)) for i in self._data.split()]
+
+    def get_n(self) -> int:
+        """Returns the number of temperature readings
+
+        Returns:
+            int: number of temperature readings
+        """
+        return self._n
+
+    def get_data(self) -> str:
+        """ Returns the data
+
+        Returns:
+            str: data
+        """
+        return self._data
+
+    def solve(self, source: Any) -> None:
+        """ Solves the problem.
+        """
+        self.read_data(source)
+        print(self.find_answer())
+        # sys.stdout.write('1')
+
+    @staticmethod
+    def main() -> None:
+        """Entry static method
+        """
+        sol = Solution()
+        sol.solve(sys.stdin)
+
+
+if __name__ == "__main__":
+    Solution.main()  # pragma: no cover

demo-assignments/A1-OOP/cold/docs/code-docs/cold.html

@@ -38,15 +38,15 @@ def tearDown(self) -> None:
     def test_read_data1(self) -> None:
         """Tests readData method"""
         self.sol.read_data(self.input1)
-        self.assertEqual(self.sol.get_n(), 3)
+        self.assertEqual(self.sol.n, 3)
         self.assertEqual(self.sol.get_data(), '5 -10 15')
 
     def test_read_data2(self) -> None:
         """
         Tests readData method
         """
         self.sol.read_data(self.input2)
-        self.assertEqual(self.sol.get_n(), 5)
+        self.assertEqual(self.sol.n, 5)
         self.assertEqual(self.sol.get_data(), '-14 -5 -39 -5 -7')
 
     def test_find_answer1(self) -> None:

demo-assignments/A1-OOP/cold/docs/code-docs/index.html

@@ -38,7 +38,7 @@ def tearDown(self) -> None:
     def test_read_data1(self) -> None:
         """Tests readData method"""
         self.sol.read_data(self.input1)
-        self.assertEqual(self.sol.get_n(), 3)
+        self.assertEqual(self.sol.n, 3)
         self.assertEqual(self.sol.get_data(), '5 -10 15')
 
     def test_read_data2(self) -> None:
@@ -47,7 +47,7 @@ def test_read_data2(self) -> None:
         :return: None
         """
         self.sol.read_data(self.input2)
-        self.assertEqual(self.sol.get_n(), 5)
+        self.assertEqual(self.sol.n, 5)
         self.assertEqual(self.sol.get_data(), '-14 -5 -39 -5 -7')
 
     def test_find_answer1(self) -> None:

demo-assignments/A1-OOP/cold/docs/code-docs/search.js

@@ -0,0 +1,54 @@
+"""Unit tests for the singleton solution.
+"""
+
+__author__ = "Ram Basnet"
+__date__ = "2025/02/10"
+__license__ = "MIT"
+__version__ = "0.1.0"
+
+
+from io import StringIO
+from cold_singleton import Solution
+
+
+def test_singleton() -> None:
+    """Test if the solution is a singleton.
+    """
+    a = Solution()
+    b = Solution()
+    assert a is b
+
+
+def test_find_answer() -> None:
+    """Test find_answer method
+    """
+    a = Solution()
+    a.read_data(StringIO("3\n5 -10 15\n"))
+    expected = a.find_answer()
+    assert expected == 1
+
+
+def test_read_data() -> None:
+    """ Test read_data method
+    """
+    a = Solution()
+    a.read_data(StringIO("3\n5 -10 15\n"))
+    assert a.get_n() == 3
+
+
+def test_get_data() -> None:
+    """Test get_data method
+    """
+    a = Solution()
+    a.read_data(StringIO("3\n5 -10 15\n"))
+    assert a.get_data() == "5 -10 15"
+
+
+def test_solve() -> None:
+    """Test solve method
+    """
+    a = Solution()
+    a.solve(StringIO("3\n5 -10 15\n"))
+    # we'll learn how to patch the stdout later
+    # for now we'll just check the answer
+    assert a.find_answer() == 1

demo-assignments/A1-OOP/cold/docs/code-docs/temperature.html

@@ -0,0 +1,4 @@
+@startuml ClassInteraction
+title "UML Class Interaction"
+Solution "1" - Temperature: manages > *
+@enduml

demo-assignments/A1-OOP/cold/tests/test_cold.py

@@ -0,0 +1,22 @@
+@startuml Solution
+scale 2
+title "UML Class Diagram"
+class Solution {
+    .. Class Variables ..
+	_instance: Solution
+    .. Instance Variables ..
+    - _n: int
+    - _data: str
+    - _temps: List[Temperature]
+    + n: int {get; }
+    .. Overloaded Methods ..
+    + __init__(): None
+    .. Instance Methods ..
+	+ read_data(source: Any): None
+    + find_answer(): int
+    + get_data(): str
+    + solve(source: Any): None
+    .. Static Methods ..
+    + main(): None
+}
+@enduml

demo-assignments/A1-OOP/cold/tests/test_solution.py

@@ -0,0 +1,23 @@
+@startuml Temperature
+scale 2
+title "UML Class Diagram"
+
+class Temperature {
+    .. Instance Variables ..
+    - _temp: int
+    - _unit: str
+    + temp: int {get; set;}
+    + unit: str {get; set;}
+    .. Overloaded Methods ..
+    + __init__(side1: float, side2: float, side3: float): None
+    + __str__(): str
+    + __repr__(): str
+    + __lt__(other: Temperature): bool
+    + __gt__(other: Temperature): bool
+    + __eq__(other: object): bool
+    + __le__(other: Temperature): bool
+    + __ge__(other: Temperature): bool
+    .. Instance Methods ..
+    + is_negative(): bool
+}
+@enduml

demo-assignments/A1-OOP/cold/tests/test_solution_singleton.py

@@ -1,4 +1,4 @@
-@startuml
+@startuml Solution
 scale 2
 title "UML Class Diagram"
 class Solution {