fronde 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31ed851cf895abccd33ec85ab91459e4310c9716631d096efd89d18fd16bf190
-  data.tar.gz: 901e11daea515cff4336f05a13a67604a5d73ca9fc020efb8250b34fbdb72450
+  metadata.gz: 2d233f108a209e4d5a02633de060293ce6f4981393555ebf5f53f16a25f6d3d0
+  data.tar.gz: 9efa6cd46fc4d6d33e98bcee3e7cb1dd43a179736bafb552f6ac3e7a8c5bb8ae
 SHA512:
-  metadata.gz: 1190105b49652d3bf177602a9ca37906f9a4659416f821734b17b5a49269825726019a6b69ad47b312937d75b362e658b93026003ffc42cd92859b601c9c8e96
-  data.tar.gz: 4e34d65345c82cc39237521c2e79365bbe4c23572fa4c4fa7d65e2d5aa7119d095a2956ec569e03c6cb459e7f1f37fe933aac3d2b0fdcefafb69f1cea8ef695b
+  metadata.gz: a1c7f18af62f3fbd02be2f025c7d6305a7ea1c3751a35490eee4402de3a4aebf11c211cc3efcc4d57d0b82e99807a439ef920eb67182f0f8313905b20d89fd15
+  data.tar.gz: 315634038a4eb1df1c07f019894a0b86b591649f58068d771811bc0bbb92402cc03f79ada03f716caae0e8219075937d1df63ab3e6453827fadb03763203d4da

data/lib/ext/nil_time.rb

@@ -10,12 +10,9 @@ class NilTime
     ''
   end
 
-  def l18n_short_date_string
-    ''
-  end
-
-  def l18n_long_date_string(*)
-    ''
+  %i[l18n_short_date_string l18n_long_date_string
+     l18n_long_date_no_year_string].each do |name|
+    define_method(name) { '' }
   end
 
   def l18n_short_date_html

data/lib/ext/time.rb

@@ -7,7 +7,7 @@ module TimePatch
     #
     # @return [String] the localized Time string representation
     def l18n_short_date_string
-      R18n.l to_date
+      I18n.l to_date
     end
 
     # Format the current Time as a HTML `time` tag showing a short date.
@@ -17,26 +17,19 @@ module TimePatch
       "<time datetime=\"#{xmlschema}\">#{l18n_short_date_string}</time>"
     end
 
-    def no_time=(value)
-      @no_time = value
+    # Returns the current Time instance as a localized long string.
+    #
+    # @return [String] the localized Time string representation
+    def l18n_long_date_string
+      I18n.l self, format: :long
     end
 
-    # Returns the current Time instance as a localized long string.
+    # Returns the current Time instance as a localized long string
+    #   without year.
     #
-    # @param with_year [Boolean] wether or not the string must contain the
-    #   year
     # @return [String] the localized Time string representation
-    def l18n_long_date_string(with_year: true)
-      locale = R18n.get.locale
-      long_fmt = R18n.t.fronde.index.full_date_format(
-        date: locale.format_date_full(self, year: with_year)
-      )
-      unless @no_time
-        long_fmt = R18n.t.fronde.index.full_date_with_time_format(
-          date: long_fmt, time: locale.time_format.delete('_').strip
-        )
-      end
-      locale.strftime(self, long_fmt)
+    def l18n_long_date_no_year_string
+      I18n.l self, format: :long_no_year
     end
 
     # Format the current Time as a HTML `time` tag showing a long date.

data/lib/ext/time_no_time.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+using TimePatch
+
+# A time emulator to keep the fact that the time information was
+# missing, even if it behaves as a Time object for the given date.
+class TimeNoTime < Time
+  # Returns the current Time instance as a localized long string
+  #   without time.
+  #
+  # @return [String] the localized Time string representation
+  def l18n_long_date_string
+    I18n.l self, format: :long_no_time
+  end
+
+  # Returns the current Time instance as a localized long string
+  #   without time nor year.
+  #
+  # @return [String] the localized Time string representation
+  def l18n_long_date_no_year_string
+    I18n.l self, format: :long_no_time_no_year
+  end
+
+  def self.parse_no_time(string)
+    strptime("#{string} 00:00:00", '%Y-%m-%d %H:%M:%S')
+  end
+end

