neruda 0.0.10 → 0.1.0

data/lib/neruda/config/lisp_config.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+
+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 mode.
+    #
+    # @return [String] the new x.x.x version string of org mode
+    def org_last_version
+      return @org_version if @org_version
+      index = open('https://orgmode.org/index.html', 'r').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
+      # :nocov:
+      @org_version = last_ver[1]
+    end
+
+    # Generate emacs lisp configuration file for org mode 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
+      projects = org_generate_projects
+      workdir = Dir.pwd
+      content = IO.read(File.expand_path('./org-config.el', __dir__))
+                  .gsub('__WORK_DIR__', workdir)
+                  .gsub('__NERUDA_DIR__', __dir__)
+                  .gsub('__ORG_VER__', org_last_version)
+                  .gsub('__ALL_PROJECTS__', all_projects(projects).strip)
+                  .gsub('__THEME_CONFIG__', org_theme_config.strip)
+                  .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 mode 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 project_names(projects)
+      projects.keys.map { |p| ["\"#{p}\"", "\"#{p}-assets\""] }
+              .flatten.join(' ')
+    end
+
+    def all_projects(projects)
+      projects.values.join("\n").strip
+              .gsub(/\n\n/, "\n")
+              .gsub(/\n/, "\n        ")
+    end
+
+    def org_project(project_name, opts)
+      orgtpl = opts['org_headers']
+      base_directory = File.expand_path(opts['path'])
+      publish_in = [Dir.pwd, settings['public_folder']]
+      publish_in << project_name unless project_name == 'org'
+      publish_in = publish_in.join('/')
+      recline = [opts['recursive'] || 't']
+      default_ex_ptrn = settings['exclude_pattern']
+      if opts['exclude']
+        recline << ":exclude \"#{opts['exclude']}\""
+      elsif project_name == 'org' && default_ex_ptrn
+        recline << ":exclude \"#{default_ex_ptrn}\""
+      end
+      <<~ORGPROJECT
+        ("#{project_name}"
+         :base-directory "#{base_directory}"
+         :base-extension "org"
+         :recursive #{recline.join("\n ")}
+         :publishing-directory "#{publish_in}"
+         :publishing-function org-html-publish-to-html
+         :section-numbers nil
+         :with-toc nil
+         #{orgtpl})
+        ("#{project_name}-assets"
+         :base-directory "#{base_directory}"
+         :base-extension "jpg\\\\\\|gif\\\\\\|png\\\\\\|svg\\\\\\|pdf"
+         :recursive #{recline[0]}
+         :publishing-directory "#{publish_in}"
+         :publishing-function org-publish-attachment)
+      ORGPROJECT
+    end
+
+    def org_default_theme_options
+      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
+      { 'html-head' => build_html_head.strip,
+        'html-postamble' => postamble.strip,
+        'html-head-include-default-style' => 't',
+        'html-head-include-scripts' => 'nil' }
+    end
+
+    def org_templates
+      orgtplopts = org_default_theme_options.merge
+      orgtplopts.merge!(settings['org-html'] || {})
+      orgtpl = []
+      orgtplopts.each do |k, v|
+        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
+      orgtpl = org_templates
+      projects = { 'org' => org_project('org', 'org_headers' => orgtpl,
+                                               'path' => './src') }
+      settings['external_sources']&.each do |s|
+        opts = { 'org_headers' => orgtpl }
+        if s.is_a? String
+          opts['path'] = s
+        elsif s.is_a? Hash
+          opts.merge! s
+        end
+        next unless opts.has_key?('path')
+        pname = File.basename(opts['path']).sub(/^\./, '')
+        projects[pname] = org_project(pname, opts)
+      end
+      projects
+    end
+
+    def org_theme_config
+      curtheme = settings['theme'] || 'default'
+      workdir = Dir.pwd
+      if curtheme == 'default'
+        sourcedir = File.expand_path('../../../', __dir__)
+      else
+        sourcedir = workdir
+      end
+      <<~THEMECONFIG
+        ("theme"
+                 :base-directory "#{sourcedir}/themes/#{curtheme}"
+                 :base-extension "jpg\\\\\\|gif\\\\\\|png\\\\\\|js\\\\\\|css\\\\\\|otf\\\\\\|ttf\\\\\\|woff2?"
+                 :recursive t
+                 :publishing-directory "#{workdir}/#{settings['public_folder']}/assets"
+                 :publishing-function org-publish-attachment)
+      THEMECONFIG
+    end
+
+    def build_html_head
+      stylesheet = <<~CSS
+        <link rel="stylesheet" type="text/css" media="screen"
+              href="#{settings['domain']}/assets/css/style.css">
+        <link rel="stylesheet" type="text/css" media="screen"
+              href="#{settings['domain']}/assets/css/htmlize.css">
+      CSS
+      return stylesheet if settings['blog_path'].nil?
+      <<~ATOM
+        #{stylesheet.strip}
+        <link rel="alternate" type="application/atom+xml" title="Atom 1.0"
+              href="#{settings['domain']}/feeds/index.xml" />
+      ATOM
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+;; Add custom org mode to load path
+(add-to-list 'load-path (expand-file-name "org-__ORG_VER__/lisp" "__WORK_DIR__"))
+;; Load modern version of htmlize.el
+(load-file (expand-file-name "htmlize.el" "__WORK_DIR__"))
+
+;; Current project options
+(setq 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__ "theme"))))
+
+;; Load neruda lib
+(load-file (expand-file-name "ox-neruda.el" "__NERUDA_DIR__"))

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

