Merge branch 'master' into custom-config-hash

Author: ashmaroli

.rubocop.yml

@@ -6,6 +6,8 @@ AllCops:
     - lib/jekyll-admin/public/**/*
     - src/**/*
     - node_modules/**/*
+    - Gemfile
+    - jekyll-admin.gemspec
 
 Metrics/BlockLength:
   Enabled: false

docs/_frontend/actions.md

@@ -7,11 +7,15 @@ description: Actions are payloads of information that send data from the applica
 
 ### > `fetchConfig`
 
-Async action for fetching Jekyll project configuration (`_config.yml`)
+Async action for fetching an object comprised of Jekyll project configuration (from `_config.yml` by default)
 
 ### > `putConfig(config)`
 
-Async action for updating Jekyll project configuration
+Async action for updating Jekyll project configuration, after ensuring the content is not empty.
+
+### > `validateConfig(config)`
+
+Action for checking whether the YAML editor has content.
 
 ### > `onEditorChange`
 

docs/_frontend/components.md

@@ -68,6 +68,21 @@ Generic component for button element.
 }
 ```
 
+## Dropzone
+
+Component for uploading staticfiles.
+
+### PropTypes
+
+```javascript
+{
+  files: Array,
+  onDrop: Function,
+  onClickDelete: Function,
+  onClickItem: Function,
+}
+```
+
 ## FilePreview
 
 Component for previewing the uploaded file. It renders an image or a div according to
@@ -144,16 +159,17 @@ Editable title component for edit views
 
 ## Metadata
 
-Set of components for handling documents' front matter(metafields).
+Set of components for handling documents' front matters (metafields).
 
 ### MetaField
 
 Contains root attributes of the metadata.
 
 ### MetaSimple
 
-Leaf component that contains an simple input or date picker depending on the field's
-key. If the key is called `date`, it shows date picker for the value.
+Leaf component for metadata that contains a simple input, date picker or staticfile
+picker depending on the field's key.
+Special keys for additional functionalities are `date`, `file` and `image`.
 
 ### MetaArray
 
@@ -165,13 +181,13 @@ Convertible array item. Can be MetaArray, MetaObject or MetaSimple.
 
 ### MetaObject
 
-Contains sortable object items. Items are sorted visually, not stored in the state.
+Contains object items which allows entering key-value fields.
 
 ### MetaObjectItem
 
 Convertible object item. Can be MetaArray, MetaObject or MetaSimple.
 
 ### MetaButtons
 
-Contains convert and delete buttons and sort handle. Dynamically shows the possible
+Contains `convert` and `delete` buttons and sort handle. Dynamically shows the possible
 conversion types.

docs/_frontend/containers.md

@@ -25,7 +25,8 @@ Container for displaying header which includes title and homepage link.
 ```javascript
 {
   config: Object,
-  fetchConfig: Function
+  fetchConfig: Function,
+  updated: Boolean \\ optional
 }
 ```
 
@@ -82,7 +83,11 @@ The button is activated when the editor changes.
   putConfig: Function,
   error: String,
   updated: Boolean,
-  editorChanged: Boolean
+  editorChanged: Boolean,
+  errors: Array,
+  clearErrors: Function,
+  router: Object,
+  route: Object
 }
 ```
 

docs/api.md

@@ -73,12 +73,18 @@ A standard JSON object of a directory looks like this:
 
 #### Data files and the config file
 
-Data files and the config file are direct JSON representations of the underlying YAML File.
+Data files are a direct JSON representations of the underlying YAML File.
+A JSON object from the config file has the data segregated into two representations:
+
+* `content` - the parsed configuration data as read by Jekyll.
+* `raw_content` - the raw data as it sits on the disk.
 
 #### Static files
 
 Static files are non-Jekyll files and may be binary or text.
 
+---
+
 ### Collections
 
 #### Parameters
@@ -143,13 +149,13 @@ Delete the requested page from disk.
 
 #### `GET /configuration`
 
