nitweb: catalog refine search algorithm

[nit.git] / src / web / api_model.nit

diff --git a/src/web/api_model.nit b/src/web/api_model.nit
index 3bb83ca..328eff9 100644 (file)
--- a/src/web/api_model.nit
+++ b/src/web/api_model.nit
@@ -26,6 +26,7 @@ redef class APIRouter
                use("/search", new APISearch(config))
                use("/random", new APIRandom(config))
                use("/entity/:id", new APIEntity(config))
+               use("/entity/:id/doc", new APIEntityDoc(config))
                use("/code/:id", new APIEntityCode(config))
                use("/uml/:id", new APIEntityUML(config))
                use("/linearization/:id", new APIEntityLinearization(config))
@@ -69,6 +70,16 @@ class APIList
                return mentities
        end
 
+       # Sort mentities by lexicographic order
+       #
+       # TODO choose order from request
+       fun sort_mentities(req: HttpRequest, mentities: Array[MEntity]) : Array[MEntity] do
+               var sorted = mentities.to_a
+               var sorter = new MEntityNameSorter
+               sorter.sort(sorted)
+               return sorted
+       end
+
        # Limit mentities depending on the `n` parameter.
        fun limit_mentities(req: HttpRequest, mentities: Array[MEntity]): Array[MEntity] do
                var n = req.int_arg("n")
@@ -80,6 +91,7 @@ class APIList
 
        redef fun get(req, res) do
                var mentities = list_mentities(req)
+               mentities = sort_mentities(req, mentities)
                mentities = limit_mentities(req, mentities)
                res.json new JsonArray.from(mentities)
        end
@@ -92,13 +104,19 @@ class APISearch
        super APIList
 
        redef fun get(req, res) do
-               var q = req.string_arg("q")
-               if q == null then
-                       res.json new JsonArray
+               var query = req.string_arg("q")
+               if query == null then
+                       res.api_error(400, "Missing search string")
                        return
                end
-               var n = req.int_arg("n")
-               res.json new JsonArray.from(config.view.find(q, n))
+               var page = req.int_arg("p")
+               var limit = req.int_arg("n")
+               var response = new JsonArray.from(search(query, limit))
+               res.json paginate(response, response.length, page, limit)
+       end
+
+       fun search(query: String, limit: nullable Int): Array[MEntity] do
+               return config.view.find(query)
        end
 end
 
@@ -136,6 +154,26 @@ class APIEntity
        end
 end
 
+# Return the full MDoc of a MEntity.
+#
+# Example: `GET /entity/core::Array/doc`
+class APIEntityDoc
+       super APIHandler
+
+       redef fun get(req, res) do
+               var mentity = mentity_from_uri(req, res)
+               if mentity == null then return
+
+               var obj = new JsonObject
+               var mdoc = mentity.mdoc_or_fallback
+               if mdoc != null then
+                       obj["documentation"] = mdoc.html_documentation.write_to_string
+                       obj["location"] = mdoc.location
+               end
+               res.json obj
+       end
+end
+
 # List ancestors, parents, child and descendants of MEntity
 #
 # Example: `GET /entity/core::Array/inheritance`
@@ -173,13 +211,19 @@ end
 #
 # Example: `GET /defs/core::Array`
 class APIEntityDefs
-       super APIHandler
+       super APIList
 
        redef fun get(req, res) do
                var mentity = mentity_from_uri(req, res)
                if mentity == null then return
                var mentities: Array[MEntity]
-               if mentity isa MModule then
+               if mentity isa MPackage then
+                       mentities = mentity.mgroups.to_a
+               else if mentity isa MGroup then
+                       mentities = new Array[MEntity]
+                       mentities.add_all mentity.in_nesting.direct_smallers
+                       mentities.add_all mentity.mmodules
+               else if mentity isa MModule then
                        mentities = mentity.mclassdefs
                else if mentity isa MClass then
                        mentities = mentity.mclassdefs
@@ -191,6 +235,8 @@ class APIEntityDefs
                        res.api_error(404, "No definition list for mentity `{mentity.full_name}`")
                        return
                end
+               mentities = sort_mentities(req, mentities)
+               mentities = limit_mentities(req, mentities)
                res.json new JsonArray.from(mentities)
        end
 end