zarchitect 1.2.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77ba88dbb19220883ea69d691bc58b4516da67029bce35deace60accadf4a64b
-  data.tar.gz: 5ef24b5ca9adb8b94acbf94a6b4567ada8661e65f61d13af1626566feda220b2
+  metadata.gz: d3c85171bc5002d2fc4d485b41efdd70ab1031c4b028766a2c2d534c50ec0f6a
+  data.tar.gz: cceb00da64b1ed2d61f6c4be6f6c2375e43dc7a51b9426383457b74524c6d9e6
 SHA512:
-  metadata.gz: c3da6babfbfb768644da6fd6dbab8c6936e00beb7e1d379ff5a111c1b0ba39f24c46eeeb2431daab8161fcb734cbb1b1f560b4b264b7bc2a6512ba0d65596255
-  data.tar.gz: 3a3b0ade3688e980356cdcbb7cd4736273d96ea5a481ec4fe3f56399caed842970ab9097186ae7535b41f41b859dccb5925052ec4a63f69b8eff40177dd9ea7d
+  metadata.gz: 8ff57eaf919aae4fbfd9e1e98814794adbc2832c81ca446dbb89a998fb9371be779eb16062485657ba6eb76e00c2a83a47856f87686f94daaf1983ff6d9d409a
+  data.tar.gz: e0ff271242382ed66211c997c9b98c82b075ea1e6a2e340552bd4095151a31b8a0c254fce70074683d22258884b33ff0b5ba21fd701c606367afe786eff81c58

data/data/_zarchitect.yaml

@@ -2,7 +2,7 @@
 url: http://www.example.com
 email: user@example.com
 site_name: example.com
-site_slogan: the best exampled
+site_slogan: the best example
 site_description: "a short description of this website"
 admin: webmaster_name
 origin_year: 2020 # can be used for dynamic copyright notices
@@ -20,3 +20,13 @@ exclude_assets: # files with these extensions don't get copied into html tree
  - .scss
  - .scss.swp
  - .css.map
+
+# optional settings
+#og_image: 
+#og_image_alt:
+#og_image_width:
+#og_image_height:
+sm_post_changefreq: monthly
+sm_post_prio: 1.0
+sm_index_changefreq: weekly
+sm_index_prio: 0.5

data/data/post.md.erb

@@ -1,6 +1,7 @@
 # header
 ---
 id: <%= @id %>
+key: <%= @key %>
 title: <%= @title %>
 date: <%= @date %> 
 <% unless @category.nil? %>

data/lib/zarchitect/category.rb

@@ -1,5 +1,5 @@
 class Category < Zarchitect
-  attr_reader :key, :name, :section, :url, :tags
+  attr_reader :key, :name, :section, :url, :tags, :index
 
   def initialize(key, name, section)
     @key = key

data/lib/zarchitect/cmd_new.rb

@@ -10,8 +10,8 @@ module CMD
           "not exist."
         GPI.quit
       end
+      @category = nil
       if GPI::CLU.parameters.size > 2
-        @category = nil
         @category = @section.find_category(GPI::CLU.parameters[1])
         if @category.nil?
           GPI.print "Error: category with key #{GPI::CLU.parameters[1]} " +
@@ -27,11 +27,13 @@ module CMD
     end
 
     def run
+      check_key
       @id = get_id
       # write file
       a = ZERB.new(File.join(Util.path_to_data, "post.md.erb"))
       data = Hash.new
       data["title"] = @title
+      data["key"] = @title
       data["date"] = Time.now
       data["author"] = Zarchitect.conf.admin
       data["id"] = @id
@@ -52,6 +54,26 @@ module CMD
 
     private
 
+    def check_key
+      duplicate_key = false
+      context = ""
+      unless @category.nil?
+        @category.posts.each do |post|
+          duplicate_key = true if @title == post.key
+          context = "#{@section.key}/#{@category.key}"
+        end
+      else
+        @section.posts.each do |post|
+          duplicate_key = true if @title == post.key
+          context = "#{@section.key}"
+        end
+      end
+      if duplicate_key
+        GPI.print "Error: key {#{@title}} already present in #{context}."
+        GPI.quit
+      end
+    end
+
     def get_id
       t = Time.now.to_i
       id = t.to_s(16).downcase

data/lib/zarchitect/cmd_sitemap.rb

