fronde 0.3.4 → 0.4.0

data/lib/tasks/site.rake

@@ -1,54 +1,92 @@
 # frozen_string_literal: true
 
-require 'fronde/emacs'
-require 'fronde/index'
-require 'fronde/utils'
-require 'fronde/org_file'
-require 'fronde/templater'
+require_relative '../fronde/emacs'
+require_relative '../fronde/index'
+require_relative '../fronde/templater'
+require_relative '../fronde/cli/throbber'
 
 namespace :site do
-  desc 'Generates all index files'
-  task :index do
-    index = Fronde::Index.new
-    if verbose
-      index.write_all
-      next
+  desc 'Build all your projects'
+  task :build, [:force?] => ['var/lib/org-config.el'] do |_, args|
+    args.with_defaults(force?: false)
+    build_index = Thread.new do
+      all_index = Fronde::Index.all_html_blog_index
+      all_index.each do |index|
+        index.write_all_org(verbose: verbose)
+      end
+      Thread.current[:all_indexes] = all_index
     end
-    build = Thread.new do
-      index.write_all(verbose: false)
+    if verbose
+      build_index.join
+    else
+      Fronde::CLI::Throbber.run(
+        build_index, R18n.t.fronde.tasks.site.generating_indexes
+      )
     end
-    Fronde::Utils.throbber(build, 'Generating indexes:')
-    next if index.empty?
-    Fronde::Config.write_org_lisp_config(with_tags: true)
-  end
+    all_indexes = build_index[:all_indexes]
 
-  desc 'Convert and customize all org files'
-  task :build, [:force?] => ['var/lib/org-config.el', :index] do |_, args|
-    args.with_defaults(:force? => false)
-    build_html = Thread.new do
-      rm_r 'var/tmp/timestamps', force: true if args[:force?]
-      Fronde::Emacs.new(verbose: verbose).publish
-    end
     begin
-      Fronde::Utils.throbber(build_html, 'Building:')
+      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 'Aborting'
+      warn R18n.t.fronde.tasks.site.aborting
       next
     end
     # :nocov:
+
+    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
+        end
+        Fronde::CLI::Throbber.run(
+          publish_feed, R18n.t.fronde.tasks.site.publishing_feeds
+        )
+      end
+    end
+
+    next unless Fronde::CONFIG.sources.any? { |source| source.type == 'html' }
+
     customize_html = Thread.new do
-      pubfolder = Fronde::Config.get('public_folder')
+      pubfolder = Fronde::CONFIG.get('html_public_folder')
       Dir["#{pubfolder}/**/*.html"].each do |f|
         Fronde::Templater.customize_output(f)
       end
     end
-    Fronde::Utils.throbber(customize_html, 'Customizing:')
+    Fronde::CLI::Throbber.run(
+      customize_html, R18n.t.fronde.tasks.site.customizing
+    )
+  end
+
+  desc 'Cleanup orphaned published files'
+  task :clean do
+    pubfolder = Fronde::CONFIG.get('html_public_folder')
+    Dir["#{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
+    end
   end
 
   desc 'Start a test server'
   task :preview do
-    require 'fronde/preview'
-    Fronde.start_preview
+    require_relative '../fronde/preview'
+    Fronde::Preview.start
   end
 end

data/lib/tasks/sync.rake

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-require 'fronde/config'
-require 'fronde/utils'
+require_relative '../fronde/config'
+require_relative '../fronde/cli/throbber'
 
 module Fronde
-  class SyncError < Error; end
+  class SyncError < ::StandardError; end
 end
 
 def rsync_command(test = nil)
-  rsync_command = Fronde::Config.get('rsync')
+  rsync_command = Fronde::CONFIG.get('rsync')
   return rsync_command unless rsync_command.nil?
+
   optstring = []
   optstring << 'n' if test
   if verbose
@@ -20,37 +21,56 @@ def rsync_command(test = nil)
   "rsync -#{optstring.join}rlt --delete"
 end
 
-def pull_or_push(direction, label, test)
-  unless [:pull, :push].include? direction
-    raise Fronde::SyncError, 'Not a valid direction'
-  end
-  remote_path = Fronde::Config.get('remote')
-  raise Fronde::SyncError, 'No remote path set' if remote_path.nil?
-  public_folder = Fronde::Config.get('public_folder')
+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)
-  publish_thread = Thread.new do
+  Thread.new do
     sh "#{rsync} #{cmd.join(' ')}"
   end
