pbsimply 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f75e4f4e81729dbe5a291d473f1f2dc83bd51d52076179bd1a5517cf6bde380
-  data.tar.gz: df909fb121e61744b056e0d934e07acd43d88d1630873c78910cc92a6462c390
+  metadata.gz: 6fcd2dee987b89244eefee781f2992241ee22b1ad7093481d515096fdc69e002
+  data.tar.gz: 9cd6f3c059ee7e524e8cad9ceaefcd5af15e622e24cd51dbbce4e148f9913f92
 SHA512:
-  metadata.gz: 06417d28977298a737faee844340700128d9d047d938ea16737ede93d1d8609e6844d0f3b49c138b4129b9c658f9a1444f38eb89e80848aa3362e1d04b47b720
-  data.tar.gz: da761d0166bc05e276296b449393f2914ea6b462ebe28d6d96ea1f392323bfa919864c3d655e1279029f57773cbdd7d89464cb33f0f74be28032455ddd275ac2
+  metadata.gz: 2685884928fc07a47d674b8a9b91b4c8fa91c9f2d510de24d984842bf29b40ff658950c68ae4d7c235bf519ccd2420cb5ae606f78db759e642d63a9a0ac04490
+  data.tar.gz: d6c32c4d2d9aa25abe78ec986934e4259f7823f263a34a8d33a98b282e8cd45dca968a3f244567c00e3d208ad6da1afdf2163e71e2c65f8a1e0f93b5c838128b

data/bin/pbsimply

@@ -2,35 +2,37 @@
 
 require 'pbsimply'
 
-PBSimply.find_docroot
-config = PBSimply.load_config
+begin
+  PBSimply.find_docroot
+  config = PBSimply.load_config
 
-pbs_class = case config["pbsimply_processor"]
-when "docutils"
-  PBSimply::Processor::Docutils
-when "redcarpet"
-  PBSimply::Processor::PbsRedCarpet
-when "kramdown"
-  PBSimply::Processor::PbsKramdown
-when "cmark"
-  PBSimply::Processor::PbsCommonMark
-when "rdoc_markdown"
-  PBSimply::Processor::PbsRMakrdown
-when "rdoc"
-  PBSimply::Processor::PbsRDoc
-else
-  PBSimply::Processor::Pandoc
-end
+  pbs_class = case config["pbsimply_processor"]
+  when "docutils"
+    PBSimply::Processor::Docutils
+  when "redcarpet"
+    PBSimply::Processor::PbsRedCarpet
+  when "kramdown"
+    PBSimply::Processor::PbsKramdown
+  when "cmark"
+    PBSimply::Processor::PbsCommonMark
+  when "rdoc_markdown"
+    PBSimply::Processor::PbsRMakrdown
+  when "rdoc"
+    PBSimply::Processor::PbsRDoc
+  else
+    PBSimply::Processor::Pandoc
+  end
 
-# Alias for compatibility.
-PureBuilder = pbs_class
+  # Alias for compatibility.
+  PureBuilder = pbs_class
 
-begin
   pbs = pbs_class.new(config)
   pbs.treat_cmdline
 
   pbs.main
-rescue PBSimply::CommandLineError => e
-  $stderr.puts e.to_s
-  exit 1
+rescue PBSimply::PBSimplyError => e
+  if PBSimply::ConfigChecker::InvalidConfigError === e.original_error
+    $stderr.puts e.original_error
+  end
+  abort e.to_s
 end

data/bin/pbsimply-init

@@ -2,8 +2,28 @@
 require 'yaml'
 require 'fileutils'
 require 'optparse'
+require 'erb'
 
 class PBSimplyInit
+  class ConfigErb
+    def initialize theme_dir, source_dir, build_dir
+      @theme_dir = theme_dir
+      @source_dir = source_dir
+      @build_dir = build_dir
+
+      @erb = ERB.new(File.read(File.join(@source_dir, ".pbsimply.yaml.erb")), trim_mode: "%")
+    end
+    
+    attr_writer :processor
+
+    def generate
+      generated_config = @erb.result(binding)
+      File.open(File.join(@source_dir, ".pbsimply.yaml"), "w") do |f|
+        f.puts generated_config
+      end
+      File.delete(File.join(@source_dir, ".pbsimply.yaml.erb"))
+    end
+  end
   def initialize
     set_gemroot
     load_default_theme
