neruda 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f3224292de6de88d025190d293fd0e9043f2cb54832986410975343887be77d
-  data.tar.gz: aaf3bf95cf510fc67cd0dcab3f6c9a65d2153ed676b4300c068dda01bfca6241
+  metadata.gz: 65d74457beb2f9469147295e9edd1f0f2ba9bc307b0adf5c7945cad322be5dd1
+  data.tar.gz: 7327285f32dc4cf51cf60d08afcb4e1e170654a0d173dd2c802d45be7b979f94
 SHA512:
-  metadata.gz: 662711c6423eea8c5c554c53761f23e56260fe8c022685d62ef8b234e6ef89f9bffd85707ff8e39e96c460096817bd52964111ad4f2f86f4b8945856e64be693
-  data.tar.gz: 6b95b730be8814ed2d9af07452b34caa6ac07ef58bdfcaef8c653ec901081392e2c2c1e5c85fa392e698a292566b69c25a24297e52beecabe1f8b2211426c141
+  metadata.gz: 8a4317715347eff92a1ba934234d05612901a2b90c74827a5c8feed173be1d5ca390f0a19cc56bf8c7c854753fd7a03b1a08b7347c4447e714d632f847652d95
+  data.tar.gz: c898c9c6128405a60b4f0f9c6402fa23a1a3b221175b6296065b93d1dd6c20f8b45c3fa51c238c549cfc454615d7161fe10eb73ff692a1b35a55f8c17f7c94f4

data/bin/pablo

@@ -7,8 +7,8 @@ require 'r18n-core'
 require 'neruda/utils'
 require 'neruda/version'
 
-R18n.set(Neruda::Config.settings['lang'],
-         File.expand_path('../locales', __dir__))
+R18n.default_places = File.expand_path('../locales', __dir__)
+R18n.set Neruda::Config.settings['lang']
 
 # Pablo commands
 module PabloCommands
@@ -20,58 +20,93 @@ module PabloCommands
     Neruda::Config.save(Neruda::Config.settings.merge(cnf))
     @rake.options.build_all = true
     @rake.invoke_task('org:install')
-    o = Neruda::OrgFile.new('src/index.org', @options)
-    o.write unless File.exist? 'src/index.org'
+    return if File.exist? 'src/index.org'
+    Neruda::OrgFile.new('src/index.org', @options).write
   end
   alias_method :pablo_config, :pablo_init
 
   def pablo_build(file = ARGV[0])
     @rake.options.build_all = true
-    if file.nil?
-      @rake.invoke_task('site:build')
-    else
-      @rake.invoke_task("site:build:one[#{file}]")
+    # Update org-config.el, if necessary
+    @rake.invoke_task('org-config.el')
+    suffix = ''
+    if !file.nil?
+      suffix = ":one[#{file}]"
+    elsif @options[:force]
+      suffix = '[true]'
     end
+    @rake.invoke_task("site:build#{suffix}")
   end
 
   def pablo_preview
+    Thread.new do
+      sleep 1
+      port = Neruda::Config.settings.dig('preview', 'server_port') || 5000
+      uri = "http://127.0.0.1:#{port}/"
+      current_os = Neruda::Utils.current_os
+      case current_os
+      when 'windows'
+        system 'start', uri
+      when 'apple'
+        system 'open', uri
+      else
+        system 'gio', 'open', uri
+      end
+    end
     @rake.invoke_task('site:preview')
   end
 
   def pablo_open
-    filename = ARGV[0] || new_file_name
+    filename = new_file_name(ARGV[0])
     FileUtils.mkdir_p File.dirname(filename)
     o = Neruda::OrgFile.new(filename, @options)
     o.write unless File.exist? filename
-
     editor = ENV['EDITOR'] || ENV['VISUAL'] || 'emacs'
-    cmd = [editor, filename]
-    cmd.insert(1, '+6') if editor.match?(/^emacs/)
+    cmd = [editor, '+6', filename]
     system(*cmd)
   end
+  alias_method :pablo_edit, :pablo_open
+
+  def pablo_publish
+    @rake.invoke_task('sync:push')
+  end
 
-  def pablo_help(command = 'basic', error = false)
+  def pablo_help(command = 'basic', error: false)
     warn R18n.t.pablo.error.no_command if error
-    command = 'basic' unless Neruda::Utils::PABLO_COMMANDS.include?(command)
-    cmd_opt = Neruda::Utils::PABLO_COMMANDS[command]
+    cmd = Neruda::Utils.resolve_possible_alias(command)
+    cmd_opt = Neruda::Utils::PABLO_COMMANDS[cmd]
     label = cmd_opt[:label] || command