-  Fronde::Utils.throbber(publish_thread, label)
+end
+
+def source_types
+  Fronde::CONFIG.sources.map(&:type).uniq
 end
 
 namespace :sync do
   desc 'Push changes to server'
   task :push, :test? do |_, args|
-    pull_or_push(:push, 'Publishing:', args[:test?])
-  rescue Fronde::SyncError => e
-    warn e
-    next
+    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
+      warn e
+      next
+    end
   end
 
   desc 'Pull changes from server'
   task :pull, :test? do |_, args|
-    pull_or_push(:pull, 'Pulling:', args[:test?])
-  rescue Fronde::SyncError => e
-    warn e
-    next
+    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
+      warn e
+      next
+    end
   end
 end

data/lib/tasks/tags.rake

@@ -1,19 +1,23 @@
 # frozen_string_literal: true
 
-require 'fronde/index'
+require_relative '../fronde/index'
 
 namespace :tags do
   desc 'List all tags by name'
   task :name do
-    index = Fronde::Index.new
-    next if index.empty?
-    puts index.sort_by(:name).join("\n")
+    Fronde::Index.all_html_blog_index do |index|
+      next if index.empty?
+
+      puts index.sort_by(:name).join("\n")
+    end
   end
 
   desc 'List all tags by weight'
   task :weight do
-    index = Fronde::Index.new
-    next if index.empty?
-    puts index.sort_by(:weight).join("\n")
+    Fronde::Index.all_html_blog_index do |index|
+      next if index.empty?
+
+      puts index.sort_by(:weight).join("\n")
+    end
   end
 end

data/locales/en.yml

@@ -2,27 +2,55 @@
 fronde:
   bin:
     usage: 'Usage: fronde %1 [options]'
+    done: done
     commands:
       cmd_title: Commands
-      alias: Alias for %1.
-      init: Initialize your Fronde instance (you just need to do it once).
-      update: Update Fronde dependency (to be run once in a while).
-      preview: 'Start a test web server to preview your website on http://127.0.0.1:5000'
+      alias: Alias for ‘%1’.
+      new: Initialize a new Fronde instance.
+      update: >-
+        Update Fronde configuration and dependency (to be run after each
+        modification of the config.yml file and once in a while to stay
+        up-to-date with Org).
+      preview: Start a test web server to preview the generated website.
       open: Open or create an org file.
-      build: Compile your org files to HTML.
-      publish: Push local changes to your public web server.
+      build: Compile all org files to HTML or gemtext.
+      publish: Push local changes to the public web server.
       help: Alias for the -h switch.
     options:
       cmd_title: Options
-      directory: Wrap the new org file in this named folder.
       help: Display help for a command and exit.
       version: Display Fronde version and exit.
-    error:
-      no_command: 'ERROR: no command or unknown command given.'
-      no_file: 'ERROR: no file to open or edit.'
+      default_title: New article
   error:
-    label: An error occurred.
-    explanation: To see the error, run your command again with more verbosity, for example, fronde build -v
+    bin:
+      label: An error occurred.
+      explanation: >-
+        To see the error, run the same command again with more
+        verbosity, for example, fronde build -v
+      no_command: 'ERROR: no command or unknown command given.'
+      no_file: >-
+        Warning: No file path given. Default file will be used.
+    config:
+      deprecated_public_folder: >-
+        ‘public_folder’ setting is deprecated. Please use either
+        ‘html_public_folder’ or ‘gemini_public_folder’.
+    source:
+      no_path: Skipping %{source} as its ‘path’ key is missing.
+      duplicate: >-
+        Skipping %{source} as it appears at least twice in the sources
+        of type %{type}.
+      inclusion: >-
+        Skipping %{source} as it might be already embedded into the
+        other source %{other_source} of type %{type}.
+    org_file:
+      no_file_or_title: No file or title given.
+      no_project: No project found for %{file}. Publication will fail.
+    index:
+      wrong_sort_kind: '%{kind} not in %{accepted_values}'
+    templater:
+      no_element_found: >-
+        No element found with the selector %{source} in %{file}.
+      no_head_element: No head tag found in file %{file}.
   index:
     unsorted: Unsorted
     published_on: Published on %1
@@ -31,9 +59,27 @@ fronde:
     by_weight: By publication number
     full_date_format: '%A %{date}'
     full_date_with_time_format: '%{date} at %{time}'