-Returns the parsed site configuration.
+Returns a hash object comprised of the parsed configuration from the file and the raw unparsed content of the file.
 
 #### `PUT /configuration`
 
-Create or update the site's `_config.yml` file with the requested contents.
+Create or update the site's `_config.yml` file with the requested raw file content string.
 
-File will be written to disk in YAML. It will not necessarily preserve whitespace or inline comments.
+File will be written to disk verbatim, preserving whitespace and inline comments.
 
 ### Static files
 

docs/architecture.md

@@ -8,6 +8,8 @@ description: Jekyll Admin exists in two parts, a Ruby back end and a Javascript
 
 Jekyll Admin piggybacks on Jekyll's built-in Webrick server. We monkey patch the `jekyll serve` command to hook in two Sinatra servers, one to serve the static front end that lives in `lib/jekyll-admin/public/dist` via `/admin`, and one to serve the Ruby API via `/_api`. Once the Sinatra servers are mounted, they work just like any other Jekyll server (and we rely on third-party plugins like `sintra-json` and `sinatra-cross_origin`).
 
+**Note:** Since there are two Sinatra servers that might call `site.process` concurrently, Jekyll Admin disables `--watch` flag to prevent a race condition between these servers that might cause incorrect responses for the API. This ensures that the site is regenerated by only the process that Jekyll Admin runs.
+
 ## How Jekyll Admin formats Jekyll objects for the API
 
 Whenever possible, we want to stay as close to the `to_liquid.to_json` representation of Jekyll's internal object structure as possible, so that we're (A) using data structure that developers are used to, and (B) so that we can benefit from upstream improvements. To do this, we have the `JekyllAdmin::APIable` module, which gets included in native Jekyll objects like Pages and Documents to add a `to_api` method which we can call to generate hashes for use in the API.

jekyll-admin.gemspec

@@ -35,7 +35,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.35"
+  spec.add_development_dependency "rubocop", "~> 0.48.1"
   spec.add_development_dependency "sinatra-cross_origin", "~> 0.3"
   spec.add_development_dependency "gem-release", "~> 0.7"
 end

lib/jekyll-admin.rb

@@ -16,29 +16,18 @@
 require "sinatra/reloader"
 require "sinatra/namespace"
 
-# Jekyll-Admin stuffs
-require "jekyll-admin/version"
-require "jekyll-admin/server"
-require "jekyll-admin/static_server"
-require "jekyll-admin/server/collection.rb"
-require "jekyll-admin/server/configuration.rb"
-require "jekyll-admin/server/data.rb"
-require "jekyll-admin/server/page.rb"
-require "jekyll-admin/server/static_file.rb"
-require "jekyll-admin/apiable.rb"
-require "jekyll-admin/urlable.rb"
-require "jekyll-admin/data_file.rb"
-require "jekyll-admin/directory.rb"
-require "jekyll-admin/page_without_a_file.rb"
-
-# Monkey Patches
-require_relative "./jekyll/commands/serve"
-[Jekyll::Page, Jekyll::Document, Jekyll::StaticFile, Jekyll::Collection].each do |klass|
-  klass.include JekyllAdmin::APIable
-  klass.include JekyllAdmin::URLable
-end
-
 module JekyllAdmin
+  autoload :APIable,          "jekyll-admin/apiable"
+  autoload :DataFile,         "jekyll-admin/data_file"
+  autoload :Directory,        "jekyll-admin/directory"
+  autoload :FileHelper,       "jekyll-admin/file_helper"
+  autoload :PageWithoutAFile, "jekyll-admin/page_without_a_file"
+  autoload :PathHelper,       "jekyll-admin/path_helper"
+  autoload :Server,           "jekyll-admin/server"
+  autoload :StaticServer,     "jekyll-admin/static_server"
+  autoload :URLable,          "jekyll-admin/urlable"
+  autoload :Version,          "jekyll-admin/version"
+
   def self.site
     @site ||= begin
       site = Jekyll.sites.first
@@ -47,3 +36,12 @@ def self.site
     end
   end
 end
