fronde 0.4.0 → 0.6.0

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

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

data/lib/fronde/source/gemini.rb

@@ -4,18 +4,13 @@ module Fronde
   class Source
     # Specific settings for Gemini {Fronde::Source}
     class Gemini < Source
-      def blog?
-        # TODO: See how to support blog/indexes with gemini
-        false
-      end
-
       class << self
         def org_default_postamble
           format(
             "📅 %<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
@@ -25,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
 
@@ -40,12 +40,12 @@ module Fronde
         super
       end
 
-      def org_default_options # rubocop:disable Metrics/MethodLength
+      def org_default_options
         defaults = {
           'publishing-function' => 'org-html-publish-to-html',
           'html-head-include-default-style' => 't',
           'html-head-include-scripts' => 't',
-          'html-head' => '{{ atom_feed }}',
+          'html-head' => '%F',
           'html-postamble' => Html.org_default_postamble
         }
         return defaults if @config['theme'] == 'default'
@@ -55,10 +55,10 @@ module Fronde
           'html-head-include-scripts' => 'nil',
           'html-head' => <<~HTMLHEAD
             <link rel="stylesheet" type="text/css" media="screen"
-                  href="{{ domain }}/assets/{{ theme }}/css/style.css">
+                  href="%h/assets/%o/css/style.css">
             <link rel="stylesheet" type="text/css" media="screen"
-                  href="{{ domain }}/assets/{{ theme }}/css/htmlize.css">
-            {{ atom_feed }}
+                  href="%h/assets/%o/css/htmlize.css">
+            %F
           HTMLHEAD
         )
       end

data/lib/fronde/source.rb

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

data/lib/fronde/sync/neocities.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'time'
+require 'yaml'
+require 'net/http'
+require 'fileutils'
+require 'digest/sha1'
+
+module Fronde
+  module Sync
+    # Everything needed to connect to neocities
+    class Neocities
+      PROTECTED_FILES = %w[index.html neocities.png not_found.html].freeze
+
+      def initialize(connection_spec, public_folder, verbose: false, &block)
+        @verbose = verbose
+        @endpoint = @website_name = @authorization = nil
+        extract_connection_details connection_spec
+        @public_folder = public_folder
+        @connection = init_connection
+        return unless block
+
+        yield self
+        finish
+      end
+
+      def remote_list
+        remote = call build_request('/list')
+        JSON.parse(remote.body)['files'].map do |stat|
+          stat['updated_at'] = Time.parse(stat['updated_at'])
+          stat
+        end
+      end
+
+      def local_list
+        Dir.chdir(@public_folder) do
+          Dir.glob('**/*').map { |file| neocities_stat(file) }
+        end
+      end
+
+      def info
+        info = call build_request('/info')
+        JSON.parse(info.body)['info']
+      end
+
+      def finish
+        @connection.finish if @connection.started?
+      end
+
+      def pull(test: false)
+        file_list = remote_list
+        finish
+        orphans = select_orphans(file_list, local_list) do |path|
+          puts I18n.t('fronde.neocities.deleting', path:) if @verbose
+
+          "#{@public_folder}/#{path}"
+        end
+        File.unlink(*orphans) unless 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:)
+        upload_all(file_list, test:)
+        finish
+      end
+
+      private
+
+      def neocities_stat(file)
+        stat = File.stat(file)
+        data = {
+          'path' => file,
+          'is_directory' => stat.directory?,
+          'updated_at' => stat.mtime.round.utc
+        }
+        return data if data['is_directory']
+
+        data['size'] = stat.size
+        data['sha1_hash'] = Digest::SHA1.hexdigest File.read(file)
+        data
+      end
+
+      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(&)
+      end
+
+      def remove_remote_orphans(file_list, test: false)
+        request = build_request '/delete', :post
+        orphan_paths = select_orphans(file_list, remote_list) do |path|
+          # Never remove the following files. If needed you can still
+          # overwrite them. And in any case, neocities will not allow
+          # the index.html file to be removed.
+          next if PROTECTED_FILES.include? path
+
+          puts I18n.t('fronde.neocities.deleting', path:) if @verbose
+          path
+        end
+        request.form_data = { 'filenames[]' => orphan_paths }
+        return if test
+
+        call request
+      end
+
+      def download_all(file_list, test: false)
+        publish_domain = "#{@website_name}.#{@endpoint.host}"
+        Dir.chdir(@public_folder) do
+          Net::HTTP.start(publish_domain, use_ssl: true) do |http|
+            file_list.each do |file_data|
+              path = file_data['path']
+              file_data['uri'] = "https://#{publish_domain}/#{path}"
+              download_file http, file_data, test:
+            end
+          end
+        end
+      end
+
+      def download_file(http, file_data, test: false)
+        path = file_data['path']
+        if file_data['is_directory']
+          puts "#{path}/" if @verbose
+          FileUtils.mkdir_p path unless test
+          return
+        end
+
+        puts path if @verbose
+
+        content = fetch_file_content(
+          http, file_data['uri'], file_data['sha1_hash']
+        )
+        return unless content && !test
+
+        save_file path, content, file_data['updated_at']
+      end
+
+      def fetch_file_content(http, uri, sha1sum)
+        # Neocities redirect HTML file to location without extension and
+        # redirect index.html file to /
+        uri = uri.delete_suffix('index.html').delete_suffix('.html')
+        content = http.get(uri).body
+        check = Digest::SHA1.hexdigest content
+        return content if check == sha1sum
+
+        warn I18n.t('fronde.neocities.sha1_differ', uri:)
+      end
+
+      def save_file(path, content, updated_at)
+        File.write path, content
+        FileUtils.touch path, mtime: updated_at
+        path
+      end
+
+      def prepare_files_to_upload(file_list)
+        Dir.chdir(@public_folder) do
+          file_list.filter_map do |file_data|
+            # No need to push intermediary directories, they are created
+            # on the fly
+            next if file_data['is_directory']
+
+            path = file_data['path']
+            puts path if @verbose
+            [path, File.new(path)]
+          end
+        end
+      end
+
+      def upload_all(file_list, test: false)
+        form_data = prepare_files_to_upload file_list
+        return if test
+
+        request = build_request '/upload', :post
+        request.set_form form_data, 'multipart/form-data'
+        call request
+      end
+
+      def extract_connection_details(connection_spec)
+        # Do not put your password into the fronde config. The password
+        # is expectfed to be found in a specific config file (not to be
+        # shared).
+        @website_name, endpoint = connection_spec.split('@', 2)
+        endpoint ||= 'neocities.org'
+        @endpoint = URI("https://#{endpoint}/api")
+        # Will raise Errno::ENOENT if file does not exist
+        credentials = YAML.load_file('.credentials')
+        # Will raise KeyError if not set
+        password = credentials.fetch("#{@website_name}_neocities_pass")
+        authorization = [[@website_name, password].join(':')].pack('m0')
+        @authorization = "Basic #{authorization}"
+      end
+
+      def build_request(path, method = :get)
+        uri = @endpoint.dup
+        uri.path += path
+        klass = Kernel.const_get "Net::HTTP::#{method.to_s.capitalize}"
+        klass.new uri
+      end
+
+      def call(request)
+        request['Authorization'] = @authorization
+        @connection.start unless @connection.started?
+        outcome = @connection.request request
+        return outcome if outcome.is_a? Net::HTTPSuccess
+
+        raise JSON.parse(outcome.body).inspect
+      end
+
+      def init_connection
+        http = Net::HTTP.new @endpoint.host, 443
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        http
+      end
+    end
+  end
+end

