Add I18n interface for mustache templates

This commit adds an interface that allows mustache templates to get I18n
translation strings, transform any arguments that may be present in
them, and then render them on the frontend.

This is our first real step to getting internationalizing the Gollum
frontend.

.github/workflows/docker-deploy.yml

@@ -1,39 +0,0 @@
-name: Deploy docker
-on: [push]
-env:
-  DEPLOY_NAME: gollumwiki/gollum:latest
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    if: ${{ github.ref == 'refs/heads/master' }}
-    steps:
-      - name: Check Out Repo
-        uses: actions/checkout@v2
-      - name: Login
-        uses: docker/login-action@v1
-        with:
-          username: ${{ secrets.DOCKER_HUB_USERNAME }}
-          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v1
-      - name: Cache docker layers
-        uses: actions/cache@v2
-        with:
-          path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-buildx-
-      - name: Build and push
-        id: docker_build
-        uses: docker/build-push-action@v2
-        with:
-          context: ./
-          file: ./Dockerfile
-          builder: ${{ steps.buildx.outputs.name }}
-          push: true
-          tags: ${{ env.DEPLOY_NAME }}
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
-      - name: Image digest
-        run: echo ${{ steps.docker_build.outputs.digest }}

.github/workflows/docker-test.yml

@@ -1,38 +0,0 @@
-name: Build and Test Docker
-on: [push, pull_request]
-env:
-  CI_IMAGE: gollum-ci-img
-jobs:
-  build-and-test:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check Out Repo
-        uses: actions/checkout@v2
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@v1
-      - name: Cache docker layers
-        uses: actions/cache@v2
-        with:
-          path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-buildx-
-      - name: Build
-        id: docker_build
-        uses: docker/build-push-action@v2
-        with:
-          context: ./
-          file: ./Dockerfile
-          builder: ${{ steps.buildx.outputs.name }}
-          push: false
-          tags: ${{ env.CI_IMAGE }}
-          outputs: type=docker
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
-      - name: Image digest
-        run: echo ${{ steps.docker_build.outputs.digest }}
-      - name: docker state
-        run: docker image ls
-      - name: Run tests
-        run: docker run -e CI=true -w /app --entrypoint bundle ${{ env.CI_IMAGE }} exec rake

.github/workflows/release.yml

@@ -1,25 +0,0 @@
-on:
-  push:
-    # Sequence of patterns matched against refs/tags
-    tags:
-      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
-
-name: Create Release
-
-jobs:
-  build:
-    name: Create Release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Create Release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
-          draft: false
-          prerelease: false

.github/workflows/test.yaml

@@ -19,8 +19,8 @@ jobs:
           ls ${{ github.workspace }}
       - uses: actions/setup-java@v2
         with:
-          distribution: 'temurin'
-          java-version: '11'
+          distribution: 'adopt'
+          java-version: '9'
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 2.4.0
+  - 2.6.0
+  - 3.0.0
+  - jruby-9.2.18.0
+jdk:
+  - oraclejdk9
+before_install:
+ - sudo apt-get update
+ - sudo apt-get install libicu-dev

Dockerfile

@@ -1,29 +0,0 @@
-FROM ruby:2.7
-ENV DEBIAN_FRONTEND="noninteractive"
-
-RUN apt-get update && apt-get install -y \
-    libicu-dev \
-    cmake
-
-COPY Gemfile* /tmp/
-COPY gollum.gemspec* /tmp/
-WORKDIR /tmp
-RUN bundle install
-
-RUN gem install \
-    asciidoctor \
-    creole \
-    wikicloth \
-    org-ruby \
-    RedCloth \
-    bibtex-ruby \
-    && echo "gem-extra complete"
-
-WORKDIR /app
-COPY . /app
-RUN bundle exec rake install
-
-VOLUME /wiki
-WORKDIR /wiki
-COPY docker-run.sh /docker-run.sh
-ENTRYPOINT ["/docker-run.sh"]

