neruda 0.1.0 → 0.2.2

data/lib/neruda/org_file.rb

@@ -7,6 +7,7 @@ require 'neruda/org_file/htmlizer'
 require 'neruda/org_file/extracter'
 require 'neruda/org_file/class_methods'
 require 'neruda/index'
+require 'neruda/version'
 
 module Neruda
   # Handles org files.
@@ -19,6 +20,10 @@ module Neruda
     #   the ~#+title:~ header.
     attr_reader :title
 
+    # @return [String] the subtitle of the current org document, taken
+    #   from the ~#+subtitle:~ header.
+    attr_reader :subtitle
+
     # @return [DateTime] the date and time of the current org document,
     #   taken from the ~#+date:~ header.
     attr_reader :date
@@ -40,6 +45,10 @@ module Neruda
     #   taken from the ~#+keywords:~ header.
     attr_reader :keywords
 
+    # @return [String] the description of this org document, taken from
+    #   the ~#+description:~ header.
+    attr_reader :excerpt
+
     # The locale of the current org document, taken from the
     #   ~#+language:~ header.
     #
@@ -61,9 +70,8 @@ module Neruda
     #   settings and the above {#html_file @html_file} attribute.
     attr_reader :url
 
-    # @return [String] the description of this org document, taken from
-    #   the ~#+description:~ header.
-    attr_reader :excerpt
+    # @return [String] the project owning this document.
+    attr_reader :project
 
     extend Neruda::OrgFileClassMethods
 
@@ -96,21 +104,25 @@ module Neruda
     #     o.title
     #     => "New file"
     #
-    # @param file_name [String] path to the corresponding org mode file
-    # @param opts [Hash] optional data to initialize new org file
-    # @option opts [String] title ('') the title of the new org file
+    # @param file_name [String] path to the corresponding Org file
+    # @param opts [Hash] optional data to initialize new Org file
+    # @option opts [String] title ('') the title of the new Org file
     # @option opts [String] author (system user or '') the author of the
     #   document
     # @option opts [Boolean] verbose (false) if the
     #   {Neruda::OrgFileHtmlizer#publish publish} method should output
     #   emacs process messages
+    # @option opts [String] project the project owning this file
+    #   must be stored
     # @return [Neruda::OrgFile] the new instance of Neruda::OrgFile
     def initialize(file_name, opts = {})
       file_name = nil if file_name == ''
       @file = file_name
-      @html_file = Neruda::OrgFile.html_file @file
-      @url = Neruda::OrgFile.html_file_with_domain @file
+      @html_file = nil
+      @url = nil
+      @project = opts.delete :project
       @options = opts
+      build_html_file_and_url
       if @file && File.exist?(@file)
         extract_data
       else
@@ -166,7 +178,7 @@ module Neruda
     # @param year [Boolean] wether or not the ~:full~ format must
     #   contain the year
     # @return [String] the document DateTime string representation
-    def datestring(dateformat = :full, year = true)
+    def datestring(dateformat = :full, year: true)
       return '' if @date.nil?
       return R18n.l @date.to_date if dateformat == :short
       return @date.rfc3339 if dateformat == :rfc3339
@@ -202,6 +214,10 @@ module Neruda
     # - %l :: the lang of the document
     # - %L :: the license information, taken from the
     #         {Neruda::Config#settings}
+    # - %n :: the Neruda name and version
+    # - %N :: the Neruda name and version with a link to the project
+    #         home on the name
+    # - %s :: the subtitle of the document
     # - %t :: the title of the document
     # - %u :: the web path to the related published HTML document
     # - %x :: the raw description (eXcerpt)
@@ -213,8 +229,9 @@ module Neruda
     #     => "Article written by Alice Smith the Wednesday 3rd July"
     #
     # @return [String] the given ~string~ after replacement occurs
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Layout/LineLength
     def format(string)
-      license = Neruda::Config.settings['license'] || ''
       string.gsub('%a', @author)
             .gsub('%A', author_to_html)
             .gsub('%d', date_to_html(:short))
@@ -224,12 +241,17 @@ module Neruda
             .gsub('%k', @keywords.join(', '))
             .gsub('%K', keywords_to_html)
             .gsub('%l', @lang)
-            .gsub('%L', license.gsub(/\s+/, ' ').strip)
+            .gsub('%L', (Neruda::Config.settings['license'] || '').gsub(/\s+/, ' ').strip)
+            .gsub('%n', "Neruda #{Neruda::VERSION}")
+            .gsub('%N', "<a href=\"https://git.umaneti.net/neruda/about/\">Neruda</a> #{Neruda::VERSION}")
+            .gsub('%s', @subtitle)
             .gsub('%t', @title)
