Add untestable reason and info about naming convention (#27)

* Add untestable reason and info about naming convention

* Don't display glotter2 info for untestable

Author: rzuckerm

poetry.lock

@@ -2,7 +2,7 @@
 [tool.poetry]
 name = "ronbun"
 description = "The Sample Programs README Automation Tool"
-version = "0.7.4"
+version = "0.8.0"
 license = "MIT"
 
 authors = [
@@ -14,16 +14,15 @@ homepage = "https://therenegadecoder.com"
 repository = "https://github.com/TheRenegadeCoder/sample-programs-readmes"
 
 classifiers=[
-   "Programming Language :: Python :: 3.9",
     "Operating System :: OS Independent",
     "Development Status :: 5 - Production/Stable",
     "License :: OSI Approved :: MIT License"
 ]
 
 [tool.poetry.dependencies]
 python = "^3.8"
-snakemd = "^2.2.0b1"
-subete = "^0.16"
+snakemd = "^2.2.0"
+subete = "^0.18.0"
 
 [tool.poetry.group.test.dependencies]
 coverage = "^7.2"

pyproject.toml

@@ -1,3 +1,4 @@
+from __future__ import annotations
 import argparse
 import logging
 import ssl
@@ -12,6 +13,13 @@
 
 issue_url_template_base = "https://github.com/TheRenegadeCoder/sample-programs/issues/new"
 issue_url_template_query = "?assignees=&labels=enhancement,{label}&template=code-snippet-request.md&title=Add+{project}+in+{language}"
+naming_conventions = {
+    "camel": "helloWorld",
+    "hyphen": "hello-world",
+    "lower": "helloworld",
+    "pascal": "HelloWorld",
+    "underscore": "hello_world"
+}
 
 
 def main():
@@ -207,24 +215,46 @@ def _build_readme(self, language: LanguageCollection) -> None:
         # Testing
         page.add_heading("Testing", level=2)
         test_data = language.testinfo()
-        if not test_data:
+        untestable_data = language.untestable_info()
+        if test_data:
+            extension = test_data["folder"]["extension"]
+            naming = test_data["folder"]["naming"]
             page.add_paragraph(
-                """
-                This language currently does not feature testing. If you'd like to help in the efforts to test all of 
-                the code in this repo, consider creating a testinfo.yml file with the following information:
-                """
+                f"The following list shares details about how we name all Sample Programs in {language}:"
             )
-            page.add_code("folder:\n  extension:\n  naming:\n\ncontainer:\n  image:\n  tag:\n  cmd:", lang="yml")
-        else:
+            page.add_unordered_list([
+                f"Extension: {extension}",
+                f"Naming Convention: {naming}"
+            ])
+
+            page.add_paragraph('For example, the "Hello World" sample would be named this:')
+            page.add_unordered_list([f"{naming_conventions[naming]}{extension}"])
+
             page.add_paragraph(
-                f"The following list shares details about what we're using to test all Sample Programs in {language}."
+                f"The following list shares details about what we're using to test all Sample Programs in {language}:"
             )
             page.add_unordered_list([
                 f"Docker Image: {test_data['container']['image']}",
                 f"Docker Tag: {test_data['container']['tag']}"
             ])
-        glotter = page.add_paragraph("See the Glotter2 project for more information on how to create a testinfo file.")
-        glotter.insert_link("Glotter2 project", "https://github.com/rzuckerm/glotter2")
+        elif untestable_data:
+                page.add_paragraph(
+                    f"{language} cannot be tested for the following reason:"
+                )
+                page.add_unordered_list([untestable_data[0]["reason"]])
+        else:
+            page.add_paragraph(
+                """
+                This language currently does not feature testing. If you'd like to help in the efforts to test all of 
+                the code in this repo, consider creating a testinfo.yml file with the following information:
+                """
+            )
+            page.add_code("folder:\n  extension:\n  naming:\n\ncontainer:\n  image:\n  tag:\n  cmd:", lang="yml")
+
+        if not untestable_data:
+            glotter = page.add_paragraph("See the Glotter2 project for more information on how to create a testinfo file.")
+            glotter.insert_link("Glotter2 project", "https://github.com/rzuckerm/glotter2")
+
         page.add_horizontal_rule()
         page.add_block(_generate_credit())