From 7c0be187814827d14a155b281285ca820c547f7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?D=C3=ADdac=20Coll=20Pujals?= Date: Fri, 19 Jun 2020 19:55:28 +0200 Subject: [PATCH] Refactor fileutils Rename MarkDownFile to MarkdownFile. Rename rewrite_all_file to write. Rename append_end to append. --- doc/copy-md-example-to-readme.py | 10 ++++----- mdutils/fileutils/__init__.py | 2 +- mdutils/fileutils/fileutils.py | 10 ++++----- mdutils/mdutils.py | 8 ++++---- tests/test_fileutils/test_fileutils.py | 28 +++++++++++++------------- tests/test_mdutils.py | 12 +++++------ 6 files changed, 35 insertions(+), 35 deletions(-) diff --git a/doc/copy-md-example-to-readme.py b/doc/copy-md-example-to-readme.py index 727f116..449998a 100755 --- a/doc/copy-md-example-to-readme.py +++ b/doc/copy-md-example-to-readme.py @@ -1,14 +1,14 @@ #!/usr/bin/python3 -from mdutils.fileutils.fileutils import MarkDownFile +from mdutils.fileutils.fileutils import MarkdownFile from pathlib import Path readme_path = "../README.md" -readme_content = MarkDownFile.read_file(readme_path) -readme = MarkDownFile(readme_path) -markdown_example = MarkDownFile.read_file("./source/examples/Example_Markdown.md") +readme_content = MarkdownFile.read_file(readme_path) +readme = MarkdownFile(readme_path) +markdown_example = MarkdownFile.read_file("./source/examples/Example_Markdown.md") replace_index = readme_content.find("Markdown File Example\n=====================") new_readme = readme_content[:replace_index] + markdown_example -readme.rewrite_all_file(new_readme) +readme.write(new_readme) diff --git a/mdutils/fileutils/__init__.py b/mdutils/fileutils/__init__.py index cc4f6ce..b69056b 100644 --- a/mdutils/fileutils/__init__.py +++ b/mdutils/fileutils/__init__.py @@ -1 +1 @@ -from mdutils.fileutils.fileutils import MarkDownFile +from mdutils.fileutils.fileutils import MarkdownFile diff --git a/mdutils/fileutils/fileutils.py b/mdutils/fileutils/fileutils.py index e7fe2d9..2a7a25b 100644 --- a/mdutils/fileutils/fileutils.py +++ b/mdutils/fileutils/fileutils.py @@ -7,7 +7,7 @@ # MIT License: (C) 2018 Dídac Coll -class MarkDownFile(object): +class MarkdownFile(object): """MarkDownFile class creates a new file of MarkDown extension. Features available are: @@ -23,14 +23,14 @@ def __init__(self, name=''): self.file = open(self.file_name, 'w+', encoding='UTF-8') self.file.close() - def rewrite_all_file(self, data): + def write(self, data): """Rewrite all the data of a Markdown file by ``data``. :param str data: is a string containing all the data that is written in the markdown file.""" with open(self.file_name, 'w', encoding='utf-8') as self.file: self.file.write(data) - def append_end(self, data): + def append(self, data): """Write at the last position of a Markdown file. :param str data: is a string containing all the data that is written in the markdown file.""" @@ -69,5 +69,5 @@ def read_file(file_name): if __name__ == '__main__': - new_file = MarkDownFile('Example') - new_file.rewrite_all_file(data="# Some Text Example") + new_file = MarkdownFile('Example') + new_file.write(data="# Some Text Example") diff --git a/mdutils/mdutils.py b/mdutils/mdutils.py index 09d6fe9..70100d5 100644 --- a/mdutils/mdutils.py +++ b/mdutils/mdutils.py @@ -20,7 +20,7 @@ """ import mdutils.tools.Table import mdutils.tools.TableOfContents -from mdutils.fileutils.fileutils import MarkDownFile +from mdutils.fileutils.fileutils import MarkdownFile from mdutils.tools.Header import Header from mdutils.tools.Image import Image from mdutils.tools.Link import Inline, Reference @@ -67,8 +67,8 @@ def __init__(self, file_name, title="", author=""): def create_md_file(self): """It creates a new Markdown file. :return: return an instance of a MarkDownFile.""" - md_file = MarkDownFile(self.file_name) - md_file.rewrite_all_file( + md_file = MarkdownFile(self.file_name) + md_file.write( data=self.title + self.table_of_contents + self.file_data_text + self.reference.get_references_as_markdown() ) return md_file @@ -81,7 +81,7 @@ def read_md_file(self, file_name): :return: optionally returns the file data content. :rtype: str """ - file_data = MarkDownFile().read_file(file_name) + file_data = MarkdownFile().read_file(file_name) self.___update_file_data(file_data) return file_data diff --git a/tests/test_fileutils/test_fileutils.py b/tests/test_fileutils/test_fileutils.py index 36189bc..0153d11 100644 --- a/tests/test_fileutils/test_fileutils.py +++ b/tests/test_fileutils/test_fileutils.py @@ -7,7 +7,7 @@ # MIT License: (C) 2020 Dídac Coll from unittest import TestCase -from mdutils.fileutils import MarkDownFile +from mdutils.fileutils import MarkdownFile import tempfile import os @@ -17,39 +17,39 @@ class TestMarkdownFile(TestCase): def test_create_file(self): with tempfile.TemporaryDirectory() as tmp: os.chdir(tmp) - file = MarkDownFile('Test_file') + file = MarkdownFile('Test_file') self.assertEqual(file.file_name, 'Test_file.md') def test_create_file_case_0(self): with tempfile.TemporaryDirectory() as tmp: os.chdir(tmp) - file = MarkDownFile('Test_filemd') + file = MarkdownFile('Test_filemd') self.assertEqual(file.file_name, 'Test_filemd.md') def test_create_file_case_1(self): with tempfile.TemporaryDirectory() as tmp: os.chdir(tmp) - file = MarkDownFile('Test_file.md') + file = MarkdownFile('Test_file.md') self.assertEqual(file.file_name, 'Test_file.md') - def test_rewrite_all_file(self): + def test_write(self): expected_content = "Write some content" file_name = 'Test_file.md' with tempfile.TemporaryDirectory() as tmp: os.chdir(tmp) - file = MarkDownFile(file_name) - file.rewrite_all_file(expected_content) + file = MarkdownFile(file_name) + file.write(expected_content) with open(file_name, 'r') as actual_md: self.assertEqual(actual_md.read(), expected_content) - def test_append_end(self): + def test_append(self): expected_content = "Write some content and some data" file_name = 'Test_file.md' with tempfile.TemporaryDirectory() as tmp: os.chdir(tmp) - file = MarkDownFile(file_name) - file.rewrite_all_file("Write some content") - file.append_end(" and some data") + file = MarkdownFile(file_name) + file.write("Write some content") + file.append(" and some data") with open(file_name, 'r') as actual_md: self.assertEqual(actual_md.read(), expected_content) @@ -58,8 +58,8 @@ def test_append_second_line(self): file_name = 'Test_file.md' with tempfile.TemporaryDirectory() as tmp: os.chdir(tmp) - file = MarkDownFile(file_name) - file.rewrite_all_file("This is the 1st line\nThis is the 2nd line\nThis is the 4th line") + file = MarkdownFile(file_name) + file.write("This is the 1st line\nThis is the 2nd line\nThis is the 4th line") file.append_after_second_line("This is the 3th line") with open(file_name, 'r') as actual_md: self.assertEqual(actual_md.read(), expected_content) @@ -72,4 +72,4 @@ def test_read(self): with open(file_name, 'w') as file: file.write(expected_content) - self.assertEqual(MarkDownFile.read_file(file_name), expected_content) + self.assertEqual(MarkdownFile.read_file(file_name), expected_content) diff --git a/tests/test_mdutils.py b/tests/test_mdutils.py index 0da2ed3..ad61c93 100644 --- a/tests/test_mdutils.py +++ b/tests/test_mdutils.py @@ -8,7 +8,7 @@ from unittest import TestCase from mdutils.mdutils import MdUtils -from mdutils.fileutils import MarkDownFile +from mdutils.fileutils import MarkdownFile from pathlib import Path import os @@ -325,7 +325,7 @@ def test_references_placed_in_markdown_file(self): md_file.create_md_file() - created_data = MarkDownFile.read_file('Test_file.md') + created_data = MarkdownFile.read_file('Test_file.md') self.assertEqual(expected_value, created_data) @@ -361,7 +361,7 @@ def test_new_reference_image_markdown_data(self): md_file.new_line(image_2) md_file.create_md_file() - actual_created_data = MarkDownFile.read_file("Test_file") + actual_created_data = MarkdownFile.read_file("Test_file") self.assertEqual(expected_created_data, actual_created_data) @@ -370,18 +370,18 @@ def test_new_list(self): md_file.new_list(self.complex_items) md_file.create_md_file() - self.assertEqual(self.expected_list, MarkDownFile.read_file('Test_file.md')) + self.assertEqual(self.expected_list, MarkdownFile.read_file('Test_file.md')) def test_new_checkbox_list(self): md_file = MdUtils(file_name="Test_file", title="") md_file.new_checkbox_list(self.complex_items) md_file.create_md_file() - self.assertEqual(self.expected_list.replace('-', '- [ ]'), MarkDownFile.read_file('Test_file.md')) + self.assertEqual(self.expected_list.replace('-', '- [ ]'), MarkdownFile.read_file('Test_file.md')) def test_new_checkbox_checked_list(self): md_file = MdUtils(file_name="Test_file", title="") md_file.new_checkbox_list(self.complex_items, checked=True) md_file.create_md_file() - self.assertEqual(self.expected_list.replace('-', '- [x]'), MarkDownFile.read_file('Test_file.md')) + self.assertEqual(self.expected_list.replace('-', '- [x]'), MarkdownFile.read_file('Test_file.md'))