Fixed Several Issues With README Generation (#33)

* Fixed program sorting issue

* Fixed an issue with the way language names display

* Added readable language function

* Updated version

Author: jrg94

generate_docs/generator.py

@@ -64,3 +64,4 @@ def main_readmes():
 
 if __name__ == '__main__':
     main_wiki()
+    main_readmes()

generate_docs/readme.py

@@ -3,8 +3,8 @@
 
 
 def _get_intro_text(language: LanguageCollection) -> str:
-    introduction = f"Welcome to Sample Programs in {language.name.capitalize()}!"
-    docs = f"""To find documentation related to the {language.name.capitalize()} 
+    introduction = f"Welcome to Sample Programs in {language.get_readable_name()}!"
+    docs = f"""To find documentation related to the {language.get_readable_name()} 
     code in this repo, look [here]({language.sample_program_url}).
     """
     interlude_valid = "Otherwise, below you'll find a list of code snippets in this collection."
@@ -30,7 +30,7 @@ def _generate_program_list(language: LanguageCollection) -> list:
     list_items = list()
     for program in language.sample_programs:
         readable_name = program.normalized_name.replace("-", " ").title()
-        doc_link = build_doc_link(program, f"{readable_name} in {program.language.capitalize()}")
+        doc_link = build_doc_link(program, f"{readable_name} in {language.get_readable_name()}")
         list_items.append(f"- {doc_link}")
     return list_items
 
@@ -56,7 +56,7 @@ def _build_readme(self, language: LanguageCollection) -> None:
         :return: None
         """
         page = MarkdownPage("README")
-        page.add_content(f"# Sample Programs in {language.name.capitalize()}")
+        page.add_content(f"# Sample Programs in {language.get_readable_name()}")
         page.add_section_break()
         page.add_content(_get_intro_text(language))
         page.add_section_break()

generate_docs/repo.py

@@ -83,7 +83,7 @@ class LanguageCollection:
     def __init__(self, name: str, path: str, file_list: list[str]) -> None:
         """
         Constructs an instance of LanguageCollection.
-        :param name: the name of the language (e.g., Python)
+        :param name: the name of the language (e.g., python)
         :param path: the path of the language (e.g., .../archive/p/python/)
         :param file_list: the list of files in language collection
         """
@@ -100,6 +100,7 @@ def __init__(self, name: str, path: str, file_list: list[str]) -> None:
         self._collect_sample_programs()
         self._analyze_language_collection()
         self._generate_urls()
+        self._organize_collection()
 
     def __str__(self) -> str:
         return self.name + ";" + str(self.total_snippets) + ";" + str(self.total_dir_size)
@@ -131,6 +132,28 @@ def _analyze_language_collection(self) -> None:
     def _generate_urls(self) -> None:
         self.sample_program_url = f"https://sample-programs.therenegadecoder.com/languages/{self.name}"
 
+    def _organize_collection(self):
+        self.sample_programs.sort(key=lambda program: program.language.casefold())
+
+    def get_readable_name(self):
+        """
+        Generates as close to the proper language name as possible given a language
+        name in plain text separated by hyphens
+            EX: google-apps-script -> Google Apps Script
+            EX: c-sharp -> C#
+        :return: a readable representation of the language name
+        """
+        text_to_symbol = {
+            "plus": "+",
+            "sharp": "#",
+            "star": r"\*"
+        }
+        tokens = [text_to_symbol.get(token, token) for token in self.name.split("-")]
+        if any(token in text_to_symbol.values() for token in tokens):
+            return "".join(tokens).title()
+        else:
+            return " ".join(tokens).title()
+
 
 class SampleProgram:
     """

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="generate_docs",
-    version="2.0.0",
+    version="2.0.2",
     author="The Renegade Coder",
     author_email="jeremy.grifski@therenegadecoder.com",
     description="A docs generation package for the Sample Programs repo",