@terpjs/spec 0.14.0 → 0.16.0

package/corpus/backend/no_print/compliant-01/modules/notes/service.py

@@ -1,7 +1,7 @@
-import logging
-
-log = logging.getLogger(__name__)
-
-
-def run():
-    log.info("hello")
+import logging
+
+log = logging.getLogger(__name__)
+
+
+def run():
+    log.info("hello")

package/corpus/backend/no_print/violation-01/modules/notes/service.py

@@ -1,2 +1,2 @@
-def run():
-    print("hello")
+def run():
+    print("hello")

package/corpus/backend/no_raw_app_routes/compliant-01/main.py

@@ -1,12 +1,12 @@
-"""Compliant: the composition root only composes; modules own every route."""
-
-from terp.core import create_app
-
-from app.modules.notes.module import module as notes_module
-
-
-def build():
-    return create_app([notes_module])
-
-
-app = build()
+"""Compliant: the composition root only composes; modules own every route."""
+
+from terp.core import create_app
+
+from app.modules.notes.module import module as notes_module
+
+
+def build():
+    return create_app([notes_module])
+
+
+app = build()

package/corpus/backend/no_raw_app_routes/violation-01/main.py

@@ -1,10 +1,10 @@
-"""Violation: a verb route registered on the composed app bypasses the module guard."""
-
-from terp.core import create_app
-
-app = create_app([])
-
-
-@app.get("/api/v1/hacks/")
-def list_hacks() -> dict:
-    return {}
+"""Violation: a verb route registered on the composed app bypasses the module guard."""
+
+from terp.core import create_app
+
+app = create_app([])
+
+
+@app.get("/api/v1/hacks/")
+def list_hacks() -> dict:
+    return {}

package/corpus/backend/no_raw_app_routes/violation-02/main.py

@@ -1,16 +1,16 @@
-"""Violation: raw surface mounted on the app returned by the composition factory."""
-
-from fastapi import APIRouter
-
-from terp.core import create_app
-
-
-def build():
-    return create_app([])
-
-
-app = build()
-
-router = APIRouter()
-app.include_router(router, prefix="/api/v1/raw")
-app.mount("/static", object())
+"""Violation: raw surface mounted on the app returned by the composition factory."""
+
+from fastapi import APIRouter
+
+from terp.core import create_app
+
+
+def build():
+    return create_app([])
+
+
+app = build()
+
+router = APIRouter()
+app.include_router(router, prefix="/api/v1/raw")
+app.mount("/static", object())

package/corpus/backend/no_raw_app_routes/violation-03/main.py

@@ -1,12 +1,12 @@
-"""Violation: annotated create_app binding plus legacy route decorator."""
-
-from fastapi import FastAPI
-
-from terp.core import create_app
-
-app: FastAPI = create_app([])
-
-
-@app.route("/api/v1/raw")
-def raw(request):
-    return {}
+"""Violation: annotated create_app binding plus legacy route decorator."""
+
+from fastapi import FastAPI
+
+from terp.core import create_app
+
+app: FastAPI = create_app([])
+
+
+@app.route("/api/v1/raw")
+def raw(request):
+    return {}

package/corpus/backend/no_raw_app_routes/violation-04/main.py

@@ -1,10 +1,10 @@
-"""Violation: aliased create_app binding plus websocket route decorator."""
-
-from terp.core import create_app as make_app
-
-app = make_app([])
-
-
-@app.websocket_route("/ws")
-async def ws(websocket):
-    return None
+"""Violation: aliased create_app binding plus websocket route decorator."""
+
+from terp.core import create_app as make_app
+
+app = make_app([])
+
+
+@app.websocket_route("/ws")
+async def ws(websocket):
+    return None

package/corpus/backend/no_raw_app_routes/violation-05/main.py

@@ -1,12 +1,12 @@
-"""Violation: factory returns a local create_app result; app.router adds a route."""
-
-from terp.core import create_app
-
-
-def build():
-    app = create_app([])
-    return app
-
-
-app = build()
-app.router.add_api_route("/api/v1/raw", endpoint, methods=["GET"])
+"""Violation: factory returns a local create_app result; app.router adds a route."""
+
+from terp.core import create_app
+
+
+def build():
+    app = create_app([])
+    return app
+
+
+app = build()
+app.router.add_api_route("/api/v1/raw", endpoint, methods=["GET"])

