speclogician 0.0.0b1__py3-none-any.whl

speclogician/presentation/models/state_instance_summary.py

@@ -0,0 +1,102 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/state_instance_summary.py
+#
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+from typing import Optional
+
+
+class StateInstanceSummaryPM(BaseModel):
+    # -----------------
+    # metadata
+    # -----------------
+    created_at: Optional[str] = None
+
+    # -----------------
+    # changes
+    # -----------------
+    num_changes: int = 0
+
+    # -----------------
+    # Domain model (base)
+    # -----------------
+    base_status: Optional[str] = None
+    base_has_state: Optional[bool] = None
+    base_has_action: Optional[bool] = None
+
+    # -----------------
+    # Domain model (state predicates)
+    # -----------------
+    num_state_preds_total: Optional[int] = None
+    num_state_preds_matched: Optional[int] = None
+    num_state_preds_valid_logic: Optional[int] = None
+    num_state_preds_errored: Optional[int] = None
+
+    # -----------------
+    # Domain model (action predicates)
+    # -----------------
+    num_action_preds_total: Optional[int] = None
+    num_action_preds_matched: Optional[int] = None
+    num_action_preds_valid_logic: Optional[int] = None
+    num_action_preds_errored: Optional[int] = None
+
+    # -----------------
+    # Domain model (predicate totals)
+    # -----------------
+    num_preds_total: Optional[int] = None
+    num_preds_matched: Optional[int] = None
+    num_preds_valid_logic: Optional[int] = None
+    num_preds_errored: Optional[int] = None
+
+    # -----------------
+    # Domain model (transitions)
+    # -----------------
+    num_trans_total: Optional[int] = None
+    num_trans_matched: Optional[int] = None
+    num_trans_valid_logic: Optional[int] = None
+    num_trans_errored: Optional[int] = None
+
+    # -----------------
+    # Scenarios
+    # -----------------
+    num_sc_total: Optional[int] = None
+    num_sc_missing: Optional[int] = None
+    num_sc_matched: Optional[int] = None
+    num_sc_inconsistent: Optional[int] = None
+
+    # -----------------
+    # Conflicts (spec-level)
+    # -----------------
+    num_sc_conflicted: Optional[int] = None
+    num_sc_overlap: Optional[int] = None
+    num_sc_consumed: Optional[int] = None
+
+    # -----------------
+    # Test traces
+    # -----------------
+    num_test_traces_total: Optional[int] = None
+    num_test_traces_matched: Optional[int] = None
+    num_test_traces_logic_good: Optional[int] = None
+
+    # -----------------
+    # Log traces
+    # -----------------
+    num_log_traces_total: Optional[int] = None
+    num_log_traces_matched: Optional[int] = None
+    num_log_traces_logic_good: Optional[int] = None
+
+    # -----------------
+    # Source code artifacts
+    # -----------------
+    num_src_code_arts_total: Optional[int] = None
+    num_src_code_arts_matched: Optional[int] = None
+
+    # -----------------
+    # Doc artifacts
+    # -----------------
+    num_doc_arts_total: Optional[int] = None
+    num_doc_arts_matched: Optional[int] = None

speclogician/presentation/models/trace.py

@@ -0,0 +1,42 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/trace.py
+# 
+
+from __future__ import annotations
+
+from typing import Literal
+from pydantic import BaseModel
+
+
+class TraceIMLValidityPM(BaseModel):
+    iml_valid: str  # "unknown" | "valid" | "invalid"
+    err: str | None = None
+
+
+class TraceCorePM(BaseModel):
+    art_id: str
+    given: str
+    when: str | None = None
+    then: str | None = None
+    time: str = ""
+    iml_validity: TraceIMLValidityPM
+
+
+class TestTracePM(BaseModel):
+    kind: Literal["test_trace"] = "test_trace"
+    core: TraceCorePM
+
+    name: str
+    filepath: str = ""
+    language: str | None = None
+    contents: str | None = None  # optional / heavy
+
+
+class LogTracePM(BaseModel):
+    kind: Literal["log_trace"] = "log_trace"
+    core: TraceCorePM
+
+    filename: str
+    contents: str | None = None  # optional / heavy

speclogician/presentation/preview/__init__.py

