frontman-ssg 0.0.2

data/frontman.svg

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 344.97 369.41" width="344.97" height="369.41"><defs><style>.cls-1{fill:#5468ff;}</style></defs><title>logo-frontman-blue</title><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><path class="cls-1" d="M15.36,175.35q5.2-1.64,10.72-3.16L22,147.43H322.24l-4.12,24.76q5.5,1.51,10.72,3.16l5.41-32.55a5.55,5.55,0,0,0-5.47-6.46H243.51L238.92,0l-8.3,26a16.68,16.68,0,0,1-22.41,10.29s-24.75-8.55-38.62-8.55S131,36.28,131,36.28A16.69,16.69,0,0,1,108.56,26L100.27,0,95.66,136.34H15.42A5.55,5.55,0,0,0,10,142.8Zm214.22-72-19.2,17.26a16.15,16.15,0,0,1-19.68,1.48l-11.28-7.41Zm-69.82,11.33-11.28,7.41a16.15,16.15,0,0,1-19.68-1.48l-19.2-17.26Z"></path><path class="cls-1" d="M50.79,320.77l-6.72-40.41q-5.52,1.25-10.81,2.6l7.15,43a5.54,5.54,0,0,0,3.85,4.39l92.07,28.15-6.74-13.66Z"></path><path class="cls-1" d="M293.42,320.77l-79.77,24.38L206.9,358.8l93-28.44a5.54,5.54,0,0,0,3.85-4.39l7.15-43q-5.28-1.36-10.8-2.6Z"></path><path class="cls-1" d="M147.35,302V259.67q-6.36.34-12.7.85-5.13,13.38-10.23,26.88l-.55.05q-5.13-12.42-10.24-24.72-6.31.81-12.62,1.81v42.28c3.29-.52,6.58-1,9.88-1.45V278.68l.52-.08q4.71,11.14,9.41,22.37c2.22-.25,4.43-.48,6.65-.7q4.69-12.22,9.4-24.34l.53,0v26.69Q142.37,302.21,147.35,302Z"></path><path class="cls-1" d="M196.14,302.08Q189,280.52,181.9,259.21q-6.6-.16-13.19-.14-7.12,21.17-14.23,42.56c3.57-.13,7.13-.21,10.7-.25l2.73-9.32q6.93,0,13.84.14c.88,3.12,1.77,6.23,2.65,9.36Q190.27,301.74,196.14,302.08ZM170,284.32q2.33-7.86,4.64-15.71h.56q2.28,7.89,4.56,15.81Q174.84,284.32,170,284.32Z"></path><path class="cls-1" d="M213.44,279.39l.56.06q8.82,12.87,17.63,26.11c2.83.39,5.65.81,8.48,1.26V264.54q-5.07-.8-10.15-1.49v23.79l-.55-.07q-8.78-13.06-17.58-25.78-4.29-.4-8.59-.72v42.28q5.1.38,10.2.87Z"></path><path class="cls-1" d="M44.44,218.83q-13.51,3.18-26.9,7V209.81q14.75-4.26,29.66-7.69V187.71Q23.39,193.2,0,200.79v70.46q8.73-2.83,17.54-5.38V239.6q13.38-3.87,26.9-7Z"></path><path class="cls-1" d="M117.8,199.4c0-14.52-10-22.39-26.5-20q-15.57,2.29-31,5.46v70.46q8.92-1.83,17.91-3.37V227.3c3.09-.53,6.19-1,9.3-1.51q6,11.39,12.12,22.92,10.11-1.34,20.27-2.29-7.09-13-14.18-25.77A24.05,24.05,0,0,0,117.8,199.4Zm-29,13.54c-3.55.53-7.09,1.11-10.62,1.71V195q5.28-.9,10.57-1.71c6.42-1,10.6,2.36,10.6,8.36S95.42,211.94,88.8,212.94Z"></path><path class="cls-1" d="M164,171.63c-21.46.36-35.17,15.9-35.17,38.76S142.45,246.26,164,245.9s35.14-13.58,35.14-36.58C199.15,186.47,185.42,171.34,164,171.63Zm0,59.43c-10.14.16-16.71-8.18-16.71-21.81S154,186.64,164,186.48s16.66,8.69,16.66,22.26S174,230.91,164,231.06Z"></path><path class="cls-1" d="M256.56,219.49Q241.83,197.43,227,176.14q-7.22-.7-14.45-1.22v70.45q8.58.63,17.16,1.51v-40l.93.09q14.85,21.58,29.62,43.95,7.13,1.14,14.22,2.46V182.88q-8.49-1.59-17-2.9v39.65Z"></path><path class="cls-1" d="M287.23,185.39V199.8q10.13,2.13,20.17,4.63v56.05q8.85,2.2,17.63,4.7V209.13Q335,212,345,215.2V200.79A559.87,559.87,0,0,0,287.23,185.39Z"></path><polygon class="cls-1" points="156.87 331.36 145.94 342.94 156.87 342.94 156.87 331.36"></polygon><polygon class="cls-1" points="159.36 340.38 168.54 330.65 159.36 330.65 159.36 340.38"></polygon><polygon class="cls-1" points="171.71 330.64 160.25 342.94 183.11 342.94 171.71 330.64"></polygon><polygon class="cls-1" points="159.92 345.42 171.71 369.41 183.43 345.42 159.92 345.42"></polygon><polygon class="cls-1" points="146.01 345.42 167.93 366.91 157.05 345.42 146.01 345.42"></polygon><polygon class="cls-1" points="186.54 342.94 197.47 342.94 186.54 331.36 186.54 342.94"></polygon><polygon class="cls-1" points="184.06 330.65 174.88 330.65 184.06 340.38 184.06 330.65"></polygon><polygon class="cls-1" points="175.49 366.91 197.41 345.42 186.36 345.42 175.49 366.91"></polygon></g></g></svg>

