Add meta info to cards in editorial workflow #293

Benaiah · 2017-03-16T23:09:22Z

Fixes #270

- Summary

Adds meta information to the cards in the editorial workflow. Currently this includes the following:

Which collection an entry is part of
Whether an entry is new or an update to an already published entry

In order to retrieve the new/update info, it adds the field state.editorialWorkflow.entities[i].isModification, which is retrieved using the GitHub API whenever unpublished entries are loaded.

- Test plan

Tested manually (no automated tests exist for the editorial workflow).

- Description for the changelog

Add meta info to cards in editorial workflow

- A picture of a cute animal (not mandatory but encouraged)

erquhart · 2017-03-17T22:14:02Z

src/components/UnpublishedListing/UnpublishedListingCardMeta.css

+
+.meta {}
+.label {
+  padding: 5px .75em 4px .75em;


Just use pixels for everything, browsers now handle them pretty well across display densities.

erquhart · 2017-03-17T22:27:18Z

src/components/UnpublishedListing/UnpublishedListingCardMeta.css

+.meta {}
+.label {
+  padding: 5px .75em 4px .75em;
+  border-radius: 1em;


Use the borderRadius variable from UI/theme.

erquhart · 2017-03-17T22:28:07Z

src/components/UnpublishedListing/UnpublishedListingCardMeta.css

@@ -0,0 +1,23 @@
+.cardMeta {


Import ../UI/theme and use variables where it makes sense, especially for colors (add new ones where necessary). Doesn't have to be over-thought - lots of change is coming. Just want to establish the pattern of general re-use for these kinds of values.

erquhart · 2017-03-17T22:30:17Z

src/components/UnpublishedListing/UnpublishedListingCardMeta.js

+import React, { PropTypes } from 'react';
+import styles from './UnpublishedListingCardMeta.css';
+
+const UnpublishedListingCardMeta = ({ meta, label }) =>


👍 for splitting this into a new component.

erquhart · 2017-03-17T22:32:50Z

src/valueObjects/Entry.js

@@ -8,5 +8,8 @@ export function createEntry(collection, slug = '', path = '', options = {}) {
  returnObj.data = options.data || {};
  returnObj.label = options.label || null;
  returnObj.metaData = options.metaData || null;
+  returnObj.isModification = (options.isModification === true || options.isModification === false)


We can improve clarity and length using _.isBoolean, make it a one-liner.

Benaiah · 2017-03-20T19:59:47Z

@erquhart I've added the resolvePromiseProperties code to this branch. How do you want the history to look? I'm thinking about merging the last two.

Benaiah · 2017-03-20T20:29:37Z

@erquhart I've addressed your change requests - how does this look now?

erquhart

This should be the last round, great work :)

erquhart · 2017-03-20T22:47:27Z

src/components/UnpublishedListing/UnpublishedListing.js

@@ -77,6 +80,10 @@ class UnpublishedListing extends React.Component {
              >
                <div className={styles.draggable}>
                  <Card className={styles.card}>
+                    <UnpublishedListingCardMeta
+                      meta={pluralize(collection.charAt(0).toUpperCase() + collection.slice(1), 1)}


Just use lodash.capitalize here.

erquhart · 2017-03-20T23:05:00Z

src/lib/promiseHelper.js

@@ -1,3 +1,23 @@
+import _ from 'lodash';


We can keep module size down by importing the specific functions that we need.

erquhart · 2017-03-20T23:05:25Z

src/valueObjects/Entry.js

@@ -1,3 +1,5 @@
+import _ from "lodash";


Same here, just grab the one function.

erquhart · 2017-03-20T23:09:38Z

src/backends/github/API.js

-    return unpublishedPromise;
+  }
+
+  isUnpublishedEntryModification(path) {


We should be passing the path and the branch in.

`resolvePromiseProperties` takes on object and returns a promise which resolves to a copy of the object. This copy has all its immediate properties which were Promises replaced with the resolved value of those promises. Promises are run with `Promise.all`. Errors are passed up to the outer promise chain. Example usage: ```js resolvePromiseProperties({ promise: Promise.resolve("this property will resolve to this string"), nonPromise: "this will remain the same", // you can nest the function nestedPromiseInside: resolvePromiseProperties({ nestedPromise: Promise.resolve("this will resolve"), nestedNonPromise: "this stays the same", }), }) .then(obj => console.log(obj)) ``` That will produce the following output: ```js { promise: "this property will resolve to this string", nonPromise: "this will remain the same", nestedPromiseInside: { nestedPromise: "this will resolve", nestedNonPromise: "this stays the same", }, } ```

erquhart

LGTM

biilmann added the in progress label Mar 16, 2017

erquhart suggested changes Mar 17, 2017

View reviewed changes

This was referenced Mar 17, 2017

New promise helper, resolvePromiseProperties #299

Closed

Add entry type to search results #301

Closed

Benaiah force-pushed the label-cards-in-editorial-workflow branch 2 times, most recently from 84ebafd to 7ce1032 Compare March 20, 2017 19:58

Benaiah force-pushed the label-cards-in-editorial-workflow branch from 7ce1032 to 9deb15f Compare March 20, 2017 20:29

Benaiah changed the title ~~(WIP) Add meta info to cards in editorial workflow~~ Add meta info to cards in editorial workflow Mar 20, 2017

Benaiah force-pushed the label-cards-in-editorial-workflow branch from 9deb15f to ba76de4 Compare March 20, 2017 20:32

erquhart suggested changes Mar 20, 2017

View reviewed changes

Benaiah added 2 commits March 20, 2017 17:02

Label cards in editorial workflow

c079cb9

Benaiah force-pushed the label-cards-in-editorial-workflow branch from ba76de4 to df89b50 Compare March 21, 2017 00:05

Refactor readUnpublishedBranchFile with resolvePromiseProperties

1aa02eb

Benaiah force-pushed the label-cards-in-editorial-workflow branch from df89b50 to 1aa02eb Compare March 21, 2017 00:17

erquhart approved these changes Mar 21, 2017

View reviewed changes

erquhart merged commit 96d6242 into decaporg:master Mar 21, 2017

biilmann removed the in progress label Mar 21, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add meta info to cards in editorial workflow #293

Add meta info to cards in editorial workflow #293

Benaiah commented Mar 16, 2017 •

edited by erquhart

Loading

erquhart Mar 17, 2017

erquhart Mar 17, 2017

erquhart Mar 17, 2017

erquhart Mar 17, 2017

erquhart Mar 17, 2017

Benaiah commented Mar 20, 2017

Benaiah commented Mar 20, 2017

erquhart left a comment

erquhart Mar 20, 2017

erquhart Mar 20, 2017

erquhart Mar 20, 2017

erquhart Mar 20, 2017

erquhart left a comment

Add meta info to cards in editorial workflow #293

Add meta info to cards in editorial workflow #293

Conversation

Benaiah commented Mar 16, 2017 • edited by erquhart Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Benaiah commented Mar 20, 2017

Benaiah commented Mar 20, 2017

erquhart left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erquhart left a comment

Choose a reason for hiding this comment

Benaiah commented Mar 16, 2017 •

edited by erquhart

Loading