speclogician 0.0.0b1__py3-none-any.whl

speclogician/presentation/builders/state_instance_summary.py

@@ -0,0 +1,84 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/builders/state_instance_summary.py
+#
+
+from __future__ import annotations
+
+from speclogician.presentation.ctx import RenderCtx
+from speclogician.presentation.models.state_instance_summary import StateInstanceSummaryPM
+from speclogician.state.inst import StateInstance
+
+
+def _g(obj: object, name: str, default):
+    return getattr(obj, name, default)
+
+
+def build_state_instance_summary_pm(si: StateInstance, ctx: RenderCtx) -> StateInstanceSummaryPM:
+    dm = si.spec.domain_model
+    spec = si.spec
+    art = si.art_container
+
+    return StateInstanceSummaryPM(
+        created_at=si.created_at.isoformat() if si.created_at else None,
+        num_changes=len(si.changes or []),
+
+        # ---- Domain model (base) ----
+        base_status=str(_g(dm, "base_status", None)),
+        base_has_state=_g(dm, "base_has_state", False),
+        base_has_action=_g(dm, "base_has_action", False),
+
+        # ---- State predicates ----
+        num_state_preds_total=_g(dm, "num_state_preds_total", 0),
+        num_state_preds_matched=_g(dm, "num_state_preds_matched", 0),
+        num_state_preds_valid_logic=_g(dm, "num_state_preds_valid_logic", 0),
+        num_state_preds_errored=_g(dm, "num_state_preds_errored", 0),
+
+        # ---- Action predicates ----
+        num_action_preds_total=_g(dm, "num_action_preds_total", 0),
+        num_action_preds_matched=_g(dm, "num_action_preds_matched", 0),
+        num_action_preds_valid_logic=_g(dm, "num_action_preds_valid_logic", 0),
+        num_action_preds_errored=_g(dm, "num_action_preds_errored", 0),
+
+        # ---- Predicates totals ----
+        num_preds_total=_g(dm, "num_preds_total", 0),
+        num_preds_matched=_g(dm, "num_preds_matched", 0),
+        num_preds_valid_logic=_g(dm, "num_preds_valid_logic", 0),
+        num_preds_errored=_g(dm, "num_preds_errored", 0),
+
+        # ---- Transitions ----
+        num_trans_total=_g(dm, "num_trans_total", 0),
+        num_trans_matched=_g(dm, "num_trans_matched", 0),
+        num_trans_valid_logic=_g(dm, "num_trans_valid_logic", 0),
+        num_trans_errored=_g(dm, "num_trans_errored", 0),
+
+        # ---- Scenarios ----
+        num_sc_total=_g(spec, "num_sc_total", 0),
+        num_sc_missing=_g(spec, "num_sc_missing", 0),
+        num_sc_matched=_g(spec, "num_sc_matched", 0),
+        num_sc_inconsistent=_g(spec, "num_sc_inconsistent", 0),
+
+        # ---- Conflicts (spec-level) ----
+        num_sc_conflicted=_g(spec, "num_sc_conflicted", 0),
+        num_sc_overlap=_g(spec, "num_sc_overlap", 0),
+        num_sc_consumed=_g(spec, "num_sc_consumed", 0),
+
+        # ---- ArtifactContainer: test traces ----
+        num_test_traces_total=_g(art, "num_test_traces_total", 0),
+        num_test_traces_logic_good=_g(art, "num_test_traces_logic_good", 0),
+        num_test_traces_matched=_g(art, "num_test_traces_matched", 0),
+
+        # ---- ArtifactContainer: log traces ----
+        num_log_traces_total=_g(art, "num_log_traces_total", 0),
+        num_log_traces_logic_good=_g(art, "num_log_traces_logic_good", 0),
+        num_log_traces_matched=_g(art, "num_log_traces_matched", 0),
+
+        # ---- ArtifactContainer: src code ----
+        num_src_code_arts_total=_g(art, "num_src_code_arts_total", 0),
+        num_src_code_arts_matched=_g(art, "num_src_code_arts_matched", 0),
+
+        # ---- ArtifactContainer: docs ----
+        num_doc_arts_total=_g(art, "num_doc_arts_total", 0),
+        num_doc_arts_matched=_g(art, "num_doc_arts_matched", 0),
+    )