@@ -0,0 +1,124 @@
+module CMD
+
+  class Sitemap < Zarchitect
+
+    def initialize
+      Zarchitect.sconf.each { |s| Zarchitect.add_section(s) }
+      if GPI::CLU.check_option('v')
+        SitemapGenerator.verbose = true
+        SitemapGenerator::Sitemap.verbose = true
+      else
+        SitemapGenerator.verbose = false
+        SitemapGenerator::Sitemap.verbose = false
+      end
+      SitemapGenerator::Sitemap.default_host = Zarchitect.conf.url
+      SitemapGenerator::Sitemap.create_index = :auto
+      SitemapGenerator::Sitemap.public_path = Zarchitect::HTMLDIR
+    end
+
+    def run
+      reset_sitemap
+      build_sitemap
+    end
+
+    private
+
+    def reset_sitemap
+      Dir.glob(File.join(HTMLDIR,"sitemap*.xml.gz")) do |path|
+        if GPI::CLU.check_option('v')
+          GPI.print "Attempting to remove '#{path}'"
+        end
+        File.delete(path)
+        GPI.print "Removed '#{path}'" if GPI::CLU.check_option('v')
+      end
+    end
+
+    def build_sitemap
+      SitemapGenerator::Sitemap.create do 
+        Zarchitect.sections.each do |section|
+          # skip sections not meant to be included in sitemap
+          if section.conf.has_option?("sitemap")
+            next if section.conf.sitemap == 'exclude'
+          end
+          # set priority and changefrequency values
+          post_prio = 1.0
+          post_changefreq = 'monthly'
+          index_prio = 0.5
+          index_changefreq = 'weekly'
+          if section.conf.has_option?("sm_post_prio")
+            post_prio = section.conf.sm_post_prio
+          elsif Zarchitect.conf.has_option?("sm_post_prio")
+            post_prio = Zarchitect.conf.sm_post_prio
+          end
+          if section.conf.has_option?("sm_post_changefreq")
+            post_changefreq = section.conf.sm_post_changefreq
+          elsif Zarchitect.conf.has_option?("sm_post_changefreq")
+            post_changefreq = Zarchitect.conf.sm_post_changefreq
+          end
+          if section.conf.has_option?("sm_index_prio")
+            index_prio = section.conf.sm_index_prio
+          elsif Zarchitect.conf.has_option?("sm_index_prio")
+            index_prio = Zarchitect.conf.sm_index_prio
+          end
+          if section.conf.has_option?("sm_index_changefreq")
+            index_changefreq = section.conf.sm_index_changefreq
+          elsif Zarchitect.conf.has_option?("sm_index_changefreq")
+            index_changefreq = Zarchitect.conf.sm_index_changefreq
+          end
+
+          # add section indices
+          if section.index
+            section.index.pages.each do |index|
+              add index.url, :changefreq => index_changefreq,
+                :lastmod => File.mtime(index.path).strftime("%FT%T%:z"),
+                :priority => index_prio
+            end
+          end
+          # add category and tag indices
+          if section.conf.collection && section.conf.categorize
+            section.categories.each do |cat|
+              cat.index.pages.each do |index|
+                add index.url, :changefreq => index_changefreq,
+                  :lastmod => File.mtime(index.path).strftime("%FT%T%:z"),
+                  :priority => index_prio
+              end
+              if cat.tags
+                cat.tags.each do |tag|
+                  tag.index.pages.each do |index|
+                    add index.url, :changefreq => index_changefreq,
+                      :lastmod => File.mtime(index.path).strftime("%FT%T%:z"),
+                      :priority => index_prio
+                  end
+                end
+              end
+            end
+          end
+          # add posts and section contents
+          section.posts.each do |post|
+            # skip posts not meant to be included
+            if post.conf.has_option?("sitemap")
+              next if post.conf.sitemap == 'exclude'
+            end
+            prio = nil
+            changefreq = nil
+            if post.conf.has_option?("sm_prio")
+              prio = post.conf.sm_prio
+            else
+              prio = post_prio
+            end
+            if post.conf.has_option?("sm_changefreq")
+              changefreq = post.conf.sm_changefreq
+            else
+              changefreq = post_changefreq
+            end
+            add post.url, :changefreq => changefreq, 
+              :lastmod => File.mtime(post.source_path).strftime("%FT%T%:z"),
+              :priority => prio
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/zarchitect/html.rb

@@ -1,4 +1,5 @@
 class HTML < Zarchitect
+  attr_reader :meta, :data, :path
   
   def initialize(str)
     @data = Hash.new

