Merge pull request #289 from ma10/refactor-yaml2x-20250308

yaml2xのリファクタリング

Author: ma10

build.mk

@@ -1,6 +1,6 @@
 rootdir = $(ROOTDIR)
-PYTHON?= python
-YAML2RST= $(PYTHON) $(rootdir)/tools/yaml2x/yaml2rst/yaml2rst.py -b $(rootdir) -l $(lang)
+#PYTHON?= python
+YAML2RST= yaml2rst -b $(rootdir) -l $(lang)
 
 ifneq ($(BASE_URL),)
 html_baseurl = $(BASE_URL)

requirements.txt

@@ -2,13 +2,8 @@ wheel
 sphinx >= 3.0
 sphinx_rtd_theme
 sphinxcontrib-trimblank
-pyyaml
-toml
 jsonschema < 4.18.0
-GitPython
 sphinx-lint
-google-auth-oauthlib
-google-api-python-client
 pytz
-pydantic
-tools/yaml2x/libs/freee_a11y_gl
+tools/lib/freee_a11y_gl
+tools/scripts/yaml2rst

tools/yaml2x/libs/freee_a11y_gl/pyproject.toml tools/lib/freee_a11y_gl/pyproject.toml

@@ -10,6 +10,11 @@ authors = [
     {name = "Masafumi NAKANE", email = "[email protected]"}
 ]
 requires-python = ">=3.8"
+dependencies = [
+    "pyyaml>=6.0",
+    "gitpython>=3.1.43",
+    "pydantic>=2.7.0"
+]
 
 [tool.setuptools]
-packages = { find = {} }
+package-dir = { "" = "src" }

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/__init__.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/__init__.py

@@ -41,34 +41,42 @@ locale:
     pass_plural_text: " are true"    # Pass condition text for multiple conditions
     date_format: "%B %-d, %Y"        # Date format in strftime format
 
-# Validation settings
-# Check severity levels and their display names
+# Severity tags configuration
 severity_tags:
   ja:
-    must: "必須"
-    should: "推奨"
+    minor: "[MINOR]"
+    normal: "[NORMAL]"
+    major: "[MAJOR]"
+    critical: "[CRITICAL]"
   en:
-    must: "Must"
-    should: "Should"
+    minor: "[MINOR]"
+    normal: "[NORMAL]"
+    major: "[MAJOR]"
+    critical: "[CRITICAL]"
 
-# Check target types and their display names
+# Check targets configuration
 check_targets:
   ja:
-    code: "コード"        # For code-level checks
-    content: "コンテンツ"  # For content-level checks
+    design: "デザイン"
+    code: "コード"
+    product: "プロダクト"
   en:
-    code: "Code"         # For code-level checks
-    content: "Content"   # For content-level checks
+    design: "Design"
+    code: "Code"
+    product: "Product"
 
 # Platform settings
 platform:
-  # Platform display names used for both platform indication and implementation targets
   names:
     ja:
-      web: "Webアプリケーション"       # Web application specific
-      mobile: "モバイルアプリケーション" # Mobile application specific
-      general: "全般"                 # Platform independent
+      web: "Web"
+      mobile: "モバイル"
+      general: "全般"
+      ios: "iOS"
+      android: "Android"
     en:
-      web: "Web Application"         # Web application specific
-      mobile: "Mobile Application"   # Mobile application specific
-      general: "General"            # Platform independent
+      web: "Web"
+      mobile: "Mobile"
+      general: "General"
+      ios: "iOS"
+      android: "Android"

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/config.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/config.py

@@ -8,15 +8,15 @@
 
 class LocaleConfig(BaseModel):
     """Locale-specific configuration."""