-    warn "Usage: pablo #{label} [options]\n\n"
-    warn cmd_opt[:desc] + "\n\n" if cmd_opt.has_key?(:desc)
-    warn "Options\n#{Neruda::Utils.summarize_command(command)}\n"
-    warn "Commands\n#{Neruda::Utils.list_commands}\n" if command == 'basic'
+    warn format("%<label>s\n\n", label: R18n.t.pablo.usage(label))
+    if R18n.t.pablo.commands[cmd].translated?
+      warn format("%<label>s\n\n", label: R18n.t.pablo.commands[cmd])
+    end
+    warn help_command_body(cmd).join("\n")
     exit 1 if error
     exit
   end
 
   private
 
-  def new_file_name
-    title = @options[:title]
+  def new_file_name(title)
+    title ||= @options[:title]
     title = 'new' if title.nil? || title == ''
     filename = Neruda::OrgFile.slug title
     return "#{filename}.org" unless @options[:directory]
     "#{filename}/index.org"
   end
+
+  def help_command_body(command)
+    body = [
+      R18n.t.pablo.options.cmd_title,
+      Neruda::Utils.summarize_command(command)
+    ]
+    return body unless command == 'basic'
+    body + [
+      '',
+      R18n.t.pablo.commands.cmd_title,
+      Neruda::Utils.list_commands
+    ]
+  end
 end
 
 # Main pablo class
@@ -100,8 +135,8 @@ class Pablo
       require 'r18n-core'
 
       neruda_spec = Gem::Specification.find_by_name 'neruda'
-      R18n.set(Neruda::Config.settings['lang'] || 'en',
-               "\#{neruda_spec.gem_dir}/locales")
+      R18n.default_places = "\#{neruda_spec.gem_dir}/locales"
+      R18n.set(Neruda::Config.settings['lang'] || 'en')
       R18n::Filters.on(:named_variables)
 
       Dir.glob("\#{neruda_spec.gem_dir}/lib/tasks/*.rake").each { |r| import r }
@@ -112,14 +147,14 @@ class Pablo
   end
 end
 
-params = {}
-optparser = OptionParser.new do |opts|
-  opts.version = Neruda::VERSION
-  Neruda::Utils::PABLO_OPTIONS.each do |k, opt|
-    short, long = Neruda::Utils.decorate_option(k)
-    opts.send(opt[:meth] || :on, short, long, opt[:desc])
-  end
+optparser = OptionParser.new
+optparser.version = Neruda::VERSION
+
+Neruda::Utils::PABLO_OPTIONS.each do |k, opt|
+  optparser.send(opt[:meth] || :on, *Neruda::Utils.decorate_option(k))
 end
+
+params = {}
 optparser.parse!(into: params)
 
 if params[:version]
@@ -133,10 +168,13 @@ if ARGV[0] == 'help'
 end
 pablo = Pablo.new(params)
 command = "pablo_#{ARGV[0]}".to_sym
-err = command.nil? || !pablo.respond_to?(command)
-pablo.pablo_help(ARGV[0], err) if err || params[:help]
+cmd_err = !pablo.respond_to?(command)
+if params[:help] || cmd_err
+  cmd_err = false if params[:help] && !ARGV[0]
+  pablo.pablo_help(ARGV[0], error: cmd_err)
+end
 ARGV.shift
 
-init_cmds = ['pablo_init', 'pablo_config']
+init_cmds = [:pablo_init, :pablo_config]
 pablo.pablo_init unless File.exist?('config.yml') || init_cmds.include?(command)
 pablo.send command

data/lib/neruda/config.rb

@@ -53,8 +53,17 @@ module Neruda
       # @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
-        @config = new_config.freeze
+        load_settings # Reload config, taking default settings into account
       end
 
       # Load the given settings as if they comes from the ~config.yml~ file.
@@ -66,28 +75,62 @@ module Neruda
       # @param config [Hash] the settings to artificially load
       # @return [Hash] the new settings
       def load_test(config)
-        @config = config
-        add_default_settings
+        @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
-        @config = {}
-        conf = 'config.yml'
-        @config = YAML.load_file(conf) if File.exist? conf
-        add_default_settings
-        @config.freeze
+        @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 add_default_settings
-        @config['lang'] ||= 'en'
-        @config['author'] ||= (ENV['USER'] || '')
-        @config['domain'] ||= ''
-        @config['public_folder'] ||= 'public_html'
-        @config['templates'] ||= []
-        return if @config['blog_path'].nil?
-        @config['blog_pattern'] ||= '**/*.org'
+      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