@@ -0,0 +1,88 @@
+;;; 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/current-work-dir nil
+  "Location of the current neruda website base directory.")
+
+(defvar neruda/org-temp-dir nil
+  "Location of the local org-mode temporary directory (where to place
+org timestamps and id locations).")
+
+(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-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>")))
+
+
+(provide 'ox-neruda)
+
+;;; ox-neruda.el ends here

data/lib/neruda/index.rb

@@ -0,0 +1,108 @@
+# 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(file_list = nil)
+      @blog_path = Neruda::Config.settings['blog_path']
+      @pubdir = Neruda::Config.settings['public_folder']
+      @index = { 'index' => [] }
+      @tags_names = {}
+      @date = DateTime.now
+      if @blog_path.nil?
+        @sources = []
+      else
+        @sources = sources_list(file_list)
+        filter_and_prefix_sources!
+        @sources.each { |f| add_to_indexes(Neruda::OrgFile.new(f)) }
+        sort!
+      end
+    end
+
+    def entries
+      @index.keys
+    end
+
+    def write_all(verbose = true)
+      @index.keys.each 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_org_lists
+      warn 'Generated all tags index' if verbose
+    end
+
+    def sort_by(kind)
+      if [:name, :weight].include?(kind)
+        return sort_tags_by_name_and_weight["by_#{kind}".to_sym]
+      end
+      raise ArgumentError, "#{kind} not in [:name, :weight]"
+    end
+
+    private
+
+    def sources_list(file_list)
+      return file_list unless file_list.nil?
+      Dir.glob(Neruda::Config.settings['blog_pattern'],
+               base: "src/#{@blog_path}")
+    end
+
+    def filter_and_prefix_sources!
+      exclude = Neruda::Config.settings['exclude_pattern']
+      sources = []
+      @sources.each do |f|
+        next if f == 'index.org'
+        if File.exist?(f)
+          file_path = f
+        else
+          file_path = "src/#{@blog_path}/#{f}"
+          next unless File.exist?(file_path)
+        end
+        next if exclude && file_path.match(exclude)
+        sources << file_path
+      end
+      @sources = sources
+    end
+
+    def add_to_indexes(article)
+      @index['index'] << article
+      article.keywords.each do |k|
+        slug = Neruda::OrgFile.slug k
+        @tags_names[slug] = k # Overwrite is permitted
+        @index[slug] = [] unless @index.has_key?(slug)
+        @index[slug] << article
+      end
+    end
+
+    def sort!
+      @index.each do |k, i|
+        @index[k] = i.sort { |a, b| b.timekey <=> a.timekey }
+      end
+    end
+
+    def sort_tags_by_name_and_weight
+      tags_sorted = {}
+      all_keys = @index.keys.reject { |k| k == 'index' }
+      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
+  end
+end

data/lib/neruda/index/atom_generator.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'neruda/config'
+
+module Neruda
+  # Embeds Atom feeds sepecific methods
+  module IndexAtomGenerator
+    def to_atom(index_name = 'index')
+      content = [atom_header(index_name)]
+      @index[index_name][0...10].each do |article|
+        content << atom_entry(article)
+      end
+      content.join("\n") + '</feed>'
+    end
+
+    def write_atom(index_name)
+      return 0 if @blog_path.nil?
+      slug = Neruda::OrgFile.slug index_name
+      FileUtils.mkdir_p "#{@pubdir}/feeds"
+      atomdest = "#{@pubdir}/feeds/#{slug}.xml"
+      IO.write(atomdest, to_atom(index_name))
+    end
+
+    private
+
+    # Render the Atom feed header.
+    #
+    # @param title [String] the title of the current atom feed
+    # @return [String] the Atom header as a String
+    def atom_header(title)
+      domain = Neruda::Config.settings['domain']
+      upddate = @date.rfc3339
+      slug = Neruda::OrgFile.slug(title)
+      tagurl = "#{domain}/tags/#{slug}.html"
+      if title == 'index'
+        if Neruda::Config.settings['title']
+          title = Neruda::Config.settings['title']
+        end
+        tagurl = "#{domain}/#{@blog_path}"
+      elsif @tags_names.has_key?(title)
+        title = @tags_names[title]
+      end
+      title_esc = CGI.escapeHTML(title)
+      <<~ENDATOM
+        <?xml version="1.0" encoding="utf-8"?>
+        <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="#{Neruda::Config.settings['lang']}">
+
+        <title>#{title_esc}</title>
+        <link href="#{domain}/feeds/#{slug}.xml" rel="self" type="application/atom+xml"/>
+        <link href="#{tagurl}" rel="alternate" type="text/html" title="#{title_esc}"/>
+        <updated>#{upddate}</updated>
+        <author><name>#{Neruda::Config.settings['author'] || ''}</name></author>
+        <id>urn:md5:#{Digest::MD5.hexdigest(domain)}</id>
+        <generator uri="https://fossil.deparis.io/neruda">Neruda</generator>
+      ENDATOM
+    end
+
+    # Render an Atom feed entry.
+    #
+    # @param article [Neruda::OrgFile] the related org document for this
+    #   entry
+    # @return [String] the Atom entry as a String
+    def atom_entry(article)
+      keywords = article.keywords.map do |k|
+        "<dc:subject>#{CGI.escapeHTML(k)}</dc:subject>"
+      end.join
+      keywords += "\n  " if keywords != ''
+      title_esc = CGI.escapeHTML(article.title)
+      <<~ENDENTRY
+        <entry>
+          <title>#{title_esc}</title>
+          <link href="#{article.url}" rel="alternate" type="text/html"
+                title="#{title_esc}"/>
+          <id>urn:md5:#{Digest::MD5.hexdigest(article.timekey)}</id>
+          <published>#{article.datestring(:rfc3339)}</published>
+          <author><name>#{CGI.escapeHTML(article.author)}</name></author>
+          #{keywords}<content type="html">#{CGI.escapeHTML(article.excerpt)}</content>
+        </entry>
+      ENDENTRY
+    end
+  end
+end