package/corpus/backend/no_raw_app_routes/violation-06/main.py

@@ -1,10 +1,10 @@
-"""Violation: a lifecycle hook registered on the composed app (ungated executable surface)."""
-
-from terp.core import create_app
-
-app = create_app([])
-
-
-@app.on_event("startup")
-def warm_cache() -> None:
-    pass
+"""Violation: a lifecycle hook registered on the composed app (ungated executable surface)."""
+
+from terp.core import create_app
+
+app = create_app([])
+
+
+@app.on_event("startup")
+def warm_cache() -> None:
+    pass

package/corpus/backend/no_raw_connection_access/compliant-01/modules/notes/service.py

@@ -1,5 +1,5 @@
-from terp.core import BaseService
-
-
-class NoteService(BaseService):
-    model = Note
+from terp.core import BaseService
+
+
+class NoteService(BaseService):
+    model = Note

package/corpus/backend/no_raw_connection_access/violation-01/modules/notes/service.py

@@ -1,2 +1,2 @@
-def purge(session):
-    session.connection().execute('DELETE FROM notes')
+def purge(session):
+    session.connection().execute('DELETE FROM notes')

package/corpus/backend/no_raw_connection_access/violation-02/modules/notes/service.py

@@ -1,2 +1,2 @@
-def purge(session):
-    return session.get_bind()
+def purge(session):
+    return session.get_bind()

package/corpus/backend/no_raw_file_references/compliant-01/modules/notes/models.py

@@ -1,10 +1,10 @@
-import uuid
-
-from sqlmodel import Field
-from terp.capabilities.files import FileRef
-from terp.core import BaseTable
-
-
-class Note(BaseTable, table=True):
-    title: str = Field(max_length=200)
-    attachment_file_id: uuid.UUID | None = FileRef()
+import uuid
+
+from sqlmodel import Field
+from terp.capabilities.files import FileRef
+from terp.core import BaseTable
+
+
+class Note(BaseTable, table=True):
+    title: str = Field(max_length=200)
+    attachment_file_id: uuid.UUID | None = FileRef()

package/corpus/backend/no_raw_file_references/violation-01/modules/notes/models.py

@@ -1,9 +1,9 @@
-import uuid
-
-from sqlmodel import Field
-from terp.core import BaseTable
-
-
-class Note(BaseTable, table=True):
-    title: str = Field(max_length=200)
-    attachment_file_id: uuid.UUID | None = None
+import uuid
+
+from sqlmodel import Field
+from terp.core import BaseTable
+
+
+class Note(BaseTable, table=True):
+    title: str = Field(max_length=200)
+    attachment_file_id: uuid.UUID | None = None

package/corpus/backend/no_raw_outbound_http/compliant-01/modules/notes/service.py

@@ -1,2 +1,2 @@
-from urllib import parse
-from terp.core import BaseService
+from urllib import parse
+from terp.core import BaseService

package/corpus/backend/no_raw_outbound_http/compliant-03/modules/notes/service.py

@@ -1,12 +1,12 @@
-"""Compliant near-misses: names that contain a restricted root without being it.
-
-``socketserver`` is not ``socket``; ``httpx_mock`` is not ``httpx``; a comment
-or string naming a client is not an import.
-"""
-
-from socketserver import BaseRequestHandler
-
-import httpx_mock
-
-# import httpx would be refused here.
-CLIENT_DOC = "outbound calls never 'import requests'; use the declared capability"
+"""Compliant near-misses: names that contain a restricted root without being it.
+
+``socketserver`` is not ``socket``; ``httpx_mock`` is not ``httpx``; a comment
+or string naming a client is not an import.
+"""
+
+from socketserver import BaseRequestHandler
+
+import httpx_mock
+
+# import httpx would be refused here.
+CLIENT_DOC = "outbound calls never 'import requests'; use the declared capability"

package/corpus/backend/no_raw_outbound_http/violation-01/expected-findings.json

@@ -1,7 +1,7 @@
-[
-  {
-    "rule": "backend/no_raw_outbound_http",
-    "path": "modules/notes/service.py",
-    "line": 1
-  }
-]
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 1
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-01/modules/notes/service.py

@@ -1 +1 @@
-import httpx
+import httpx

package/corpus/backend/no_raw_outbound_http/violation-02/expected-findings.json

