scribo 1.0.38 → 1.0.40

data/app/javascript/scribo/controllers/upload_controller.js

@@ -0,0 +1,81 @@
+import { Controller } from "@hotwired/stimulus"
+
+/***
+ * Upload controller
+ *
+ * Uploads a file, when you drop a file.
+ */
+export default class extends Controller {
+
+  connect() {
+    const self = this;
+    if(!self.data.has('param-name')) {
+      console.warn(this.element, "has no data-upload-param attribute, uploads may not work")
+    };
+
+    self.element.addEventListener('dragover', function (evt) {
+      self.element.classList.add('dragging');
+      evt.preventDefault();
+    });
+
+    self.element.addEventListener('dragleave', function (evt) {
+      self.element.classList.remove('dragging');
+      evt.preventDefault();
+    });
+
+    self.element.addEventListener('dragenter', function (evt) {
+      self.element.classList.add('dragging');
+      evt.preventDefault();
+    });
+
+    self.element.addEventListener('drop', function (evt) {
+      if (evt.dataTransfer.files.length == 0) {
+        return;
+      }
+
+      self.element.classList.remove('dragging');
+      evt.preventDefault();
+      evt.cancelBubble = true;
+
+      let formData = new FormData();
+      if(self.data.has('extra-data')) {
+        for (let [key, value] of Object.entries(JSON.parse(self.data.get('extra-data')))) {
+          formData.append(key, value);
+        }
+      }
+
+      for (let i = 0; i < evt.dataTransfer.files.length; i++) {
+        formData.append(self.data.get('param-name'), evt.dataTransfer.files[i]);
+      }
+
+      self.element.classList.add('uploading');
+
+      fetch(self.data.get('url'), {
+        method: 'POST',
+        headers: {
+          'X-CSRF-Token': document.querySelector('meta[name=csrf-token]').content
+        },
+        body: formData
+      })
+      .then(self.handleErrors)
+      .then((response) => {
+        response.json().then(function (data) {
+          self.element.classList.remove('uploading');
+          let node = document.querySelector(data.selector);
+          if (node) {
+            node.innerHTML = data.html;
+          }
+        });
+      })
+      .catch(error => {
+        console.log(error);
+        self.element.classList.remove('uploading');
+      });
+    });
+  }
+
+  handleErrors(response) {
+    if (!response.ok) throw new Error(response.status);
+    return response;
+  }
+}

data/app/views/scribo/admin/sites/contents/_form.html.slim

@@ -1,17 +1,16 @@
-div style="position: absolute; width: 100%; height: 100%;"
+div id="content-editor-#{@content.id}" style="position: absolute; width: 100%; height: 100%;" data-controller="text-editor" data-text-editor-content-id=@content.id data-text-editor-height-value="100%" data-text-editor-mode=@content.content_type data-text-editor-save-url=admin_site_content_path(@site, @content)
   - if @content.kind == 'asset'