data/lib/zarchitect/index.rb

@@ -1,6 +1,8 @@
 class Index < Zarchitect
+  attr_reader :pages
 
   def initialize(parent)
+    @pages = Array.new
     @parent = parent
     @ptype = @parent.class.to_s
     # index owns paginator
@@ -41,17 +43,39 @@ class Index < Zarchitect
   def setup_html
     @html = Array.new
     if @paginator.posts_per_page == 0
-      html = HTML.new(File.join(Dir.getwd,HTMLDIR,base_url,"index.html"))
+      url = File.join(base_url, "index.html")
+      path = File.join(Dir.getwd,HTMLDIR,base_url,"index.html")
+      @pages.push(IndexPage.new(path, url))
+      html = HTML.new(path)
       html.set_templates(layout, view)
+      html.set_data("url", url)
       html.set_data("section", section)
       html.set_data("category", category)
       html.set_data("tag", tag)
       html.set_data("posts", posts)
       html.set_data("index", true)
+
       html.set_meta("title", meta_title)
       html.set_meta("keywords", meta_keywords)
       html.set_meta("author", meta_author)
       html.set_meta("description", meta_description)
+
+      html.set_meta("og_type", "website")
+      html.set_meta("og_image", meta_og_image)
+      html.set_meta("og_image_alt", meta_og_image_alt)
+      html.set_meta("og_image_width", meta_og_image_width)
+      html.set_meta("og_image_height", meta_og_image_height)
+
+      unless html.meta["og_image"].nil?
+        if html.meta["og_image_width"] == html.meta["og_image_height"]
+          html.set_meta("twitter_card", "summary")
+        else
+          html.set_meta("twitter_card", "summary_large_image")
+        end
+      else
+        html.set_meta("twitter_card", nil)
+      end
+
       @html.push html
       return
     end
@@ -73,21 +97,43 @@ class Index < Zarchitect
                            @paginator.posts_per_page)
       if i == 0
         path = File.join(Dir.getwd,HTMLDIR,base_url, "index.html")
+        url = File.join(base_url, "index.html")
       else
         path = File.join(Dir.getwd,HTMLDIR,base_url, "index-#{i+1}.html")
+        url = File.join(base_url, "index-#{i+1}.html")
       end
+      @pages.push(IndexPage.new(path, url))
       html = HTML.new(path)
       html.set_templates(layout, view)
+      html.set_data("url", url)
       html.set_data("section", section)
       html.set_data("category", category)
       html.set_data("tag", tag)
       html.set_data("posts", rposts)
       html.set_data("paginator", @paginator.clone)
       html.set_data("index", true)
+
       html.set_meta("title", meta_title)
       html.set_meta("keywords", meta_keywords)
       html.set_meta("author", meta_author)
       html.set_meta("description", meta_description)
+
+      html.set_meta("og_type", "website")
+      html.set_meta("og_image", meta_og_image)
+      html.set_meta("og_image_alt", meta_og_image_alt)
+      html.set_meta("og_image_width", meta_og_image_width)
+      html.set_meta("og_image_height", meta_og_image_height)
+
+      unless html.meta["og_image"].nil?
+        if html.meta["og_image_width"] == html.meta["og_image_height"]
+          html.set_meta("twitter_card", "summary")
+        else
+          html.set_meta("twitter_card", "summary_large_image")
+        end
+      else
+        html.set_meta("twitter_card", nil)
+      end
+
       @html.push html
       i += 1
       @paginator.next
@@ -192,6 +238,16 @@ class Index < Zarchitect
     end
   end
 
+  def get_shared_option(opt)
+    if section.conf.has_option?(opt)
+      return section.conf.method(opt).call
+    elsif Zarchitect.conf.has_option?(opt)
+      return Zarchitect.conf.method(opt).call
+    else
+      return nil
+    end
+  end
+
   ##############################################
   # meta data
   #
@@ -213,11 +269,39 @@ class Index < Zarchitect
   end
 
   def meta_description
-    if category
-      section.name + " " + category.name
+    if section.conf.has_option?("description")
+      section.conf.description
+    elsif category
+      "#{section.name}:#{category.name}"
     else
-      section.name
+      "#{section.name}"
     end
   end
 