@@ -1,7 +1,7 @@
-[
-  {
-    "rule": "backend/no_raw_outbound_http",
-    "path": "modules/notes/service.py",
-    "line": 1
-  }
-]
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 1
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-02/modules/notes/service.py

@@ -1 +1 @@
-from urllib.request import urlopen
+from urllib.request import urlopen

package/corpus/backend/no_raw_outbound_http/violation-03/expected-findings.json

@@ -1,7 +1,7 @@
-[
-  {
-    "rule": "backend/no_raw_outbound_http",
-    "path": "modules/notes/service.py",
-    "line": 1
-  }
-]
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 1
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-03/modules/notes/service.py

@@ -1 +1 @@
-import socket
+import socket

package/corpus/backend/no_raw_outbound_http/violation-04/expected-findings.json

@@ -1,12 +1,12 @@
-[
-  {
-    "rule": "backend/no_raw_outbound_http",
-    "path": "modules/notes/service.py",
-    "line": 3
-  },
-  {
-    "rule": "backend/no_raw_outbound_http",
-    "path": "modules/notes/service.py",
-    "line": 4
-  }
-]
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 3
+  },
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 4
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-04/modules/notes/service.py

@@ -1,7 +1,7 @@
-"""Violation: aliased and multiline import forms of raw HTTP clients."""
-
-import urllib.request as transport
-from aiohttp import (
-    ClientSession,
-    ClientTimeout,
-)
+"""Violation: aliased and multiline import forms of raw HTTP clients."""
+
+import urllib.request as transport
+from aiohttp import (
+    ClientSession,
+    ClientTimeout,
+)

package/corpus/backend/no_raw_outbound_http/violation-05/expected-findings.json

@@ -1,12 +1,12 @@
-[
-  {
-    "rule": "backend/no_raw_outbound_http",
-    "path": "modules/notes/service.py",
-    "line": 3
-  },
-  {
-    "rule": "backend/no_raw_outbound_http",
-    "path": "modules/notes/service.py",
-    "line": 5
-  }
-]
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 3
+  },
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 5
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-05/modules/notes/service.py

@@ -1,5 +1,5 @@
-"""Violation: the lower-level escape routes — http.client and an urllib3 submodule."""
-
-from http.client import HTTPSConnection
-
-import urllib3.util
+"""Violation: the lower-level escape routes — http.client and an urllib3 submodule."""
+
+from http.client import HTTPSConnection
+
+import urllib3.util

package/corpus/backend/no_raw_outbound_http/violation-06/expected-findings.json

@@ -1,12 +1,12 @@
-[
-  {
-    "rule": "backend/no_raw_outbound_http",
-    "path": "modules/notes/service.py",
-    "line": 1
-  },
-  {
-    "rule": "backend/no_raw_outbound_http",
-    "path": "modules/notes/service.py",
-    "line": 2
-  }
-]
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 1
+  },
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 2
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-06/modules/notes/service.py

@@ -1,2 +1,2 @@
-import requests
-import aiohttp.client
+import requests
+import aiohttp.client

package/corpus/backend/no_raw_session_construction/compliant-01/modules/notes/service.py

@@ -1,3 +1,3 @@
-from terp.core import SessionDep
-def run(session: SessionDep):
-    return session
+from terp.core import SessionDep
+def run(session: SessionDep):
+    return session

package/corpus/backend/no_raw_session_construction/violation-01/modules/notes/service.py

@@ -1,3 +1,3 @@
-def run(engine):
-    with Session(engine) as s:
-        return s
+def run(engine):
+    with Session(engine) as s:
+        return s

package/corpus/backend/no_star_imports/compliant-01/modules/notes/service.py

@@ -1 +1 @@
-from os.path import join, dirname
+from os.path import join, dirname

package/corpus/backend/no_star_imports/violation-01/modules/notes/service.py

@@ -1 +1 @@
-from os.path import *
+from os.path import *

package/corpus/backend/no_todo_fixme/compliant-01/modules/notes/service.py

@@ -1,3 +1,3 @@
-def run():
-    value = 1  # returns the canonical seed value
-    return value
+def run():
+    value = 1  # returns the canonical seed value
+    return value

package/corpus/backend/no_todo_fixme/violation-01/modules/notes/service.py