README.md

@@ -37,11 +37,11 @@ Gollum runs on Unix-like systems using its [adapter](https://github.com/gollum/r
 ## INSTALLATION
 
 1. Ruby is best installed either via [RVM](https://rvm.io/) or a package manager of choice.
-2. Gollum is best installed via RubyGems:
+2. Gollum is best installed via RubyGems:  
 	```
 	[sudo] gem install gollum
 	```
-
+	
 Installation examples for individual systems can be seen [here](https://github.com/gollum/gollum/wiki/Installation).
 
 To run, simply:
@@ -84,19 +84,19 @@ See [here](https://github.com/gollum/gollum/wiki/Custom-rendering-gems) for inst
 
 ### Rack
 
-Gollum can also be run with any [rack-compatible web server](https://github.com/rack/rack#supported-web-servers). More on that [over here](https://github.com/gollum/gollum/wiki/Gollum-via-Rack).
+Gollum can also be ran with any [rack-compatible web server](https://github.com/rack/rack#supported-web-servers). More on that [over here](https://github.com/gollum/gollum/wiki/Gollum-via-Rack).
 
 ### Rack, with an authentication server
 
-Gollum can also be run alongside a CAS (Central Authentication Service) SSO (single sign-on) server. With a bit of tweaking, this adds basic user-support to Gollum. To see an example and an explanation, navigate [over here](https://github.com/gollum/gollum/wiki/Gollum-via-Rack-and-CAS-SSO).
+Gollum can also be ran alongside a CAS (Central Authentication Service) SSO (single sign-on) server. With a bit of tweaking, this adds basic user-support to Gollum. To see an example and an explanation, navigate [over here](https://github.com/gollum/gollum/wiki/Gollum-via-Rack-and-CAS-SSO).
 
 ### Docker
 
-Gollum can also be run via [Docker](https://www.docker.com/). More on that [over here](https://github.com/gollum/gollum/wiki/Gollum-via-Docker).
+Gollum can also be ran via [Docker](https://www.docker.com/). More on that [over here](https://github.com/gollum/gollum/wiki/Gollum-via-Docker).
 
 ### Service
 
-Gollum can also be run as a service. More on that [over here](https://github.com/gollum/gollum/wiki/Gollum-as-a-service).
+Gollum can also be ran as a service. More on that [over here](https://github.com/gollum/gollum/wiki/Gollum-as-a-service).
 
 ## CONFIGURATION
 
@@ -126,7 +126,7 @@ Gollum comes with the following command line options:
 | --no-display-metadata | none  | Do not render metadata tables in pages. |
 | --user-icons      | [MODE]    | Tell Gollum to use specific user icons for history view. Can be set to `gravatar`, `identicon` or `none`. Default: `none`. |
 | --mathjax-config  | [FILE]    | Specify path to a custom MathJax configuration. If not specified, uses the `mathjax.config.js` file from repository root. |
-| --template-dir    | [PATH]    | Specify custom mustache template directory. Only overrides templates that exist in this directory. |
+| --template-dir    | [PATH]    | Specify custom mustache template directory. |
 | --template-page   | none      | Use _Template in root as a template for new pages. Must be committed. |
 | --emoji           | none      | Parse and interpret emoji tags (e.g. `:heart:`) except when the leading colon is backslashed (e.g. `\:heart:`). |
 | --lenient-tag-lookup | none | Internal links resolve case-insensitively, will treat spaces as hyphens, and will match the first page found with a certain filename, anywhere in the repository. Provides compatibility with Gollum 4.x. |
@@ -150,7 +150,3 @@ When `--config` option is used, certain inner parts of Gollum can be customized.
 ## CONTRIBUTING
 
 Please consider helping out! See [CONTRIBUTING](CONTRIBUTING.md) for information on how to submit issues, and how to start hacking on gollum.
-
-## THANKS TO
-
-[![Testing Powered By SauceLabs](https://opensource.saucelabs.com/images/opensauce/powered-by-saucelabs-badge-gray.png?sanitize=true "Testing Powered By SauceLabs")](https://saucelabs.com)

bin/gollum

@@ -149,7 +149,7 @@ MSG
     'Can be set to \'gravatar\' or \'identicon\'. Default: standard avatar.') do |mode|
     wiki_options[:user_icons] = mode.to_s
   end
-  opts.on('--template-dir [PATH]', 'Specify custom mustache template directory. Only overrides templates that exist in this directory.') do |path|
+  opts.on('--template-dir [PATH]', 'Specify custom mustache template directory.') do |path|
     wiki_options[:template_dir] = path
   end
   opts.on('--template-page', 'Use _Template.{ext} as a template for new pages.') do
@@ -271,6 +271,7 @@ else
   Precious::App.set(:environment, ENV.fetch('RACK_ENV', :production).to_sym)
   Precious::App.set(:gollum_path, gollum_path)
   Precious::App.set(:wiki_options, wiki_options)
+  Precious::App.settings.mustache[:templates] = wiki_options[:template_dir] if wiki_options[:template_dir]
 
   if cfg = options[:config]
     # If the path begins with a '/' it will be considered an absolute path,

docker-run.sh

@@ -1,9 +0,0 @@
-#!/bin/bash
-
-# Initialize the wiki
-if [ ! -d .git ]; then
-    git init
-fi
-
-# Start gollum service
-gollum --mathjax

gollum.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'kramdown-parser-gfm', '~> 1.1.0'
   s.add_dependency 'sinatra', '~> 2.0'
   s.add_dependency 'sinatra-contrib', '~> 2.0'
-  s.add_dependency 'mustache-sinatra', '>= 1.0.1', '< 2'
+  s.add_dependency 'mustache-sinatra', '~> 1.0'
   s.add_dependency 'useragent', '~> 0.16.2'
   s.add_dependency 'gemojione', '~> 4.1'
   s.add_dependency 'octicons', '~> 12.0'

lib/gollum.rb

@@ -10,13 +10,13 @@ require 'github/markup'
 require 'rhino' if RUBY_PLATFORM == 'java'
 
 # internal
-require ::File.expand_path('../gollum/uri_encode_component', __FILE__)
+require File.expand_path('../gollum/uri_encode_component', __FILE__)
 
 module Gollum
   VERSION = '5.2.3'
 
   ::I18n.available_locales = [:en]
-  ::I18n.load_path = Dir[::File.expand_path("lib/gollum/locales") + "/*.yml"]
+  ::I18n.load_path = Dir[File.expand_path("lib/gollum/locales") + "/*.yml"]
 
   def self.assets_path
     ::File.expand_path('gollum/public', ::File.dirname(__FILE__))

lib/gollum/app.rb

@@ -22,7 +22,6 @@ require 'gollum/views/has_page'
 require 'gollum/views/has_user_icons'
 require 'gollum/views/pagination'
 require 'gollum/views/rss.rb'
-require 'gollum/views/template_cascade'
 
 require File.expand_path '../helpers', __FILE__
 
@@ -111,11 +110,7 @@ module Precious
       @wiki_title = settings.wiki_options.fetch(:title, 'Gollum Wiki')
 
       forbid unless @allow_editing || request.request_method == 'GET'
-
-      if settings.wiki_options[:template_dir]
-        Precious::Views::Layout.extend Precious::Views::TemplateCascade
-        Precious::Views::Layout.template_priority_path = settings.wiki_options[:template_dir]
-      end
+      Precious::App.set(:mustache, {:templates => settings.wiki_options[:template_dir]}) if settings.wiki_options[:template_dir]
 
       @base_url = url('/', false).chomp('/').force_encoding('utf-8')
       @page_dir = settings.wiki_options[:page_file_dir].to_s
@@ -647,7 +642,7 @@ module Precious
 
     def load_template(path)
       template_page = wiki_page(::File.join(path, '_Template')).page || wiki_page('/_Template').page
-      template_page ? Gollum::TemplateFilter.apply_filters(template_page.text_data) : nil
+      template_page ? Gollum::TemplateFilter.apply_filters(template_page.raw_data) : nil
     end
 
     def update_wiki_page(wiki, page, content, commit, name = nil, format = nil)

lib/gollum/public/assets/.sprockets-manifest-854e63efab177e012aa68e5d03e76814.json

@@ -1 +0,0 @@
-{"files":{"app-f05401ee374f0c7f48fc2bc08e30b4f4db705861fd5895ed70998683b383bfb5.js":{"logical_path":"app.js","mtime":"2021-07-10T00:40:20+09:00","size":136040,"digest":"f05401ee374f0c7f48fc2bc08e30b4f4db705861fd5895ed70998683b383bfb5","integrity":"sha256-8FQB7jdPDH9I/CvAjjC09NtwWGH9WJXtcJmGg7ODv7U="},"editor-9881d0c7ae663293f0e3a7e72729eec7e940fa613185c076709b76d292f5703a.js":{"logical_path":"editor.js","mtime":"2021-07-10T00:42:29+09:00","size":744886,"digest":"9881d0c7ae663293f0e3a7e72729eec7e940fa613185c076709b76d292f5703a","integrity":"sha256-mIHQx65mMpPw46fnJynux+lA+mExhcB2cJt20pL1cDo="},"app-cb122b4c17500faa5e013cb43334fafcf2dd7d72f694b06d9616f8b33fefb694.css":{"logical_path":"app.css","mtime":"2021-07-10T00:39:36+09:00","size":396625,"digest":"cb122b4c17500faa5e013cb43334fafcf2dd7d72f694b06d9616f8b33fefb694","integrity":"sha256-yxIrTBdQD6peATy0MzT6/PLdfXL2lLBtlhb4sz/vtpQ="},"criticmarkup-31ae5d3282bbb8e7b7c3c9917e9fb68e3315a6b4a75da6cec48d21b8846905c4.css":{"logical_path":"criticmarkup.css","mtime":"2021-07-08T05:19:03+09:00","size":646,"digest":"31ae5d3282bbb8e7b7c3c9917e9fb68e3315a6b4a75da6cec48d21b8846905c4","integrity":"sha256-Ma5dMoK7uOe3w8mRfp+2jjMVprSnXabOxI0huIRpBcQ="},"print-512498c368be0d3fb1ba105dfa84289ae48380ec9fcbef948bd4e23b0b095bfb.css":{"logical_path":"print.css","mtime":"2021-07-08T05:19:03+09:00","size":75,"digest":"512498c368be0d3fb1ba105dfa84289ae48380ec9fcbef948bd4e23b0b095bfb","integrity":"sha256-USSYw2i+DT+xuhBd+oQomuSDgOyfy++Ui9TiOwsJW/s="}},"assets":{"app.js":"app-f05401ee374f0c7f48fc2bc08e30b4f4db705861fd5895ed70998683b383bfb5.js","editor.js":"editor-9881d0c7ae663293f0e3a7e72729eec7e940fa613185c076709b76d292f5703a.js","app.css":"app-cb122b4c17500faa5e013cb43334fafcf2dd7d72f694b06d9616f8b33fefb694.css","criticmarkup.css":"criticmarkup-31ae5d3282bbb8e7b7c3c9917e9fb68e3315a6b4a75da6cec48d21b8846905c4.css","print.css":"print-512498c368be0d3fb1ba105dfa84289ae48380ec9fcbef948bd4e23b0b095bfb.css"}}

lib/gollum/public/assets/.sprockets-manifest-de7bb79aec424e55af1acdcc4237b301.json

@@ -0,0 +1 @@
+{"files":{"app-0fd228e26bfbe6fe31a2da268eb0e98e780c1191c1a918adf383377946e9c838.js":{"logical_path":"app.js","mtime":"2021-03-23T08:40:11-07:00","size":136020,"digest":"0fd228e26bfbe6fe31a2da268eb0e98e780c1191c1a918adf383377946e9c838","integrity":"sha256-D9Io4mv75v4xotomjrDpjngMEZHBqRit84M3eUbpyDg="},"editor-db10c8351306e92f1926ba225d0cd9c8e886482b3b9820a85825ec3abab5f1cf.js":{"logical_path":"editor.js","mtime":"2021-02-24T23:16:14-08:00","size":744866,"digest":"db10c8351306e92f1926ba225d0cd9c8e886482b3b9820a85825ec3abab5f1cf","integrity":"sha256-2xDINRMG6S8ZJroiXQzZyOiGSCs7mCCoWCXsOrq18c8="},"app-ad43ca64b295d8444b10f22ee868f18429268af498f1bc515434878b690e37a2.css":{"logical_path":"app.css","mtime":"2021-03-23T08:40:11-07:00","size":396615,"digest":"ad43ca64b295d8444b10f22ee868f18429268af498f1bc515434878b690e37a2","integrity":"sha256-rUPKZLKV2ERLEPIu6GjxhCkmivSY8bxRVDSHi2kON6I="},"criticmarkup-31ae5d3282bbb8e7b7c3c9917e9fb68e3315a6b4a75da6cec48d21b8846905c4.css":{"logical_path":"criticmarkup.css","mtime":"2021-02-24T23:16:14-08:00","size":646,"digest":"31ae5d3282bbb8e7b7c3c9917e9fb68e3315a6b4a75da6cec48d21b8846905c4","integrity":"sha256-Ma5dMoK7uOe3w8mRfp+2jjMVprSnXabOxI0huIRpBcQ="},"print-512498c368be0d3fb1ba105dfa84289ae48380ec9fcbef948bd4e23b0b095bfb.css":{"logical_path":"print.css","mtime":"2021-02-24T23:16:14-08:00","size":75,"digest":"512498c368be0d3fb1ba105dfa84289ae48380ec9fcbef948bd4e23b0b095bfb","integrity":"sha256-USSYw2i+DT+xuhBd+oQomuSDgOyfy++Ui9TiOwsJW/s="}},"assets":{"app.js":"app-0fd228e26bfbe6fe31a2da268eb0e98e780c1191c1a918adf383377946e9c838.js","editor.js":"editor-db10c8351306e92f1926ba225d0cd9c8e886482b3b9820a85825ec3abab5f1cf.js","app.css":"app-ad43ca64b295d8444b10f22ee868f18429268af498f1bc515434878b690e37a2.css","criticmarkup.css":"criticmarkup-31ae5d3282bbb8e7b7c3c9917e9fb68e3315a6b4a75da6cec48d21b8846905c4.css","print.css":"print-512498c368be0d3fb1ba105dfa84289ae48380ec9fcbef948bd4e23b0b095bfb.css"}}

lib/gollum/public/gollum/javascript/editor/gollum.editor.js

@@ -218,7 +218,7 @@
           $form.attr('action', this.href || routePath('preview'));
           $form.attr('target', '_blank');
           var paths = window.location.pathname.split('/');
-          $form.attr('page', decodeURIComponent(paths[ paths.length - 1 ]) || '')
+          $form.attr('page', paths[ paths.length - 1 ] || '')
           $form.submit();
 
 

lib/gollum/public/gollum/javascript/gollum.js.erb

@@ -345,7 +345,7 @@ $(document).ready(function() {
     var formData = new FormData($('#gollum-editor-form').get(0));
     var paths = window.location.pathname.split('/');
     var sectionAnchor = window.location.hash.substr(1);
-    formData.append('page', decodeURIComponent(paths[ paths.length - 1 ]) || '')
+    formData.append('page', paths[ paths.length - 1 ] || '')
     $.ajax({
       url: routePath('preview'),
       data: formData,

lib/gollum/public/gollum/stylesheets/editor.scss

@@ -29,7 +29,6 @@ a.tabnav-tab:focus {
   overflow: hidden;
   font-family: Consolas, "Liberation Mono", Courier, monospace;
   font-size: 1em;
-  padding: 0;
 }
 
 #gollum-editor {

lib/gollum/views/template_cascade.rb

@@ -1,36 +0,0 @@
-module Precious
-  module Views
-    module TemplateCascade
-      def template_priority_path
-        @@template_priority_path
-      end
-
-      def template_priority_path=(path)
-        @@template_priority_path = File.expand_path(path)
-        @template = nil
-      end
-
-      def first_path_available(name)
-        priority = File.join(template_priority_path, "#{name}.#{template_extension}")
-        default = File.join(template_path, "#{name}.#{template_extension}")
-        File.exists?(priority) ? priority : default
-      end
-
-      # Method should track lib/mustache/settings.rb from Mustache project.
-      def template_file
-        @template_file || first_path_available(template_name)
-      end
-
-      # Method should track lib/mustache.rb from Mustache project.
-      def partial(name)
-        path = first_path_available(name)
-        begin
-          File.read(path)
-        rescue
-          raise if raise_on_context_miss?
-          ""
-        end
-      end
-    end
-  end
-end

test/examples/template_cascade/navbar.mustache

@@ -1,8 +0,0 @@
-<nav>
-  <div style="background-color: red;">NAVBAR_OVERRIDE</div>
-
-  <p>Still include an original partial to ensure the fallback works even when nested from an overriden partial:</p>
-  <div>
-    {{>mobilenav}}
-  </div>
-</nav>

test/examples/template_cascade/page.mustache

@@ -1,12 +0,0 @@
-<div id="wiki-wrapper" class="page">
-
-<p>Include an overridden partial:</p>
-<div id="head">
-	{{#navbar?}}{{>navbar}}{{/navbar?}}
-</div>
-
-<div style="background-color: red;">PAGE_OVERRIDE</div>
-
-{{>wiki_content}}
-
-</div>

test/test_app.rb

@@ -328,7 +328,7 @@ EOF
   test "create with template succeed if template exists" do
     Precious::App.set(:wiki_options, { :template_page => true })
     page='_Template'
-    post '/gollum/create', :content => 'fake template with some Utf-8: Ü', :page => page,
+    post '/gollum/create', :content => 'fake template', :page => page,
       :path               => '/', :format => 'markdown', :message => ''
     follow_redirect!      
     assert last_response.ok?

test/test_template_cascade.rb

@@ -1,43 +0,0 @@
-# ~*~ encoding: utf-8 ~*~
-require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
-
-class TestTemplateCascade < Minitest::Unit::TestCase
-  include Rack::Test::Methods
-
-  def setup
-    @path = cloned_testpath('examples/lotr.git')
-    Precious::App.set(:gollum_path, @path)
-    Precious::App.set(:wiki_options, {template_dir: testpath('examples/template_cascade')})
-    @wiki = Gollum::Wiki.new(@path)
-  end
-
-  def teardown
-    FileUtils.rm_rf(@path)
-  end
-
-  def app
-    Precious::App
-  end
-
-  def test_overridden_page_template_is_used
-    get '/Home'
-
-    assert last_response.body.include?('PAGE_OVERRIDE')
-  end
-
-  def test_overridden_navbar_partial_is_used
-    get '/Home'
-
-    assert last_response.body.include?('NAVBAR_OVERRIDE')
-  end
-
-  def test_overridden_templates_are_ignore_without_template_dir_set
-    Precious::App.set(:wiki_options, {template_dir: nil})
-
-    get '/Home'
-    assert_equal '/Home', last_request.fullpath
-    assert last_response.ok?
-    assert_no_match /PAGE_OVERRIDE/, last_response.body
-    assert_no_match /NAVBAR_OVERRIDE/, last_response.body
-  end
-end