jekyll-admin 0.8.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e3a603092f343692bb2fcd0c1dab8a04da0603daba3eb86ed4a10f44b29c28b
-  data.tar.gz: 173733135b068e422b498a52a5ba70a6fe7070a07584ead7d9985d01f9aca73a
+  metadata.gz: dd575c1a5e2646679878544936041b41705f451b3a9cb38d71272bc3518c5be4
+  data.tar.gz: 122cd2307dfd1e3cdd2587da707bae510d9744cdc4453f5eaa24f4e9dd72d290
 SHA512:
-  metadata.gz: 75d237355890639a3003b2f7397ed3c4c3386e1a02592eedd0ea89e6066d226bc92c91a27a18c6ebebb491e6a588546f82e3de72860f528c3a57a7771c7c741d
-  data.tar.gz: 4ed0303b0055911ae268634a3559a38cbe988959dc9405f1be91150065e519e1ea61d6e175b07dd550e496544247e618662a3f263920b2df5533514042ea617a
+  metadata.gz: b022a7157b17c8e42f6ecdaa3edcdb162242eb7a000f54f5e1d595ec30d4ea75d41df3eb6e9d3765b370cdc33ab97538ac95f6b31af89fc84fa34bf63337e8b8
+  data.tar.gz: 8bbadf4964bb2ab703863d04c5a0c9cf7b9c650bf009a9368435da84750a74aafe1b85ca2634dffb1ce5dc9905a68d610a90b72df4ad589b5c82240861806f2d

data/README.md