@@ -33,6 +53,8 @@ class PBSimplyInit
       list_theme
       exit true
     end
+
+    @config_erb_params = {}
   end
 
   def list_theme
@@ -43,8 +65,19 @@ class PBSimplyInit
         themes[theme_name] ||= YAML.load File.read i
       end
     end
-    themes.each do |k, v|
-      puts [k, v["name"], v["description"]].join("   ")
+
+    # Expand rbmdlib -> [kramdown, redcarpet, cmark]
+    rbmdlib = themes.keys.select {|i| i =~ %r:^rbmdlib/: }
+    rbmdlib.each do |k|
+      themes[k.sub(%r:^rbmdlib/:, "kramdown/")] = themes[k]
+      themes[k.sub(%r:^rbmdlib/:, "redcarpet/")] = themes[k]
+      themes[k.sub(%r:^rbmdlib/:, "cmark/")] = themes[k]
+      themes.delete k
+    end
+
+    sorted_keys = themes.keys.sort
+    sorted_keys.each do |k|
+      puts [k, themes[k]["name"], themes[k]["description"]].join("   ")
     end
   end
 
@@ -82,6 +115,20 @@ class PBSimplyInit
     else
       @theme = @default_theme
     end
+
+    @config_erb_params[:processor] = @theme[0]
+
+    if %w:kramdown redcarpet cmark:.include? @theme[0]
+      unified_theme = @theme.clone
+      unified_theme[0] = "rbmdlib"
+      theme_path = search_theme unified_theme
+      if theme_path
+        @config_erb_params[:theme_dir] = theme_path
+        @theme = unified_theme
+        return load_theme_yaml theme_path
+      end
+    end
+
     theme_path = search_theme @theme
     load_theme_yaml theme_path
   end
@@ -134,6 +181,13 @@ class PBSimplyInit
           FileUtils.cp_r(File.join(@source_dir, *i), @build_dir)
         end
       end
+
+      if @theme_yaml["config_erb"]
+        $stderr.puts "Building .pbsimply.yaml..."
+        erb = ConfigErb.new(@config_erb_params[:theme_dir], @source_dir, @build_dir)
+        erb.processor = @config_erb_params[:processor]
+        erb.generate
+      end
     end
 
     $stderr.puts "Done"

data/lib/pbsimply/config-checker.rb

@@ -2,9 +2,6 @@
 
 class PBSimply
   class ConfigChecker
-    class InvalidConfigError < StandardError
-    end
-
     def self.verify_config config
       # blessmethod_accs_rel
       if config["blessmethod_accs_rel"] && ! %w:numbering date timestamp lexical:.include?(config["blessmethod_accs_rel"])

data/lib/pbsimply/docengine/docutils.rb

@@ -19,7 +19,7 @@ class PBSimply
           elsif @config["css"].kind_of?(Array)
             @docutils_cli_options.push("--stylesheet=#{@config["css"].join(",")}")
           else
-            abort "css in Config should be a String or an Array."
+            raise PBLoadError.new "css in Config should be a String or an Array."
           end
         end
 
@@ -44,9 +44,9 @@ class PBSimply
           doc = io.read
         end
 
-        # Abort if pandoc returns non-zero status
+        # Abort if docutils returns non-zero status
         if $?.exitstatus != 0
-          abort "Docutils (rst2html5) returns exit code #{$?.exitstatus}"
+          raise ProcessorError.new "Docutils (rst2html5) returns exit code #{$?.exitstatus}"
         end
 
         doc

data/lib/pbsimply/docengine/misc.rb

@@ -66,14 +66,14 @@ class PBSimply
       end
 
       def print_fileproc_msg(filename)
-        $stderr.puts "#{filename} generate with CommonMarker (cmark-gfm)"
+        $stderr.puts "#{filename} generate with Commonmarker (cmark-gfm)"
       end
 
       def process_document(dir, filename, frontmatter, orig_filepath, ext, procdoc)
