Merge branch 'main' into refactor-follow-activities-and-test-data-previously

Author: aaronjae22

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.2  # Use the latest version from https://github.com/astral-sh/ruff-pre-commit/releases
+    hooks:
+      # Run the linter.
+      - id: ruff
+      # Run the formatter.
+      - id: ruff-format

README.md

@@ -64,5 +64,31 @@ To run the tests, use the following command:
 pytest
 ```
 
+## 🧹 pre-commit Hooks
+
+We use [pre-commit](https://pre-commit.com/) to automatically lint and format code before each commit, ensuring code quality and consistency.
+
+### 🚀 Setting it up
+
+1. **Install the pre-commit hook**  
+   This sets up Git hooks in your local repo:
+
+   ```sh
+   pre-commit install
+   ```
+
+2. **You're all set!**  
+   Now, every time you commit, `pre-commit` will automatically run checks (like `ruff`) on staged files.
+
+### 💡 Run checks manually (optional)
+
+To run all hooks on all files manually:
+
+```bash
+pre-commit run --all-files
+```
+
+This is useful for checking your work before pushing large changes.
+
 ## License
 This project is licensed under the Apache License 2.0.

conftest.py

@@ -1,6 +1,7 @@
 import pytest
 
+
 def pytest_collection_modifyitems(items):
     # Automatically adds django_db marker to all test functions
     for item in items:
-        item.add_marker(pytest.mark.django_db)
+        item.add_marker(pytest.mark.django_db)

main.py

@@ -6,11 +6,11 @@
 
 def print_hi(name):
     # Use a breakpoint in the code line below to debug your script.
-    print(f'Welcome to {name}')  # Press ⌘F8 to toggle the breakpoint.
+    print(f"Welcome to {name}")  # Press ⌘F8 to toggle the breakpoint.
 
 
 # Press the green button in the gutter to run the script.
-if __name__ == '__main__':
-    print_hi('Activity Pub Testbed Project')
+if __name__ == "__main__":
+    print_hi("Activity Pub Testbed Project")
 
 # See PyCharm help at https://www.jetbrains.com/help/pycharm/

manage.py

@@ -1,12 +1,13 @@
 #!/usr/bin/env python
 """Django's command-line utility for administrative tasks."""
+
 import os
 import sys
 
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'testbed.settings.development')
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testbed.settings.development")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:
@@ -18,5 +19,5 @@ def main():
     execute_from_command_line(sys.argv)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

requirements.txt

@@ -8,8 +8,10 @@ factory_boy==3.3.1
 html-sanitizer==2.4.4
 Markdown==3.7
 pip-tools==7.4.1
+pre_commit==4.2.0
 psycopg2==2.9.10
 pytest==8.3.3
 pytest-cov==6.0.0
 pytest-django==4.9.0
-requests==2.32.3
+requests==2.32.3
+ruff==0.11.2

testbed/asgi.py

@@ -11,6 +11,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'testbed.settings.production')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testbed.settings.production")
 
 application = get_asgi_application()

testbed/core/admin.py

@@ -1,98 +1,117 @@
 from django.contrib import admin
 from .models import (
-        Actor,
-        Note,
-        CreateActivity,
-        LikeActivity,
-        FollowActivity,
-        PortabilityOutbox
-    )
+    Actor,
+    Note,
+    CreateActivity,
+    LikeActivity,
+    FollowActivity,
+    PortabilityOutbox,
+)
 
 
 @admin.register(Actor)
 class ActorAdmin(admin.ModelAdmin):
-    list_display = ('username', 'full_name', 'created_at', 'updated_at')
-    search_fields = ('username', 'full_name')
-    readonly_fields = ('created_at', 'updated_at')
+    list_display = ("username", "full_name", "created_at", "updated_at")
+    search_fields = ("username", "full_name")
+    readonly_fields = ("created_at", "updated_at")
+
 
 @admin.register(Note)
 class NoteAdmin(admin.ModelAdmin):
-    list_display = ('actor', 'content', 'published', 'visibility')
-    list_filter = ('visibility', 'published')
-    search_fields = ('content', 'actor__username')
+    list_display = ("actor", "content", "published", "visibility")
+    list_filter = ("visibility", "published")
+    search_fields = ("content", "actor__username")
+
 
 @admin.register(CreateActivity)
 class CreateActivityAdmin(admin.ModelAdmin):
-    list_display = ('actor', 'timestamp', 'visibility')
-    list_filter = ('visibility', 'timestamp')
+    list_display = ("actor", "timestamp", "visibility")
+    list_filter = ("visibility", "timestamp")
+
 
 @admin.register(LikeActivity)
 class LikeActivityAdmin(admin.ModelAdmin):
-    list_display = ('actor', 'get_liked_object', 'timestamp', 'visibility') 
-    list_filter = ('visibility', 'timestamp')
-    search_fields = ('actor__username', 'object_url', 'object_data__content') 
+    list_display = ("actor", "get_liked_object", "timestamp", "visibility")
+    list_filter = ("visibility", "timestamp")
+    search_fields = ("actor__username", "object_url", "object_data__content")
 
     def get_liked_object(self, obj):
         if obj.note:
             return f"Local: {obj.note}"
-        return f"Remote: {obj.object_data.get('content', '')[:50]}... ({obj.object_url})"
+        return (
+            f"Remote: {obj.object_data.get('content', '')[:50]}... ({obj.object_url})"
+        )
+
     get_liked_object.short_description = "Liked Object"
 
+
 @admin.register(FollowActivity)
 class FollowActivityAdmin(admin.ModelAdmin):
-    list_display = ('actor', 'target_actor', 'timestamp', 'visibility')
-    list_filter = ('visibility', 'timestamp')
+    list_display = ("actor", "target_actor", "timestamp", "visibility")
+    list_filter = ("visibility", "timestamp")
+
 
 @admin.register(PortabilityOutbox)
 class PortabilityOutboxAdmin(admin.ModelAdmin):
-    list_display = ('actor', 'created_at')
-    readonly_fields = ('created_at', 'get_create_activities', 'get_like_activities', 'get_follow_activities')
-    fields = ('actor', 'created_at', 'get_create_activities', 'get_like_activities', 'get_follow_activities')
+    list_display = ("actor", "created_at")
+    readonly_fields = (
+        "created_at",
+        "get_create_activities",
+        "get_like_activities",
+        "get_follow_activities",
+    )
+    fields = (
+        "actor",
+        "created_at",
+        "get_create_activities",
+        "get_like_activities",
+        "get_follow_activities",
+    )
 
     def get_create_activities(self, obj):
         if not obj:
             return "No create activities"
-        
+
         create_activities = obj.activities_create.filter(actor=obj.actor)
         output = []
         for activity in create_activities:
             if activity.note:
                 output.append(f"Created note: {activity.note.content[:50]}...")
             else:
                 output.append("Created actor profile")
-        
+
         return "\n".join(output) if output else "No create activities"
-    
+
     get_create_activities.short_description = "Create Activities"
 
     def get_like_activities(self, obj):
         if not obj:
             return "No like activities"
-        
+
         like_activities = obj.activities_like.filter(actor=obj.actor)
         output = []
         for activity in like_activities:
             if activity.note:
                 output.append(f"Liked local: {activity.note.content[:50]}...")
             else:
-                content = activity.object_data.get('content', '')[:50]
+                content = activity.object_data.get("content", "")[:50]
                 output.append(f"Liked remote: {content}... ({activity.object_url})")
-        
+
         return "\n".join(output) if output else "No like activities"
-    
+
     get_like_activities.short_description = "Like Activities"
 
     def get_follow_activities(self, obj):
         if not obj:
             return "No follow activities"
-        
+
         follow_activities = obj.activities_follow.filter(actor=obj.actor)
         output = []
         for activity in follow_activities:
             output.append(f"Followed: {activity.target_actor.username}")
-        
+
         return "\n".join(output) if output else "No follow activities"
-    
+
     get_follow_activities.short_description = "Follow Activities"
 
     def has_add_permission(self, request):

testbed/core/apps.py

@@ -2,5 +2,5 @@
 
 
 class CoreConfig(AppConfig):
-    default_auto_field = 'django.db.models.BigAutoField'
-    name = 'testbed.core'
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "testbed.core"

testbed/core/factories.py

@@ -2,21 +2,22 @@
 from factory.django import DjangoModelFactory
 from django.contrib.auth.models import User
 from testbed.core.models import (
-    Actor, Note,
+    Actor,
+    Note,
     CreateActivity,
     LikeActivity,
     FollowActivity,
-    PortabilityOutbox
+    PortabilityOutbox,
 )
 
 
 class UserFactory(DjangoModelFactory):
     class Meta:
         model = User
 
-    username = factory.Sequence(lambda n: f'user_{n}')
-    email = factory.LazyAttribute(lambda o: f'{o.username}@example.com')
-    password = factory.PostGenerationMethodCall('set_password', 'testpass123')
+    username = factory.Sequence(lambda n: f"user_{n}")
+    email = factory.LazyAttribute(lambda o: f"{o.username}@example.com")
+    password = factory.PostGenerationMethodCall("set_password", "testpass123")
     is_staff = False
     is_active = True
 
@@ -41,8 +42,8 @@ class Meta:
         model = Note
 
     actor = factory.SubFactory(ActorFactory)
-    content = factory.Faker('text', max_nb_chars=200)
-    visibility = factory.Iterator(['public', 'private', 'followers-only'])
+    content = factory.Faker("text", max_nb_chars=200)
+    visibility = factory.Iterator(["public", "private", "followers-only"])
 
 
 class CreateActivityFactory(DjangoModelFactory):
@@ -51,34 +52,34 @@ class Meta:
 
     actor = factory.SubFactory(ActorFactory)
     note = factory.SubFactory(NoteFactory)
-    visibility = factory.Iterator(['public', 'private', 'followers-only'])
+    visibility = factory.Iterator(["public", "private", "followers-only"])
 
     # Helper method to create a CreateActivity for Actor creation
     @classmethod
     def create_for_actor(cls, actor):
         return cls.create(
             actor=actor,
-            note=None, # No note means this is an Actor creation activity
-            visibility='public'
+            note=None,  # No note means this is an Actor creation activity
+            visibility="public",
         )
-    
+
 
 class LikeActivityFactory(DjangoModelFactory):
     class Meta:
         model = LikeActivity
 
     actor = factory.SubFactory(ActorFactory)
-    note = factory.SubFactory(NoteFactory) # Required for Like activity
-    visibility = factory.Iterator(['public', 'private', 'followers-only'])
+    note = factory.SubFactory(NoteFactory)  # Required for Like activity
+    visibility = factory.Iterator(["public", "private", "followers-only"])
 
 
 class FollowActivityFactory(DjangoModelFactory):
     class Meta:
         model = FollowActivity
 
     actor = factory.SubFactory(ActorFactory)
-    target_actor = factory.SubFactory(ActorFactory) # Required for Follow activity
-    visibility = factory.Iterator(['public', 'private', 'followers-only'])
+    target_actor = factory.SubFactory(ActorFactory)  # Required for Follow activity
+    visibility = factory.Iterator(["public", "private", "followers-only"])
 
 
 class PortabilityOutboxFactory(DjangoModelFactory):