@@ -0,0 +1,13 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/preview/__init__.py
+#
+
+from __future__ import annotations
+
+from .cli import app as preview_app
+
+__all__ = [
+    "preview_app"
+]

speclogician/presentation/preview/cli.py

@@ -0,0 +1,50 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/preview/cli.py
+#
+
+from __future__ import annotations
+
+import json
+import typer
+
+from speclogician.presentation.ctx import RenderCtx
+from speclogician.presentation.preview.registry import get, list_previews
+from speclogician.presentation.preview.fixtures import register_fixtures
+from speclogician.utils import console  # your rich console
+
+
+app = typer.Typer(help="Preview PM renderers using synthetic fixtures.")
+
+
+@app.command("list")
+def list_cmd() -> None:
+    register_fixtures()
+    for spec in sorted(list_previews(), key=lambda s: s.name):
+        console.print(f"[bold]{spec.name}[/bold]  variants={', '.join(spec.variants)}")
+
+
+@app.command("show")
+def show_cmd(
+    name: str = typer.Argument(..., help="Preview name (see: preview list)"),
+    variant: str = typer.Argument("typical", help="Variant: typical|minimal|edge"),
+    json_only: bool = typer.Option(False, "--json", help="Dump PM as JSON instead of rendering."),
+    compact: bool = typer.Option(False, "--compact", help="Use compact rendering."),
+) -> None:
+    register_fixtures()
+
+    ctx = RenderCtx(compact=compact)
+    spec = get(name)
+
+    if variant not in spec.variants:
+        raise typer.BadParameter(f"Unknown variant '{variant}'. Choose one of: {', '.join(spec.variants)}")
+
+    pm = spec.make(ctx, variant)
+
+    if json_only:
+        # Pydantic v2
+        typer.echo(json.dumps(pm.model_dump(), indent=2, default=str))
+        raise typer.Exit(0)
+
+    console.print(spec.render(pm, ctx))

speclogician/presentation/preview/fixtures/__init__.py