-        options = @config["commonmarker_options"]&.map(&:to_sym) || [:table, :strikethrough]
+        options = @config["commonmarker_options"] ? @config["commonmarker_options"].transform_keys(&:to_sym) : {}
 
         # Getting HTML string.
-        article_body = CommonMarker.render_doc(File.read(procdoc), :DEFAULT, options).to_html
+        article_body = Commonmarker.parse(File.read(procdoc), options: options).to_html
 
         # Process with eRuby temaplte.
         erb_template = ERB.new(File.read(@config["template"]), trim_mode: '%<>')

data/lib/pbsimply/docengine/pandoc.rb

@@ -37,7 +37,7 @@ class PBSimply
           elsif @config["css"].kind_of?(Array)
             @pandoc_default_file["css"] = @config["css"]
           else
-            abort "css in Config should be a String or an Array."
+            raise PBLoadError.new "css in Config should be a String or an Array."
           end
         end
 
@@ -71,14 +71,14 @@ class PBSimply
           pandoc_cmdline += ["-f", @pandoc_input_extmap[File.extname filename]]
         end
         pandoc_cmdline += [ procdoc ]
-        pp pandoc_cmdline if @debug
+        pp pandoc_cmdline if $debug
         IO.popen((pandoc_cmdline)) do |io|
           doc = io.read
         end
 
         # Abort if pandoc returns non-zero status
         if $?.exitstatus != 0
-          abort "Pandoc returns exit code #{$?.exitstatus}"
+          raise ProcessorError.new "Pandoc returns exit code #{$?.exitstatus}"
         end
 
         doc

data/lib/pbsimply/document.rb

@@ -4,15 +4,17 @@ class PBSimply
   class Document
     include Frontmatter
 
-    def initialize(config, dir, filename, base_frontmatter, now)
-      @config = config
-      @dir = dir
+    def initialize(pbs, filename)
+      @config = pbs.config
+      @dir = pbs.dir
       @filename = filename
       @ext = File.extname filename
-      @orig_filepath = File.join(dir, filename)
-      @now = now
-      frontmatter, @pos = read_frontmatter(dir, filename)
-      @frontmatter = base_frontmatter.merge frontmatter
+      @orig_filepath = File.join(pbs.dir, filename)
+      @now = pbs.now
+      @accs_processing = pbs.accs_processing
+      @outfile = pbs.outfile
+      frontmatter, @pos = read_frontmatter(pbs.dir, filename)
+      @frontmatter = pbs.frontmatter.merge frontmatter
       @modified = true
       @proc_doc_path = nil
     end

data/lib/pbsimply/frontmatter.rb

@@ -131,8 +131,8 @@ module PBSimply::Frontmatter
       end
     end
 
-    abort "This document has no frontmatter" unless frontmatter
-    abort "This document has no title." unless frontmatter["title"]
+    raise DocumentError.new("This document has no frontmatter") unless frontmatter
+    raise DocumentError.new("This document has no title.") unless frontmatter["title"]
 
     outpath = case
     when @outfile

data/lib/pbsimply/prayer.rb

@@ -50,11 +50,11 @@ module PBSimply::Prayer
     File.open(@workfile_frontmatter, "w") {|f| f.write PBSimply::JSON_LIB.dump(frontmatter) }
     # BLESSING (Always)
     if @config["bless_cmd"]
-      (Array === @config["bless_cmd"] ? system(*@config["bless_cmd"]) : system(@config["bless_cmd"]) ) or abort "*** BLESS COMMAND RETURNS NON-ZERO STATUS"
+      (Array === @config["bless_cmd"] ? system(*@config["bless_cmd"]) : system(@config["bless_cmd"]) ) or raise BlessError.new "*** BLESS COMMAND RETURNS NON-ZERO STATUS"
     end
     # BLESSING (ACCS)
     if @config["bless_accscmd"]
