Improve default sorting (temando#103)

Author: quangkhoa

src/components/Method/Method.js

@@ -12,12 +12,12 @@ import './Method.scss'
 export default class Method extends PureComponent {
   render () {
     const { method } = this.props
-    const { summary, description, parameters, request, responses } = method
+    const { title, description, parameters, request, responses } = method
 
     return (
       <ScrollableAnchor id={method.link}>
         <div className='method'>
-          <h3>{summary}</h3>
+          <h3>{title}</h3>
           <div className='method-body'>
             {description && <Description description={description} />}
             {parameters && this.renderParameters(parameters)}
@@ -74,5 +74,13 @@ export default class Method extends PureComponent {
 }
 
 Method.propTypes = {
-  method: PropTypes.object
+  method: PropTypes.shape({
+    type: PropTypes.string,
+    title: PropTypes.string,
+    link: PropTypes.string,
+    description: PropTypes.string,
+    parameters: PropTypes.object,
+    request: PropTypes.object,
+    responses: PropTypes.array
+  })
 }

src/parser/open-api/v3/open-api-v3-parser.js

@@ -1,31 +1,29 @@
 import refParser from 'json-schema-ref-parser'
 import getUIReadySchema from '../schemaParser'
-import { sortByAlphabet, httpMethodSort } from '../../sorting'
+import { sortByUIMethod } from '../../sorting'
 
 /**
  * Construct navigation and services ready to be consumed by the UI
  *
  * @param {Array} tags
  * @param {Object} paths
- * @param {Function} pathSortFunction
- * @param {Function} methodSortFunction
  *
  * @return {{navigation: [], services: []}}
  */
-function getUINavigationAndServices (tags, paths, pathSortFunction = sortByAlphabet, methodSortFunction = httpMethodSort) {
+function getUINavigationAndServices (tags, paths) {
   const navigation = []
   const services = []
 
   for (let i = 0; i < tags.length; i++) {
     const tag = tags[i]
     const navigationMethods = []
     const servicesMethods = []
-    const pathIds = Object.keys(paths).sort(pathSortFunction)
+    const pathIds = Object.keys(paths)
 
     for (let j = 0; j < pathIds.length; j++) {
       const pathId = pathIds[j]
       const path = paths[pathId]
-      const methodTypes = Object.keys(path).sort(methodSortFunction)
+      const methodTypes = Object.keys(path)
 
       for (let k = 0; k < methodTypes.length; k++) {
         const methodType = methodTypes[k]
@@ -47,8 +45,8 @@ function getUINavigationAndServices (tags, paths, pathSortFunction = sortByAlpha
         const uiResponses = getUIResponses(method.responses)
         const servicesMethod = {
           type: methodType,
+          title: method.summary,
           link,
-          summary: method.summary,
           request: uiRequest,
           responses: uiResponses
         }
@@ -68,16 +66,16 @@ function getUINavigationAndServices (tags, paths, pathSortFunction = sortByAlpha
 
     navigation.push({
       title: tag,
-      methods: navigationMethods
+      methods: navigationMethods.sort(sortByUIMethod)
     })
 
     services.push({
       title: tag,
-      methods: servicesMethods
+      methods: servicesMethods.sort(sortByUIMethod)
     })
   }
 
-  return { navigation, services }
+  return {navigation, services}
 }
 
 /**
@@ -162,9 +160,9 @@ function getUIParametersForLocation (parameters, location) {
     // handles this. Property should eventually be split and this won't be
     // necessary...
     if (parameter.type) {
-      uiParameter.type = [ parameter.type ]
+      uiParameter.type = [parameter.type]
     } else if (parameter.schema && parameter.schema.type) {
-      uiParameter.type = [ parameter.schema.type ]
+      uiParameter.type = [parameter.schema.type]
     }
 
     if (parameter.schema && parameter.schema.default !== undefined) {
@@ -307,7 +305,7 @@ export default async function getUIReadyDefinition (openApiV3) {
   const tags = getTags(paths)
 
   // Construction navigation and services
-  const { navigation, services } = getUINavigationAndServices(tags, paths)
+  const {navigation, services} = getUINavigationAndServices(tags, paths)
 
   const definition = {
     title: info.title,

src/parser/sorting.js

@@ -30,14 +30,32 @@ export function sortByAlphabet (str1, str2) {
 /**
  * Sort function
  *
- * @param {String} inMethod1
- * @param {String} inMethod2
+ * @param {String} type1
+ * @param {String} type2
  *
  * @return {number}
  */
-export function httpMethodSort (inMethod1, inMethod2) {
-  const method1 = inMethod1.toUpperCase()
-  const method2 = inMethod2.toUpperCase()
+export function sortByHttpMethod (type1, type2) {
+  const normalisedType1 = type1.toUpperCase()
+  const normalisedType2 = type2.toUpperCase()
 
-  return methodWeights[method1] - methodWeights[method2]
+  return methodWeights[normalisedType1] - methodWeights[normalisedType2]
+}
+
+/**
+ * Sort function
+ *
+ * @param {type, title} method1
+ * @param {type, title} method2
+ *
+ * return {number}
+ */
+export function sortByUIMethod (method1, method2) {
+  // Sort by method type first
+  if (method1.type !== method2.type) {
+    return sortByHttpMethod(method1.type, method2.type)
+  }
+
+  // Then by method title
+  return sortByAlphabet(method1.title, method2.title)
 }

test/parser/open-api/v3/data/outputs/accounts.json

@@ -26,7 +26,7 @@
         {
           "type": "get",
           "link": "/accounts/{id}/users/get",
-          "summary": "Get all the users of a given account",
+          "title": "Get all the users of a given account",
           "parameters": {
             "path": [
               {
@@ -368,7 +368,7 @@
         {
           "type": "post",
           "link": "/accounts/{id}/users/post",
-          "summary": "Create a user under the given account",
+          "title": "Create a user under the given account",
           "parameters": {
             "path": [
               {

test/parser/open-api/v3/data/outputs/carrier.json

@@ -21,7 +21,7 @@
         {
           "type": "get",
           "link": "/carriers/get",
-          "summary": "Returns a list of integrations available for registration",
+          "title": "Returns a list of integrations available for registration",
           "request": {
             "description": "Returns a list of integrations available for registration"
           },