Update app.py

app.py

@@ -78,6 +78,35 @@ PERIOD_REQUIRED = {
     "Other": False
 }
 
+# Document formatting rules
+DOCUMENT_FORMATTING_RULES = {
+    "italics_only": {
+        "types": ["Advisory Circular"],
+        "italics": True, 
+        "quotes": False,
+        "description": "For Advisory Circulars, referenced document titles should be italicized but not quoted",
+        "example": "See AC 20-135, *Powerplant Installation and Propulsion System Component Fire Protection Test Methods, Standards, and Criteria* for information on X."
+    },
+    "quotes_only": {
+        "types": [
+            "Airworthiness Criteria", "Deviation Memo", "Exemption", 
+            "Federal Register Notice", "Order", "Rule", "Special Condition", 
+            "Technical Standard Order"
+        ],
+        "italics": False, 
+        "quotes": True,
+        "description": "For this document type, referenced document titles should be in quotes without italics",
+        "example": 'See AC 20-135, "Powerplant Installation and Propulsion System Component Fire Protection Test Methods, Standards, and Criteria" for information on X.'
+    },
+    "no_formatting": {
+        "types": ["Policy Statement", "Other"],
+        "italics": False, 
+        "quotes": False,
+        "description": "For this document type, referenced document titles should not use italics or quotes",
+        "example": "See AC 20-135, Powerplant Installation and Propulsion System Component Fire Protection Test Methods, Standards, and Criteria for information on X."
+    }
+}
+
 # 1. Base Exception Classes
 class DocumentCheckError(Exception):
     """Base exception for document checker errors."""