-      (Array === @config["bless_accscmd"] ? system({"pbsimply_workdir" => @workdir, "pbsimply_frontmatter" => @workfile_frontmatter, "pbsimply_indexes" => @db.path}, *@config["bless_accscmd"]) : system({"pbsimply_workdir" => @workdir, "pbsimply_frontmatter" => @workfile_frontmatter, "pbsimply_indexes" => @db.path}, @config["bless_accscmd"]) ) or abort "*** BLESS COMMAND RETURNS NON-ZERO STATUS"
+      (Array === @config["bless_accscmd"] ? system({"pbsimply_workdir" => @workdir, "pbsimply_frontmatter" => @workfile_frontmatter, "pbsimply_indexes" => @db.path}, *@config["bless_accscmd"]) : system({"pbsimply_workdir" => @workdir, "pbsimply_frontmatter" => @workfile_frontmatter, "pbsimply_indexes" => @db.path}, @config["bless_accscmd"]) ) or raise BlessError.new "*** BLESS COMMAND RETURNS NON-ZERO STATUS"
     end
     mod_frontmatter = JSON.load(File.read(@workfile_frontmatter))
     frontmatter.replace(mod_frontmatter)
@@ -77,14 +77,14 @@ module PBSimply::Prayer
           when "date"
             begin
               @article_order = @indexes.to_a.sort_by {|i| i[1]["date"]}
-            rescue
-              abort "*** Automatic Blessing Method Error: Maybe some article have no date."
+            rescue => e
+              raise BlessError.new("*** Automatic Blessing Method Error: Maybe some article has no date.", e)
             end
           when "timestamp"
             begin
               @article_order = @indexes.to_a.sort_by {|i| i[1]["timestamp"]}
-            rescue
-              abort "*** Automatic Blessing Method Error: Maybe some article have no timetsamp."
+            rescue => e
+              raise BlessError.new("*** Automatic Blessing Method Error: Maybe some article has no timetsamp.", e)
             end
           when "lexical"
             @article_order = @indexes.to_a.sort_by {|i| i[1]["_filename"]}

data/lib/pbsimply.rb

@@ -26,7 +26,37 @@ class PBSimply
   include ACCS
 
   # Custom exception
-  class CommandLineError < StandardError
+  class PBSimplyError < StandardError
+    def initialize(*arg)
+      @original_error = nil
+      if arg.size == 2
+        @original_error = arg.pop
+        print_error(@original_error)
+      end
+
+      super(*arg)
+    end
+
+    attr_reader :original_error
+
+    private
+    def print_error(e)
+      $stderr.puts e.full_message if $debug && e
+    end
+  end
+  class CommandLineError < PBSimplyError
+  end
+  class BlessError < PBSimplyError
+  end
+  class PBLoadError < PBSimplyError
+  end
+  class DocumentError < PBSimplyError
+  end
+  class ProcessorError < PBSimplyError
+  end
+  class ConfigChecker
+    class InvalidConfigError < PBSimplyError
+    end
   end
 
   # Use Oj as JSON library for frontmatter passing if possible.
@@ -47,7 +77,7 @@ class PBSimply
     until File.exist?(".pbsimply.yaml")
       Dir.chdir ".."
       if lastwd == Dir.pwd
-        abort "PureBuilder Simply document root not found."
+        raise PBLoadError.new "PureBuilder Simply document root not found."
       end
       lastwd = Dir.pwd
     end
@@ -61,14 +91,12 @@ class PBSimply
         config = Psych.unsafe_load(f)
       end
       ConfigChecker.verify_config config
-    rescue PBSimply::ConfigChecker::InvalidConfigError
-      abort $!.to_s
-    rescue
-      abort "Failed to load config file (./.pbsimply.yaml)"
+    rescue => e
+      raise PBLoadError.new "Failed to load config file (./.pbsimply.yaml)", e
     end
 
     # Required values
-    config["outdir"] or abort "Output directory is not set (outdir)."
+    config["outdir"] or raise PBLoadError.new "Output directory is not set (outdir)."
     config["template"] ||= "./template.html"
 
     config
@@ -129,10 +157,15 @@ class PBSimply
     @accs_index = {}
     @now = Time.now
     @hooks = PBSimply::Hooks.new(self, @config)