@@ -0,0 +1,205 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/preview/fixtures/__init__.py
+#
+
+from __future__ import annotations
+
+from speclogician.presentation.preview.registry import PreviewSpec, register
+
+from . import state_diff
+from . import state_instance_summary
+from . import trace
+from . import data_artifact
+from . import artifact_container
+from . import predicate
+from . import scenario
+from . import domain_model
+from . import instances_list
+from . import spec
+from . import smart_find
+from . import state_instance
+
+
+def register_fixtures() -> None:
+
+    # ------------------------------------------------------------------
+    # State-level fixtures (already present)
+    # ------------------------------------------------------------------
+
+    register(
+        PreviewSpec(
+            name="state-diff",
+            variants=("typical", "minimal", "edge"),
+            make=state_diff.make_state_diff_pm,
+            render=state_diff.render,
+        )
+    )
+
+    register(
+        PreviewSpec(
+            name="state-instance-summary",
+            variants=("typical", "minimal", "edge"),
+            make=state_instance_summary.make_state_instance_summary_pm,
+            render=state_instance_summary.render,
+        )
+    )
+
+    # ------------------------------------------------------------------
+    # Trace fixtures
+    # ------------------------------------------------------------------
+
+    register(
+        PreviewSpec(
+            name="test-trace",
+            variants=("typical", "minimal", "edge"),
+            make=trace.make_test_trace_pm,
+            render=trace.render_test,
+        )
+    )
+
+    register(
+        PreviewSpec(
+            name="log-trace",
+            variants=("typical", "minimal", "edge"),
+            make=trace.make_log_trace_pm,
+            render=trace.render_log,
+        )
+    )
+
+    # ------------------------------------------------------------------
+    # Data artifact fixtures
+    # ------------------------------------------------------------------
+
+
+    register(
+        PreviewSpec(
+            name="doc-ref",
+            variants=("typical", "minimal", "edge"),
+            make=data_artifact.make_doc_ref_pm,
+            render=data_artifact.render_doc,
+        )
+    )
+
+    register(
+        PreviewSpec(
+            name="src-code-ref",
+            variants=("typical", "minimal", "edge"),
+            make=data_artifact.make_src_code_ref_pm,
+            render=data_artifact.render_src,
+        )
+    )
+
+    # ------------------------------------------------------------------
+    # Artifact container fixtures
+    # ------------------------------------------------------------------
+
+    register(
+        PreviewSpec(
+            name="artifact-container",
+            variants=("typical", "minimal", "edge"),
+            make=artifact_container.make_artifact_container_pm,
+            render=artifact_container.render,
+        )
+    )   
+
+    # ------------------------------------------------------------------
+    # Predicate/Transition fixtures
+    # ------------------------------------------------------------------
+
+    register(
+        PreviewSpec(
+            name="predicate",
+            variants=("typical", "minimal", "edge"),
+            make=predicate.make_predicate_pm,
+            render=predicate.render_predicate,
+        )
+    )
+
+    register(
+        PreviewSpec(
+            name="transition",
+            variants=("typical", "minimal", "edge"),
+            make=predicate.make_transition_pm,
+            render=predicate.render_transition,
+        )
+    )
+
+    # ------------------------------------------------------------------
+    # Scenario fixture
+    # ------------------------------------------------------------------
+
+    register(
+        PreviewSpec(
+            name="scenario",
+            variants=("typical", "minimal", "edge"),
+            make=scenario.make_scenario_pm,
+            render=scenario.render,
+        )
+    )
+
+    # ------------------------------------------------------------------
+    # DomainModel fixture
+    # ------------------------------------------------------------------
+
+    register(
+        PreviewSpec(
+            name="domain-model",
+            variants=("typical", "minimal", "edge"),
+            make=domain_model.make_domain_model_pm,
+            render=domain_model.render,
+        )
+    )
+
+    # ------------------------------------------------------------------
+    # InstancesList fixture
+    # ------------------------------------------------------------------
+
+    register(
+        PreviewSpec(
+            name="instances-list",
+            variants=("typical", "minimal", "edge"),
+            make=instances_list.make_instances_list_pm,
+            render=instances_list.render,
+        )
+    )
+
+    # ------------------------------------------------------------------
+    # Spec fixture
+    # ------------------------------------------------------------------
+
+    register(
+        PreviewSpec(
+            name="spec",
+            variants=("typical", "minimal", "edge"),
+            make=spec.make_spec_pm,
+            render=spec.render,
+        )
+    )
+
+    # ------------------------------------------------------------------
+    # SmartFind
+    # ------------------------------------------------------------------
+    register(
+        PreviewSpec(
+            name="smart-find",
+            variants=("typical", "minimal", "edge"),
+            make=smart_find.make_smart_find_pm,
+            render=smart_find.render,
+        )
+    )
+
+
+    # ------------------------------------------------------------------
+    # SmartFind
+    # ------------------------------------------------------------------
+
+    register(
+        PreviewSpec(
+            name="state-instance",
+            variants=("typical", "minimal", "edge"),
+            make=state_instance.make_state_instance_pm,
+            render=state_instance.render,
+        )
+    )

speclogician/presentation/preview/fixtures/artifact_container.py

