neruda 0.0.10 → 0.1.0

data/lib/neruda/org_file/htmlizer.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'neruda/config'
+
+module Neruda
+  # This module holds HTML formatter methods for the {Neruda::OrgFile}
+  # class.
+  module OrgFileHtmlizer
+    # Publish the current file or the entire project if
+    #   {Neruda::OrgFile#file @file} is ~nil~.
+    #
+    # @return [Boolean, nil] the underlying ~system~ method return value
+    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
+
+    # Format {Neruda::OrgFile#keywords} list in an HTML listing.
+    #
+    # @return [String] the HTML keywords list
+    def keywords_to_html
+      domain = Neruda::Config.settings['domain']
+      klist = @keywords.map do |k|
+        <<~KEYWORDLINK
+          <li class="keyword">
+            <a href="#{domain}/tags/#{Neruda::OrgFile.slug(k)}.html">#{k}</a>
+          </li>
+        KEYWORDLINK
+      end.join
+      "<ul class=\"keywords-list\">#{klist}</ul>"
+    end
+
+    # Format {Neruda::OrgFile#date} as a HTML `time` tag.
+    #
+    # @return [String] the HTML `time` tag
+    def date_to_html(dateformat = :full)
+      return '' if @date.nil?
+      "<time datetime=\"#{@date.rfc3339}\">#{datestring(dateformat)}</time>"
+    end
+
+    # Format {Neruda::OrgFile#author} in a HTML `span` tag with a
+    #   specific class.
+    #
+    # @return [String] the author HTML `span`
+    def author_to_html
+      return '' if @author == ''
+      "<span class=\"author\">#{@author}</span>"
+    end
+
+    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)\''
+      unless @options[:verbose]
+        emacs_cmd << '--eval \'(setq inhibit-message t)\''
+      end
+      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 @options[:verbose]
+        warn command
+        return system(command)
+      end
+      system command, out: '/dev/null', err: '/dev/null'
+    end
+  end
+end

