From be449e23e319cbaa15c226560b9fa52ec4aa326e Mon Sep 17 00:00:00 2001
From: Filipa Lacerda <filipa@gitlab.com>
Date: Wed, 4 Sep 2019 14:10:29 +0000
Subject: [PATCH] Creates base components for new job log

Creates a link component, a line component and
a clickable line component to handle the
new job log format
---
 .../javascripts/jobs/components/log/line.vue  | 28 +++++++
 .../jobs/components/log/line_header.vue       | 45 ++++++++++
 .../jobs/components/log/line_number.vue       | 52 ++++++++++++
 .../unreleased/66454-base-components.yml      |  5 ++
 .../jobs/components/log/line_header_spec.js   | 84 +++++++++++++++++++
 .../jobs/components/log/line_number_spec.js   | 40 +++++++++
 .../jobs/components/log/line_spec.js          | 49 +++++++++++
 7 files changed, 303 insertions(+)
 create mode 100644 app/assets/javascripts/jobs/components/log/line.vue
 create mode 100644 app/assets/javascripts/jobs/components/log/line_header.vue
 create mode 100644 app/assets/javascripts/jobs/components/log/line_number.vue
 create mode 100644 changelogs/unreleased/66454-base-components.yml
 create mode 100644 spec/javascripts/jobs/components/log/line_header_spec.js
 create mode 100644 spec/javascripts/jobs/components/log/line_number_spec.js
 create mode 100644 spec/javascripts/jobs/components/log/line_spec.js

