#3664 Stop using JsonObject on StructuredData - share variable names and logic for the Sarql queries

Author: macgills

app/src/main/java/fr/free/nrw/commons/depictions/subClass/models/SparqlResponses.kt

@@ -2,49 +2,25 @@ package fr.free.nrw.commons.depictions.subClass.models
 
 import fr.free.nrw.commons.upload.structure.depictions.DepictedItem
 
-
-data class ParentSparqlResponse(val results: ParentResult) {
-    fun toDepictedItems() =
-        results.bindings
-            .filter { it.parentClassDescription != null }
-            .map {
-                DepictedItem(
-                    it.parentClassLabel.value,
-                    it.parentClassDescription!!.value,
-                    "",
-                    false,
-                    it.parentClass.value
-                )
-            }
-}
-
-data class SubclassSparqlResponse(val results: SubclassResult) {
+data class SparqlResponse(val results: Result) {
     fun toDepictedItems() =
         results.bindings.map {
             DepictedItem(
-                it.subclassLabel.value,
-                it.subclassDescription?.value ?: "",
+                it.itemLabel.value,
+                it.itemDescription?.value ?: "",
                 "",
                 false,
-                it.subclass.value.substringAfterLast("/")
+                it.item.value.substringAfterLast("/")
             )
         }
 }
 
-data class ParentResult(val bindings: List<ParentBinding>)
-
-data class SubclassResult(val bindings: List<SubclassBinding>)
-
-data class ParentBinding(
-    val parentClass: SparqInfo,
-    val parentClassLabel: SparqInfo,
-    val parentClassDescription: SparqInfo? = null
-)
+data class Result(val bindings: List<Binding>)
 
-data class SubclassBinding(
-    val subclass: SparqInfo,
-    val subclassLabel: SparqInfo,
-    val subclassDescription: SparqInfo? = null
+data class Binding(
+    val item: SparqInfo,
+    val itemLabel: SparqInfo,
+    val itemDescription: SparqInfo? = null
 )
 
 data class SparqInfo(val type: String, val value: String)

app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.java

@@ -6,8 +6,7 @@
 import fr.free.nrw.commons.achievements.FeaturedImages;
 import fr.free.nrw.commons.achievements.FeedbackResponse;
 import fr.free.nrw.commons.campaigns.CampaignResponseDTO;
-import fr.free.nrw.commons.depictions.subClass.models.ParentSparqlResponse;
-import fr.free.nrw.commons.depictions.subClass.models.SubclassSparqlResponse;
+import fr.free.nrw.commons.depictions.subClass.models.SparqlResponse;
 import fr.free.nrw.commons.location.LatLng;
 import fr.free.nrw.commons.nearby.Place;
 import fr.free.nrw.commons.nearby.model.NearbyResponse;
@@ -29,6 +28,7 @@
 import okhttp3.Request;
 import okhttp3.Response;
 import okhttp3.ResponseBody;
+import org.jetbrains.annotations.NotNull;
 import timber.log.Timber;
 
 /**
@@ -207,51 +207,40 @@ public Observable<List<Place>> getNearbyPlaces(LatLng cur, String language, doub
    * bridge -> suspended bridge, aqueduct, etc
    */
   public Observable<List<DepictedItem>> getChildQIDs(String qid) throws IOException {
-    String queryString = FileUtils.readFromResource("/queries/subclasses_query.rq");
-    String query = queryString.
-        replace("${QID}", qid)
-        .replace("${LANG}", "\"" + Locale.getDefault().getLanguage() + "\"");
-    Timber.e(query);
-    HttpUrl.Builder urlBuilder = HttpUrl
-        .parse(sparqlQueryUrl)
-        .newBuilder()
-        .addQueryParameter("query", query)
-        .addQueryParameter("format", "json");
-    Request request = new Request.Builder()
-        .url(urlBuilder.build())
-        .build();
-    return Observable.fromCallable(() -> {
-      Response response = okHttpClient.newCall(request).execute();
-      return gson.fromJson(response.body().string(), SubclassSparqlResponse.class).toDepictedItems();
-    }).doOnError(Timber::e);
+    return depictedItemsFrom(sparqlQuery(qid, "/queries/subclasses_query.rq"));
   }
 
   /**
    * Get the QIDs of all Wikidata items that are subclasses of the given Wikidata item. Example:
    * bridge -> suspended bridge, aqueduct, etc
    */
   public Observable<List<DepictedItem>> getParentQIDs(String qid) throws IOException {
-    String queryString = FileUtils.readFromResource("/queries/parentclasses_query.rq");
-    String query = queryString.
+    return depictedItemsFrom(sparqlQuery(qid, "/queries/parentclasses_query.rq"));
+  }
+
+  private Observable<List<DepictedItem>> depictedItemsFrom(Request request) {
+    return Observable.fromCallable(() -> {
+      try (ResponseBody body = okHttpClient.newCall(request).execute().body()) {
+        return gson.fromJson(body.string(), SparqlResponse.class).toDepictedItems();
+      }catch (Exception e) {
+        return new ArrayList<DepictedItem>();
+      }
+    }).doOnError(Timber::e);
+  }
+
+  @NotNull
+  private Request sparqlQuery(String qid, String fileName) throws IOException {
+    String query = FileUtils.readFromResource(fileName).
         replace("${QID}", qid)
         .replace("${LANG}", "\"" + Locale.getDefault().getLanguage() + "\"");
-    Timber.e(query);
     HttpUrl.Builder urlBuilder = HttpUrl
         .parse(sparqlQueryUrl)
         .newBuilder()
         .addQueryParameter("query", query)
         .addQueryParameter("format", "json");
-    Request request = new Request.Builder()
+    return new Request.Builder()
         .url(urlBuilder.build())
         .build();
-    return Observable.fromCallable(() -> {
-      Response response = okHttpClient.newCall(request).execute();
-      try {
-        return gson.fromJson(response.body().string(), ParentSparqlResponse.class).toDepictedItems();
-      } catch (Exception e) {
-        return new ArrayList<DepictedItem>();
-      }
-    }).doOnError(Timber::e);
   }
 
   public Single<CampaignResponseDTO> getCampaigns() {

app/src/main/resources/queries/parentclasses_query.rq

@@ -1,4 +1,4 @@
-SELECT ?parentClass ?parentClassLabel ?parentClassDescription WHERE {
-    wd:${QID} wdt:P279 ?parentClass.
+SELECT ?item ?itemLabel ?itemDescription WHERE {
+    wd:${QID} wdt:P279 ?item.
     SERVICE wikibase:label { bd:serviceParam wikibase:language ${LANG}. }
 }

app/src/main/resources/queries/subclasses_query.rq

@@ -1,4 +1,4 @@
-SELECT ?subclass ?subclassLabel ?subclassDescription WHERE {
-    ?subclass wdt:P279 wd:${QID}.
+SELECT ?item ?itemLabel ?itemDescription WHERE {
+    ?item wdt:P279 wd:${QID}.
     SERVICE wikibase:label { bd:serviceParam wikibase:language ${LANG}. }
 }