data/lib/fronde/sync/rsync.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative '../config'
+
+module Fronde
+  module Sync
+    # Everything needed to push or pull data with rsync
+    class Rsync
+      def initialize(remote_path, local_path, verbose: false)
+        @verbose = verbose
+        @remote_path = remote_path
+        @local_path = "#{local_path}/"
+      end
+
+      def pull(test: false)
+        run command(test:) + [@remote_path, @local_path]
+      end
+
+      def push(test: false)
+        run command(test:) + [@local_path, @remote_path]
+      end
+
+      private
+
+      def run(cmd)
+        puts cmd.join(' ') if @verbose
+        # Be precise about Kernel to allow mock in rspec
+        Kernel.system(*cmd)
+      end
+
+      def command(test: false)
+        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
+    end
+  end
+end

data/lib/fronde/sync.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'config'
+require_relative 'sync/rsync'
+require_relative 'sync/neocities'
+
+module Fronde
+  # Entrypoint for synchronization with remote public server
+  module Sync
+    class Error < ::StandardError; end
+
+    ALLOWED_SYNCER = %w[rsync neocities].freeze
+
+    def self.extract_method_and_remote(type)
+      remote_path = Fronde::CONFIG.get("#{type}_remote")
+      raise Error, "No #{type} remote path set" if remote_path.nil?
+
+      method, remote = remote_path.split(':', 2)
+      return [method, remote] if ALLOWED_SYNCER.include?(method)
+
+      ['rsync', remote_path]
+    end
+
+    def self.pull_or_push(direction, type, test: false, verbose: false)
+      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:)
+      Thread.new { syncer.send(direction, test:) }
+    end
+  end
+end