+
+# Monkey Patches
+require_relative "./jekyll/commands/serve"
+require_relative "./jekyll/commands/build"
+
+[Jekyll::Page, Jekyll::Document, Jekyll::StaticFile, Jekyll::Collection].each do |klass|
+  klass.include JekyllAdmin::APIable
+  klass.include JekyllAdmin::URLable
+end

lib/jekyll-admin/apiable.rb

@@ -40,6 +40,7 @@ def to_api(include_content: false)
       # array with each rendered document, which we don't want.
       if is_a?(Jekyll::Collection)
         output.delete("docs")
+        output["entries_url"] = entries_url
       end
 
       if is_a?(Jekyll::Document)

lib/jekyll-admin/data_file.rb

@@ -5,6 +5,10 @@ class DataFile
 
     include APIable
     include URLable
+    include PathHelper
+    extend PathHelper
+
+    alias_method :path, :relative_path
 
     # Initialize a new DataFile object
     #
@@ -17,17 +21,6 @@ def exists?
       @exists ||= File.exist?(absolute_path)
     end
 
-    def absolute_path
-      @absolute_path ||= Jekyll.sanitized_path(JekyllAdmin.site.source, relative_path)
-    end
-    alias_method :file_path, :absolute_path
-
-    # Returns the relative path relative to site source
-    def relative_path
-      @relative_path = File.join(DataFile.data_dir, basename_with_extension)
-    end
-    alias_method :path, :relative_path
-
     # Returns unparsed content as it exists on disk
     def raw_content
       @raw_content ||= File.open(absolute_path, "r:UTF-8", &:read)
@@ -65,10 +58,9 @@ def to_liquid
     end
 
     def self.all
-      data_dir = Jekyll.sanitized_path(JekyllAdmin.site.source, DataFile.data_dir)
-      data_dir = Pathname.new(data_dir)
+      data_dir = sanitized_path DataFile.data_dir
       Dir["#{data_dir}/*.{#{EXTENSIONS.join(",")}}"].map do |path|
-        new(Pathname.new(path).relative_path_from(data_dir).to_s)
+        new path_without_site_source(path)
       end
     end
 
@@ -90,5 +82,10 @@ def basename
     def basename_with_extension
       [basename, extension].join
     end
+    alias_method :filename, :basename_with_extension
+
+    def namespace
+      "data"
+    end
   end
 end

lib/jekyll-admin/file_helper.rb

@@ -0,0 +1,64 @@
+module JekyllAdmin
+  module FileHelper
+
+    # The file the user requested in the URL
+    def requested_file
+      find_by_path(path)
+    end
+
+    # The file ultimately written to disk
+    # This may be the requested file, or in the case of a rename will be read
+    # from the new path that was actually written to disk
+    def written_file
+      find_by_path(write_path)
+    end
+
+    # Write a file to disk with the given content
+    def write_file(path, content)
+      Jekyll.logger.debug "WRITING:", path
+      path = sanitized_path(path)
+      FileUtils.mkdir_p File.dirname(path)
+      File.write(path, content)
+      site.process
+    end
+
+    # Delete the file at the given path
+    def delete_file(path)
+      Jekyll.logger.debug "DELETING:", path
+      FileUtils.rm_f sanitized_path(path)
+      site.process
+    end
+
+    private
+
+    def ensure_requested_file
+      ensure_file(requested_file)
+    end
+
+    def ensure_written_file
+      ensure_file(written_file)
+    end
+
+    def find_by_path(path)
+      files = case namespace
+              when "collections"
+                collection.docs
+              when "data"
+                DataFile.all
+              when "pages", "static_files"
+                site.public_send(namespace.to_sym)
+              else
+                []
+              end
+      files.find { |f| sanitized_path(f.path) == path }
+    end
+
+    def ensure_file(file)
+      render_404 if file.nil?
+    end
+
+    def ensure_directory
+      render_404 unless Dir.exist?(directory_path)
+    end
+  end
+end