fronde 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 160fe641b74b790fc6446fa97854ebc9aba8dcd4aef50d7651510c8f6b92d63f
-  data.tar.gz: aefb09d2cd99c6b10d9e281934799e4821023da5404ff09fb1558b9632c22649
+  metadata.gz: 59daab21a7ef37010f30971994ebda28af2c212528205e43c2dae18abe6c510f
+  data.tar.gz: 89fda0a99813459bdbd2291c91aebe44d3a6c2fb3a6faf4742b7e7036191e5e8
 SHA512:
-  metadata.gz: 2c68e67d4adadd0f06a21526f1a6f5b13d8d9e7eabfe67861eff3823c8283da9cba88b728aa7fa00178d45ed81479bc124e2cc727f051b33cec3cf57dc94d448
-  data.tar.gz: 6f9325d21dd7491e0c83c6d12a03b7b0d755dd9afebf5dc241ec6a40f40e2b5c8c93648d0da9c4020d0d30d4adb74a2eb6b8db580223b3844a6fd622b3a50184
+  metadata.gz: de60c2c6254acbe48846e3af209106aeb1f7058a604491e27bbeef1bf32b2c78d1d17e320d47168f086b046ad368b888a5b6933eddf56b7f4471c824c6acaa14
+  data.tar.gz: 62f6c65db410960e4395bcbbff9bb1918886dfdb9a1c0b9c8f8871f61c285160c1a3edca901619b674b93bce80ba1cc45ce2de6ce74195c4c0f5a72292db1d70

data/bin/fronde

@@ -8,7 +8,7 @@ require 'fronde/version'
 require 'fronde/cli'
 
 R18n.default_places = File.expand_path('../locales', __dir__)
-R18n.set Fronde::Config.settings['lang']
+R18n.set Fronde::Config.get('lang')
 
 optparser = OptionParser.new
 optparser.version = Fronde::VERSION
@@ -38,7 +38,7 @@ if params[:help] || cmd_err
 end
 ARGV.shift
 
-init_cmds = [:fronde_init, :fronde_config]
+init_cmds = [:fronde_init, :fronde_config, :fronde_update]
 unless File.exist?('config.yml') || init_cmds.include?(command)
   fronde.fronde_init
 end

data/lib/fronde/cli/commands.rb

@@ -3,18 +3,21 @@
 module Fronde
   # Fronde commands
   module CLICommands
+    def fronde_update
+      update_config
+      @rake.options.build_all = true
+      @rake.invoke_task('org:upgrade')
+    end
+    alias_method :fronde_config, :fronde_update
+
     def fronde_init
-      cnf = @options.merge
-      cnf.delete(:verbose)
-      cnf.transform_keys!(&:to_s)
-      Fronde::Config.save(Fronde::Config.settings.merge(cnf))
+      update_config
       @rake.options.build_all = true
       @rake.invoke_task('org:install')
       return if File.exist? 'src/index.org'
       Fronde::OrgFile.new('src/index.org', @options).write
       fronde_open 'src/index.org'
     end
-    alias_method :fronde_config, :fronde_init
 
     def fronde_build
       @rake.options.build_all = true
@@ -26,7 +29,7 @@ module Fronde
     def fronde_preview
       Thread.new do
         sleep 1
-        port = Fronde::Config.settings.dig('preview', 'server_port') || 5000
+        port = Fronde::Config.get(['preview', 'server_port'], 5000)
         uri = "http://127.0.0.1:#{port}/"
         current_os = Fronde::Utils.current_os
         case current_os
@@ -62,10 +65,10 @@ module Fronde
 
     def fronde_help(command = 'basic', error: false)
       warn R18n.t.fronde.bin.error.no_command if error
-      cmd = Fronde::Utils.resolve_possible_alias(command)
-      cmd_opt = Fronde::Utils::FRONDE_COMMANDS[cmd]
+      cmd_opt = Fronde::Utils.command_options(command)
       label = cmd_opt[:label] || command
       warn format("%<label>s\n\n", label: R18n.t.fronde.bin.usage(label))
+      cmd = cmd_opt[:name] || command
       if R18n.t.fronde.bin.commands[cmd].translated?
         warn format("%<label>s\n\n", label: R18n.t.fronde.bin.commands[cmd])
       end
@@ -76,6 +79,13 @@ module Fronde
 
     private
 