speclogician/presentation/builders/trace.py

@@ -0,0 +1,58 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/builders/trace.py
+#
+
+from __future__ import annotations
+
+from speclogician.presentation.ctx import RenderCtx
+from speclogician.presentation.models.trace import (
+    TraceIMLValidityPM,
+    TraceCorePM,
+    TestTracePM,
+    LogTracePM,
+)
+
+from speclogician.data.traces import TestTrace, LogTrace
+
+
+def _build_validity_pm(v) -> TraceIMLValidityPM:
+    # v: TraceIMLValidity(iml_valid=IMLValidity, err=...)
+    iml_valid = getattr(v, "iml_valid", None)
+    # enum -> "valid"/"invalid"/"unknown"
+    iml_valid_s = getattr(iml_valid, "value", None) or str(iml_valid)
+    return TraceIMLValidityPM(iml_valid=str(iml_valid_s), err=getattr(v, "err", None))
+
+
+def _build_core_pm(tr: TestTrace | LogTrace) -> TraceCorePM:
+    return TraceCorePM(
+        art_id=tr.art_id,
+        given=tr.given,
+        when=tr.when,
+        then=tr.then,
+        time=tr.time or "",
+        iml_validity=_build_validity_pm(tr.iml_validity),
+    )
+
+
+def build_test_trace_pm(tr: TestTrace, ctx: RenderCtx) -> TestTracePM:
+    # heavy fields obey ctx.show_code (or rename to ctx.show_contents if you prefer)
+    contents = tr.contents if getattr(ctx, "show_code", True) else None
+    return TestTracePM(
+        core=_build_core_pm(tr),
+        name=tr.name,
+        filepath=tr.filepath or "",
+        language=tr.language,
+        contents=contents,
+    )
+
+
+def build_log_trace_pm(tr: LogTrace, ctx: RenderCtx) -> LogTracePM:
+    # heavy log contents also obey ctx.show_code
+    contents = tr.contents if getattr(ctx, "show_code", True) else None
+    return LogTracePM(
+        core=_build_core_pm(tr),
+        filename=tr.filename,
+        contents=contents,
+    )

speclogician/presentation/ctx.py

@@ -0,0 +1,38 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/ctx.py
+#
+
+from __future__ import annotations
+from pydantic import BaseModel
+from speclogician.data.container import ArtifactContainer
+from speclogician.data.mapping import ArtifactMap
+
+class RenderCtx(BaseModel):
+    art_cont: ArtifactContainer | None = None
+    art_map: ArtifactMap | None = None
+
+    show_ids: bool = False
+    show_art_ids: bool = False
+
+    # --- global presentation toggles ---
+    compact: bool = False          # tighter tables/panels
+    show_stats_only: bool = False  # render only summary stats (no code blocks)
+    show_code: bool = True         # include code blocks (IML, src snippets)
+
+    # --- domain-model specific ---
+    show_base: bool = True
+    show_predicates: bool = True
+    show_transitions: bool = True
+
+    # --- scenario specific (when you wire it) ---
+    show_scenario_conflicts: bool = True
+    show_missing_components: bool = True
+
+    # --- artifacts/mapping (when you wire it) ---
+    show_traces: bool = True
+    show_artifacts: bool = True
+
+    show_empty_sections: bool = False
+    show_recommendations: bool = True

speclogician/presentation/models/container.py

