fronde 0.3.4 → 0.5.0

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

data/lib/fronde/utils.rb

@@ -1,229 +0,0 @@
-# frozen_string_literal: true
-
-require 'uri'
-require 'rainbow'
-require 'net/http'
-require 'r18n-core'
-require 'fronde/config'
-
-module Fronde
-  # Default Error, which may be raised by fronde code
-  class Error < ::StandardError; end
-
-  # 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 ~fronde~ options and their
-    #   configuration
-    FRONDE_OPTIONS = {
-      '-a' => { long: 'author' },
-      '-f' => { long: 'force', boolean: true },
-      '-h' => { long: 'help', boolean: true, meth: :on_tail },
-      '-l' => { long: 'lang', keyword: 'LOCALE' },
-      '-t' => { long: 'title' },
-      '-v' => { long: 'verbose', boolean: true, meth: :on_tail },
-      '-V' => { long: 'version', boolean: true, meth: :on_tail }
-    }.freeze
-
-    # @return [Hash] the possible ~fronde~ subcommands and their
-    #   configuration
-    FRONDE_COMMANDS = {
-      'init' => { opts: ['-a', '-h', '-l', '-t', '-v'] },
-      'update' => { opts: ['-a', '-h', '-l', '-t', '-v'] },
-      'config' => { alias: 'update' },
-      'preview' => { opts: ['-h'] },
-      'open' => { opts: ['-a', '-h', '-l', '-t', '-v'] },
-      'edit' => { alias: 'open' },
-      'build' => { opts: ['-f', '-h'] },
-      'publish' => { opts: ['-h'] },
-      'help' => { opts: ['-h'] },
-      '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
-      # {Fronde::Config#settings}).
-      #
-      # @example
-      #     long_stuff = Thread.new { very_long_operation }
-      #     Fronde::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)
-        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
-      end
-
-      # Returns the short and long options specification for a given
-      #   short option.
-      #
-      # This method use the {Fronde::Utils::FRONDE_OPTIONS} Hash to
-      # retrieve corresponding values.
-      #
-      # @example
-      #     spec = Fronde::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 = Fronde::Utils::FRONDE_OPTIONS[short]
-        long = "--#{opt[:long]}"
-        return [short, long] if opt[:boolean]
-        key = opt[:keyword] || opt[:long].upcase
-        [short + key, format('%<long>s %<key>s', long: long, key: key)]
-      end
-
-      # Returns the ~fronde~ help summary for a given command.
-      #
-      # @param command [String] the command for which a summary
-      #   should be given
-      # @return [String]
-      def summarize_command(command)
-        Fronde::Utils::FRONDE_COMMANDS[command][:opts].map do |k|
-          short, long = Fronde::Utils.decorate_option(k)
-          opt = Fronde::Utils::FRONDE_OPTIONS[k]
-          label = [short, long].join(', ')
-          line = [format('    %<opt>s', opt: label).ljust(30)]
-          if R18n.t.fronde.bin.options[opt[:long]].translated?
-            line << R18n.t.fronde.bin.options[opt[:long]]
-          end
-          line.join(' ')
-        end.join("\n")
-      end
-
-      # Returns a formatted list of available commands for ~fronde~.
-      #
-      # @return [String]
-      def list_commands
-        lines = []
-        Fronde::Utils::FRONDE_COMMANDS.each do |cmd, opt|
-          next if cmd == 'basic'
-          line = ['   ', cmd.ljust(10)]
-          if opt.has_key? :alias
-            line << R18n.t.fronde.bin.commands.alias(opt[:alias])
-          else
-            line << R18n.t.fronde.bin.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 Fronde::Utils::FRONDE_COMMANDS.include?(command)
-        cmd_opt = Fronde::Utils::FRONDE_COMMANDS[command]
-        return cmd_opt[:alias] if cmd_opt.has_key?(:alias)
-        command
-      end
-
-      # Returns the given command options.
-      #
-      # This method will first try to resolve command alias, if any.
-      #
-      # @param command [String] the command, which options should be returned
-      # @return [Hash] the command options
-      def command_options(command)
-        cmd = resolve_possible_alias command
-        FRONDE_COMMANDS[cmd].merge(name: cmd)
-      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.
-      #
-      # @param destination [String] where to save the org-mode tarball
-      # @return [String] the downloaded org-mode version
-      def download_org(destination = 'var/tmp')
-        # :nocov:
-        return if Fronde::Config.org_last_version.nil?
-        # :nocov:
-        # Remove version number in dest file to allow easy rake file
-        # task naming
-        dest_file = File.expand_path('org.tar.gz', destination)
-        return if File.exist?(dest_file)
-        tarball = "org-mode-release_#{Fronde::Config.org_last_version}.tar.gz"
-        uri = URI("https://git.savannah.gnu.org/cgit/emacs/org-mode.git/snapshot/#{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.fronde.error.label).bold.red,
-            explanation: Rainbow(R18n.t.fronde.error.explanation).bold
-          )
-        )
-      end
-
-      def select_throbber_frames
-        model = Fronde::Config.settings['throbber'] || 'default'
-        model = 'default' unless Fronde::Utils::THROBBER_FRAMES.has_key?(model)
-        Fronde::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
-      end
-    end
-  end
-end