@@ -1,3 +1,3 @@
-def run():
-    value = 1  # TODO: finish this later
-    return value
+def run():
+    value = 1  # TODO: finish this later
+    return value

package/corpus/backend/no_unique_columns_on_soft_delete_models/compliant-01/modules/notes/models.py

@@ -1,17 +1,17 @@
-from sqlalchemy import Index, text
-from sqlmodel import Field
-from terp.core import BaseTable, SoftDeleteMixin
-
-
-class Note(BaseTable, SoftDeleteMixin, table=True):
-    __table_args__ = (
-        Index(
-            'uq_note_slug_live',
-            'slug',
-            unique=True,
-            postgresql_where=text('deleted_at IS NULL'),
-            sqlite_where=text('deleted_at IS NULL'),
-        ),
-    )
-
-    slug: str = Field(max_length=80)
+from sqlalchemy import Index, text
+from sqlmodel import Field
+from terp.core import BaseTable, SoftDeleteMixin
+
+
+class Note(BaseTable, SoftDeleteMixin, table=True):
+    __table_args__ = (
+        Index(
+            'uq_note_slug_live',
+            'slug',
+            unique=True,
+            postgresql_where=text('deleted_at IS NULL'),
+            sqlite_where=text('deleted_at IS NULL'),
+        ),
+    )
+
+    slug: str = Field(max_length=80)

package/corpus/backend/no_unique_columns_on_soft_delete_models/violation-01/expected-findings.json

@@ -1,7 +1,7 @@
-[
-  {
-    "rule": "backend/no_unique_columns_on_soft_delete_models",
-    "path": "modules/notes/models.py",
-    "line": 6
-  }
-]
+[
+  {
+    "rule": "backend/no_unique_columns_on_soft_delete_models",
+    "path": "modules/notes/models.py",
+    "line": 6
+  }
+]

package/corpus/backend/no_unique_columns_on_soft_delete_models/violation-01/modules/notes/models.py

@@ -1,6 +1,6 @@
-from sqlmodel import Field
-from terp.core import BaseTable, SoftDeleteMixin
-
-
-class Note(BaseTable, SoftDeleteMixin, table=True):
-    slug: str = Field(max_length=80, unique=True)
+from sqlmodel import Field
+from terp.core import BaseTable, SoftDeleteMixin
+
+
+class Note(BaseTable, SoftDeleteMixin, table=True):
+    slug: str = Field(max_length=80, unique=True)

package/corpus/backend/no_unique_columns_on_soft_delete_models/violation-02/expected-findings.json

@@ -1,7 +1,7 @@
-[
-  {
-    "rule": "backend/no_unique_columns_on_soft_delete_models",
-    "path": "modules/notes/models.py",
-    "line": 11
-  }
-]
+[
+  {
+    "rule": "backend/no_unique_columns_on_soft_delete_models",
+    "path": "modules/notes/models.py",
+    "line": 11
+  }
+]

package/corpus/backend/no_unique_columns_on_soft_delete_models/violation-02/modules/notes/models.py

@@ -1,13 +1,13 @@
-from sqlalchemy import UniqueConstraint
-from sqlmodel import Field
-from terp.core import BaseTable, SoftDeleteMixin
-
-
-class ArchivableRow(BaseTable, SoftDeleteMixin):
-    pass
-
-
-class Note(ArchivableRow, table=True):
-    __table_args__ = (UniqueConstraint('slug'),)
-
-    slug: str = Field(max_length=80)
+from sqlalchemy import UniqueConstraint
+from sqlmodel import Field
+from terp.core import BaseTable, SoftDeleteMixin
+
+
+class ArchivableRow(BaseTable, SoftDeleteMixin):
+    pass
+
+
+class Note(ArchivableRow, table=True):
+    __table_args__ = (UniqueConstraint('slug'),)
+
+    slug: str = Field(max_length=80)

package/corpus/backend/no_unique_columns_on_soft_delete_models/violation-03/expected-findings.json

@@ -1,7 +1,7 @@
-[
-  {
-    "rule": "backend/no_unique_columns_on_soft_delete_models",
-    "path": "modules/notes/models.py",
-    "line": 8
-  }
-]
+[
+  {
+    "rule": "backend/no_unique_columns_on_soft_delete_models",
+    "path": "modules/notes/models.py",
+    "line": 8
+  }
+]