neruda 0.2.4 → 0.2.6

data/lib/neruda/index/org_generator.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-module Neruda
-  # Embeds methods responsible for generating an org file for a given
-  #   index.
-  module IndexOrgGenerator
-    def to_org(index_name = 'index', is_project: false)
-      return project_home_page(index_name) if is_project
-      return all_tags_index if index_name == 'index'
-      [org_header(index_name),
-       org_articles(@index[index_name])].join("\n")
-    end
-    alias_method :to_s, :to_org
-
-    def write_org(index_name)
-      return unless save?
-      slug = Neruda::OrgFile.slug index_name
-      FileUtils.mkdir 'tags' unless Dir.exist? 'tags'
-      content = to_org index_name
-      orgdest = "tags/#{slug}.org"
-      IO.write(orgdest, content)
-    end
-
-    private
-
-    def project_home_page(project_name)
-      content = [org_header(project_name, is_tag: false)]
-      if @projects[project_name]&.any?
-        content += org_articles(@projects[project_name])
-      end
-      content.join("\n")
-    end
-
-    def write_all_blog_home(verbose)
-      Neruda::Config.sources.each do |project|
-        next unless project['is_blog']
-        next unless Dir.exist?(project['path'])
-        warn "Generated blog home for #{project['name']}" if verbose
-        orgdest = format('%<root>s/index.org', root: project['path'])
-        IO.write(orgdest, to_org(project['name'], is_project: true))
-      end
-    end
-
-    def all_tags_index
-      content = [
-        org_header(R18n.t.neruda.index.all_tags, is_tag: false)
-      ]
-      sort_tags_by_name_and_weight.each do |t, tags|
-        content << ''
-        content << org_title(R18n.t.neruda.index.send(t), 'index-tags')
-        next if tags.empty?
-        tags.each do |k|
-          content << "- #{tag_published_url(k)} (#{@index[k].length})"
-        end
-      end
-      content.join("\n")
-    end
-
-    def tag_published_url(tag_name)
-      domain = Neruda::Config.settings['domain']
-      title = @tags_names[tag_name]
-      tag_link = "#{domain}/tags/#{tag_name}.html"
-      "[[#{tag_link}][#{title}]]"
-    end
-
-    def org_header(title = nil, is_tag: true)
-      if is_tag
-        title = @tags_names[title]
-      elsif title.nil? || title == 'index'
-        title = Neruda::Config.settings['title']
-      end
-      <<~HEADER.strip
-        #+title: #{title}
-        #+author: #{Neruda::Config.settings['author']}
-        #+language: #{Neruda::Config.settings['lang']}
-      HEADER
-    end
-
-    def org_articles(articles_list)
-      last_year = nil
-      articles_list.map do |article|
-        year_title = ''
-        year = article.timekey.slice(0, 4)
-        if year != last_year
-          year_title = format("\n%<title>s\n", title: org_title(year))
-          last_year = year
-        end
-        year_title + org_entry(article)
-      end
-    end
-
-    def org_entry(article)
-      line = "- *[[#{article.url}][#{article.title}]]*"
-      if article.date
-        art_date = article.datestring(:full, year: false)
-        published = R18n.t.neruda.index.published_on art_date
-        line += " / #{published}"
-      end
-      line += " \\\\\n  #{article.excerpt}" if article.excerpt != ''
-      line
-    end
-
-    def org_title(year, html_class = 'index-year')
-      year = R18n.t.neruda.index.unsorted if year == '0000'
-      <<~ENDPROP
-        * #{year}
-        :PROPERTIES:
-        :HTML_CONTAINER_CLASS: #{html_class}
-        :UNNUMBERED: notoc
-        :END:
-      ENDPROP
-    end
-  end
-end

data/lib/neruda/index.rb

@@ -1,130 +0,0 @@
-# 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
-      @pubdir = Neruda::Config.settings['public_folder']
-      @index = { 'index' => [] }
-      @projects = {}
-      @tags_names = {}
-      @date = DateTime.now
-      feed
-      sort!
-    end
-
-    def entries
-      @index.keys.reject { |k| k == 'index' }
-    end
-
-    def empty?
-      @index['index'].empty?
-    end
-
-    def write_all(verbose: true)
-      @index.each_key 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_all_blog_home(verbose)
-    end
-
-    def sort_by(kind)
-      if [:name, :weight].include?(kind)
-        tags_sorted = sort_tags_by_name_and_weight["by_#{kind}".to_sym]
-        # Reverse in order to have most important or A near next prompt
-        # and avoid to scroll to find the beginning of the list.
-        return tags_sorted.map do |k|
-          @tags_names[k] + " (#{@index[k].length})"
-        end.reverse
-      end
-      raise ArgumentError, "#{kind} not in [:name, :weight]"
-    end
-
-    private
-
-    def feed
-      Neruda::Config.sources.each do |project|
-        next unless project['is_blog']
-        if project['recursive']
-          file_pattern = '**/*.org'
-        else
-          file_pattern = '*.org'
-        end
-        Dir.glob(file_pattern, base: project['path']).map do |s|
-          org_file = File.join(project['path'], s)
-          next if exclude_file?(org_file, project)
-          add_to_indexes(
-            Neruda::OrgFile.new(org_file, project: project)
-          )
-        end
-      end
-    end
-
-    def add_to_project_index(article)
-      project = article.project
-      @projects[project['name']] ||= []
-      @projects[project['name']] << article
-    end
-
-    def add_to_indexes(article)
-      @index['index'] << article
-      add_to_project_index article
-      article.keywords.each do |k|
-        slug = Neruda::OrgFile.slug k
-        @tags_names[slug] = k # Overwrite is permitted
-        @index[slug] ||= []
-        @index[slug] << article
-      end
-    end
-
-    def sort!
-      @index.each do |k, i|
-        @index[k] = i.sort { |a, b| b.timekey <=> a.timekey }
-      end
-      @projects.each do |k, i|
-        @projects[k] = i.sort { |a, b| b.timekey <=> a.timekey }
-      end
-    end
-
-    def sort_tags_by_name_and_weight
-      tags_sorted = {}
-      all_keys = entries
-      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
-
-    def exclude_file?(file_path, project)
-      # Obviously excluding index itself for blogs
-      return true if file_path == File.join(project['path'], 'index.org')
-      return false unless project['exclude']
-      file_path.match? project['exclude']
-    end
-
-    def save?
-      return true unless empty?
-      Neruda::Config.sources.each do |project|
-        return true if project['is_blog'] && Dir.exist?(project['path'])
-      end
-      false
-    end
-  end
-end

