jekyll-admin 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e3a603092f343692bb2fcd0c1dab8a04da0603daba3eb86ed4a10f44b29c28b
-  data.tar.gz: 173733135b068e422b498a52a5ba70a6fe7070a07584ead7d9985d01f9aca73a
+  metadata.gz: 23d2ff89a0eaf62c63c8b52e919ae8a347ec623c4f0db5a2810ca387d5aa92f0
+  data.tar.gz: 5ac8a35dfa123e685c61a75488e19c0106dd55b3984e60b6fd8ed083d87b67a7
 SHA512:
-  metadata.gz: 75d237355890639a3003b2f7397ed3c4c3386e1a02592eedd0ea89e6066d226bc92c91a27a18c6ebebb491e6a588546f82e3de72860f528c3a57a7771c7c741d
-  data.tar.gz: 4ed0303b0055911ae268634a3559a38cbe988959dc9405f1be91150065e519e1ea61d6e175b07dd550e496544247e618662a3f263920b2df5533514042ea617a
+  metadata.gz: 4527e5b2b8c03417a198784c2949f47f596e3d004982a6a603a0f007f16094559eab7815b2b916e3e93c4f62dd6289401a33eea218c60e3f6a303ee257a96ff1
+  data.tar.gz: d6770f35c386dfd341731e6ea27ba403d53c6b8d1afd9acbe8b2ce97917bb178598e32f21e8232ef566e3337126e23534ce755ebf8f78cfc2f532322e22ef2a3