+    def update_config
+      cnf = @options.merge
+      cnf.delete(:verbose)
+      cnf.transform_keys!(&:to_s)
+      Fronde::Config.save(Fronde::Config.settings.merge(cnf))
+    end
+
     def new_file_name(file_path)
       file_path = File.expand_path(file_path || '')
       return file_path if file_path[-4..] == '.org'

data/lib/fronde/cli.rb

@@ -36,14 +36,14 @@ module Fronde
 
         fronde_spec = Gem::Specification.find_by_name 'fronde'
         R18n.default_places = "\#{fronde_spec.gem_dir}/locales"
-        R18n.set(Fronde::Config.settings['lang'] || 'en')
+        R18n.set(Fronde::Config.get('lang', 'en'))
         R18n::Filters.on(:named_variables)
 
         Dir.glob("\#{fronde_spec.gem_dir}/lib/tasks/*.rake").each { |r| import r }
 
         task default: 'site:build'
       RAKE
-      IO.write 'Rakefile', rakefile
+      File.write 'Rakefile', rakefile
     end
 
     def init_gitignore
@@ -54,7 +54,7 @@ module Fronde
         public_html
         var
       GITIGNORE
-      IO.write '.gitignore', gitignore
+      File.write '.gitignore', gitignore
     end
   end
 end

data/lib/fronde/config/lisp_config.rb

@@ -4,6 +4,20 @@ require 'json'
 require 'open-uri'
 require 'fronde/version'
 
+def fetch_org_version
+  # Retrieve last org version from git repository tags page.
+  tag_rx = Regexp.new(
+    '<a href=\'/cgit/emacs/org-mode.git/tag/\?h=' \
+    '(?<tag>release_(?<number>[^\']+))\'>\k<tag></a>'
+  )
+  versions = URI(
+    'https://git.savannah.gnu.org/cgit/emacs/org-mode.git/refs/'
+  ).open.readlines.map do |line|
+    line.match(tag_rx) { |matchdata| matchdata[:number] }
+  end
+  versions.compact.first
+end
+
 module Fronde
   # This module contains utilitary methods to ease ~org-config.el~
   # file generation
@@ -14,15 +28,12 @@ module Fronde
     def org_last_version
       return @org_version if @org_version
       if File.exist?('var/tmp/last_org_version')
-        @org_version = IO.read('var/tmp/last_org_version')
+        @org_version = File.read('var/tmp/last_org_version')
         return @org_version
       end
-      versions = JSON.parse(
-        URI('https://updates.orgmode.org/data/releases').open.read
-      ).sort { |a, b| b['date'] <=> a['date'] }
-      @org_version = versions.first['version']
+      @org_version = fetch_org_version
       FileUtils.mkdir_p 'var/tmp'
-      IO.write('var/tmp/last_org_version', @org_version)
+      File.write('var/tmp/last_org_version', @org_version)
       @org_version
     end
 
@@ -33,24 +44,29 @@ module Fronde
     # existed already.
     #
     # @return [Integer] the length written (as returned by the
-    #   underlying ~IO.write~ method call)
+    #   underlying ~File.write~ method call)
+    # rubocop:disable Metrics/MethodLength
     def write_org_lisp_config(with_tags: false)
       projects = org_generate_projects(with_tags: with_tags)
       workdir = Dir.pwd
-      content = IO.read(File.expand_path('./org-config.el', __dir__))
-                  .gsub('__VERSION__', Fronde::VERSION)
-                  .gsub('__WORK_DIR__', workdir)
-                  .gsub('__FRONDE_DIR__', __dir__)
-                  .gsub('__ORG_VER__', org_last_version)
-                  .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)
-                  .gsub('__AUTHOR_EMAIL__', settings['author_email'] || '')
-                  .gsub('__AUTHOR_NAME__', settings['author'])
+      content = File.read(File.expand_path('./org-config.el', __dir__))
+                    .gsub('__VERSION__', Fronde::VERSION)
+                    .gsub('__WORK_DIR__', workdir)
+                    .gsub('__FRONDE_DIR__', __dir__)
+                    .gsub('__ORG_VER__', org_last_version)
+                    .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)
+                    .gsub('__AUTHOR_EMAIL__', get('author_email', ''))
+                    .gsub('__AUTHOR_NAME__', get('author'))
       FileUtils.mkdir_p "#{workdir}/var/lib"
-      IO.write("#{workdir}/var/lib/org-config.el", content)
+      File.write("#{workdir}/var/lib/org-config.el", content)
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Generate emacs directory variables file.
     #
@@ -59,11 +75,11 @@ module Fronde
     # of this fronde instance.
     #
     # @return [Integer] the length written (as returned by the