@@ -215,8 +244,8 @@ class DocumentCheckerConfig:
         """Initialize configuration with optional config file."""
         self.default_config = {
             "logging": {
-                "level": "INFO",
-                "format": "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+                "level": DEFAULT_LOG_LEVEL,  # Use constant defined at top
+                "format": DEFAULT_LOG_FORMAT  # Use constant defined at top
             },
             "checks": {
                 "acronyms": True,
@@ -637,35 +666,6 @@ def profile_performance(func):
 # 8. FAA Document Checker
 class FAADocumentChecker(DocumentChecker):
     """Document checker implementation for FAA documents."""
-    
-    # Class Constants
-    PERIOD_REQUIRED = {
-        DocumentType.ADVISORY_CIRCULAR: True,
-        DocumentType.AIRWORTHINESS_CRITERIA: False,
-        DocumentType.DEVIATION_MEMO: False,
-        DocumentType.EXEMPTION: False,
-        DocumentType.FEDERAL_REGISTER_NOTICE: False,
-        DocumentType.ORDER: True,
-        DocumentType.POLICY_STATEMENT: False,
-        DocumentType.RULE: False,
-        DocumentType.SPECIAL_CONDITION: False,
-        DocumentType.TECHNICAL_STANDARD_ORDER: True,
-        DocumentType.OTHER: False
-    }
-    
-    HEADING_WORDS = {
-        'INFORMATION', 'GENERAL', 'SUMMARY', 'INTRODUCTION', 'BACKGROUND', 
-        'DISCUSSION', 'CONCLUSION', 'APPENDIX', 'CHAPTER', 'SECTION',
-        'PURPOSE', 'APPLICABILITY', 'CANCELLATION', 'DEFINITION', 'REQUIREMENTS',
-        'AUTHORITY', 'POLICY', 'SCOPE', 'RELATED', 'MATERIAL', 'DISTRIBUTION',
-        'EXPLANATION', 'PROCEDURES', 'NOTE', 'WARNING', 'CAUTION', 'EXCEPTION',
-        'GROUPS', 'PARTS', 'TABLE', 'FIGURE', 'REFERENCES', 'DEFINITIONS'
-    }
-    
-    PREDEFINED_ACRONYMS = {
-        'CFR', 'U.S.', 'USA', 'US', 'U.S.C', 'e.g.', 'i.e.', 'FAQ', 'No.', 'ZIP', 'PDF', 'SSN',
-        'DC', 'MA', 'WA', 'TX', 'MO'
-    }
 
     # Constructor
     def __init__(self, config_path: Optional[str] = None):
@@ -777,22 +777,7 @@ class FAADocumentChecker(DocumentChecker):
                 issues=[{'error': f'Unsupported document type: {doc_type}'}]
             )
 
-        # Define document types requiring periods in headings
-        period_required = {
-            "Advisory Circular": True,
-            "Airworthiness Criteria": False,
-            "Deviation Memo": False,
-            "Exemption": False,
-            "Federal Register Notice": False,
-            "Order": True,
-            "Policy Statement": False,
-            "Rule": False,
-            "Special Condition": False,
-            "Technical Standard Order": True,
-            "Other": False
-        }
-
-        should_have_period = period_required.get(doc_type)
+        should_have_period = PERIOD_REQUIRED.get(doc_type)
         if should_have_period is None:
             self.logger.error(f"Period requirement not defined for document type: {doc_type}")
             return DocumentCheckResult(
@@ -2064,6 +2049,31 @@ class DocumentCheckResultsFormatter:
         Returns:
             str: Formatted report with consistent styling
         """
+        format_group = None
+        for group, rules in DOCUMENT_FORMATTING_RULES.items():
+            if doc_type in rules["types"]:
+                format_group = rules
+                break
+
+        # Use default if document type not found
+        if not format_group:
+            format_group = DOCUMENT_FORMATTING_RULES["no_formatting"]
+
+        # Update the document title check category with global rules
+        self.issue_categories['document_title_check'] = {
+            'title': 'Referenced Document Title Format Issues',
+            'description': format_group['description'],
+            'solution': "Format referenced document titles as follows: " + (
+                "Italicize the title" if format_group['italics'] else 
+                "Put the title in quotes" if format_group['quotes'] else 
+                "No special formatting required"
+            ),
+            'example_fix': {
+                'before': 'See AC 20-135, Powerplant Installation for information on X.',
+                'after': format_group['example']
+            }
+        }
+
         # Determine caption format based on document type
         if doc_type in ["Advisory Circular", "Order"]:
             table_format = {
@@ -2107,61 +2117,6 @@ class DocumentCheckResultsFormatter:
         # Update the issue categories with the correct format
         self.issue_categories['caption_check_table'] = table_format
         self.issue_categories['caption_check_figure'] = figure_format
-
-        # Define formatting rules for different document types
-        formatting_rules = {
-            "italics_only": {
-                "types": ["Advisory Circular"],
-                "italics": True, 
-                "quotes": False,
-                "description": "For Advisory Circulars, referenced document titles should be italicized but not quoted",
-                "example": "See AC 20-135, *Powerplant Installation and Propulsion System Component Fire Protection Test Methods, Standards, and Criteria* for information on X."
-            },
-            "quotes_only": {
-                "types": [
-                    "Airworthiness Criteria", "Deviation Memo", "Exemption", 
-                    "Federal Register Notice", "Order", "Rule", "Special Condition", 
-                    "Technical Standard Order"
-                ],
-                "italics": False, 
-                "quotes": True,
-                "description": "For this document type, referenced document titles should be in quotes without italics",
-                "example": 'See AC 20-135, "Powerplant Installation and Propulsion System Component Fire Protection Test Methods, Standards, and Criteria" for information on X.'
-            },
-            "no_formatting": {
-                "types": ["Policy Statement", "Other"],
-                "italics": False, 
-                "quotes": False,
-                "description": "For this document type, referenced document titles should not use italics or quotes",
-                "example": "See AC 20-135, Powerplant Installation and Propulsion System Component Fire Protection Test Methods, Standards, and Criteria for information on X."
-            }
-        }
-
-        # Find the formatting group for the current document type
-        format_group = None
-        for group, rules in formatting_rules.items():
-            if doc_type in rules["types"]:
-                format_group = rules
-                break
-
-        # Use default if document type not found
-        if not format_group:
-            format_group = formatting_rules["no_formatting"]
-
-        # Update the document title check category
-        self.issue_categories['document_title_check'] = {
-            'title': 'Referenced Document Title Format Issues',
-            'description': format_group['description'],
-            'solution': "Format referenced document titles as follows: " + (
-                "Italicize the title" if format_group['italics'] else 
-                "Put the title in quotes" if format_group['quotes'] else 
-                "No special formatting required"
-            ),
-            'example_fix': {
-                'before': 'See AC 20-135, Powerplant Installation for information on X.',
-                'after': format_group['example']
-            }
-        }
         
         output = []