Welcome to mirror list, hosted at ThFree Co, Russian Federation.

copy_to_clipboard_spec.js « behaviors « frontend « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: c5beaa0ba5d4e4728a87fb789ecf28b390b3bc5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
import initCopyToClipboard, {
  CLIPBOARD_SUCCESS_EVENT,
  CLIPBOARD_ERROR_EVENT,
  I18N_ERROR_MESSAGE,
} from '~/behaviors/copy_to_clipboard';
import { show, hide, fixTitle, once } from '~/tooltips';

let onceCallback = () => {};
jest.mock('~/tooltips', () => ({
  show: jest.fn(),
  hide: jest.fn(),
  fixTitle: jest.fn(),
  once: jest.fn((event, callback) => {
    onceCallback = callback;
  }),
}));

describe('initCopyToClipboard', () => {
  let clearSelection;
  let focusSpy;
  let dispatchEventSpy;
  let button;
  let clipboardInstance;

  afterEach(() => {
    document.body.innerHTML = '';
    clipboardInstance = null;
  });

  const title = 'Copy this value';
  const defaultButtonAttributes = {
    'data-clipboard-text': 'foo bar',
    title,
    'data-title': title,
  };
  const createButton = (attributes = {}) => {
    const combinedAttributes = { ...defaultButtonAttributes, ...attributes };
    button = document.createElement('button');
    Object.keys(combinedAttributes).forEach((attributeName) => {
      button.setAttribute(attributeName, combinedAttributes[attributeName]);
    });
    document.body.appendChild(button);
  };

  const init = () => {
    clipboardInstance = initCopyToClipboard();
  };

  const setupSpies = () => {
    clearSelection = jest.fn();
    focusSpy = jest.spyOn(button, 'focus');
    dispatchEventSpy = jest.spyOn(button, 'dispatchEvent');
  };

  const emitSuccessEvent = () => {
    clipboardInstance.emit('success', {
      action: 'copy',
      text: 'foo bar',
      trigger: button,
      clearSelection,
    });
  };

  const emitErrorEvent = () => {
    clipboardInstance.emit('error', {
      action: 'copy',
      text: 'foo bar',
      trigger: button,
      clearSelection,
    });
  };

  const itHandlesTooltip = (expectedTooltip) => {
    it('handles tooltip', () => {
      expect(button.getAttribute('title')).toBe(expectedTooltip);
      expect(button.getAttribute('aria-label')).toBe(expectedTooltip);
      expect(fixTitle).toHaveBeenCalledWith(button);
      expect(show).toHaveBeenCalledWith(button);
      expect(once).toHaveBeenCalledWith('hidden', expect.any(Function));

      expect(hide).not.toHaveBeenCalled();
      jest.runAllTimers();
      expect(hide).toHaveBeenCalled();

      onceCallback({ target: button });
      expect(button.getAttribute('title')).toBe(title);
      expect(button.getAttribute('aria-label')).toBe(title);
      expect(fixTitle).toHaveBeenCalledWith(button);
    });
  };

  describe('when value is successfully copied', () => {
    it(`calls clearSelection, focuses the button, and dispatches ${CLIPBOARD_SUCCESS_EVENT} event`, () => {
      createButton();
      init();
      setupSpies();
      emitSuccessEvent();

      expect(clearSelection).toHaveBeenCalled();
      expect(focusSpy).toHaveBeenCalled();
      expect(dispatchEventSpy).toHaveBeenCalledWith(new Event(CLIPBOARD_SUCCESS_EVENT));
    });

    describe('when `data-clipboard-handle-tooltip` is set to `false`', () => {
      beforeEach(() => {
        createButton({
          'data-clipboard-handle-tooltip': 'false',
        });
        init();
        emitSuccessEvent();
      });

      it('does not handle success tooltip', () => {
        expect(show).not.toHaveBeenCalled();
      });
    });

    describe('when `data-clipboard-handle-tooltip` is set to `true`', () => {
      beforeEach(() => {
        createButton({
          'data-clipboard-handle-tooltip': 'true',
        });
        init();
        emitSuccessEvent();
      });

      itHandlesTooltip('Copied');
    });

    describe('when `data-clipboard-handle-tooltip` is not set', () => {
      beforeEach(() => {
        createButton();
        init();
        emitSuccessEvent();
      });

      itHandlesTooltip('Copied');
    });
  });

  describe('when there is an error copying the value', () => {
    it(`dispatches ${CLIPBOARD_ERROR_EVENT} event`, () => {
      createButton();
      init();
      setupSpies();
      emitErrorEvent();

      expect(dispatchEventSpy).toHaveBeenCalledWith(new Event(CLIPBOARD_ERROR_EVENT));
    });

    describe('when `data-clipboard-handle-tooltip` is set to `false`', () => {
      beforeEach(() => {
        createButton({
          'data-clipboard-handle-tooltip': 'false',
        });
        init();
        emitErrorEvent();
      });

      it('does not handle error tooltip', () => {
        expect(show).not.toHaveBeenCalled();
      });
    });

    describe('when `data-clipboard-handle-tooltip` is set to `true`', () => {
      beforeEach(() => {
        createButton({
          'data-clipboard-handle-tooltip': 'true',
        });
        init();
        emitErrorEvent();
      });

      itHandlesTooltip(I18N_ERROR_MESSAGE);
    });

    describe('when `data-clipboard-handle-tooltip` is not set', () => {
      beforeEach(() => {
        createButton();
        init();
        emitErrorEvent();
      });

      itHandlesTooltip(I18N_ERROR_MESSAGE);
    });
  });
});