Merge branch 'master' of https://github.com/jekyll/jekyll-admin into jekyll-master

Author: rthrfrd

.rubocop.yml

@@ -12,5 +12,16 @@ AllCops:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/PerceivedComplexity:
+  Max: 9
+
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - lib/jekyll-admin/page_without_a_file.rb
+
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - lib/jekyll-admin/data_file.rb

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright 2017 Mert Kahyaoğlu and the Jekyll Admin contributors
+Copyright 2016-present Mert Kahyaoğlu and the Jekyll Admin contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,26 +4,26 @@
 [![Coverage Status](https://coveralls.io/repos/github/jekyll/jekyll-admin/badge.svg?branch=master)](https://coveralls.io/github/jekyll/jekyll-admin?branch=master)
 [![NPM Dependencies](https://david-dm.org/jekyll/jekyll-admin.svg)](https://david-dm.org/jekyll/jekyll-admin)
 
-A Jekyll plugin that provides users with a traditional CMS-style graphical interface to author content and administer Jekyll sites. The project is divided into two parts. A Ruby-based HTTP API that handles Jekyll and filesystem operations, and a Javascript-based front end, built on that API.
+A Jekyll plugin that provides users with a traditional CMS-style graphical interface to author content and administer Jekyll sites. The project is divided into two parts. A Ruby-based HTTP API that handles Jekyll and filesystem operations, and a JavaScript-based front end, built on that API.
 
 ![screenshot of Jekyll Admin](/screenshot.png)
 
 ## Installation
 
 Refer to the [installing plugins](https://jekyllrb.com/docs/plugins/#installing-a-plugin) section of Jekyll's documentation and install the `jekyll-admin` plugin as you would any other plugin. Here's the short version:
 
-1. Add the following to your site's Gemfile:
+1.  Add the following to your site's Gemfile:
 
     ```ruby
     gem 'jekyll-admin', group: :jekyll_plugins
     ```
 
-2. Run `bundle install`
+2.  Run `bundle install`
 
 ## Usage
 
-1. Start Jekyll as you would normally (`bundle exec jekyll serve`)
-2. Navigate to `http://localhost:4000/admin` to access the administrative interface
+1.  Start Jekyll as you would normally (`bundle exec jekyll serve`)
+2.  Navigate to `http://localhost:4000/admin` to access the administrative interface
 
 ## Options
 
@@ -45,10 +45,6 @@ jekyll_admin:
 
 Interested in contributing to Jekyll Admin? We’d love your help. Jekyll Admin is an open source project, built one contribution at a time by users like you. See [the contributing instructions](.github/CONTRIBUTING.md), and [the development docs](http://jekyll.github.io/jekyll-admin/development/) for more information.
 
-## Looking for a hosted version?
-
-Jekyll Admin is intended to be run on your computer alongside your local Jekyll installation. If you're looking for a hosted version, we'd recommend checking out [Siteleaf](https://www.siteleaf.com/) a hosted Jekyll editor with deep GitHub integration (whom we'd also like to thank for inspiring parts of Jekyll Admin itself!).
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

docs/_config.yml

@@ -6,7 +6,7 @@ collections:
     permalink: /frontend/:path/
     output: true
 
-gems:
+plugins:
   - jekyll-seo-tag
   - jekyll-sitemap
 

docs/_frontend/actions.md

@@ -77,6 +77,27 @@ The response includes the document body.
 
 Async action for deleting the document in a directory from disk. After deletion, collection documents are requested.
 
+## Drafts
+
+### `fetchDrafts(directory)`
+
+Async action for fetching an array of drafts in a sub-directory.
+
+### `fetchDraft(directory, filename)`
+
+Async action for fetching the requested draft in a sub-directory.
+
+### `putDraft(mode, directory, filename = '')`
+
+Async action for creating or updating the requested draft. The content comes
+from `state.metadata`.
+If the path is not provided when `mode` equals `'create'`, it is auto-generated from the `title` metadata.
+
+### `deleteDraft(directory, filename)`
+
+Async action for deleting the requested draft in a sub-directory.
+After deletion, draft list is requested.
+
 ## Metadata
 
 ### `storeContentFields(meta)`

docs/_frontend/containers.md

@@ -228,6 +228,70 @@ Container for creating a new document.
 }
 ```
 
+## Drafts
+
+Container for Drafts view. Lists all drafts and sub-directories at given path.
+
+### PropTypes
+
+```javascript
+{
+  drafts: Array,
+  fetchDrafts: Function,
+  deleteDraft: Function,
+  search: Function,
+  isFetching: Boolean,
+  params: Object
+}
+```
+
+## DraftNew
+
+Container for creating a new draft.
+
+```javascript
+{
+  putDraft: Function,
+  updateTitle: Function,
+  updateBody: Function,
+  updatePath: Function,
+  updateDraft: Function,
+  clearErrors: Function,
+  errors: Array,
+  fieldChanged: Boolean,
+  updated: Boolean,
+  router: Object,
+  route: Object,
+  params: Object,
+  config: Object
+}
+```
+
+## DraftEdit
+
+Container for editing a draft.
+
+```javascript
+{
+  draft: Object,
+  fetchDraft: Function,
+  deleteDraft: Function,
+  putDraft: Function,
+  updateTitle: Function,
+  updateBody: Function,
+  updatePath: Function,
+  clearErrors: Function,
+  isFetching: Boolean,
+  fieldChanged: Boolean,
+  updated: Boolean,
+  errors: Array,
+  params: Object,
+  router: Object,
+  route: Object,
+  config: Object
+}
+```
+
 ## DataFiles
 
 Container for DataFiles view. Lists data files.

docs/_frontend/reducers.md

@@ -43,6 +43,19 @@ description: Specifies how the application’s state changes in response to acti
 }
 ```
 
+## Drafts
+
+### State
+
+```javascript
+{
+  drafts: Array,
+  draft: Object, // currently visited draft
+  isFetching: Boolean, // set to true when the draft is being fetched
+  updated: Boolean // set to true when the draft is updated
+}
+```
+
 ## Metadata
 
 ### State

docs/_includes/sidebar.html

@@ -14,6 +14,7 @@
 
   <ul class="routes">
     <li><a href="{{ "/" | relative_url }}" {% if page.url == '/' %}class="active"{% endif %}>Index</a></li>
+    <li><a href="{{ "/configs" | relative_url }}" {% if active[1] == 'configs' %}class="active"{% endif %}>Configs</a></li>
     <li><a href="{{ "/api" | relative_url }}" {% if active[1] == 'api' %}class="active"{% endif %}>API</a></li>
     <li><a href="{{ "/frontend" | relative_url }}" {% if active[1] == 'frontend' %}class="active"{% endif %}>Front End</a>
       <ul>

docs/api.md

@@ -186,6 +186,151 @@ Create or update the requested page, writing its contents to disk.
 
 Delete the requested page from disk.
 
+### Drafts
+
+The end-points for drafts are modelled similar to `Pages` even though the resource inherently belongs to a `Posts` collection.
+
+#### Parameters
+
+* `directory` - the *optional* sub-directory for a draft, relative to `_drafts` at the site root (e.g., `draft-dir`) (`String`).
+* `filename` - the draft's filename.
+* `raw_content` - the drafts's body (`String`)
+* `front_matter` - the drafts's YAML front matter (`Object`)
+
+While `path` for a sub-directory, is the same as the parameter `directory` itself, for a draft-file, it is the entire path relative to the site's root 
+
+#### `GET /drafts/:directory`
+
+Returns an array of drafts and directories for the requested directory path. If `directory`
+is not provided, entries at the root level (`./_drafts/*`) are returned.
+
+The response does not include drafts' body.
+
+##### Example response
+
+```
+GET /drafts
+```
+
+```json
+[
+  {
+    "name": "draft-dir",
+    "modified_time": "2017-09-24 19:08:41 -0400",
+    "path": "draft-dir",
+    "type": "directory",
+    "http_url": null,
+    "api_url": "http://localhost:4000/_api/drafts/draft-dir"
+  },
+  {
+    "path": "_drafts/draft-post.md",
+    "id": "/2017/09/24/draft-post",
+    "url": "/2017/09/24/draft-post.html",
+    "relative_path": "draft-post.md",
+    "collection": "posts",
+    "draft": true,
+    "categories": [
+
+    ],
+    "all": true,
+    "foo": "bar",
+    "title": "Draft Post",
+    "slug": "draft-post",
+    "ext": ".md",
+    "tags": [
+
+    ],
+    "date": "2017-09-24 18:03:49 -0400",
+    "http_url": "http://localhost:4000/2017/09/24/draft-post.html",
+    "api_url": "http://localhost:4000/_api/drafts/draft-post.md",
+    "name": "draft-post.md"
+  }
+]
+```
+
+#### `GET /drafts/:directory/:filename`
+
+Returns the requested draft. The response includes the draft body.
+
+##### Example response
+
+```
+GET /drafts/draft-dir/another-draft-post.md
+```
+
+```json
+{
+  "next": {
+    "path": "_drafts/draft-post.md",
+    "id": "/2017/09/24/draft-post",
+    "url": "/2017/09/24/draft-post.html",
+    "relative_path": "draft-post.md",
+    "collection": "posts",
+    "draft": true,
+    "categories": [],
+    "all": true,
+    "foo": "bar",
+    "title": "Draft Post",
+    "slug": "draft-post",
+    "ext": ".md",
+    "tags": [],
+    "date": "2017-09-24 18:03:49 -0400",
+    "http_url": "http://localhost:4000/2017/09/24/draft-post.html",
+    "api_url": "http://localhost:4000/_api/drafts/draft-post.md",
+    "name": "draft-post.md"
+  },
+  "path": "_drafts/draft-dir/another-draft-post.md",
+  "previous": {
+    "path": "_drafts/draft-dir/WIP/yet-another-draft-post.md",
+    "id": "/2017/09/24/yet-another-draft-post",
+    "url": "/2017/09/24/yet-another-draft-post.html",
+    "relative_path": "draft-dir/WIP/yet-another-draft-post.md",
+    "collection": "posts",
+    "draft": true,
+    "categories": [],
+    "all": true,
+    "foo": "bar",
+    "title": "Yet Another Draft Post",
+    "slug": "yet-another-draft-post",
+    "ext": ".md",
+    "tags": [],
+    "date": "2017-09-24 18:03:49 -0400",
+    "http_url": "http://localhost:4000/2017/09/24/yet-another-draft-post.html",
+    "api_url": "http://localhost:4000/_api/drafts/draft-dir/WIP/yet-another-draft-post.md",
+    "name": "yet-another-draft-post.md"
+  },
+  "content": "<h1 id=\"another-draft-post\">Another Draft Post</h1>\n",
+  "id": "/2017/09/24/another-draft-post",
+  "url": "/2017/09/24/another-draft-post.html",
+  "relative_path": "draft-dir/another-draft-post.md",
+  "collection": "posts",
+  "excerpt": "<h1 id=\"another-draft-post\">Another Draft Post</h1>\n",
+  "draft": true,
+  "categories": [],
+  "all": true,
+  "foo": "bar",
+  "title": "Another Draft Post",
+  "slug": "another-draft-post",
+  "ext": ".md",
+  "tags": [],
+  "date": "2017-09-24 18:03:49 -0400",
+  "http_url": "http://localhost:4000/2017/09/24/another-draft-post.html",
+  "api_url": "http://localhost:4000/_api/drafts/draft-dir/another-draft-post.md",
+  "raw_content": "# Another Draft Post\n",
+  "front_matter": {
+    "foo": "bar"
+  },
+  "name": "another-draft-post.md"
+}
+```
+#### `PUT /drafts/:directory/:filename`
+
+Create or update the requested page, writing its contents to disk.
+
+#### `DELETE /drafts/:directory/:filename`
+
+Delete the requested page from disk.
+
 ### Configuration
 
 #### `GET /configuration`

docs/assets/images/logo.png

@@ -0,0 +1,25 @@
+---
+title: Configuration Options
+permalink: /configs/
+--- 
+
+Jekyll Admin related options can be specified in `_config.yml`
+under a key called `jekyll_admin`.
+
+### Config Options
+
+#### `hidden_links`
+
+For hiding unwanted links on the sidebar. 
+
+The following keys under `hidden_links` can be used in order to hide default links:
+
+```yaml
+jekyll_admin:
+  hidden_links:
+    - posts
+    - pages
+    - staticfiles
+    - datafiles
+    - configuration
+```

docs/configs.md

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "rubocop", "~> 0.48.1"
+  spec.add_development_dependency "rubocop", "~> 0.57.2"
   spec.add_development_dependency "sinatra-cross_origin", "~> 0.3"
   spec.add_development_dependency "gem-release", "~> 0.7"
 end

jekyll-admin.gemspec

@@ -44,6 +44,7 @@ def to_api(include_content: false)
       end
 
       if is_a?(Jekyll::Document)
+        output["relative_path"] = relative_path.sub("_drafts/", "") if draft?
         output["name"] = basename
       end