feat: add TextFileReader

Author: glefer

.github/workflows/tests.yml

@@ -1,6 +1,9 @@
 name: test
 
-on: [push, pull_request]
+on:
+    push:
+        branches: [ main ]
+    pull_request:
 
 jobs:
   test:
@@ -32,9 +35,13 @@ jobs:
         run: poetry install --no-interaction
       - name: Code Quality
         run: |
-          source .venv/bin/activate
           poetry run pre-commit run --all-files
       - name: Run tests
         run: |
-          source .venv/bin/activate
-          poetry run pytest tests/
+          poetry run pytest --cov=src tests/  --cov-report=xml
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: glefer-training/file-parser
+        if: github.event_name != 'pull_request'

.gitignore

@@ -1,2 +1,3 @@
 /.coverage
+/coverage.xml
 __pycache__

.pre-commit-config.yaml

@@ -13,16 +13,16 @@ repos:
         entry: poetry run black
         language: system
         types: [file, python]
-        files: '^(src|test)/'
+        files: '^(src|tests)/'
       - id: isort
         name: isort
         entry: poetry run isort
         language: system
         types: [file, python]
-        files: '^(src|test)/'
+        files: '^(src|tests)/'
       - id: flake8
         name: flake8
         entry: poetry run flake8
         language: system
         types: [file, python]
-        files: '^(src|test)/'
+        files: '^(src|tests)/'

README.md

@@ -0,0 +1,3 @@
+# File calculation parser
+
+![Coverage](https://codecov.io/gh/glefer-training/file-parser/branch/main/graph/badge.svg)

src/file_calculation_parser/main.py

@@ -0,0 +1,7 @@
+class TextFileReader:
+    def __init__(self, filename: str):
+        self._filename = filename
+
+    def read(self):
+        with open(self._filename, "r", encoding="utf-8") as f:
+            yield from (row.strip() for row in f if row.strip())

src/file_calculation_parser/reader.py

@@ -0,0 +1,25 @@
+import os
+import tempfile
+import unittest
+
+from src.file_calculation_parser.reader import TextFileReader
+
+
+class TestTextReader(unittest.TestCase):
+    def setUp(self):
+        """Create temporary file with some rows to testing"""
+        self._temp_filename: str = tempfile.NamedTemporaryFile(delete=False).name
+        self._files_rows: list = ["row1", "row2", "row3", " ", "", "\n"]
+
+        with open(self._temp_filename, "w", encoding="utf-8") as f:
+            f.write("\n".join(self._files_rows))
+
+    def test_can_read_each_rows(self):
+        """Check if TextReader read each file and remove empty rows"""
+        reader: TextFileReader = TextFileReader(self._temp_filename)
+        expected_result: list = [row.strip() for row in self._files_rows if row.strip()]
+        self.assertListEqual(list(reader.read()), expected_result)
+
+    def tearDown(self):
+        if os.path.exists(self._temp_filename):
+            os.remove(self._temp_filename)