artagnon/clayoven

require "slim"
require "colorize"
require "fileutils"
require "progressbar"
require "sitemap_generator"

# :nodoc:
module Clayoven
  require_relative "git"
  require_relative "config"
  require_relative "claytext"

  # The toplevel module for clayoven, which contains main
  module Toplevel
    require_relative "util"

    # An abstract page class
    #
    # IndexPage and ContentPage inherit from this class. Exposes accessors to various fields
    # to be used in `design/template.slim`.
    #
    # Be careful when creating \Page objects, because new is expensive.
    class Page
      # The \permalink of the page of the form `blog` or `blog/1`
      attr_accessor :permalink

      # The first line in the .clay or .index.clay file serves as the \title of the page
      attr_accessor :title

      # A `Time` object indicating the last-modified date of the post
      attr_accessor :lastmod

      # A `Time` object indicating the creation date of the post
      attr_accessor :crdate

      # An `Array` of `String` of places where the post was written
      attr_accessor :locations

      # An `Array` of Clayoven::Claytext::Paragraph objects
      attr_accessor :paragraphs

      # A `String` indicating the path to the HTML file on disk
      attr_accessor :target

      # An `Array` of "topics" (`String`) corresponding to IndexPage entries
      attr_accessor :topics

      # An `Array` of "subtopics" for the page, used to fill the IndexPage with subtopic headings,
      # and ContentPage entries
      attr_accessor :subtopics

      # Initialize with filename and data from Clayoven::Git#metadata
      #
      # Expensive due to `log --follow`; avoid creating `Page` objects when not necessary.
      def initialize(filename, git)
        @filename = filename
        # If a file is in the git index, use `Time.now`; otherwise, log --follow it.
        @lastmod, @crdate, @locations = git.metadata @filename
        @title, @body = File.read(@filename).split "\n\n", 2
      end

      # Writes out HTML pages rendered by Clayoven::Claytext::process and `Slim::Template`
      # Initializes Page#topics, and accepts a template.
      def render(topics, template)
        @topics = topics
        @paragraphs = @body ? (Clayoven::Claytext.process @body) : []
        Slim::Engine.set_options pretty: true, sort_attrs: false
        rendered = Slim::Template.new { template }.render self
        File.open(@target, _ = "w") { |targetio| targetio.write rendered }
      end
    end

    # An "index page"
    #
    # Should be an `index.clay` in the toplevel directory, or `#{topic}.index.clay` files in the toplevel directory,
    # or some subdirectory. The ContentPage entries corresponding to this \IndexPage will have to be `.clay` files
    # under the `#{topic}/[#{subtopic}/]` directory of `#{topic}.index.clay`
    class IndexPage < Page
      # Initialize permalink and target, with special handling for 'index.clay';
      # every other filename is a '*.index.clay'
      def initialize(filename, git)
        super

        @permalink =
          if @filename == "index.clay"
            "index"
          else
            filename.split(".index.clay").first
          end
        @target = "#{@permalink}.html"
      end

      # Page#crdate and Page#lastmod are decided, not based on git metadata, but on content_pages
      def update_crdate_lastmod(content_pages)
        @crdate = content_pages.map(&:crdate).append(@crdate).min
        @lastmod = content_pages.map(&:lastmod).append(@lastmod).max
      end

      # Initialize Page#subtopics, and call IndexPage#update_crdate_lastmod.
      def fillindex(content_pages, stmap)
        st = Struct.new(:title, :content_pages, :begints, :endts)
        content_pages = content_pages.sort
        @subtopics =
          content_pages
            .group_by(&:subtopic)
            .map do |subtop, grp|
              st.new(stmap[subtop], grp, grp.last.crdate, grp.first.crdate)
            end
        update_crdate_lastmod content_pages if content_pages.any?
      end
    end

    # A "content page"
    #
    # For .clay files nested within subdirectories, with a corresponding `#{subdirectory}.index.clay`
    # in the ancestor directory.
    class ContentPage < Page
      # The specific "topic" under which this ContentPage sits
      attr_accessor :topic

      # The specific "subtopic" under which this ContentPage sits
      attr_accessor :subtopic

      # Initialize Page#topic, Page#subtopic, Page#permalink, and Page#target
      def initialize(filename, git)
        super
        # There cannot be ContentPages nested under 'index'
        @topic, @subtopic, = @filename.split "/", 3
        @subtopic = nil if @subtopic.end_with?(".clay")
        @permalink = @filename.split(".clay").first
        @target = "#{@permalink}.html"
      end

      # sort is unstable, and we resolve equality of crdate elegantly
      def <=>(other)
        if crdate.to_i == other.crdate.to_i
          other.permalink <=> permalink
        else
          other.crdate.to_i <=> crdate.to_i
        end
      end
    end

    # Simply create IndexPage and ContentPage entries out of index_files and content_files.
    def self.dirty_pages_from_add(index_files, content_files)
      progress =
        ProgressBar.create(
          title: "[#{"GIT".green} ]",
          total: index_files.count + content_files.count
        )

      # Strightforward
      dirty_index_pages =
        index_files.map do |filename|
          progress.increment
          IndexPage.new filename, @git
        end
      dirty_content_pages =
        content_files.map do |filename|
          progress.increment
          ContentPage.new filename, @git
        end
      [dirty_index_pages, dirty_content_pages]
    end

    # Find the modified index_files and added_or_modified content_files from the git index
    def self.modified_files_from_gitidx(index_files, content_files)
      # The case when index_files are added is handled in dirty_pages
      [
        index_files.select { |f| @git.modified? f },
        content_files.select { |f| @git.added_or_modified? f }
      ]
    end

    # Find the dirty IndexPage entries from dirty ContentPage entries and `modified_index_files`.
    # First, see which modified_index_files are forced dirty by corresponding dirty_content_pages;
    # then, add to the list the ones that are dirty by themselves.
    #
    # Returns an `Array` of IndexPage
    def self.find_dirty_index_pages(
      dirty_content_pages,
      modified_index_files,
      progress
    )
      # Avoid adding the
      # index page twice when there are two dirty content_pages under the same index
      dirty_from_content =
        dirty_content_pages
          .map { |dcp| "#{dcp.topic}.index.clay" }
          .uniq
          .map do |dif|
            progress.increment
            IndexPage.new dif, @git
          end
      dirty_from_content +
        modified_index_files.map do |filename|
          progress.increment
          IndexPage.new filename, @git
        end
    end

    # Find the dirty IndexPage and ContentPage entries from some modification that occured in the git index,
    # based on index_files, and content_files.
    #
    # Returns an `Array` of IndexPage
    def self.dirty_pages_from_mod(index_files, content_files)
      # Create a progressbar based on information from the git index
      modified_index_files, modified_content_files =
        modified_files_from_gitidx(index_files, content_files)
      progress =
        ProgressBar.create(
          title: "[#{"GIT".green} ]",
          total: modified_index_files.count + modified_content_files.count * 2
        )

      # Find out the dirty content_pages
      dirty_content_pages =
        modified_content_files.map do |filename|
          progress.increment
          ContentPage.new filename, @git
        end

      [
        find_dirty_index_pages(
          dirty_content_pages,
          modified_index_files,
          progress
        ),
        dirty_content_pages
      ]
    end

    # Return `Array` of IndexPage and ContentPage entries to render
    def self.dirty_pages(index_files, content_files, is_aggressive)
      # Adding a new index file is equivalent to re-rendering the entire site
      if @git.any_added?(index_files) || @git.template_changed? || is_aggressive
        dirty_pages_from_add(index_files, content_files)
      else
        dirty_pages_from_mod(index_files, content_files)
      end
    end

    # Reject the `content_files` that match Clayoven::Config#hidden
    def self.unhidden_content_files(content_files)
      content_files.reject do |cf|
        @config.hidden.any? { |hidden_entry| "#{hidden_entry}.clay" == cf }
      end
    end

    # Return IndexPage and ContentPage entries to render; we work with index_files and content_files, because
    # converting them to Page objects prematurely will result in unnecessary `log --follow` invocations
    def self.pages_to_render(index_files, content_files, is_aggressive)
      dirty_index_pages, dirty_content_pages =
        dirty_pages index_files, content_files, is_aggressive

      # Reject hidden content_files
      dirty_index_pages.each do |dip|
        content_pages =
          unhidden_content_files(content_files)
            .select { |cf| cf.split("/", 2).first == dip.permalink }
            .map { |cf| ContentPage.new cf, @git }
        dip.fillindex content_pages, @config.stmap
      end
      dirty_index_pages + dirty_content_pages
    end

    # Find the list of topics to be exposed as Page#topics.
    def self.find_topics(index_files)
      all_topics =
        Util
          .lex_sort(index_files)
          .map { |file| file.split(".index.clay").first }
      topics =
        all_topics.reject do |entry|
          @config.hidden.any? { |hidden_entry| hidden_entry == entry }
        end
      [all_topics, topics]
    end

    # Separate out `index_files` and `content_files` from `all_files` based on filename
    def self.separate_index_content_files(all_files)
      # index_files are files ending in '.index.clay' and 'index.clay'
      # content_files are all other files; topics is the list of topics: we need it for the sidebar
      index_files =
        ["index.clay"] + all_files.select { |file| /\.index\.clay$/ =~ file }
      [index_files, all_files - index_files]
    end

    # From all_files, find out the list of `index_files`, `content_files`, and `topics`, and return them.
    #
    # Returns an `Array` of three different `Array` of `String`.
    def self.index_content_files(all_files)
      index_files, content_files = separate_index_content_files all_files
      all_topics, topics = find_topics index_files

      # Look for stray files.  All content_files are nested within directories
      # We look in `all_topics`, because we still want hidden content_files to be
      # generated, just not shown.
      content_files
        .reject { |file| all_topics.include? file.split("/").first }
        .each do |stray|
          content_files -= [stray]
          warn "[#{"WARN".yellow} ]: #{stray} is a stray file or directory; ignored"
        end

      [index_files, content_files, topics]
    end

    # Produce HTML files, first using Page#render, and then operating on the files produced
    # in-place with MathJaX
    def self.generate_html(genpages, topics)
      progress =
        ProgressBar.create(title: "[#{"CLAY".green}]", total: genpages.length)
      genpages.each do |page|
        page.render topics, @config.template
        progress.increment
      end
      Util.render_math genpages.map(&:target).join(" ")
    end

    # For the sitemap root entry, find the maximal Page#lastmod of IndexPage entries in all_pages.
    #
    # Returns a Time object.
    def self.sitewide_lastmod(all_pages)
      all_pages.select { |p| p.instance_of? IndexPage }.map(&:lastmod).max
    end

    # Generate `sitemap.xml` from all_pages.
    def self.generate_sitemap(all_pages)
      puts "[#{"XML".green} ]: Generating sitemap"
      SitemapGenerator.verbose = false
      SitemapGenerator::Sitemap.include_root = false
      SitemapGenerator::Sitemap.compress = false
      SitemapGenerator::Sitemap.default_host = "https://#{@config.sitename}"
      SitemapGenerator::Sitemap.public_path = "."
      SitemapGenerator::Sitemap.create do
        add "/",
            lastmod: Clayoven::Toplevel.sitewide_lastmod(all_pages),
            priority: 1.0,
            changefreq: "always"
        all_pages.each { |p| add p.permalink, lastmod: p.lastmod }
      end
    end

    # Generate HTML, minify the design, and generate the sitemap.
    def self.generate_site(genpages, topics, is_aggressive)
      generate_html genpages, topics if genpages.any?
      Util.minify_design if @git.design_changed? || is_aggressive
      generate_sitemap genpages if is_aggressive
    end

    # The entry point for `clayoven`, and `clayoven aggressive`.
    def self.main(is_aggressive: false)
      # Only operate on git repositories
      toplevel = Git.toplevel
      if $? != 0 || toplevel.empty? ||
           (!File.directory? "#{toplevel}/.clayoven")
        abort "[#{"ERR".red} ]: Not a clayoven project (have you run `clayoven init`?)"
      end
      Dir.chdir(toplevel) do
        # Write out template files, if necessary
        @config = Clayoven::Config.new

        # Initialize git
        @git = Clayoven::Git.new @config.tzmap

        # Collect the list of files from a directory listing
        all_files = Util.ls_files

        # From all_files, get the list of index_files, content_files, and topics
        index_files, content_files, topics = index_content_files all_files

        # If the template changes, we're definitely in aggressive mode
        is_aggressive ||= @git.template_changed?

        # Get a list of pages to render, genpages
        genpages = pages_to_render index_files, content_files, is_aggressive

        # Generate the genpages
        generate_site genpages, topics, is_aggressive
      end
    end
  end
end