Merge pull request #54 from brootware/dev

Dev

Author: brootware

images/refactor10jul/classes_pyredactkit.png

@@ -48,6 +48,7 @@ mypy = "^0.961"
 flake8 = "^4.0.1"
 tox = "^3.25.0"
 pytest-cov = "^3.0.0"
+pytest-mock = "^3.8.2"
 
 [tool.poetry.scripts]
 pyredactkit = "pyredactkit.pyredactkit:main"

images/refactor10jul/packages_pyredactkit.png

@@ -55,42 +55,49 @@ def valid_options(self) -> tuple:
             option_tuple += id['type']
         return option_tuple
 
-    def process_report(self, filename: str):
-        """Function to process calculate and generate report of man hour saved.
+    def compute_total_words(self, filename: str) -> int:
+        """Function to compute total words in a file.
         Args:
             filename (str): File to count the words
 
         Returns:
-            Creates a report on estimated man hours/minutes saved.
+            total_words (int): total words in file
         """
+        total_words = 0
+        word_length = 5
         try:
-            # Open a file read pointer as target_file
             with open(filename, encoding="utf-8") as target_file:
                 text_chunk = target_file.read()
-
-                # Words per minute
-                WPM = 75
-
-                word_length = 5
-                total_words = 0
                 for current_text in text_chunk:
                     total_words += len(current_text)/word_length
+        except UnicodeDecodeError:
+            sys.exit("[-] Unable to read target file")
+        return math.ceil(total_words)
 
-                total_words = math.ceil(total_words)
+    def compute_reading_minutes(self, total_words: int) -> int:
+        # Words per minute
+        WPM = 75
+        return math.ceil(total_words/WPM)
 
-                # Divide total words by words per minute read to get minutes and hour estimate.
-                reading_minutes = math.ceil(total_words/WPM)
-                reading_hours = math.floor(reading_minutes/60)
+    def compute_reading_hours(self, reading_minutes: int) -> int:
+        return math.floor(reading_minutes/60)
 
-                word_report = f"[+] Estimated total words : {total_words}"
-                minutes_saved = f"[+] Estimated total minutes saved : {reading_minutes}"
-                man_hours_saved = f"[+] Estimated total man hours saved : {reading_hours}"
+    def process_report(self, filename: str):
+        """Function to process calculate and generate report of man hour saved.
+        Args:
+            filename (str): File to count the words
+
+        Returns:
+            Creates a report on estimated man hours/minutes saved.
+        """
+        total_words = self.compute_total_words(filename)
+        reading_minutes = self.compute_reading_minutes(total_words)
+        reading_hours = self.compute_reading_hours(reading_minutes)
 
-                print(word_report)
-                print(minutes_saved)
-                print(man_hours_saved)
+        word_report = f"[+] Estimated total words : {total_words}"
+        minutes_saved = f"[+] Estimated total minutes saved : {reading_minutes}"
+        man_hours_saved = f"[+] Estimated total man hours saved : {reading_hours}"
 
-        except UnicodeDecodeError:
-            os.remove(f"manhour_saved_report_{os.path.basename(filename)}")
-            print("[-] Removed incomplete report")
-            sys.exit("[-] Unable to read target file")
+        print(word_report)
+        print(minutes_saved)
+        print(man_hours_saved)

poetry.lock

@@ -0,0 +1,42 @@
+import pytest
+import json
+import os
+from pyredactkit.common_jobs import CommonJobs
+
+
+@pytest.fixture
+def common_obj():
+    return CommonJobs()
+
+
+@pytest.fixture
+def mocker_text_file(mocker):
+    content = "Message to write on file to be written"
+    mocked_open = mocker.mock_open(read_data=content)
+    builtin_open = "builtins.open"
+    mocker.patch(builtin_open, mocked_open)
+
+
+def test_write_hashmap_should_create_json_file(common_obj, tmp_path):
+    hash_map = {"key": "value"}
+    common_obj.write_hashmap(hash_map, filename='fakefile', savedir=tmp_path)
+    assert os.path.isfile(f"{tmp_path}.hashshadow_fakefile.json"), f"{tmp_path}.hashshadow_fakefile.json file not created"
+
+
+def test_valid_options_should_return_tuple(common_obj):
+    assert isinstance(common_obj.valid_options(), tuple), "valid_options should return a tuple"
+
+
+def test_compute_total_words_should_return_int(common_obj, mocker_text_file):
+    assert isinstance(common_obj.compute_total_words(filename='fakefile'), int), "compute_total_words should return an int"
+
+
+def test_compute_reading_minutes_should_return_int(common_obj, mocker_text_file):
+    total_words = common_obj.compute_total_words(filename='fakefile')
+    assert isinstance(common_obj.compute_reading_minutes(total_words), int), "compute_reading_minutes should return an int"
+
+
+def test_compute_reading_hours_should_return_int(common_obj, mocker_text_file):
+    total_words = common_obj.compute_total_words(filename='fakefile')
+    reading_minutes = common_obj.compute_reading_minutes(total_words)
+    assert isinstance(common_obj.compute_reading_hours(reading_minutes), int),  "compute_reading_hours should return an int"

pyproject.toml

@@ -1,4 +1,5 @@
 import pytest
+import os
 from pyredactkit.core_redactor import CoreRedactorEngine
 
 data = """John, please get that article on www.linkedin.com to me by 5:00PM on Jan 9th 2012. 4:00 would be ideal, actually. If you have any questions, You can reach me at(519)-236-2723 or get in touch with my associate at [email protected]
@@ -51,9 +52,29 @@ def redactor_obj():
     return CoreRedactorEngine()
 
 
+@pytest.fixture
+def mocker_text_file(mocker):
+    content = "Message to write on file to be written"
+    mocked_open = mocker.mock_open(read_data=content)
+    builtin_open = "builtins.open"
+    mocker.patch(builtin_open, mocked_open)
+
+
 def test_redact_all_function_should_return_string_and_dictionary(redactor_obj):
     set1 = redactor_obj.redact_all(data)
     set2 = ("This is a string", hash_table)
     assert type(set1[0]) == type(set2[0]), "1st element of redact_all function should return string"
     assert type(set1[1]) == type(set2[1]), "2nd element of redact_all function should return dictionary"
     assert type(set1) == type(set2), "redact_all function should return a tuple"
+
+
+# def test_process_text_function_should_create_redacted_file_and_json(redactor_obj, tmp_path):
+#     redactor_obj.process_text(data, tmp_path)
+#     assert os.path.isfile(tmp_path / "redacted_file.txt"), "redacted_file.txt should be created"
+#     assert os.path.isfile(tmp_path / "redacted_file.json"), "redacted_file.json should be created"
+
+
+# def test_process_core_file_function_should_create_redacted_file_and_json(redactor_obj, mocker_text_file, tmp_path):
+#     redactor_obj.process_core_file(filename='fakefile', savedir=tmp_path)
+#     assert os.path.isfile(tmp_path / "redacted_fakefile.txt"), "redacted_fakefile.txt should be created"
+#     assert os.path.isfile(tmp_path / "redacted_fakefile.json"), "redacted_fakefile.json should be created"