+    index_generated: Generated index file for %{tag}.
+    atom_generated: Generated Atom feed for %{tag}.
   org:
+    generate_blog_index: Generating blog home page for %{name}
     postamble:
       written_by: Written by %a
       last_modification: Last modification on %C
-      with_emacs: 'with %c, and published with %n'
-      with_emacs_html: 'with %c, and published with %N'
+      with_emacs: with %c, and published with %n
+      with_emacs_html: with %c, and published with %N
+  tasks:
+    site:
+      aborting: Aborting
+      generating_indexes: 'Generating index files:'
+      building_indexes: 'Building index files:'
+      publishing_feeds: 'Publishing Atom feeds:'
+      building: 'Building:'
+      customizing: 'Customizing:'
+      remove_orphan_file: 'Remove it? [y/N]: '
+    org:
+      downloaded: Org version %{version} has been downloaded.
+      downloading: 'Downloading Org:'
+      no_download: Impossible to download Org now. Please try again later.
+      installed: Org version %{version} has been locally installed.
+      installing: 'Installing Org:'

data/locales/fr.yml

@@ -2,27 +2,61 @@
 fronde:
   bin:
     usage: 'Usage : fronde %1 [options]'
+    done: fait
     commands:
       cmd_title: Commandes
-      alias: Alias pour %1.
-      init: Initialise votre instance de Fronde (vous ne devriez faire cela qu'une fois).
-      update: Met à jour les dépendances de Fronde (à lancer une fois de temps à autre).
-      preview: "Démarre un serveur web de test pour prévisualiser votre site à l'adresse http://127.0.0.1:5000"
+      alias: Alias pour ‘%1’.
+      new: Initialise une nouvelle instance de Fronde.
+      update: >-
+        Met à jour la configuration et les dépendances de Fronde (à
+        lancer après chaque modification du fichier config.yml et une
+        fois de temps à autre pour rester à jour avec Org).
+      preview: >-
+        Démarre un serveur web de test pour prévisualiser le site
+        généré.
       open: Ouvre ou crée un fichier org.
-      build: Compile vos fichiers org en HTML.
-      publish: Pousse vos changements locaux vers votre serveur web public.
+      build: Compile les fichiers org en HTML ou gemtext.
+      publish: >-
+        Pousse les changements locaux vers le serveur web public.
       help: Alias pour l'argument -h.
     options:
       cmd_title: Options
-      directory: Place le nouveau fichier org dans un dossier à ce nom.
       help: Affiche l'aide pour une commande et quitte.
       version: Affiche la version de Fronde et quitte.
-    error:
-      no_command: 'ERREUR : Aucune commande ou commande inconnue donnée.'
-      no_file: 'ERREUR : Aucun fichier à ouvrir ou éditer.'
+      default_title: Nouvel article
   error:
-    label: Une erreur est survenue
-    explanation: Pour voir le détail, lancez de nouveau la commande avec plus de verbosité, par exemple fronde build -v
+    bin:
+      label: Une erreur est survenue
+      explanation: >-
+        Pour voir le détail, lancez de nouveau la commande avec plus de
+        verbosité, par exemple fronde build -v
+      no_command: 'ERREUR : Aucune commande ou commande inconnue donnée.'
+      no_file: >-
+        Attention : Aucun chemin de fichier donné. Utilisation du
+        fichier par défaut.
+    config:
+      deprecated_public_folder: >-
+        La clé de configuration ‘public_folder’ est dépréciée. Merci
+        d’utiliser ‘html_public_folder’ ou ‘gemini_public_folder’ à la
+        place.
+    source:
+      no_path: >-
+        Ignore %{source} comme sa clé ‘path’ est manquante.
+      duplicate: >-
+        Ignore %{source} comme elle apparaît au moins deux fois dans les
+        sources de type %{type}.
+      inclusion: >-
+        Ignore %{source} qui semble être déjà inclue dans l’autre source
+        %{other_source} de type %{type}.
+    org_file:
+      no_file_or_title: Aucun chemin de fichier ou titre donné.
+      no_project: Aucun projet trouvé pour %{file}. Sa publication va échouer.
+    index:
+      wrong_sort_kind: '%{kind} n’est pas dans %{accepted_values}'
+    templater:
+      no_element_found: >-
+        Aucun élément trouvé avec le sélecteur %{source} dans %{file}.
+      no_head_element: Aucun élément head trouvé dans le fichier %{file}.
   index:
     unsorted: Non triés
     published_on: Publié le %1
@@ -31,9 +65,29 @@ fronde:
     by_weight: Par nombre de publication
     full_date_format: '%A %{date}'
     full_date_with_time_format: '%{date} à %{time}'
+    index_generated: Fichier d’index généré pour %{tag}.
+    atom_generated: Flux Atom généré pour %{tag}.
   org:
+    generate_blog_index: Génération de la page d’accueil du blog pour %{name}
     postamble:
       written_by: Écrit par %a
       last_modification: dernière modification le %C
-      with_emacs: 'avec %c et publié avec %n'
-      with_emacs_html: 'avec %c et publié avec %N'
+      with_emacs: avec %c et publié avec %n
+      with_emacs_html: avec %c et publié avec %N
+  tasks:
+    site:
+      aborting: Annulation
+      generating_indexes: 'Génération des fichiers d’index :'
+      building_indexes: 'Compilation des fichiers d’index :'
+      publishing_feeds: 'Publication des flux Atom :'
+      building: 'Compilation :'
+      customizing: 'Décoration :'
+      remove_orphan_file: 'Le supprimer ? [y/N]: '
+    org:
+      downloaded: La version %{version} de Org a été téléchargée.
+      downloading: 'Téléchargement de Org :'
+      no_download: >-
+        Impossible de télécharger Org maintenant. Merci de réessayer
+        plus tard.
+      installed: La version %{version} de Org a été installé localement.
+      installing: 'Installation de Org :'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fronde
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Étienne Deparis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2023-11-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -80,104 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: org-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.56'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.56'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.19'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.19'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.23'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.23'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 description: |
   Fronde helps you to convert Org mode files into websites, giving you
   full control over the publication process.
@@ -189,24 +105,41 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - bin/fronde
+- lib/ext/nil_time.rb
+- lib/ext/r18n.rb
+- lib/ext/time.rb
 - lib/fronde/cli.rb
 - lib/fronde/cli/commands.rb
+- lib/fronde/cli/data/Rakefile
+- lib/fronde/cli/data/config.yml
+- lib/fronde/cli/data/gitignore
+- lib/fronde/cli/data/zsh_completion
+- lib/fronde/cli/helpers.rb
+- lib/fronde/cli/opt_parse.rb
+- lib/fronde/cli/throbber.rb
 - lib/fronde/config.rb
-- lib/fronde/config/lisp_config.rb
-- lib/fronde/config/org-config.el
-- lib/fronde/config/ox-fronde.el
+- lib/fronde/config/data/org-config.el
+- lib/fronde/config/data/ox-fronde.el
+- lib/fronde/config/helpers.rb
+- lib/fronde/config/lisp.rb
 - lib/fronde/emacs.rb
 - lib/fronde/index.rb
 - lib/fronde/index/atom_generator.rb
+- lib/fronde/index/data/all_tags.org
+- lib/fronde/index/data/template.org
+- lib/fronde/index/data/template.xml
 - lib/fronde/index/org_generator.rb
-- lib/fronde/org_file.rb
-- lib/fronde/org_file/class_methods.rb
-- lib/fronde/org_file/extracter.rb
-- lib/fronde/org_file/htmlizer.rb
+- lib/fronde/org.rb
+- lib/fronde/org/file.rb
+- lib/fronde/org/file_extracter.rb
 - lib/fronde/preview.rb
+- lib/fronde/slug.rb
+- lib/fronde/source.rb
+- lib/fronde/source/gemini.rb
+- lib/fronde/source/html.rb
 - lib/fronde/templater.rb
-- lib/fronde/utils.rb
 - lib/fronde/version.rb
+- lib/tasks/cli.rake
 - lib/tasks/org.rake
 - lib/tasks/site.rake
 - lib/tasks/sync.rake
@@ -221,7 +154,16 @@ metadata:
   source_code_uri: https://git.umaneti.net/fronde
   homepage_uri: https://etienne.depar.is/fronde/
   funding_uri: https://liberapay.com/milouse
-post_install_message:
+post_install_message: |+
+  Start your first fronde project with:
+
+      fronde new myproject
+
+  Update your existing projects with:
+
+      fronde update
+      fronde build -f
+
 rdoc_options: []
 require_paths:
 - lib
@@ -236,8 +178,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: An opinionated static website generator for Org
 test_files: []
+...