data/lib/fronde/cli/commands.rb

@@ -27,13 +27,13 @@ module Fronde
         init_rake
         @rake.options.build_all = true
         @rake['org:upgrade'].invoke
-        0
+        true
       end
 
       def fronde_build
         @rake.options.build_all = true
         @rake['site:build'].invoke @options[:force]
-        0
+        true
       end
 
       def fronde_preview
@@ -43,7 +43,7 @@ module Fronde
           Helpers.launch_app_for_uri "http://127.0.0.1:#{port}/"
         end
         @rake['site:preview'].invoke
-        0
+        true
       end
 
       def fronde_open
@@ -58,12 +58,12 @@ module Fronde
           cmd << '+6'
         end
         cmd << file_path
-        (system(*cmd) && 0) || 1
+        system(*cmd)
       end
 
       def fronde_publish
         @rake['sync:push'].invoke
-        0
+        true
       end
 
       def fronde_help
@@ -71,22 +71,26 @@ module Fronde
         @command = @argv.shift || 'basic' if @command == 'help'
         cmd_opt = OptParse.command_options(@command)
         label = cmd_opt[:label] || @command
-        warn format("%<label>s\n\n", label: R18n.t.fronde.bin.usage(label))
+        output = [format_label(I18n.t('fronde.bin.usage', label:))]
         cmd = cmd_opt[:name] || @command
-        if R18n.t.fronde.bin.commands[cmd].translated?
-          warn format("%<label>s\n\n", label: R18n.t.fronde.bin.commands[cmd])
-        end
-        body = OptParse.help_command_body(cmd)
-        warn body unless body == ''
-        0
+        output << format_label(I18n.t("fronde.bin.commands.#{cmd}"))
+        output << OptParse.help_command_body(cmd)
+        puts output.join
+        true
       end
 
       private
 
+      def format_label(label)
+        return '' if label == '' || label.start_with?('Translation missing:')
+
+        format("%<label>s\n\n", label:)
+      end
+
       def file_name_from_title
-        title = @options[:title] || R18n.t.fronde.bin.options.default_title
+        title = @options[:title] || I18n.t('fronde.bin.options.default_title')
         # No title, nor a reliable file_path? Better abort
-        raise R18n.t.fronde.error.bin.no_file if title == ''
+        raise I18n.t('fronde.error.bin.no_file') if title == ''
 
         "#{Fronde::Slug.slug(title)}.org"
       end

data/lib/fronde/cli/data/fish_completion

@@ -0,0 +1,20 @@
+function __fronde_main_commands
+  echo {{ comcomp }}
+end
+
+function __fronde_no_command_yet
+  set -f cmd (__fish_print_cmd_args_without_options)
+  {%- for com in commands %}
+  {% unless forloop.first %}and {% endunless %}not contains {{ com }} $cmd
+  {%- endfor %}
+end
+
+complete -c fronde -e
+complete -c fronde -f
+complete -c fronde -x -n '__fronde_no_command_yet' -a '(__fronde_main_commands)'
+complete -c fronde -n 'contains help (__fish_print_cmd_args_without_options)' -a '{{ commands | join ' ' }}'
+complete -c fronde -n 'contains new (__fish_print_cmd_args_without_options)' -F
+complete -c fronde -n 'contains open (__fish_print_cmd_args_without_options)' -F
+{%- for compopt in details %}
+complete -c fronde{% unless compopt.command == 'basic' %} -n 'contains {{ compopt.command }} (__fish_print_cmd_args_without_options)'{% endunless %} -s {{ compopt.short_no_dash }} -l {{ compopt.long_no_dash }}{% if compopt.keyword %} -r{% endif %}{% if compopt.choices %} -a '{{ compopt.choices | join ' ' }}'{% endif %} -d {% if compopt.help %}'{{ compopt.help }}'{% else %}{{ compopt.long_no_dash | capitalize }}{% endif %}
+{%- endfor %}

data/lib/fronde/cli/data/gitignore

@@ -1,4 +1,3 @@
-.dir-locals.el
 .ruby-version
 Rakefile
 lib/