-    text_separator: str = Field(default=": ", description="Text separator for the category and the title for guideline links")
-    list_separator: str = Field(default=", ", description="List item separator")
-    and_separator: str = Field(default=" and ", description="AND conjunction")
-    or_separator: str = Field(default=" or ", description="OR conjunction")
-    and_conjunction: str = Field(default=", and ", description="AND conjunction for grouped items")
-    or_conjunction: str = Field(default=", or ", description="OR conjunction for grouped items")
-    pass_singular_text: str = Field(default=" is true", description="Pass condition text for single condition")
-    pass_plural_text: str = Field(default=" are true", description="Pass condition text for multiple conditions")
-    date_format: str = Field(default="%B %-d, %Y", description="Date format in strftime format")
+    text_separator: str = Field(description="Text separator for the category and the title for guideline links")
+    list_separator: str = Field(description="List item separator")
+    and_separator: str = Field(description="AND conjunction")
+    or_separator: str = Field(description="OR conjunction")
+    and_conjunction: str = Field(description="AND conjunction for grouped items")
+    or_conjunction: str = Field(description="OR conjunction for grouped items")
+    pass_singular_text: str = Field(description="Pass condition text for single condition")
+    pass_plural_text: str = Field(description="Pass condition text for multiple conditions")
+    date_format: str = Field(description="Date format in strftime format")
 
 class LanguageConfig(BaseModel):
     """Language configuration."""

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/config.yaml.sample tools/lib/freee_a11y_gl/src/freee_a11y_gl/config.yaml.sample

@@ -0,0 +1 @@
+graft src/yaml2rst/templates

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/constants.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/constants.py

@@ -0,0 +1,28 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "yaml2rst"
+version = "0.1.0"
+description = "Process YAML files into reStructuredText to e included in the guidelines document."
+readme = "README.md"
+authors = [
+    { name = "Masafumi NAKANE", email = "[email protected]" }
+]
+dependencies = [
+    "jinja2",
+    "freee_a11y_gl>=0.1.0",
+]
+requires-python = ">=3.8"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["yaml2rst*"]
+
+[project.scripts]
+yaml2rst = "yaml2rst.yaml2rst:main"

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/info_utils.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/info_utils.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/initializer.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/initializer.py

@@ -0,0 +1,5 @@
+"""Main entry point for yaml2rst when run with python -m yaml2rst."""
+from .yaml2rst import main
+
+if __name__ == '__main__':
+    main()

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/models/__init__.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/models/__init__.py

@@ -0,0 +1,34 @@
+"""Package for RST file generation components."""
+from .base_generator import BaseGenerator, GeneratorError, ValidationError
+from .file_generator import FileGenerator, GeneratorConfig
+from .common_generators import ListBasedGenerator, SingleFileGenerator
+from .content_generators import (
+    CategoryGenerator,
+    AllChecksGenerator, CheckExampleGenerator,
+    FaqArticleGenerator, FaqTagPageGenerator, FaqIndexGenerator,
+    FaqTagIndexGenerator, FaqArticleIndexGenerator,
+    WcagMappingGenerator, PriorityDiffGenerator, MiscDefinitionsGenerator,
+    InfoToGuidelinesGenerator, InfoToFaqsGenerator,
+    AxeRulesGenerator,
+    MakefileGenerator,
+    MakefileConfig
+)
+
+__all__ = [
+    'BaseGenerator',
+    'GeneratorError',
+    'ValidationError',
+    'FileGenerator',
+    'GeneratorConfig',
+    'ListBasedGenerator',
+    'SingleFileGenerator',
+    'CategoryGenerator',
+    'AllChecksGenerator, CheckExampleGenerator',
+    'FaqArticleGenerator, FaqTagPageGenerator, FaqIndexGenerator',
+    'FaqTagIndexGenerator, FaqArticleIndexGenerator',
+    'WcagMappingGenerator, PriorityDiffGenerator, MiscDefinitionsGenerator',
+    'InfoToGuidelinesGenerator, InfoToFaqsGenerator',
+    'AxeRulesGenerator',
+    'MakefileGenerator',
+    'MakefileConfig'
+]

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/models/axe.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/models/axe.py