+  def meta_og_image
+    return get_shared_option("og_image")
+  end
+
+  def meta_og_image_alt
+    return get_shared_option("og_image_alt")
+  end
+
+  def meta_og_image_width
+    return get_shared_option("og_image_width")
+  end
+
+  def meta_og_image_height
+    return get_shared_option("og_image_height")
+  end
+
+end
+
+class IndexPage
+  attr_reader :url, :path
+
+  def initialize(path, url)
+    @url = url
+    @path = path
+  end
+
 end

data/lib/zarchitect/post.rb

@@ -1,6 +1,6 @@
 class Post < Zarchitect
   attr_reader :source_path, :html_path, :conf, :content, :name, :draft, :date,
-    :description, :url, :category
+    :description, :url, :category, :key
   attr_accessor :write_block
 
   def initialize(path, section)
@@ -11,6 +11,11 @@ class Post < Zarchitect
     @conf.validate_post
     @conf.setup
     @id = @conf.id.clone if @conf.has_option?("id")
+    if @conf.has_option?("key")
+      @key = @conf.key.clone
+    else
+      @key = @id.clone
+    end
     if @conf.has_option?("always_write")
       @always_write = @conf.always_write.clone 
     else
@@ -72,7 +77,7 @@ class Post < Zarchitect
       @category = c if @conf.category == c.key
     end
     if @category.nil?
-      GPI.print "Unable to find category #{@conf.category}."
+      GPI.print "Error: Unable to find category #{@conf.category}."
       GPI.quit
     end
   end
@@ -90,9 +95,11 @@ class Post < Zarchitect
   def set_url
     if @section.conf.collection
       if @section.conf.categorize
-        @url = "/#{@section.key}/#{@category.key}/#{@id}/index.html"
+        #@url = "/#{@section.key}/#{@category.key}/#{@id}/index.html"
+        @url = "/#{@section.key}/#{@category.key}/#{@key}.html"
       else
-        @url = "/#{@section.key}/#{@id}/index.html"
+        #@url = "/#{@section.key}/#{@id}/index.html"
+        @url = "/#{@section.key}/#{@key}.html"
       end
     else
       @url   = "/#{@section.key}/index.html"
@@ -107,9 +114,9 @@ class Post < Zarchitect
 
   def create_dir
     if @section.conf.collection && @section.conf.categorize
-      Util.mkdir(File.join(HTMLDIR, @section.key, @category.key, @id.to_s))
+      Util.mkdir(File.join(HTMLDIR, @section.key, @category.key))
     elsif @section.conf.collection
-      Util.mkdir(File.join(HTMLDIR, @section.key, @id.to_s))
+      Util.mkdir(File.join(HTMLDIR, @section.key))
     end
   end
 
@@ -178,6 +185,7 @@ class Post < Zarchitect
     @html = HTML.new(@html_path)
     @html.set_templates(@section.conf.layout, @section.conf.view)
 
+    @html.set_data("url", @url)
     @html.set_data("section", @section)
     @html.set_data("category", @category)
     @html.set_data("post", self)
@@ -188,12 +196,61 @@ class Post < Zarchitect
     @html.set_meta("keywords", meta_keywords)
     @html.set_meta("author", meta_author)
     @html.set_meta("description", @description)
+
+    @html.set_meta("og_type", meta_og_type)
+    @html.set_meta("og_image", meta_og_image)
+    @html.set_meta("og_image_alt", meta_og_image_alt)
+    @html.set_meta("og_image_width", meta_og_image_width)
+    @html.set_meta("og_image_height", meta_og_image_height)
+    @html.set_meta("twitter_card", meta_twitter_card)
   end
 
   ######################################
   # meta data
   #
   
+  def meta_twitter_card
+    if @conf.has_option?("twitter_card")
+      return @conf.twitter_card
+    else
+      unless @html.meta["og_image"].nil?
+        if @html.meta["og_image_width"] == @html.meta["og_image_height"]
+          return "summary"
+        else
+          return "summary_large_image"
+        end
+      else
+        return nil
+      end
+    end
+  end
+
+  def meta_og_image
+    return get_shared_option("og_image")
+  end
+
+  def meta_og_image_alt
+    return get_shared_option("og_image_alt")
+  end
+
+  def meta_og_image_width
+    return get_shared_option("og_image_width")
+  end
+
+  def meta_og_image_height
+    return get_shared_option("og_image_height")
+  end
+
+  def meta_og_type
+    if @conf.has_option?("og_type")
+      return @conf.og_type
+    elsif @section.conf.collection 
+      return "article"
+    else
+      return "website"
+    end
+  end
+  
   def meta_title
     title = "#{@name} - #{Zarchitect.conf.site_name}"
     if @section.conf.collection