@@ -0,0 +1,44 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/container.py
+#
+
+from __future__ import annotations
+
+from typing import Literal
+from pydantic import BaseModel, Field
+
+from speclogician.presentation.models.trace import TestTracePM, LogTracePM
+from speclogician.presentation.models.data_artifact import DocRefPM, SrcCodeRefPM
+
+
+class ArtifactContainerCountsPM(BaseModel):
+    # traces
+    num_test_traces_total: int = 0
+    num_test_traces_matched: int = 0
+    num_test_traces_logic_good: int = 0
+
+    num_log_traces_total: int = 0
+    num_log_traces_matched: int = 0
+    num_log_traces_logic_good: int = 0
+
+    # data artifacts
+    num_src_code_arts_total: int = 0
+    num_src_code_arts_matched: int = 0
+
+    num_doc_arts_total: int = 0
+    num_doc_arts_matched: int = 0
+
+
+class ArtifactContainerItemsPM(BaseModel):
+    test_traces: list[TestTracePM] = Field(default_factory=list)
+    log_traces: list[LogTracePM] = Field(default_factory=list)
+    doc_refs: list[DocRefPM] = Field(default_factory=list)
+    src_code_refs: list[SrcCodeRefPM] = Field(default_factory=list)
+
+
+class ArtifactContainerPM(BaseModel):
+    kind: Literal["artifact_container"] = "artifact_container"
+    counts: ArtifactContainerCountsPM
+    items: ArtifactContainerItemsPM

speclogician/presentation/models/data_artifact.py

@@ -0,0 +1,33 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/data_artifact.py
+#
+
+from __future__ import annotations
+
+from typing import Literal
+from pydantic import BaseModel
+
+
+class DataArtifactCorePM(BaseModel):
+    art_id: str
+
+
+class DocRefPM(BaseModel):
+    kind: Literal["doc_ref"] = "doc_ref"
+    core: DataArtifactCorePM
+
+    text: str
+    meta: str | None = None
+
+
+class SrcCodeRefPM(BaseModel):
+    kind: Literal["src_code_ref"] = "src_code_ref"
+    core: DataArtifactCorePM
+
+    src_code: str
+    language: str | None = None
+    file_path: str | None = None
+    iml_code: str | None = None
+    meta: str | None = None

speclogician/presentation/models/domain.py

@@ -0,0 +1,50 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/domain.py
+#
+
+from __future__ import annotations
+
+from pydantic import BaseModel
+from typing import Literal
+
+from speclogician.modeling.domain import BaseStatus
+
+
+class DomainCountsPM(BaseModel):
+    # base flags
+    base_status: BaseStatus
+    base_has_state: bool
+    base_has_action: bool
+
+    # predicates
+    num_state_preds_total: int = 0
+    num_state_preds_valid_logic: int = 0
+    num_state_preds_matched: int = 0
+
+    num_action_preds_total: int = 0
+    num_action_preds_valid_logic: int = 0
+    num_action_preds_matched: int = 0
+
+    num_preds_total: int = 0
+    num_preds_valid_logic: int = 0
+    num_preds_matched: int = 0
+
+    # transitions
+    num_trans_total: int = 0
+    num_trans_valid_logic: int = 0
+    num_trans_matched: int = 0
+
+
+class DomainCodePM(BaseModel):
+    base: str = ""
+    state_preds_iml: str = ""
+    action_preds_iml: str = ""
+    transitions_iml: str = ""
+
+
+class DomainModelPM(BaseModel):
+    kind: Literal["domain_model"] = "domain_model"
+    counts: DomainCountsPM
+    code: DomainCodePM

speclogician/presentation/models/instances_list.py

@@ -0,0 +1,23 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/instances_list.py
+#
+
+from __future__ import annotations
+
+from typing import Literal
+from pydantic import BaseModel, Field
+
+from speclogician.presentation.models.state_instance_summary import StateInstanceSummaryPM
+
+
+class InstancesListRowPM(BaseModel):
+    state_label: str  # "latest" or index string
+    changes: str      # already formatted (short_str / class name join)
+    summary: StateInstanceSummaryPM
+
+
+class InstancesListPM(BaseModel):
+    kind: Literal["instances_list"] = "instances_list"
+    rows: list[InstancesListRowPM] = Field(default_factory=list[InstancesListRowPM])

speclogician/presentation/models/predicate.py