data/lib/fronde/cli/helpers.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'uri'
-require 'net/http'
 require 'fileutils'
 
 module Fronde

data/lib/fronde/cli/opt_parse.rb

@@ -10,13 +10,13 @@ module Fronde
         '-a' => { long: 'author' },
         '-f' => { long: 'force', boolean: true },
         '-h' => { long: 'help', boolean: true, method: :on_tail,
-                  help: R18n.t.fronde.bin.options.help },
+                  help: I18n.t('fronde.bin.options.help') },
         '-l' => { long: 'lang', keyword: 'LOCALE' },
         '-o' => { long: 'output', keyword: 'FORMAT', choices: %w[gemini html] },
         '-t' => { long: 'title' },
         '-v' => { long: 'verbose', boolean: true, method: :on_tail },
         '-V' => { long: 'version', boolean: true, method: :on_tail,
-                  help: R18n.t.fronde.bin.options.version }
+                  help: I18n.t('fronde.bin.options.version') }
       }.freeze
 
       # TODO: jekyll new [path] / jekyll build / jekyll clean / jekyll serve
@@ -28,13 +28,13 @@ module Fronde
       FRONDE_COMMANDS = {
         'new' => { opts: ['-a', '-l', '-o', '-t', '-v'], label: 'new <path>' },
         'init' => { alias: 'new' },
-        'update' => {},
+        'update' => { opts: ['-v'] },
         'config' => { alias: 'update' },
         'preview' => {},
-        'open' => { opts: ['-a', '-l', '-t', '-v'], label: 'open <path>' },
+        'open' => { opts: ['-a', '-l', '-t'], label: 'open <path>' },
         'edit' => { alias: 'open' },
-        'build' => { opts: ['-f'] },
-        'publish' => {},
+        'build' => { opts: ['-f', '-v'] },
+        'publish' => { opts: ['-v'] },
         'help' => {},
         'basic' => { opts: ['-h', '-V'], label: '<command>' }
       }.freeze
@@ -59,11 +59,10 @@ module Fronde
             config = [short, long]
           else
             key = opt[:keyword] || opt[:long].upcase
-            config = [short, format('%<long>s %<key>s', long: long, key: key)]
+            config = [short, format('%<long>s %<key>s', long:, key:)]
           end
-          config << opt[:choices] if opt[:choices]
-          config << opt[:help] if opt[:help]
-          config
+          config.push opt[:choices], opt[:help]
+          config.compact
         end
 
         # Returns the ~fronde~ help summary for a given command.
@@ -76,12 +75,10 @@ module Fronde
             short, long = decorate_option(k)
             opt = FRONDE_OPTIONS[k]
             label = [short, long].join(', ')
-            line = [format('    %<opt>s', opt: label).ljust(30)]
-            help = opt[:help]
-            line << help if help
+            line = [format('    %<opt>s', opt: label).ljust(30), opt[:help]]
             choices = opt[:choices]
             line << "(#{choices.join(', ')})" if choices
-            line.join(' ')
+            line.compact.join(' ')
           end.join("\n")
         end
 
@@ -89,9 +86,9 @@ module Fronde
           command_opts_doc = summarize_command(command)
           return '' if command_opts_doc == ''
 
-          body = [R18n.t.fronde.bin.options.cmd_title, command_opts_doc]
+          body = [I18n.t('fronde.bin.options.cmd_title'), command_opts_doc]
           if command == 'basic'
-            body += ['', R18n.t.fronde.bin.commands.cmd_title, list_commands]
+            body += ['', I18n.t('fronde.bin.commands.cmd_title'), list_commands]
           end
           body.join("\n")
         end
@@ -105,9 +102,9 @@ module Fronde
 
             line = ['   ', cmd.ljust(10)]
             if opt.has_key? :alias
-              line << R18n.t.fronde.bin.commands.alias(opt[:alias])
+              line << I18n.t('fronde.bin.commands.alias', alias: opt[:alias])
             else
-              line << R18n.t.fronde.bin.commands[cmd]
+              line << I18n.t("fronde.bin.commands.#{cmd}")
             end
             line.join(' ')
           end.join("\n")

data/lib/fronde/cli/throbber.rb

@@ -21,6 +21,7 @@ module Fronde
 
       def initialize(thread, message)
         @frames = select_frames
