fix(core): make category hosts return host categories (#472)

Author: Marco Friso

packages/api-elements/CHANGELOG.md

@@ -1,5 +1,11 @@
 # API Elements (JavaScript) CHANGELOG
 
+## 0.2.6 (2020-07-01)
+
+### Bug Fixes
+
+- Fixes the `hosts` property in api category to return the hosts category.
+
 ## 0.2.5 (2020-06-13)
 
 ### Bug Fixes

packages/api-elements/lib/elements/Category.js

@@ -15,6 +15,15 @@ class Category extends ArrayElement {
     this.element = 'category';
   }
 
+  /**
+   * @name hosts
+   * @type ArraySlice
+   * @memberof Category.prototype
+   */
+  get hosts() {
+    return this.children.filter(item => item.classes.contains('hosts'));
+  }
+
   /**
    * @name resourceGroups
    * @type ArraySlice
@@ -78,15 +87,6 @@ class Category extends ArrayElement {
     return this.children.filter(item => schemes.indexOf(item.element) !== -1);
   }
 
-  /**
-   * @name hosts
-   * @type ArraySlice
-   * @memberof Category.prototype
-   */
-  get hosts() {
-    return this.children.filter(item => item.element === 'hosts');
-  }
-
   metadata(value) {
     const metadata = this.attributes.get('metadata');
 

packages/api-elements/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-elements",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "API Elements JavaScript",
   "author": "Apiary.io <[email protected]>",
   "license": "MIT",

packages/api-elements/test/api-description-test.js

@@ -102,6 +102,20 @@ describe('API description namespace', () => {
           },
         },
         content: [
+          {
+            element: 'category',
+            meta: {
+              classes: {
+                element: 'array',
+                content: [
+                  {
+                    element: 'string',
+                    content: 'hosts',
+                  },
+                ],
+              },
+            },
+          },
           {
             element: 'category',
             meta: {
@@ -212,6 +226,16 @@ describe('API description namespace', () => {
       expect(random).to.be.undefined;
     });
 
+    it('should contain hosts', () => {
+      const items = category.hosts;
+      expect(items).to.have.length(1);
+
+      items.forEach((item) => {
+        expect(item).to.be.an.instanceof(Category);
+        expect(item).to.have.class('hosts');
+      });
+    });
+
     it('should contain a resource group', () => {
       const items = category.resourceGroups;
       expect(items).to.have.length(1);
@@ -734,6 +758,20 @@ describe('API description namespace', () => {
               },
             ],
           },
+          hosts: {
+            element: 'array',
+            content: [
+              {
+                element: 'resource',
+                attributes: {
+                  href: {
+                    element: 'href',
+                    content: 'https://first-server.com',
+                  },
+                },
+              },
+            ],
+          },
         },
         content: [
           {
@@ -795,6 +833,18 @@ describe('API description namespace', () => {
       });
     });
 
+    it('should have hosts', () => {
+      expect(resource.hosts.first.attributes.get('href').toValue()).to.deep.equal('https://first-server.com');
+    });
+
+    it('should set hosts', () => {
+      const host = new namespace.elements.Resource();
+      host.href = 'https://second-server.com';
+      resource.hosts = [host];
+
+      expect(resource.hosts.first.attributes.get('href').toValue()).to.deep.equal('https://second-server.com');
+    });
+
     it('should contain a transition', () => {
       const items = resource.transitions;
       expect(items).to.have.length(1);
@@ -842,6 +892,20 @@ describe('API description namespace', () => {
               },
             ],
           },
+          hosts: {
+            element: 'array',
+            content: [
+              {
+                element: 'resource',
+                attributes: {
+                  href: {
+                    element: 'href',
+                    content: 'https://first-server.com',
+                  },
+                },
+              },
+            ],
+          },
           data: {
             element: 'dataStructure',
             content: {
@@ -943,6 +1007,18 @@ describe('API description namespace', () => {
       });
     });
 
+    it('should have hosts', () => {
+      expect(transition.hosts.first.href.toValue()).to.deep.equal('https://first-server.com');
+    });
+
+    it('should set hosts', () => {
+      const host = new namespace.elements.Resource();
+      host.href = 'https://second-server.com';
+      transition.hosts = [host];
+
+      expect(transition.hosts.first.href.toValue()).to.deep.equal('https://second-server.com');
+    });
+
     it('should have data', () => {
       expect(transition.data.toValue()).to.deep.equal({});
     });