+    @dir = nil
+    @frontmatter = {}
+    @accs_processing = false
 
-    @debug = (ENV["DEBUG"] == "yes")
+    $debug = (ENV["DEBUG"] == "yes")
   end
 
+  attr_reader :config, :dir, :frontmatter, :now, :accs_processing, :outfile
+
   # Process command-line
   def treat_cmdline(dir=nil)
     # Options definition.
@@ -145,6 +178,7 @@ class PBSimply
     opts.on("-o FILE", "--output") {|v| @outfile = v }
     opts.on("-m FILE", "--additional-metafile") {|v| @add_meta = Psych.unsafe_load(File.read(v))}
     opts.on("-a", "--only-accs") { @accs_only = true }
+    opts.on("--debug") { $debug = true }
     opts.parse!(ARGV)
 
     if File.exist?(".pbsimply-bless.rb")
@@ -188,6 +222,7 @@ class PBSimply
   def proc_dir
     draft_articles = []
     target_docs = []
+    effective_docs = []
     $stderr.puts "in #{@dir}..."
 
     $stderr.puts "Checking Frontmatter..."
@@ -207,7 +242,7 @@ class PBSimply
       end
 
       $stderr.puts "Checking frontmatter in #{filename}"
-      doc = Document.new(@config, @dir, filename, @frontmatter, @now)
+      doc = Document.new(self, filename)
 
       if doc.draft?
         draft_articles.push({
@@ -219,9 +254,13 @@ class PBSimply
       end
 
       doc.orig_frontmatter = @indexes[filename]
+      @indexes[filename] = doc.frontmatter
 
       # Push to target documents without checking modification.
       target_docs.push(doc)
+
+      # Push to all effective documents.
+      effective_docs.push(doc)
     end
     ENV.delete("pbsimply_currentdoc")
     ENV.delete("pbsimply_filename")
@@ -231,20 +270,9 @@ class PBSimply
     proc_docs target_docs
 
     delete_missing
-
-    # Update modified doc's frontmatter
-    if @preflight
-      target_docs.each do |doc|
-        @indexes[doc.filename] = doc.effective_forntmatter
-      end
-    else
-      target_docs.each do |doc|
-        @indexes[doc.filename] = doc.frontmatter
-      end
-    end
     
     # Save index.
-    @db.dump(@indexes) unless @skip_index
+    save_index(effective_docs) unless @skip_index
 
     # ACCS processing
     if @accs && !target_docs.empty?
@@ -371,7 +399,7 @@ class PBSimply
 
         load_index
 
-        doc = Document.new(@config, dir, filename, @frontmatter, @now)
+        doc = Document.new(self, filename)
         @index = doc.frontmatter
 
         proc_docs([doc])
@@ -479,4 +507,12 @@ class PBSimply
       raise CommandLineError.new "ACCS-only processing needs ACCS directory as an argument."
     end
   end
+
+  def save_index(effective_docs)
+    new_indexes = {}
+    effective_docs.each do |doc|
+      new_indexes[doc.filename] = doc.effective_forntmatter
+    end
+    @db.dump(new_indexes)
+  end
 end

data/themes/pandoc/_pandoc_base/.pbsimply.yaml

@@ -106,12 +106,12 @@ pandoc_additional_options:
 #redcarpet_extensions: {}
 #
 #################################################
-# CommonMarker engine option
+# Commonmarker engine option
 #################################################
 #pbsimply_processor: cmark
 #
-# An array showing `CommonMarker.render_doc`'s 3rd agrument.
-#commonmarker_options: []
+# An Hash showing `Commonmarker.prase`'s `options` argument.
+#commonmarker_options: {}
 #
 #################################################
 # Docutils engine option

data/themes/pandoc/_pandoc_new/.pbsimply.yaml

@@ -103,12 +103,12 @@ pandoc_additional_options:
 #redcarpet_extensions: {}
 #
 #################################################
-# CommonMarker engine option
+# Commonmarker engine option
 #################################################
 #pbsimply_processor: cmark
 #
-# An array showing `CommonMarker.render_doc`'s 3rd agrument.
-#commonmarker_options: []
+# An Hash showing `Commonmarker.prase`'s `options` argument.
+#commonmarker_options: {}
 #
 #################################################
 # Docutils engine option

data/themes/{kramdown/init322/.pbsimply.yaml → rbmdlib/init322/.pbsimply.yaml.erb}

@@ -88,24 +88,36 @@ self_url_external_prefix: https://example.com/
 #################################################
 # Kramdown engine option
 #################################################
+% if @processor == "kramdown"
 pbsimply_processor: kramdown
+% else
+#pbsimply_processor: kramdown
+% end
 # An associative array passed as the second argument to `Kramdown::Document.new`. See the https://kramdown.gettalong.org/rdoc/Kramdown/Options.html for detail.
 #kramdown_features: {}
 #
 #################################################
 # RedCarpet engine option
 #################################################
+% if @processor == "redcarpet"
+pbsimply_processor: redcarpet
+% else
 #pbsimply_processor: redcarpet
+% end
 # An associative array showing the extensions to Redcarpet. See the https://github.com/vmg/redcarpet for details.
 #redcarpet_extensions: {}
 #
 #################################################
-# CommonMarker engine option
+# Commonmarker engine option
 #################################################
+% if @processor == "cmark"
+pbsimply_processor: cmark
+% else
 #pbsimply_processor: cmark
+% end
 #
-# An array showing `CommonMarker.render_doc`'s 3rd agrument.
-#commonmarker_options: []
+# An Hash showing `Commonmarker.prase`'s `options` argument.
+#commonmarker_options: {}
 #
 #################################################
 # Docutils engine option

data/themes/{kramdown → rbmdlib}/init322/.theme.yaml

@@ -2,4 +2,5 @@ name: Init_3.2.2
 description: Theme used in PureBuilder Simply 3.2.2's pbsimply-init.
 initial_control:
   build_cpr:
-    - [css]
+    - [css]
+config_erb: true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pbsimply
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Masaki Haruka
@@ -11,7 +11,7 @@ date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A flexible, programmable static site generator for Markdown, reStructuredText,
   and RDoc formats. PureBuilder Simply supports both embedded and external content
-  processors—including Kramdown, Redcarpet, CommonMarker, RDoc, Pandoc, Docutils—and
+  processors—including Kramdown, Redcarpet, Commonmarker, RDoc, Pandoc, Docutils—and
   enables customizable conversion workflows and CLI-based project generation.
 email:
 - yek@reasonset.net
@@ -43,15 +43,6 @@ files:
 - lib/pbsimply/prayer.rb
 - themes/contribute/README.md
 - themes/default.yaml
-- themes/kramdown/init322/.accsindex.erb
-- themes/kramdown/init322/.pbsimply.yaml
-- themes/kramdown/init322/.theme.yaml
-- themes/kramdown/init322/articles/.accs.yaml
-- themes/kramdown/init322/articles/20231028-untitled.md
-- themes/kramdown/init322/css/style.css
-- themes/kramdown/init322/index.md
-- themes/kramdown/init322/menu.yaml
-- themes/kramdown/init322/template.erb
 - themes/pandoc/_pandoc_base/.accsindex.erb
 - themes/pandoc/_pandoc_base/.pbsimply.yaml
 - themes/pandoc/_pandoc_base/css/base.css
@@ -86,6 +77,15 @@ files:
 - themes/pandoc/practical/css/layout.css
 - themes/pandoc/warm/.theme.yaml
 - themes/pandoc/warm/css/base.css
+- themes/rbmdlib/init322/.accsindex.erb
+- themes/rbmdlib/init322/.pbsimply.yaml.erb
+- themes/rbmdlib/init322/.theme.yaml
+- themes/rbmdlib/init322/articles/.accs.yaml
+- themes/rbmdlib/init322/articles/20231028-untitled.md
+- themes/rbmdlib/init322/css/style.css
+- themes/rbmdlib/init322/index.md
+- themes/rbmdlib/init322/menu.yaml
+- themes/rbmdlib/init322/template.erb
 homepage: https://purebuilder.app/
 licenses:
 - Apache-2.0