fronde 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c646347a1cdbe6537384936ec392c1848617524fd7557f3c32566adb14e3c357
-  data.tar.gz: 41785e0d542baa6ac44c8e2f7b8d12d26db6ea5a5e10349ea4002d71b25f435d
+  metadata.gz: 2270e37b7e8d42fa6a70cc1844bcc883db47e21268e463db721887309b65ca23
+  data.tar.gz: 2c17f8cf073c980a6050fbad6a2bc91f07999dc0455b0add8d13b234b2609ed9
 SHA512:
-  metadata.gz: ecac97edd7c48c3cd808c906195b11e941f84db6254f0548af1d951e8bba215a6545616cc8b425977b5453b158f5b3032e08d4cf702b1087f110054770e3c739
-  data.tar.gz: adb5628d1999d54284ad38c614ca29bd76b287124fb4ebc434a465225f3c1fb97acf1cce4e844de05aaf66b35c40be8216b9045535dfb05370c77eecb0cb4bde
+  metadata.gz: 63906ee9ae84ab6a1b81417dae22e9ab2d90fd0c348c435d35c309568505e5d39d13f98ce5c86c80474f0927796422fe3e89518faebd5c5a1a298a3d16722392
+  data.tar.gz: 399c76bd432a76be07efe3729a538e6f2fcee1fa4448043ff637cc77aae7a14df858794f0160d455ffef74ed965267d2f3194a94207bd47bb588c2aa3bb58888

data/lib/fronde/config/lisp_config.rb

@@ -42,7 +42,7 @@ module Fronde
                   .gsub('__WORK_DIR__', workdir)
                   .gsub('__FRONDE_DIR__', __dir__)
                   .gsub('__ORG_VER__', org_last_version)
-                  .gsub('__ALL_PROJECTS__', all_projects(projects))
+                  .gsub('__ALL_PROJECTS__', projects.values.join("\n        "))
                   .gsub('__THEME_CONFIG__', org_default_theme_config)
                   .gsub('__ALL_PROJECTS_NAMES__', project_names(projects))
                   .gsub('__LONG_DATE_FMT__', r18n_full_datetime_format)
@@ -109,12 +109,6 @@ module Fronde
       names.join(' ')
     end
 
-    def all_projects(projects)
-      projects.values.join("\n").strip
-              .gsub(/\n\s*\n/, "\n")
-              .gsub(/\n/, "\n        ")
-    end
-
     # Return the full path to the publication path of a given project
     #   configuration.
     #
@@ -122,49 +116,60 @@ module Fronde
     #   the ~sources~ key)
     # @return [String] the full path to the target dir of this project
     def publication_path(project)
-      publish_in = [Dir.pwd, settings['public_folder']]
+      publish_in = [Dir.pwd]
+      if project['type'] == 'gemini'
+        publish_in << (settings['gemini_public_folder'] || 'public_gmi')
+      else
+        publish_in << settings['public_folder']
+      end
       publish_in << project['target'] unless project['target'] == '.'
       publish_in.join('/')
     end
 
+    # Return the publication function needed for a given project
+    #   configuration.
+    #
+    # @param project [Hash] a project configuration (as extracted from
+    #   the ~sources~ key)
+    # @return [String] the org publication function name
+    def publication_function(project)
+      case project['type']
+      when 'gemini'
+        'org-gmi-publish-to-gemini'
+      else
+        'org-html-publish-to-html'
+      end
+    end
+
     def org_project(project_name, opts)
