Merge pull request #337 from jekyll/defaults

Support frontmatter defaults in the front end

Author: mertkahyaoglu

spec/fixtures/site/_config.yml

@@ -17,7 +17,22 @@ defaults:
     scope:
       path: ""
     values:
-      some_front_matter: "default"
+      all: true
+  - scope:
+      path: ''
+      type: pages
+    values:
+      page_only: true
+  - scope:
+      path: ''
+      type: puppies
+    values:
+      breed: ''
+  - scope:
+      path: 'test'
+      type: posts
+    values:
+      post_test_only: true
 
 # Dummy Collection.
 collections:

spec/jekyll-admin/apiable_spec.rb

@@ -52,8 +52,8 @@
           end
 
           it "includes front matter defaults as top-level keys" do
-            expect(as_api).to have_key("some_front_matter")
-            expect(as_api["some_front_matter"]).to eql("default")
+            expect(as_api).to have_key("all")
+            expect(as_api["all"]).to eql(true)
           end
 
           it "includes front matter as top-level keys" do

spec/jekyll-admin/server/collection_spec.rb

@@ -71,7 +71,7 @@ def app
       it "includes front matter defaults" do
         get "/collections/posts/entries/"
         expect(last_response).to be_ok
-        expect(first_document.key?("some_front_matter")).to eq(true)
+        expect(first_document.key?("all")).to eq(true)
       end
 
       it "doesn't include the raw front matter" do
@@ -181,7 +181,7 @@ def app
 
       it "contains front matter defaults" do
         get "/collections/posts/2016-01-01-test-post.md"
-        expect(last_response_parsed.key?("some_front_matter")).to eql(true)
+        expect(last_response_parsed.key?("all")).to eql(true)
       end
 
       it "contains raw front matter" do

spec/jekyll-admin/server/page_spec.rb

@@ -45,7 +45,8 @@ def app
     it "includes front matter defaults" do
       get "/pages"
       expect(last_response).to be_ok
-      expect(first_page).to have_key("some_front_matter")
+      expect(first_page).to have_key("all")
+      expect(first_page).to have_key("page_only")
     end
 
     it "doesn't include the raw front matter" do
@@ -101,7 +102,8 @@ def app
 
       it "contains front matter defaults" do
         get "/pages/page.md"
-        expect(last_response_parsed.key?("some_front_matter")).to eql(true)
+        expect(last_response_parsed.key?("all")).to eql(true)
+        expect(last_response_parsed.key?("page_only")).to eql(true)
       end
 
       it "contains raw front matter" do
@@ -112,7 +114,7 @@ def app
 
       it "raw front matter doesn't include defaults" do
         get "/pages/page.md"
-        expect(front_matter.key?("some_front_matter")).to eql(false)
+        expect(front_matter.key?("all")).to eql(false)
       end
     end
 

src/containers/MetaFields.js