-            .gsub('%u', @html_file)
+            .gsub('%u', @html_file || '')
             .gsub('%x', @excerpt)
             .gsub('%X', "<p>#{@excerpt}</p>")
     end
+    # rubocop:enable Layout/LineLength
+    # rubocop:enable Metrics/MethodLength
 
     # Writes the current OrgFile content to the underlying file.
     #
@@ -246,20 +268,31 @@ module Neruda
 
     private
 
+    def build_html_file_and_url
+      return if @file.nil?
+      @html_file = Neruda::OrgFile.target_for_source(
+        @file, @project, with_public_folder: false
+      )
+      @url = "#{Neruda::Config.settings['domain']}/#{@html_file}"
+    end
+
     def init_empty_file
       @title = @options[:title] || ''
+      @subtitle = ''
       @date = DateTime.now
       @notime = false
       @author = @options[:author] || Neruda::Config.settings['author']
       @keywords = []
-      @lang = Neruda::Config.settings['lang']
+      @lang = @options[:lang] || Neruda::Config.settings['lang']
       @excerpt = ''
-      @content = @options[:content] || <<~ORG
+      body = @options[:content] || ''
+      @content = @options[:raw_content] || <<~ORG
         #+title: #{@title}
         #+date: <#{@date.strftime('%Y-%m-%d %a. %H:%M:%S')}>
         #+author: #{@author}
         #+language: #{@lang}
 
+        #{body}
       ORG
     end
   end

data/lib/neruda/org_file/class_methods.rb

@@ -3,39 +3,56 @@
 module Neruda
   # This module holds class methods for the {Neruda::OrgFile} class.
   module OrgFileClassMethods
-    def html_file(file_name)
-      return nil if file_name.nil?
-      path = Neruda::OrgFile.target_for_source(file_name)
+    def source_for_target(file_name)
+      # file_name may be frozen...
+      src = file_name.sub(/\.html\z/, '.org')
       pubfolder = Neruda::Config.settings['public_folder']