+        @term_width = terminal_width
         @thread = thread
         @thread.abort_on_exception = false
         @thread.report_on_exception = false
@@ -28,23 +29,17 @@ module Fronde
       end
 
       def run
-        term_width = terminal_width
-        frames_len = @frames.length
-        current = 0
-        while @thread.alive?
-          sleep 0.1
-          frame = @frames[current % frames_len]
-          message = "#{@message} #{frame}"
-          print "#{message.ljust(term_width)}\r"
-          current += 1
-        end
-        @thread.join # Ensure any inner exception is re-raised
+        thread_loop
       rescue RuntimeError => e
         show_error
         raise e
+        # :nocov: not sure how to emulate a Ctrl+c in rspec
+      rescue Interrupt => e
+        show_message Rainbow(I18n.t('fronde.bin.interrupted')).red, "\n"
+        raise e
+        # :nocov:
       else
-        done = Rainbow(R18n.t.fronde.bin.done).green
-        puts "#{@message} #{done}".ljust(term_width)
+        show_message Rainbow(I18n.t('fronde.bin.done')).green, "\n"
       end
 
       class << self
@@ -61,15 +56,32 @@ module Fronde
         #
         # @param thread [Thread] the long-running operation to decorate
         # @param message [String] the message to display before the throbber
+        # @param verbose [Boolean] whether the decoration should be shown
+        #   or skipped
         # @return [void]
-        def run(thread, message)
-          throbber = new(thread, message)
-          throbber.run
+        def run(thread, message, verbose)
+          if verbose
+            thread.join
+          else
+            throbber = new(thread, message)
+            throbber.run
+          end
         end
       end
 
       private
 
+      def thread_loop
+        frames_len = @frames.length
+        current = 0
+        while @thread.alive?
+          sleep 0.1
+          show_message @frames[current % frames_len]
+          current += 1
+        end
+        @thread.join # Ensure any inner exception is re-raised
+      end
+
       def terminal_width
         # Not a tty. Docker?
         return 0 unless system('test -t 0')
@@ -77,13 +89,18 @@ module Fronde
         `stty size`.strip.split[1].to_i - 1
       end
 
+      def show_message(suffix, end_of_line = "\r")
+        message = "#{@message} #{suffix}".ljust(@term_width)
+        print "#{message}#{end_of_line}"
+      end
+
       def show_error
         warn(
           format(
             "%<message>s %<label>s\n%<explanation>s",
             message: @message,
-            label: Rainbow(R18n.t.fronde.error.bin.label).bold.red,
-            explanation: Rainbow(R18n.t.fronde.error.bin.explanation).bold
+            label: Rainbow(I18n.t('fronde.error.bin.label')).bold.red,
+            explanation: Rainbow(I18n.t('fronde.error.bin.explanation')).bold
           )
         )
       end

data/lib/fronde/cli.rb

@@ -21,12 +21,13 @@ module Fronde
 
         if help_param_given?
           return 2 if @options[:recover_from_error]
-          return 0
+
+          return true
         end
 
         init_rake if %w[build preview publish].include?(@command)
 
-        method = "fronde_#{@command}".to_sym
+        method = :"fronde_#{@command}"
         return 2 if method_unknown?(method)
 
         send method
@@ -50,7 +51,7 @@ module Fronde
       def method_unknown?(method)
         return false if respond_to?(method)
 
-        warn R18n.t.fronde.error.bin.no_command
+        warn I18n.t('fronde.error.bin.no_command')
         fronde_help
         true
       end

data/lib/fronde/config/data/org-config.el

@@ -4,8 +4,9 @@
 (load-file (expand-file-name "htmlize.el" "{{ work_dir }}/lib"))
 
 ;; Current project options