@@ -5,7 +5,7 @@
 from pathlib import Path
 import logging
 
-from template_manager import TemplateManager
+from ..template_manager import TemplateManager
 from .base_generator import BaseGenerator, GeneratorError
 
 @dataclass(frozen=True)

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/models/base.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/models/base.py

@@ -1,9 +1,9 @@
 import os
 import argparse
-import config
-from path import get_dest_dirnames, get_static_dest_files, TEMPLATE_DIR, TEMPLATE_FILENAMES
+from . import config
+from .path import get_dest_dirnames, get_static_dest_files, TEMPLATE_DIR, TEMPLATE_FILENAMES
 from freee_a11y_gl.source import get_src_path
-from template_manager import TemplateManager
+from .template_manager import TemplateManager
 
 def setup_parameters():
     args = parse_args()

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/models/check.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/models/check.py

@@ -1,5 +1,5 @@
 import os
-from config import AVAILABLE_LANGUAGES
+from .config import AVAILABLE_LANGUAGES
 from freee_a11y_gl.source import DATA_DIR, YAML_DIR, JSON_DIR
 from freee_a11y_gl.constants import AXE_CORE
 

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/models/content.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/models/content.py

@@ -4,9 +4,9 @@
 import os
 from pathlib import Path
 
-import initializer
-from generators.file_generator import FileGenerator, GeneratorConfig
-from generators.content_generators import (
+from . import initializer
+from .generators.file_generator import FileGenerator, GeneratorConfig
+from .generators.content_generators import (
     CategoryGenerator,
     AllChecksGenerator, CheckExampleGenerator,
     FaqArticleGenerator, FaqTagPageGenerator, FaqIndexGenerator,

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/models/faq/__init__.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/models/faq/__init__.py

@@ -0,0 +1 @@
+include src/yaml2sheet/*.sample

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/models/faq/article.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/models/faq/article.py

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "yaml2sheet"
+version = "0.1.0"
+description = "Generate checklist in Google Sheets from YAML data"
+readme = "README.md"
+authors = [
+    { name = "Masafumi NAKANE", email = "[email protected]" }
+]
+dependencies = [
+    "google-api-python-client",
+    "google-auth-oauthlib",
+    "sphinx",
+    "toml",
+    "freee_a11y_gl>=0.1.0"
+]
+requires-python = ">=3.8"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["yaml2sheet*"]
+
+[project.scripts]
+yaml2sheet = "yaml2sheet.yaml2sheet:main"

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/models/faq/tag.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/models/faq/tag.py

@@ -0,0 +1,8 @@
+"""Generate checklist in Google Sheets from YAML data."""
+
+from .yaml2sheet import main
+from .config_loader import ApplicationConfig
+from .auth import GoogleAuthManager
+from .sheet_generator import ChecklistSheetGenerator
+
+__version__ = "0.1.0"

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/models/reference.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/models/reference.py

@@ -0,0 +1,5 @@
+"""Command line entry point for yaml2sheet."""
+from .yaml2sheet import main
+
+if __name__ == '__main__':
+    main()

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/relationship_manager.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/relationship_manager.py

@@ -1,5 +1,5 @@
 from typing import Dict, List
-from config import M17nField, Condition, COLUMNS
+from .config import M17nField, Condition, COLUMNS
 
 class ConditionFormatter:
     """Handles creation and formatting of conditional formulas for sheet cells"""

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/settings.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/settings.py

@@ -1,7 +1,7 @@
 from typing import Dict, List, Any
 import logging
-from config import TARGET_NAMES, M17nField
-from sheet_structure import CheckInfo
+from .config import TARGET_NAMES, M17nField, COLUMNS
+from .sheet_structure import CheckInfo
 
 logger = logging.getLogger(__name__)
 
@@ -70,7 +70,6 @@ def _has_generated_data(self, sheet_names: List[str]) -> bool:
         Returns:
             bool: True if any sheets require generated data
         """
-        from config import COLUMNS
         return any(
             bool(COLUMNS[name]['generatedData'])
             for name in sheet_names

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/source.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/source.py

@@ -1,7 +1,7 @@
 from typing import Dict, List, Optional
 import logging
-from sheet_structure import SheetStructure
-from config import CHECK_RESULTS, FINAL_CHECK_RESULTS
+from .sheet_structure import SheetStructure
+from .config import CHECK_RESULTS, FINAL_CHECK_RESULTS, COLUMNS
 
 logger = logging.getLogger(__name__)
 
@@ -128,7 +128,6 @@ def get_result_column_index(self) -> int:
         Returns:
             int: Index of result column
         """
-        from config import COLUMNS
         return len(COLUMNS['idCols']) + len(COLUMNS[self.current_target]['generatedData'])
 
     def add_protection_settings(self, sheet_id: int, sheet: SheetStructure) -> List[Dict]:
@@ -141,8 +140,6 @@ def add_protection_settings(self, sheet_id: int, sheet: SheetStructure) -> List[
         Returns:
             List[Dict]: List of protection requests
         """
-        from config import COLUMNS
-        
         requests = []
         data_length = len(sheet.data)
 

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/utils.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/utils.py

@@ -4,13 +4,13 @@
 from google.oauth2.credentials import Credentials
 from googleapiclient.discovery import build
 
-from config import TARGET_NAMES, LANGS, COLUMN_INFO, CHECK_RESULTS, FINAL_CHECK_RESULTS, COLUMNS
-from sheet_structure import SheetStructure, CheckInfo
-from cell_data import CellData, CellType
-from condition_formatter import ConditionFormatter
-from sheet_formatter import SheetFormatter
-from data_processor import DataProcessor
-from utils import create_version_info_request, adjust_sheet_size
+from .config import TARGET_NAMES, LANGS, COLUMN_INFO, CHECK_RESULTS, FINAL_CHECK_RESULTS, COLUMNS
+from .sheet_structure import SheetStructure, CheckInfo
+from .cell_data import CellData, CellType
+from .condition_formatter import ConditionFormatter
+from .sheet_formatter import SheetFormatter
+from .data_processor import DataProcessor
+from .utils import create_version_info_request, adjust_sheet_size
 
 logger = logging.getLogger(__name__)
 
@@ -423,7 +423,7 @@ def _add_plain_data_columns(
             lang: Language code
             row_data: Row data to append to
         """
-        from utils import l10n_string
+        from .utils import l10n_string
 
         plain_headers = [
             *COLUMNS['common']['plainData1'],

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/version_utils.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/version_utils.py

@@ -1,6 +1,6 @@
 from typing import List, Dict, Optional
 from dataclasses import dataclass, field
-from cell_data import CellData
+from .cell_data import CellData
 
 @dataclass
 class ColumnProperties:

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/yaml_processor/__init__.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/yaml_processor/__init__.py

@@ -1,5 +1,5 @@
 from typing import Dict, List, Any, Union
-from config import M17nField
+from .config import M17nField
 
 def format_statement_summary(statement: M17nField) -> M17nField:
     """Format a check statement summary into a complete sentence

tools/yaml2x/libs/freee_a11y_gl/freee_a11y_gl/yaml_processor/process_yaml.py tools/lib/freee_a11y_gl/src/freee_a11y_gl/yaml_processor/process_yaml.py

@@ -4,9 +4,9 @@
 import argparse
 from typing import Optional
 from pathlib import Path
-from auth import GoogleAuthManager
-from sheet_generator import ChecklistSheetGenerator
-from config_loader import load_configuration, ApplicationConfig
+from .auth import GoogleAuthManager
+from .sheet_generator import ChecklistSheetGenerator
+from .config_loader import load_configuration, ApplicationConfig
 from googleapiclient.errors import HttpError
 from google.oauth2.credentials import Credentials