-    #   underlying ~IO.write~ method call)
+    #   underlying ~File.write~ method call)
     def write_dir_locals
       workdir = Dir.pwd
       # rubocop:disable Layout/LineLength
-      IO.write(
+      File.write(
         "#{workdir}/.dir-locals.el",
         "((org-mode . ((eval . (load-file \"#{workdir}/var/lib/org-config.el\")))))"
       )
@@ -93,12 +109,10 @@ module Fronde
       names = projects.keys.map do |p|
         ["\"#{p}\"", "\"#{p}-assets\""]
       end.flatten
-      unless settings['theme'] == 'default'
-        names << "\"theme-#{settings['theme']}\""
-      end
+      names << "\"theme-#{get('theme')}\"" unless get('theme') == 'default'
       sources.each do |s|
         # Default theme defined in settings is already included
-        next unless s['theme'] && s['theme'] != settings['theme']
+        next unless s['theme'] && s['theme'] != get('theme')
         # Never include theme named 'default' as it does not rely on any
         # file to export.
         next if s['theme'] == 'default'
@@ -118,9 +132,9 @@ module Fronde
     def publication_path(project)
       publish_in = [Dir.pwd]
       if project['type'] == 'gemini'
-        publish_in << (settings['gemini_public_folder'] || 'public_gmi')
+        publish_in << get('gemini_public_folder', 'public_gmi')
       else
-        publish_in << settings['public_folder']
+        publish_in << get('public_folder')
       end
       publish_in << project['target'] unless project['target'] == '.'
       publish_in.join('/')
@@ -187,7 +201,7 @@ module Fronde
         'html-head-include-default-style' => 't',
         'html-head-include-scripts' => 't'
       }
-      curtheme = project['theme'] || settings['theme']
+      curtheme = project['theme'] || get('theme')
       return defaults if curtheme.nil? || curtheme == 'default'
       defaults['html-head'] = org_default_html_head
       defaults['html-head-include-default-style'] = 'nil'
@@ -205,7 +219,7 @@ module Fronde
       else
         defaults.merge!(
           org_default_html_options(project),
-          settings['org-html'] || {},
+          get('org-html', {}),
           project['org-html'] || {}
         )
       end
@@ -213,14 +227,14 @@ module Fronde
     end
 
     def expand_vars_in_html_head(head, project)
-      curtheme = project['theme'] || settings['theme']
+      curtheme = project['theme'] || get('theme')
       # Head may be frozen when coming from settings
       head = head.gsub('__THEME__', curtheme)
-                 .gsub('__DOMAIN__', settings['domain'])
+                 .gsub('__DOMAIN__', get('domain'))
       return head.gsub('__ATOM_FEED__', '') unless project['is_blog']
       atomfeed = <<~ATOMFEED
         <link rel="alternate" type="application/atom+xml" title="Atom 1.0"
-              href="#{settings['domain']}/feeds/index.xml" />
+              href="#{get('domain')}/feeds/index.xml" />
       ATOMFEED
       head.gsub('__ATOM_FEED__', atomfeed)
     end
@@ -261,7 +275,7 @@ module Fronde
     end
 
     def org_default_theme_config
-      theme_config = org_theme_config(settings['theme'])
+      theme_config = org_theme_config(get('theme'))
       return theme_config if theme_config == ''
       format("\n        %<conf>s", conf: theme_config)
     end
@@ -278,7 +292,7 @@ module Fronde
         # rubocop:enable Layout/LineLength
         ' :recursive t',
         format(' :publishing-directory "%<wd>s/%<pub>s/assets/%<theme>s"',
-               wd: workdir, pub: settings['public_folder'], theme: theme),
+               wd: workdir, pub: get('public_folder'), theme: theme),
         ' :publishing-function org-publish-attachment)'
       ].join("\n        ").strip
     end

data/lib/fronde/config.rb

@@ -24,7 +24,7 @@ module Fronde
   # Settings will be available like this:
   #
   # #+begin_src
-  # Fronde::Config.settings['author']
+  # Fronde::Config.get('author')
   # => "Alice Doe"
   # #+end_src
   class Config
@@ -33,15 +33,38 @@ module Fronde
     class << self
       # Access the current website settings
       #
-      # If the settings have not been loaded yet, this method is
-      # responsible for calling the one, which actually loads them.
+      # If necessary, this method will load settings from a config
+      # file.
       #
       # @return [Hash] the website settings
       def settings
-        return load_settings unless @config
+        load_settings
         @config
       end
 
