bejw 0.2.2__tar.gz → 0.2.4__tar.gz

{bejw-0.2.2 → bejw-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bejw
-Version: 0.2.2
+Version: 0.2.4
 Summary: A capped reading list for links that shimmer
 Author: menisadi
 License: MIT License
@@ -53,11 +53,15 @@ python main.py --help
 python main.py init --capacity 10
 python main.py add "https://example.com" "Example"
 python main.py list
-python main.py remove <id>
+python main.py list --format tsv --show-ids | fzf
+python main.py list --format jsonl | jq .
+python main.py remove <number>
 python main.py capacity 5
 python main.py clear
 ```
 
+`list` output includes a 1-based number column that matches the `remove` command.
+
 ## Storage
 
 By default, data is stored in `~/.bejw/links.json`.

{bejw-0.2.2 → bejw-0.2.4}/README.md

@@ -15,11 +15,15 @@ python main.py --help
 python main.py init --capacity 10
 python main.py add "https://example.com" "Example"
 python main.py list
-python main.py remove <id>
+python main.py list --format tsv --show-ids | fzf
+python main.py list --format jsonl | jq .
+python main.py remove <number>
 python main.py capacity 5
 python main.py clear
 ```
 
+`list` output includes a 1-based number column that matches the `remove` command.
+
 ## Storage
 
 By default, data is stored in `~/.bejw/links.json`.

{bejw-0.2.2 → bejw-0.2.4}/bejw/main.py

@@ -2,12 +2,13 @@
 bejw:  A capped reading list for links that shimmer
 """
 
+import webbrowser
 from pathlib import Path
 
 import typer
 
 from .models import CapacityError, ReadingList
-from .render import render_links
+from .render import OutputFormat, render_links
 from .storage import load, save
 from rich import print
 
@@ -50,25 +51,63 @@ def add(url: str, title: str, file_path: str = DEFAULT_FILE_PATH) -> None:
         )
         raise typer.Exit(code=1)
     save(reading_list, file_path)
-    typer.echo(f"Added {link.id}")
+    ordered = reading_list.ordered_links()
+    number = next(
+        (index for index, item in enumerate(ordered, start=1) if item.id == link.id),
+        len(ordered),
+    )
+    typer.echo(f"Added #{number}")
 
 
 @app.command()
-def remove(link_id: str, file_path: str = DEFAULT_FILE_PATH) -> None:
-    """Remove a link from the reading list by id."""
+def remove(number: int, file_path: str = DEFAULT_FILE_PATH) -> None:
+    """Remove a link from the reading list by number."""
     reading_list = load(file_path)
-    removed = reading_list.remove_link(link_id)
+    removed = reading_list.remove_by_number(number)
     save(reading_list, file_path)
     if not removed:
-        typer.echo("No link found with that id.")
+        typer.echo("No link found with that number.")
+        raise typer.Exit(code=1)
+
+
+@app.command()
+def read(number: int, file_path: str = DEFAULT_FILE_PATH) -> None:
+    """Open a link from the reading list by number."""
+    reading_list = load(file_path)
+    ordered = reading_list.ordered_links()
+    if number < 1 or number > len(ordered):
+        typer.echo("No link found with that number.")
         raise typer.Exit(code=1)
 
+    url = ordered[number - 1].url
+    webbrowser.open(url)
+    typer.echo(f"Opened #{number}: {url}")
+
 
 @app.command()
-def list(file_path: str = DEFAULT_FILE_PATH, show_ids: bool = False) -> None:
+def list(
+    file_path: str = DEFAULT_FILE_PATH,
+    show_ids: bool = False,
+    output_format: OutputFormat = typer.Option(
+        OutputFormat.TABLE,
+        "--format",
+        "-f",
+        help="Output format: table, tsv, csv, or jsonl.",
+    ),
+    no_header: bool = typer.Option(
+        False,
+        "--no-header",
+        help="Omit the header row for tsv and csv output.",
+    ),
+) -> None:
     """Display the reading list."""
     reading_list = load(file_path)
-    render_links(reading_list, show_ids=show_ids)
+    render_links(
+        reading_list,
+        show_ids=show_ids,
+        output_format=output_format,
+        include_header=not no_header,
+    )
 
 
 @app.command()

{bejw-0.2.2 → bejw-0.2.4}/bejw/models.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
+from datetime import datetime, timedelta, timezone
 from typing import Iterable
 from uuid import uuid4
 
@@ -17,10 +18,22 @@ class Link:
     id: str
     url: str
     title: str
+    created_at: str
 
     @staticmethod
     def create(url: str, title: str) -> "Link":
-        return Link(id=str(uuid4()), url=url, title=title)
+        created_at = datetime.now(timezone.utc).isoformat()
+        return Link(id=str(uuid4()), url=url, title=title, created_at=created_at)
+
+
+def _created_at_key(link: Link) -> datetime:
+    try:
+        created_at = datetime.fromisoformat(link.created_at)
+    except ValueError:
+        return datetime.min.replace(tzinfo=timezone.utc)
+    if created_at.tzinfo is None:
+        return created_at.replace(tzinfo=timezone.utc)
+    return created_at
 
 
 class ReadingList:
@@ -35,11 +48,21 @@ class ReadingList:
         self.links.append(link)
         return link
 
+    def ordered_links(self) -> list[Link]:
+        return sorted(self.links, key=_created_at_key)
+
     def remove_link(self, link_id: str) -> bool:
         before = len(self.links)
         self.links = [link for link in self.links if link.id != link_id]
         return len(self.links) < before
 
+    def remove_by_number(self, number: int) -> bool:
+        ordered = self.ordered_links()
+        if number < 1 or number > len(ordered):
+            return False
+        target_id = ordered[number - 1].id
+        return self.remove_link(target_id)
+
     def clear_links(self) -> None:
         self.links = []
 
@@ -51,6 +74,15 @@ class ReadingList:
 
     @staticmethod
     def from_dict(data: dict) -> "ReadingList":
-        links = [Link(**item) for item in data.get("links", [])]
+        raw_links = data.get("links", [])
+        base_time = datetime(1970, 1, 1, tzinfo=timezone.utc)
+        links = []
+        for index, item in enumerate(raw_links):
+            if "created_at" not in item:
+                item = {
+                    **item,
+                    "created_at": (base_time + timedelta(seconds=index)).isoformat(),
+                }
+            links.append(Link(**item))
         capacity = data.get("capacity", 10)
         return ReadingList(capacity=capacity, links=links)

bejw-0.2.4/bejw/render.py

@@ -0,0 +1,105 @@
+import csv
+import io
+import json
+from enum import StrEnum
+
+from rich.console import Console
+from rich.table import Table, box
+
+from .models import ReadingList
+
+console = Console()
+
+
+class OutputFormat(StrEnum):
+    TABLE = "table"
+    TSV = "tsv"
+    CSV = "csv"
+    JSONL = "jsonl"
+
+
+def _link_headers(show_ids: bool) -> list[str]:
+    headers = ["no"]
+    if show_ids:
+        headers.append("id")
+    headers.extend(["title", "url"])
+    return headers
+
+
+def _link_values(reading_list: ReadingList, show_ids: bool) -> list[list[str]]:
+    rows: list[list[str]] = []
+    ordered = reading_list.ordered_links()
+    for index, link in enumerate(ordered, start=1):
+        row: list[str] = [str(index)]
+        if show_ids:
+            row.append(link.id)
+        row.append(link.title)
+        row.append(link.url)
+        rows.append(row)
+    return rows
+
+
+def _render_delimited(
+    reading_list: ReadingList, show_ids: bool, include_header: bool, delimiter: str
+) -> str:
+    output = io.StringIO()
+    writer = csv.writer(output, delimiter=delimiter, lineterminator="\n")
+
+    if include_header:
+        writer.writerow(_link_headers(show_ids))
+    writer.writerows(_link_values(reading_list, show_ids))
+    return output.getvalue()
+
+
+def _render_jsonl(reading_list: ReadingList, show_ids: bool) -> str:
+    """Render the reading list as JSONL (JSON Lines) format."""
+    lines = []
+    ordered = reading_list.ordered_links()
+    for index, link in enumerate(ordered, start=1):
+        payload = {"number": index, "title": link.title, "url": link.url}
+        if show_ids:
+            payload["id"] = link.id
+        lines.append(json.dumps(payload, ensure_ascii=False))
+    # Join the lines. Add a final newline at the end if there are any lines
+    return "\n".join(lines) + ("\n" if lines else "")
+
+
+def render_links(
+    reading_list: ReadingList,
+    show_ids: bool = False,
+    output_format: OutputFormat = OutputFormat.TABLE,
+    include_header: bool = True,
+) -> None:
+    if output_format == OutputFormat.TSV:
+        console.file.write(_render_delimited(reading_list, show_ids, include_header, "\t"))
+        return
+    if output_format == OutputFormat.CSV:
+        console.file.write(_render_delimited(reading_list, show_ids, include_header, ","))
+        return
+    if output_format == OutputFormat.JSONL:
+        console.file.write(_render_jsonl(reading_list, show_ids))
+        return
+
+    # If non of the above formats were selected, rendering a table
+    table = Table(
+        title="Bejeweled Reading List",
+        box=box.SIMPLE,
+        title_justify="left",
+        title_style="bold red",
+    )
+    table.add_column("No.", style="cyan", no_wrap=True)
+    if show_ids:
+        table.add_column("ID", style="cyan", no_wrap=True)
+    table.add_column("Title", style="magenta")
+    table.add_column("URL", style="green")
+
+    ordered = reading_list.ordered_links()
+    for index, link in enumerate(ordered, start=1):
+        row = [str(index)]
+        if show_ids:
+            row.append(str(link.id))
+        row.append(link.title)
+        row.append(link.url)
+        table.add_row(*row)
+
+    console.print(table)

{bejw-0.2.2 → bejw-0.2.4}/bejw.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bejw
-Version: 0.2.2
+Version: 0.2.4
 Summary: A capped reading list for links that shimmer
 Author: menisadi
 License: MIT License
@@ -53,11 +53,15 @@ python main.py --help
 python main.py init --capacity 10
 python main.py add "https://example.com" "Example"
 python main.py list
-python main.py remove <id>
+python main.py list --format tsv --show-ids | fzf
+python main.py list --format jsonl | jq .
+python main.py remove <number>
 python main.py capacity 5
 python main.py clear
 ```
 
+`list` output includes a 1-based number column that matches the `remove` command.
+
 ## Storage
 
 By default, data is stored in `~/.bejw/links.json`.

{bejw-0.2.2 → bejw-0.2.4}/bejw.egg-info/SOURCES.txt

@@ -12,5 +12,7 @@ bejw.egg-info/dependency_links.txt
 bejw.egg-info/entry_points.txt
 bejw.egg-info/requires.txt
 bejw.egg-info/top_level.txt
+tests/test_cli_list_formats.py
+tests/test_cli_read.py
 tests/test_models.py
 tests/test_storage.py

{bejw-0.2.2 → bejw-0.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "bejw"
-version = "0.2.2"
+version = "0.2.4"
 description = "A capped reading list for links that shimmer"
 readme = "README.md"
 requires-python = ">=3.13"

bejw-0.2.4/tests/test_cli_list_formats.py

@@ -0,0 +1,83 @@
+from pathlib import Path
+
+from typer.testing import CliRunner
+
+from bejw.main import app
+from bejw.models import Link, ReadingList
+from bejw.storage import save
+
+
+runner = CliRunner()
+
+
+def _seed_reading_list(file_path: Path) -> None:
+    reading_list = ReadingList(
+        capacity=10,
+        links=[
+            Link(
+                id="id-1",
+                title="Example One",
+                url="https://example.com/1",
+                created_at="2024-01-01T00:00:00+00:00",
+            ),
+            Link(
+                id="id-2",
+                title="Example Two",
+                url="https://example.com/2",
+                created_at="2024-01-02T00:00:00+00:00",
+            ),
+        ],
+    )
+    save(reading_list, str(file_path))
+
+
+def test_list_tsv_with_header_and_ids(tmp_path: Path) -> None:
+    file_path = tmp_path / "links.json"
+    _seed_reading_list(file_path)
+
+    result = runner.invoke(
+        app,
+        ["list", "--file-path", str(file_path), "--show-ids", "--format", "tsv"],
+    )
+
+    assert result.exit_code == 0
+    assert (
+        result.stdout
+        == "no\tid\ttitle\turl\n"
+        "1\tid-1\tExample One\thttps://example.com/1\n"
+        "2\tid-2\tExample Two\thttps://example.com/2\n"
+    )
+
+
+def test_list_csv_without_header(tmp_path: Path) -> None:
+    file_path = tmp_path / "links.json"
+    _seed_reading_list(file_path)
+
+    result = runner.invoke(
+        app,
+        ["list", "--file-path", str(file_path), "--format", "csv", "--no-header"],
+    )
+
+    assert result.exit_code == 0
+    assert (
+        result.stdout
+        == "1,Example One,https://example.com/1\n"
+        "2,Example Two,https://example.com/2\n"
+    )
+
+
+def test_list_jsonl_with_ids(tmp_path: Path) -> None:
+    file_path = tmp_path / "links.json"
+    _seed_reading_list(file_path)
+
+    result = runner.invoke(
+        app,
+        ["list", "--file-path", str(file_path), "--show-ids", "--format", "jsonl"],
+    )
+
+    assert result.exit_code == 0
+    assert (
+        result.stdout
+        == '{"number": 1, "title": "Example One", "url": "https://example.com/1", "id": "id-1"}\n'
+        '{"number": 2, "title": "Example Two", "url": "https://example.com/2", "id": "id-2"}\n'
+    )

bejw-0.2.4/tests/test_cli_read.py

@@ -0,0 +1,72 @@
+import webbrowser
+from pathlib import Path
+
+from typer.testing import CliRunner
+
+from bejw.main import app
+from bejw.models import Link, ReadingList
+from bejw.storage import save
+
+
+runner = CliRunner()
+
+
+def _seed_reading_list(file_path: Path) -> None:
+    reading_list = ReadingList(
+        capacity=10,
+        links=[
+            Link(
+                id="id-1",
+                title="Example One",
+                url="https://example.com/1",
+                created_at="2024-01-01T00:00:00+00:00",
+            ),
+            Link(
+                id="id-2",
+                title="Example Two",
+                url="https://example.com/2",
+                created_at="2024-01-02T00:00:00+00:00",
+            ),
+        ],
+    )
+    save(reading_list, str(file_path))
+
+
+def test_read_opens_selected_link_and_prints_confirmation(
+    tmp_path: Path, monkeypatch
+) -> None:
+    file_path = tmp_path / "links.json"
+    _seed_reading_list(file_path)
+    opened: list[str] = []
+
+    def _fake_open(url: str, *_args, **_kwargs) -> bool:
+        opened.append(url)
+        return True
+
+    monkeypatch.setattr(webbrowser, "open", _fake_open)
+
+    result = runner.invoke(app, ["read", "2", "--file-path", str(file_path)])
+
+    assert result.exit_code == 0
+    assert opened == ["https://example.com/2"]
+    assert result.stdout == "Opened #2: https://example.com/2\n"
+
+
+def test_read_returns_error_when_number_is_missing(tmp_path: Path) -> None:
+    file_path = tmp_path / "links.json"
+    _seed_reading_list(file_path)
+
+    result = runner.invoke(app, ["read", "99", "--file-path", str(file_path)])
+
+    assert result.exit_code == 1
+    assert result.stdout == "No link found with that number.\n"
+
+
+def test_read_returns_error_for_empty_list(tmp_path: Path) -> None:
+    file_path = tmp_path / "links.json"
+    save(ReadingList(capacity=10), str(file_path))
+
+    result = runner.invoke(app, ["read", "1", "--file-path", str(file_path)])
+
+    assert result.exit_code == 1
+    assert result.stdout == "No link found with that number.\n"

{bejw-0.2.2 → bejw-0.2.4}/tests/test_models.py

@@ -11,6 +11,7 @@ def test_add_link_increases_size_and_returns_link() -> None:
     assert isinstance(link, Link)
     assert link.url == "https://example.com"
     assert link.title == "Example"
+    assert link.created_at
     assert len(reading_list.links) == 1
 
 
@@ -22,20 +23,20 @@ def test_add_link_raises_when_capacity_reached() -> None:
         reading_list.add_link("https://second.com", "Second")
 
 
-def test_remove_link_returns_true_when_found() -> None:
+def test_remove_by_number_returns_true_when_found() -> None:
     reading_list = ReadingList()
-    link = reading_list.add_link("https://example.com", "Example")
+    reading_list.add_link("https://example.com", "Example")
 
-    removed = reading_list.remove_link(link.id)
+    removed = reading_list.remove_by_number(1)
 
     assert removed is True
     assert reading_list.links == []
 
 
-def test_remove_link_returns_false_when_missing() -> None:
+def test_remove_by_number_returns_false_when_missing() -> None:
     reading_list = ReadingList()
 
-    removed = reading_list.remove_link("missing-id")
+    removed = reading_list.remove_by_number(2)
 
     assert removed is False
 

bejw-0.2.2/bejw/render.py

@@ -1,29 +0,0 @@
-from rich.console import Console
-from rich.table import Table, box
-
-from .models import ReadingList
-
-console = Console()
-
-
-def render_links(reading_list: ReadingList, show_ids: bool = False) -> None:
-    table = Table(
-        title="Bejeweled Reading List",
-        box=box.SIMPLE,
-        title_justify="left",
-        title_style="bold red",
-    )
-    if show_ids:
-        table.add_column("ID", style="cyan", no_wrap=True)
-    table.add_column("Title", style="magenta")
-    table.add_column("URL", style="green")
-
-    for link in reading_list.links:
-        row = []
-        if show_ids:
-            row.append(str(link.id))
-        row.append(link.title)
-        row.append(link.url)
-        table.add_row(*row)
-
-    console.print(table)