Feature/preceding following signs

ebl/signs/infrastructure/mongo_sign_repository.py

@@ -43,6 +43,12 @@ def filter_none(self, data, **kwargs):
         return {key: value for key, value in data.items() if value is not None}
 
 
+class OrderedSignSchema(Schema):
+    name = fields.String(required=True)
+    unicode = fields.List(fields.Int(), required=True)
+    sort_key = fields.Int(required=True)
+
+
 class LogogramSchema(Schema):
     logogram = fields.String(required=True)
     atf = fields.String(required=True)
@@ -101,6 +107,10 @@ def make_sign(self, data, **kwargs) -> Sign:
         return Sign(**data)
 
 
+class OrderedSignsSchema(Schema):
+    ordered_signs = fields.Nested(OrderedSignSchema, many=True, data_key="signs")
+
+
 class SignDtoSchema(SignSchema):
     @post_dump
     def make_sign_dto(self, data, **kwargs) -> Dict:
@@ -123,6 +133,57 @@ def find(self, name: SignName) -> Sign:
         data = self._collection.find_one_by_id(name)
         return cast(Sign, SignSchema(unknown=EXCLUDE).load(data))
 
+    def find_signs_by_order(self, name: SignName, order: str, sort_era: str) -> Sign:
+        key = self._collection.find_one_by_id(name)["sortKeys"][sort_era][0]
+        range_start = "$lt"
+        range_end = "$gte"
+        end_key = key - 5
+        if order == "following":
+            range_start = "$gt"
+            range_end = "$lte"
+            end_key = key + 5
+        cursor = self._collection.aggregate(
+            [
+                {
+                    "$match": {
+                        f"sortKeys.{sort_era}": {
+                            "$elemMatch": {
+                                f"{range_start}": key,
+                                f"{range_end}": end_key,
+                            }
+                        }
+                    }
+                },
+                {"$unwind": f"$sortKeys.{sort_era}"},
+                {
+                    "$match": {
+                        f"sortKeys.{sort_era}": {
+                            f"{range_start}": key,
+                            f"{range_end}": end_key,
+                        }
+                    }
+                },
+                {
+                    "$project": {
+                        "sign": 1,
+                        "unicode": 1,
+                        "name": "$_id",
+                        "sort_key": f"$sortKeys.{sort_era}",
+                    }
+                },
+                {"$sort": {"sort_key": 1}},
+                {"$group": {"_id": "1", "signs": {"$push": "$$ROOT"}}},
+                {
+                    "$project": {
+                        "signs.name": 1,
+                        "signs.unicode": 1,
+                        "signs.sort_key": 1,
+                    }
+                },
+            ]
+        )
+        return OrderedSignsSchema().load(cursor, unknown=EXCLUDE, many=True)
+
     def search(self, reading: str, sub_index: Optional[int] = None) -> Optional[Sign]:
         sub_index_query = {"$exists": False} if sub_index is None else sub_index
         try:

ebl/signs/web/bootstrap.py

@@ -5,13 +5,14 @@
     CroppedAnnotationService,
 )
 from ebl.signs.web.sign_search import SignsSearch
-from ebl.signs.web.signs import SignsResource, SignsListResource
+from ebl.signs.web.signs import SignsResource, SignsListResource, SignsOrderResource
 from ebl.signs.web.cropped_annotations import CroppedAnnotationsResource
 
 
 def create_signs_routes(api: falcon.App, context: Context):
     signs_search = SignsSearch(context.sign_repository)
     signs = SignsResource(context.sign_repository)
+    ordered_signs = SignsOrderResource(context.sign_repository)
     signs_images = CroppedAnnotationsResource(
         CroppedAnnotationService(
             context.annotations_repository,
@@ -24,3 +25,4 @@ def create_signs_routes(api: falcon.App, context: Context):
     api.add_route("/signs/{sign_name}", signs)
     api.add_route("/signs/{sign_name}/images", signs_images)
     api.add_route("/signs/all", signs_all)
+    api.add_route("/signs/{sign_name}/{order}/{sort_era}", ordered_signs)

ebl/signs/web/signs.py

@@ -35,3 +35,13 @@ def __init__(self, signs: SignRepository):
 
     def on_get(self, req, resp):
         resp.media = self.sign_repository.list_all_signs()
+
+
+class SignsOrderResource:
+    def __init__(self, signs: SignRepository):
+        self.sign_repository = signs
+
+    def on_get(self, req, resp, sign_name, order, sort_era):
+        resp.media = self.sign_repository.find_signs_by_order(
+            sign_name, order, sort_era
+        )