data/lib/neruda/config/lisp_config.rb

@@ -1,28 +1,35 @@
 # 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 mode.
+    # Fetch and return the last published version of Org.
     #
-    # @return [String] the new x.x.x version string of org mode
+    # @return [String] the new x.x.x version string of Org
     def org_last_version
       return @org_version if @org_version
-      index = open('https://orgmode.org/index.html', 'r').read
+      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 mode and write it.
+    # 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
@@ -30,15 +37,16 @@ module Neruda
     #
     # @return [Integer] the length written (as returned by the
     #   underlying ~IO.write~ method call)
-    def write_org_lisp_config
-      projects = org_generate_projects
+    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).strip)
-                  .gsub('__THEME_CONFIG__', org_theme_config.strip)
+                  .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'] || '')
@@ -49,8 +57,8 @@ module Neruda
     # 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.
+    # 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)
@@ -76,69 +84,136 @@ module Neruda
       )
     end
 
+    def ruby_to_lisp_boolean(value)
+      return 't' if value == true
+      'nil'
+    end
+
     def project_names(projects)
-      projects.keys.map { |p| ["\"#{p}\"", "\"#{p}-assets\""] }
-              .flatten.join(' ')
+      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\n/, "\n")
+              .gsub(/\n\s*\n/, "\n")
               .gsub(/\n/, "\n        ")
     end
 
-    def org_project(project_name, opts)
-      orgtpl = opts['org_headers']
-      base_directory = File.expand_path(opts['path'])
+    # 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_name unless project_name == 'org'
-      publish_in = publish_in.join('/')
-      recline = [opts['recursive'] || 't']
-      default_ex_ptrn = settings['exclude_pattern']
+      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']
-        recline << ":exclude \"#{opts['exclude']}\""
-      elsif project_name == 'org' && default_ex_ptrn
-        recline << ":exclude \"#{default_ex_ptrn}\""
+        other_lines << format(':exclude "%<value>s"',
+                              value: opts['exclude'])
       end
+      themeconf = org_theme_config(opts['theme'])
       <<~ORGPROJECT
         ("#{project_name}"
-         :base-directory "#{base_directory}"
+         :base-directory "#{opts['path']}"
          :base-extension "org"
-         :recursive #{recline.join("\n ")}
+         #{other_lines.join("\n ")}
          :publishing-directory "#{publish_in}"
          :publishing-function org-html-publish-to-html
          :section-numbers nil
          :with-toc nil
-         #{orgtpl})
+         #{opts['org_headers']})
         ("#{project_name}-assets"
-         :base-directory "#{base_directory}"
+         :base-directory "#{opts['path']}"
          :base-extension "jpg\\\\\\|gif\\\\\\|png\\\\\\|svg\\\\\\|pdf"
-         :recursive #{recline[0]}
+         #{other_lines[0]}
          :publishing-directory "#{publish_in}"
          :publishing-function org-publish-attachment)
+        #{themeconf}
       ORGPROJECT
     end
 
-    def org_default_theme_options
-      postamble = <<~POSTAMBLE
+    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
-      { 'html-head' => build_html_head.strip,
-        'html-postamble' => postamble.strip,
-        'html-head-include-default-style' => 't',
+    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)
+      curtheme = project['theme'] || settings['theme']
+      if curtheme.nil? || curtheme == 'default'
+        return { 'html-head' => '__ATOM_FEED__',
+                 'html-postamble' => org_default_postamble,
+                 'html-head-include-default-style' => 't',
+                 'html-head-include-scripts' => 't' }
+      end
+      { 'html-head' => org_default_html_head,
+        'html-postamble' => org_default_postamble,
+        'html-head-include-default-style' => 'nil',
         'html-head-include-scripts' => 'nil' }
     end
 
-    def org_templates
-      orgtplopts = org_default_theme_options.merge
-      orgtplopts.merge!(settings['org-html'] || {})
+    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 ['t', 'nil', '1'].include? val
+        if truthy_val.include? val
           orgtpl << ":#{k} #{val}"
         else
           orgtpl << ":#{k} \"#{val}\""
@@ -147,55 +222,41 @@ module Neruda
       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)
+    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_theme_config
-      curtheme = settings['theme'] || 'default'
-      workdir = Dir.pwd
-      if curtheme == 'default'
-        sourcedir = File.expand_path('../../../', __dir__)
-      else
-        sourcedir = workdir
+    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
-      <<~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
+      format("\n%<conf>s", conf: output.join("\n"))
     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
+    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