neruda 0.2.4 → 0.2.6

data/lib/neruda/config/lisp_config.rb

@@ -1,260 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-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
-      versions = JSON.parse(
-        URI('https://updates.orgmode.org/data/releases').open.read
-      ).sort { |a, b| b['date'] <=> a['date'] }
-      @org_version = versions.first['version']
-      FileUtils.mkdir_p 'tmp'
-      IO.write('tmp/__last_org_version__', @org_version)
-      @org_version
-    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
-      unless settings['theme'] == 'default'
-        names << "\"theme-#{settings['theme']}\""
-      end
-      sources.each do |s|
-        # Default theme defined in settings is already included
-        next unless s['theme'] && s['theme'] != settings['theme']
-        # Never include theme named 'default' as it does not rely on any
-        # file to export.
-        next if s['theme'] == 'default'
-        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
-         #{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(project)
-      defaults = {
-        'section-numbers' => 'nil',
-        'with-toc' => 'nil',
-        'html-postamble' => org_default_postamble,
-        'html-head' => '__ATOM_FEED__',
-        'html-head-include-default-style' => 't',
-        'html-head-include-scripts' => 't'
-      }
-      curtheme = project['theme'] || settings['theme']
-      return defaults if curtheme.nil? || curtheme == 'default'
-      defaults['html-head'] = org_default_html_head
-      defaults['html-head-include-default-style'] = 'nil'
-      defaults['html-head-include-scripts'] = 'nil'
-      defaults
-    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(project).merge(
-        settings['org-html'] || {}, project['org-html'] || {}
-      )
-      orgtpl = []
-      truthy_val = ['t', 'nil', '1'].freeze
-      orgtplopts.each do |k, v|
-        v = expand_vars_in_html_head(v, project) if k == 'html-head'
-        val = v.strip.gsub(/"/, '\"')
-        if truthy_val.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
-      theme_config = org_theme_config(settings['theme'])
-      return theme_config if theme_config == ''
-      output = theme_config.split("\n").map do |line|
-        "        #{line}"
-      end
-      format("\n%<conf>s", conf: output.join("\n"))
-    end
-
-    def org_theme_config(theme)
-      return '' if theme.nil? || theme == 'default'
-      workdir = Dir.pwd
-      <<~THEMECONFIG
-        ("theme-#{theme}"
-         :base-directory "#{workdir}/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

@@ -1,17 +0,0 @@
-;; 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

@@ -1,114 +0,0 @@
-;;; 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/config.rb

@@ -1,137 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-require 'neruda/config/lisp_config'
-
-module Neruda
-  # Wrapper for configuration
-  #
-  # This class is a singleton interface, which share the static website
-  # being build settings among different steps or tasks.
-  #
-  # It expects the website author to holds their custom settings in a
-  # YAML file named ~config.yml~ available at the root of their
-  # project.
-  #
-  # For example, with the given config file:
-  #
-  # #+begin_src
-  # ---
-  # title: My website
-  # author: Alice Doe
-  # #+end_src
-  #
-  # Settings will be available like this:
-  #
-  # #+begin_src
-  # Neruda::Config.settings['author']
-  # => "Alice Doe"
-  # #+end_src
-  class Config
-    extend Neruda::LispConfig
-
-    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.
-      #
-      # @return [Hash] the website settings
-      def settings
-        return load_settings unless @config
-        @config
-      end
-
-      # Save the settings given as a parameter to the ~config.yml~ file.
-      #
-      # Not only this method overwrite the old settings, but it replace
-      # the current shared settings with the ones given in
-      # parameter. Later call to
-      # {file:Neruda/Config.html#settings-class_method settings}
-      # will, obviously, use these new settings.
-      #
-      # @param new_config [Hash] the settings to save
-      # @return [Hash] the new settings after save
-      def save(new_config)
-        # Do not save obvious default config values. We'll always try to
-        # save author and lang as they default on system variables,
-        # which may be different from a system to another. Thus it may
-        # be confusing if one use neruda on two different computer and
-        # these params always change.
-        new_config.delete_if do |k, v|
-          ['domain', 'public_folder', 'templates', 'theme'].include?(k) \
-          && v == default_settings[k]
-        end
-        IO.write 'config.yml', new_config.to_yaml
-        load_settings # Reload config, taking default settings into account
-      end
-
-      # Load the given settings as if they comes from the ~config.yml~ file.
-      #
-      # This method is handy for testing purpose. Later call to
-      # {file:Neruda/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
-        @config = default_settings.merge config
-      end
-
-      # Return the qualified projects sources list.
-      #
-      # @return [Array] the fully qualified projects sources list
-      def sources
-        return @sources if @sources
-        default_sources = [{ 'path' => 'src', 'target' => '.' }]
-        @sources = (settings['sources'] || default_sources).map do |s|
-          build_source(s)
-        end.compact
-      end
-
-      private
-
-      def load_settings
-        @sources = nil
-        conf_file = 'config.yml'
-        if File.exist? conf_file
-          @config = default_settings.merge(YAML.load_file(conf_file)).freeze
-        else
-          @config = default_settings
-        end
-      end
-
-      def extract_lang_from_env(default)
-        (ENV['LANG'] || default).split('_', 2).first
-      end
-
-      def default_settings
-        return @default_settings if @default_settings
-        @default_settings = {
-          'author' => (ENV['USER'] || ''),
-          'domain' => '',
-          'lang' => extract_lang_from_env('en'),
-          'public_folder' => 'public_html',
-          'templates' => [],
-          'theme' => 'default'
-        }.freeze
-      end
-
-      def build_source(seed)
-        opts = { 'recursive' => true, 'is_blog' => false }
-        case seed
-        when String
-          opts['path'] = seed
-        when Hash
-          opts.merge! seed
-        end
-        return nil unless opts.has_key?('path')
-        opts['path'] = File.expand_path(opts['path'])
-        opts['name'] ||= File.basename(opts['path']).sub(/^\./, '')
-        opts['target'] ||= opts['name']
-        opts
-      end
-    end
-  end
-end

data/lib/neruda/emacs.rb

@@ -1,37 +0,0 @@
-# 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
-      command = emacs_command(
-        '-l ./org-config.el', '--eval \'(org-publish "website")\''
-      )
-      if @verbose
-        warn command
-        return system(command, exception: true)
-      end
-      system command, out: '/dev/null', err: '/dev/null', exception: true
-    end
-
-    private
-
-    def emacs_command(*arguments)
-      default_emacs = Neruda::Config.settings['emacs']
-      emacs_cmd = [
-        default_emacs || 'emacs -Q --batch -nw',
-        '--eval \'(setq enable-dir-local-variables nil)\''
-      ]
-      emacs_cmd << '--eval \'(setq inhibit-message t)\'' unless @verbose
-      emacs_cmd.concat(arguments)
-      emacs_cmd.join(' ')
-    end
-  end
-end

data/lib/neruda/index/atom_generator.rb

@@ -1,86 +0,0 @@
-# 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
-      format '%<content>s</feed>', content: content.join("\n")
-    end
-
-    def write_atom(index_name)
-      return unless save?
-      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
-      if title == 'index'
-        slug = 'index'
-        tagurl = domain
-        title = Neruda::Config.settings['title'] || \
-                R18n.t.neruda.index.all_tags
-      else
-        slug = Neruda::OrgFile.slug(title)
-        tagurl = "#{domain}/tags/#{slug}.html"
-        title = @tags_names[title]
-      end
-      title = 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}</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>#{Neruda::Config.settings['author'] || ''}</name></author>
-        <id>urn:md5:#{Digest::MD5.hexdigest(domain)}</id>
-        <generator uri="https://git.umaneti.net/neruda/about/">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 = CGI.escapeHTML(article.title)
-      <<~ENDENTRY
-        <entry>
-          <title>#{title}</title>
-          <link href="#{article.url}" rel="alternate" type="text/html"
-                title="#{title}"/>
-          <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