data/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-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
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,50 +1,50 @@
-[![Gem Version](https://img.shields.io/gem/v/jekyll-admin.svg)](https://rubygems.org/gems/jekyll-admin)
-[![Build Status](https://travis-ci.org/jekyll/jekyll-admin.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-admin)
-[![Build status](https://ci.appveyor.com/api/projects/status/biop1r6ae524xlm2/branch/master?svg=true)](https://ci.appveyor.com/project/benbalter/jekyll-admin/branch/master)
-[![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.
-
-![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:
-
-    ```ruby
-    gem 'jekyll-admin', group: :jekyll_plugins
-    ```
-
-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
-
-## Options
-
-Jekyll Admin related options can be specified in `_config.yml`
-under a key called `jekyll_admin`. Currently it has only one option `hidden_links`
-which is 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
-```
-
-## Contributing
-
-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.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+[![Gem Version](https://img.shields.io/gem/v/jekyll-admin.svg)](https://rubygems.org/gems/jekyll-admin)
+[![Build Status](https://travis-ci.org/jekyll/jekyll-admin.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-admin)
+[![Build status](https://ci.appveyor.com/api/projects/status/biop1r6ae524xlm2/branch/master?svg=true)](https://ci.appveyor.com/project/benbalter/jekyll-admin/branch/master)
+[![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.
+
+![screenshot of Jekyll Admin](/screenshot.png)
+
+## Installation
+
+Refer to the [installing plugins](https://jekyllrb.com/docs/plugins/installation/) 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:
+
+    ```ruby
+    gem 'jekyll-admin', group: :jekyll_plugins
+    ```
+
+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
+
+## Options
+
+Jekyll Admin related options can be specified in `_config.yml`
+under a key called `jekyll_admin`. Currently it has only one option `hidden_links`
+which is 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
+```
+
+## Contributing
+
+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](https://jekyll.github.io/jekyll-admin/development/) for more information.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/jekyll-admin.rb

@@ -1,46 +1,46 @@
-# Default Sinatra to "production" mode (surpress errors) unless
-# otherwise specified by the `RACK_ENV` environmental variable.
-# Must be done prior to requiring Sinatra, or we'll get a LoadError
-# as it looks for sinatra/cross-origin, which is development only
-ENV["RACK_ENV"] = "production" if ENV["RACK_ENV"].to_s.empty?
-
-require "json"
-require "jekyll"
-require "base64"
-require "webrick"
-require "sinatra"
-require "fileutils"
-require "sinatra/base"
-require "sinatra/json"
-require "addressable/uri"
-require "sinatra/reloader"
-require "sinatra/namespace"
-
-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
-      site.future = true
-      site
-    end
-  end
-end
-
-# 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
+# Default Sinatra to "production" mode (surpress errors) unless
+# otherwise specified by the `RACK_ENV` environmental variable.
+# Must be done prior to requiring Sinatra, or we'll get a LoadError
+# as it looks for sinatra/cross-origin, which is development only
+ENV["RACK_ENV"] = "production" if ENV["RACK_ENV"].to_s.empty?
+
+require "json"
+require "jekyll"
+require "base64"
+require "webrick"
+require "sinatra"
+require "fileutils"
+require "sinatra/base"
+require "sinatra/json"
+require "addressable/uri"
+require "sinatra/reloader"
+require "sinatra/namespace"
+
+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
+      site.future = true
+      site
+    end
+  end
+end
+
+# 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

data/lib/jekyll-admin/apiable.rb

@@ -1,162 +1,163 @@
-module JekyllAdmin
-  # Abstract module to be included in Convertible and Document to provide
-  # additional, API-specific functionality without duplicating logic
-  module APIable
-
-    CONTENT_FIELDS = %w(next previous content excerpt).freeze
-
-    # Returns a hash suitable for use as an API response.
-    #
-    # For Documents and Pages:
-    #
-    # 1. Adds the file's raw content to the `raw_content` field
-    # 2. Adds the file's raw YAML front matter to the `front_matter` field
-    #
-    # For Static Files it addes the Base64 `encoded_content` field
-    #
-    # Options:
-    #
-    # include_content - if true, includes the content in the respond, false by default
-    #                   to support mapping on indexes where we only want metadata
-    #
-    #
-    # Returns a hash (which can then be to_json'd)
-    def to_api(include_content: false)
-      output = hash_for_api
-      output = output.merge(url_fields)
-
-      # Include content, if requested, otherwise remove it
-      if include_content
-        output = output.merge(content_fields)
-      else
-        CONTENT_FIELDS.each { |field| output.delete(field) }
-      end
-
-      # Documents have duplicate output and content fields, Pages do not
-      # Since it's an API, use `content` in both for consistency
-      output.delete("output")
-
-      # By default, calling to_liquid on a collection will return a docs
-      # 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)
-        output["relative_path"] = relative_path.sub("_drafts/", "") if draft?
-        output["name"] = basename
-      end
-
-      if is_a?(Jekyll::StaticFile)
-        output["from_theme"] = from_theme_gem?
-      end
-
-      output
-    end
-
-    private
-
-    # Pages don't have a hash method, but Documents do
-    def file_path
-      if is_a?(Jekyll::Document)
-        path
-      else
-        File.join(@base, @dir, name)
-      end
-    end
-
-    def from_theme_gem?
-      @base == site.in_theme_dir
-    end
-
-    # StaticFiles don't have `attr_accesor` set for @site or @name
-    def site
-      @site
-    end
-
-    def name
-      @name
-    end
-
-    def file_contents
-      @file_contents ||= File.read(file_path, file_read_options) if file_exists?
-    end
-
-    def file_read_options
-      Jekyll::Utils.merged_file_read_opts(site, {})
-    end
-
-    def front_matter
-      return unless file_exists?
-      @front_matter ||= if file_contents =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
-                          SafeYAML.load(Regexp.last_match(1))
-                        else
-                          {}
-                        end
-    end
-
-    def raw_content
-      return unless file_exists?
-      @raw_content ||= if file_contents =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
-                         $POSTMATCH
-                       else
-                         file_contents
-                       end
-    end
-
-    def encoded_content
-      @encoded_content ||= Base64.encode64(file_contents) if file_exists?
-    end
-
-    def file_exists?
-      return @file_exists if defined? @file_exists
-      @file_exists = File.exist?(file_path)
-    end
-
-    # Base hash from which to generate the API output
-    def hash_for_api
-      output = to_liquid
-      if output.respond_to?(:hash_for_json)
-        output.hash_for_json
-      else
-        output.to_h
-      end
-    end
-
-    # Returns a hash of content fields for inclusion in the API output
-    def content_fields
-      output = {}
-
-      # Include file content-related fields
-      if is_a?(Jekyll::StaticFile)
-        output["encoded_content"] = encoded_content
-      elsif is_a?(JekyllAdmin::DataFile)
-        output["content"] = content
-        output["raw_content"] = raw_content
-      else
-        output["raw_content"] = raw_content
-        output["front_matter"] = front_matter
-      end
-
-      # Include next and previous documents non-recursively
-      if is_a?(Jekyll::Document)
-        %w(next previous).each do |direction|
-          method = "#{direction}_doc".to_sym
-          doc = public_send(method)
-          output[direction] = doc.to_api if doc
-        end
-      end
-
-      output
-    end
-
-    def url_fields
-      return {} unless respond_to?(:http_url) && respond_to?(:api_url)
-      {
-        "http_url" => http_url,
-        "api_url"  => api_url,
-      }
-    end
-  end
-end
+module JekyllAdmin
+  # Abstract module to be included in Convertible and Document to provide
+  # additional, API-specific functionality without duplicating logic
+  module APIable
+    CONTENT_FIELDS = %w(next previous content excerpt).freeze
+
+    # Returns a hash suitable for use as an API response.
+    #
+    # For Documents and Pages:
+    #
+    # 1. Adds the file's raw content to the `raw_content` field
+    # 2. Adds the file's raw YAML front matter to the `front_matter` field
+    #
+    # For Static Files it addes the Base64 `encoded_content` field
+    #
+    # Options:
+    #
+    # include_content - if true, includes the content in the respond, false by default
+    #                   to support mapping on indexes where we only want metadata
+    #
+    #
+    # Returns a hash (which can then be to_json'd)
+    def to_api(include_content: false)
+      output = hash_for_api
+      output = output.merge(url_fields)
+
+      # Include content, if requested, otherwise remove it
+      if include_content
+        output = output.merge(content_fields)
+      else
+        CONTENT_FIELDS.each { |field| output.delete(field) }
+      end
+
+      # Documents have duplicate output and content fields, Pages do not
+      # Since it's an API, use `content` in both for consistency
+      output.delete("output")
+
+      # By default, calling to_liquid on a collection will return a docs
+      # 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)
+        output["relative_path"] = relative_path.sub("_drafts/", "") if draft?
+        output["name"] = basename
+      end
+
+      output["from_theme"] = from_theme_gem? if is_a?(Jekyll::StaticFile)
+
+      output
+    end
+
+    private
+
+    # Pages don't have a hash method, but Documents do
+    def file_path
+      if is_a?(Jekyll::Document)
+        path
+      else
+        File.join(@base, @dir, name)
+      end
+    end
+
+    def from_theme_gem?
+      @base == site.in_theme_dir
+    end
+
+    # StaticFiles don't have `attr_accesor` set for @site or @name
+    def site
+      @site
+    end
+
+    def name
+      @name
+    end
+
+    def file_contents
+      @file_contents ||= File.read(file_path, file_read_options) if file_exists?
+    end
+
+    def file_read_options
+      Jekyll::Utils.merged_file_read_opts(site, {})
+    end
+
+    def front_matter
+      return unless file_exists?
+
+      @front_matter ||= if file_contents =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
+                          SafeYAML.load(Regexp.last_match(1))
+                        else
+                          {}
+                        end
+    end
+
+    def raw_content
+      return unless file_exists?
+
+      @raw_content ||= if file_contents =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
+                         $POSTMATCH
+                       else
+                         file_contents
+                       end
+    end
+
+    def encoded_content
+      @encoded_content ||= Base64.encode64(file_contents) if file_exists?
+    end
+
+    def file_exists?
+      return @file_exists if defined? @file_exists
+
+      @file_exists = File.exist?(file_path)
+    end
+
+    # Base hash from which to generate the API output
+    def hash_for_api
+      output = to_liquid
+      if output.respond_to?(:hash_for_json)
+        output.hash_for_json
+      else
+        output.to_h
+      end
+    end
+
+    # Returns a hash of content fields for inclusion in the API output
+    def content_fields
+      output = {}
+
+      # Include file content-related fields
+      if is_a?(Jekyll::StaticFile)
+        output["encoded_content"] = encoded_content
+      elsif is_a?(JekyllAdmin::DataFile)
+        output["content"] = content
+        output["raw_content"] = raw_content
+      else
+        output["raw_content"] = raw_content
+        output["front_matter"] = front_matter
+      end
+
+      # Include next and previous documents non-recursively
+      if is_a?(Jekyll::Document)
+        %w(next previous).each do |direction|
+          method = "#{direction}_doc".to_sym
+          doc = public_send(method)
+          output[direction] = doc.to_api if doc
+        end
+      end
+
+      output
+    end
+
+    def url_fields
+      return {} unless respond_to?(:http_url) && respond_to?(:api_url)
+
+      {
+        "http_url" => http_url,
+        "api_url"  => api_url,
+      }
+    end
+  end
+end