Merge pull request #2270 from zetter/copy-commit-sha-and-subject

Make it easier to copy the commit SHA and subject

Author: smashwilson

lib/controllers/recent-commits-controller.js

@@ -63,6 +63,7 @@ export default class RecentCommitsController extends React.Component {
         selectPreviousCommit={this.selectPreviousCommit}
         selectedCommitSha={this.state.selectedCommitSha}
         commands={this.props.commands}
+        clipboard={atom.clipboard}
       />
     );
   }

lib/views/recent-commits-view.js

@@ -12,6 +12,8 @@ import Timeago from './timeago';
 
 class RecentCommitView extends React.Component {
   static propTypes = {
+    commands: PropTypes.object.isRequired,
+    clipboard: PropTypes.object.isRequired,
     commit: PropTypes.object.isRequired,
     undoLastCommit: PropTypes.func.isRequired,
     isMostRecent: PropTypes.bool.isRequired,
@@ -49,6 +51,10 @@ class RecentCommitView extends React.Component {
           'is-selected': this.props.isSelected,
         })}
         onClick={this.props.openCommit}>
+        <Commands registry={this.props.commands} target={this.refRoot}>
+          <Command command="github:copy-commit-sha" callback={this.copyCommitSha} />
+          <Command command="github:copy-commit-subject" callback={this.copyCommitSubject} />
+        </Commands>
         {this.renderAuthors()}
         <span
           className="github-RecentCommit-message"
@@ -104,6 +110,18 @@ class RecentCommitView extends React.Component {
     );
   }
 
+  copyCommitSha = event => {
+    event.stopPropagation();
+    const {commit, clipboard} = this.props;
+    clipboard.write(commit.sha);
+  }
+
+  copyCommitSubject = event => {
+    event.stopPropagation();
+    const {commit, clipboard} = this.props;
+    clipboard.write(commit.messageSubject);
+  }
+
   undoLastCommit = event => {
     event.stopPropagation();
     this.props.undoLastCommit();
@@ -118,6 +136,7 @@ export default class RecentCommitsView extends React.Component {
     selectedCommitSha: PropTypes.string.isRequired,
 
     // Atom environment
+    clipboard: PropTypes.object.isRequired,
     commands: PropTypes.object.isRequired,
 
     // Action methods
@@ -192,6 +211,8 @@ export default class RecentCommitsView extends React.Component {
             return (
               <RecentCommitView
                 key={commit.getSha()}
+                commands={this.props.commands}
+                clipboard={this.props.clipboard}
                 isMostRecent={i === 0}
                 commit={commit}
                 undoLastCommit={this.props.undoLastCommit}

menus/git.cson

@@ -140,3 +140,13 @@
       'command': 'github:amend-last-commit'
     }
   ]
+  '.github-RecentCommit': [
+    {
+      'label': 'Copy Commit SHA'
+      'command': 'github:copy-commit-sha'
+    }
+    {
+      'label': 'Copy Commit Subject'
+      'command': 'github:copy-commit-subject'
+    }
+  ]

test/controllers/recent-commits-controller.test.js

@@ -45,6 +45,12 @@ describe('RecentCommitsController', function() {
     assert.isTrue(wrapper.find('RecentCommitsView').prop('isLoading'));
   });
 
+  it('passes the clipboard to the RecentCommitsView', function() {
+    app = React.cloneElement(app);
+    const wrapper = shallow(app);
+    assert.deepEqual(wrapper.find('RecentCommitsView').prop('clipboard'), atom.clipboard);
+  });
+
   describe('openCommit({sha, preserveFocus})', function() {
     it('opens a commit detail item', async function() {
       sinon.stub(atomEnv.workspace, 'open').resolves();

test/views/recent-commits-view.test.js

@@ -14,6 +14,7 @@ describe('RecentCommitsView', function() {
     app = (
       <RecentCommitsView
         commits={[]}
+        clipboard={{}}
         isLoading={false}
         selectedCommitSha=""
         commands={atomEnv.commands}
@@ -220,4 +221,34 @@ describe('RecentCommitsView', function() {
       assert.isNull(await instance.retreatFocusFrom(CommitView.firstFocus));
     });
   });
+
+  describe('copying details of a commit', function() {
+    let wrapper;
+    let clipboard;
+
+    beforeEach(function() {
+      const commits = [
+        commitBuilder().sha('0000').messageSubject('subject 0').build(),
+        commitBuilder().sha('1111').messageSubject('subject 1').build(),
+        commitBuilder().sha('2222').messageSubject('subject 2').build(),
+      ];
+      clipboard = {write: sinon.spy()};
+      app = React.cloneElement(app, {commits, clipboard});
+      wrapper = mount(app);
+    });
+
+    it('copies the commit sha on github:copy-commit-sha', function() {
+      const commitNode = wrapper.find('.github-RecentCommit').at(1).getDOMNode();
+      atomEnv.commands.dispatch(commitNode, 'github:copy-commit-sha');
+      assert.isTrue(clipboard.write.called);
+      assert.isTrue(clipboard.write.calledWith('1111'));
+    });
+
+    it('copies the commit subject on github:copy-commit-subject', function() {
+      const commitNode = wrapper.find('.github-RecentCommit').at(1).getDOMNode();
+      atomEnv.commands.dispatch(commitNode, 'github:copy-commit-subject');
+      assert.isTrue(clipboard.write.called);
+      assert.isTrue(clipboard.write.calledWith('subject 1'));
+    });
+  });
 });