@@ -1,8 +1,9 @@
 [![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)
+[![Build status](https://ci.appveyor.com/api/projects/status/u6u9tn7rk5tln33s/branch/master?svg=true)](https://ci.appveyor.com/project/jekyll/jekyll-admin)
 [![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)
+[![Financial Contributors on Open Collective](https://opencollective.com/jekyll-admin/all/badge.svg?label=financial+contributors)](https://opencollective.com/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.
 
@@ -10,7 +11,7 @@ A Jekyll plugin that provides users with a traditional CMS-style graphical inter
 
 ## 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:
+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:
 
@@ -27,9 +28,7 @@ Refer to the [installing plugins](https://jekyllrb.com/docs/plugins/#installing-
 
 ## 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;
+Jekyll Admin related options can be specified in `_config.yml` under a key called `jekyll_admin`.
 
 ```yaml
 jekyll_admin:
@@ -39,12 +38,56 @@ jekyll_admin:
     - staticfiles
     - datafiles
     - configuration
+  homepage: "pages"
+```
+
+### Customizing collection label in Sidebar
+
+The plugin allows you to customize the name of a collection that is displayed in the sidebar by defining it in the collection's
+metadata in the config file. For example, if your source's *posts* are actually *news-items* on the deployed site, then it can
+be distracting to see the label `Posts` in the admin's sidebar. This situation can be resolved with the following configuration:
+
+```yaml
+collections:
+  posts:
+    output: true
+    sidebar_label: News
 ```
 
 ## 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.
+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.
+
+## Contributors
+
+### Code Contributors
+
+This project exists thanks to all the people who contribute. [[Contribute](.github/CONTRIBUTING.md)].
+<a href="https://github.com/jekyll/jekyll-admin/graphs/contributors"><img src="https://opencollective.com/jekyll-admin/contributors.svg?width=890&button=false" /></a>
+
+### Financial Contributors
+
+Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/jekyll-admin/contribute)]
+
+#### Individuals
+
+<a href="https://opencollective.com/jekyll-admin"><img src="https://opencollective.com/jekyll-admin/individuals.svg?width=890"></a>
+
+#### Organizations
+
+Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/jekyll-admin/contribute)]
+
+<a href="https://opencollective.com/jekyll-admin/organization/0/website"><img src="https://opencollective.com/jekyll-admin/organization/0/avatar.svg"></a>
+<a href="https://opencollective.com/jekyll-admin/organization/1/website"><img src="https://opencollective.com/jekyll-admin/organization/1/avatar.svg"></a>
+<a href="https://opencollective.com/jekyll-admin/organization/2/website"><img src="https://opencollective.com/jekyll-admin/organization/2/avatar.svg"></a>
+<a href="https://opencollective.com/jekyll-admin/organization/3/website"><img src="https://opencollective.com/jekyll-admin/organization/3/avatar.svg"></a>
+<a href="https://opencollective.com/jekyll-admin/organization/4/website"><img src="https://opencollective.com/jekyll-admin/organization/4/avatar.svg"></a>
+<a href="https://opencollective.com/jekyll-admin/organization/5/website"><img src="https://opencollective.com/jekyll-admin/organization/5/avatar.svg"></a>
+<a href="https://opencollective.com/jekyll-admin/organization/6/website"><img src="https://opencollective.com/jekyll-admin/organization/6/avatar.svg"></a>
+<a href="https://opencollective.com/jekyll-admin/organization/7/website"><img src="https://opencollective.com/jekyll-admin/organization/7/avatar.svg"></a>
+<a href="https://opencollective.com/jekyll-admin/organization/8/website"><img src="https://opencollective.com/jekyll-admin/organization/8/avatar.svg"></a>
+<a href="https://opencollective.com/jekyll-admin/organization/9/website"><img src="https://opencollective.com/jekyll-admin/organization/9/avatar.svg"></a>
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+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,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -17,16 +19,15 @@ 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"
+  autoload :APIable,      "jekyll-admin/apiable"
+  autoload :DataFile,     "jekyll-admin/data_file"
+  autoload :Directory,    "jekyll-admin/directory"
+  autoload :FileHelper,   "jekyll-admin/file_helper"
+  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
@@ -37,10 +38,10 @@ module JekyllAdmin
   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
+
+# Monkey Patches
+require_relative "jekyll/commands/serve"

data/lib/jekyll-admin/apiable.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 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
+    API_SCAFFOLD   = %w(name path relative_path).map { |i| [i, nil] }.to_h.freeze
 
     # Returns a hash suitable for use as an API response.
     #
@@ -19,15 +21,13 @@ module JekyllAdmin
     # 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)
+      output = API_SCAFFOLD.merge hash_for_api
 
       # Include content, if requested, otherwise remove it
       if include_content
-        output = output.merge(content_fields)
+        output.merge!(content_fields)
       else
         CONTENT_FIELDS.each { |field| output.delete(field) }
       end
@@ -36,26 +36,73 @@ module JekyllAdmin
       # Since it's an API, use `content` in both for consistency
       output.delete("output")
 
+      output["name"] = basename if is_a?(Jekyll::Document)
+      output["from_theme"] = from_theme_gem? if is_a?(Jekyll::StaticFile)
+      output["relative_path"] = relative_path_for_api
+
       # 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["name"] = label
+        output["path"] = relative_directory
         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.merge!(url_fields)
+      output
+    end
 
-      if is_a?(Jekyll::StaticFile)
-        output["from_theme"] = from_theme_gem?
+    private
+
+    # Relative path of files and directories with their *special directories*
+    # and any leading slashes stripped away.
+    #
+    # Examples:
+    #        `_drafts/foo/draft-post.md` => `foo/draft-post.md`
+    #   `_posts/foo/2019-10-18-hello.md` => `foo/2019-10-18-hello.md`
+    #             `/assets/img/logo.png` => `assets/img/logo.png`
+    def relative_path_for_api
+      return unless respond_to?(:relative_path) && relative_path
+
+      @relative_path_for_api ||= begin
+        rel_path = relative_path.dup
+        strip_leading_slash!(rel_path)
+        strip_leading_special_directory!(rel_path)
+        strip_leading_slash!(rel_path)
+
+        rel_path
       end
+    end
 
-      output
+    # Prefer substituting substrings instead of using a regex in order to avoid multiple
+    # regex allocations. String literals are frozen and reused.
+
+    def strip_leading_slash!(path)
+      return unless path.start_with?("/")
+
+      path.sub!("/", "")
     end
 
-    private
+    def strip_leading_special_directory!(path)
+      return unless special_directory && path.start_with?(special_directory)
+
+      path.sub!(special_directory, "")
+    end
+
+    def special_directory
+      return @special_directory if defined?(@special_directory)
+
+      @special_directory = begin
+        if is_a?(Jekyll::Document) && draft?
+          "_drafts"
+        elsif is_a?(Jekyll::Document)
+          collection.relative_directory
+        elsif is_a?(Jekyll::Collection)
+          relative_directory
+        end
+      end
+    end
 
     # Pages don't have a hash method, but Documents do
     def file_path
@@ -80,15 +127,26 @@ module JekyllAdmin
     end
 
     def file_contents
-      @file_contents ||= File.read(file_path, file_read_options) if file_exists?
+      @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_defaults
+      return unless file_exists?
+
+      @front_matter_defaults ||= begin
+        return {} unless respond_to?(:relative_path) && respond_to?(:type)
+
+        site.frontmatter_defaults.all(relative_path, type)
+      end
+    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
@@ -98,6 +156,7 @@ module JekyllAdmin
 
     def raw_content
       return unless file_exists?
+
       @raw_content ||= if file_contents =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
                          $POSTMATCH
                        else
@@ -111,6 +170,7 @@ module JekyllAdmin
 
     def file_exists?
       return @file_exists if defined? @file_exists
+
       @file_exists = File.exist?(file_path)
     end
 
@@ -137,6 +197,7 @@ module JekyllAdmin
       else
         output["raw_content"] = raw_content
         output["front_matter"] = front_matter
+        output["front_matter_defaults"] = front_matter_defaults
       end
 
       # Include next and previous documents non-recursively
@@ -153,6 +214,7 @@ module JekyllAdmin
 
     def url_fields
       return {} unless respond_to?(:http_url) && respond_to?(:api_url)
+
       {
         "http_url" => http_url,
         "api_url"  => api_url,

data/lib/jekyll-admin/data_file.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module JekyllAdmin
   class DataFile
-    METHODS_FOR_LIQUID = %w(path relative_path slug ext title).freeze
+    METHODS_FOR_LIQUID = %w(name path relative_path slug ext title).freeze
     EXTENSIONS = %w(yaml yml json csv).freeze
 
     include APIable
@@ -8,16 +10,26 @@ module JekyllAdmin
     include PathHelper
     extend PathHelper
 
-    attr_reader :id
+    attr_reader :id, :ext
 
     # Initialize a new DataFile object
     #
     # id - the file ID as passed from the API. This may or may not have an extension
     def initialize(id)
-      @id ||= File.extname(id).empty? ? "#{id}.yml" : id
+      extname = File.extname(id)
+      if extname.empty?
+        @id  = "#{id}.yml"
+        @ext = ".yml"
+      else
+        @id  = id
+        @ext = extname
+      end
     end
     alias_method :relative_path, :id
 
+    # Returns the file's extension with preceeding `.`
+    alias_method :extension, :ext
+
     def exists?
       @exists ||= File.exist?(absolute_path)
     end
@@ -32,16 +44,6 @@ module JekyllAdmin
       @content ||= data_reader.read_data_file(absolute_path)
     end
 
-    # Returns the file's extension with preceeding `.`
-    def ext
-      @ext ||= if File.extname(id).to_s.empty?
-                 ".yml"
-               else
-                 File.extname(id)
-               end
-    end
-    alias_method :extension, :ext
-
     # Returns the file's sanitized slug (as used in `site.data[slug]`)
     def slug
       @slug ||= data_reader.sanitize_filename(basename)
@@ -54,7 +56,7 @@ module JekyllAdmin
 
     # Returns path relative to site source
     def path
-      ensure_leading_slash(File.join(DataFile.data_dir, relative_path))
+      @path ||= File.join(DataFile.data_dir, relative_path)
     end
 
     def absolute_path
@@ -92,9 +94,10 @@ module JekyllAdmin
     end
 
     def basename_with_extension
-      [basename, extension].join
+      "#{basename}#{extension}"
     end
-    alias_method :filename, :basename_with_extension
+    alias_method :name, :basename_with_extension
+    public :name
 
     def namespace
       "data"

data/lib/jekyll-admin/directory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllAdmin
   class Directory
     extend Forwardable
@@ -9,45 +11,41 @@ module JekyllAdmin
     include JekyllAdmin::URLable
     include JekyllAdmin::APIable
 
-    TYPE = :directory
+    RESOURCE_TYPES  = %w(pages data drafts static_files).freeze
+    DOT_DIRECTORIES = [".", ".."].freeze
 
-    # Arguments:
-    #
-    # path - full path of the directory which its entries will be listed
-    #
-    # base - passes site.source to generate `relative_path` needed for `to_api`
-    #
-    # content_type - type of the requested directory entries, this is used to generate
-    # API endpoint of the directory along with `splat`
+    private_constant :RESOURCE_TYPES, :DOT_DIRECTORIES
+
+    # Parameters:
+    #   path - The full path of the directory at which its entries will be listed.
     #
-    # splat - the requested directory path relative to content namespace
-    def initialize(path, base: nil, content_type: nil, splat: nil)
-      @base = Pathname.new base
-      @content_type = content_type
+    # Named parameters:
+    #           base: - The full path to the directory from source.
+    #          splat: - The requested directory path relative to content namespace.
+    #   content_type: - The type of the requested directory entries. Corresponds to
+    #                   the resources' API namespace.
+    def initialize(path, base:, splat:, content_type:)
+      @path  = Pathname.new path
+      @base  = Pathname.new base
       @splat = Pathname.new splat
-      @path = Pathname.new path
+      @content_type = content_type
     end
 
     def to_liquid
       {
-        :name          => name,
-        :modified_time => modified_time,
-        :path          => relative_path,
-        :type          => TYPE,
+        "name"          => name,
+        "modified_time" => modified_time,
+        "path"          => relative_path,
+        "type"          => "directory",
       }
     end
 
     def relative_path
-      if content_type == "drafts"
-        path.relative_path_from(base).to_s.sub("_drafts/", "")
-      else
-        path.relative_path_from(base).to_s
-      end
+      @relative_path ||= path.relative_path_from(base).to_s
     end
 
     def resource_path
-      types = %w(pages data drafts)
-      if types.include?(content_type)
+      if RESOURCE_TYPES.include?(content_type)
         "/#{content_type}/#{splat}/#{name}"
       else
         "/collections/#{content_type}/entries/#{splat}/#{name}"
@@ -61,8 +59,9 @@ module JekyllAdmin
 
     def directories
       path.entries.map do |entry|
-        next if [".", ".."].include? entry.to_s
+        next if DOT_DIRECTORIES.include? entry.to_s
         next unless path.join(entry).directory?
+
         self.class.new(
           path.join(entry),
           :base => base, :content_type => content_type, :splat => splat