fronde 0.4.0 → 0.6.0

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
 
@@ -103,6 +82,17 @@ module Fronde
       end
     end
 
+    def warn_no_element(source)
+      public_file = @org_file.pub_file(absolute: true)
+      warn(
+        I18n.t(
+          'fronde.error.templater.no_element_found',
+          source: source, file: public_file.sub(/^#{Dir.pwd}/, '.')
+        )
+      )
+      '' # Return empty string
+    end
+
     def extract_content
       # We must either have a source or a content key
       source = @config.delete 'source'
@@ -111,30 +101,24 @@ module Fronde
       end
 
       node = @dom.css(source)
-      # Do nothing if we don’t have a reliable content to work with
-      unless node.any?
-        warn(
-          R18n.t.fronde.error.templater.no_element_found(
-            source: source,
-            file: Fronde::CONFIG.get('html_public_folder') + @org_file.pub_file
-          )
-        )
-        return ''
+      if node.any?
+        # Put it back in config
+        @config['source'] = node
+        return node.to_s
       end
 
-      @config['source'] = node
-      node.to_s
+      # Do nothing if we don’t have a reliable content to work with
+      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.4.0'
+  VERSION = '0.6.0'
 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

data/lib/tasks/org.rake

@@ -8,10 +8,12 @@ require_relative '../fronde/cli/throbber'
 require 'rake/clean'
 
 CLOBBER.push(
-  'var/lib/org-config.el', '.dir-locals.el',
-  'lib/htmlize.el'
+  'var/lib/org-config.el', 'lib/htmlize.el'
 )
 
+HTMLIZE_TAG = 'release/1.58'
+OX_GMI_TAG = 'v0.2'
+
 namespace :org do
   directory 'var/tmp'
 
@@ -20,54 +22,50 @@ namespace :org do
     # Weird Rake issue, still executing the task even if the file exists
     next if File.exist? 'var/tmp/org.tar.gz'
 
-    download = Thread.new { Fronde::Org.download }
-    if verbose
-      warn R18n.t.fronde.tasks.org.downloaded(version: download.value)
-    else
-      Fronde::CLI::Throbber.run(download, R18n.t.fronde.tasks.org.downloading)
+    download = Thread.new do
+      version = Fronde::Org.download
+      puts I18n.t('fronde.tasks.org.downloaded', version:) if verbose
     end
-  rescue RuntimeError
-    warn R18n.t.fronde.tasks.org.no_download if verbose
+    Fronde::CLI::Throbber.run(
+      download, I18n.t('fronde.tasks.org.downloading'), verbose
+    )
+  rescue RuntimeError, Interrupt
+    warn I18n.t('fronde.tasks.org.no_download') if verbose
   end
 
   desc 'Compile Org'
   multitask compile: ['var/tmp/org.tar.gz', 'lib'] do |task|
-    begin
-      # No need to force fetch last version as it is only interesting as
-      # part of the upgrade task
-      org_version = Fronde::Org.last_version
-    rescue RuntimeError
-      next
-    end
-    org_dir = "lib/org-#{org_version}"
+    # No need to force fetch last version as it is only interesting as
+    # part of the upgrade task
+    version = Fronde::Org.last_version
+
+    org_dir = "lib/org-#{version}"
     next if Dir.exist?("#{org_dir}/lisp")
 
     build = Thread.new do
-      Fronde::Org.compile(
-        task.prerequisites[0], org_version, org_dir, verbose: verbose
-      )
+      Fronde::Org.compile(task.prerequisites[0], version, org_dir, verbose:)
       Dir.glob('lib/org-[0-9.]*').each { rm_r _1 unless _1 == org_dir }
+      puts I18n.t('fronde.tasks.org.installed', version:) if verbose
     end
-    if verbose
-      build.join
-      warn R18n.t.fronde.tasks.org.installed(version: org_version)
-    else
-      Fronde::CLI::Throbber.run(build, R18n.t.fronde.tasks.org.installing)
-    end
+    Fronde::CLI::Throbber.run(
+      build, I18n.t('fronde.tasks.org.installing'), verbose
+    )
+  rescue RuntimeError, Interrupt
+    next
   end
 
   directory 'lib'
 
   file 'lib/htmlize.el' => 'lib' do
     htmlize = URI(
-      'https://raw.githubusercontent.com/hniksic/emacs-htmlize/master/htmlize.el'
+      "https://raw.githubusercontent.com/hniksic/emacs-htmlize/refs/tags/#{HTMLIZE_TAG}/htmlize.el"
     ).open.read
     File.write 'lib/htmlize.el', htmlize
   end
 
   file 'lib/ox-gmi.el' => 'lib' do
     ox_gmi = URI(
-      'https://git.umaneti.net/ox-gmi/plain/ox-gmi.el'
+      "https://git.umaneti.net/ox-gmi/plain/ox-gmi.el?h=#{OX_GMI_TAG}"
     ).open.read
     File.write 'lib/ox-gmi.el', ox_gmi
   end
@@ -76,10 +74,6 @@ namespace :org do
     Fronde::CONFIG.write_org_lisp_config
   end
 
-  file '.dir-locals.el' => 'var/lib/org-config.el' do
-    Fronde::Config::Helpers.write_dir_locals
-  end
-
   file '.gitignore' do
     next if File.exist? '.gitignore'
 
@@ -91,9 +85,10 @@ namespace :org do
 
   desc 'Install Org'
   multitask install: ['org:compile', '.gitignore'] do
-    # I need a fully installed org mode to correctly generate the lisp
-    # config
-    Rake::Task['.dir-locals.el'].invoke
+    # lib/htmlize.el and lib/ox-gmi.el cannot be generated in parallel
+    # of org:compilation, as it will leads to a weird SSL error. Thus
+    # finishing file generation "manually" here.
+    Rake::Task['var/lib/org-config.el'].invoke
     sources = Fronde::CONFIG.sources
     sources.each { mkdir_p _1['path'] }
 

data/lib/tasks/site.rake

@@ -5,82 +5,104 @@ require_relative '../fronde/index'
 require_relative '../fronde/templater'
 require_relative '../fronde/cli/throbber'
 
+def remove_orphan_file_maybe(file_path)
+  print I18n.t('fronde.tasks.site.remove_orphan_file')
+  action = $stdin.gets.strip.downcase
+  return unless action == 'y'
+
+  FileUtils.rm file_path
+end
+
 namespace :site do
   desc 'Build all your projects'
   task :build, [:force?] => ['var/lib/org-config.el'] do |_, args|
     args.with_defaults(force?: false)
+
+    FileUtils.rm_f 'var/tmp/keywords'
     build_index = Thread.new do
-      all_index = Fronde::Index.all_html_blog_index
+      all_index = Fronde::Index.all_blog_index
+      offset = 0
       all_index.each do |index|
-        index.write_all_org(verbose: verbose)
+        index.write_all_org(verbose:)
+        offset = File.write('var/tmp/keywords', index.emacs_keywords, offset)
       end
       Thread.current[:all_indexes] = all_index
     end
-    if verbose
-      build_index.join
-    else
-      Fronde::CLI::Throbber.run(
-        build_index, R18n.t.fronde.tasks.site.generating_indexes
-      )
-    end
+    Fronde::CLI::Throbber.run(
+      build_index, I18n.t('fronde.tasks.site.generating_indexes'), verbose
+    )
     all_indexes = build_index[:all_indexes]
 
-    begin
-      build_html = Thread.new do
-        rm_r 'var/tmp/timestamps', force: true if args[:force?]
-        Fronde::Emacs.new(verbose: verbose).publish
-      end
-      Fronde::CLI::Throbber.run(build_html, R18n.t.fronde.tasks.site.building)
-
-    # :nocov:
-    rescue RuntimeError
-      warn R18n.t.fronde.tasks.site.aborting
-      next
+    build_html = Thread.new do
+      Fronde::Emacs.new(verbose:).publish(force: args[:force?])
     end
-    # :nocov:
-
+    Fronde::CLI::Throbber.run(
+      build_html, I18n.t('fronde.tasks.site.building'), verbose
+    )
     if all_indexes.any?
-      if verbose
-        all_indexes.each(&:write_all_feeds)
-      else
-        publish_feed = Thread.new do
-          all_indexes.each do |index|
-            index.write_all_feeds(verbose: false)
-          end
+      publish_feed = Thread.new do
+        all_indexes.each do |index|
+          index.write_all_feeds(verbose: false)
         end
-        Fronde::CLI::Throbber.run(
-          publish_feed, R18n.t.fronde.tasks.site.publishing_feeds
-        )
       end
+      Fronde::CLI::Throbber.run(
+        publish_feed, I18n.t('fronde.tasks.site.publishing_feeds'), verbose
+      )
     end
 
     next unless Fronde::CONFIG.sources.any? { |source| source.type == 'html' }
 
     customize_html = Thread.new do
       pubfolder = Fronde::CONFIG.get('html_public_folder')
-      Dir["#{pubfolder}/**/*.html"].each do |f|
+      Dir.glob("#{pubfolder}/**/*.html").each do |f|
+        if verbose
+          short_file = f.sub(/^#{Dir.pwd}/, '.')
+          puts I18n.t('fronde.tasks.site.customizing_file', file: short_file)
+        end
         Fronde::Templater.customize_output(f)
       end
     end
     Fronde::CLI::Throbber.run(
-      customize_html, R18n.t.fronde.tasks.site.customizing
+      customize_html, I18n.t('fronde.tasks.site.customizing'), verbose
     )
+    # :nocov:
+  rescue RuntimeError, Interrupt
+    warn I18n.t('fronde.tasks.site.aborting')
+    next
+    # :nocov:
+  end
+
+  desc 'Build a single file'
+  task :build_file, %i[path force?] do |_, args|
+    args.with_defaults(force?: false)
+    Fronde::Emacs.new(verbose: true).publish_file(
+      args[:path], force: args[:force?]
+    )
+    puts I18n.t('fronde.tasks.site.customizing_file', file: args[:path])
+    Fronde::Templater.customize_output(args[:path])
   end
 
   desc 'Cleanup orphaned published files'
   task :clean do
+    Fronde::Index.all_blog_index do |index|
+      project = index.project
+      all_tags = %w[index] + index.all_tags
+      Dir.glob("#{project['path']}/tags/*").each do |file_name|
+        slug = File.basename file_name, '.org'
+        next if all_tags.include?(slug)
+
+        short_file = file_name.sub(/^#{Dir.pwd}/, '.')
+        puts I18n.t('fronde.tasks.site.orphan_tag', file: short_file)
+        remove_orphan_file_maybe file_name
+      end
+    end
     pubfolder = Fronde::CONFIG.get('html_public_folder')
-    Dir["#{pubfolder}/**/*.html"].each do |file_name|
+    Dir.glob("#{pubfolder}/**/*.html").each do |file_name|
       source = Fronde::Org::File.new(file_name)
-
       # Return if an org file has been found for this published file
       next unless source.file == file_name
 
-      print R18n.t.fronde.tasks.site.remove_orphan_file
-      action = $stdin.gets.strip.downcase
-      next unless action == 'y'
-
-      rm file_name
+      remove_orphan_file_maybe file_name
     end
   end
 

data/lib/tasks/sync.rake

@@ -1,40 +1,9 @@
 # frozen_string_literal: true
 
 require_relative '../fronde/config'
+require_relative '../fronde/sync'
 require_relative '../fronde/cli/throbber'
 
-module Fronde
-  class SyncError < ::StandardError; end
-end
-
-def rsync_command(test = nil)
-  rsync_command = Fronde::CONFIG.get('rsync')
-  return rsync_command unless rsync_command.nil?
-
-  optstring = []
-  optstring << 'n' if test
-  if verbose
-    optstring << 'v'
-  else
-    optstring << 'q'
-  end
-  "rsync -#{optstring.join}rlt --delete"
-end
-
-def pull_or_push(direction, type, test)
-  remote_path = Fronde::CONFIG.get("#{type}_remote")
-  raise Fronde::SyncError, "No #{type} remote path set" if remote_path.nil?
-
-  public_folder = Fronde::CONFIG.get("#{type}_public_folder")
-  # Default is to push
-  cmd = ["#{public_folder}/", remote_path]
-  cmd.reverse! if direction == :pull
-  rsync = rsync_command(test)
-  Thread.new do
-    sh "#{rsync} #{cmd.join(' ')}"
-  end
-end
-
 def source_types
   Fronde::CONFIG.sources.map(&:type).uniq
 end
@@ -43,34 +12,34 @@ namespace :sync do
   desc 'Push changes to server'
   task :push, :test? do |_, args|
     source_types.each do |type|
-      publish_thread = pull_or_push(:push, type, args[:test?])
-      if verbose
-        publish_thread.join
-      else
-        Fronde::CLI::Throbber.run(
-          publish_thread, format('Publishing %<fmt>s:', fmt: type)
-        )
-      end
-    rescue Fronde::SyncError => e
+      publish_thread = Fronde::Sync.pull_or_push(
+        :push, type, test: args[:test?], verbose: verbose
+      )
+      Fronde::CLI::Throbber.run(
+        publish_thread, format('Publishing %<fmt>s:', fmt: type), verbose
+      )
+    rescue Fronde::Sync::Error => e
       warn e
       next
     end
+  rescue RuntimeError, Interrupt
+    next
   end
 
   desc 'Pull changes from server'
   task :pull, :test? do |_, args|
     source_types.each do |type|
-      pull_thread = pull_or_push(:pull, type, args[:test?])
-      if verbose
-        pull_thread.join
-      else
-        Fronde::CLI::Throbber.run(
-          pull_thread, format('Pulling %<fmt>s:', fmt: type)
-        )
-      end
-    rescue Fronde::SyncError => e
+      pull_thread = Fronde::Sync.pull_or_push(
+        :pull, type, test: args[:test?], verbose: verbose
+      )
+      Fronde::CLI::Throbber.run(
+        pull_thread, format('Pulling %<fmt>s:', fmt: type), verbose
+      )
+    rescue Fronde::Sync::Error => e
       warn e
       next
     end
+  rescue RuntimeError, Interrupt
+    next
   end
 end

data/lib/tasks/tags.rake

@@ -5,7 +5,7 @@ require_relative '../fronde/index'
 namespace :tags do
   desc 'List all tags by name'
   task :name do
-    Fronde::Index.all_html_blog_index do |index|
+    Fronde::Index.all_blog_index do |index|
       next if index.empty?
 
       puts index.sort_by(:name).join("\n")
@@ -14,7 +14,7 @@ namespace :tags do
 
   desc 'List all tags by weight'
   task :weight do
-    Fronde::Index.all_html_blog_index do |index|
+    Fronde::Index.all_blog_index do |index|
       next if index.empty?
 
       puts index.sort_by(:weight).join("\n")