scribo 1.0.39 → 1.0.40

data/Gemfile.lock

@@ -0,0 +1,397 @@
+GIT
+  remote: git@github.com:entdec/keypath-ruby.git
+  revision: c2ce9a5038c48504a113e26defecaf80f6c82bf2
+  branch: master
+  specs:
+    key_path (1.2.0)
+      activesupport (>= 4.0)
+
+PATH
+  remote: .
+  specs:
+    scribo (1.0.38)
+      ancestry
+      babel-transpiler (~> 0.7)
+      down (~> 5.2)
+      importmap-rails
+      kaminari
+      key_path
+      liquidum (~> 1)
+      mime-types
+      mimemagic
+      pg
+      rails (> 7)
+      rouge (~> 3)
+      rubyzip (> 1.1)
+      slim-rails (~> 3)
+      stimulus-rails
+      tailwindcss-rails
+      turbo-rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.3.2)
+      actionview (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      globalid (>= 0.3.6)
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      timeout (>= 0.4.0)
+    activestorage (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      marcel (~> 1.0)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ancestry (4.3.3)
+      activerecord (>= 5.2.6)
+    ansi (1.5.0)
+    ast (2.4.2)
+    auxilium (3.0.24)
+      actionpack (> 5.1)
+      activemodel (> 5.1)
+      activesupport (> 5.1)
+      pundit (> 2)
+      responders (> 3)
+      rolify (> 5)
+    babel-source (5.8.35)
+    babel-transpiler (0.7.0)
+      babel-source (>= 4.0, < 6)
+      execjs (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    builder (3.2.4)
+    byebug (11.1.3)
+    capybara (3.40.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.11)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    cuprite (0.15)
+      capybara (~> 3.0)
+      ferrum (~> 0.14.0)
+    date (3.3.4)
+    down (5.4.1)
+      addressable (~> 2.8)
+    drb (2.2.1)
+    erubi (1.12.0)
+    execjs (2.9.1)
+    ferrum (0.14)
+      addressable (~> 2.5)
+      concurrent-ruby (~> 1.1)
+      webrick (~> 1.7)
+      websocket-driver (>= 0.6, < 0.8)
+    ffi (1.16.3)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    importmap-rails (2.0.1)
+      actionpack (>= 6.0.0)
+      activesupport (>= 6.0.0)
+      railties (>= 6.0.0)
+    io-console (0.7.2)
+    irb (1.11.2)
+      rdoc
+      reline (>= 0.4.2)
+    jbuilder (2.11.5)
+      actionview (>= 5.0.0)
+      activesupport (>= 5.0.0)
+    json (2.7.1)
+    kaminari (1.2.2)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
+      actionview
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
+      activerecord
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
+    liquid (5.1.0)
+    liquidum (1.0.17)
+      addressable (~> 2)
+      babel-transpiler (~> 0.7)
+      i18n (~> 1.8)
+      kramdown (~> 2.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (= 5.1.0)
+      parslet
+      pg
+      rails (>= 5.2)
+      sassc (~> 2.2)
+      slim-rails (~> 3.2.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    matrix (0.4.2)
+    method_source (1.0.0)
+    mime-types (3.5.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2024.0206)
+    mimemagic (0.4.3)
+      nokogiri (~> 1)
+      rake
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
+    minitest (5.22.2)
+    minitest-reporters (1.6.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mutex_m (0.2.0)
+    net-imap (0.4.10)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0.1)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.16.2)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    parslet (2.0.0)
+    pg (1.5.6)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    pry-rails (0.3.9)
+      pry (>= 0.10.4)
+    psych (5.1.2)
+      stringio
+    public_suffix (5.0.4)
+    puma (6.4.2)
+      nio4r (~> 2.0)
+    pundit (2.3.1)
+      activesupport (>= 3.0.0)
+    racc (1.7.3)
+    rack (3.0.9.1)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.3.2)
+      actioncable (= 7.1.3.2)
+      actionmailbox (= 7.1.3.2)
+      actionmailer (= 7.1.3.2)
+      actionpack (= 7.1.3.2)
+      actiontext (= 7.1.3.2)
+      actionview (= 7.1.3.2)
+      activejob (= 7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activerecord (= 7.1.3.2)
+      activestorage (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      bundler (>= 1.15.0)
+      railties (= 7.1.3.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3.2)
+      actionpack (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.0)
+    reline (0.4.3)
+      io-console (~> 0.5)
+    responders (3.1.1)
+      actionpack (>= 5.2)
+      railties (>= 5.2)
+    rexml (3.2.6)
+    rolify (6.0.1)
+    rouge (3.30.0)
+    rubocop (1.61.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.1)
+      parser (>= 3.3.0.4)
+    ruby-progressbar (1.13.0)
+    rubyzip (2.3.2)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    selenium-webdriver (4.18.1)
+      base64 (~> 0.2)
+      rexml (~> 3.2, >= 3.2.5)
+      rubyzip (>= 1.2.2, < 3.0)
+      websocket (~> 1.0)
+    signum (0.3.12)
+      pg
+      rails (> 6.0)
+      state_machines-activemodel
+    slim (4.1.0)
+      temple (>= 0.7.6, < 0.9)
+      tilt (>= 2.0.6, < 2.1)
+    slim-rails (3.2.0)
+      actionpack (>= 3.1)
+      railties (>= 3.1)
+      slim (>= 3.0, < 5.0)
+    state_machines (0.6.0)
+    state_machines-activemodel (0.9.0)
+      activemodel (>= 6.0)
+      state_machines (>= 0.6.0)
+    stimulus-rails (1.3.3)
+      railties (>= 6.0.0)
+    stringio (3.1.0)
+    tailwindcss-rails (2.3.0)
+      railties (>= 6.0.0)
+    temple (0.8.2)
+    thor (1.3.1)
+    tilt (2.0.11)
+    timeout (0.4.1)
+    turbo-rails (2.0.4)
+      actionpack (>= 6.0.0)
+      activejob (>= 6.0.0)
+      railties (>= 6.0.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket (1.2.10)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.6.13)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  auxilium (~> 3.0)
+  capybara
+  cuprite
+  jbuilder
+  key_path!
+  minitest (~> 5.11)
+  minitest-reporters (~> 1.1)
+  pry
+  pry-byebug (~> 3)
+  pry-rails
+  puma
+  rubocop
+  scribo!
+  selenium-webdriver
+  signum
+
+BUNDLED WITH
+   2.1.4

data/TODO.md

@@ -0,0 +1,32 @@
+# TODO
+
+## General
+
+- Feature: Controller, view and path overrides
+  Allow users to override controllers and views (like devise), describe how this should be done.
+  This to enable admin pages with authentication, or regular content with authentication.
+  Or specific admin page requirements.
+
+## Site/Content
+
+- Front-matter defaults - https://jekyllrb.com/docs/configuration/front-matter-defaults/
+- Versioned content
+
+## Liquid
+
+- Local tags
+  Local tags (https://github.com/Shopify/liquid/pull/590) - a way to make tags only available for certain templates
+  ie include should not be available for messages.
+- Mail tag
+
+## Jekyll compatibility
+
+- Check filters from Jekyll: https://github.com/jekyll/jekyll/blob/c9b84e2b354067e61cf9878f27665c5c1c02481c/lib/jekyll/filters.rb
+
+## IDE
+
+- Allow for multiple tabs and open editors
+- Search for content
+- Use localstorage for changes to prevent loss
+- Allow export, preview from IDE
+- Allow to go back to sites index

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/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.
+