fronde 0.5.0 → 0.6.1

data/lib/fronde/index.rb

@@ -8,7 +8,7 @@ module Fronde
   # Generates website indexes and atom feeds for all the org documents
   #   keywords.
   class Index
-    attr_reader :date
+    attr_reader :date, :project
 
     def initialize(project)
       @project = project
@@ -31,7 +31,8 @@ module Fronde
     def sort_by(kind)
       accepted_values = %i[name weight]
       unless accepted_values.include?(kind)
-        error_msg = R18n.t.fronde.error.index.wrong_sort_kind(
+        error_msg = I18n.t(
+          'fronde.error.index.wrong_sort_kind',
           kind: kind, accepted_values: accepted_values.inspect
         )
         raise ArgumentError, error_msg
@@ -43,6 +44,10 @@ module Fronde
       # and avoid to scroll to find the beginning of the list.
     end
 
+    def emacs_keywords
+      @tags_names.map { |slug, title| "#{title}\x1f#{slug}" }.join("\x1e")
+    end
+
     class << self
       def all_blog_index(&block)
         all_blogs = CONFIG.sources.filter_map do |project|
@@ -91,7 +96,7 @@ module Fronde
       all_keys = all_tags
       {
         by_name: all_keys.sort,
-        by_weight: all_keys.sort_by { @index[_1].length }.reverse
+        by_weight: all_keys.sort_by { [-@index[_1].length, _1] }
       }
     end
   end

data/lib/fronde/org/file.rb

@@ -109,6 +109,21 @@ module Fronde
         @data[:date].strftime('%Y%m%d%H%M%S')
       end
 
+      # Returns the path to the published version of this document.
+      #
+      # By default, this method returns the relative path to the published
+      # file. If the ~absolute~ argument is true, it will return the absolute
+      # path to the published file.
+      #
+      # @param absolute [Boolean] whether to display absolute or relative
+      #   published file path (default false)
+      # @return [String] the document key
+      def pub_file(absolute: false)
+        return @data[:pub_file] unless absolute
+
+        "#{@project['folder']}#{@data[:pub_file]}"
+      end
+
       # Formats given ~string~ with values of the current Org::File.
       #
       # This method expects to find percent-tags in the given ~string~
@@ -151,6 +166,7 @@ module Fronde
       #     org_file.format("Article written by %a the %d")
       #     => "Article written by Alice Smith the Wednesday 3rd July"
       #
+      # @param string [String] the template text to edit
       # @return [String] the given ~string~ after replacement occurs
       # rubocop:disable Layout/LineLength
       def format(string)
@@ -159,13 +175,18 @@ module Fronde
         #       %a (author), %c (creator), %C (input-file), %d (date),
         #       %e (email), %s (subtitle), %t (title), %T (timestamp),
         #       %v (html validation link)
+        localized_dates = I18n.with_locale(@data[:lang]) do
+          { short: @data[:date].l18n_short_date_string,
+            short_html: @data[:date].l18n_short_date_html,
+            long_html: @data[:date].l18n_long_date_html }
+        end
         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('%d', localized_dates[:short_html])
+              .gsub('%D', localized_dates[:long_html])
               .gsub('%F', project_data['atom_feed'] || '')
               .gsub('%h', project_data['domain'] || '')
-              .gsub('%i', @data[:date].l18n_short_date_string)
+              .gsub('%i', localized_dates[:short])
               .gsub('%I', @data[:date].xmlschema)
               .gsub('%k', @data[:keywords].join(', '))
               .gsub('%K', keywords_to_html)
@@ -191,18 +212,17 @@ module Fronde
       def write
         if ::File.directory? @file
           if @data[:title] == ''
-            raise R18n.t.fronde.error.org_file.no_file_or_title
+            raise I18n.t('fronde.error.org_file.no_file_or_title')
           end
 
           @file = ::File.join @file, "#{Slug.slug(@data[:title])}.org"
         else
-          file_dir = ::File.dirname @file
-          FileUtils.mkdir_p file_dir
+          FileUtils.mkdir_p ::File.dirname(@file)
         end
         ::File.write @file, @data[:content]
       end
 
-      def method_missing(method_name, *args, &block)
+      def method_missing(method_name, *args, &)
         reader_method = method_name.to_s.delete_suffix('=').to_sym
         if @data.has_key? reader_method
           return @data[reader_method] if reader_method == method_name
@@ -222,11 +242,13 @@ module Fronde
       end
 
       def to_h
-        fields = %w[author excerpt keywords timekey title url]
+        fields = %w[author excerpt keywords lang timekey title url]
         data = fields.to_h { |key| [key, send(key)] }
         data['published_body'] = extract_published_body
         pub_date = @data[:date]
-        data['published'] = pub_date.l18n_long_date_string(with_year: false)
+        data['published'] = I18n.with_locale(@data[:lang]) do
+          pub_date.l18n_long_date_no_year_string
+        end
         data['published_gemini_index'] = pub_date.strftime('%Y-%m-%d')
         data['published_xml'] = pub_date.xmlschema
         data['updated_xml'] = @data[:updated]&.xmlschema
@@ -244,13 +266,11 @@ module Fronde
         return source if source
 
         short_file = @file.sub(/^#{Dir.pwd}/, '.')
-        warn R18n.t.fronde.error.org_file.no_project(file: short_file)
+        warn I18n.t('fronde.error.org_file.no_project', file: short_file)
       end
 
       def find_source_for_org_file
-        Fronde::CONFIG.sources.find do |project|
-          project.source_for? @file
-        end
+        Fronde::CONFIG.sources.find { _1.source_for? @file }
       end
 
       def find_source_for_publication_file

data/lib/fronde/org/file_extracter.rb

@@ -20,11 +20,19 @@ module Fronde
         end
         return unless @project
 
+        warn_if_dangerous_code_block
         @data[:updated] = ::File.mtime(@file)
         @data[:pub_file] = @project.target_for @file
         @data[:url] = Fronde::CONFIG.get('domain') + @data[:pub_file]
       end
 
+      def warn_if_dangerous_code_block
+        code_block_rx = /^#\+begin_src.+:exports (?:results|both).*$/i
+        return unless code_block_rx.match?(@data[:content])
+
+        warn I18n.t('fronde.error.org_file.dangerous_code_block', file: @file)
+      end
+
       def extract_date
         timerx = '([0-9:]{5})(?::([0-9]{2}))?'
         daterx = /^#\+date: *<([0-9-]{10}) [\w.]+(?: #{timerx})?> *$/i

data/lib/fronde/org.rb

@@ -10,7 +10,7 @@ module Fronde
     class << self
       def current_version
         # Do not crash if Org is not yet installed (and thus return nil)
-        Dir['lib/org-*'].first&.delete_prefix('lib/org-')
+        Dir.glob('lib/org-*').first&.delete_prefix('lib/org-')
       end
 
       # Fetch and return the last published version of Org.
@@ -97,8 +97,8 @@ module Fronde
         FileUtils.mv "org-mode-release_#{version}", target
         # Fix a weird unknown package version
         ::File.write("#{target}/mk/version.mk", "ORGVERSION ?= #{version}")
-        system(*make_org_cmd(target, 'compile', verbose: verbose))
-        system(*make_org_cmd(target, 'autoloads', verbose: verbose))
+        system(*make_org_cmd(target, 'compile', verbose:))
+        system(*make_org_cmd(target, 'autoloads', verbose:))
       end
     end
   end

data/lib/fronde/source/gemini.rb

@@ -8,9 +8,9 @@ module Fronde
         def org_default_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
+            author: I18n.t('fronde.org.postamble.written_by'),
+            creator: I18n.t('fronde.org.postamble.with_emacs'),
+            date: I18n.t('fronde.org.postamble.last_modification')
           )
         end
       end
@@ -20,7 +20,7 @@ module Fronde
       def fill_in_specific_config
         @config.merge!(
           'type' => 'gemini', 'ext' => '.gmi', 'mime_type' => 'text/gemini',
-          'folder' => CONFIG.get('gemini_public_folder')
+          'folder' => File.expand_path(CONFIG.get('gemini_public_folder'))
         )
       end
 

data/lib/fronde/source/html.rb

@@ -13,9 +13,9 @@ module Fronde
       class << self
         def org_default_postamble
           <<~POSTAMBLE
-            <p><span class="author">#{R18n.t.fronde.org.postamble.written_by}</span>
-            #{R18n.t.fronde.org.postamble.with_emacs_html}</p>
-            <p class="date">#{R18n.t.fronde.org.postamble.last_modification}</p>
+            <p><span class="author">#{I18n.t('fronde.org.postamble.written_by')}</span>
+            #{I18n.t('fronde.org.postamble.with_emacs_html')}</p>
+            <p class="date">#{I18n.t('fronde.org.postamble.last_modification')}</p>
             <p class="validation">%v</p>
           POSTAMBLE
         end
@@ -26,7 +26,7 @@ module Fronde
       def fill_in_specific_config
         @config.merge!(
           'type' => 'html', 'ext' => '.html', 'mime_type' => 'text/html',
-          'folder' => CONFIG.get('html_public_folder')
+          'folder' => File.expand_path(CONFIG.get('html_public_folder'))
         )
       end
 

data/lib/fronde/source.rb

@@ -58,11 +58,11 @@ module Fronde
     def source_for(file_name)
       relative_file_path = file_name.delete_prefix "#{publication_path}/"
       # file_name does not begin with source path.
-      return nil if relative_file_path == file_name
+      return if relative_file_path == file_name
 
       # Looks like a file at a deeper level, but current source is not
       # recursive.
-      return nil if relative_file_path.include?('/') && !recursive?
+      return if relative_file_path.include?('/') && !recursive?
 
       # Looks like a match. But does a source file for this one actually
       # exists?
@@ -70,7 +70,7 @@ module Fronde
         /#{@config['ext']}\z/, '.org'
       )
       source_path = File.join(@config['path'], relative_source_path)