diff --git a/app/assets/javascripts/jobs/components/log/line.vue b/app/assets/javascripts/jobs/components/log/line.vue
new file mode 100644
index 00000000000..86d0fcc3b74
--- /dev/null
+++ b/app/assets/javascripts/jobs/components/log/line.vue
@@ -0,0 +1,28 @@
+<script>
+import LineNumber from './line_number.vue';
+
+export default {
+  components: {
+    LineNumber,
+  },
+  props: {
+    line: {
+      type: Object,
+      required: true,
+    },
+    path: {
+      type: String,
+      required: true,
+    },
+  },
+};
+</script>
+
+<template>
+  <div class="line">
+    <line-number :line-number="line.lineNumber" :path="path" />
+    <span v-for="(content, i) in line.content" :key="i" class="line-text" :class="content.style">{{
+      content.text
+    }}</span>
+  </div>
+</template>
diff --git a/app/assets/javascripts/jobs/components/log/line_header.vue b/app/assets/javascripts/jobs/components/log/line_header.vue
new file mode 100644
index 00000000000..4ec212d2333
--- /dev/null
+++ b/app/assets/javascripts/jobs/components/log/line_header.vue
@@ -0,0 +1,45 @@
+<script>
+import Icon from '~/vue_shared/components/icon.vue';
+import LineNumber from './line_number.vue';
+
+export default {
+  components: {
+    Icon,
+    LineNumber,
+  },
+  props: {
+    line: {
+      type: Object,
+      required: true,
+    },
+    isClosed: {
+      type: Boolean,
+      required: true,
+    },
+    path: {
+      type: String,
+      required: true,
+    },
+  },
+  computed: {
+    iconName() {
+      return this.isClosed ? 'angle-right' : 'angle-down';
+    },
+  },
+  methods: {
+    handleOnClick() {
+      this.$emit('toggleLine');
+    },
+  },
+};
+</script>
+
+<template>
+  <div class="line collapsible-line" role="button" @click="handleOnClick">
+    <icon :name="iconName" class="arrow" />
+    <line-number :line-number="line.lineNumber" :path="path" />
+    <span v-for="(content, i) in line.content" :key="i" class="line-text" :class="content.style">{{
+      content.text
+    }}</span>
+  </div>
+</template>
diff --git a/app/assets/javascripts/jobs/components/log/line_number.vue b/app/assets/javascripts/jobs/components/log/line_number.vue
new file mode 100644
index 00000000000..e06836e2e97
--- /dev/null
+++ b/app/assets/javascripts/jobs/components/log/line_number.vue
@@ -0,0 +1,52 @@
+<script>
+import { GlLink } from '@gitlab/ui';
+
+export default {
+  components: {
+    GlLink,
+  },
+  props: {
+    lineNumber: {
+      type: Number,
+      required: true,
+    },
+    path: {
+      type: String,
+      required: true,
+    },
+  },
+  computed: {
+    /**
+     * Builds the url for each line number
+     *
+     * @returns {String}
+     */
+    buildLineNumber() {
+      return `${this.path}#${this.lineNumberId}`;
+    },
+    /**
+     * Array indexes start with 0, so we add 1
+     * to create the line number
+     *
+     * @returns {Number} the line number
+     */
+    parsedLineNumber() {
+      return this.lineNumber + 1;
+    },
+
+    /**
+     * Creates the anchor for each link
+     *
+     * @returns {String}
+     */
+    lineNumberId() {
+      return `L${this.parsedLineNumber}`;
+    },
+  },
+};
+</script>
+<template>
+  <gl-link :id="lineNumberId" class="line-number" :href="buildLineNumber">{{
+    parsedLineNumber
+  }}</gl-link>
+</template>
diff --git a/changelogs/unreleased/66454-base-components.yml b/changelogs/unreleased/66454-base-components.yml
new file mode 100644
index 00000000000..7a40a66f122
--- /dev/null
+++ b/changelogs/unreleased/66454-base-components.yml
@@ -0,0 +1,5 @@
+---
+title: Creates base components for the new job log
+merge_request:
+author:
+type: added
diff --git a/spec/javascripts/jobs/components/log/line_header_spec.js b/spec/javascripts/jobs/components/log/line_header_spec.js
new file mode 100644
index 00000000000..4efd412a6cd
--- /dev/null
+++ b/spec/javascripts/jobs/components/log/line_header_spec.js
@@ -0,0 +1,84 @@
+import { mount } from '@vue/test-utils';
+import LineHeader from '~/jobs/components/log/line_header.vue';
+import LineNumber from '~/jobs/components/log/line_number.vue';
+
+describe('Job Log Header Line', () => {
+  let wrapper;
+
+  const data = {
+    line: {
+      content: [
+        {
+          text: 'Running with gitlab-runner 12.1.0 (de7731dd)',
+          style: 'term-fg-l-green',
+        },
+      ],
+      lineNumber: 0,
+    },
+    isClosed: true,
+    path: '/jashkenas/underscore/-/jobs/335',
+  };
+
+  const createComponent = (props = {}) => {
+    wrapper = mount(LineHeader, {
+      sync: false,
+      propsData: {
+        ...props,
+      },
+    });
+  };
+
+  afterEach(() => {
+    wrapper.destroy();
+  });
+
+  describe('line', () => {
+    beforeEach(() => {
+      createComponent(data);
+    });
+
+    it('renders the line number component', () => {
+      expect(wrapper.contains(LineNumber)).toBe(true);
+    });
+
+    it('renders a span the provided text', () => {
+      expect(wrapper.find('span').text()).toBe(data.line.content[0].text);
+    });
+
+    it('renders the provided style as a class attribute', () => {
+      expect(wrapper.find('span').classes()).toContain(data.line.content[0].style);
+    });
+  });
+
+  describe('when isCloses is true', () => {
+    beforeEach(() => {
+      createComponent({ ...data, isClosed: true });
+    });
+
+    it('sets icon name to be angle-right', () => {
+      expect(wrapper.vm.iconName).toEqual('angle-right');
+    });
+  });
+
+  describe('when isCloses is false', () => {
+    beforeEach(() => {
+      createComponent({ ...data, isClosed: false });
+    });
+
+    it('sets icon name to be angle-down', () => {
+      expect(wrapper.vm.iconName).toEqual('angle-down');
+    });
+  });
+
+  describe('on click', () => {
+    beforeEach(() => {
+      createComponent(data);
+    });
+
+    it('emits toggleLine event', () => {
+      wrapper.trigger('click');
+
+      expect(wrapper.emitted().toggleLine.length).toBe(1);
+    });
+  });
+});
diff --git a/spec/javascripts/jobs/components/log/line_number_spec.js b/spec/javascripts/jobs/components/log/line_number_spec.js
new file mode 100644
index 00000000000..fcf2edf9159
--- /dev/null
+++ b/spec/javascripts/jobs/components/log/line_number_spec.js
@@ -0,0 +1,40 @@
+import { shallowMount } from '@vue/test-utils';
+import LineNumber from '~/jobs/components/log/line_number.vue';
+
+describe('Job Log Line Number', () => {
+  let wrapper;
+
+  const data = {
+    lineNumber: 0,
+    path: '/jashkenas/underscore/-/jobs/335',
+  };
+
+  const createComponent = (props = {}) => {
+    wrapper = shallowMount(LineNumber, {
+      sync: false,
+      propsData: {
+        ...props,
+      },
+    });
+  };
+
+  beforeEach(() => {
+    createComponent(data);
+  });
+
+  afterEach(() => {
+    wrapper.destroy();
+  });
+
+  it('renders incremented lineNunber by 1', () => {
+    expect(wrapper.text()).toBe('1');
+  });
+
+  it('renders link with lineNumber as an ID', () => {
+    expect(wrapper.attributes().id).toBe('L1');
+  });
+
+  it('links to the provided path with line number as anchor', () => {
+    expect(wrapper.attributes().href).toBe(`${data.path}#L1`);
+  });
+});
diff --git a/spec/javascripts/jobs/components/log/line_spec.js b/spec/javascripts/jobs/components/log/line_spec.js
new file mode 100644
index 00000000000..ea593e3c39a
--- /dev/null
+++ b/spec/javascripts/jobs/components/log/line_spec.js
@@ -0,0 +1,49 @@
+import { shallowMount } from '@vue/test-utils';
+import Line from '~/jobs/components/log/line.vue';
+import LineNumber from '~/jobs/components/log/line_number.vue';
+
+describe('Job Log Line', () => {
+  let wrapper;
+
+  const data = {
+    line: {
+      content: [
+        {
+          text: 'Running with gitlab-runner 12.1.0 (de7731dd)',
+          style: 'term-fg-l-green',
+        },
+      ],
+      lineNumber: 0,
+    },
+    path: '/jashkenas/underscore/-/jobs/335',
+  };
+
+  const createComponent = (props = {}) => {
+    wrapper = shallowMount(Line, {
+      sync: false,
+      propsData: {
+        ...props,
+      },
+    });
+  };
+
+  beforeEach(() => {
+    createComponent(data);
+  });
+
+  afterEach(() => {
+    wrapper.destroy();
+  });
+
+  it('renders the line number component', () => {
+    expect(wrapper.contains(LineNumber)).toBe(true);
+  });
+
+  it('renders a span the provided text', () => {
+    expect(wrapper.find('span').text()).toBe(data.line.content[0].text);
+  });
+
+  it('renders the provided style as a class attribute', () => {
+    expect(wrapper.find('span').classes()).toContain(data.line.content[0].style);
+  });
+});