-(setq fronde/version "{{ version }}"
-      fronde/current-work-dir "{{ work_dir }}"
+(setq fronde-version "{{ version }}"
+      fronde-current-work-dir "{{ work_dir }}"
+      fronde-domain "{{ domain }}"
       user-mail-address "{{ author.email }}"
       user-full-name "{{ author.name }}"
       org-html-metadata-timestamp-format "{{ long_date_fmt }}"

data/lib/fronde/config/data/ox-fronde.el

@@ -34,87 +34,132 @@
 
 ;;; Function Declarations
 
-(defvar fronde/version ""
-  "Version of the current fronde installation")
+(defvar fronde-version ""
+  "Version of the current fronde installation.")
 
-(defvar fronde/current-work-dir nil
+(defvar fronde-current-work-dir nil
   "Location of the current fronde website base directory.")
 
-(defvar fronde/org-temp-dir nil
-  "Location of the local Org temporary directory (where to place
-org timestamps and id locations).")
-
-(defun fronde/org-html-format-spec (upstream info)
-  "Return format specification for preamble and postamble.
+(defvar fronde-domain ""
+  "Target domain with scheme of the current fronde installation.")
+
+(defvar fronde-org-temp-dir nil
+  "Location of the local Org temporary directory.
+This is where to place org timestamps and id locations.")
+
+(defvar fronde--keywords-slugs-alist nil
+  "A list associating each keywords to its related slug.
+
+Can be hydrated with `fronde--build-keywords-list'.")
+
+(defun fronde--build-keywords-list ()
+  (let ((keywords-file (format "%s/keywords" fronde-org-temp-dir))
+        keywords-slugs)
+    (when (file-readable-p keywords-file)
+      (let ((content (with-temp-buffer
+                       (insert-file-contents keywords-file)
+                       (string-trim-right (buffer-string)))))
+        (mapcar
+         (lambda (line)
+           (push (split-string line "\x1f") keywords-slugs))
+         (split-string content "\x1e"))))
+    keywords-slugs))
+
+(defun fronde--format-rich-keywords (info function)
+  "Extract keywords from INFO and apply FUNCTION on them.
+FUNCTION is expected to format each keyword for a rich display for the
+current export backend.  FUNCTION must receive 3 arguments: the current
+KEYWORD, its related SLUG and the current project BASE-URI."
+  (let ((base-uri (plist-get info :fronde-base-uri)))
+    (mapcar
+     (lambda (k)
+       (let ((slug (cadr (assoc k fronde--keywords-slugs-alist))))
+         (funcall function k slug base-uri)))
+     (split-string
+      (org-export-data (plist-get info :keywords) info)
+      ",+ *"))))
+
+(defun fronde--org-html-format-spec (upstream info)
+  "Advise UPSTREAM to return format specification for preamble and postamble.
 INFO is a plist used as a communication channel."
   (let ((output (funcall upstream info)))
     (push `(?A . ,(format "<span class=\"author\">%s</span>"
                     (org-export-data (plist-get info :author) info)))
-      output)
+          output)
     (push `(?k . ,(org-export-data (plist-get info :keywords) info)) output)
-    (push `(?K . ,(format "<ul class=\"keywords-list\">%s</ul>"
-                    (mapconcat
-	                    (lambda (k) (format "<li class=\"keyword\">%s</li>" k))
-	                    (split-string (or (plist-get info :keywords) "")  ",+ *")
-	                    "\n")))
-      output)
+    (push `(?K . ,(format "<ul class=\"keywords-list\">\n%s</ul>"
+                    (apply #'concat
+                      (fronde--format-rich-keywords
+                        info
+	                    (lambda (k slug base-uri)
+                          (format "<li class=\"keyword\"><a href=\"%stags/%s.html\">%s</a></li>\n"
+                            base-uri slug k))))))
+          output)
     (push `(?l . ,(org-export-data (plist-get info :language) info)) output)
-    (push `(?n . ,(format "Fronde %s" fronde/version)) output)
-    (push `(?N . ,(format "<a href=\"https://etienne.depar.is/fronde/\">Fronde</a> %s" fronde/version)) output)
+    (push `(?n . ,(format "Fronde %s" fronde-version)) output)
+    (push `(?N . ,(format "<a href=\"https://etienne.depar.is/fronde/\">Fronde</a> %s" fronde-version)) output)
     (push `(?x . ,(org-export-data (plist-get info :description) info)) output)
     (push `(?X . ,(format "<p>%s</p>"
                     (org-export-data (plist-get info :description) info)))
-      output)))
+          output)))
 
