hyphae 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 26fffd773e8c0b6c43d8a286fd4be72a835246377634ee003cd41adead85234c
+  data.tar.gz: 37abf4892e01b535f8e8585cbf616eae7bbce2d3a27663cb318f3f514d49b4b7
+SHA512:
+  metadata.gz: 5aecfc870811743bcd373bbdab8942982e0781554d30f867df1045597550f29caa20bff837d1c461b89925f4632dfcd6f73a7e17b3a73dcf47a01d5aeea750ad
+  data.tar.gz: e09d2ac065b089110e335d556494a3fbec5eb80c6456c8f2aa6c0cf66ecd9fd6df58f4023cbe0545149adbd6ca4bcc0d1b45e59f6b60a675c23874ec713414cc

data/bin/hyphae

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby
+
+require 'hyphae'
+
+###################
+### Main Script ###
+###################
+
+# The first argument given is the site input directory
+input_dir = ARGV[0] || "site"
+if not Dir.exist?(input_dir) then
+  puts "ERROR: No input directory '#{input_dir}'"
+  exit
+end
+
+# The second argument is the rendered html site output directory
+output_dir = ARGV[1] || "_build"
+
+# Builds the page tree of the site
+if not Dir.exist?(input_dir + "/pages") then
+  puts "ERROR: No '/pages' directory in #{input_dir}"
+  exit
+end
+page_tree = Hyphae::SiteDir.new(input_dir + '/pages')
+
+# Reads site template file
+if not File.exist?(input_dir + "/template.html") then
+  puts "ERROR: No 'template.html' file in #{input_dir}"
+  exit
+end
+template = File.read(input_dir + "/template.html")
+
+# Reads site index content file
+index_content = ''
+if File.exist?(input_dir + "/index.html") then
+  index_content = File.read(input_dir + "/template.html")
+end
+
+# Makes the output directory
+FileUtils.rm_rf output_dir
+FileUtils.mkdir output_dir
+
+# Moves site's static files
+if not Dir.exist?(input_dir + "/static") then
+  puts "ERROR: No '/static' directory in #{input_dir}"
+  exit
+end
+FileUtils.cp_r(input_dir + '/static', output_dir)
+
+# Builds html pages
+page_tree.build(output_dir, template)
+
+# Build site index
+page_tree.build_index(output_dir, template, index_content)

data/lib/hyphae.rb