data/lib/neruda/preview.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'webrick'
+require 'neruda/config'
+
+module Neruda # rubocop:disable Style/Documentation
+  # A tiny preview server, which main goal is to replace references to
+  # the target domain by localhost.
+  class PreviewServlet < WEBrick::HTTPServlet::AbstractServlet
+    include WEBrick::HTTPUtils
+
+    def do_GET(request, response) # rubocop:disable Naming/MethodName
+      file = local_path(request.path)
+      response.body = parse_body(file, "http://#{request.host}:#{request.port}")
+      response.status = 200
+      response.content_type = mime_type(file, DefaultMimeTypes)
+    end
+
+    private
+
+    def local_path(requested_path)
+      routes = Neruda::Config.settings['routes'] || {}
+      return routes[requested_path] if routes.keys.include? requested_path
+      local_path = Neruda::Config.settings['public_folder'] + requested_path
+      if File.directory? local_path
+        local_path = local_path.delete_suffix('/') + '/index.html'
+      end
+      return local_path if File.exist? local_path
+      raise WEBrick::HTTPStatus::NotFound, 'Not found.'
+    end
+
+    def parse_body(local_path, local_host)
+      body = IO.read local_path
+      return body unless local_path.match?(/\.(?:ht|x)ml$/)
+      domain = Neruda::Config.settings['domain']
+      return body if domain == ''
+      body.gsub(/"file:\/\//, '"' + local_host)
+          .gsub(/"#{domain}/, '"' + local_host)
+    end
+  end
+
+  class << self
+    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 = Neruda::Config.settings['server_port'] || 5000
+      s = WEBrick::HTTPServer.new(Port: port)
+      s.mount '/', Neruda::PreviewServlet
+      ['TERM', 'QUIT', 'INT'].each { |sig| trap(sig, proc { s.shutdown }) }
+      s.start
+    end
+  end
+end

data/lib/neruda/templater.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'digest/md5'
+require 'neruda/org_file'
+
+module Neruda
+  # Insert custom part inside generated HTML files.
+  class Templater
+    def initialize(source, dom, opts = {})
+      @dom = dom
+      @org_file = source
+      @position = opts['type'] || 'after'
+      @content = opts['content']
+      @element = @dom.css(opts['selector'])
+      digest = Digest::MD5.hexdigest(@content)
+      @check_line = " Neruda Template: #{digest} "
+    end
+
+    def apply
+      flag_head
+      content = @org_file.format(@content)
+      @element.each do |e|
+        insert_new_node_at e, content
+      end
+    end
+
+    def in_head?
+      @dom.xpath('//head').children.to_a.filter(&:comment?).each do |c|
+        return true if c.text == @check_line
+      end
+      false
+    end
+
+    class << self
+      def customize_output(file_name, source = nil)
+        templates_to_apply = filter_templates(file_name)
+        return if templates_to_apply.empty?
+        if source.nil?
+          sourcepath = Neruda::OrgFile.source_for_target(file_name)
+          source = Neruda::OrgFile.new(sourcepath)
+        end
+        dom = open_dom(file_name)
+        templates_to_apply.each do |t|
+          tpl = Neruda::Templater.new(source, dom, t)
+          next if tpl.in_head?
+          tpl.apply
+        end
+        write_dom(file_name, dom)
+      end
+
+      private
+
+      def filter_templates(file_name)
+        templates = Neruda::Config.settings['templates']
+        return [] if templates.nil? || templates.empty?
+        templates.filter do |t|
+          if !t.has_key?('selector') || !t.has_key?('content')
+            false
+          elsif t.has_key?('path') && !check_path(file_name, t['path'])
+            false
+          else
+            true
+          end
+        end
+      end
+
+      def open_dom(file_name)
+        file = File.new file_name, 'r'
+        dom = Nokogiri::HTML file
+        file.close
+        dom
+      end
+
+      def write_dom(file_name, dom)
+        file = File.new file_name, 'w'
+        dom.write_to file
+        file.close
+      end
+
+      def check_path(file_name, pathes)
+        pub_folder = Neruda::Config.settings['public_folder']
+        if pathes.is_a?(Array)
+          pathes.each do |tp|
+            return true if File.fnmatch?("#{pub_folder}#{tp}",
+                                         file_name, File::FNM_DOTMATCH)
+          end
+          return false
+        end
+        File.fnmatch?("#{pub_folder}#{pathes}",
+                      file_name, File::FNM_DOTMATCH)
+      end
+    end
+
+    private
+
+    def flag_head
+      @dom.xpath('//head').first.prepend_child("<!--#{@check_line}-->\n")
+    end
+
+    def insert_new_node_at(elem, content)
+      if @position == 'before'
+        elem.add_previous_sibling content
+      elsif @position == 'replace'
+        elem.replace content
+      else
+        elem.add_next_sibling content
+      end
+    end
+  end
+end

data/lib/neruda/utils.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'rainbow'
+require 'neruda/config'
+
+module Neruda
+  # Embeds usefull methods, mainly used in rake tasks.
+  module Utils
+    # @return [Hash] the possible throbber themes
+    THROBBER_FRAMES = {
+      'basic' => '-\|/',
+      'basicdots' => '⋯⋱⋮⋰',
+      'moon' => '🌑🌒🌓🌔🌕🌖🌗🌘',
+      'clock' => '🕛🕐🕑🕒🕓🕔🕕🕖🕗🕘🕙🕚',
+      'bricks' => '⣷⣯⣟⡿⢿⣻⣽⣾',
+      'points' => '·⁘∷⁛∷⁘',
+      'quadrant2' => '▙▛▜▟',
+      'default' => ['⠁ ⠂ ⠄ ⡀ ⠄ ⠂ ⠁', '⠂ ⠁ ⠂ ⠄ ⡀ ⠄ ⠂', '⠄ ⠂ ⠁ ⠂ ⠄ ⡀ ⠄',
+                    '⡀ ⠄ ⠂ ⠁ ⠂ ⠄ ⡀', '⠄ ⡀ ⠄ ⠂ ⠁ ⠂ ⠄', '⠂ ⠄ ⡀ ⠄ ⠂ ⠁ ⠂']
+    }.freeze
+
+    # @return [Hash] the possible ~pablo~ options and their
+    #   configuration
+    PABLO_OPTIONS = {
+      '-a' => { long: 'author' },
+      '-l' => { long: 'lang', keyword: 'LOCALE' },
+      '-t' => { long: 'title' },
+      '-p' => { long: 'path', desc: 'Path to the new file' },
+      '-d' => { long: 'directory', boolean: true,
+                desc: 'Wrap the new org file in a named folder' },
+      '-v' => { long: 'verbose', boolean: true, meth: :on_tail },
+      '-h' => { long: 'help', boolean: true, meth: :on_tail,
+                desc: 'Display help for a command and exit' },
+      '-V' => { long: 'version', boolean: true, meth: :on_tail,
+                desc: 'Display Neruda version and exit' }
+    }.freeze
+
+    # @return [Hash] the possible ~pablo~ subcommands and their
+    #   configuration
+    PABLO_COMMANDS = {
+      'init' => { opts: ['-a', '-l', '-t', '-v', '-h'],
+                  desc: 'Initialize your Neruda instance ' \
+                        '(you just need to do it once).' },
+      'preview' => { opts: ['-h'],
+                     desc: 'Start a test webserver to preview ' \
+                           'your website on http://127.0.0.1:5000' },
+      'open' => { opts: ['-a', '-l', '-t', '-d', '-p', '-v', '-h'],
+                  desc: 'Open or create an org file for edition.' },
+      'help' => { opts: ['-h'], desc: 'Alias for the -h switch.' },
+      'basic' => { opts: ['-h', '-V'], label: '<command>' }
+    }.freeze
+
+    class << self
+      # Animates strings in the user console to alert him that something
+      #   is running in the background.
+      #
+      # The animation is chosen among a bunch of themes, with the
+      # configuration option ~throbber~ (retrieved via
+      # {Neruda::Config#settings}).
+      #
+      # @example
+      #     long_stuff = Thread.new { very_long_operation }
+      #     Neruda::Utils.throbber(long_stuff, 'Computing hard stuff:')
+      #
+      # @param thread [Thread] the long-running operation to decorate
+      # @param message [String] the message to display before the throbber
+      # @return [void]
+      def throbber(thread, message)
+        model = Neruda::Config.settings['throbber'] || 'default'
+        model = 'default' unless Neruda::Utils::THROBBER_FRAMES.has_key?(model)
+        frames = Neruda::Utils::THROBBER_FRAMES[model]
+        current = 0
+        while thread.alive?
+          sleep 0.1
+          print "#{message} #{frames[current % frames.length]}\r"
+          current += 1
+        end
+        done = Rainbow('done'.ljust(frames[0].length)).green
+        puts "#{message} #{done}"
+      end
+
+      # Returns the short and long options specification for a given
+      #   short option.
+      #
+      # This method use the {Neruda::Utils::PABLO_OPTIONS} Hash to
+      # retrieve corresponding values.
+      #
+      # @example
+      #     spec = Neruda::Utils.decorate_option('-a')
+      #     => ['-a AUTHOR', '--author AUTHOR']
+      #
+      # @param short [String] the short option to decorate
+      # @return [Array] the short and long specification for an option
+      def decorate_option(short)
+        opt = Neruda::Utils::PABLO_OPTIONS[short]
+        long = "--#{opt[:long]}"
+        return [short, long] if opt[:boolean]
+        key = ' ' + (opt[:keyword] || opt[:long].upcase)
+        [short + key, long + key]
+      end
+
+      # Returns the ~pablo~ help summary for a given command.
+      #
+      # @param command [String] the command for which a summary
+      #   should be given
+      # @return [String]
+      def summarize_command(command)
+        Neruda::Utils::PABLO_COMMANDS[command][:opts].map do |k|
+          short, long = Neruda::Utils.decorate_option(k)
+          opt = Neruda::Utils::PABLO_OPTIONS[k]
+          line = '    ' + [short, long].join(', ')
+          line = line.ljust(34) + " #{opt[:desc]}" if opt.has_key?(:desc)
+          line + "\n"
+        end.join
+      end
+
+      # Returns a formatted list of available commands for ~pablo~.
+      #
+      # @return [String]
+      def list_commands
+        lines = ''
+        Neruda::Utils::PABLO_COMMANDS.each do |cmd, opt|
+          next if cmd == 'basic'
+          lines += "    #{cmd.ljust(10)} #{opt[:desc]}\n"
+        end
+        lines
+      end
+    end
+  end
+end

data/lib/neruda/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Neruda
+  VERSION = '0.1.0'
+end

data/lib/tasks/org.rake

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# Neruda::Config is required by Neruda::Utils
+require 'neruda/utils'
+
+namespace :org do
+  desc 'Download last version of org-mode'
+  task :download do
+    verbose = Rake::FileUtilsExt.verbose_flag
+    org_version = "org-#{Neruda::Config.org_last_version}"
+    next if Neruda::Config.org_last_version.nil?
+    next if Dir.exist?("#{org_version}/lisp")
+    tarball = "#{org_version}.tar.gz"
+    curl = ['curl', '--progress-bar', '-O',
+            "https://orgmode.org/#{tarball}"]
+    make = ['make', '-C', org_version]
+    unless verbose
+      curl[1] = '-s'
+      make << '-s'
+      make << 'EMACSQ="emacs -Q --eval \'(setq inhibit-message t)\'"'
+    end
+    build = Thread.new do
+      sh curl.join(' ')
+      sh "tar xzf #{tarball}"
+      File.unlink tarball
+      sh((make + ['compile']).join(' '))
+      sh((make + ['autoloads']).join(' '))
+      Dir.glob('org-[0-9.]*').each do |ov|
+        next if ov == org_version
+        rm_r ov
+      end
+    end
+    if verbose
+      build.join
+      warn "#{org_version} has been locally installed"
+    else
+      Neruda::Utils.throbber(build, 'Installing org mode:')
+    end
+  end
+
+  file 'htmlize.el' do
+    verbose = Rake::FileUtilsExt.verbose_flag
+    curl = ['curl', '--progress-bar', '-O',
+            'https://raw.githubusercontent.com/hniksic/emacs-htmlize/master/htmlize.el']
+    curl[1] = '-s' unless verbose
+    build = Thread.new { sh curl.join(' ') }
+    if verbose
+      build.join
+      warn 'htmlize.el has been locally installed'
+    else
+      Neruda::Utils.throbber(build, 'Installing htmlize.el:')
+    end
+  end
+
+  file 'org-config.el' => 'htmlize.el' do
+    next if Neruda::Config.org_last_version.nil?
+    Neruda::Config.write_org_lisp_config
+  end
+
+  file '.dir-locals.el' do
+    Neruda::Config.write_dir_locals
+  end
+
+  desc 'Install org'
+  task install: ['org:download', 'org-config.el', '.dir-locals.el'] do
+    mkdir_p "#{Neruda::Config.settings['public_folder']}/assets"
+    mkdir_p 'src'
+  end
+end