@@ -0,0 +1,60 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/predicate.py
+#
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+from speclogician.modeling.predicates import PredicateType
+from speclogician.utils import IMLValidity
+
+
+class LinkedArtifactsPM(BaseModel):
+    total: int = 0
+    test_traces: int = 0
+    log_traces: int = 0
+    doc_refs: int = 0
+    src_code_refs: int = 0
+    unresolved_ids: int = 0
+    art_ids: list[str] = Field(default_factory=list)
+
+
+class PredicatePM(BaseModel):
+    kind: Literal["state_predicate", "action_predicate"]  # matches your model
+    comp_id: str
+    name: str
+    last_updated: datetime
+
+    pred_type: PredicateType
+    signature: str
+
+    src_code: str = ""
+    iml: str = ""
+
+    is_iml_valid: IMLValidity = IMLValidity.UNKNOWN
+    iml_error: str | None = None
+
+    links: LinkedArtifactsPM = Field(default_factory=LinkedArtifactsPM)
+
+
+class TransitionPM(BaseModel):
+    kind: Literal["transition"] = "transition"
+    comp_id: str
+    name: str
+    last_updated: datetime
+
+    signature: str
+
+    src_code: str = ""
+    iml: str = ""
+
+    is_iml_valid: IMLValidity = IMLValidity.UNKNOWN
+    iml_error: str | None = None
+
+    links: LinkedArtifactsPM = Field(default_factory=LinkedArtifactsPM)

speclogician/presentation/models/recommendations.py

@@ -0,0 +1,34 @@
+#
+#   Imandra Inc.
+#   
+#   speclogician/presentation/models/recommendations.py
+#
+
+
+from __future__ import annotations
+
+from typing import Literal
+from pydantic import BaseModel, Field
+
+
+RecommendationKind = Literal["error", "warning", "next", "info"]
+
+
+class RecommendationPM(BaseModel):
+    kind: RecommendationKind = "next"
+    priority: int = 50  # lower = higher priority
+    text: str
+
+
+class RecommendationsPM(BaseModel):
+    """
+    A presentable bundle of recommendations (already deduped/sorted upstream).
+    """
+    count: int = 0
+    items: list[RecommendationPM] = Field(default_factory=list)
+
+    # Optional: quick counts by kind (useful for compact views)
+    num_error: int = 0
+    num_warning: int = 0
+    num_next: int = 0
+    num_info: int = 0

speclogician/presentation/models/scenario.py

@@ -0,0 +1,31 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/scenario.py
+#
+
+from __future__ import annotations
+
+from typing import Literal
+from pydantic import BaseModel, Field
+
+
+class ScenarioStatusPM(BaseModel):
+    kind: Literal["valid", "missing", "inconsistent"]
+    missing_preds: list[str] = Field(default_factory=list)
+    missing_trans: list[str] = Field(default_factory=list)
+
+
+class ScenarioPM(BaseModel):
+    comp_id: str
+    name: str
+
+    status: ScenarioStatusPM
+
+    given: list[str] = Field(default_factory=list)
+    when: list[str] = Field(default_factory=list)
+    then: list[str] = Field(default_factory=list)
+
+    given_preds_consistent: bool = True
+    when_preds_consistent: bool = True
+    all_preds_consistent: bool = True

speclogician/presentation/models/scenario_complement.py

@@ -0,0 +1,40 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/scenario_complement.py
+#
+
+from __future__ import annotations
+
+from typing import Literal
+from pydantic import BaseModel
+
+
+class ScenarioComplementRegionPM(BaseModel):
+    """
+    Lightweight representation of a single region.
+
+    We store:
+      - fp: stable-ish short fingerprint (from modeling/complement.py)
+      - invariant/model/model_eval/constraints: optional strings for display
+    """
+    fp: str
+
+    num_constraints: int = 0
+    invariant: str | None = None
+    model: str | None = None
+    model_eval: str | None = None
+
+    # optional: include a few constraints for preview
+    constraints_preview: list[str] = []
+
+
+class ScenarioComplementPM(BaseModel):
+    kind: Literal["scenario_complement"] = "scenario_complement"
+
+    count_regions: int = 0
+
+    # a small sample for UI
+    regions_preview: list[ScenarioComplementRegionPM] = []
+
+    regions_all: list[ScenarioComplementRegionPM] | None = None