@@ -0,0 +1,166 @@
+require 'kramdown'
+require 'fileutils'
+
+module Hyphae
+
+  #########################
+  ### Utility Functions ###
+  #########################
+
+  # Produces a URL safe version of a string
+  def self.sanitize(str)
+    str.downcase.gsub(' ', '_').gsub(/[^\d\w_]/, "")
+  end
+
+  # Renders an HTML tag
+  def self.make_tag(tag, content, attrs={})
+    attrs_str = ""
+    attrs.map { |x, y| attrs_str << " #{x}=\"#{y}\""}
+    "<#{tag}#{attrs_str}>#{content}</#{tag}>"
+  end
+
+
+
+  #############################
+  ### Site Building Classes ###
+  #############################
+
+  # Site content node, all other site node classes inherit from this one
+  class SiteNode
+    attr_reader :name, :slug, :path, :parent, :order, :date
+
+    def initialize(filename, parent=nil)
+      @name = File.basename(filename, '.*')
+      @parent = parent
+      @hidden = false
+      @order = nil
+      @date = nil
+      if captures = @name.match(/^_(.+)/) then
+        @hidden = true
+        @name = captures[1]
+      elsif captures = @name.match(/^o(\d+)_(.+)/) then
+        @order = captures[1].to_i
+        @name = captures[2]
+      elsif captures = @name.match(/^ut(\d+)_(.+)/) then
+        @date = Time.at(captures[1].to_i)
+        @name = captures[2]
+      end
+      @slug = Hyphae::sanitize @name
+      @path = @parent ? @parent.path + [(@slug)] : []
+      return self
+    end
+
+    # Get the root SiteNode of a tree of SiteNodes
+    def root
+      return self if @parent.nil?
+      @parent.root
+    end
+
+    # Compare this SiteNode with another
+    def cmp(other)
+      if other.order then
+        return 1 if @order.nil?
+        return @order <=> other.order
+      end
+      if other.date then
+        return 1 if @date.nil?
+        return other.date <=> @date
+      end
+      @name <=> other.name
+    end
+  end
+
+
+  # A SiteDir represents a directory containing nested SiteNodes
+  class SiteDir < SiteNode
+    def initialize(filename, parent=nil)
+      super
+      @children = []
+      Dir.glob(filename + '/*').each do |f|
+        if File.directory? f then
+          @children.push SiteDir.new(f, self)
+        elsif File.extname(f) == '.md' then
+          @children.push SitePage.new(f, self)
+        elsif File.extname(f) == '.link' then
+          @children.push SiteLink.new(f, self)
+        end
+      end
+      @children.sort! { |x, y| x.cmp(y) }
+      return self
+    end
+
+    # Returns the html for each child's nav menu link
+    def menu_items(open_path=[])
+      @children.map { |x| x.nav_link(open_path) }.join
+    end
+
+    # Returns the html for this SiteDir's nav menu link
+    def nav_link(open_path=[])
+      return "" if @hidden
+      link = Hyphae::make_tag('span', @name, {'class' => 'nav_menu_link'})
+      menu_attrs = { 'class' => 'nav_menu_items' }
+      menu_attrs['class'] += ' open' if open_path.first == @slug
+      menu = Hyphae::make_tag('div', menu_items(open_path[1..-1] || []), menu_attrs)
+      Hyphae::make_tag('div', link + menu, {'class' => 'nav_menu'})
+    end
+
+    # Recursively builds pages for all children
+    def build(build_dir, template)
+      @children.each { |child| child.build(build_dir, template) }
+    end
+
+    # Builds an index page for this SiteDir
+    def build_index(build_dir, template, index_content='')
+      page_html = template.gsub('{{navbar}}', menu_items).gsub("{{content}}", index_content).gsub('{{index_class}}', ' index_page')
+      File.open("#{build_dir}/index.html", 'w') { |f| f << page_html }
+    end
+  end
+
+
+  # A SitePage represents a markdown document
+  class SitePage < SiteNode
+    def initialize(filename, parent)
+      super
+      markdown = File.read filename
+      @html = Kramdown::Document.new(markdown).to_html
+    end
+
+    # Builds the nav menu tag for this page
+    def nav_link(open_path=[])
+      return "" if @hidden
+      attrs = { 'class' => 'nav_page', 'href' => "/#{@path.join('/')}.html" }
+      attrs['class'] += ' current_page' if @slug == open_path.first
+      Hyphae::make_tag('a', @name, attrs)
+    end
+
+    # Builds html page
+    def build(build_dir, template)
+      nav = root.menu_items(@path)
+      page_html = template.gsub('{{navbar}}', nav).gsub("{{content}}", @html).gsub('{{index_class}}', '')
+      page_dir_path = "#{build_dir}/#{@parent.path.join('/')}"
+      FileUtils.mkdir_p page_dir_path
+      File.open("#{page_dir_path}/#{@slug}.html", 'w') { |f| f << page_html }
+    end
+  end
+
+
+  # A SiteLink represents an arbitrary link
+  class SiteLink < SiteNode
+    def initialize(filename, parent)
+      super
+      @link = File.read(filename).strip
+    end
+
+    # Builds the nav menu tag for this page
+    def nav_link(open_path=[])
+      return "" if @hidden
+      attrs = { 'class' => 'nav_link', 'href' => @link }
+      Hyphae::make_tag('a', @name, attrs)
+    end
+
+    # Builds html page (does nothing for a link)
+    def build(build_dir, template)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: hyphae
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Nicholas Rakita
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.1
+description: A Minimal SSG
+email: rakita@protonmail.ch
+executables:
+- hyphae
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/hyphae
+- lib/hyphae.rb
+homepage: https://rubygems.org/gems/hyphae
+licenses:
+- Unlicense
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Hyphae
+test_files: []