-      - if @content.media_type == 'image'
-        div id="content-editor-#{@content.id}" data-controller="image-editor" data-image-editor-content-id=@content.id data-image-editor-url=content_url(@content) data-image-editor-mime-type=@content.mime_type data-image-editor-save-url=admin_site_content_path(@site, @content) style="max-width: 100%;"
-      - if @content.media_type == 'font' || @content.mime_type == "application/vnd.ms-fontobject"
-        css:
+    - if @content.media_type == 'image'
+      div data-controller="image-editor" data-image-editor-content-id=@content.id data-image-editor-url=content_url(@content) data-image-editor-mime-type=@content.mime_type data-image-editor-save-url=admin_site_content_path(@site, @content) style="max-width: 100%;"
+    - if @content.media_type == 'font' || @content.mime_type == "application/vnd.ms-fontobject"
+      css:
           @font-face {
-            font-family: 'MyWebFont';
-            src: url(#{"#{content_path(@content)}"}); /* IE9 Compat Modes */
+              font-family: 'MyWebFont';
+              src: url(#{ "#{content_path(@content)}" }); /* IE9 Compat Modes */
           }
-        - for i in [10, 12, 14, 16, 18, 20, 22, 24]
-          div style="font-family: MyWebFont; font-size: #{i}px;"
-            | #{i} - THE QUICK BROWN FOX JUMPED OVER THE LAZY DOG. the quick brown fox jumped over the lazy dog.
+      - for i in [10, 12, 14, 16, 18, 20, 22, 24]
+        div style="font-family: MyWebFont; font-size: #{i}px;"
+          | #{i} - THE QUICK BROWN FOX JUMPED OVER THE LAZY DOG. the quick brown fox jumped over the lazy dog.
 
   - else
-    textarea id="content-editor-#{@content.id}" name='content[data_with_frontmatter]' data-controller="text-editor" data-text-editor-content-id=@content.id data-text-editor-target="textarea" data-text-editor-mode="#{@content.content_type}" data-text-editor-save-url=admin_site_content_path(@site, @content) style="display: block; height: 100%;"
-      = @content.data_with_frontmatter || 'Start typing here'
+    input type="hidden" name='content[data_with_frontmatter]' data-text-editor-target="input" value=(@content.data_with_frontmatter || 'Start typing here')

data/app/views/scribo/shared/_ide.html.slim

@@ -1,7 +1,7 @@
 .scribo-ide id="ide" data-controller='open-editors'
   .explorer-pane data-controller="tree-view upload" data-tree-view-update-url="#{move_admin_site_contents_path(@site)}" data-upload-url="#{upload_admin_site_contents_url(@site)}" data-upload-param-name="content[files][]"
     .tree-view
-        = render partial: 'scribo/shared/tree-view'
+      = render partial: 'scribo/shared/tree-view'
 
   .editors-pane
     .editors-tabs data-open-editors-target='tabs' data-action="click->open-editors#clickTabs"

data/app/views/scribo/shared/_tree-view.html.slim

@@ -9,9 +9,9 @@ div.section
 div.section
   span.title = @site.title
   .tools
-    i.fal.fa-file-plus data-action="click->tree-view#create" data-kind="text" data-url="#{admin_site_contents_url(@site)}" title=I18n.t('scribo.tools.new_file')
-    i.fal.fa-folder-plus data-action="click->tree-view#create" data-kind="folder" data-url="#{admin_site_contents_url(@site)}" title=I18n.t('scribo.tools.new_folder')
-    i.fal.fa-square-plus data-action="click->tree-view#collapseExpandAll" data-tree-view-target="collapseExpand" title=I18n.t('scribo.tools.collapse_all')
+    i.fas.fa-file-plus data-action="click->tree-view#create" data-kind="text" data-url="#{admin_site_contents_url(@site)}" title=I18n.t('scribo.tools.new_file')
+    i.fas.fa-folder-plus data-action="click->tree-view#create" data-kind="folder" data-url="#{admin_site_contents_url(@site)}" title=I18n.t('scribo.tools.new_folder')
+    i.fas.fa-square-plus data-action="click->tree-view#collapseExpandAll" data-tree-view-target="collapseExpand" title=I18n.t('scribo.tools.collapse_all')
 
   ul data-tree-view-target="contentItems" data-open-editors-target='contentItems'
     - @contents.each do |content|

data/bin/importmap

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative "../test/dummy/config/application"
+require "importmap/commands"

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/scribo/engine', __FILE__)
+APP_PATH = File.expand_path('../../test/dummy/config/application', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/cli/.gitignore

@@ -0,0 +1,2 @@
+lib/
+scribo

data/cli/scribo.cr

@@ -0,0 +1,103 @@
+require "compress/zip"
+require "admiral"
+require "yaml"
+require "http/client"
+
+class Scribo
+  def initialize
+  end
+
+  def zip_and_upload
+    if !config["endpoint"]? || config["api_key"]?
+      puts "Please configure an endpoint and api_key in your _config.yml:\n\n"
+      puts "cli:\n  endpoint: https://example.com/\n  api_key: someapikey"
+      exit
+    end
+
+    zip_file_name = "#{File.basename(Dir.current)}.zip"
+    tempfile = File.tempfile(zip_file_name)
+    File.open(tempfile.path, "w") do |file|
+      Compress::Zip::Writer.open(file) do |zip|
+
+        Dir.glob("**/*").each do |file_name|
+          next if File.directory?(file_name)
+          zip.add file_name, File.open(file_name)
+        end
+      end
+    end
+
+    io = IO::Memory.new
+    builder = HTTP::FormData::Builder.new(io, "aA47")
+    builder.file("files[]", File.open(tempfile.path), HTTP::FormData::FileMetadata.new(filename: zip_file_name))
+    builder.finish
+
+    response = HTTP::Client.post(import_url, headers: HTTP::Headers{"User-Agent" => "Scribo"}, body: io.to_s)
+
+    tempfile.delete
+  end
+
+  def init_example(name)
+    if Dir.exists?(name)
+      puts "A folder #{name} already exists, move this out of the way first."
+      exit
+    end
+
+    Dir.mkdir_p("#{name}/assets/images")
+    Dir.mkdir_p("#{name}/assets/fonts")
+    Dir.mkdir_p("#{name}/assets/style")
+    Dir.mkdir_p("#{name}/_layouts")
+    File.open("#{name}/_config.yml", "w") do |file|
+      file.puts "# General configuration\ntitle: #{name}\nbaseurl: /#{name}\n\n# Scribo command line utility related\n\ncli:\n  endpoint: https://example.com/scribo\n  api_key: someapikey"
+    end
+    File.open("#{name}/index.md", "w") do |file|
+      file.puts "---\nlayout: default\n---\n# Welcome to #{name}\nYou can find the contents of this page in index.md"
+    end
+    File.open("#{name}/_layouts/default.html", "w") do |file|
+      file.puts %(<!DOCTYPE html>\n<html>\n<head>\n  <title></title>\n  <meta name="viewport" content="width=device-width, initial-scale=1">\n<body>\n  {{content}}\n</body>\n</html>)
+    end
+  end
+
+  # private
+
+  def config
+    config = YAML.parse(File.read("_config.yml"))
+    config = config["cli"]
+  end
+
+  def import_url
+    "#{config["endpoint"]}/api/sites/import"
+  end
+end
+
+class ScriboCommand < Admiral::Command
+  define_help description: "Scribo command line utility"
+
+  class PublishCommand < Admiral::Command
+    def run
+      Scribo.new.zip_and_upload
+    end
+  end
+
+  class InitCommand < Admiral::Command
+    define_help description: "Initializes a new site"
+    define_argument name, required: true
+
+    def run
+      Scribo.new.init_example(arguments.name)
+    end
+  end
+
+  register_sub_command publish : PublishCommand, description: "Uploads the current site"
+  register_sub_command init : InitCommand, description: "Creates a new site"
+
+  def run
+    puts help
+
+    if !File.exists?("_config.yml")
+      puts "\nNo _config.yml found, are you in the correct folder?"
+      exit
+    end
+  end
+end
+
+ScriboCommand.run

data/cli/shard.lock

@@ -0,0 +1,6 @@
+version: 2.0
+shards:
+  admiral:
+    git: https://github.com/jwaldrip/admiral.cr.git
+    version: 1.11.2
+

data/cli/shard.yml

@@ -0,0 +1,18 @@
+name: cli
+version: 0.1.0
+
+authors:
+  - Tom de Grunt <tom@degrunt.nl>
+
+description: |
+  Scribo CLI utility
+
+dependencies:
+  admiral:
+    github: jwaldrip/admiral.cr
+
+# development_dependencies:
+#   webmock:
+#     github: manastech/webmock.cr
+
+license: MIT

data/config/importmap.rb

@@ -0,0 +1,8 @@
+pin "@hotwired/stimulus", to: "@hotwired--stimulus.js" # @3.2.2
+pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true
+pin "painterro" # @1.2.87
+pin "sortablejs" # @1.15.2
+
+pin "scribo", to: "scribo/application.js", preload: false
+
+pin_all_from Scribo::Engine.root.join("app/javascript/scribo/controllers"), under: "scribo/controllers", to: "scribo/controllers", preload: false

data/docs/content.md

@@ -0,0 +1,33 @@
+# Content
+
+To keep the CMS easy to use and not have to much impact on your existing database,
+all content is kept in one model: `Content`.
+The field 'kind' is used to make a distinction between text-based content (text) and binary content (assets).
+
+## Content
+Text based content (kind: text) is meant for things like:
+- Text (text/plain)
+- HTML (text/html)
+- JavaScript
+- Stylesheets
+- JSON
+- XML
+
+Text based content is always going through the liquid templating processor.
+
+### Path
+
+All content has a path, and is directly available through a url or path. You can also make it not directly available by using an underscore in the path.
+
+## Assets
+Binary content (kind: assets) is meant for things like:
+- Images
+- Audio
+- Video
+- Documents (Word, Excel, Powerpoint, PDF's)
+- Fonts
+- Others (fe zip)
+- Everything else
+
+Assets will always be served in the same way they are stored in the database.
+

data/docs/features.md

@@ -0,0 +1,71 @@
+# Features
+
+## Shared path per site
+
+All content within one site shares a path to be as similar to a regular site as possible.
+This means your index.html can refer to a /img/logo.png just like you normally would.
+
+## Nested layouts
+
+Your blog articles can have an article layout, but still use your site-layout:
+
+Say you have an article.html and some layouts:
+
+- article.html, layout: article_layout
+- article_layout, layout: application_layout
+- application_layout
+
+Scribo will render `article.html` in the `article_layout`, which will be rendered in the `application_layout`
+
+## Liquid templating
+
+All text-based content is rendered through [liquid](http://liquidmarkup.org)
+This means you can do powerful things with your pages, layouts but even stylesheets.
+
+To every content we render, we add the `content` local, this means you can access content information in the content we render:
+
+index.html:
+
+```html
+<html>
+  <head>
+    <title>{{content.title}}</title>
+    <meta name="title" content="{{content.title}}" />
+    <meta name="description" content="{{content.description}}" />
+    <meta name="keywords" content="{{content.keywords}}" />
+  </head>
+  <body>
+    <h1>Navigation</h1>
+    <ul>
+      {%for c in content.sites.contents%}
+      <li><a href="{{c.path}}">{{c.title}}</a></li>
+      {%endfor%}
+    </ul>
+  </body>
+</html>
+```
+
+### include
+
+Usage: {% include 'identifier' %}
+
+Will include the content from the identified content.
+
+Example:
+
+```
+{% include 'menu' %}
+```
+
+Will look for content with identifier 'menu' and include that.
+
+## Filters
+
+Because we use [Slim](http://slim-lang.com) and [Tilt](https://github.com/rtomayko/tilt), all text-based content can be run through additional filters like Markdown, Slim, Haml and Sass.
+
+If you add content and set filter to 'markdown', Scribo will render that content using markdown.
+
+## Nested content (not enabled)
+
+Content can have child content, this allows for blog-like structure (rendering is done by parent).
+Child content will inherit the path of the parent.

data/docs/ide.md

@@ -0,0 +1,17 @@
+# IDE
+The IDE provides you with two main areas, the explorer on the right and the code editor on the right.
+
+## Explorer
+The explorer shows all files and folders in the site. The explorer allows you to do the following:
+- add files or folders, by clicking the 'New file' of 'New folder' icon
+- rename files or folders, by double clicking on a file or folder name
+- reorder files or folders by dragging them.
+- add new files to your site by dragging files onto the tree
+
+## Code editor
+The code editor allows you to edit files. It provides syntax highlighting, allows you to collapse regions.
+The following shortcuts are available:
+
+- cmd-f / ctrl-f: Find
+- option-cmd-f / alt-ctrl-f: Replace
+

data/docs/import_export.md

@@ -0,0 +1,7 @@
+# Importing and exporting
+
+Scribo allows you to easily import and export sites,
+if you want to work with the content outside the web-based maintenance.
+
+Importing and exporting is done using zip files, which contains one zipped site.
+All content in the zip will be in a folder with the same base-name as the zip.

data/docs/liquid.md

@@ -0,0 +1,59 @@
+# Liquid
+
+Scribo uses liquid for all its template rendering, liquid is simple and safe.
+You can read more about liquid here: https://shopify.github.io/liquid/
+
+When you render a template, you can pass it assigns and registers.
+The difference is subtle: assigns are exposed to the template, while registers are exposed to Drops, Tags, and Filters.
+
+## Customizing
+
+### Filters
+Filters are methods which take one or more parameters and return a value.
+Filters can access the context and registers as in the below example: 
+
+```ruby
+module RenderFilter
+  def render(input)
+    template = Liquid::Template.parse(input)
+    template.render(@context, registers: @context.registers)
+  end
+end
+
+Liquid::Template.register_filter(RenderFilter)
+```
+
+### Tags
+
+"Tags" are tags that take any number of arguments, but do not contain a block of template code.
+
+```ruby
+# Renders content
+#
+# {% render variable%}
+class RenderTag < Liquid::Tag
+  def initialize(tag_name, markup, options)
+    super
+    @name = markup.strip
+  end
+
+  def render(context)
+    value = Liquid::VariableLookup.parse(@name).evaluate(context)
+    template = Liquid::Template.parse(value)
+    template.render(context, registers: context.registers)
+  end
+end
+
+Liquid::Template.register_tag('render', RenderTag)
+```
+
+### Block tags
+
+"Blocks" are tags that contain a block of template code which is delimited by a {% end<TAGNAME> %} tag.
+
+## Reference
+
+https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers
+https://github.com/Shopify/liquid/wiki/Liquid-for-Designers
+https://shopify.github.io/liquid/
+

data/lib/generators/scribo/install_generator.rb

@@ -0,0 +1,22 @@
+module Scribo
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_initializer_file
+      template "config/initializers/scribo.rb"
+    end
+
+    def add_route
+      return if Rails.application.routes.routes.detect { |route| route.app.app == Scribo::Engine }
+      route %(mount Scribo::Engine => "/scribo")
+    end
+
+    def copy_migrations
+      rake "scribo:install:migrations"
+    end
+
+    def tailwindcss_config
+      rake "scribo:tailwindcss:config"
+    end
+  end
+end

data/lib/generators/scribo/tailwind_config_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/base'
+
+module Scribo
+  module Generators
+    class TailwindConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+      desc 'Configures tailwind.config.js and application.tailwindcss.css'
+
+      def add_content_to_tailwind_config
+        inject_into_file "config/tailwind.config.js", before: "],\n  theme: {" do
+          "  // Scribo content\n" +
+            %w[/app/views/**/* /app/helpers/**/* /app/controllers/**/* /app/components/**/* /app/javascript/**/*.js /app/assets/**/*.css].map { |path| "    \"#{Scribo::Engine.root}#{path}\"" }.join(",\n") +
+            ",\n  "
+        end
+      end
+
+      def add_content_application_tailwind_css
+        inject_into_file "app/assets/stylesheets/application.tailwind.css", before: "@tailwind base;" do
+          "@import '#{Scribo::Engine.root}/app/assets/stylesheets/scribo/application.css';\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/scribo/templates/config/initializers/scribo.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+Scribo.setup do |config|
+  config.base_controller = "::UnauthenticatedController"
+  config.admin_authentication_module = "Auxilium::Concerns::AdminAuthenticated"
+
+  config.scribable_objects = lambda do
+    return [] unless Current.account
+
+    [Current.account]
+  end
+
+  config.scribable_for_request = lambda do |request|
+    Current.account
+  end
+end