fronde 0.3.3 → 0.4.0

data/lib/fronde/org_file/class_methods.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Fronde
-  # This module holds class methods for the {Fronde::OrgFile} class.
-  module OrgFileClassMethods
-    def source_for_target(file_name)
-      # file_name may be frozen...
-      src = file_name.sub(/\.html\z/, '.org')
-      pubfolder = Fronde::Config.get('public_folder')
-      src.sub!(/^#{pubfolder}\//, '')
-      # Look for match in each possible sources. The first found wins.
-      Fronde::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 = Fronde::Config.get('public_folder')
-      "#{pubfolder}/#{target}"
-    end
-
-    def project_for_source(file_name)
-      # Look for match in each possible sources. The first found wins.
-      Fronde::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/fronde/org_file/extracter.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Fronde
-  # This module holds extracter methods for the {Fronde::OrgFile} class.
-  module OrgFileExtracter
-    private
-
-    # Main method, which will call the other to initialize an
-    #   {Fronde::OrgFile} instance.
-    def extract_data
-      @content = File.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 Fronde::Config.get('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 Fronde::Config.get('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/fronde/org_file/htmlizer.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'fronde/config'
-require 'fronde/emacs'
-
-module Fronde
-  # This module holds HTML formatter methods for the {Fronde::OrgFile}
-  # class.
-  module OrgFileHtmlizer
-    private
-
-    # Format {Fronde::OrgFile#keywords} list in an HTML listing.
-    #
-    # @return [String] the HTML keywords list
-    def keywords_to_html
-      domain = Fronde::Config.get('domain')
-      klist = @keywords.map do |k|
-        <<~KEYWORDLINK
-          <li class="keyword">
-            <a href="#{domain}/tags/#{Fronde::OrgFile.slug(k)}.html">#{k}</a>
-          </li>
-        KEYWORDLINK
-      end.join
-      "<ul class=\"keywords-list\">#{klist}</ul>"
-    end
-
-    # Format {Fronde::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 {Fronde::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

data/lib/fronde/org_file.rb

@@ -1,298 +0,0 @@
-# frozen_string_literal: true
-
-require 'time'
-require 'fileutils'
-# fronde/config is required by htmlizer
-require 'fronde/org_file/htmlizer'
-require 'fronde/org_file/extracter'
-require 'fronde/org_file/class_methods'
-require 'fronde/index'
-require 'fronde/version'
-
-module Fronde
-  # Handles org files.
-  #
-  # This class is responsible for reading or writing existing or new org
-  # files, and formating their content to be used on the generated
-  # website.
-  class OrgFile # rubocop:disable Metrics/ClassLength
-    # @return [String] the title of the current org document, taken from
-    #   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
-
-    # @return [Boolean] wether a time has been extracted from the
-    #   current org document ~#+date:~ header.
-    attr_reader :notime
-
-    # The author of the current org document, taken from the ~#+author:~
-    #   header.
-    #
-    # If the current document doesn't have any authorship information,
-    # the one from the ~config.yml~ file will be used instead
-    #
-    # @return [String] the author name
-    attr_reader :author
-
-    # @return [Array] the keywords list of the current org document,
-    #   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.
-    #
-    # If the current document doesn't have any language information, the
-    # one from the ~config.yml~ file will be used instead, or "en" by
-    # default.
-    #
-    # @return [String] the document lang
-    attr_reader :lang
-
-    # @return [String] the relative path to the source of this document.
-    attr_reader :file
-
-    # @return [String] the relative path to the generated html file of
-    #   this document.
-    attr_reader :html_file
-
-    # @return [String] the url of this document, build from the ~domain~
-    #   settings and the above {#html_file @html_file} attribute.
-    attr_reader :url
-
-    # @return [String] the project owning this document.
-    attr_reader :project
-
-    extend Fronde::OrgFileClassMethods
-
-    include Fronde::OrgFileExtracter
-    include Fronde::OrgFileHtmlizer
-
-    # Prepares the file named by ~file_name~ for read and write
-    #   operations.
-    #
-    # If the file ~file_name~ does not exist, the new instance may be
-    # populated by data given in the ~opts~ parameter.
-    #
-    # @example
-    #     File.exist? './test.org'
-    #     => true
-    #     o = Fronde::OrgFile.new('./test.org')
-    #     => #<Fronde::OrgFile @file='./test.org'...>
-    #     o.title
-    #     => "This is an existing test file"
-    #     File.exist? '/tmp/does_not_exist.org'
-    #     => false
-    #     o = Fronde::OrgFile.new('/tmp/does_not_exist.org')
-    #     => #<Fronde::OrgFile @file='/tmp/does_not_exist.org'...>
-    #     o.title
-    #     => ""
-    #     File.exist? '/tmp/other.org'
-    #     => false
-    #     o = Fronde::OrgFile.new('/tmp/other.org', title: 'New file')
-    #     => #<Fronde::OrgFile @file='/tmp/other.org'...>
-    #     o.title
-    #     => "New 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 [String] project the project owning this file
-    #   must be stored
-    # @return [Fronde::OrgFile] the new instance of Fronde::OrgFile
-    def initialize(file_name, opts = {})
-      file_name = nil if file_name == ''
-      @file = file_name
-      @html_file = nil
-      @url = nil
-      @project = opts.delete :project
-      @options = opts
-      build_html_file_and_url
-      if @file && File.exist?(@file)
-        extract_data
-      else
-        init_empty_file
-      end
-    end
-
-    # Returns a String representation of the document date, which aims
-    #   to be used to sort several OrgFiles.
-    #
-    # The format used for the key is ~%Y%m%d%H%M%S~. If the current
-    # OrgFile instance does not have a date, this mehod return
-    # ~00000000000000~. If the current OrgFile instance does not have
-    # time information, the date is padded with zeros.
-    #
-    # @example with the org header ~#+date: <2019-07-03 Wed 20:52:49>~
-    #     org_file.date
-    #     => #<DateTime: 2019-07-03T20:52:49+02:00...>
-    #     org_file.timekey
-    #     => "20190703205349"
-    #
-    # @example with the org header ~#+date: <2019-07-03 Wed>~
-    #     org_file.date
-    #     => #<DateTime: 2019-07-03T00:00:00+02:00...>
-    #     org_file.timekey
-    #     => "20190703000000"
-    #
-    # @example with no date header in the org file
-    #     org_file.date
-    #     => nil
-    #     org_file.timekey
-    #     => "00000000000000"
-    #
-    # @return [String] the document key
-    def timekey
-      return '00000000000000' if @date.nil?
-      @date.strftime('%Y%m%d%H%M%S')
-    end
-
-    # Returns the current OrgFile instance DateTime as a String.
-    #
-    # This method accepts three values for the ~dateformat~ parameter:
-    #
-    # - ~:full~ (or ~:long~) :: outputs a complete date and time
-    #   representation, localized through R18n;
-    # - ~:short~ :: outputs a short date representation (without time),
-    #   localized with R18n;
-    # - ~:rfc3339~ :: outputs the RFC 3339 date and time representation,
-    #   used in atom feed.
-    #
-    # @param dateformat [Symbol] the format to use to convert DateTime
-    #   into String
-    # @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)
-      return '' if @date.nil?
-      return R18n.l @date.to_date if dateformat == :short
-      return @date.rfc3339 if dateformat == :rfc3339
-      locale = R18n.get.locale
-      long_fmt = R18n.t.fronde.index.full_date_format(
-        date: locale.format_date_full(@date, year: year)
-      )
-      unless @notime
-        long_fmt = R18n.t.fronde.index.full_date_with_time_format(
-          date: long_fmt, time: locale.time_format.delete('_').strip
-        )
-      end
-      locale.strftime(@date, long_fmt)
-    end
-
-    # Formats given ~string~ with values of the current OrgFile.
-    #
-    # This method expects to find percent-tags in the given ~string~ and
-    # replace them by their corresponding value.
-    #
-    # It reuses the same tags than the ~org-html-format-spec~ method.
-    #
-    # *** Format:
-    #
-    # - %a :: the raw author name
-    # - %A :: the HTML rendering of the author name, equivalent to
-    #         ~<span class="author">%a</span>~
-    # - %d :: the ~:short~ date HTML representation, equivalent
-    #         to ~<time datetime="%I">%i</time>~
-    # - %D :: the ~:full~ date and time HTML representation
-    # - %i :: the raw ~:short~ date and time
-    # - %I :: the raw ~:rfc3339~ date and time
-    # - %k :: the keywords separated by a comma
-    # - %K :: the HTML list rendering of the keywords
-    # - %l :: the lang of the document
-    # - %L :: the license information, taken from the
-    #         {Fronde::Config#settings}
-    # - %n :: the Fronde name and version
-    # - %N :: the Fronde 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)
-    # - %X :: the description, enclosed in an HTML ~p~ tag, equivalent
-    #         to ~<p>%x</p>~
-    #
-    # @example
-    #     org_file.format("Article written by %a the %d")
-    #     => "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)
-      string.gsub('%a', @author)
-            .gsub('%A', author_to_html)
-            .gsub('%d', date_to_html(:short))
-            .gsub('%D', date_to_html)
-            .gsub('%i', datestring(:short))
-            .gsub('%I', datestring(:rfc3339))
-            .gsub('%k', @keywords.join(', '))
-            .gsub('%K', keywords_to_html)
-            .gsub('%l', @lang)
-            .gsub('%L', Fronde::Config.get('license', '').gsub(/\s+/, ' ').strip)
-            .gsub('%n', "Fronde #{Fronde::VERSION}")
-            .gsub('%N', "<a href=\"https://git.umaneti.net/fronde/about/\">Fronde</a> #{Fronde::VERSION}")
-            .gsub('%s', @subtitle)
-            .gsub('%t', @title)
-            .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.
-    #
-    # The intermediate parent folders are created if necessary.
-    #
-    # @return [Integer] the length written (as returned by the
-    #   underlying ~File.write~ method call)
-    def write
-      raise TypeError, 'no conversion from nil file name to path.' if @file.nil?
-      file_dir = File.dirname @file
-      FileUtils.mkdir_p file_dir unless Dir.exist? file_dir
-      File.write @file, @content
-    end
-
-    private
-
-    def build_html_file_and_url
-      return if @file.nil?
-      @html_file = Fronde::OrgFile.target_for_source(
-        @file, @project, with_public_folder: false
-      )
-      @url = "#{Fronde::Config.get('domain')}/#{@html_file}"
-    end
-
-    def init_empty_file
-      @title = @options[:title] || ''
-      @subtitle = ''
-      @date = DateTime.now
-      @notime = false
-      @author = @options[:author] || Fronde::Config.get('author')
-      @keywords = []
-      @lang = @options[:lang] || Fronde::Config.get('lang')
-      @excerpt = ''
-      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
-end