speclogician/presentation/models/smart_find.py

@@ -0,0 +1,34 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/smart_find.py
+#
+
+from __future__ import annotations
+
+from typing import Literal
+from pydantic import BaseModel, Field
+
+from speclogician.presentation.models.trace import TestTracePM, LogTracePM
+from speclogician.presentation.models.data_artifact import DocRefPM, SrcCodeRefPM
+
+
+class SmartFindCountsPM(BaseModel):
+    needle: str
+    num_test_traces: int = 0
+    num_log_traces: int = 0
+    num_doc_refs: int = 0
+    num_src_code_refs: int = 0
+
+
+class SmartFindItemsPM(BaseModel):
+    test_traces: list[TestTracePM] = Field(default_factory=list)
+    log_traces: list[LogTracePM] = Field(default_factory=list)
+    doc_refs: list[DocRefPM] = Field(default_factory=list)
+    src_code_refs: list[SrcCodeRefPM] = Field(default_factory=list)
+
+
+class SmartFindPM(BaseModel):
+    kind: Literal["smart_find"] = "smart_find"
+    counts: SmartFindCountsPM
+    items: SmartFindItemsPM

speclogician/presentation/models/spec.py

@@ -0,0 +1,32 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/spec.py
+#
+
+from __future__ import annotations
+
+from typing import Literal
+from pydantic import BaseModel
+
+from speclogician.presentation.models.domain import DomainModelPM
+from speclogician.presentation.models.scenario_complement import ScenarioComplementPM
+
+
+class SpecCountsPM(BaseModel):
+    num_sc_total: int = 0
+    num_sc_missing: int = 0
+    num_sc_matched: int = 0
+    num_sc_inconsistent: int = 0
+    num_sc_conflicted: int = 0
+
+
+class SpecPM(BaseModel):
+    kind: Literal["spec"] = "spec"
+    domain: DomainModelPM
+    counts: SpecCountsPM
+
+    # cheap “list view” for CLI
+    scenario_names: list[str] = []
+
+    scenario_complement: ScenarioComplementPM | None = None

speclogician/presentation/models/state_diff.py

@@ -0,0 +1,34 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/state_diff.py
+#
+
+from __future__ import annotations
+
+from typing import Any, Literal
+from pydantic import BaseModel, Field
+
+from speclogician.state.diff import ComparisonOutcome
+
+
+class DiffRowPM(BaseModel):
+    label: str
+    before: Any
+    after: Any
+    outcome: ComparisonOutcome = ComparisonOutcome.UNKNOWN
+    message: str = ""
+
+
+class DiffSectionPM(BaseModel):
+    title: str
+    rows: list[DiffRowPM] = Field(default_factory=list)
+
+    def empty(self) -> bool:
+        return not self.rows
+
+
+class StateDiffPM(BaseModel):
+    kind: Literal["state_diff"] = "state_diff"
+    has_changes: bool
+    sections: list[DiffSectionPM] = Field(default_factory=list)

speclogician/presentation/models/state_instance.py

@@ -0,0 +1,31 @@
+#
+#   Imandra Inc.
+#
+#   speclogician/presentation/models/state_instance.py
+#
+
+from __future__ import annotations
+
+from typing import Literal
+
+from pydantic import BaseModel
+
+from speclogician.presentation.models.state_instance_summary import StateInstanceSummaryPM
+from speclogician.presentation.models.spec import SpecPM
+from speclogician.presentation.models.container import ArtifactContainerPM
+from speclogician.presentation.models.state_diff import StateDiffPM
+from speclogician.presentation.models.recommendations import RecommendationsPM
+
+
+class StateInstancePM(BaseModel):
+    kind: Literal["state_instance"] = "state_instance"
+
+    summary: StateInstanceSummaryPM
+
+    # Optional heavy sections
+    spec: SpecPM | None = None
+    artifacts: ArtifactContainerPM | None = None
+    state_diff: StateDiffPM | None = None
+
+    # Recommendations (computed after change/diff)
+    recommendations: RecommendationsPM