feat: Order Series items by ordering type

critiquebrainz/frontend/external/bookbrainz_db/relationships.py

@@ -19,31 +19,75 @@
  'Work': 71,
 }
 
-def fetch_relationships(relationship_set_id: int, relation_types_id: List) -> List:
+def fetch_relationships(relationship_set_id: int, relation_types_id: List, ordering_type=None) -> List:
  """
  Fetch relationships from the database.
+ Args:
+ relationship_set_id (int): ID of the relationship set.
+ relation_types (list): List of relation types.
+ ordering_type (int): ID of the ordering type. (optional)
+
+ Returns:
+ List of relationships of the given types.
+
  """
  if not relationship_set_id:
  return None
 
- key = cache.gen_key('bb_relationship', relationship_set_id, relation_types_id)
+ key = cache.gen_key('bb_relationship', relationship_set_id, relation_types_id, ordering_type)
  relationships = cache.get(key)
  if not relationships:
+
+ query_params = {
+ 'relationship_set_id': relationship_set_id,
+ 'relation_types_id': tuple(relation_types_id),
+ }
+
+ order_by_clause = ''
+ if ordering_type:
+ order_by_clause = """
+ ORDER BY CASE
+ WHEN :ordering_type = 2
+ THEN (attributes->>'position')::int
+ ELSE (attributes->>'number')::int
+ END
+ """
+ query_params['ordering_type'] = ordering_type
+
  with db.bb_engine.connect() as connection:
  result = connection.execute(sqlalchemy.text("""
- SELECT rel.id as id,
- reltype.id as relation_type_id,
- reltype.label as label,
- rel.source_bbid::text as source_bbid,
- rel.target_bbid::text as target_bbid,
- reltype.target_entity_type as target_entity_type,
- reltype.source_entity_type as source_entity_type
- FROM relationship_set__relationship rels
- LEFT JOIN relationship rel on rels.relationship_id = rel.id
- LEFT JOIN relationship_type reltype on rel.type_id = reltype.id
- WHERE rels.set_id = :relationship_set_id
- AND reltype.id in :relation_types_id
- """), {'relationship_set_id': relationship_set_id, 'relation_types_id': tuple(relation_types_id)})
+ WITH intermediate AS (
+ SELECT rel.id as id,
+ reltype.label as label,
+ rel.source_bbid::text as source_bbid,
+ rel.target_bbid::text as target_bbid,
+ reltype.target_entity_type as target_entity_type,
+ reltype.source_entity_type as source_entity_type,
+ COALESCE( 
+ jsonb_object_agg(relatttype.name, relatttext.text_value)
+ FILTER (WHERE relatts IS NOT NULL),
+ '[]'
+ ) as attributes
+ FROM relationship_set__relationship rels
+ LEFT JOIN relationship rel ON rels.relationship_id = rel.id
+ LEFT JOIN relationship_type reltype ON rel.type_id = reltype.id
+ LEFT JOIN relationship_attribute_set__relationship_attribute relatts ON rel.attribute_set_id = relatts.set_id
+ LEFT JOIN relationship_attribute relatt ON relatts.attribute_id = relatt.id
+ LEFT JOIN relationship_attribute_type relatttype ON relatt.attribute_type = relatttype.id
+ LEFT JOIN relationship_attribute_text_value relatttext ON relatts.attribute_id = relatttext.attribute_id
+ WHERE rels.set_id = :relationship_set_id
+ AND reltype.id in :relation_types_id
+ GROUP BY rel.id,
+ reltype.label,
+ rel.source_bbid,
+ rel.target_bbid,
+ reltype.target_entity_type,
+ reltype.source_entity_type
+ ) SELECT *
+ FROM intermediate
+ {order_by_clause}
+ """.format(order_by_clause=order_by_clause)
+ ), query_params)
  relationships = result.fetchall()
  relationships = [dict(relationship) for relationship in relationships]
  cache.set(key, relationships, DEFAULT_CACHE_EXPIRATION)

critiquebrainz/frontend/external/bookbrainz_db/series.py

@@ -65,7 +65,8 @@ def fetch_multiple_series(bbids: List[uuid.UUID]) -> dict:
  disambiguation,
  identifier_set_id,
  relationship_set_id,
- series_ordering_type.label as series_ordering_type
+ series_ordering_type.label as series_ordering_type,
+ series_ordering_type.id as series_ordering_type_id
  FROM series
  LEFT JOIN series_ordering_type
  ON series.ordering_type_id = series_ordering_type.id
@@ -80,7 +81,9 @@ def fetch_multiple_series(bbids: List[uuid.UUID]) -> dict:
  series = dict(series)
  series['bbid'] = str(series['bbid'])
  series['identifiers'] = fetch_bb_external_identifiers(series['identifier_set_id'])
- series['rels'] = fetch_relationships(series['relationship_set_id'], [SERIES_REL_MAP[series['series_type']]])
+ series['rels'] = fetch_relationships(series['relationship_set_id'],
+ [SERIES_REL_MAP[series['series_type']]],
+ series['series_ordering_type_id'])
  results[series['bbid']] = series
 
  cache.set(bb_series_key, results, DEFAULT_CACHE_EXPIRATION)

critiquebrainz/frontend/templates/bb_series/entity.html

@@ -77,7 +77,13 @@ <h4>{{ _('Author') }}</h4>
  <tbody>
  {% for rel in series_rels_info %}
  <tr>
- <td>{{ loop.index }}</td>
+ <td>
+ {% if rel['number'] is defined and rel['number'] %}
+ {{ rel['number'] }}
+ {% else %}
+ -
+ {% endif %}
+ </td>
  <td>
  <a href="{{ url_for('bb_author.entity', id=rel.bbid) }}">
  {{ rel.name }}
@@ -117,7 +123,13 @@ <h4>{{ _('Edition') }}</h4>
  <tbody>
  {% for rel in series_rels_info %}
  <tr>
- <td>{{ loop.index }}</td>
+ <td>
+ {% if rel['number'] is defined and rel['number'] %}
+ {{ rel['number'] }}
+ {% else %}
+ -
+ {% endif %}
+ </td>
  <td>
  <a href="https://bookbrainz.org/edition/{{rel.bbid}}">
  {{ rel.name }}
@@ -161,7 +173,13 @@ <h4>{{ _('Edition Groups') }}</h4>
  <tbody>
  {% for rel in series_rels_info %}
  <tr>
- <td>{{ loop.index }}</td>
+ <td>
+ {% if rel['number'] is defined and rel['number'] %}
+ {{ rel['number'] }}
+ {% else %}
+ -
+ {% endif %}
+ </td>
  <td>
  <a href="{{ url_for('bb_edition_group.entity', id=rel.bbid) }}">
  {{ rel.name }}
@@ -209,7 +227,13 @@ <h4>{{ _('Publisher') }}</h4>
  <tbody>
  {% for rel in series_rels_info %}
  <tr>
- <td>{{ loop.index }}</td>
+ <td>
+ {% if rel['number'] is defined and rel['number'] %}
+ {{ rel['number'] }}
+ {% else %}
+ -
+ {% endif %}
+ </td>
  <td>
  <a href="https://bookbrainz.org/publisher/{{rel.bbid}}">
  {{ rel.name }}
@@ -249,7 +273,13 @@ <h4>{{ _('Literary Works') }}</h4>
  <tbody>
  {% for rel in series_rels_info %}
  <tr>
- <td>{{ loop.index }}</td>
+ <td>
+ {% if rel['number'] is defined and rel['number'] %}
+ {{ rel['number'] }}
+ {% else %}
+ -
+ {% endif %}
+ </td>
  <td>
  <a href="{{ url_for('bb_literary_work.entity', id=rel.bbid) }}">
  {{ rel.name }}

critiquebrainz/frontend/views/bb_series.py

@@ -54,14 +54,28 @@ def entity(id):
  rating_form = RatingEditForm(entity_id=id, entity_type='bb_series')
  rating_form.rating.data = my_review['rating'] if my_review else None
 
- rels_bbid = [rel['source_bbid'] for rel in series['rels']]
+ rels_bbid = []
+ rels_order_number = []
+ for rel in series['rels']:
+ rels_bbid.append(rel['source_bbid'])
+ if 'number' in rel['attributes']:
+ rels_order_number.append(rel['attributes']['number'])
+ else:
+ rels_order_number.append(None)
+
  series_rels_info = bb_series.fetch_series_rels_info(series['series_type'], rels_bbid)
- series_rels_info = series_rels_info.values()
+
+ series_items = []
+ for index, bbid in enumerate(rels_bbid):
+ item = series_rels_info[bbid]
+ number = rels_order_number[index]
+ item['number'] = number
+ series_items.append(item)
 
  return render_template('bb_series/entity.html',
  id=series['bbid'],
  series=series,
- series_rels_info=series_rels_info,
+ series_rels_info=series_items,
  reviews=reviews,
  my_review=my_review,
  count=count,