bunto-admin 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a94550c2d097b53acd31b350a63b6c4e69e6170
+  data.tar.gz: 96293e84a9555a6b0a923f057b2f834c39b3db86
+SHA512:
+  metadata.gz: 53241eb2316aa7151ddb272954e95cbb8a4a98547241b306aff1bebca1f905a593a61370fd894496ce472508903af5e204e63abbf57b70ac351d9a720d748d16
+  data.tar.gz: 43e085fd123baa45bad5e0ce5dc8e155d372501972dd87dc1e676dd6ccf70bcec13e7e1698db48edc507d32c811d03af3c08437939bed2c1b1f90a959ab72832

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2017-present Mert Kahyaoğlu and the Bunto/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

@@ -0,0 +1,52 @@
+[![Gem Version](https://img.shields.io/gem/v/bunto-admin.svg)](https://rubygems.org/gems/bunto-admin)
+[![Build Status](https://travis-ci.org/bunto/bunto-admin.svg?branch=master)](https://travis-ci.org/bunto/bunto-admin)
+[![Build status](https://ci.appveyor.com/api/projects/status/ciih4n6v0yfa5pvm/branch/master?svg=true)](https://ci.appveyor.com/project/SuriyaaKudoIsc/bunto-admin/branch/master)
+[![Coverage Status](https://coveralls.io/repos/github/bunto/bunto-admin/badge.svg?branch=master)](https://coveralls.io/github/bunto/bunto-admin?branch=master)
+[![NPM Dependencies](https://david-dm.org/bunto/bunto-admin.svg)](https://david-dm.org/bunto/bunto-admin)
+
+A Bunto plugin that provides users with a traditional CMS-style graphical interface to author content and administer Bunto sites. The project is divided into two parts. A Ruby-based HTTP API that handles Bunto and filesystem operations, and a Javascript-based front end, built on that API.
+
+## Installation
+
+Refer to the [installing plugins](https://buntowaf.tk/docs/plugins/#installing-a-plugin) section of Bunto's documentation and install the `bunto-admin` plugin as you would any other plugin. Here's the short version:
+
+1. Add the following to your site's Gemfile:
+
+    ```ruby
+    gem 'bunto-admin', group: :bunto_plugins
+    ```
+
+2. Run `bundle install`
+
+## Usage
+
+1. Start Bunto as you would normally (`bundle exec bunto serve`)
+2. Navigate to `http://localhost:4000/admin` to access the administrative interface
+
+## Options
+
+Bunto Admin related options can be specified in `_config.yml`
+under a key called `bunto_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
+bunto_admin:
+  hidden_links:
+    - posts
+    - pages
+    - staticfiles
+    - datafiles
+    - configuration
+```
+
+## Contributing
+
+Interested in contributing to Bunto Admin? We’d love your help. Bunto 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://bunto.github.io/bunto-admin/development/) for more information.
+
+## Looking for a hosted version?
+
+Bunto Admin is intended to be run on your computer alongside your local Bunto installation. If you're looking for a hosted version, we'd recommend checking out [Siteleaf](https://www.siteleaf.com/) a hosted Bunto editor with deep GitHub integration (whom we'd also like to thank for inspiring parts of Bunto Admin itself!).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/bunto-admin.rb

@@ -0,0 +1,47 @@
+# 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 "bunto"
+require "base64"
+require "webrick"
+require "sinatra"
+require "fileutils"
+require "sinatra/base"
+require "sinatra/json"
+require "addressable/uri"
+require "sinatra/reloader"
+require "sinatra/namespace"
+
+module BuntoAdmin
+  autoload :APIable,          "bunto-admin/apiable"
+  autoload :DataFile,         "bunto-admin/data_file"
+  autoload :Directory,        "bunto-admin/directory"
+  autoload :FileHelper,       "bunto-admin/file_helper"
+  autoload :PageWithoutAFile, "bunto-admin/page_without_a_file"
+  autoload :PathHelper,       "bunto-admin/path_helper"
+  autoload :Server,           "bunto-admin/server"
+  autoload :StaticServer,     "bunto-admin/static_server"
+  autoload :URLable,          "bunto-admin/urlable"
+  autoload :Version,          "bunto-admin/version"
+
+  def self.site
+    @site ||= begin
+      site = Bunto.sites.first
+      site.future = true
+      site
+    end
+  end
+end
+
+# Monkey Patches
+require_relative "./bunto/commands/serve"
+require_relative "./bunto/commands/build"
+
+[Bunto::Page, Bunto::Document, Bunto::StaticFile, Bunto::Collection].each do |klass|
+  klass.include BuntoAdmin::APIable
+  klass.include BuntoAdmin::URLable
+end

data/lib/bunto-admin/apiable.rb

@@ -0,0 +1,161 @@
+module BuntoAdmin
+  # 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?(Bunto::Collection)
+        output.delete("docs")
+        output["entries_url"] = entries_url
+      end
+
+      if is_a?(Bunto::Document)
+        output["name"] = basename
+      end
+
+      if is_a?(Bunto::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?(Bunto::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
+      Bunto::Utils.merged_file_read_opts(site, {})
+    end
+
+    def front_matter
+      return unless file_exists?
+      @front_matter ||= if file_contents =~ Bunto::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 =~ Bunto::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?(Bunto::StaticFile)
+        output["encoded_content"] = encoded_content
+      elsif is_a?(BuntoAdmin::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?(Bunto::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

data/lib/bunto-admin/data_file.rb

@@ -0,0 +1,106 @@
+module BuntoAdmin
+  class DataFile
+    METHODS_FOR_LIQUID = %w(path relative_path slug ext title).freeze
+    EXTENSIONS = %w(yaml yml json csv).freeze
+
+    include APIable
+    include URLable
+    include PathHelper
+    extend PathHelper
+
+    attr_reader :id
+
+    # 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
+    end
+    alias_method :path, :id
+
+    def exists?
+      @exists ||= File.exist?(absolute_path)
+    end
+
+    # Returns unparsed content as it exists on disk
+    def raw_content
+      @raw_content ||= File.open(absolute_path, "r:UTF-8", &:read)
+    end
+
+    # Returnes (re)parsed content using Bunto's native parsing mechanism
+    def content
+      @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)
+    end
+
+    # Returns the human-readable title of the data file
+    def title
+      @title ||= Bunto::Utils.titleize_slug(slug.tr("_", "-"))
+    end
+
+    # Return path relative to configured `data_dir`
+    def relative_path
+      id.sub("/#{DataFile.data_dir}/", "")
+    end
+
+    # Return the absolute path to given data file
+    def absolute_path
+      sanitized_path id
+    end
+
+    # Mimics Bunto's native to_liquid functionality by returning a hash
+    # of data file metadata
+    def to_liquid
+      @to_liquid ||= METHODS_FOR_LIQUID.map { |key| [key, public_send(key)] }.to_h
+    end
+
+    def self.all
+      data_dir = sanitized_path DataFile.data_dir
+      files = Dir["#{data_dir}/**/*.{#{EXTENSIONS.join(",")}}"].reject do |d|
+        File.directory?(d)
+      end
+
+      files.map do |path|
+        new path_without_site_source(path)
+      end
+    end
+
+    # Relative path to data directory within site source
+    def self.data_dir
+      BuntoAdmin.site.config["data_dir"]
+    end
+
+    private
+
+    def data_reader
+      @data_reader = Bunto::DataReader.new(BuntoAdmin.site)
+    end
+
+    def basename
+      @basename ||= File.basename(id, ".*")
+    end
+
+    def basename_with_extension
+      [basename, extension].join
+    end
+    alias_method :filename, :basename_with_extension
+
+    def namespace
+      "data"
+    end
+  end
+end

data/lib/bunto-admin/directory.rb

@@ -0,0 +1,70 @@
+module BuntoAdmin
+  class Directory
+    extend Forwardable
+    def_delegator :@path, :basename, :name
+    def_delegator :@path, :mtime, :modified_time
+    attr_reader :path, :splat, :content_type, :base
+
+    include Enumerable
+    include BuntoAdmin::URLable
+    include BuntoAdmin::APIable
+
+    TYPE = :directory
+
+    # 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`
+    #
+    # 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
+      @splat = Pathname.new splat
+      @path = Pathname.new path
+    end
+
+    def to_liquid
+      {
+        :name          => name,
+        :modified_time => modified_time,
+        :path          => relative_path,
+        :type          => TYPE,
+      }
+    end
+
+    def relative_path
+      path.relative_path_from(base).to_s
+    end
+
+    def resource_path
+      if content_type == "pages"
+        "/pages/#{splat}/#{name}"
+      elsif content_type == "data"
+        "/data/#{splat}/#{name}/"
+      else
+        "/collections/#{content_type}/entries/#{splat}/#{name}"
+      end
+    end
+    alias_method :url, :resource_path
+
+    def http_url
+      nil
+    end
+
+    def directories
+      path.entries.map do |entry|
+        next if [".", ".."].include? entry.to_s
+        next unless path.join(entry).directory?
+        self.class.new(
+          path.join(entry),
+          :base => base, :content_type => content_type, :splat => splat
+        )
+      end.compact!
+    end
+  end
+end