-(defun fronde/org-gmi-format-spec (upstream info)
-  "Return format specification for gemini postamble.
+(defun fronde--org-gmi-format-spec (upstream info)
+  "Advise UPSTREAM to return format specification for gemini postamble.
 INFO is a plist used as a communication channel."
   (let ((output (funcall upstream info)))
-    (push `(?n . ,(format "Fronde %s" fronde/version)) output)))
-
-(defun fronde/org-i18n-export (link description format)
-  "Export a i18n link"
-  (let* ((splitted-link (split-string link "|"))
+    (push `(?K . ,(org-gmi--build-links-list
+                   (fronde--format-rich-keywords
+                    info
+                    (lambda (k slug base-uri)
+                      (list (format "%stags/%s.gmi" base-uri slug)
+                            (format "🏷️ %s" k))))))
+          output)
+    (push `(?n . ,(format "Fronde %s" fronde-version)) output)))
+
+(defun fronde--org-i18n-export (link description backend)
+  "Export the given i18n LINK with its DESCRIPTION for the current BACKEND."
+  (let* ((splitted-link (split-string link "::"))
          (path (car splitted-link))
          (desc (or description path))
          (lang (cadr splitted-link)))
-    (pcase format
+    (pcase backend
       (`html (if lang
                  (format "<a href=\"%s\" hreflang=\"%s\">%s</a>"
                          path lang desc)
                (format "<a href=\"%s\">%s</a>" path desc)))
-      (`latex (format "\\href{%s}{%s}" path desc))
-      (_ (format "%s (%s)" desc path)))))
+      (_ nil))))
 
-(defun fronde/org-i18n-follow (link)
-  "Visit a i18n link"
-  (browse-url (car (split-string link "|"))))
+(defun fronde--org-i18n-follow (link)
+  "Visit the given i18n LINK."
+  (browse-url (car (split-string link "::"))))
 
 (org-link-set-parameters "i18n"
-  :export #'fronde/org-i18n-export
-  :follow #'fronde/org-i18n-follow)
+  :export #'fronde--org-i18n-export
+  :follow #'fronde--org-i18n-follow)
 
 
 ;;; Set configuration options
 
-(setq fronde/org-temp-dir (expand-file-name "var/tmp" fronde/current-work-dir)
-      org-publish-timestamp-directory (expand-file-name "timestamps/" fronde/org-temp-dir)
-      org-id-locations-file (expand-file-name "id-locations.el" fronde/org-temp-dir)
+(setq fronde-org-temp-dir (expand-file-name "var/tmp" fronde-current-work-dir)
+      fronde--keywords-slugs-alist (fronde--build-keywords-list)
+      org-publish-timestamp-directory (expand-file-name "timestamps/" fronde-org-temp-dir)
+      org-id-locations-file (expand-file-name "id-locations.el" fronde-org-temp-dir)
       make-backup-files nil
-      enable-local-variables :all
-      org-confirm-babel-evaluate nil
+      enable-dir-local-variables nil
+      enable-local-variables t ;; enforce default
+      org-confirm-babel-evaluate t ;; enforce default
       org-export-with-broken-links t
       org-html-doctype "html5"
       org-html-html5-fancy t
       org-html-htmlize-output-type 'css
       org-html-text-markup-alist '((bold . "<strong>%s</strong>")
-                                    (code . "<code>%s</code>")
-                                    (italic . "<em>%s</em>")
-                                    (strike-through . "<del>%s</del>")
-                                    (underline . "<span class=\"underline\">%s</span>")
-                                    (verbatim . "<code>%s</code>")))
-(advice-add 'org-html-format-spec :around #'fronde/org-html-format-spec)
-(advice-add 'org-gmi--format-spec :around #'fronde/org-gmi-format-spec)
+                                   (code . "<code>%s</code>")
+                                   (italic . "<em>%s</em>")
+                                   (strike-through . "<del>%s</del>")
+                                   (underline . "<span class=\"underline\">%s</span>")
+                                   (verbatim . "<code>%s</code>")))
+(advice-add 'org-html-format-spec :around #'fronde--org-html-format-spec)
+(advice-add 'org-gmi--format-spec :around #'fronde--org-gmi-format-spec)
 
 (provide 'ox-fronde)