@@ -0,0 +1,150 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/preview/fixtures/artifact_container.py
+#
+
+from __future__ import annotations
+from speclogician.presentation.ctx import RenderCtx
+
+from speclogician.presentation.models.container import (
+    ArtifactContainerPM,
+    ArtifactContainerCountsPM,
+    ArtifactContainerItemsPM,
+)
+
+# reuse existing fixtures
+from speclogician.presentation.preview.fixtures.trace import (
+    minimal_test_trace_pm,
+    typical_test_trace_pm,
+    edge_test_trace_pm,
+    minimal_log_trace_pm,
+    typical_log_trace_pm,
+    edge_log_trace_pm,
+)
+
+from speclogician.presentation.preview.fixtures.data_artifact import (
+    minimal_doc_ref_pm,
+    typical_doc_ref_pm,
+    edge_doc_ref_pm,
+    minimal_src_code_ref_pm,
+    typical_src_code_ref_pm,
+    edge_src_code_ref_pm,
+)
+
+
+# -----------------------------------------------------------------------------
+# helpers
+# -----------------------------------------------------------------------------
+
+def _counts_from_items(items: ArtifactContainerItemsPM) -> ArtifactContainerCountsPM:
+    # totals
+    num_test_total = len(items.test_traces)
+    num_log_total = len(items.log_traces)
+    num_doc_total = len(items.doc_refs)
+    num_src_total = len(items.src_code_refs)
+
+    # matched / logic_good are not explicitly present on PMs yet,
+    # so we keep these deterministic for fixtures. You can refine
+    # this later once you encode matched flags in PMs.
+    def _half(n: int) -> int:
+        return 0 if n == 0 else max(1, n // 2)
+
+    return ArtifactContainerCountsPM(
+        num_test_traces_total=num_test_total,
+        num_test_traces_matched=_half(num_test_total),
+        num_test_traces_logic_good=_half(num_test_total),
+
+        num_log_traces_total=num_log_total,
+        num_log_traces_matched=_half(num_log_total),
+        num_log_traces_logic_good=_half(num_log_total),
+
+        num_src_code_arts_total=num_src_total,
+        num_src_code_arts_matched=_half(num_src_total),
+
+        num_doc_arts_total=num_doc_total,
+        num_doc_arts_matched=_half(num_doc_total),
+    )
+
+
+# -----------------------------------------------------------------------------
+# main fixture entrypoint (matches PreviewSpec.make signature)
+# -----------------------------------------------------------------------------
+
+def make_artifact_container_pm(ctx: RenderCtx, variant: str = "typical") -> ArtifactContainerPM:
+    v = (variant or "typical").lower().strip()
+
+    # -------------------------
+    # minimal
+    # -------------------------
+    if v == "minimal":
+        items = ArtifactContainerItemsPM(
+            test_traces=[],
+            log_traces=[],
+            doc_refs=[],
+            src_code_refs=[],
+        )
+        return ArtifactContainerPM(
+            counts=_counts_from_items(items),
+            items=items,
+        )
+
+    # -------------------------
+    # edge (stress: long content, many items)
+    # -------------------------
+    if v == "edge":
+        items = ArtifactContainerItemsPM(
+            test_traces=[
+                edge_test_trace_pm(),
+                typical_test_trace_pm(with_contents=True, invalid=True),
+                typical_test_trace_pm(with_contents=False, invalid=False),
+            ],
+            log_traces=[
+                edge_log_trace_pm(),
+                typical_log_trace_pm(with_contents=True, invalid=True),
+            ],
+            doc_refs=[
+                edge_doc_ref_pm(),
+                typical_doc_ref_pm(),
+            ],
+            src_code_refs=[
+                edge_src_code_ref_pm(),
+                typical_src_code_ref_pm(),
+            ],
+        )
+        return ArtifactContainerPM(
+            counts=_counts_from_items(items),
+            items=items,
+        )
+
+    # -------------------------
+    # typical
+    # -------------------------
+    items = ArtifactContainerItemsPM(
+        test_traces=[
+            typical_test_trace_pm(with_contents=False, invalid=False),
+            typical_test_trace_pm(with_contents=True, invalid=True),
+        ],
+        log_traces=[
+            typical_log_trace_pm(with_contents=False, invalid=False),
+        ],
+        doc_refs=[
+            typical_doc_ref_pm(),
+        ],
+        src_code_refs=[
+            typical_src_code_ref_pm(),
+        ],
+    )
+    return ArtifactContainerPM(
+        counts=_counts_from_items(items),
+        items=items,
+    )
+
+
+# -----------------------------------------------------------------------------
+# renderer adapter (matches other fixtures style)
+# -----------------------------------------------------------------------------
+
+def render(pm: ArtifactContainerPM, ctx : RenderCtx):
+    from speclogician.presentation.renderers.container import render_artifact_container
+    return render_artifact_container(pm, ctx=ctx)

speclogician/presentation/preview/fixtures/data_artifact.py

@@ -0,0 +1,144 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/preview/fixtures/data_artifact.py
+#
+
+from __future__ import annotations
+
+from speclogician.presentation.ctx import RenderCtx
+from speclogician.presentation.models.data_artifact import DataArtifactCorePM, DocRefPM, SrcCodeRefPM
+from speclogician.presentation.renderers.data_artifact import (
+    render_doc_ref,
+    render_src_code_ref,
+)
+
+# -----------------------------------------------------------------------------
+# Shared helpers
+# -----------------------------------------------------------------------------
+
+def _core(*, art_id: str) -> DataArtifactCorePM:
+    return DataArtifactCorePM(art_id=art_id)
+
+
+# -----------------------------------------------------------------------------
+# DocRefPM fixtures
+# -----------------------------------------------------------------------------
+
+def minimal_doc_ref_pm() -> DocRefPM:
+    return DocRefPM(
+        core=_core(art_id="00000000-0000-0000-0000-000000000000"),
+        text="",
+        meta=None,
+    )
+
+
+def typical_doc_ref_pm() -> DocRefPM:
+    return DocRefPM(
+        core=_core(art_id="11111111-1111-1111-1111-111111111111"),
+        text="Order must be rejected if quantity exceeds max order size.",
+        meta="spec:order_limits; source=confluence; section=Risk Checks",
+    )
+
+
+def edge_doc_ref_pm() -> DocRefPM:
+    return DocRefPM(
+        core=_core(art_id="99999999-9999-9999-9999-999999999999"),
+        text=(
+            "A very long doc note that should wrap nicely and still be readable. "
+            "It may contain bullet-like text, punctuation, and ‘quoted’ phrases.\n\n"
+            "- Must preserve meaning\n"
+            "- Must keep formatting\n"
+            "- Should not overflow tables\n"
+        ),
+        meta=(
+            "url=https://example.com/really/long/path/to/a/doc\n"
+            "tags=risk,limits,edge-case\n"
+            "owner=QA\n"
+        ),
+    )
+
+
+def make_doc_ref_pm(ctx: RenderCtx, variant: str) -> DocRefPM:
+    match variant:
+        case "minimal":
+            return minimal_doc_ref_pm()
+        case "edge":
+            return edge_doc_ref_pm()
+        case _:
+            return typical_doc_ref_pm()
+
+
+# -----------------------------------------------------------------------------
+# SrcCodeRefPM fixtures
+# -----------------------------------------------------------------------------
+
+def minimal_src_code_ref_pm() -> SrcCodeRefPM:
+    return SrcCodeRefPM(
+        core=_core(art_id="00000000-0000-0000-0000-000000000000"),
+        src_code="",
+        language=None,
+        file_path=None,
+        iml_code=None,
+        meta=None,
+    )
+
+
+def typical_src_code_ref_pm(*, with_iml: bool = True) -> SrcCodeRefPM:
+    return SrcCodeRefPM(
+        core=_core(art_id="22222222-2222-2222-2222-222222222222"),
+        src_code=(
+            "def check_qty(order):\n"
+            "    return order.qty <= 10000\n"
+        ),
+        language="python",
+        file_path="risk/checks/order_limits.py",
+        iml_code=(
+            "let check_qty (o: order) : bool = o.qty <= 10000"
+            if with_iml
+            else None
+        ),
+        meta="repo=speclogician; commit=abc123; kind=snippet",
+    )
+
+
+def edge_src_code_ref_pm() -> SrcCodeRefPM:
+    return SrcCodeRefPM(
+        core=_core(art_id="aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"),
+        src_code=(
+            "class RiskEngine:\n"
+            "    def check(self, order, market_data, limits):\n"
+            "        # extremely long snippet to stress wrapping\n"
+            + ("        # line\n" * 60)
+            + "        return True\n"
+        ),
+        language="python",
+        file_path=("very/long/path/" * 6) + "risk_engine.py",
+        iml_code=(
+            "type order = { qty : int }\n"
+            "let check (o: order) : bool = o.qty > 0\n"
+            + ("(* comment *)\n" * 40)
+        ),
+        meta=(
+            "repo=monorepo\n"
+            "component=risk_engine\n"
+            "note=this meta is multi-line to stress rendering\n"
+        ),
+    )
+
+
+def make_src_code_ref_pm(ctx: RenderCtx, variant: str) -> SrcCodeRefPM:
+    match variant:
+        case "minimal":
+            return minimal_src_code_ref_pm()
+        case "edge":
+            return edge_src_code_ref_pm()
+        case _:
+            return typical_src_code_ref_pm()
+        
+def render_doc(pm: DocRefPM, ctx: RenderCtx):
+    return render_doc_ref(pm, ctx=ctx)
+
+
+def render_src(pm: SrcCodeRefPM, ctx: RenderCtx):
+    return render_src_code_ref(pm, ctx=ctx)