-      return nil unless File.file?(source_path)
+      return unless File.file?(source_path)
 
       source_path
     end
@@ -111,7 +111,7 @@ module Fronde
     def publication_path
       return @config['publication_path'] if @config['publication_path']
 
-      publish_in = [File.expand_path(@config['folder']), @config['target']]
+      publish_in = [@config['folder'], @config['target']]
       @config['publication_path'] = publish_in.join('/').delete_suffix('/')
     end
 

data/lib/fronde/sync/neocities.rb

@@ -35,7 +35,7 @@ module Fronde
 
       def local_list
         Dir.chdir(@public_folder) do
-          Dir['**/*'].map { |file| neocities_stat(file) }
+          Dir.glob('**/*').map { |file| neocities_stat(file) }
         end
       end
 
@@ -52,19 +52,19 @@ module Fronde
         file_list = remote_list
         finish
         orphans = select_orphans(file_list, local_list) do |path|
-          warn "deleting #{path}" if @verbose
+          puts I18n.t('fronde.neocities.deleting', path:) if @verbose
 
           "#{@public_folder}/#{path}"
         end
         File.unlink(*orphans) unless test
-        download_all file_list, test: test
+        download_all(file_list, test:)
         nil # Mute this method
       end
 
       def push(test: false)
         file_list = local_list