@@ -17,7 +17,7 @@ export class MetaFields extends Component {
   }
 
   shouldComponentUpdate(nextProps) {
-    return nextProps.metadata !== this.props.metadata;
+    return !_.isEqual(nextProps.metadata, this.props.metadata);
   }
 
   render() {

src/containers/views/DocumentEdit.js

@@ -15,6 +15,7 @@ import Metadata from '../../containers/MetaFields';
 import { fetchDocument, deleteDocument, putDocument } from '../../actions/collections';
 import { updateTitle, updateBody, updatePath } from '../../actions/metadata';
 import { clearErrors } from '../../actions/utils';
+import { injectDefaultFields } from '../../utils/metadata';
 import { preventDefault } from '../../utils/helpers';
 import {
   getLeaveMessage, getDeleteMessage, getNotFoundMessage
@@ -97,7 +98,7 @@ export class DocumentEdit extends Component {
   render() {
     const {
       isFetching, currentDocument, errors, updateTitle, updateBody, updatePath, updated,
-      fieldChanged, params
+      fieldChanged, params, config
     } = this.props;
 
     if (isFetching) {
@@ -113,6 +114,8 @@ export class DocumentEdit extends Component {
     } = currentDocument;
     const [directory, ...rest] = params.splat;
 
+    const metafields = injectDefaultFields(config, directory, collection, front_matter);
+
     const keyboardHandlers = {
       'save': this.handleClickSave,
     };
@@ -139,7 +142,7 @@ export class DocumentEdit extends Component {
               initialValue={raw_content}
               ref="editor" />
             <Splitter />
-            <Metadata fields={{title, path: name, raw_content, ...front_matter}} />
+            <Metadata fields={{title, path: name, raw_content, ...metafields}} />
           </div>
 
           <div className="content-side">
@@ -188,15 +191,17 @@ DocumentEdit.propTypes = {
   fieldChanged: PropTypes.bool.isRequired,
   params: PropTypes.object.isRequired,
   router: PropTypes.object.isRequired,
-  route: PropTypes.object.isRequired
+  route: PropTypes.object.isRequired,
+  config: PropTypes.object.isRequired
 };
 
 const mapStateToProps = (state) => ({
   currentDocument: state.collections.currentDocument,
   isFetching: state.collections.isFetching,
   fieldChanged: state.metadata.fieldChanged,
   updated: state.collections.updated,
-  errors: state.utils.errors
+  errors: state.utils.errors,
+  config: state.config.config
 });
 
 const mapDispatchToProps = (dispatch) => bindActionCreators({

src/containers/views/DocumentNew.js

@@ -14,6 +14,7 @@ import { updateTitle, updateBody, updatePath } from '../../actions/metadata';
 import { createDocument } from '../../actions/collections';
 import { clearErrors } from '../../actions/utils';
 import { getFilenameFromPath } from '../../utils/helpers';
+import { injectDefaultFields } from '../../utils/metadata';
 import {
   getLeaveMessage, getDeleteMessage, getNotFoundMessage
 } from '../../constants/lang';
@@ -59,13 +60,14 @@ export class DocumentNew extends Component {
   }
 
   render() {
-    const {
-      errors, updated, updateTitle, updateBody, updatePath, fieldChanged, params
-    } = this.props;
+    const { errors, updated, updateTitle, updateBody, updatePath, fieldChanged,
+      params, config } = this.props;
 
     const collection = params.collection_name;
     const link = `${ADMIN_PREFIX}/collections/${collection}`;
 
+    const metafields = injectDefaultFields(config, params.splat, collection);
+
     return (
       <div className="single">
         {errors.length > 0 && <Errors errors={errors} />}
@@ -86,7 +88,7 @@ export class DocumentNew extends Component {
               initialValue=""
               ref="editor" />
             <Splitter />
-            <Metadata fields={{}} />
+            <Metadata fields={metafields} />
           </div>
 
           <div className="content-side">
@@ -115,14 +117,16 @@ DocumentNew.propTypes = {
   updated: PropTypes.bool.isRequired,
   params: PropTypes.object.isRequired,
   router: PropTypes.object.isRequired,
-  route: PropTypes.object.isRequired
+  route: PropTypes.object.isRequired,
+  config: PropTypes.object.isRequired
 };
 
 const mapStateToProps = (state) => ({
   currentDocument: state.collections.currentDocument,
   fieldChanged: state.metadata.fieldChanged,
   errors: state.utils.errors,
-  updated: state.collections.updated
+  updated: state.collections.updated,
+  config: state.config.config
 });
 
 const mapDispatchToProps = (dispatch) => bindActionCreators({
@@ -133,6 +137,4 @@ const mapDispatchToProps = (dispatch) => bindActionCreators({
   clearErrors
 }, dispatch);
 
-export default withRouter(
-  connect(mapStateToProps, mapDispatchToProps)(DocumentNew)
-);
+export default withRouter(connect(mapStateToProps, mapDispatchToProps)(DocumentNew));

src/containers/views/PageEdit.js

@@ -15,6 +15,7 @@ import Metadata from '../MetaFields';
 import { fetchPage, deletePage, putPage } from '../../actions/pages';
 import { updateTitle, updateBody, updatePath } from '../../actions/metadata';
 import { clearErrors } from '../../actions/utils';
+import { injectDefaultFields } from '../../utils/metadata';
 import { preventDefault } from '../../utils/helpers';
 import {
   getLeaveMessage, getDeleteMessage, getNotFoundMessage
@@ -89,7 +90,7 @@ export class PageEdit extends Component {
 
   render() {
     const { isFetching, page, errors, updateTitle, updateBody, updatePath,
-      updated, fieldChanged, params } = this.props;
+      updated, fieldChanged, params, config } = this.props;
 
     if (isFetching) {
       return null;
@@ -105,7 +106,10 @@ export class PageEdit extends Component {
 
     const { name, raw_content, http_url, path, front_matter } = page;
     const [directory, ...rest] = params.splat;
+
     const title = front_matter && front_matter.title ? front_matter.title : '';
+    const metafields = injectDefaultFields(config, directory, 'pages', front_matter);
+
     return (
       <HotKeys
         handlers={keyboardHandlers}
@@ -126,7 +130,7 @@ export class PageEdit extends Component {
               initialValue={raw_content}
               ref="editor" />
             <Splitter />
-            <Metadata fields={{title, raw_content, path: name, ...front_matter}} />
+            <Metadata fields={{title, raw_content, path: name, ...metafields}} />
           </div>
 
           <div className="content-side">
@@ -173,15 +177,17 @@ PageEdit.propTypes = {
   updated: PropTypes.bool.isRequired,
   params: PropTypes.object.isRequired,
   router: PropTypes.object.isRequired,
-  route: PropTypes.object.isRequired
+  route: PropTypes.object.isRequired,
+  config: PropTypes.object.isRequired
 };
 
 const mapStateToProps = (state) => ({
   page: state.pages.page,
   isFetching: state.pages.isFetching,
   fieldChanged: state.metadata.fieldChanged,
   updated: state.pages.updated,
-  errors: state.utils.errors
+  errors: state.utils.errors,
+  config: state.config.config
 });
 
 const mapDispatchToProps = (dispatch) => bindActionCreators({

src/containers/views/PageNew.js

@@ -15,6 +15,7 @@ import Metadata from '../../containers/MetaFields';
 import { updateTitle, updateBody, updatePath, updateDraft } from '../../actions/metadata';
 import { createPage } from '../../actions/pages';
 import { clearErrors } from '../../actions/utils';
+import { injectDefaultFields } from '../../utils/metadata';
 import {
   getLeaveMessage, getDeleteMessage, getNotFoundMessage
 } from '../../constants/lang';
@@ -55,8 +56,9 @@ export class PageNew extends Component {
 
   render() {
     const { errors, updated, updateTitle, updateBody, updatePath,
-      updateDraft, fieldChanged, params } = this.props;
+      updateDraft, fieldChanged, params, config } = this.props;
 
+    const metafields = injectDefaultFields(config, params.splat, 'pages');
     return (
       <div className="single">
         {errors.length > 0 && <Errors errors={errors} />}
@@ -77,7 +79,7 @@ export class PageNew extends Component {
               initialValue=""
               ref="editor" />
             <Splitter />
-            <Metadata fields={{}} />
+            <Metadata fields={metafields} />
           </div>
 
           <div className="content-side">
@@ -107,14 +109,16 @@ PageNew.propTypes = {
   updated: PropTypes.bool.isRequired,
   router: PropTypes.object.isRequired,
   route: PropTypes.object.isRequired,
-  params: PropTypes.object.isRequired
+  params: PropTypes.object.isRequired,
+  config: PropTypes.object.isRequired
 };
 
 const mapStateToProps = (state) => ({
   page: state.pages.page,
   fieldChanged: state.metadata.fieldChanged,
   errors: state.utils.errors,
-  updated: state.pages.updated
+  updated: state.pages.updated,
+  config: state.config.config
 });
 
 const mapDispatchToProps = (dispatch) => bindActionCreators({

src/containers/views/tests/documentedit.spec.js

@@ -7,7 +7,7 @@ import { DocumentEdit } from '../DocumentEdit';
 import Errors from '../../../components/Errors';
 import Button from '../../../components/Button';
 
-import { doc } from './fixtures';
+import { config, doc } from './fixtures';
 
 const defaultProps = {
   currentDocument: doc,
@@ -17,6 +17,7 @@ const defaultProps = {
   isFetching: false,
   router: {},
   route: {},
+  config: config,
   params: { collection_name: "movies", splat: [null, "inception", "md"] }
 };
 

src/containers/views/tests/documentnew.spec.js

@@ -7,14 +7,15 @@ import { DocumentNew } from '../DocumentNew';
 import Errors from '../../../components/Errors';
 import Button from '../../../components/Button';
 
-import { doc } from './fixtures';
+import { config, doc } from './fixtures';
 
 const defaultProps = {
   errors: [],
   fieldChanged: false,
   updated: false,
   router: {},
   route: {},
+  config: config,
   params: { collection_name: doc.collection }
 };
 

src/containers/views/tests/pageedit.spec.js

@@ -7,7 +7,7 @@ import { PageEdit } from '../PageEdit';
 import Errors from '../../../components/Errors';
 import Button from '../../../components/Button';
 
-import { page } from './fixtures';
+import { config, page } from './fixtures';
 
 const defaultProps = {
   page: page,
@@ -17,6 +17,7 @@ const defaultProps = {
   isFetching: false,
   router: {},
   route: {},
+  config: config,
   params: { splat: [null, "page", "md"] }
 };
 

src/containers/views/tests/pagenew.spec.js

@@ -7,14 +7,15 @@ import { PageNew } from '../PageNew';
 import Errors from '../../../components/Errors';
 import Button from '../../../components/Button';
 
-import { page } from './fixtures';
+import { config, page } from './fixtures';
 
 const defaultProps = {
   errors: [],
   fieldChanged: false,
   updated: false,
   router: {},
   route: {},
+  config: config,
   params: { splat: 'page-dir' }
 };