+      # Return a named setting.
+      #
+      # ~setting~ may be a ~String~ or an ~Array~.
+      #
+      # If the given ~setting~ name is an Array, this method will
+      # behave as ~Hash::dig~.
+      #
+      # If no value is found for the given setting, ~default~ will be
+      # returned.
+      #
+      # @param setting [String, Array] the setting to get
+      # @param default the default value to use if ~setting~ is absent
+      # @return the setting value or nil
+      def get(setting, default = nil)
+        load_settings
+        if setting.is_a? Array
+          value = @config.dig(*setting)
+        else
+          value = @config[setting]
+        end
+        value || default
+      end
+
       # Save the settings given as a parameter to the ~config.yml~ file.
       #
       # Not only this method overwrite the old settings, but it replace
@@ -58,25 +81,42 @@ module Fronde
         # which may be different from a system to another. Thus it may
         # be confusing if one use fronde on two different computer and
         # these params always change.
+        default_keys = default_settings.keys
         new_config.delete_if do |k, v|
-          ['domain', 'public_folder', 'templates', 'theme'].include?(k) \
-          && v == default_settings[k]
+          default_keys.include?(k) && v == default_settings[k]
         end
-        IO.write 'config.yml', new_config.to_yaml
+        File.write 'config.yml', new_config.to_yaml
+        @config = @sources = nil
         load_settings # Reload config, taking default settings into account
       end
 
+      # Reset settings
+      #
+      # This method is handy for testing purpose. Next call to
+      # {file:Fronde/Config.html#get-class_method get} or
+      # {file:Fronde/Config.html#settings-class_method settings} will
+      # force reload the settings from the config file
+      #
+      # @return nil
+      def reset
+        @sources = @config = nil
+      end
+
       # Load the given settings as if they comes from the ~config.yml~ file.
       #
-      # This method is handy for testing purpose. Later call to
+      # This method is handy for testing purpose. Next call to
+      # {file:Fronde/Config.html#get-class_method get},
+      # {file:Fronde/Config.html#sources-class_method sources} or
       # {file:Fronde/Config.html#settings-class_method settings} will
       # use these new settings.
       #
       # @param config [Hash] the settings to artificially load
       # @return [Hash] the new settings
       def load_test(config)
-        @sources = nil # Reset sources
+        reset
         @config = default_settings.merge config
+        sources
+        @config
       end
 
       # Return the qualified projects sources list.
@@ -84,8 +124,9 @@ module Fronde
       # @return [Array] the fully qualified projects sources list
       def sources
         return @sources if @sources
+        load_settings
         default_sources = [{ 'path' => 'src', 'target' => '.' }]
-        @sources = (settings['sources'] || default_sources).map do |s|
+        @sources = get('sources', default_sources).map do |s|
           build_source(s)
         end.compact
       end
@@ -93,7 +134,7 @@ module Fronde
       private
 
       def load_settings
-        @sources = nil
+        return @config if @config
         conf_file = 'config.yml'
         if File.exist? conf_file
           @config = default_settings.merge(YAML.load_file(conf_file)).freeze

data/lib/fronde/emacs.rb

@@ -24,7 +24,7 @@ module Fronde
     private
 
     def emacs_command(*arguments)
