From 2615cafd5d021045ed780810d059d1a41a3623b8 Mon Sep 17 00:00:00 2001
From: Oliver Sand <oliver.sand@sda-se.com>
Date: Wed, 9 Sep 2020 14:50:54 +0200
Subject: [PATCH] feat: add showCopyCodeButton to CodeSnippet component

This allows to easiy copy the content of the code snippet.
---
 .../CodeSnippet/CodeSnippet.stories.tsx       |  6 +++++
 .../CodeSnippet/CodeSnippet.test.tsx          | 12 ++++++++-
 .../components/CodeSnippet/CodeSnippet.tsx    | 27 +++++++++++++------
 .../CopyTextButton/CopyTextButton.test.tsx    |  4 +--
 4 files changed, 38 insertions(+), 11 deletions(-)

diff --git a/packages/core/src/components/CodeSnippet/CodeSnippet.stories.tsx b/packages/core/src/components/CodeSnippet/CodeSnippet.stories.tsx
index c0f57d6330..77f3ca51cc 100644
--- a/packages/core/src/components/CodeSnippet/CodeSnippet.stories.tsx
+++ b/packages/core/src/components/CodeSnippet/CodeSnippet.stories.tsx
@@ -86,3 +86,9 @@ export const Languages = () => (
     <CodeSnippet text={PYTHON} language="python" showLineNumbers />
   </InfoCard>
 );
+
+export const CopyCode = () => (
+  <InfoCard title="Copy Code">
+    <CodeSnippet text={JAVASCRIPT} language="javascript" showCopyCodeButton />
+  </InfoCard>
+);
diff --git a/packages/core/src/components/CodeSnippet/CodeSnippet.test.tsx b/packages/core/src/components/CodeSnippet/CodeSnippet.test.tsx
index 42efbf14af..1a76f84f44 100644
--- a/packages/core/src/components/CodeSnippet/CodeSnippet.test.tsx
+++ b/packages/core/src/components/CodeSnippet/CodeSnippet.test.tsx
@@ -15,7 +15,7 @@
  */
 
 import React from 'react';
-import { render } from '@testing-library/react';
+import { render, fireEvent } from '@testing-library/react';
 import { wrapInTestApp } from '@backstage/test-utils';
 
 import { CodeSnippet } from './CodeSnippet';
@@ -55,4 +55,14 @@ describe('<CodeSnippet />', () => {
     expect(queryByText(/2/)).toBeInTheDocument();
     expect(queryByText(/3/)).toBeInTheDocument();
   });
+
+  it('copy code using button', async () => {
+    document.execCommand = jest.fn();
+    const rendered = render(
+      wrapInTestApp(<CodeSnippet {...minProps} showCopyCodeButton />),
+    );
+    const button = rendered.getByTitle('Text copied to clipboard');
+    fireEvent.click(button);
+    expect(document.execCommand).toHaveBeenCalled();
+  });
 });
diff --git a/packages/core/src/components/CodeSnippet/CodeSnippet.tsx b/packages/core/src/components/CodeSnippet/CodeSnippet.tsx
index 324d71e936..b6d9b3a5aa 100644
--- a/packages/core/src/components/CodeSnippet/CodeSnippet.tsx
+++ b/packages/core/src/components/CodeSnippet/CodeSnippet.tsx
@@ -20,19 +20,22 @@ import SyntaxHighlighter from 'react-syntax-highlighter';
 import { docco, dark } from 'react-syntax-highlighter/dist/cjs/styles/hljs';
 import { useTheme } from '@material-ui/core';
 import { BackstageTheme } from '@backstage/theme';
+import { CopyTextButton } from '../CopyTextButton';
 
 type Props = {
   text: string;
   language: string;
   showLineNumbers?: boolean;
+  showCopyCodeButton?: boolean;
 };
 
 const defaultProps = {
   showLineNumbers: false,
+  showCopyCodeButton: false,
 };
 
 export const CodeSnippet: FC<Props> = props => {
-  const { text, language, showLineNumbers } = {
+  const { text, language, showLineNumbers, showCopyCodeButton } = {
     ...defaultProps,
     ...props,
   };
@@ -41,13 +44,20 @@ export const CodeSnippet: FC<Props> = props => {
   const mode = theme.palette.type === 'dark' ? dark : docco;
 
   return (
-    <SyntaxHighlighter
-      language={language}
-      style={mode}
-      showLineNumbers={showLineNumbers}
-    >
-      {text}
-    </SyntaxHighlighter>
+    <div style={{ position: 'relative' }}>
+      <SyntaxHighlighter
+        language={language}
+        style={mode}
+        showLineNumbers={showLineNumbers}
+      >
+        {text}
+      </SyntaxHighlighter>
+      {showCopyCodeButton && (
+        <div style={{ position: 'absolute', top: 0, right: 0 }}>
+          <CopyTextButton text={text} />
+        </div>
+      )}
+    </div>
   );
 };
 
@@ -56,4 +66,5 @@ CodeSnippet.propTypes = {
   text: PropTypes.string.isRequired,
   language: PropTypes.string.isRequired,
   showLineNumbers: PropTypes.bool,
+  showCopyCodeButton: PropTypes.bool,
 };
diff --git a/packages/core/src/components/CopyTextButton/CopyTextButton.test.tsx b/packages/core/src/components/CopyTextButton/CopyTextButton.test.tsx
index e789035b44..cab992e11a 100644
--- a/packages/core/src/components/CopyTextButton/CopyTextButton.test.tsx
+++ b/packages/core/src/components/CopyTextButton/CopyTextButton.test.tsx
@@ -15,7 +15,7 @@
  */
 
 import React from 'react';
-import { render } from '@testing-library/react';
+import { render, fireEvent } from '@testing-library/react';
 import { wrapInTestApp } from '@backstage/test-utils';
 import { CopyTextButton } from './CopyTextButton';
 import {
@@ -76,7 +76,7 @@ describe('<CopyTextButton />', () => {
       ),
     );
     const button = rendered.getByTitle('mockTooltip');
-    button.click();
+    fireEvent.click(button);
     expect(document.execCommand).toHaveBeenCalled();
     rendered.getByText('mockTooltip');
   });