Compare commits

...
2 Commits
Author SHA1 Message Date
Phil 88088e10e1 Merge branch 'fix/v2.3.3-micropub-title-source-url' for v2.3.3 release
Build Container / build (push) Successful in 7s
2026-10-31 19:34:24 -06:00
PhilandClaude Opus 5.5 391bdb9db3 fix: Micropub titles, q=source URL, single title display (v2.3.3)
Micropub `name` was dropped; store it as the note's '# Heading' first
line, which is how StarPunk titles work. q=source returned /notes/<slug>
(a 404) and a name for every note; it now returns the real permalink and
name only for titled notes, without the heading in content. Titled notes
no longer show their title twice (Note.body_html, excerpt).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-31 19:34:23 -06:00
8 changed files with 191 additions and 39 deletions

No files matched your search

+9
View File
@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
## [2.3.3] - 2026-10-31
### Fixed
- Micropub `name` was ignored, so titles sent by Micropub clients never appeared. It is now stored as the note's `# Heading` first line, which is how StarPunk titles work
- Micropub `q=source` returned `/notes/<slug>` links (a 404); it now returns the real permalink `/note/<slug>`
- Micropub `q=source` reported every note's first line as its `name`; it now returns `name` only for titled notes, with the heading left out of `content`, matching what was posted
- Titled notes showed their title twice: as the page heading and again at the top of the body (and of the home-page summary)
## [2.3.2] - 2026-10-31
### Changed
@@ -0,0 +1,23 @@
# v2.3.3: Micropub titles, q=source URL, single title display
Found while building tuipub, a terminal Micropub client, against StarPunk.
## Problems
1. **Micropub `name` dropped.** `handle_create` called `extract_title()` and threw the result away. StarPunk has no title column: `Note.title` is derived from the content's first line, and a `# Heading` first line marks a titled note (Q22). So a `name` sent by a client never showed up.
2. **`q=source` URL wrong.** It built `{SITE_URL}notes/{slug}`, but the route is `/note/<slug>`, so the URL was a 404.
3. **`q=source` name wrong.** It returned `note.title` for every note. For untitled notes that is just the first line of the content, so clients saw a `name` they never sent.
4. **Title shown twice.** `note.html` renders the title as `<h1 class="p-name">` and then the whole content, which includes the `# Heading` again. Home-page previews did the same with the excerpt.
## Decisions
- Store `name` as a `# {name}` first line (`micropub.add_title_heading`) rather than adding a title column. This matches how titled notes already work everywhere (pages, feeds, search, admin editor), and needs no migration. If the content already starts with that exact heading, it isn't added twice.
- `models.split_title()` is the single definition of "title heading": the first non-blank line starting with `#` (the same rule as the templates' `has_explicit_title`). `q=source` uses it to return `name` + `content` the way they were posted.
- `Note.body_html` renders the content without the title heading; `note.html` uses it. `Note.excerpt` also leaves the title out. `Note.html` is unchanged, so feeds and syndication behave as before (feed items carry a separate title anyway).
- `extract_title()` no longer derives a fallback title from content: that value was never used.
## Tests
- `tests/test_micropub.py`: name stored as heading, no duplicate heading, `q=source` url equals the Location permalink, `name` only for titled notes, round trip.
- `tests/test_models.py`: `split_title`, `body_html`, excerpt without title.
- Checked end to end with tuipub against a local dev server: titled post → page shows the title once, `q=source` returns `name`, `content` and a working url.
+1 -1
View File
@@ -464,5 +464,5 @@ def create_app(config=None):
# Package version (Semantic Versioning 2.0.0)
# See docs/standards/versioning-strategy.md for details
__version__ = "2.3.2"
__version__ = "2.3.3"
__version_info__ = (2, 1, 0)
+26 -33
View File
@@ -7,7 +7,7 @@ interface for creating posts via external clients.
Functions:
normalize_properties: Convert form/JSON data to Micropub properties format
extract_content: Get content from Micropub properties
extract_title: Get or generate title from Micropub properties
extract_title: Get the explicit title (name) from Micropub properties
extract_tags: Get category tags from Micropub properties
handle_create: Process Micropub create action
handle_query: Process Micropub query endpoints
@@ -28,6 +28,7 @@ from typing import Optional
from flask import Request, current_app, jsonify
from starpunk.models import split_title
from starpunk.notes import create_note, get_note, InvalidNoteDataError, NoteNotFoundError
from starpunk.indieauth import check_scope
from starpunk.utils import absolute_url_for
@@ -189,38 +190,31 @@ def extract_content(properties: dict) -> str:
def extract_title(properties: dict) -> Optional[str]:
"""
Extract or generate title from Micropub properties
Extract the explicit title (Micropub 'name' property)
Per ADR-029 mapping rules:
1. Use 'name' property if provided
2. If no name, extract from content (first line, max 50 chars)
StarPunk has no title field: a note's title is a '# Heading' first line
(see Note.title), so the caller stores the name as that heading.
Args:
properties: Normalized Micropub properties dict
Returns:
Title string or None
Title on a single line, or None if no name was sent
"""
# Try explicit name property first
name = properties.get("name", [""])[0]
if name:
return name.strip()
name = (properties.get("name") or [""])[0]
if not isinstance(name, str):
return None
return " ".join(name.split()) or None
# Generate from content (first line, max 50 chars)
content_list = properties.get("content", [])
if content_list:
content = content_list[0]
# Handle structured content
if isinstance(content, dict):
content = content.get("text") or content.get("html", "")
if content:
first_line = content.split("\n")[0].strip()
if len(first_line) > 50:
return first_line[:50] + "..."
return first_line
return None
def add_title_heading(content: str, title: Optional[str]) -> str:
"""Prefix content with '# title' unless it already starts with that heading"""
if not title:
return content
first_line = content.lstrip().split("\n", 1)[0]
if first_line.startswith("#") and first_line.lstrip("#").strip() == title:
return content
return f"# {title}\n\n{content}"
def extract_tags(properties: dict) -> list[str]:
@@ -428,7 +422,7 @@ def handle_create(data: dict, token_info: dict):
# Create note using existing CRUD
try:
note = create_note(
content=content,
content=add_title_heading(content, title),
published=True, # Micropub posts are published by default
created_at=published_date,
custom_slug=custom_slug,
@@ -520,21 +514,20 @@ def handle_query(args: dict, token_info: dict):
current_app.logger.error(f"Failed to get note source: {e}")
return error_response("server_error", "Failed to retrieve post")
# Convert note to Micropub Microformats2 format
# Note: SITE_URL is normalized to include trailing slash (for IndieAuth spec compliance)
site_url = current_app.config.get("SITE_URL", "http://localhost:5000")
# Convert note to Micropub Microformats2 format. A '# Heading' first
# line is the title, returned as name (mirrors how create stores it).
title, content = split_title(note.content)
mf2 = {
"type": ["h-entry"],
"properties": {
"content": [note.content],
"content": [content],
"published": [note.created_at.isoformat()],
"url": [f"{site_url}notes/{note.slug}"],
"url": [absolute_url_for("public.note", slug=note.slug)],
},
}
# Add optional properties
if note.title:
mf2["properties"]["name"] = [note.title]
if title:
mf2["properties"]["name"] = [title]
# Add tags if present (v1.3.0)
if note.tags:
+33 -3
View File
@@ -43,6 +43,23 @@ MAX_TITLE_LENGTH = 200
EXCERPT_LENGTH = 200
def split_title(content: str) -> tuple[Optional[str], str]:
"""
Split a note's '# Heading' first line (its title, per Q22) off its content
Returns:
(title, remaining content); title is None if the note has no heading
"""
stripped = content.lstrip()
if not stripped.startswith("#"):
return None, content
first_line, _, rest = stripped.partition("\n")
title = first_line.lstrip("#").strip()
if not title:
return None, content
return title, rest.strip()
@dataclass(frozen=True)
class Note:
"""
@@ -244,6 +261,19 @@ class Note:
return self._cached_html
@property
def body_html(self) -> str:
"""
Rendered HTML without the title heading
Pages show a titled note's title as their own heading, so the body
leaves it out to avoid showing it twice. Untitled notes: same as html.
"""
title, body = split_title(self.content)
if title is None:
return self.html
return markdown.markdown(body, extensions=MARKDOWN_EXTENSIONS)
@property
def title(self) -> str:
"""
@@ -311,10 +341,10 @@ class Note:
'This is my note content. It has some interesting points...'
"""
try:
# Get content
content = self.content
# Leave out the title; previews show it separately
_, content = split_title(self.content)
# Remove markdown heading syntax from first line
# Remove markdown heading syntax
lines = content.split("\n")
cleaned_lines = []
for line in lines:
+1 -1
View File
@@ -44,7 +44,7 @@
{# e-content: note content BELOW media (per ADR-057) #}
<div class="e-content">
{{ note.html|safe }}
{{ note.body_html|safe }}
</div>
<footer class="note-meta">
+60
View File
@@ -167,6 +167,34 @@ def test_micropub_create_with_name(client, app, mock_valid_token):
assert response.status_code == 201
assert 'Location' in response.headers
# StarPunk titles are a '# Heading' first line, so name must land there
slug = response.headers['Location'].rstrip('/').split('/')[-1]
with app.app_context():
note = get_note(slug)
assert note.content == '# My Test Title\n\nContent goes here'
assert note.title == 'My Test Title'
def test_micropub_create_with_name_already_heading(client, app, mock_valid_token):
"""A name that matches the content's heading is not added twice"""
with patch('starpunk.routes.micropub.verify_access_token', mock_valid_token):
response = client.post(
'/micropub',
json={
'type': ['h-entry'],
'properties': {
'name': ['Same Title'],
'content': ['# Same Title\n\nBody']
}
},
headers={'Authorization': 'Bearer valid_token'}
)
assert response.status_code == 201
slug = response.headers['Location'].rstrip('/').split('/')[-1]
with app.app_context():
assert get_note(slug).content == '# Same Title\n\nBody'
def test_micropub_create_with_categories(client, app, mock_valid_token):
"""Test creating a note with tags (category property)"""
@@ -290,6 +318,38 @@ def test_micropub_query_source(client, mock_valid_token):
data = response.get_json()
assert 'properties' in data
assert data['properties']['content'][0] == 'Source test'
# url must be the real permalink (was /notes/<slug>, a 404)
assert data['properties']['url'] == [location]
# A note without a heading has no name
assert 'name' not in data['properties']
def test_micropub_query_source_with_name(client, mock_valid_token):
"""q=source returns name and content the way they were posted"""
with patch('starpunk.routes.micropub.verify_access_token', mock_valid_token):
create_response = client.post(
'/micropub',
json={
'type': ['h-entry'],
'properties': {
'name': ['Round Trip'],
'content': ['Body text']
}
},
headers={'Authorization': 'Bearer valid_token'}
)
location = create_response.headers['Location']
response = client.get(
f'/micropub?q=source&url={location}',
headers={'Authorization': 'Bearer valid_token'}
)
assert response.status_code == 200
properties = response.get_json()['properties']
assert properties['name'] == ['Round Trip']
assert properties['content'] == ['Body text']
assert properties['url'] == [location]
# Error Handling Tests
+38 -1
View File
@@ -11,7 +11,7 @@ Organized by model:
import pytest
from datetime import datetime, timedelta
from pathlib import Path
from starpunk.models import Note, Session, Token, AuthState
from starpunk.models import Note, Session, Token, AuthState, split_title
from starpunk.utils import calculate_content_hash
@@ -245,6 +245,43 @@ class TestNoteModel:
assert note.excerpt == "my-note"
def _note_with(self, tmp_path, content):
note_file = tmp_path / "notes" / "2024" / "11" / "test.md"
note_file.parent.mkdir(parents=True, exist_ok=True)
note_file.write_text(content)
return Note(
id=1,
slug="test",
file_path="notes/2024/11/test.md",
published=True,
created_at=datetime.utcnow(),
updated_at=datetime.utcnow(),
_data_dir=tmp_path,
)
def test_split_title(self):
"""A '# Heading' first line is split off as the title"""
assert split_title("# My Title\n\nBody") == ("My Title", "Body")
assert split_title("\n## Sub\nBody") == ("Sub", "Body")
assert split_title("No heading\n# later") == (None, "No heading\n# later")
assert split_title("#\nBody") == (None, "#\nBody")
def test_body_html_leaves_out_title(self, tmp_path):
"""Pages show the title themselves, so the body must not repeat it"""
note = self._note_with(tmp_path, "# My Title\n\nBody text.")
assert "My Title" not in note.body_html
assert "<p>Body text.</p>" in note.body_html
assert "<h1>My Title</h1>" in note.html # html is unchanged
def test_body_html_untitled_matches_html(self, tmp_path):
note = self._note_with(tmp_path, "Plain note.")
assert note.body_html == note.html
def test_excerpt_leaves_out_title(self, tmp_path):
"""Previews show the title above the excerpt, so it is not repeated"""
note = self._note_with(tmp_path, "# Title\n\nShort content.")
assert note.excerpt == "Short content."
def test_permalink(self):
"""Test permalink generation"""
note = Note(