@@ -225,4 +282,16 @@ class Post < Zarchitect
     end
   end
 
+  def get_shared_option(opt)
+    if @conf.has_option?(opt)
+      return @conf.method(opt).call
+    elsif @section.conf.has_option?(opt)
+      return @section.conf.method(opt).call
+    elsif Zarchitect.conf.has_option?(opt)
+      return Zarchitect.conf.method(opt).call
+    else
+      return nil
+    end
+  end
+
 end

data/lib/zarchitect/section.rb

@@ -1,7 +1,8 @@
 class Section < Zarchitect
-  attr_reader :key, :conf, :name, :categories, :url
+  attr_reader :key, :conf, :name, :categories, :url, :index
 
   def initialize(conf)
+    @index = false
     GPI.print "Initializing Section #{conf.key}.", GPI::CLU.check_option('v')
     @conf = conf
     @key = conf.key

data/lib/zarchitect/tag.rb

@@ -1,10 +1,10 @@
 class Tag < Zarchitect
-  attr_accessor :category, :name, :key, :url
+  attr_accessor :category, :name, :key, :url, :index
 
   def initialize(str, cat)
     @category = cat
     @name = str
-    @key = hash(str)
+    set_key
     @url = "/#{@category.section.key}/#{@category.key}/#{@key}/index.html"
     create_dir
     setup_index
@@ -43,4 +43,21 @@ class Tag < Zarchitect
     str2.to_s(16).downcase
   end
 
+  private 
+
+  def set_key
+    if Zarchitect.conf.has_option?("tags")
+      @key = Zarchitect.conf.tags.key(@name)
+      if (@key == nil)
+        @key = Zarchitect.conf.tags.key(@name.downcase)
+        if (@key == nil)
+          GPI.print "Error: No tag key found for '#{@name}'."
+          GPI.quit
+        end
+      end
+    else
+      @key = hash(str)
+    end
+  end
+
 end

data/lib/zarchitect.rb

@@ -5,9 +5,11 @@ require 'sanitize'
 require 'rss'
 require 'nokogiri'
 require 'katex'
+require 'sitemap_generator'
 
 class Zarchitect
 
+  VERSION = "1.6.0"
   HTMLDIR = "_html"
   BUILDIR = "_build"
   NODEDIR = "_build/nodes"
@@ -35,6 +37,9 @@ class Zarchitect
     GPI::CLU.use_command("u", [0], "rvqdD")
     GPI::CLU.use_command("update", [0], "rvqdD")
 
+    GPI::CLU.use_command("s", [0], "v")
+    GPI::CLU.use_command("sitemap", [0], "v")
+
     GPI::CLU.use_command("ua", [0], "v")
     GPI::CLU.use_command("update-assets", [0], "v")
 
@@ -60,6 +65,10 @@ class Zarchitect
       load_conf
       cmd = CMD::New.new
       cmd.run
+    when "sitemap", "s"
+      load_conf
+      cmd = CMD::Sitemap.new
+      cmd.run
     when "update","u"
       load_conf
       cmd = CMD::Update.new
@@ -179,6 +188,7 @@ require 'zarchitect/image_set.rb'
 require 'zarchitect/index.rb'
 require 'zarchitect/cmd_misc.rb'
 require 'zarchitect/cmd_new.rb'
+require 'zarchitect/cmd_sitemap.rb'
 require 'zarchitect/cmd_update.rb'
 require 'zarchitect/misc_file.rb'
 require 'zarchitect/post.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zarchitect
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.6.0
 platform: ruby
 authors:
 - ryu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-29 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies: []
 description: Yet another static website generator
 email: ryu@tohya.net
@@ -26,6 +26,7 @@ files:
 - lib/zarchitect/category.rb
 - lib/zarchitect/cmd_misc.rb
 - lib/zarchitect/cmd_new.rb
+- lib/zarchitect/cmd_sitemap.rb
 - lib/zarchitect/cmd_update.rb
 - lib/zarchitect/config.rb
 - lib/zarchitect/content.rb
@@ -46,7 +47,7 @@ files:
 - lib/zarchitect/util.rb
 - lib/zarchitect/video.rb
 - lib/zarchitect/zerb.rb
-homepage: https://www.tohya.net/projects/other/5faa82d2/index.html
+homepage: https://www.tohya.net/projects/web/zarchitect.html
 licenses:
 - GPL-3.0
 metadata: {}