-        remove_remote_orphans file_list, test: test
-        upload_all file_list, test: test
+        remove_remote_orphans(file_list, test:)
+        upload_all(file_list, test:)
         finish
       end
 
@@ -84,10 +84,10 @@ module Fronde
         data
       end
 
-      def select_orphans(to_apply, current_list, &block)
+      def select_orphans(to_apply, current_list, &)
         paths_to_apply = to_apply.map { _1['path'] }
         current_paths = current_list.map { _1['path'] }
-        (current_paths - paths_to_apply).filter_map(&block)
+        (current_paths - paths_to_apply).filter_map(&)
       end
 
       def remove_remote_orphans(file_list, test: false)
@@ -98,7 +98,7 @@ module Fronde
           # the index.html file to be removed.
           next if PROTECTED_FILES.include? path
 
-          warn "deleting #{path}" if @verbose
+          puts I18n.t('fronde.neocities.deleting', path:) if @verbose
           path
         end
         request.form_data = { 'filenames[]' => orphan_paths }
@@ -114,7 +114,7 @@ module Fronde
             file_list.each do |file_data|
               path = file_data['path']
               file_data['uri'] = "https://#{publish_domain}/#{path}"
-              download_file http, file_data, test: test
+              download_file http, file_data, test:
             end
           end
         end
@@ -123,12 +123,12 @@ module Fronde
       def download_file(http, file_data, test: false)
         path = file_data['path']
         if file_data['is_directory']
-          warn "#{path}/" if @verbose
+          puts "#{path}/" if @verbose
           FileUtils.mkdir_p path unless test
           return
         end
 
