fronde 0.4.0 → 0.5.0

data/lib/fronde/config.rb

@@ -39,16 +39,16 @@ module Fronde
 
       def initialize
         @default_settings = {
-          'author' => (ENV['USER'] || ''),
+          'author' => ENV['USER'] || '',
           'domain' => '',
           'lang' => Fronde::Config::Helpers.extract_lang_from_env('en'),
           'html_public_folder' => 'public_html',
           'gemini_public_folder' => 'public_gmi',
           'templates' => [], 'theme' => 'default'
         }.freeze
-        @org_version = @sources = nil
-        @config = load_settings
         # Do not load sources now to avoid dependency loop on config
+        @sources = nil
+        @config = load_settings
       end
 
       include Fronde::Config::Lisp
@@ -93,7 +93,7 @@ module Fronde
       def reset
         # Reload config, taking default settings into account
         @config = load_settings
-        @org_version = @sources = nil
+        @sources = nil
         @sources = load_sources
       end
 
@@ -109,7 +109,7 @@ module Fronde
       # @return [Fronde::Config::Store] self
       def load_test(config)
         @config = @default_settings.merge config
-        @org_version = @sources = nil
+        @sources = nil
         @sources = load_sources
         self
       end
@@ -148,26 +148,48 @@ module Fronde
         end
       end
 
+      def check_duplicate_and_warn(collection, source, type)
+        path = source['path']
+        return path unless collection[type].has_key?(path)
+
+        warn(
+          R18n.t.fronde.error.source.duplicate(
+            source: source['name'], type: type
+          )
+        )
+      end
+
       def remove_duplicate(sources)
         check_paths = {}
         sources.each do |source|
           type = source.type
           check_paths[type] ||= {}
-          path = source['path']
+          path = check_duplicate_and_warn check_paths, source, type
           # Avoid duplicate
-          if check_paths[type].has_key?(path)
-            warn(
-              R18n.t.fronde.error.source.duplicate(
-                source: source['name'], type: type
-              )
-            )
-            next
-          end
+          next unless path
+
           check_paths[type][path] = source
         end
         check_paths
       end
 
+      def filter_possible_matchs(path, other_paths_list)
+        other_paths_list.select do |other_path|
+          path != other_path && other_path.start_with?(path)
+        end
+      end
+
+      def warn_on_existing_inclusion(type, other, possible_matchs, sources)
+        possible_matchs.each do |match|
+          warn(
+            R18n.t.fronde.error.source.inclusion(
+              source: sources[match]['title'],
+              other_source: other, type: type
+            )
+          )
+        end
+      end
+
       def remove_inclusion(check_paths)
         check_paths.map do |type, sources_by_path|
           skip_paths = []
@@ -183,21 +205,13 @@ module Fronde
             next source unless source.recursive?
 
             # Ensure that the current source does not embed another one
-            possible_matchs = sorted_paths.select do |other_path|
-              path != other_path && other_path.start_with?(path)
-            end
+            possible_matchs = filter_possible_matchs path, sorted_paths
             next source if possible_matchs.empty?
 
             skip_paths += possible_matchs
-            possible_matchs.each do |match|
-              other_source = sources_by_path[match]
-              warn(
-                R18n.t.fronde.error.source.inclusion(
-                  source: other_source['title'], type: type,
-                  other_source: source['title']
-                )
-              )
-            end
+            warn_on_existing_inclusion(
+              type, source['title'], possible_matchs, sources_by_path
+            )
           end
         end.flatten
       end

data/lib/fronde/emacs.rb

@@ -23,7 +23,7 @@ module Fronde
         warn cmd
         return system(cmd, exception: true)
       end
-      system cmd, out: '/dev/null', err: '/dev/null', exception: true
+      system cmd, out: File::NULL, err: File::NULL, exception: true
     end
 
     def build_command(org_action)

data/lib/fronde/index/data/all_tags.org

@@ -4,11 +4,16 @@
 {% for index in indexes %}
 * {{ index.title }}
 :PROPERTIES:
-:HTML_CONTAINER_CLASS: index-tags
+{%- if project_type == 'html' %}
+:HTML_CONTAINER_CLASS: index-tags{% endif %}
 :UNNUMBERED: notoc
 :END:
 
 {% for tag in index.tags -%}
+{%- if project_type == 'gemini' -%}
+[[{{ domain }}{{ project_path }}tags/{{ tag.slug }}.gmi][{{ tag.title }} ({{ tag.weight }})]]
+{%- else -%}
 - [[{{ domain }}{{ project_path }}tags/{{ tag.slug }}.html][{{ tag.title }}]] ({{ tag.weight }})
+{%- endif %}
 {% endfor %}
 {%- endfor -%}

data/lib/fronde/index/data/template.org

@@ -1,22 +1,26 @@
 #+title: {{ title }}
 #+author: {{ author }}
 #+language: {{ lang }}
-{%- unless slug == '__HOME_PAGE__' %}
+{%- if project_type == 'html' and slug != '__HOME_PAGE__' %}
 #+html_head_extra: <link rel="alternate" type="application/atom+xml" title="{{ title }}" href="{{ domain }}{{ project_path }}feeds/{{ slug }}.xml" />
-{% endunless -%}
+{% endif -%}
 {%- assign last_year = 0 -%}
 {% for article in entries %}
 {% assign cur_year = article.timekey | slice: 0, 4 %}
 {%- unless cur_year == last_year %}
 * {% if cur_year == "0000" %}{{ unsorted }}{% else %}{{ cur_year }}{% endif %}
 :PROPERTIES:
-:HTML_CONTAINER_CLASS: index-year
+{%- if project_type == 'html' %}
+:HTML_CONTAINER_CLASS: index-year{% endif %}
 :UNNUMBERED: notoc
 :END:
 {% assign last_year = cur_year %}
 {% endunless -%}
+{%- if project_type == 'gemini' -%}
+[[{{ article.url }}][{% if article.published != '' %}{{ article.published_gemini_index }} {% endif %}{{ article.title }}]]
+{%- else -%}
 - *[[{{ article.url }}][{{ article.title }}]]*
 {%- if article.published != '' %} / {{ article.published }}{% endif -%}
 {%- if article.excerpt != '' %} \\
-  {{ article.excerpt }}{% endif %}
+  {{ article.excerpt }}{% endif %}{% endif %}
 {%- endfor %}

data/lib/fronde/index/org_generator.rb

@@ -56,6 +56,7 @@ module Fronde
         'title' => title,
         'slug' => slug,
         'project_path' => @project.public_absolute_path,
+        'project_type' => @project.type,
         'domain' => Fronde::CONFIG.get('domain'),
         'lang' => Fronde::CONFIG.get('lang'),
         'author' => Fronde::CONFIG.get('author'),
@@ -81,6 +82,7 @@ module Fronde
         'author' => Fronde::CONFIG.get('author'),
         'domain' => Fronde::CONFIG.get('domain'),
         'project_path' => @project.public_absolute_path,
+        'project_type' => @project.type,
         'indexes' => indexes
       )
     end

data/lib/fronde/index.rb

@@ -30,26 +30,23 @@ module Fronde
 
     def sort_by(kind)
       accepted_values = %i[name weight]
-      if accepted_values.include?(kind)
-        tags_sorted = sort_tags_by_name_and_weight["by_#{kind}".to_sym]
-        # Reverse in order to have most important or A near next prompt
-        # and avoid to scroll to find the beginning of the list.
-        return tags_sorted.map do |tag|
-          @tags_names[tag] + " (#{@index[tag].length})"
-        end.reverse
+      unless accepted_values.include?(kind)
+        error_msg = R18n.t.fronde.error.index.wrong_sort_kind(
+          kind: kind, accepted_values: accepted_values.inspect
+        )
+        raise ArgumentError, error_msg
       end
-      error_msg = R18n.t.fronde.error.index.wrong_sort_kind(
-        kind: kind, accepted_values: accepted_values.inspect
-      )
-      raise ArgumentError, error_msg
+      sort_tags_by_name_and_weight[:"by_#{kind}"].map do |tag|
+        @tags_names[tag] + " (#{@index[tag].length})"
+      end.reverse
+      # Reverse in order to have most important or A near next prompt
+      # and avoid to scroll to find the beginning of the list.
     end
 
     class << self
-      def all_html_blog_index(&block)
+      def all_blog_index(&block)
         all_blogs = CONFIG.sources.filter_map do |project|
-          next unless project['type'] == 'html' && project.blog?
-
-          Index.new(project)
+          Index.new(project) if project.blog?
         end
         return all_blogs unless block
 

data/lib/fronde/org/file.rb

@@ -118,41 +118,53 @@ module Fronde
       #
       # *** Format:
       #
-      # - %a :: the raw author name
+      # - %a :: the raw author name.
       # - %A :: the HTML rendering of the author name, equivalent to
-      #         ~<span class="author">%a</span>~
+      #         ~<span class="author">%a</span>~.
       # - %d :: the ~:short~ date HTML representation, equivalent
-      #         to ~<time datetime="%I">%i</time>~
-      # - %D :: the ~:full~ date and time HTML representation
-      # - %i :: the raw ~:short~ date and time
-      # - %I :: the raw ~:iso8601~ date and time
-      # - %k :: the keywords separated by a comma
-      # - %K :: the HTML list rendering of the keywords
-      # - %l :: the lang of the document
+      #         to ~<time datetime="%I">%i</time>~.
+      # - %D :: the ~:full~ date and time HTML representation.
+      # - %F :: the ~link~ HTML tag for the main Atom feed of the
+      #         current file source.
+      # - %h :: the declared host/domain name, taken from the
+      #         {Fronde::Config#settings}.
+      # - %i :: the raw ~:short~ date and time.
+      # - %I :: the raw ~:iso8601~ date and time.
+      # - %k :: the document keywords separated by commas.
+      # - %K :: the HTML list rendering of the keywords.
+      # - %l :: the lang of the document.
       # - %L :: the license information, taken from the
-      #         {Fronde::Config#settings}
-      # - %n :: the Fronde name and version
-      # - %N :: the Fronde name and version with a link to the project
-      #         home on the name
-      # - %s :: the subtitle of the document
-      # - %t :: the title of the document
-      # - %u :: the URL to the related published HTML document
-      # - %x :: the raw description (eXcerpt)
+      #         {Fronde::Config#settings}.
+      # - %n :: the fronde name and version.
+      # - %N :: the fronde name and version with a link to the project
+      #         home on the name.
+      # - %o :: the theme name (~o~ as in Outfit) of the current file source.
+      # - %s :: the subtitle of the document (from ~#+subtitle:~).
+      # - %t :: the title of the document (from ~#+title:~).
+      # - %u :: the URL to the related published HTML document.
+      # - %x :: the raw description (~x~ as in eXcerpt) of the document
+      #         (from ~#+description:~).
       # - %X :: the description, enclosed in an HTML ~p~ tag, equivalent
-      #         to ~<p>%x</p>~
+      #         to ~<p>%x</p>~.
       #
       # @example
       #     org_file.format("Article written by %a the %d")
       #     => "Article written by Alice Smith the Wednesday 3rd July"
       #
       # @return [String] the given ~string~ after replacement occurs
-      # rubocop:disable Metrics/MethodLength
       # rubocop:disable Layout/LineLength
       def format(string)
+        project_data = @project.to_h
+        # NOTE: The following keycode are reserved by Org itself:
+        #       %a (author), %c (creator), %C (input-file), %d (date),
+        #       %e (email), %s (subtitle), %t (title), %T (timestamp),
+        #       %v (html validation link)
         string.gsub('%a', @data[:author])
               .gsub('%A', "<span class=\"author\">#{@data[:author]}</span>")
               .gsub('%d', @data[:date].l18n_short_date_html)
               .gsub('%D', @data[:date].l18n_long_date_html)
+              .gsub('%F', project_data['atom_feed'] || '')
+              .gsub('%h', project_data['domain'] || '')
               .gsub('%i', @data[:date].l18n_short_date_string)
               .gsub('%I', @data[:date].xmlschema)
               .gsub('%k', @data[:keywords].join(', '))
@@ -161,6 +173,7 @@ module Fronde
               .gsub('%L', Fronde::CONFIG.get('license', '').gsub(/\s+/, ' ').strip)
               .gsub('%n', "Fronde #{Fronde::VERSION}")
               .gsub('%N', "<a href=\"https://git.umaneti.net/fronde/about/\">Fronde</a> #{Fronde::VERSION}")
+              .gsub('%o', project_data['theme'] || '')
               .gsub('%s', @data[:subtitle])
               .gsub('%t', @data[:title])
               .gsub('%u', @data[:url] || '')
@@ -168,7 +181,6 @@ module Fronde
               .gsub('%X', "<p>#{@data[:excerpt]}</p>")
       end
       # rubocop:enable Layout/LineLength
-      # rubocop:enable Metrics/MethodLength
 
       # Writes the current Org::File content to the underlying file.
       #
@@ -215,6 +227,7 @@ module Fronde
         data['published_body'] = extract_published_body
         pub_date = @data[:date]
         data['published'] = pub_date.l18n_long_date_string(with_year: false)
+        data['published_gemini_index'] = pub_date.strftime('%Y-%m-%d')
         data['published_xml'] = pub_date.xmlschema
         data['updated_xml'] = @data[:updated]&.xmlschema
         data
@@ -228,8 +241,10 @@ module Fronde
         else
           source = find_source_for_publication_file
         end
