framework-m 0.7.3__tar.gz → 0.8.0__tar.gz

{framework_m-0.7.3 → framework_m-0.8.0}/CHANGELOG.md

@@ -1,3 +1,14 @@
+## framework-m v0.8.0
+
+### Features
+
+- pagination, tabbed layout and dynamic fields in desk (86b5e66)
+
+### Bug Fixes
+
+- clarify use aiosqlite for db url in test (981c6c4)
+- typecheck error (1e06770)
+
 **framework-m** v0.7.3: internal dependency bump due to **framework-m-core** update**framework-m** v0.7.2: internal dependency bump due to **framework-m-core** update**framework-m** v0.7.1: internal dependency bump due to **framework-m-studio** update## framework-m v0.7.0
 
 ### Features

{framework_m-0.7.3 → framework_m-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: framework-m
-Version: 0.7.3
+Version: 0.8.0
 Summary: A modular, metadata-driven business application framework
 Project-URL: Homepage, https://gitlab.com/castlecraft/framework-m
 Project-URL: Documentation, https://gitlab.com/castlecraft/framework-m#readme
@@ -18,8 +18,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 Requires-Python: >=3.12
-Requires-Dist: framework-m-core>=0.13.0
-Requires-Dist: framework-m-standard>=0.10.0
+Requires-Dist: framework-m-core>=0.14.0
+Requires-Dist: framework-m-standard>=0.11.0
 Description-Content-Type: text/markdown
 
 # Framework M

{framework_m-0.7.3 → framework_m-0.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "framework-m"
-version = "0.7.3"
+version = "0.8.0"
 description = "A modular, metadata-driven business application framework"
 readme = "README.md"
 license = { text = "Apache-2.0" }
@@ -21,8 +21,8 @@ classifiers = [
 ]
 
 dependencies = [
-    "framework-m-core>=0.13.0",
-    "framework-m-standard>=0.10.0",
+    "framework-m-core>=0.14.0",
+    "framework-m-standard>=0.11.0",
 ]
 
 [tool.uv.sources]
@@ -83,8 +83,11 @@ filterwarnings = [
 ]
 
 [tool.coverage.run]
-source = ["src/framework_m"]
 branch = true
+omit = [
+    "*/tests/*",
+    "*conftest.py",
+]
 
 [tool.coverage.report]
 exclude_lines = [

{framework_m-0.7.3 → framework_m-0.8.0}/tests/conftest.py

@@ -101,7 +101,7 @@ def configured_container() -> Container:
     container = Container()
     container.config.from_dict(
         {
-            "database_url": "sqlite:///:memory:",
+            "database_url": "sqlite+aiosqlite:///:memory:",
             "debug": True,
             "app_name": "TestApp",
         }

{framework_m-0.7.3 → framework_m-0.8.0}/tests/core/test_correction_service.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from typing import Any
-from unittest.mock import AsyncMock
+from unittest.mock import AsyncMock, patch
 
 import pytest
 from framework_m_core.domain.base_doctype import BaseDocType, Field
@@ -11,6 +11,7 @@ from framework_m_core.domain.mixins import DocStatus, SubmittableMixin, Versione
 from framework_m_core.interfaces.audit import AuditLogProtocol
 from framework_m_core.interfaces.auth_context import UserContext
 from framework_m_core.interfaces.repository import RepositoryProtocol
+from pydantic import ConfigDict
 
 from framework_m.core.services.correction import CorrectionService
 
@@ -26,6 +27,17 @@ class VersionedInvoice(Invoice, VersionedMixin):
     """Versioned invoice doctype for in-place correction tests."""
 
 
+class PlainDoc(BaseDocType):
+    """Plain doc without SubmittableMixin for edge cases."""
+
+    title: str = Field(default="Test")
+    model_config = ConfigDict(extra="ignore")
+
+
+class PlainVersionedDoc(PlainDoc, VersionedMixin):
+    """Versioned plain doc for in-place edge cases."""
+
+
 @pytest.fixture
 def mock_repository() -> AsyncMock:
     """Repository mock implementing save semantics."""
@@ -239,6 +251,91 @@ class TestCorrectionServiceRestore:
                 user=user_context,
             )
 
+
+class TestCorrectionServiceEdgeCases:
+    """Coverage tests for defensive checks and edge cases."""
+
+    def test_next_amended_name_unmatchable_pattern(
+        self, service: CorrectionService
+    ) -> None:
+        """Cover branch where regex match is None."""
+        assert service._next_amended_name("INV-001-A") == "INV-001-A-1"
+
+    def test_ensure_submitted_without_docstatus(
+        self, service: CorrectionService
+    ) -> None:
+        """Cover branch where doc has no docstatus attribute."""
+        doc = PlainDoc(name="PLAIN-1")
+        with pytest.raises(
+            ValueError, match="Only submitted documents can be corrected"
+        ):
+            service._ensure_submitted(doc)
+
+    def test_clone_with_updates_keep_id_and_no_docstatus(
+        self, service: CorrectionService
+    ) -> None:
+        """Cover branches for drop_id=False and missing docstatus field."""
+        doc = PlainDoc(name="PLAIN-1")
+        cloned = service._clone_with_updates(
+            source=doc,
+            new_name="PLAIN-2",
+            docstatus=DocStatus.DRAFT,
+            drop_id=False,
+        )
+        assert cloned.id == doc.id
+        assert cloned.name == "PLAIN-2"
+        assert not hasattr(cloned, "docstatus")
+
+    def test_document_ref_without_name(self, service: CorrectionService) -> None:
+        """Cover branch where doc.name is None/empty."""
+        doc = PlainDoc(name="")
+        assert service._document_ref(doc) == str(doc.id)
+
+    @pytest.mark.asyncio
+    @patch.object(CorrectionService, "_ensure_submitted")
+    async def test_amend_without_copied_docstatus(
+        self,
+        mock_ensure: Any,
+        service: CorrectionService,
+        mock_repository: AsyncMock,
+        user_context: UserContext,
+    ) -> None:
+        """Cover hasattr(cancelled, 'docstatus') == False branch."""
+        doc = PlainDoc(name="PLAIN-1")
+        await service.amend(doc, "Test", user_context)
+        cancelled_doc = mock_repository.save.await_args_list[0].args[0]
+        assert not hasattr(cancelled_doc, "docstatus")
+
+    @pytest.mark.asyncio
+    @patch.object(CorrectionService, "_ensure_submitted")
+    async def test_restore_without_copied_docstatus(
+        self,
+        mock_ensure: Any,
+        service: CorrectionService,
+        mock_repository: AsyncMock,
+        user_context: UserContext,
+    ) -> None:
+        """Cover hasattr(cancelled, 'docstatus') == False branch."""
+        doc = PlainDoc(name="PLAIN-1")
+        await service.restore(doc, {"title": "Restored"}, "Test", user_context)
+        cancelled_doc = mock_repository.save.await_args_list[0].args[0]
+        assert not hasattr(cancelled_doc, "docstatus")
+
+    @pytest.mark.asyncio
+    @patch.object(CorrectionService, "_ensure_submitted")
+    async def test_in_place_edit_without_copied_docstatus(
+        self,
+        mock_ensure: Any,
+        service: CorrectionService,
+        mock_repository: AsyncMock,
+        user_context: UserContext,
+    ) -> None:
+        """Cover hasattr(editable, 'docstatus') == False branch."""
+        doc = PlainVersionedDoc(name="PLAIN-1")
+        await service.in_place_edit(doc, "Test", user_context)
+        editable_doc = mock_repository.save.await_args_list[1].args[0]
+        assert not hasattr(editable_doc, "docstatus")
+
     @pytest.mark.asyncio
     async def test_restore_raises_if_snapshot_empty(
         self,

{framework_m-0.7.3 → framework_m-0.8.0}/tests/integration/test_migration_flow.py

@@ -139,9 +139,9 @@ class TestMigrationFlow:
             conn.execute(
                 text(
                     "INSERT INTO datadoc "
-                    "(id, name, name_field, creation, modified, owner) "
+                    "(id, name, name_field, creation, modified, owner, custom_fields) "
                     "VALUES ('test-uuid-1', 'DATA-001', 'Test Data', "
-                    "datetime('now'), datetime('now'), 'test@test.com')"
+                    "datetime('now'), datetime('now'), 'test@test.com', '{}')"
                 )
             )
             conn.commit()

{framework_m-0.7.3 → framework_m-0.8.0}/tests/integration/test_workflow_lifecycle.py

@@ -50,7 +50,13 @@ class InMemoryWorkflowAdapter:
                         "from": "Draft",
                         "to": "Pending Approval",
                         "action": "submit",
-                        "allowed_roles": ["Employee", "Manager", "Admin"],
+                        "allowed_roles": ["Employee"],
+                    },
+                    {
+                        "from": "Draft",
+                        "to": "Pending Approval",
+                        "action": "submit",
+                        "allowed_roles": ["Manager", "Admin"],  # Admins can also submit
                     },
                     {
                         "from": "Pending Approval",
@@ -123,18 +129,15 @@ class InMemoryWorkflowAdapter:
         current_state_info = self._states[key]
         workflow_config = self._workflow_config[current_state_info.workflow_name]
 
-        # Find matching transition
-        transition = None
-        for trans in workflow_config["transitions"]:
-            if (
-                trans["from"] == current_state_info.current_state
-                and trans["action"] == request.action
-            ):
-                transition = trans
-                break
+        # Find matching transition(s) for the action
+        possible_transitions = [
+            t
+            for t in workflow_config["transitions"]
+            if t["from"] == current_state_info.current_state
+            and t["action"] == request.action
+        ]
 
-        # No valid transition found
-        if transition is None:
+        if not possible_transitions:
             return TransitionResult(
                 success=False,
                 old_state=current_state_info.current_state,
@@ -143,22 +146,31 @@ class InMemoryWorkflowAdapter:
                 message=f"Invalid action '{request.action}' from state '{current_state_info.current_state}'",
             )
 
-        # Check user role permission
+        # Find a transition the user is allowed to perform
         user_roles = request.user.roles
-        allowed_roles = transition["allowed_roles"]
+        allowed_transition = None
+        for trans in possible_transitions:
+            allowed_roles = trans.get("allowed_roles")
+            if not allowed_roles or any(r in user_roles for r in allowed_roles):
+                allowed_transition = trans
+                break
 
-        if not any(role in allowed_roles for role in user_roles):
+        if not allowed_transition:
+            # A transition exists, but user lacks permission
+            required_roles = {
+                r for t in possible_transitions for r in (t.get("allowed_roles") or [])
+            }
             return TransitionResult(
                 success=False,
                 old_state=current_state_info.current_state,
                 new_state=current_state_info.current_state,
                 action=request.action,
-                message=f"User does not have required role. Required: {allowed_roles}, User has: {user_roles}",
+                message=f"User does not have required role. Required: {required_roles}, User has: {user_roles}",
             )
 
         # Perform transition
         old_state = current_state_info.current_state
-        new_state = transition["to"]
+        new_state = allowed_transition["to"]
 
         self._states[key] = current_state_info.model_copy(
             update={
@@ -197,8 +209,8 @@ class InMemoryWorkflowAdapter:
                 continue
 
             # Check if user has required role
-            allowed_roles = transition["allowed_roles"]
-            if any(role in allowed_roles for role in user_roles):
+            allowed_roles = transition.get("allowed_roles")
+            if not allowed_roles or any(r in user_roles for r in allowed_roles):
                 available_actions.append(transition["action"])
 
         return available_actions

framework_m-0.7.3/docs/ports.md

@@ -1,414 +0,0 @@
-# Protocol Interfaces (Ports)
-
-Framework M defines clear protocol interfaces for all infrastructure concerns. This allows different implementations to be swapped without changing business logic.
-
-## Overview
-
-| Protocol | File | Purpose |
-|----------|------|---------|
-| `RepositoryProtocol` | `repository.py` | CRUD operations for documents |
-| `EventBusProtocol` | `event_bus.py` | Publish/subscribe events |
-| `AuthContextProtocol` | `auth_context.py` | Current user context |
-| `PermissionProtocol` | `permission.py` | Authorization with RLS |
-| `StorageProtocol` | `storage.py` | File storage abstraction |
-| `JobQueueProtocol` | `job_queue.py` | Background job processing |
-| `CacheProtocol` | `cache.py` | Caching layer |
-| `NotificationProtocol` | `notification.py` | Email/SMS notifications |
-| `SearchProtocol` | `search.py` | Full-text search |
-| `PrintProtocol` | `print.py` | PDF/document generation |
-| `I18nProtocol` | `i18n.py` | Internationalization |
-
----
-
-## RepositoryProtocol
-
-**Purpose**: Data access for documents with filtering, pagination, and optimistic concurrency.
-
-```python
-from typing import Protocol, Generic, TypeVar
-
-T = TypeVar("T")
-
-class RepositoryProtocol(Protocol[T]):
-    async def get(self, name: str) -> T | None:
-        """Fetch a document by its name."""
-        ...
-    
-    async def save(self, doc: T, version: int | None = None) -> T:
-        """Save a document with optional optimistic concurrency."""
-        ...
-    
-    async def delete(self, name: str) -> None:
-        """Delete a document."""
-        ...
-    
-    async def exists(self, name: str) -> bool:
-        """Check if a document exists."""
-        ...
-    
-    async def list(
-        self,
-        filters: FilterSpec | None = None,
-        order_by: list[OrderSpec] | None = None,
-        limit: int | None = None,
-        offset: int | None = None,
-    ) -> PaginatedResult[T]:
-        """List documents with filtering and pagination."""
-        ...
-```
-
-**Key Types**:
-- `FilterSpec`: Nested filter conditions
-- `OrderSpec`: Sort specification (field, direction)
-- `PaginatedResult`: Paginated response with items and total
-
----
-
-## EventBusProtocol
-
-**Purpose**: Publish/subscribe event system with CloudEvents format.
-
-```python
-class EventBusProtocol(Protocol):
-    async def publish(self, event: CloudEvent) -> None:
-        """Publish an event to all subscribers."""
-        ...
-    
-    async def subscribe(
-        self,
-        pattern: str,
-        handler: EventHandler,
-    ) -> str:
-        """Subscribe to events matching a pattern."""
-        ...
-    
-    async def unsubscribe(self, subscription_id: str) -> None:
-        """Remove a subscription."""
-        ...
-```
-
-**Event Types**:
-- `doc.created` - Document created
-- `doc.updated` - Document modified
-- `doc.deleted` - Document deleted
-- `workflow.transition` - Workflow state change
-
----
-
-## AuthContextProtocol
-
-**Purpose**: Access to current user, roles, and tenant information.
-
-```python
-class AuthContextProtocol(Protocol):
-    @property
-    def user(self) -> UserContext | None:
-        """Get current user or None for anonymous."""
-        ...
-    
-    def has_role(self, role: str) -> bool:
-        """Check if user has a specific role."""
-        ...
-    
-    def is_system_user(self) -> bool:
-        """Check if running as system (bypass permissions)."""
-        ...
-```
-
-**UserContext**:
-```python
-class UserContext:
-    user_id: str
-    email: str
-    full_name: str
-    roles: list[str]
-    tenant_id: str | None
-```
-
----
-
-## PermissionProtocol
-
-**Purpose**: Check permissions and generate Row-Level Security filters.
-
-```python
-class PermissionProtocol(Protocol):
-    async def can(
-        self,
-        action: PermissionAction,
-        doctype: str,
-        doc: BaseDocType | None = None,
-    ) -> bool:
-        """Check if user can perform action."""
-        ...
-    
-    async def get_permitted_filters(
-        self,
-        doctype: str,
-        action: PermissionAction,
-    ) -> FilterSpec:
-        """Get RLS filters for list queries."""
-        ...
-```
-
-**PermissionAction**: `read`, `write`, `create`, `delete`, `submit`, `cancel`
-
----
-
-## StorageProtocol
-
-**Purpose**: File storage with presigned URLs and metadata.
-
-```python
-class StorageProtocol(Protocol):
-    async def save_file(
-        self,
-        key: str,
-        content: bytes | AsyncIterable[bytes],
-        content_type: str | None = None,
-    ) -> FileMetadata:
-        """Save a file."""
-        ...
-    
-    async def get_file(self, key: str) -> bytes:
-        """Retrieve file content."""
-        ...
-    
-    async def get_url(
-        self,
-        key: str,
-        expires_in: int = 3600,
-    ) -> str:
-        """Get a presigned URL for direct access."""
-        ...
-    
-    async def delete_file(self, key: str) -> None:
-        """Delete a file."""
-        ...
-```
-
----
-
-## JobQueueProtocol
-
-**Purpose**: Enqueue background jobs with scheduling and retry.
-
-```python
-class JobQueueProtocol(Protocol):
-    async def enqueue(
-        self,
-        job_name: str,
-        *args: Any,
-        defer_by: int | None = None,
-        **kwargs: Any,
-    ) -> str:
-        """Enqueue a job for background execution."""
-        ...
-    
-    async def schedule(
-        self,
-        job_name: str,
-        cron: str,
-        *args: Any,
-        **kwargs: Any,
-    ) -> str:
-        """Schedule a recurring job."""
-        ...
-    
-    async def cancel(self, job_id: str) -> bool:
-        """Cancel a pending job."""
-        ...
-```
-
----
-
-## CacheProtocol
-
-**Purpose**: Key-value caching with TTL and pattern operations.
-
-```python
-class CacheProtocol(Protocol):
-    async def get(self, key: str) -> Any | None:
-        """Get a cached value."""
-        ...
-    
-    async def set(
-        self,
-        key: str,
-        value: Any,
-        ttl: int | None = None,
-    ) -> None:
-        """Set a cached value with optional TTL."""
-        ...
-    
-    async def delete(self, key: str) -> None:
-        """Delete a cached value."""
-        ...
-    
-    async def delete_pattern(self, pattern: str) -> int:
-        """Delete all keys matching a pattern."""
-        ...
-```
-
----
-
-## NotificationProtocol
-
-**Purpose**: Send notifications via email, SMS, push, etc.
-
-```python
-class NotificationProtocol(Protocol):
-    async def send(
-        self,
-        notification: Notification,
-    ) -> str:
-        """Send a notification."""
-        ...
-    
-    async def send_bulk(
-        self,
-        notifications: list[Notification],
-    ) -> list[str]:
-        """Send multiple notifications."""
-        ...
-```
-
-**Notification Types**: `email`, `sms`, `push`, `in_app`
-
----
-
-## SearchProtocol
-
-**Purpose**: Full-text search with facets and highlighting.
-
-```python
-class SearchProtocol(Protocol):
-    async def index(
-        self,
-        doctype: str,
-        doc_id: str,
-        data: dict[str, Any],
-    ) -> None:
-        """Index a document for search."""
-        ...
-    
-    async def search(
-        self,
-        query: str,
-        doctypes: list[str] | None = None,
-        filters: FilterSpec | None = None,
-        limit: int = 20,
-    ) -> SearchResult:
-        """Search documents."""
-        ...
-    
-    async def delete_index(
-        self,
-        doctype: str,
-        doc_id: str,
-    ) -> None:
-        """Remove a document from search index."""
-        ...
-```
-
----
-
-## PrintProtocol
-
-**Purpose**: Generate PDF/HTML documents from templates.
-
-```python
-class PrintProtocol(Protocol):
-    async def render(
-        self,
-        template: str,
-        data: dict[str, Any],
-        format: Literal["pdf", "html"] = "pdf",
-    ) -> bytes:
-        """Render a template to PDF or HTML."""
-        ...
-    
-    async def get_template(self, name: str) -> Template:
-        """Get a print template by name."""
-        ...
-```
-
----
-
-## I18nProtocol
-
-**Purpose**: Internationalization and localization.
-
-```python
-class I18nProtocol(Protocol):
-    def translate(
-        self,
-        key: str,
-        locale: str | None = None,
-        **kwargs: Any,
-    ) -> str:
-        """Translate a key to the target locale."""
-        ...
-    
-    def get_locale(self) -> str:
-        """Get the current locale."""
-        ...
-    
-    def list_locales(self) -> list[str]:
-        """List available locales."""
-        ...
-```
-
----
-
-## Using Protocols
-
-### In Business Logic
-
-```python
-from framework_m.core.interfaces import RepositoryProtocol
-
-class InvoiceService:
-    def __init__(self, repo: RepositoryProtocol[Invoice]) -> None:
-        self.repo = repo
-    
-    async def create_invoice(self, data: dict) -> Invoice:
-        invoice = Invoice(**data)
-        return await self.repo.save(invoice)
-```
-
-### With Dependency Injection
-
-```python
-from dependency_injector.wiring import inject, Provide
-from framework_m.core.container import Container
-from framework_m.core.interfaces import RepositoryProtocol
-
-@inject
-async def get_invoices(
-    repo: RepositoryProtocol = Provide[Container.repository],
-) -> list[Invoice]:
-    result = await repo.list()
-    return result.items
-```
-
-### In Testing
-
-```python
-class MockRepository:
-    def __init__(self):
-        self.data = {}
-    
-    async def get(self, name: str) -> Invoice | None:
-        return self.data.get(name)
-    
-    async def save(self, doc: Invoice) -> Invoice:
-        self.data[doc.name] = doc
-        return doc
-
-# In tests
-def test_invoice_creation():
-    repo = MockRepository()
-    service = InvoiceService(repo)
-    # ...
-```