-        warn path if @verbose
+        puts path if @verbose
 
         content = fetch_file_content(
           http, file_data['uri'], file_data['sha1_hash']
@@ -146,7 +146,7 @@ module Fronde
         check = Digest::SHA1.hexdigest content
         return content if check == sha1sum
 
-        warn "SHA1 hash differ for #{uri}"
+        warn I18n.t('fronde.neocities.sha1_differ', uri:)
       end
 
       def save_file(path, content, updated_at)
@@ -163,7 +163,7 @@ module Fronde
             next if file_data['is_directory']
 
             path = file_data['path']
-            warn path if @verbose
+            puts path if @verbose
             [path, File.new(path)]
           end
         end

data/lib/fronde/sync/rsync.rb

@@ -13,17 +13,17 @@ module Fronde
       end
 
       def pull(test: false)
-        run command(test: test) + [@remote_path, @local_path]
+        run command(test:) + [@remote_path, @local_path]
       end
 
       def push(test: false)
-        run command(test: test) + [@local_path, @remote_path]
+        run command(test:) + [@local_path, @remote_path]
       end
 
       private
 
       def run(cmd)
-        warn cmd.join(' ') if @verbose
+        puts cmd.join(' ') if @verbose
         # Be precise about Kernel to allow mock in rspec
         Kernel.system(*cmd)
       end

data/lib/fronde/sync.rb

@@ -25,8 +25,8 @@ module Fronde
       method, remote_path = extract_method_and_remote type
       public_folder = Fronde::CONFIG.get("#{type}_public_folder")
       klass = Kernel.const_get("::Fronde::Sync::#{method.capitalize}")
-      syncer = klass.new(remote_path, public_folder, verbose: verbose)
-      Thread.new { syncer.send(direction, test: test) }
+      syncer = klass.new(remote_path, public_folder, verbose:)
+      Thread.new { syncer.send(direction, test:) }
     end
   end
 end

data/lib/fronde/templater.rb

@@ -5,8 +5,6 @@ require 'digest/md5'
 require_relative 'org/file'
 
 module Fronde
-  class NoHeadError < ::StandardError; end
-
   # Insert custom part inside generated HTML files.
   class Templater
     def initialize(source, dom, config = {})
@@ -19,74 +17,55 @@ module Fronde
 
     def apply
       # Flag the file for this template
-      head = @dom.xpath('//head').first
-      raise NoHeadError, self unless head
-
-      head.prepend_child("<!--#{@config['check_line']}-->")
+      html = @dom.xpath('//html').first
+      html.add_child("<!--#{@config['check_line']}-->\n")
       content = @org_file.format extract_content
       # Remove source element if necessary to avoid doubling it during
       # the insert action
       @config['source'].unlink if @config.has_key? 'source'
       # Insert new content
-      @dom.css(@config['selector']).each do |element|
+      @dom.css(@config['selector']).map do |element|
         insert_new_node_at element, content
       end
     end
 
-    def in_head?
-      @dom.xpath('//head').children.any? do |child|
+    def applied?
+      @dom.xpath('//html').children.any? do |child|
         next false unless child.comment?
 
         child.text == @config['check_line']
       end
     end
 
-    def valid?(file_name)
+    def valid?
       return false unless @config.has_key?('selector')
 
       unless @config.has_key?('content') || @config.has_key?('source')
         return false
       end
 
-      check_path(file_name)
+      check_path
     end
 
     class << self
       def customize_output(file_name)
-        source = Fronde::Org::File.new(file_name)
+        source = Fronde::Org::File.new file_name
         # Return if no org file found for this published file
-        return if source.file.end_with?(file_name)
+        return unless source.pub_file
 
-        dom = open_dom(file_name)
-        updated = apply_templates(source, dom, file_name)
-        write_dom(file_name, dom) if updated
+        apply_templates source
       end
 
-      private
-
-      def apply_templates(source, dom, file_name)
-        Fronde::CONFIG.get('templates', []).map do |config|
+      def apply_templates(source)
+        public_file = source.pub_file absolute: true
+        dom = File.open(public_file, 'r') { Nokogiri::HTML _1 }
+        changes = Fronde::CONFIG.get('templates', []).map do |config|
           template = Fronde::Templater.new(source, dom, config)
-          next if !template.valid?(file_name) || template.in_head?
+          next if !template.valid? || template.applied?
 
           template.apply
-          true
-        rescue NoHeadError
-          warn R18n.t.fronde.error.templater.no_head_element(file: file_name)
-          next
-        end.any?
-      end
-
-      def open_dom(file_name)
-        File.open(file_name, 'r') do |file|
-          Nokogiri::HTML file
-        end
-      end
-
-      def write_dom(file_name, dom)
-        File.open(file_name, 'w') do |file|
-          dom.write_to file
         end
+        File.open(public_file, 'w') { dom.write_to _1 } if changes.any?
       end
     end
 
@@ -104,12 +83,11 @@ module Fronde
     end
 
     def warn_no_element(source)
-      pub_folder = Fronde::CONFIG.get('html_public_folder').sub(
-        /^#{Dir.pwd}/, '.'
-      )
+      public_file = @org_file.pub_file(absolute: true)
       warn(
-        R18n.t.fronde.error.templater.no_element_found(
-          source: source, file: "#{pub_folder}#{@org_file.pub_file}"
+        I18n.t(
+          'fronde.error.templater.no_element_found',
+          source: source, file: public_file.sub(/^#{Dir.pwd}/, '.')
         )
       )
       '' # Return empty string
@@ -133,15 +111,14 @@ module Fronde
       warn_no_element source
     end
 
-    def check_path(file_name)
+    def check_path
       paths = @config['path']
       return true unless paths
 
       paths = [paths] unless paths.is_a? Array
 
-      pub_folder = Fronde::CONFIG.get('html_public_folder')
       paths.any? do |template_path|
-        File.fnmatch?("#{pub_folder}#{template_path}", file_name)
+        File.fnmatch?(template_path, @org_file.pub_file)
       end
     end
   end

data/lib/fronde/version.rb

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

data/lib/tasks/cli.rake

@@ -2,6 +2,24 @@
 
 require_relative '../fronde/cli/opt_parse'
 
+def comp_opt_to_liquid(option, command)
+  opt_config = Fronde::CLI::OptParse::FRONDE_OPTIONS[option]
+  keyword = nil
+  unless opt_config[:boolean]
+    keyword = opt_config[:keyword] || opt_config[:long].upcase
+  end
+  {
+    'command' => command,
+    'short' => option,
+    'short_no_dash' => option.delete_prefix('-'),
+    'long' => "--#{opt_config[:long]}",
+    'long_no_dash' => opt_config[:long],
+    'keyword' => keyword,
+    'choices' => opt_config[:choices],
+    'help' => opt_config[:help]
+  }
+end
+
 namespace :cli do
   desc 'Generate an autocomplete file for zsh'
   task :zsh_complete do
@@ -10,24 +28,38 @@ namespace :cli do
     data['commands'] = all_commands.filter_map do |command, options|
       next if options[:alias] || command == 'basic'
 
-      opts = (options[:opts] || []).map do |opt|
-        opt_config = Fronde::CLI::OptParse::FRONDE_OPTIONS[opt]
-        keyword = nil
-        unless opt_config[:boolean]
-          keyword = opt_config[:keyword] || opt_config[:long].upcase
-        end
-        { 'short' => opt,
-          'long' => "--#{opt_config[:long]}",
-          'keyword' => keyword }
-      end
-
-      translation = R18n.t.fronde.bin.commands[command].tr("'", '’')
+      opts = (options[:opts] || []).map { comp_opt_to_liquid(_1, command) }
       { 'name' => command,
-        'translation' => translation,
+        'translation' => I18n.t("fronde.bin.commands.#{command}"),
         'options' => opts }
     end
     source = File.expand_path '../fronde/cli/data/zsh_completion', __dir__
     template = Liquid::Template.parse(File.read(source))
     puts template.render(data)
   end
+
+  desc 'Generate an autocomplete file for fish'
+  task :fish_complete do
+    data = { 'commands' => [], 'details' => [] }
+    all_commands = []
+    Fronde::CLI::OptParse::FRONDE_COMMANDS.each do |command, options|
+      next if options[:alias]
+
+      data['details'] += (options[:opts] || []).map do |opt|
+        comp_opt_to_liquid opt, command
+      end
+      next if command == 'basic'
+
+      data['commands'] << command
+
+      help = I18n.t("fronde.bin.commands.#{command}")
+      all_commands << "#{command}\\t'#{help}'"
+    end
+
+    data['comcomp'] = all_commands.join('\n')
+
+    source = File.expand_path '../fronde/cli/data/fish_completion', __dir__
+    template = Liquid::Template.parse(File.read(source))
+    puts template.render(data)
+  end
 end