-      publish_in = publication_path(opts)
-      other_lines = [
-        format(':recursive %<value>s',
-               value: ruby_to_lisp_boolean(opts['recursive']))
+      shared_lines = org_project_shared_lines(opts)
+      project_config = [
+        org_project_config(project_name, opts, shared_lines),
+        org_assets_config(project_name, shared_lines)
       ]
-      if opts['exclude']
-        other_lines << format(':exclude "%<value>s"',
-                              value: opts['exclude'])
-      end
       themeconf = org_theme_config(opts['theme'])
-      <<~ORGPROJECT
-        ("#{project_name}"
-         :base-directory "#{opts['path']}"
-         :base-extension "org"
-         #{other_lines.join("\n ")}
-         :publishing-directory "#{publish_in}"
-         :publishing-function org-html-publish-to-html
-         #{opts['org_headers']})
-        ("#{project_name}-assets"
-         :base-directory "#{opts['path']}"
-         :base-extension "jpg\\\\\\|gif\\\\\\|png\\\\\\|svg\\\\\\|pdf"
-         #{other_lines[0]}
-         :publishing-directory "#{publish_in}"
-         :publishing-function org-publish-attachment)
-        #{themeconf}
-      ORGPROJECT
+      project_config << themeconf unless themeconf == ''
+      project_config.join("\n        ")
     end
 
-    def org_default_postamble
+    def org_default_html_postamble
       <<~POSTAMBLE
         <p><span class="author">#{R18n.t.fronde.org.postamble.written_by}</span>
-        #{R18n.t.fronde.org.postamble.with_emacs}</p>
+        #{R18n.t.fronde.org.postamble.with_emacs_html}</p>
         <p class="date">#{R18n.t.fronde.org.postamble.last_modification}</p>
         <p class="validation">%v</p>
       POSTAMBLE
     end
 
+    def org_default_gemini_postamble
+      format(
+        "📅 %<date>s\n📝 %<author>s %<creator>s",
+        author: R18n.t.fronde.org.postamble.written_by,
+        creator: R18n.t.fronde.org.postamble.with_emacs,
+        date: R18n.t.fronde.org.postamble.last_modification
+      )
+    end
+
     def org_default_html_head
       <<~HTMLHEAD
         <link rel="stylesheet" type="text/css" media="screen"
@@ -177,9 +182,7 @@ module Fronde
 
     def org_default_html_options(project)
       defaults = {
-        'section-numbers' => 'nil',
-        'with-toc' => 'nil',
-        'html-postamble' => org_default_postamble,
+        'html-postamble' => org_default_html_postamble,
         'html-head' => '__ATOM_FEED__',
         'html-head-include-default-style' => 't',
         'html-head-include-scripts' => 't'
@@ -192,6 +195,23 @@ module Fronde
       defaults
     end
 
+    def org_publish_options(project)
+      defaults = {
+        'section-numbers' => 'nil',
+        'with-toc' => 'nil'
+      }
+      if project['type'] == 'gemini'
+        defaults['gemini-postamble'] = org_default_gemini_postamble
+      else
+        defaults.merge!(
+          org_default_html_options(project),
+          settings['org-html'] || {},
+          project['org-html'] || {}
+        )
+      end
+      defaults.merge(project['org-options'] || {})
+    end
+
     def expand_vars_in_html_head(head, project)
       curtheme = project['theme'] || settings['theme']
       # Head may be frozen when coming from settings
@@ -212,21 +232,17 @@ module Fronde
     end
 
     def build_project_org_headers(project)
-      orgtplopts = org_default_html_options(project).merge(
-        settings['org-html'] || {}, project['org-html'] || {}
-      )
-      orgtpl = []
+      orgtplopts = org_publish_options(project)
       lisp_keywords = ['t', 'nil', '1', '-1', '0'].freeze
-      orgtplopts.each do |k, v|
+      orgtplopts.map do |k, v|
         v = expand_vars_in_html_head(v, project) if k == 'html-head'
         val = cast_lisp_value(v)
         if lisp_keywords.include? val
-          orgtpl << ":#{k} #{val}"
+          ":#{k} #{val}"
         else
-          orgtpl << ":#{k} \"#{val}\""
+          ":#{k} \"#{val}\""
         end
       end
-      orgtpl.join("\n ")
     end
 
     def org_generate_projects(with_tags: false)
@@ -247,23 +263,64 @@ module Fronde
     def org_default_theme_config
       theme_config = org_theme_config(settings['theme'])
       return theme_config if theme_config == ''
-      output = theme_config.split("\n").map do |line|
-        "        #{line}"
-      end
-      format("\n%<conf>s", conf: output.join("\n"))
+      format("\n        %<conf>s", conf: theme_config)
     end
 
     def org_theme_config(theme)
       return '' if theme.nil? || theme == 'default'
       workdir = Dir.pwd
-      <<~THEMECONFIG
-        ("theme-#{theme}"
-         :base-directory "#{workdir}/themes/#{theme}"
-         :base-extension "jpg\\\\\\|gif\\\\\\|png\\\\\\|js\\\\\\|css\\\\\\|otf\\\\\\|ttf\\\\\\|woff2?"
-         :recursive t
-         :publishing-directory "#{workdir}/#{settings['public_folder']}/assets/#{theme}"
-         :publishing-function org-publish-attachment)
-      THEMECONFIG
+      [
+        format('("theme-%<theme>s"', theme: theme),
+        format(' :base-directory "%<wd>s/themes/%<theme>s"',
+               wd: workdir, theme: theme),
+        # rubocop:disable Layout/LineLength
+        ' :base-extension "jpg\\\\\\|gif\\\\\\|png\\\\\\|js\\\\\\|css\\\\\\|otf\\\\\\|ttf\\\\\\|woff2?"',
+        # rubocop:enable Layout/LineLength
+        ' :recursive t',
+        format(' :publishing-directory "%<wd>s/%<pub>s/assets/%<theme>s"',
+               wd: workdir, pub: settings['public_folder'], theme: theme),
+        ' :publishing-function org-publish-attachment)'
+      ].join("\n        ").strip
+    end
+
+    def org_project_shared_lines(project)
+      [
+        format(':base-directory "%<path>s"', path: project['path']),
+        format(
+          ':publishing-directory "%<path>s"',
+          path: publication_path(project)
+        ),
+        format(
+          ':recursive %<rec>s',
+          rec: ruby_to_lisp_boolean(project['recursive'])
+        )
+      ]
+    end
+
+    def org_project_config(project_name, project, shared_lines)
+      project_lines = [
+        format('"%<name>s"', name: project_name),
+        ':base-extension "org"',
+        format(
+          ':publishing-function %<fun>s',
+          fun: publication_function(project)
+        )
+      ] + shared_lines + project['org_headers']
+      if project['exclude']
+        project_lines << format(
+          ':exclude "%<value>s"', value: project['exclude']
+        )
+      end
+      format('(%<pr>s)', pr: project_lines.join("\n         "))
+    end
+
+    def org_assets_config(project_name, shared_lines)
+      assets_lines = [
+        format('"%<name>s-assets"', name: project_name),
+        ':base-extension "jpg\\\\\\|gif\\\\\\|png\\\\\\|svg\\\\\\|pdf"',
+        ':publishing-function org-publish-attachment'
+      ] + shared_lines
+      format('(%<assets>s)', assets: assets_lines.join("\n         "))
     end
   end
 end

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

@@ -9,9 +9,11 @@
       user-mail-address "__AUTHOR_EMAIL__"
       user-full-name "__AUTHOR_NAME__"
       org-html-metadata-timestamp-format "__LONG_DATE_FMT__"
+      org-gmi-timestamp-format "__LONG_DATE_FMT__"
       org-publish-project-alist
       `(__ALL_PROJECTS____THEME_CONFIG__
         ("website" :components (__ALL_PROJECTS_NAMES__))))
 
 ;; Load fronde lib
+(load-file (expand-file-name "ox-gmi.el" "__WORK_DIR__/lib"))
 (load-file (expand-file-name "ox-fronde.el" "__FRONDE_DIR__"))

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

@@ -30,6 +30,7 @@
 
 (require 'org)
 (require 'ox-html)
+(require 'ox-gmi)
 
 ;;; Function Declarations
 
@@ -65,6 +66,12 @@ INFO is a plist used as a communication channel."
                     (org-export-data (plist-get info :description) info)))
       output)))
 
+(defun fronde/org-gmi-format-spec (upstream info)
+  "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 "|"))
@@ -77,8 +84,7 @@ INFO is a plist used as a communication channel."
                          path lang desc)
                (format "<a href=\"%s\">%s</a>" path desc)))
       (`latex (format "\\href{%s}{%s}" path desc))
-      (`ascii (format "%s (%s)" desc path))
-      (_ path))))
+      (_ (format "%s (%s)" desc path)))))
 
 (defun fronde/org-i18n-follow (link)
   "Visit a i18n link"
@@ -108,6 +114,7 @@ INFO is a plist used as a communication channel."
                                     (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)
 

data/lib/fronde/org_file.rb

@@ -109,9 +109,6 @@ module Fronde
     # @option opts [String] title ('') the title of the new Org file
     # @option opts [String] author (system user or '') the author of the
     #   document
-    # @option opts [Boolean] verbose (false) if the
-    #   {Fronde::OrgFileHtmlizer#publish publish} method should output
-    #   emacs process messages
     # @option opts [String] project the project owning this file
     #   must be stored
     # @return [Fronde::OrgFile] the new instance of Fronde::OrgFile

data/lib/fronde/version.rb

@@ -2,5 +2,5 @@
 
 module Fronde
   # @return [String] the version number of the current Fronde release.
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/lib/tasks/org.rake

@@ -67,7 +67,14 @@ namespace :org do
     IO.write 'lib/htmlize.el', htmlize
   end
 
-  file 'var/lib/org-config.el' => 'lib/htmlize.el' do
+  file 'lib/ox-gmi.el' => 'lib' do
+    ox_gmi = URI(
+      'https://git.umaneti.net/ox-gmi.el/plain/ox-gmi.el'
+    ).open.read
+    IO.write 'lib/ox-gmi.el', ox_gmi
+  end
+
+  file 'var/lib/org-config.el' => ['lib/htmlize.el', 'lib/ox-gmi.el'] do
     Fronde::Config.write_org_lisp_config
   end
 

data/locales/en.yml

@@ -20,8 +20,8 @@ fronde:
       no_command: 'ERROR: no command or unknown command given.'
       no_file: 'ERROR: no file to open or edit.'
   error:
-    label: An error occured.
-    explanation: To see it, run again your command with more verbosity, i.e. fronde build -v
+    label: An error occurred.
+    explanation: To see the error, run your command again with more verbosity, for example, fronde build -v
   index:
     unsorted: Unsorted
     published_on: Published on %1
@@ -33,5 +33,6 @@ fronde:
   org:
     postamble:
       written_by: Written by %a
-      with_emacs: 'with %c, and published with %N'
       last_modification: Last modification on %C
+      with_emacs: 'with %c, and published with %n'
+      with_emacs_html: 'with %c, and published with %N'

data/locales/fr.yml

@@ -33,5 +33,6 @@ fronde:
   org:
     postamble:
       written_by: Écrit par %a
-      with_emacs: 'avec %c et publié avec %N'
       last_modification: dernière modification le %C
+      with_emacs: 'avec %c et publié avec %n'
+      with_emacs_html: 'avec %c et publié avec %N'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fronde
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Étienne Deparis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri