X-Git-Url: http://nitlanguage.org?ds=sidebyside diff --git a/src/doc/templates/json_commands.nit b/src/doc/templates/json_commands.nit new file mode 100644 index 0000000..aea7be3 --- /dev/null +++ b/src/doc/templates/json_commands.nit @@ -0,0 +1,294 @@ +# This file is part of NIT ( http://www.nitlanguage.org ). +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Translate command results to json +module json_commands + +import commands_catalog +import commands_graph +import commands_ini +import commands_main +import commands_usage + +import templates::json_model +import json::static + +redef class DocCommand + # Return a JSON Serializable representation of `self` results + fun to_json: nullable Serializable is abstract +end + +# Message handling + +redef class CmdMessage + # Return a JSON Serializable representation of `self` + fun to_json: nullable Serializable do + var obj = new JsonObject + obj["status"] = class_name + obj["message"] = to_s + return obj + end +end + +redef class CmdEntity + redef fun to_json do return mentity +end + +redef class CmdList + redef fun to_json do + var obj = new JsonObject + obj["results"] = results + obj["page"] = page + obj["count"] = count + obj["limit"] = limit + obj["max"] = max + return obj + end +end + +redef class CmdEntityList + redef fun to_json do return super +end + +# Model commands + +redef class CmdComment + redef fun to_json do + var obj = new JsonObject + var render = self.render_comment + if render != null then + obj["documentation"] = render.write_to_string + end + return obj + end +end + +redef class CmdEntityLink + redef fun to_json do + var obj = new JsonObject + var text = self.text + if text != null then obj["text"] = text + var title = self.title + if title != null then obj["title"] = title + return obj + end +end + +redef class CmdCode + redef fun to_json do + var obj = new JsonObject + var node = self.node + if node == null then return obj + + var code = render_code(node) + obj["location"] = node.location + obj["code"] = code.write_to_string + return obj + end +end + +redef class CmdGraph + redef fun to_json do + var obj = new JsonObject + var output = render + if output != null then + obj["graph"] = output.write_to_string + end + return obj + end +end + +redef class CmdMetadata + redef fun to_json do return metadata +end + +# CmdCatalog + +redef class CmdCatalogStats + redef fun to_json do return stats +end + +redef class CmdCatalogTags + redef fun to_json do return packages_count_by_tags +end + +redef class CmdCatalogTag + redef fun to_json do + var obj = super.as(JsonObject) + obj["tag"] = tag + return obj + end +end + +redef class CmdCatalogPerson + redef fun to_json do return person +end + +redef class CmdCatalogMaintaining + redef fun to_json do + var obj = new JsonObject + obj["person"] = person + obj["results"] = results + obj["page"] = page + obj["count"] = count + obj["limit"] = limit + obj["max"] = max + return obj + end +end + +redef class CmdCatalogContributing + redef fun to_json do + var obj = new JsonObject + obj["person"] = person + obj["results"] = results + obj["page"] = page + obj["count"] = count + obj["limit"] = limit + obj["max"] = max + return obj + end +end + +# CmdIni + +redef class CmdIniDescription + redef fun to_json do + var obj = new JsonObject + obj["desc"] = desc + return obj + end +end + +redef class CmdIniGitUrl + redef fun to_json do + var obj = new JsonObject + obj["url"] = url + return obj + end +end + +redef class CmdIniCloneCommand + redef fun to_json do + var obj = new JsonObject + obj["command"] = command + return obj + end +end + +redef class CmdIniIssuesUrl + redef fun to_json do + var obj = new JsonObject + obj["url"] = url + return obj + end +end + +redef class CmdIniMaintainer + redef fun to_json do + var obj = new JsonObject + obj["maintainer"] = maintainer + return obj + end +end + +redef class CmdIniContributors + redef fun to_json do + var obj = new JsonObject + obj["contributors"] = contributors + return obj + end +end + +redef class CmdIniLicense + redef fun to_json do + var obj = new JsonObject + obj["license"] = license + return obj + end +end + +redef class CmdLicenseFile + redef fun to_json do + var obj = new JsonObject + obj["file"] = file + return obj + end +end + +redef class CmdLicenseFileContent + redef fun to_json do + var obj = super.as(JsonObject) + obj["content"] = content + return obj + end +end + +redef class CmdContribFile + redef fun to_json do + var obj = new JsonObject + obj["file"] = file + return obj + end +end + +redef class CmdContribFileContent + redef fun to_json do + var obj = super.as(JsonObject) + obj["content"] = content + return obj + end +end + +# CmdMain + +redef class CmdMains + redef fun to_json do + var obj = new JsonObject + obj["results"] = results + return obj + end +end + +redef class CmdMainCompile + redef fun to_json do + var obj = new JsonObject + obj["command"] = command + return obj + end +end + +redef class CmdTesting + redef fun to_json do + var obj = new JsonObject + obj["command"] = command + return obj + end +end + +redef class CmdManSynopsis + redef fun to_json do + var obj = new JsonObject + obj["synopsis"] = synopsis + return obj + end +end + +redef class CmdManOptions + redef fun to_json do + var obj = new JsonObject + obj["options"] = options + return obj + end +end