data/lib/frontman.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'frontman/app'
+require 'frontman/context'
+require 'frontman/config'
+require 'frontman/custom_struct'
+require 'frontman/data_store'
+require 'frontman/data_store_file'
+require 'frontman/sitemap_tree'
+require 'frontman/resource'
+
+require 'frontman/renderers/renderer'
+require 'frontman/renderers/erb_renderer'
+require 'frontman/renderers/haml_renderer'
+require 'frontman/renderers/markdown_renderer'

data/lib/frontman/app.rb

@@ -0,0 +1,175 @@
+# typed: ignore
+# frozen_string_literal: false
+
+require 'frontman/sitemap_tree'
+require 'frontman/data_store'
+require 'singleton'
+require 'sorbet-runtime'
+
+module Frontman
+  class App
+    extend T::Sig
+    include Singleton
+
+    attr_accessor :current_page, :current_tree, :view_data, :refresh_data_files,
+                  :asset_pipelines
+    attr_reader :layouts, :redirects, :assets_manifest, :data_dirs
+
+    sig { void }
+    def initialize
+      @current_page = nil
+      @current_tree = nil
+      @view_data = []
+      @layouts = []
+      @redirects = {}
+      @assets_manifest = {}
+      @data_dirs = {}
+      @refresh_data_files = false
+      @asset_pipelines = []
+    end
+
+    sig { returns(Frontman::SitemapTree) }
+    def sitemap_tree
+      @sitemap_tree ||= Frontman::SitemapTree.new(nil)
+    end
+
+    sig { returns(T.self_type) }
+    def app
+      self
+    end
+
+    sig { params(config: String).void }
+    def run(config)
+      instance_eval config
+    end
+
+    sig { params(glob: String, layout_name: T.nilable(String)).void }
+    def register_layout(glob, layout_name)
+      layout_dir = Frontman::Config.get(:layout_dir, fallback: 'views/layouts')
+      layout = glob, layout_name.nil? ? nil : File.join(layout_dir, layout_name)
+
+      @layouts.push(layout)
+    end
+
+    sig { params(helpers: T::Array[T::Hash[Symbol, String]]).void }
+    def register_helpers(helpers)
+      helpers.each do |helper|
+        require T.must(helper[:path])
+        singleton_class.send(
+          :include,
+          Object.const_get(T.must(helper[:name]).to_sym)
+        )
+      end
+    end
+
+    sig { params(dir: String).void }
+    def register_helper_dir(dir)
+      Frontman::Config.set(:helpers_dir, dir)
+      register_helpers(
+        Frontman::Bootstrapper.find_helpers_in(
+          File.join('.', dir)
+        )
+      )
+    end
+
+    sig { params(from: String, to: String).returns(String) }
+    def add_redirect(from, to)
+      from = format_url(from)
+
+      resource = sitemap_tree.from_url(from)&.resource
+      raise ExistingResourceError.create(from, resource) if resource
+
+      @redirects[from] = to
+    end
+
+    sig { params(url: String).returns(T.nilable(String)) }
+    def get_redirect(url)
+      url = format_url(url)
+
+      @redirects[url]
+    end
+
+    sig { params(key: String, value: String).returns(String) }
+    def add_to_manifest(key, value)
+      @assets_manifest[key] = '/' + value.sub(%r{^/}, '')
+    end
+
+    sig { params(dirs: Array).void }
+    def register_data_dirs(dirs)
+      dirs.each do |dir|
+        define_singleton_method dir.to_sym do
+          @data_dirs[dir] ||= DataStore.new(File.join(Dir.pwd, dir))
+        end
+      end
+    end
+
+    sig do
+      params(
+        command: String,
+        name: T.nilable(String),
+        source_dir: T.nilable(String),
+        timing: Symbol,
+        mode: Symbol,
+        delay: T.any(Integer, String)
+      ).returns(Array)
+    end
+    def add_asset_pipeline(
+      command:, name: nil, source_dir: nil,
+      timing: :before, mode: :all, delay: 0
+    )
+      @asset_pipelines.push(
+        name: name || command,
+        source_dir: source_dir,
+        command: command,
+        timing: timing == :after ? :after : :before,
+        mode: mode,
+        delay: delay
+      )
+    end
+
+    def method_missing(method_id, *_)
+      from_view_data = get_from_view_data(method_id)
+      return from_view_data unless from_view_data.nil?
+
+      from_current_page = get_from_current_page(method_id)
+      return from_current_page unless from_current_page.nil?
+
+      return true if method_id == :render_toc
+
+      super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      public_send(method_name)
+      true
+    rescue StandardError
+      super
+    end
+
+    private
+
+    sig { params(key: T.any(String, Symbol)).returns(T.untyped) }
+    def get_from_current_page(key)
+      return unless current_page && current_page.data.respond_to?(key)
+
+      current_page.data[key]
+    end
+
+    sig { params(key: T.any(String, Symbol)).returns(T.untyped) }
+    def get_from_view_data(key)
+      return if @view_data.empty? || @view_data.last.nil?
+
+      return @view_data.last[key] unless @view_data.last[key].nil?
+
+      local_data = @view_data.last[:locals]
+      local_data[key] unless local_data.nil?
+    end
+
+    class ExistingResourceError < StandardError
+      def self.create(url, resource)
+        new("Unable to redirect for #{url},
+             the resource #{resource.file_path} already exists on this URL")
+      end
+    end
+  end
+end

data/lib/frontman/bootstrapper.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# typed: ignore
+
+require 'sorbet-runtime'
+require 'frontman/app'
+require 'frontman/resource'
+
+module Frontman
+  class Bootstrapper
+    class << self
+      extend T::Sig
+
+      sig { params(path: String).returns(T::Array[T::Hash[Symbol, String]]) }
+      def find_helpers_in(path)
+        Dir.entries(path).map do |file|
+          next unless file.end_with?('_helper.rb')
+
+          {
+            path: File.join(path, file),
+            name: file.split('_').collect(&:capitalize).join.gsub('.rb', '')
+          }
+        end.compact
+      end
+
+      sig { params(app: Frontman::App).returns(Frontman::App) }
+      def bootstrap_app(app)
+        unless bootstrapped?
+          register_default_helpers(app)
+
+          config_path = Frontman::Config.get(
+            :config_path,
+            fallback: './config.rb'
+          )
+          app.run(File.read(config_path)) if File.exist?(config_path)
+
+          @@bootstrapped = true
+        end
+
+        app
+      end
+
+      sig { params(content_root: String).returns(T::Array[Frontman::Resource]) }
+      def resources_from_dir(content_root)
+        files = Dir.glob(
+          File.join(content_root, '**/*')
+        )
+
+        files.reject! { |f| File.directory?(f) || File.fnmatch('**.yml', f) }
+        files.sort! { |a, b| a <=> b || 0 }
+        files.map do |path|
+          Frontman::Resource.from_path(path, path.sub(/^#{content_root}/, ''))
+        end
+      end
+
+      def bootstrapped?
+        @@bootstrapped ||= false
+      end
+
+      private
+
+      sig { params(app: Frontman::App).void }
+      def register_default_helpers(app)
+        app.register_helpers(
+          find_helpers_in(File.join(__dir__, 'helpers'))
+        )
+      end
+    end
+  end
+end

data/lib/frontman/builder/asset_pipeline.rb

@@ -0,0 +1,55 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+
+module Frontman
+  module Builder
+    class AssetPipeline
+      extend T::Sig
+
+      attr_reader :pipelines
+
+      sig { params(external_pipelines: T::Array[Hash]).void }
+      def initialize(external_pipelines)
+        @pipelines = external_pipelines
+      end
+
+      sig { params(timing: Symbol).returns(T::Array[Hash]) }
+      def run!(timing)
+        pipelines = get_by_timing(timing)
+
+        pipelines.each do |pipeline|
+          p "Running external asset pipeline: #{pipeline[:name]}"
+
+          `#{pipeline[:command]}`
+          sleep(pipeline[:delay]) if pipeline[:delay]
+
+          p "Finished: #{pipeline[:name]}"
+        end
+
+        pipelines
+      end
+
+      sig { params(timing: Symbol).returns(T::Array[T.nilable(Integer)]) }
+      def run_in_background!(timing)
+        pipelines = get_by_timing(timing)
+
+        pipelines.map do |pipeline|
+          p "Running external asset pipeline: #{pipeline[:name]}"
+          pid = fork { exec(pipeline[:command]) }
+          sleep(pipeline[:delay]) if pipeline[:delay]
+
+          pid
+        end
+      end
+
+      private
+
+      sig { params(timing: Symbol).returns(T::Array[Hash]) }
+      def get_by_timing(timing)
+        @pipelines.filter { |pipeline| pipeline[:timing] == timing }
+      end
+    end
+  end
+end

data/lib/frontman/builder/builder.rb

@@ -0,0 +1,193 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'frontman/builder/file'
+require 'frontman/config'
+require 'frontman/concerns/dispatch_events'
+require 'frontman/iterator'
+require 'sorbet-runtime'
+
+module Frontman
+  module Builder
+    class Builder
+      extend T::Sig
+      include Frontman::DispatchEvents
+
+      attr_accessor :build_directory, :current_build_files, :public_dir
+
+      sig { void }
+      def initialize
+        @emit_events = true
+        @build_directory = Dir.pwd + '/build/'
+        @public_dir = Frontman::Config.get(:public_dir, fallback: 'public/')
+        @current_build_files = []
+      end
+
+      sig do
+        params(resource: Frontman::Resource).returns(Frontman::Builder::File)
+      end
+      def build_resource(resource)
+        build_from_content(create_path_from_resource(resource), resource.render)
+      end
+
+      sig do
+        params(resources: T::Array[Frontman::Resource])
+          .returns(T::Array[String])
+      end
+      def build_from_resources(resources)
+        # Disable emitting of events, this causes problems when done in parallel
+        @emit_events = false
+        opts = { in_processes: (Frontman::Iterator.processor_count / 2).ceil }
+        resources = Frontman::Iterator.map(resources, opts) do |resource|
+          build_resource(resource)
+        end
+
+        # After the resources are built, we emit all events synchronously
+        @emit_events = true
+        resources.map do |build_file|
+          fire_build_event(build_file)
+          build_file.path
+        end
+      end
+
+      sig do
+        params(assets_to_build: T::Array[String]).returns(T::Array[String])
+      end
+      def build_assets(assets_to_build)
+        # We need to go through ERB files at the end so assets_manifest filled
+        assets_to_build.sort_by! { |f| f.end_with?('.erb') ? 1 : 0 }
+        assets_to_build.map do |path|
+          public_dir = ::File.join(@public_dir, '')
+          if path.end_with?('.erb')
+            build_file = build_from_erb(
+              path,
+              path.sub(public_dir, '').gsub('.erb', '')
+            )
+          else
+            build_file = build_from_asset(
+              path,
+              path.sub(public_dir, '')
+            )
+          end
+
+          build_file.path
+        end
+      end
+
+      sig do
+        params(path: String, manifest_path: String)
+          .returns(Frontman::Builder::File)
+      end
+      def build_from_asset(path, manifest_path)
+        target_path = create_target_path(manifest_path)
+
+        build_from_content(target_path, ::File.read(path))
+      end
+
+      sig do
+        params(path: String, manifest_path: String)
+          .returns(Frontman::Builder::File)
+      end
+      def build_from_erb(path, manifest_path)
+        build_resource(Resource.from_path(path, manifest_path))
+      end
+
+      sig { returns(T::Array[String]) }
+      def build_redirects
+        Frontman::App.instance.redirects.map do |from, to|
+          build_file = build_redirect("#{from}index.html", to)
+          build_file.path
+        end
+      end
+
+      sig { params(files_to_delete: T::Array[String]).void }
+      def delete_files(files_to_delete)
+        files_to_delete.each do |path|
+          delete_from_path(path)
+        end
+      end
+
+      private
+
+      sig do
+        params(destination_path: String, redirect_to: String)
+          .returns(Frontman::Builder::File)
+      end
+      def build_redirect(destination_path, redirect_to)
+        content = <<~REDIRECT
+          <!DOCTYPE html>
+              <link rel="canonical" href="#{redirect_to}" />
+              <meta http-equiv=refresh content="0; url=#{redirect_to}" />
+              <meta name="robots" content="noindex,follow" />
+              <meta http-equiv="cache-control" content="no-cache" />
+          </html>
+        REDIRECT
+
+        build_from_content(create_target_path(destination_path), content)
+      end
+
+      sig do
+        params(build_file: Frontman::Builder::File)
+          .returns(Frontman::Builder::File)
+      end
+      def fire_build_event(build_file)
+        emit(build_file.status, build_file) if @emit_events
+        build_file
+      end
+
+      sig { params(path: String).returns(Frontman::Builder::File) }
+      def delete_from_path(path)
+        FileUtils.rm_f(path)
+        fire_build_event(File.deleted(path))
+      end
+
+      sig { params(file_path: String, content: String).returns(T::Boolean) }
+      def content_changed?(file_path, content)
+        ::File.read(file_path) != content
+      end
+
+      sig { params(file_path: String).returns(T::Boolean) }
+      def exists_in_current_build?(file_path)
+        current_build_files.include?(file_path)
+      end
+
+      sig do
+        params(file_path: String, content: String)
+          .returns(Frontman::Builder::File)
+      end
+      def build_from_content(file_path, content)
+        file_exists = exists_in_current_build?(file_path)
+
+        if file_exists && !content_changed?(file_path, content)
+          return fire_build_event(File.unchanged(file_path))
+        end
+
+        ::File.write(file_path, content)
+
+        fire_build_event(
+          file_exists ? File.updated(file_path) : File.created(file_path)
+        )
+      end
+
+      sig { params(destination_path: String).returns(String) }
+      def create_target_path(destination_path)
+        # dir = destination_path.split('/')[0..-2].join('/')
+        dir = ::File.dirname(destination_path)
+        destination = build_directory + dir
+        FileUtils.mkdir_p(destination)
+
+        build_directory + destination_path.sub(%r{^/}, '')
+      end
+
+      sig { params(resource: Frontman::Resource).returns(String) }
+      def create_path_from_resource(resource)
+        create_target_path(resource.destination_path)
+      end
+
+      sig { params(path: String).returns(String) }
+      def digest(path)
+        ::Digest::SHA1.file(path).hexdigest[0..7]
+      end
+    end
+  end
+end