-      path.sub(/^#{pubfolder}\//, '/')
+      src.sub!(/^#{pubfolder}\//, '')
+      # Look for match in each possible sources. The first found wins.
+      Neruda::Config.sources.each do |project|
+        if project['target'] == '.'
+          origin = File.join(project['path'], src)
+        else
+          origin = File.join(
+            project['path'], src.sub(/^#{project['target']}\//, '')
+          )
+        end
+        return origin if File.exist?(origin)
+      end
+      nil
     end
 
-    def html_file_with_domain(file_name)
+    def target_for_source(file_name, project, with_public_folder: true)
       return nil if file_name.nil?
-      Neruda::Config.settings['domain'] + html_file(file_name)
-    end
-
-    def source_for_target(file_name)
       # file_name may be frozen...
-      src = file_name.sub(/\.html$/, '.org')
+      target = file_name.sub(/\.org\z/, '.html').sub(/^#{Dir.pwd}\//, '')
+      if project.nil?
+        subfolder = File.basename(File.dirname(target))
+        target = File.basename(target)
+        target = "#{subfolder}/#{target}" if subfolder != '.'
+      else
+        project_relative_path = project['path'].sub(/^#{Dir.pwd}\//, '')
+        target.sub!(/^#{project_relative_path}\//, '')
+        target = "#{project['target']}/#{target}" if project['target'] != '.'
+      end
+      return target unless with_public_folder
       pubfolder = Neruda::Config.settings['public_folder']
-      src.sub(/^#{pubfolder}\//, 'src/')
+      "#{pubfolder}/#{target}"
     end
 
-    def target_for_source(file_name)
-      # file_name may be frozen...
-      target = file_name.sub(/\.org$/, '.html')
-      pubfolder = Neruda::Config.settings['public_folder']
-      return target.sub(/^src\//, "#{pubfolder}/") if /^src\//.match?(target)
-      subfolder = File.basename(File.dirname(target))
-      leaf = File.basename(target)
-      "#{pubfolder}/#{subfolder}/#{leaf}"
+    def project_for_source(file_name)
+      # Look for match in each possible sources. The first found wins.
+      Neruda::Config.sources.each do |project|
+        project_relative_path = project['path'].sub(/^#{Dir.pwd}\//, '')
+        return project if file_name.match?(/^#{project_relative_path}\//)
+      end
+      nil
     end
 
     def slug(title)
-      title.downcase.gsub(' ', '-')
+      title.downcase.tr(' ', '-')
            .encode('ascii', fallback: ->(k) { translit(k) })
-           .gsub(/[^\w-]/, '').gsub(/-$/, '')
+           .gsub(/[^\w-]/, '').delete_suffix('-')
     end
 
     private

data/lib/neruda/org_file/extracter.rb

@@ -10,6 +10,7 @@ module Neruda
     def extract_data
       @content = IO.read @file
       @title = extract_title
+      @subtitle = extract_subtitle
       @date = extract_date
       @author = extract_author
       @keywords = extract_keywords
@@ -32,7 +33,17 @@ module Neruda
 
     def extract_title
       m = /^#\+title:(.+)$/i.match(@content)
-      return @file if m.nil?
+      if m.nil?
+        # Avoid to leak absolute path
+        project_relative_path = @file.sub(/^#{Dir.pwd}\//, '')
+        return project_relative_path
+      end
+      m[1].strip
+    end
+
+    def extract_subtitle
+      m = /^#\+subtitle:(.+)$/i.match(@content)
+      return '' if m.nil?
       m[1].strip
     end
 

data/lib/neruda/org_file/htmlizer.rb

@@ -1,22 +1,19 @@
 # frozen_string_literal: true
 
 require 'neruda/config'
+require 'neruda/emacs'
 
 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~.
+    # Publish the current file
     #
     # @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
+      Neruda::Emacs.new(
+        file_path: @file, verbose: @options[:verbose]
+      ).publish
     end
 
     private
@@ -40,7 +37,7 @@ module Neruda
     #
     # @return [String] the HTML `time` tag
     def date_to_html(dateformat = :full)
-      return '' if @date.nil?
+      return '<time></time>' if @date.nil?
       "<time datetime=\"#{@date.rfc3339}\">#{datestring(dateformat)}</time>"
     end
 
@@ -49,30 +46,7 @@ module Neruda
     #
     # @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

@@ -19,11 +19,13 @@ module Neruda # rubocop:disable Style/Documentation
     private
 
     def local_path(requested_path)
-      routes = Neruda::Config.settings['routes'] || {}
-      return routes[requested_path] if routes.keys.include? requested_path
+      routes = Neruda::Config.settings.dig('preview', 'routes') || {}
+      return routes[requested_path] if routes.has_key? requested_path
       local_path = Neruda::Config.settings['public_folder'] + requested_path
       if File.directory? local_path
-        local_path = local_path.delete_suffix('/') + '/index.html'
+        local_path = format(
+          '%<path>s/index.html', path: local_path.delete_suffix('/')
+        )
       end
       return local_path if File.exist? local_path
       raise WEBrick::HTTPStatus::NotFound, 'Not found.'
@@ -31,11 +33,11 @@ module Neruda # rubocop:disable Style/Documentation
 
     def parse_body(local_path, local_host)
       body = IO.read local_path
-      return body unless local_path.match?(/\.(?:ht|x)ml$/)
+      return body unless local_path.match?(/\.(?:ht|x)ml\z/)
       domain = Neruda::Config.settings['domain']
       return body if domain == ''
-      body.gsub(/"file:\/\//, '"' + local_host)
-          .gsub(/"#{domain}/, '"' + local_host)
+      body.gsub(/"file:\/\//, format('"%<host>s', host: local_host))
+          .gsub(/"#{domain}/, format('"%<host>s', host: local_host))
     end
   end
 
@@ -43,7 +45,7 @@ module Neruda # rubocop:disable Style/Documentation
     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
+      port = Neruda::Config.settings.dig('preview', 'server_port') || 5000
       s = WEBrick::HTTPServer.new(Port: port)
       s.mount '/', Neruda::PreviewServlet
       ['TERM', 'QUIT', 'INT'].each { |sig| trap(sig, proc { s.shutdown }) }

data/lib/neruda/templater.rb

@@ -99,9 +99,10 @@ module Neruda
     end
 
     def insert_new_node_at(elem, content)
-      if @position == 'before'
+      case @position
+      when 'before'
         elem.add_previous_sibling content
-      elsif @position == 'replace'
+      when 'replace'
         elem.replace content
       else
         elem.add_next_sibling content

data/lib/neruda/utils.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
+require 'uri'
 require 'rainbow'
+require 'net/http'
+require 'r18n-core'
 require 'neruda/config'
 
 module Neruda
@@ -23,30 +26,27 @@ module Neruda
     #   configuration
     PABLO_OPTIONS = {
       '-a' => { long: 'author' },
+      '-d' => { long: 'directory', boolean: true },
+      '-f' => { long: 'force', boolean: true },
+      '-h' => { long: 'help', boolean: true, meth: :on_tail },
       '-l' => { long: 'lang', keyword: 'LOCALE' },
+      '-p' => { long: 'path' },
       '-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' }
+      '-V' => { long: 'version', boolean: true, meth: :on_tail }
     }.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.' },
+      'init' => { opts: ['-a', '-h', '-l', '-t', '-v'] },
+      'config' => { alias: 'init' },
+      'preview' => { opts: ['-h'] },
+      'open' => { opts: ['-a', '-d', '-h', '-l', '-p', '-t', '-v'] },
+      'edit' => { alias: 'open' },
+      'build' => { opts: ['-f', '-h'] },
+      'publish' => { opts: ['-h'] },
+      'help' => { opts: ['-h'] },
       'basic' => { opts: ['-h', '-V'], label: '<command>' }
     }.freeze
 
@@ -66,17 +66,16 @@ module Neruda
       # @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
+        frames = select_throbber_frames
+        begin
+          run_and_decorate_thread thread, message, frames
+        rescue RuntimeError => e
+          throbber_error message
+          raise e
+        else
+          done = Rainbow('done'.ljust(frames[0].length)).green
+          puts "#{message} #{done}"
         end
-        done = Rainbow('done'.ljust(frames[0].length)).green
-        puts "#{message} #{done}"
       end
 
       # Returns the short and long options specification for a given
@@ -95,8 +94,8 @@ module Neruda
         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]
+        key = opt[:keyword] || opt[:long].upcase
+        [short + key, format('%<long>s %<key>s', long: long, key: key)]
       end
 
       # Returns the ~pablo~ help summary for a given command.
@@ -108,22 +107,108 @@ module Neruda
         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
+          label = [short, long].join(', ')
+          line = [format('    %<opt>s', opt: label).ljust(30)]
+          if R18n.t.pablo.options[opt[:long]].translated?
+            line << R18n.t.pablo.options[opt[:long]]
+          end
+          line.join(' ')
+        end.join("\n")
       end
 
       # Returns a formatted list of available commands for ~pablo~.
       #
       # @return [String]
       def list_commands
-        lines = ''
+        lines = []
         Neruda::Utils::PABLO_COMMANDS.each do |cmd, opt|
           next if cmd == 'basic'
-          lines += "    #{cmd.ljust(10)} #{opt[:desc]}\n"
+          line = ['   ', cmd.ljust(10)]
+          if opt.has_key? :alias
+            line << R18n.t.pablo.commands.alias(opt[:alias])
+          else
+            line << R18n.t.pablo.commands[cmd]
+          end
+          lines << line.join(' ')
+        end
+        lines.join("\n")
+      end
+
+      # Returns the real command name for a given command, which may be
+      #   an alias.
+      #
+      # @param command [String] the command to resolve
+      # @return [String]
+      def resolve_possible_alias(command)
+        return 'basic' unless Neruda::Utils::PABLO_COMMANDS.include?(command)
+        cmd_opt = Neruda::Utils::PABLO_COMMANDS[command]
+        return cmd_opt[:alias] if cmd_opt.has_key?(:alias)
+        command
+      end
+
+      # Try to discover the current host operating system.
+      #
+      # @return [String] either apple, windows or linux (default)
+      # :nocov:
+      def current_os
+        if ENV['OS'] == 'Windows_NT' || RUBY_PLATFORM.include?('cygwin')
+          return 'windows'
+        end
+        return 'apple' if RUBY_PLATFORM.include?('darwin')
+        'linux'
+      end
+      # :nocov:
+
+      # Download latest org-mode tarball.
+      #
+      # @return [String] the downloaded org-mode version
+      def download_org
+        # :nocov:
+        return if Neruda::Config.org_last_version.nil?
+        # :nocov:
+        tarball = "org-#{Neruda::Config.org_last_version}.tar.gz"
+        # Remove version number in dest file to allow easy rake file
+        # task naming
+        dest_file = 'tmp/org.tar.gz'
+        return if File.exist?(dest_file)
+        uri = URI("https://orgmode.org/#{tarball}")
+        # Will crash on purpose if anything goes wrong
+        Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+          http.request(Net::HTTP::Get.new(uri)) do |response|
+            File.open(dest_file, 'w') do |io|
+              response.read_body { |chunk| io.write chunk }
+            end
+          end
+        end
+      end
+
+      private
+
+      def throbber_error(message)
+        warn(
+          format(
+            "%<message>s %<label>s\n%<explanation>s",
+            message: message,
+            label: Rainbow(R18n.t.neruda.error.label).bold.red,
+            explanation: Rainbow(R18n.t.neruda.error.explanation).bold
+          )
+        )
+      end
+
+      def select_throbber_frames
+        model = Neruda::Config.settings['throbber'] || 'default'
+        model = 'default' unless Neruda::Utils::THROBBER_FRAMES.has_key?(model)
+        Neruda::Utils::THROBBER_FRAMES[model]
+      end
+
+      def run_and_decorate_thread(thread, message, frames)
+        thread.abort_on_exception = true
+        current = 0
+        while thread.alive?
+          sleep 0.1
+          print "#{message} #{frames[current % frames.length]}\r"
+          current += 1
         end
-        lines
       end
     end
   end