data/lib/neruda/org_file/class_methods.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Neruda
-  # This module holds class methods for the {Neruda::OrgFile} class.
-  module OrgFileClassMethods
-    def source_for_target(file_name)
-      # file_name may be frozen...
-      src = file_name.sub(/\.html\z/, '.org')
-      pubfolder = Neruda::Config.settings['public_folder']
-      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 target_for_source(file_name, project, with_public_folder: true)
-      return nil if file_name.nil?
-      # file_name may be frozen...
-      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']
-      "#{pubfolder}/#{target}"
-    end
-
-    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.tr(' ', '-')
-           .encode('ascii', fallback: ->(k) { translit(k) })
-           .gsub(/[^\w-]/, '').delete_suffix('-')
-    end
-
-    private
-
-    def translit(char)
-      return 'a' if ['á', 'à', 'â', 'ä', 'ǎ', 'ã', 'å'].include?(char)
-      return 'e' if ['é', 'è', 'ê', 'ë', 'ě', 'ẽ'].include?(char)
-      return 'i' if ['í', 'ì', 'î', 'ï', 'ǐ', 'ĩ'].include?(char)
-      return 'o' if ['ó', 'ò', 'ô', 'ö', 'ǒ', 'õ'].include?(char)
-      return 'u' if ['ú', 'ù', 'û', 'ü', 'ǔ', 'ũ'].include?(char)
-      return 'y' if ['ý', 'ỳ', 'ŷ', 'ÿ', 'ỹ'].include?(char)
-      return 'c' if char == 'ç'
-      return 'n' if char == 'ñ'
-      '-'
-    end
-  end
-end

data/lib/neruda/org_file/extracter.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Neruda
-  # This module holds extracter methods for the {Neruda::OrgFile} class.
-  module OrgFileExtracter
-    private
-
-    # Main method, which will call the other to initialize an
-    #   {Neruda::OrgFile} instance.
-    def extract_data
-      @content = IO.read @file
-      @title = extract_title
-      @subtitle = extract_subtitle
-      @date = extract_date
-      @author = extract_author
-      @keywords = extract_keywords
-      @lang = extract_lang
-      @excerpt = extract_excerpt
-    end
-
-    def extract_date
-      timerx = '([0-9:]{5})(?::([0-9]{2}))?'
-      m = /^#\+date: *<([0-9-]{10}) [\w.]+(?: #{timerx})?> *$/i.match(@content)
-      return nil if m.nil?
-      @notime = m[2].nil?
-      if @notime
-        time = '00:00:00'
-      else
-        time = "#{m[2]}:#{m[3] || '00'}"
-      end
-      DateTime.strptime("#{m[1]} #{time}", '%Y-%m-%d %H:%M:%S')
-    end
-
-    def extract_title
-      m = /^#\+title:(.+)$/i.match(@content)
-      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
-
-    def extract_author
-      m = /^#\+author:(.+)$/i.match(@content)
-      return Neruda::Config.settings['author'] if m.nil?
-      m[1].strip
-    end
-
-    def extract_keywords
-      m = /^#\+keywords:(.+)$/i.match(@content)
-      return [] if m.nil?
-      m[1].split(',').map(&:strip)
-    end
-
-    def extract_lang
-      m = /^#\+language:(.+)$/i.match(@content)
-      return Neruda::Config.settings['lang'] if m.nil?
-      m[1].strip
-    end
-
-    def extract_excerpt
-      @content.scan(/^#\+description:(.+)$/i).map { |l| l[0].strip }.join(' ')
-    end
-  end
-end

data/lib/neruda/org_file/htmlizer.rb

@@ -1,43 +0,0 @@
-# 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
-    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 '<time></time>' 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
-      "<span class=\"author\">#{@author}</span>"
-    end
-  end
-end