neruda 0.0.9 → 0.2.0

data/lib/neruda/config/lisp_config.rb

@@ -0,0 +1,254 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'neruda/version'
+
+module Neruda
+  # This module contains utilitary methods to ease ~org-config.el~
+  # file generation
+  module LispConfig
+    # Fetch and return the last published version of Org.
+    #
+    # @return [String] the new x.x.x version string of Org
+    def org_last_version
+      return @org_version if @org_version
+      if File.exist?('tmp/__last_org_version__')
+        @org_version = IO.read('tmp/__last_org_version__')
+        return @org_version
+      end
+      index = URI('https://orgmode.org/index.html').open.read
+      last_ver = index.match(/https:\/\/orgmode\.org\/org-([0-9.]+)\.tar\.gz/)
+      # :nocov:
+      if last_ver.nil?
+        warn 'Org last version not found'
+        return nil
+      end
+      FileUtils.mkdir_p 'tmp'
+      IO.write('tmp/__last_org_version__', last_ver[1])
+      # :nocov:
+      @org_version = last_ver[1]
+    end
+
+    # Generate emacs lisp configuration file for Org and write it.
+    #
+    # This method saves the generated configuration in the file
+    # ~org-config.el~ at the root of your project, overwriting it if it
+    # existed already.
+    #
+    # @return [Integer] the length written (as returned by the
+    #   underlying ~IO.write~ method call)
+    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__', Neruda::VERSION)
+                  .gsub('__WORK_DIR__', workdir)
+                  .gsub('__NERUDA_DIR__', __dir__)
+                  .gsub('__ORG_VER__', org_last_version)
+                  .gsub('__ALL_PROJECTS__', all_projects(projects))
+                  .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'])
+      IO.write("#{workdir}/org-config.el", content)
+    end
+
+    # Generate emacs directory variables file.
+    #
+    # This method generate the file ~.dir-locals.el~, which is
+    # responsible to load neruda Org settings when visiting an Org file
+    # of this neruda instance.
+    #
+    # @return [Integer] the length written (as returned by the
+    #   underlying ~IO.write~ method call)
+    def write_dir_locals
+      workdir = Dir.pwd
+      IO.write(
+        "#{workdir}/.dir-locals.el",
+        "((org-mode . ((eval . (load-file \"#{workdir}/org-config.el\")))))"
+      )
+    end
+
+    private
+
+    def r18n_full_datetime_format
+      locale = R18n.get.locale
+      date_fmt = R18n.t.neruda.index.full_date_format(
+        date: locale.full_format
+      )
+      date_fmt = locale.year_format.sub('_', date_fmt)
+      time_fmt = locale.time_format.delete('_').strip
+      R18n.t.neruda.index.full_date_with_time_format(
+        date: date_fmt, time: time_fmt
+      )
+    end
+
+    def ruby_to_lisp_boolean(value)
+      return 't' if value == true
+      'nil'
+    end
+
+    def project_names(projects)
+      names = projects.keys.map do |p|
+        ["\"#{p}\"", "\"#{p}-assets\""]
+      end.flatten
+      names << "\"theme-#{settings['theme']}\""
+      sources.each do |s|
+        next unless s['theme'] && s['theme'] != settings['theme']
+        theme = "\"theme-#{s['theme']}\""
+        next if names.include? theme
+        names << theme
+      end
+      names.join(' ')
+    end
+
+    def all_projects(projects)
+      projects.values.join("\n").strip
+              .gsub(/\n\s*\n/, "\n")
+              .gsub(/\n/, "\n        ")
+    end
+
+    # Return the full path to the publication path of a given project
+    #   configuration.
+    #
+    # @param project [Hash] a project configuration (as extracted from
+    #   the ~sources~ key)
+    # @return [String] the full path to the target dir of this project
+    def publication_path(project)
+      publish_in = [Dir.pwd, settings['public_folder']]
+      publish_in << project['target'] unless project['target'] == '.'
+      publish_in.join('/')
+    end
+
+    def org_project(project_name, opts)
+      publish_in = publication_path(opts)
+      other_lines = [
+        format(':recursive %<value>s',
+               value: ruby_to_lisp_boolean(opts['recursive']))
+      ]
+      if opts['exclude']
+        other_lines << format(':exclude "%<value>s"',
+                              value: opts['exclude'])
+      end
+      themeconf = org_theme_config(opts['theme']) || ''
+      <<~ORGPROJECT
+        ("#{project_name}"
+         :base-directory "#{opts['path']}"
+         :base-extension "org"
+         #{other_lines.join("\n ")}
+         :publishing-directory "#{publish_in}"
+         :publishing-function org-html-publish-to-html
+         :section-numbers nil
+         :with-toc nil
+         #{opts['org_headers']})
+        ("#{project_name}-assets"
+         :base-directory "#{opts['path']}"
+         :base-extension "jpg\\\\\\|gif\\\\\\|png\\\\\\|svg\\\\\\|pdf"
+         #{other_lines[0]}
+         :publishing-directory "#{publish_in}"
+         :publishing-function org-publish-attachment)
+        #{themeconf}
+      ORGPROJECT
+    end
+
+    def org_default_postamble
+      <<~POSTAMBLE
+        <p><span class="author">#{R18n.t.neruda.org.postamble.written_by}</span>
+        #{R18n.t.neruda.org.postamble.with_emacs}</p>
+        <p class="date">#{R18n.t.neruda.org.postamble.last_modification}</p>
+        <p class="validation">%v</p>
+      POSTAMBLE
+    end
+
+    def org_default_html_head
+      <<~HTMLHEAD
+        <link rel="stylesheet" type="text/css" media="screen"
+              href="__DOMAIN__/assets/__THEME__/css/style.css">
+        <link rel="stylesheet" type="text/css" media="screen"
+              href="__DOMAIN__/assets/__THEME__/css/htmlize.css">
+        __ATOM_FEED__
+      HTMLHEAD
+    end
+
+    def org_default_html_options
+      { 'html-head' => org_default_html_head,
+        'html-postamble' => org_default_postamble,
+        'html-head-include-default-style' => 't',
+        'html-head-include-scripts' => 'nil' }
+    end
+
+    def expand_vars_in_html_head(head, project)
+      curtheme = project['theme'] || settings['theme']
+      # Head may be frozen when coming from settings
+      head = head.gsub('__THEME__', curtheme)
+                 .gsub('__DOMAIN__', settings['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" />
+      ATOMFEED
+      head.gsub('__ATOM_FEED__', atomfeed)
+    end
+
+    def build_project_org_headers(project)
+      orgtplopts = org_default_html_options.merge(
+        settings['org-html'] || {}, project['org-html'] || {}
+      )
+      orgtpl = []
+      orgtplopts.each do |k, v|
+        v = expand_vars_in_html_head(v, project) if k == 'html-head'
+        val = v.strip.gsub(/"/, '\"')
+        if ['t', 'nil', '1'].include? val
+          orgtpl << ":#{k} #{val}"
+        else
+          orgtpl << ":#{k} \"#{val}\""
+        end
+      end
+      orgtpl.join("\n ")
+    end
+
+    def org_generate_projects(with_tags: false)
+      projects = {}
+      projects_sources = sources
+      if with_tags
+        tags_conf = build_source('tags')
+        tags_conf['recursive'] = false
+        projects_sources << tags_conf
+      end
+      projects_sources.each do |opts|
+        opts['org_headers'] = build_project_org_headers(opts)
+        projects[opts['name']] = org_project(opts['name'], opts)
+      end
+      projects
+    end
+
+    def org_default_theme_config
+      org_theme_config(settings['theme']).split("\n").map do |line|
+        if line[0] == '('
+          line
+        else
+          "        #{line}"
+        end
+      end.join("\n")
+    end
+
+    def org_theme_config(theme)
+      return nil if theme.nil?
+      workdir = Dir.pwd
+      if theme == 'default'
+        sourcedir = File.expand_path('../../../', __dir__)
+      else
+        sourcedir = workdir
+      end
+      <<~THEMECONFIG
+        ("theme-#{theme}"
+         :base-directory "#{sourcedir}/themes/#{theme}"
+         :base-extension "jpg\\\\\\|gif\\\\\\|png\\\\\\|js\\\\\\|css\\\\\\|otf\\\\\\|ttf\\\\\\|woff2?"
+         :recursive t
+         :publishing-directory "#{workdir}/#{settings['public_folder']}/assets/#{theme}"
+         :publishing-function org-publish-attachment)
+      THEMECONFIG
+    end
+  end
+end

data/lib/neruda/config/org-config.el

@@ -0,0 +1,18 @@
+;; Add org-mode to load path
+(add-to-list 'load-path (expand-file-name "org-__ORG_VER__/lisp" "__WORK_DIR__"))
+;; Load last version of htmlize.el
+(load-file (expand-file-name "htmlize.el" "__WORK_DIR__"))
+
+;; Current project options
+(setq neruda/version "__VERSION__"
+      neruda/current-work-dir "__WORK_DIR__"
+      user-mail-address "__AUTHOR_EMAIL__"
+      user-full-name "__AUTHOR_NAME__"
+      org-html-metadata-timestamp-format "__LONG_DATE_FMT__"
+      org-publish-project-alist
+      `(__ALL_PROJECTS__
+        __THEME_CONFIG__
+        ("website" :components (__ALL_PROJECTS_NAMES__))))
+
+;; Load neruda lib
+(load-file (expand-file-name "ox-neruda.el" "__NERUDA_DIR__"))

data/lib/neruda/config/ox-neruda.el

@@ -0,0 +1,114 @@
+;;; ox-neruda.el --- Neruda Gem specific helpers for Org Export Engine -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2011-2019 Free Software Foundation, Inc.
+
+;; Author: Étienne Deparis <etienne at depar dot is>
+;; Keywords: org, export
+
+;; This file is not part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; This library implements specific helpers function, needed by the Ruby
+;; Gem Neruda, which offers an easy way to publish a static website
+;; using Org files as sources.
+
+;;; Code:
+
+(require 'org)
+(require 'ox-html)
+
+;;; Function Declarations
+
+(defvar neruda/version ""
+  "Version of the current neruda installation")
+
+(defvar neruda/current-work-dir nil
+  "Location of the current neruda website base directory.")
+
+(defvar neruda/org-temp-dir nil
+  "Location of the local Org temporary directory (where to place
+org timestamps and id locations).")
+
+(defun neruda/org-html-format-spec (upstream info)
+  "Return format specification for preamble and postamble.
+INFO is a plist used as a communication channel."
+  (let ((output (funcall upstream info)))
+    (push `(?A . ,(format "<span class=\"author\">%s</span>"
+                    (org-export-data (plist-get info :author) info)))
+      output)
+    (push `(?k . ,(org-export-data (plist-get info :keywords) info)) output)
+    (push `(?K . ,(format "<ul class=\"keywords-list\">%s</ul>"
+                    (mapconcat
+	                    (lambda (k) (format "<li class=\"keyword\">%s</li>" k))
+	                    (split-string (or (plist-get info :keywords) "")  ",+ *")
+	                    "\n")))
+      output)
+    (push `(?l . ,(org-export-data (plist-get info :language) info)) output)
+    (push `(?n . ,(format "Neruda %s" neruda/version)) output)
+    (push `(?N . ,(format "<a href=\"https://git.umaneti.net/neruda/about/\">Neruda</a> %s" neruda/version)) output)
+    (push `(?x . ,(org-export-data (plist-get info :description) info)) output)
+    (push `(?X . ,(format "<p>%s</p>"
+                    (org-export-data (plist-get info :description) info)))
+      output)))
+
+(defun neruda/org-i18n-export (link description format)
+  "Export a i18n link"
+  (let* ((splitted-link (split-string link "|"))
+         (path (car splitted-link))
+         (desc (or description path))
+         (lang (cadr splitted-link)))
+    (pcase format
+      (`html (if lang
+                 (format "<a href=\"%s\" hreflang=\"%s\">%s</a>"
+                         path lang desc)
+               (format "<a href=\"%s\">%s</a>" path desc)))
+      (`latex (format "\\href{%s}{%s}" path desc))
+      (`ascii (format "%s (%s)" desc path))
+      (_ path))))
+
+(defun neruda/org-i18n-follow (link)
+  "Visit a i18n link"
+  (browse-url (car (split-string link "|"))))
+
+(org-link-set-parameters "i18n"
+  :export #'neruda/org-i18n-export
+  :follow #'neruda/org-i18n-follow)
+
+
+;;; Set configuration options
+
+(setq neruda/org-temp-dir (expand-file-name "tmp" neruda/current-work-dir)
+      org-publish-timestamp-directory (expand-file-name "timestamps/" neruda/org-temp-dir)
+      org-id-locations-file (expand-file-name "id-locations.el" neruda/org-temp-dir)
+      make-backup-files nil
+      enable-local-variables :all
+      org-confirm-babel-evaluate nil
+      org-export-with-broken-links t
+      org-html-doctype "html5"
+      org-html-html5-fancy t
+      org-html-htmlize-output-type 'css
+      org-html-text-markup-alist '((bold . "<strong>%s</strong>")
+                                    (code . "<code>%s</code>")
+                                    (italic . "<em>%s</em>")
+                                    (strike-through . "<del>%s</del>")
+                                    (underline . "<span class=\"underline\">%s</span>")
+                                    (verbatim . "<code>%s</code>")))
+(advice-add 'org-html-format-spec :around #'neruda/org-html-format-spec)
+
+(provide 'ox-neruda)
+
+;;; ox-neruda.el ends here

data/lib/neruda/emacs.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'neruda/config'
+
+module Neruda
+  # Wraps Gnu/Emacs calls
+  class Emacs
+    def initialize(file_path: nil, verbose: false)
+      @file = file_path
+      @verbose = verbose
+    end
+
+    def publish
+      if @file.nil?
+        emacs_args = ['--eval \'(org-publish "website")\'']
+      else
+        emacs_args = ['-f org-publish-current-file']
+      end
+      call_emacs emacs_args
+    end
+
+    private
+
+    def emacs_command(arguments = [])
+      default_emacs = Neruda::Config.settings['emacs']
+      emacs_cmd = [default_emacs || 'emacs -Q --batch -nw']
+      emacs_cmd << '--eval \'(setq enable-dir-local-variables nil)\''
+      emacs_cmd << '--eval \'(setq inhibit-message t)\'' unless @verbose
+      emacs_cmd << '-l ./org-config.el'
+      emacs_cmd << "--eval '(find-file \"#{@file}\")'" unless @file.nil?
+      emacs_cmd.concat(arguments)
+      emacs_cmd.join(' ')
+    end
+
+    def call_emacs(arguments = [])
+      command = emacs_command arguments
+      if @verbose
+        warn command
+        return system(command, exception: true)
+      end
+      system command, out: '/dev/null', err: '/dev/null', exception: true
+    end
+  end
+end

data/lib/neruda/index.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'digest/md5'
+require 'neruda/config'
+require 'neruda/org_file'
+require 'neruda/index/atom_generator'
+require 'neruda/index/org_generator'
+
+module Neruda
+  # Generates website indexes and atom feeds for all the org documents
+  #   keywords.
+  class Index
+    attr_reader :date
+
+    include Neruda::IndexAtomGenerator
+    include Neruda::IndexOrgGenerator
+
+    def initialize
+      @pubdir = Neruda::Config.settings['public_folder']
+      @index = { 'index' => [] }
+      @projects = {}
+      @tags_names = {}
+      @date = DateTime.now
+      feed
+      sort!
+    end
+
+    def entries
+      @index.keys.reject { |k| k == 'index' }
+    end
+
+    def empty?
+      @index['index'].empty?
+    end
+
+    def write_all(verbose: true)
+      @index.each_key do |k|
+        write_org(k)
+        warn "Generated index file for #{k}" if verbose
+        write_atom(k)
+        warn "Generated atom feed for #{k}" if verbose
+      end
+      write_all_blog_home(verbose)
+    end
+
+    def sort_by(kind)
+      if [:name, :weight].include?(kind)
+        tags_sorted = sort_tags_by_name_and_weight["by_#{kind}".to_sym]
+        # Reverse in order to have most important or A near next prompt
+        # and avoid to scroll to find the beginning of the list.
+        return tags_sorted.map do |k|
+          @tags_names[k] + " (#{@index[k].length})"
+        end.reverse
+      end
+      raise ArgumentError, "#{kind} not in [:name, :weight]"
+    end
+
+    private
+
+    def feed
+      Neruda::Config.sources.each do |project|
+        next unless project['is_blog']
+        if project['recursive']
+          file_pattern = '**/*.org'
+        else
+          file_pattern = '*.org'
+        end
+        Dir.glob(file_pattern, base: project['path']).map do |s|
+          org_file = File.join(project['path'], s)
+          add_to_indexes(
+            Neruda::OrgFile.new(org_file, project: project)
+          )
+        end
+      end
+    end
+
+    def add_to_project_index(article)
+      project = article.project
+      @projects[project['name']] ||= []
+      @projects[project['name']] << article
+    end
+
+    def add_to_indexes(article)
+      @index['index'] << article
+      add_to_project_index article
+      article.keywords.each do |k|
+        slug = Neruda::OrgFile.slug k
+        @tags_names[slug] = k # Overwrite is permitted
+        @index[slug] ||= []
+        @index[slug] << article
+      end
+    end
+
+    def sort!
+      @index.each do |k, i|
+        @index[k] = i.sort { |a, b| b.timekey <=> a.timekey }
+      end
+      @projects.each do |k, i|
+        @projects[k] = i.sort { |a, b| b.timekey <=> a.timekey }
+      end
+    end
+
+    def sort_tags_by_name_and_weight
+      tags_sorted = {}
+      all_keys = entries
+      tags_sorted[:by_name] = all_keys.sort
+      tags_sorted[:by_weight] = all_keys.sort do |a, b|
+        @index[b].length <=> @index[a].length
+      end
+      tags_sorted
+    end
+
+    def save?
+      return true unless empty?
+      Neruda::Config.sources.each do |project|
+        return true if project['is_blog'] && Dir.exist?(project['path'])
+      end
+      false
+    end
+  end
+end