-        warn R18n.t.fronde.error.org_file.no_project(file: @file) unless source
-        source
+        return source if source
+
+        short_file = @file.sub(/^#{Dir.pwd}/, '.')
+        warn R18n.t.fronde.error.org_file.no_project(file: short_file)
       end
 
       def find_source_for_org_file
@@ -250,20 +265,17 @@ module Fronde
       def init_empty_file
         @data = {
           title: @options[:title] || '', subtitle: '', excerpt: '',
-          date: Time.now,
           author: @options[:author] || Fronde::CONFIG.get('author'),
-          keywords: [],
           lang: @options[:lang] || Fronde::CONFIG.get('lang'),
-          pub_file: nil, url: nil
+          date: Time.now, keywords: [], pub_file: nil, url: nil
         }
-        body = @options[:content] || ''
         @data[:content] = @options[:raw_content] || <<~ORG
           #+title: #{@data[:title]}
           #+date: <#{@data[:date].strftime('%Y-%m-%d %a. %H:%M:%S')}>
           #+author: #{@data[:author]}
           #+language: #{@data[:lang]}
 
-          #{body}
+          #{@options[:content]}
         ORG
       end
 

data/lib/fronde/org/file_extracter.rb

@@ -2,6 +2,8 @@
 
 using TimePatch
 
+require_relative '../../ext/time_no_time'
+
 module Fronde
   module Org
     # This module holds extracter methods for the {Fronde::Org::File}
@@ -14,7 +16,7 @@ module Fronde
       def extract_data
         @data = { content: ::File.read(@file), pub_file: nil, url: nil }
         %i[title subtitle date author keywords lang excerpt].each do |param|
-          @data[param] = send("extract_#{param}".to_sym)
+          @data[param] = send(:"extract_#{param}")
         end
         return unless @project
 
@@ -29,22 +31,19 @@ module Fronde
         match = daterx.match(@data[:content])
         return NilTime.new if match.nil?
 
-        notime = match[2].nil?
-        if notime
-          time = '00:00:00'
-        else
-          time = "#{match[2]}:#{match[3] || '00'}"
-        end
-        date = Time.strptime("#{match[1]} #{time}", '%Y-%m-%d %H:%M:%S')
-        date.no_time = notime
-        date
+        return TimeNoTime.parse_no_time(match[1]) if match[2].nil?
+
+        Time.strptime(
+          "#{match[1]} #{match[2]}:#{match[3] || '00'}",
+          '%Y-%m-%d %H:%M:%S'
+        )
       end
 
       def extract_title
         match = /^#\+title:(.+)$/i.match(@data[:content])
         if match.nil?
           # Avoid to leak absolute path
-          project_relative_path = @file.sub(/^#{Dir.pwd}\//, '')
+          project_relative_path = @file.sub %r{^#{Dir.pwd}/}, ''
           return project_relative_path
         end
         match[1].strip
@@ -81,13 +80,17 @@ module Fronde
         # Always return something, even when not published yet
         return @data[:excerpt] unless pub_file && @project
 
-        project_type = @project['type']
+        project_type = @project.type
         pub_folder = Fronde::CONFIG.get("#{project_type}_public_folder")
         file_name = pub_folder + pub_file
         return @data[:excerpt] unless ::File.exist? file_name
 
         return ::File.read(file_name) if project_type == 'gemini'
 
+        read_html_body file_name
+      end
+
+      def read_html_body(file_name)
         dom = ::File.open(file_name, 'r') { |file| Nokogiri::HTML file }
         body = dom.css('div#content')
         body.css('header').unlink # Remove the main title

data/lib/fronde/org.rb

@@ -55,23 +55,25 @@ module Fronde
       # @param destination [String] where to save the org-mode tarball
       # @return [String] the downloaded org-mode version
       def download(destination = 'var/tmp')
-        # Remove version number in dest file to allow easy rake file
-        # task naming
-        dest_file = ::File.expand_path('org.tar.gz', destination)
         org_last_version = last_version(force: false, cookie_dir: destination)
         tarball = "org-mode-release_#{org_last_version}.tar.gz"
         uri = URI("https://git.savannah.gnu.org/cgit/emacs/org-mode.git/snapshot/#{tarball}")
         # Will crash on purpose if anything goes wrong
         Net::HTTP.start(uri.host) do |http|
-          request = Net::HTTP::Get.new uri
+          fetch_org_tarball http, Net::HTTP::Get.new(uri), destination
+        end
+        org_last_version
+      end
 
-          http.request request do |response|
-            ::File.open(dest_file, 'w') do |io|
-              response.read_body { |chunk| io.write chunk }
-            end
+      def fetch_org_tarball(http, request, destination)
+        # Remove version number in dest file to allow easy rake file
+        # task naming
+        dest_file = ::File.expand_path('org.tar.gz', destination)
+        http.request request do |response|
+          ::File.open(dest_file, 'w') do |io|
+            response.read_body { |chunk| io.write chunk }
           end
         end
-        org_last_version
       end
 
       def make_org_cmd(org_dir, target, verbose: false)

data/lib/fronde/slug.rb

@@ -5,23 +5,50 @@ module Fronde
   module Slug
     class << self
       def slug(title)
-        title.downcase.tr(' ', '-')
+        title.downcase
              .encode('ascii', fallback: ->(k) { translit(k) })
-             .gsub(/[^\w-]/, '').delete_suffix('-')
+             .encode('utf-8') # Convert back to utf-8 string
+             .gsub(/[^\w-]/, '-')
+             .squeeze('-')
+             .delete_suffix('-')
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/MethodLength
       def translit(char)
-        return 'a' if %w[á à â ä ǎ ã å].include?(char)
-        return 'e' if %w[é è ê ë ě ẽ].include?(char)
-        return 'i' if %w[í ì î ï ǐ ĩ].include?(char)
-        return 'o' if %w[ó ò ô ö ǒ õ].include?(char)
-        return 'u' if %w[ú ù û ü ǔ ũ].include?(char)
-        return 'y' if %w[ý ỳ ŷ ÿ ỹ].include?(char)
-        return 'c' if char == 'ç'
-        return 'n' if char == 'ñ'
-
-        '-'
+        case char
+        when 'á', 'à', 'â', 'ä', 'ǎ', 'ã', 'å'
+          'a'
+        when 'é', 'è', 'ê', 'ë', 'ě', 'ẽ', '€'
+          'e'
+        when 'í', 'ì', 'î', 'ï', 'ǐ', 'ĩ'
+          'i'
+        when 'ó', 'ò', 'ô', 'ö', 'ǒ', 'õ', 'ø'
+          'o'
+        when 'ú', 'ù', 'û', 'ü', 'ǔ', 'ũ'
+          'u'
+        when 'ý', 'ỳ', 'ŷ', 'ÿ', 'ỹ'
+          'y'
+        when 'ç', '©', '🄯'
+          'c'
+        when 'ñ'
+          'n'
+        when 'ß'
+          'ss'
+        when 'œ'
+          'oe'
+        when 'æ'
+          'ae'
+        when '®'
+          'r'
+        when '™'
+          'tm'
+        else
+          '-'
+        end
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/fronde/source/gemini.rb

@@ -4,11 +4,6 @@ module Fronde
   class Source
     # Specific settings for Gemini {Fronde::Source}
     class Gemini < Source
-      def blog?
-        # TODO: See how to support blog/indexes with gemini
-        false
-      end
-
       class << self
         def org_default_postamble
           format(

data/lib/fronde/source/html.rb

@@ -40,12 +40,12 @@ module Fronde
         super
       end
 
-      def org_default_options # rubocop:disable Metrics/MethodLength
+      def org_default_options
         defaults = {
           'publishing-function' => 'org-html-publish-to-html',
           'html-head-include-default-style' => 't',
           'html-head-include-scripts' => 't',
-          'html-head' => '{{ atom_feed }}',
+          'html-head' => '%F',
           'html-postamble' => Html.org_default_postamble
         }
         return defaults if @config['theme'] == 'default'
@@ -55,10 +55,10 @@ module Fronde
           'html-head-include-scripts' => 'nil',
           'html-head' => <<~HTMLHEAD
             <link rel="stylesheet" type="text/css" media="screen"
-                  href="{{ domain }}/assets/{{ theme }}/css/style.css">
+                  href="%h/assets/%o/css/style.css">
             <link rel="stylesheet" type="text/css" media="screen"
-                  href="{{ domain }}/assets/{{ theme }}/css/htmlize.css">
-            {{ atom_feed }}
+                  href="%h/assets/%o/css/htmlize.css">
+            %F
           HTMLHEAD
         )
       end

data/lib/fronde/source.rb

@@ -147,7 +147,7 @@ module Fronde
 
     def clean_config
       fill_in_specific_config
-      @config['name'] ||= @config['path'].sub(/^[.~]*\//, '').tr('/.', '-')
+      @config['name'] ||= @config['path'].sub(%r{^[.~]*/}, '').tr('/.', '-')
       @config['title'] ||= @config['path']
       @config['target'] ||= File.basename(@config['path']).delete_prefix '.'
       @config['target'] = '' if @config['target'] == '.'
@@ -168,12 +168,16 @@ module Fronde
     end
 
     def render_heading
-      heading_key = "#{@config['type']}-head"
-      heading = @config.dig 'org-options', heading_key
-      @config['org-options'][heading_key] = \
-        Config::Helpers.render_liquid_template(
-          heading, to_h
-        )
+      %w[head head-extra preamble postamble].each do |kind|
+        heading_key = "#{@config['type']}-#{kind}"
+        heading = @config.dig 'org-options', heading_key
+        next unless heading
+
+        @config['org-options'][heading_key] =
+          heading.gsub('%F', @config['atom_feed'])
+                 .gsub('%h', @config['domain'])
+                 .gsub('%o', @config['theme'])
+      end
     end
 
     def org_project_config
@@ -181,7 +185,8 @@ module Fronde
         'base-directory' => @config['path'],
         'base-extension' => 'org',
         'publishing-directory' => publication_path,
-        'recursive' => @config['recursive']
+        'recursive' => @config['recursive'],
+        'fronde-base-uri' => "#{@config['domain']}#{public_absolute_path}"
       }.merge(@config['org-options'])
       exclude = @config['exclude']
       attributes['exclude'] = exclude if exclude