Merge pull request #874 from amirhoseinsalimi/feature/collection-min

feat: add `Collection.min` method

Author: josephmancuso

src/masoniteorm/collection/Collection.py

@@ -109,6 +109,26 @@ def max(self, key=None):
         except (TypeError, ValueError):
             pass
         return result
+    
+    def min(self, key=None):
+        """Returns the min of the items.
+
+        If a key is given it will return the min of all the values of the key.
+
+        Keyword Arguments:
+            key {string} -- The key to use to find the min of all the values of that key. (default: {None})
+
+        Returns:
+            int -- Returns the min.
+        """
+        result = 0
+        items = self._get_value(key) or self._items
+
+        try:
+            return min(items)
+        except (TypeError, ValueError):
+            pass
+        return result
 
     def chunk(self, size: int):
         """Chunks the items.

tests/collection/test_collection.py

@@ -185,6 +185,24 @@ def test_max(self):
         collection = Collection([{"batch": 1}, {"batch": 1}])
         self.assertEqual(collection.max("batch"), 1)
 
+    def test_min(self):
+        collection = Collection([1, 1, 2, 4])
+        self.assertEqual(collection.min(), 1)
+
+        collection = Collection(
+            [
+                {"name": "Corentin All", "age": 1},
+                {"name": "Corentin All", "age": 2},
+                {"name": "Corentin All", "age": 3},
+                {"name": "Corentin All", "age": 4},
+            ]
+        )
+        self.assertEqual(collection.min("age"), 1)
+        self.assertEqual(collection.min(), 0)
+
+        collection = Collection([{"batch": 1}, {"batch": 1}])
+        self.assertEqual(collection.min("batch"), 1)
+
     def test_count(self):
         collection = Collection([1, 1, 2, 4])
         self.assertEqual(collection.count(), 4)