-      default_emacs = Fronde::Config.settings['emacs']
+      default_emacs = Fronde::Config.get('emacs')
       emacs_cmd = [
         default_emacs || 'emacs -Q --batch -nw',
         '--eval \'(setq enable-dir-local-variables nil)\''

data/lib/fronde/index/atom_generator.rb

@@ -19,7 +19,7 @@ module Fronde
       slug = Fronde::OrgFile.slug index_name
       FileUtils.mkdir_p "#{@pubdir}/feeds"
       atomdest = "#{@pubdir}/feeds/#{slug}.xml"
-      IO.write(atomdest, to_atom(index_name))
+      File.write(atomdest, to_atom(index_name))
     end
 
     private
@@ -29,13 +29,12 @@ module Fronde
     # @param title [String] the title of the current atom feed
     # @return [String] the Atom header as a String
     def atom_header(title)
-      domain = Fronde::Config.settings['domain']
+      domain = Fronde::Config.get('domain')
       upddate = @date.rfc3339
       if title == 'index'
         slug = 'index'
         tagurl = domain
-        title = Fronde::Config.settings['title'] || \
-                R18n.t.fronde.index.all_tags
+        title = Fronde::Config.get('title', R18n.t.fronde.index.all_tags)
       else
         slug = Fronde::OrgFile.slug(title)
         tagurl = "#{domain}/tags/#{slug}.html"
@@ -47,13 +46,13 @@ module Fronde
         <feed xmlns="http://www.w3.org/2005/Atom"
               xmlns:dc="http://purl.org/dc/elements/1.1/"
               xmlns:wfw="http://wellformedweb.org/CommentAPI/"
-              xml:lang="#{Fronde::Config.settings['lang']}">
+              xml:lang="#{Fronde::Config.get('lang')}">
 
         <title>#{title}</title>
         <link href="#{domain}/feeds/#{slug}.xml" rel="self" type="application/atom+xml"/>
         <link href="#{tagurl}" rel="alternate" type="text/html" title="#{title}"/>
         <updated>#{upddate}</updated>
-        <author><name>#{Fronde::Config.settings['author'] || ''}</name></author>
+        <author><name>#{Fronde::Config.get('author', '')}</name></author>
         <id>urn:md5:#{Digest::MD5.hexdigest(domain)}</id>
         <generator uri="https://git.umaneti.net/fronde/about/">Fronde</generator>
       ENDATOM

data/lib/fronde/index/org_generator.rb

@@ -18,7 +18,7 @@ module Fronde
       FileUtils.mkdir 'tags' unless Dir.exist? 'tags'
       content = to_org index_name
       orgdest = "tags/#{slug}.org"
-      IO.write(orgdest, content)
+      File.write(orgdest, content)
     end
 
     private
@@ -37,7 +37,7 @@ module Fronde
         next unless Dir.exist?(project['path'])
         warn "Generated blog home for #{project['name']}" if verbose
         orgdest = format('%<root>s/index.org', root: project['path'])
-        IO.write(orgdest, to_org(project['name'], is_project: true))
+        File.write(orgdest, to_org(project['name'], is_project: true))
       end
     end
 
@@ -57,7 +57,7 @@ module Fronde
     end
 
     def tag_published_url(tag_name)
-      domain = Fronde::Config.settings['domain']
+      domain = Fronde::Config.get('domain')
       title = @tags_names[tag_name]
       tag_link = "#{domain}/tags/#{tag_name}.html"
       "[[#{tag_link}][#{title}]]"
@@ -67,12 +67,12 @@ module Fronde
       if is_tag
         title = @tags_names[title]
       elsif title.nil? || title == 'index'
-        title = Fronde::Config.settings['title']
+        title = Fronde::Config.get('title')
       end
       <<~HEADER.strip
         #+title: #{title}
-        #+author: #{Fronde::Config.settings['author']}
-        #+language: #{Fronde::Config.settings['lang']}
+        #+author: #{Fronde::Config.get('author')}
+        #+language: #{Fronde::Config.get('lang')}
       HEADER
     end
 

data/lib/fronde/index.rb

@@ -17,7 +17,7 @@ module Fronde
     include Fronde::IndexOrgGenerator
 
     def initialize
-      @pubdir = Fronde::Config.settings['public_folder']
+      @pubdir = Fronde::Config.get('public_folder')
       @index = { 'index' => [] }
       @projects = {}
       @tags_names = {}

data/lib/fronde/org_file/class_methods.rb

@@ -6,7 +6,7 @@ module Fronde
     def source_for_target(file_name)
       # file_name may be frozen...
       src = file_name.sub(/\.html\z/, '.org')
-      pubfolder = Fronde::Config.settings['public_folder']
+      pubfolder = Fronde::Config.get('public_folder')
       src.sub!(/^#{pubfolder}\//, '')
       # Look for match in each possible sources. The first found wins.
       Fronde::Config.sources.each do |project|
@@ -36,7 +36,7 @@ module Fronde
         target = "#{project['target']}/#{target}" if project['target'] != '.'
       end
       return target unless with_public_folder
-      pubfolder = Fronde::Config.settings['public_folder']
+      pubfolder = Fronde::Config.get('public_folder')
       "#{pubfolder}/#{target}"
     end
 

data/lib/fronde/org_file/extracter.rb

@@ -8,7 +8,7 @@ module Fronde
     # Main method, which will call the other to initialize an
     #   {Fronde::OrgFile} instance.
     def extract_data
-      @content = IO.read @file
+      @content = File.read @file
       @title = extract_title
       @subtitle = extract_subtitle
       @date = extract_date
@@ -49,7 +49,7 @@ module Fronde
 
     def extract_author
       m = /^#\+author:(.+)$/i.match(@content)
-      return Fronde::Config.settings['author'] if m.nil?
+      return Fronde::Config.get('author') if m.nil?
       m[1].strip
     end
 
@@ -61,7 +61,7 @@ module Fronde
 
     def extract_lang
       m = /^#\+language:(.+)$/i.match(@content)
-      return Fronde::Config.settings['lang'] if m.nil?
+      return Fronde::Config.get('lang') if m.nil?
       m[1].strip
     end
 

data/lib/fronde/org_file/htmlizer.rb

@@ -13,7 +13,7 @@ module Fronde
     #
     # @return [String] the HTML keywords list
     def keywords_to_html
-      domain = Fronde::Config.settings['domain']
+      domain = Fronde::Config.get('domain')
       klist = @keywords.map do |k|
         <<~KEYWORDLINK
           <li class="keyword">

data/lib/fronde/org_file.rb

@@ -15,7 +15,7 @@ module Fronde
   # This class is responsible for reading or writing existing or new org
   # files, and formating their content to be used on the generated
   # website.
-  class OrgFile
+  class OrgFile # rubocop:disable Metrics/ClassLength
     # @return [String] the title of the current org document, taken from
     #   the ~#+title:~ header.
     attr_reader :title
@@ -240,7 +240,7 @@ module Fronde
             .gsub('%k', @keywords.join(', '))
             .gsub('%K', keywords_to_html)
             .gsub('%l', @lang)
-            .gsub('%L', (Fronde::Config.settings['license'] || '').gsub(/\s+/, ' ').strip)
+            .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('%s', @subtitle)
@@ -257,12 +257,12 @@ module Fronde
     # The intermediate parent folders are created if necessary.
     #
     # @return [Integer] the length written (as returned by the
-    #   underlying ~IO.write~ method call)
+    #   underlying ~File.write~ method call)
     def write
       raise TypeError, 'no conversion from nil file name to path.' if @file.nil?
       file_dir = File.dirname @file
       FileUtils.mkdir_p file_dir unless Dir.exist? file_dir
-      IO.write @file, @content
+      File.write @file, @content
     end
 
     private
@@ -272,7 +272,7 @@ module Fronde
       @html_file = Fronde::OrgFile.target_for_source(
         @file, @project, with_public_folder: false
       )
-      @url = "#{Fronde::Config.settings['domain']}/#{@html_file}"
+      @url = "#{Fronde::Config.get('domain')}/#{@html_file}"
     end
 
     def init_empty_file
@@ -280,9 +280,9 @@ module Fronde
       @subtitle = ''
       @date = DateTime.now
       @notime = false
-      @author = @options[:author] || Fronde::Config.settings['author']
+      @author = @options[:author] || Fronde::Config.get('author')
       @keywords = []
-      @lang = @options[:lang] || Fronde::Config.settings['lang']
+      @lang = @options[:lang] || Fronde::Config.get('lang')
       @excerpt = ''
       body = @options[:content] || ''
       @content = @options[:raw_content] || <<~ORG

data/lib/fronde/preview.rb

@@ -19,9 +19,9 @@ module Fronde # rubocop:disable Style/Documentation
     private
 
     def local_path(requested_path)
-      routes = Fronde::Config.settings.dig('preview', 'routes') || {}
+      routes = Fronde::Config.get(['preview', 'routes'], {})
       return routes[requested_path] if routes.has_key? requested_path
-      local_path = Fronde::Config.settings['public_folder'] + requested_path
+      local_path = Fronde::Config.get('public_folder') + requested_path
       if File.directory? local_path
         local_path = format(
           '%<path>s/index.html', path: local_path.delete_suffix('/')
@@ -32,9 +32,9 @@ module Fronde # rubocop:disable Style/Documentation
     end
 
     def parse_body(local_path, local_host)
-      body = IO.read local_path
+      body = File.read local_path
       return body unless local_path.match?(/\.(?:ht|x)ml\z/)
-      domain = Fronde::Config.settings['domain']
+      domain = Fronde::Config.get('domain')
       return body if domain == ''
       body.gsub(/"file:\/\//, format('"%<host>s', host: local_host))
           .gsub(/"#{domain}/, format('"%<host>s', host: local_host))
@@ -45,7 +45,7 @@ module Fronde # rubocop:disable Style/Documentation
     def start_preview
       # Inspired by ruby un.rb library, which allows normally to start a
       # webrick server in one line: ruby -run -e httpd public_html -p 5000
-      port = Fronde::Config.settings.dig('preview', 'server_port') || 5000
+      port = Fronde::Config.get(['preview', 'server_port'], 5000)
       s = WEBrick::HTTPServer.new(Port: port)
       s.mount '/', Fronde::PreviewServlet
       ['TERM', 'QUIT', 'INT'].each { |sig| trap(sig, proc { s.shutdown }) }

data/lib/fronde/templater.rb

@@ -52,7 +52,7 @@ module Fronde
       private
 
       def filter_templates(file_name)
-        templates = Fronde::Config.settings['templates']
+        templates = Fronde::Config.get('templates')
         return [] if templates.nil? || templates.empty?
         templates.filter { |t| check_required_keys(t, file_name) }
       end
@@ -71,7 +71,7 @@ module Fronde
       end
 
       def check_path(file_name, pathes)
-        pub_folder = Fronde::Config.settings['public_folder']
+        pub_folder = Fronde::Config.get('public_folder')
         if pathes.is_a?(Array)
           pathes.each do |tp|
             return true if File.fnmatch?("#{pub_folder}#{tp}",

data/lib/fronde/utils.rb

@@ -7,6 +7,9 @@ require 'r18n-core'
 require 'fronde/config'
 
 module Fronde
+  # Default Error, which may be raised by fronde code
+  class Error < ::StandardError; end
+
   # Embeds usefull methods, mainly used in rake tasks.
   module Utils
     # @return [Hash] the possible throbber themes
@@ -38,7 +41,8 @@ module Fronde
     #   configuration
     FRONDE_COMMANDS = {
       'init' => { opts: ['-a', '-h', '-l', '-t', '-v'] },
-      'config' => { alias: 'init' },
+      'update' => { opts: ['-a', '-h', '-l', '-t', '-v'] },
+      'config' => { alias: 'update' },
       'preview' => { opts: ['-h'] },
       'open' => { opts: ['-a', '-h', '-l', '-t', '-v'] },
       'edit' => { alias: 'open' },
@@ -144,6 +148,17 @@ module Fronde
         command
       end
 
+      # Returns the given command options.
+      #
+      # This method will first try to resolve command alias, if any.
+      #
+      # @param command [String] the command, which options should be returned
+      # @return [Hash] the command options
+      def command_options(command)
+        cmd = resolve_possible_alias command
+        FRONDE_COMMANDS[cmd].merge(name: cmd)
+      end
+
       # Try to discover the current host operating system.
       #
       # @return [String] either apple, windows or linux (default)

data/lib/fronde/version.rb

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

data/lib/tasks/org.rake

@@ -12,12 +12,19 @@ CLOBBER.push(
   'var/lib/org-config.el', '.dir-locals.el', 'lib/htmlize.el'
 )
 
+def make_org_cmd(org_dir, target)
+  make = ['make', '-C', org_dir, target]
+  return make.join(' ') if verbose
+  make.insert(3, '-s')
+  make << 'EMACSQ="emacs -Q --eval \'(setq inhibit-message t)\'"'
+  make.join(' ')
+end
+
 namespace :org do
   directory 'var/tmp'
 
   desc 'Download last version of Org'
   file 'var/tmp/org.tar.gz' => 'var/tmp' do
-    verbose = Rake::FileUtilsExt.verbose_flag
     download = Thread.new do
       Thread.current[:org_version] = Fronde::Config.org_last_version
       Fronde::Utils.download_org
@@ -32,20 +39,14 @@ namespace :org do
 
   desc 'Compile Org'
   task compile: 'var/tmp/org.tar.gz' do |task|
-    verbose = Rake::FileUtilsExt.verbose_flag
     org_version = Fronde::Config.org_last_version
     org_dir = "lib/org-#{org_version}"
     next if Dir.exist?("#{org_dir}/lisp")
-    make = ['make', '-C', org_dir]
-    unless verbose
-      make << '-s'
-      make << 'EMACSQ="emacs -Q --eval \'(setq inhibit-message t)\'"'
-    end
     build = Thread.new do
       sh "tar -C lib -xzf #{task.prerequisites[0]}"
       mv "lib/org-mode-release_#{org_version}", org_dir
-      sh((make + ['compile']).join(' '))
-      sh((make + ['autoloads']).join(' '))
+      sh make_org_cmd(org_dir, 'compile')
+      sh make_org_cmd(org_dir, 'autoloads')
       Dir.glob('lib/org-[0-9.]*').each do |ov|
         next if ov == org_dir
         rm_r ov
@@ -65,14 +66,14 @@ namespace :org do
     htmlize = URI(
       'https://raw.githubusercontent.com/hniksic/emacs-htmlize/master/htmlize.el'
     ).open.read
-    IO.write 'lib/htmlize.el', htmlize
+    File.write 'lib/htmlize.el', htmlize
   end
 
   file 'lib/ox-gmi.el' => 'lib' do
     ox_gmi = URI(
-      'https://git.umaneti.net/ox-gmi.el/plain/ox-gmi.el'
+      'https://git.umaneti.net/ox-gmi/plain/ox-gmi.el'
     ).open.read
-    IO.write 'lib/ox-gmi.el', ox_gmi
+    File.write 'lib/ox-gmi.el', ox_gmi
   end
 
   file 'var/lib/org-config.el' => ['lib/htmlize.el', 'lib/ox-gmi.el'] do
@@ -85,7 +86,7 @@ namespace :org do
 
   desc 'Install Org'
   multitask install: ['org:compile', '.dir-locals.el'] do
-    mkdir_p "#{Fronde::Config.settings['public_folder']}/assets"
+    mkdir_p "#{Fronde::Config.get('public_folder')}/assets"
     Fronde::Config.sources.each do |s|
       mkdir_p s['path'] unless Dir.exist? s['path']
     end

data/lib/tasks/site.rake

@@ -10,7 +10,6 @@ namespace :site do
   desc 'Generates all index files'
   task :index do
     index = Fronde::Index.new
-    verbose = Rake::FileUtilsExt.verbose_flag
     if verbose
       index.write_all
       next
@@ -28,7 +27,7 @@ namespace :site do
     args.with_defaults(:force? => false)
     build_html = Thread.new do
       rm_r 'var/tmp/timestamps', force: true if args[:force?]
-      Fronde::Emacs.new(verbose: Rake::FileUtilsExt.verbose_flag).publish
+      Fronde::Emacs.new(verbose: verbose).publish
     end
     begin
       Fronde::Utils.throbber(build_html, 'Building:')
@@ -39,7 +38,7 @@ namespace :site do
     end
     # :nocov:
     customize_html = Thread.new do
-      pubfolder = Fronde::Config.settings['public_folder']
+      pubfolder = Fronde::Config.get('public_folder')
       Dir["#{pubfolder}/**/*.html"].each do |f|
         Fronde::Templater.customize_output(f)
       end

data/lib/tasks/sync.rake

@@ -3,8 +3,12 @@
 require 'fronde/config'
 require 'fronde/utils'
 
-def rsync_command(verbose, test = nil)
-  rsync_command = Fronde::Config.settings['rsync']
+module Fronde
+  class SyncError < Error; 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
@@ -16,19 +20,37 @@ def rsync_command(verbose, 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')
+  # Default is to push
+  cmd = ["#{public_folder}/", remote_path]
+  cmd.reverse! if direction == :pull
+  rsync = rsync_command(test)
+  publish_thread = Thread.new do
+    sh "#{rsync} #{cmd.join(' ')}"
+  end
+  Fronde::Utils.throbber(publish_thread, label)
+end
+
 namespace :sync do
-  desc 'Push change to server'
+  desc 'Push changes to server'
   task :push, :test? do |_, args|
-    remote_path = Fronde::Config.settings['remote']
-    if remote_path.nil?
-      warn 'No remote path set'
-      next
-    end
-    public_folder = Fronde::Config.settings['public_folder']
-    publish_thread = Thread.new do
-      sh [rsync_command(Rake::FileUtilsExt.verbose_flag, args[:test?]),
-          "#{public_folder}/", remote_path].join(' ')
-    end
-    Fronde::Utils.throbber(publish_thread, 'Publishing:')
+    pull_or_push(:push, 'Publishing:', args[:test?])
+  rescue Fronde::SyncError => e
+    warn e
+    next
+  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
   end
 end

data/locales/en.yml

@@ -6,6 +6,7 @@ fronde:
       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'
       open: Open or create an org file.
       build: Compile your org files to HTML.

data/locales/fr.yml

@@ -6,6 +6,7 @@ fronde:
       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"
       open: Ouvre ou crée un fichier org.
       build: Compile vos fichiers org en HTML.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fronde
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Étienne Deparis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: r18n-core
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: org-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -108,104 +94,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.56'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.56'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.23'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -258,7 +216,11 @@ files:
 homepage: https://git.umaneti.net/fronde/about/
 licenses:
 - WTFPL
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://git.umaneti.net/fronde
+  homepage_uri: https://etienne.depar.is/fronde/
+  funding_uri: https://liberapay.com/milouse
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -274,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: An opinionated static website generator for Org