pbsimply 3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b3583d8259481a06d6ac35e90619841a2b3dedda0689db267c61679c06ceed2
-  data.tar.gz: 69160342826f79285f050b9358b315267376337bd03ccf80d4808d2e38be992d
+  metadata.gz: 2f75e4f4e81729dbe5a291d473f1f2dc83bd51d52076179bd1a5517cf6bde380
+  data.tar.gz: df909fb121e61744b056e0d934e07acd43d88d1630873c78910cc92a6462c390
 SHA512:
-  metadata.gz: a0f0112820966f4d03e5ae46210eee0dfeac73faa81534ea1dadd40c55f08723026352ce882721f92bdb3285d28edfb8ee852b3d8bae966bd857b8c4227aaa0d
-  data.tar.gz: 584cbb371bceb868d89ba6265dbef0029eab4598e5db3d575888c8b8af37070f8e48bc677f1c3d183212cfbdbb5b09a2d70478cc60d1c3432428c39ffe8a432a
+  metadata.gz: 06417d28977298a737faee844340700128d9d047d938ea16737ede93d1d8609e6844d0f3b49c138b4129b9c658f9a1444f38eb89e80848aa3362e1d04b47b720
+  data.tar.gz: da761d0166bc05e276296b449393f2914ea6b462ebe28d6d96ea1f392323bfa919864c3d655e1279029f57773cbdd7d89464cb33f0f74be28032455ddd275ac2

data/README.md

@@ -34,7 +34,11 @@ PB Simply ACCS make `index.md` with indexes build by PureBuilder.
 ## Dependency
 
 * Ruby >= 3.0
-* Pandoc >= 2.8
+* Pandoc >= 2.8 (Optional)
+* Docutils (Optional)
+* redcarpet Gem (Optional)
+* kramdown Gem (Optional)
+* commonmarker Gem (Optional)
 
 ## Usage
 

data/bin/pbsimply

@@ -25,6 +25,12 @@ end
 # Alias for compatibility.
 PureBuilder = pbs_class
 
-pbs = pbs_class.new(config)
-pbs.treat_cmdline
-pbs.main
+begin
+  pbs = pbs_class.new(config)
+  pbs.treat_cmdline
+
+  pbs.main
+rescue PBSimply::CommandLineError => e
+  $stderr.puts e.to_s
+  exit 1
+end

data/lib/pbsimply/docengine/pandoc.rb

@@ -85,7 +85,6 @@ class PBSimply
       end
 
       def target_file_extensions
-        p [".md", ".rst"] + @pandoc_input_extmap.keys
         [".md", ".rst"] + @pandoc_input_extmap.keys
       end
     end

data/lib/pbsimply/document.rb

@@ -0,0 +1,110 @@
+require 'pbsimply/frontmatter'
+
+class PBSimply
+  class Document
+    include Frontmatter
+
+    def initialize(config, dir, filename, base_frontmatter, now)
+      @config = config
+      @dir = 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
+      @modified = true
+      @proc_doc_path = nil
+    end
+
+    attr_reader :frontmatter, :filename, :pos, :ext, :proc_doc_path, :orig_filepath
+    attr_accessor :orig_frontmatter, :now
+
+    def add_meta(additional_meta)
+      frontmatter.merge!(additional_meta)
+    end
+
+    def read_document(workdir: "")
+      File.open(File.join(@dir, @filename)) do |f|
+        f.seek(@pos)
+        doc_content = f.read
+        if @config["unicode_normalize"] && !@frontmatter["skip_normalize"]
+          doc_content.unicode_normalize!(@config["unicode_normalize"].to_sym)
+        end
+        File.open(File.join(workdir, "current_document#{@ext}"), "w") do |fo|
+          fo.write doc_content
+        end
+      end
+
+      @proc_doc_path = File.join(workdir, "current_document#{@ext}")
+    end
+
+    def draft?
+      frontmatter["draft"]
+    end
+
+    def to_a
+      [@dir, @filename, @frontmatter]
+    end
+
+    # Check is the article modified? (or force update?)
+    def modified?
+      index = @orig_frontmatter ||= {}
+
+      case @config["detect_modification"]
+      when "changes"
+        # Use "changes"
+        @modified = false if @frontmatter["changes"] == index["changes"]
+      when "mtimesize"
+        # Use mtime and file size.
+        @modified = false if @frontmatter["_mtime"] <= (index["_last_proced"] || 0) && @frontmatter["_size"] == index["_size"]
+      else
+        # Default method, use mtime.
+        @modified = false if @frontmatter["_mtime"] <= (index["_last_proced"] || 0)
+      end
+
+      if @modified
+        $stderr.puts "#{@filename} last modified at #{@frontmatter["_mtime"]}, last processed at #{index["_last_proced"] || 0}"
+      else
+        $stderr.puts "#{@filename} is not modified."
+      end
+
+      set_timestamp
+
+      if @frontmatter["skip_update"]
+        # Document specific skip update
+        @modified = false
+      elsif index["_modified"]
+        @modified = true
+      else
+        @modified
+      end
+    end
+
+    def mark_meta_modified
+      # Frontmatter used as a reference for metadata update detection.
+      # Keys that are always updated during processing should be removed.
+      ex_keys = ["_last_proced", "last_update"] + (@config["compr_ex_keys"] || [])
+      @orig_frontmatter ||= {}
+      compr_frontmatter = @orig_frontmatter.except(*ex_keys) # Hash#except from Ruby 2.0
+
+      if compr_frontmatter == frontmatter
+        @modified = false
+      else
+        @frontmatter["_modified"] = true
+        @frontmatter.merge!(@orig_frontmatter.slice(*ex_keys))
+      end
+    end
+
+    def effective_forntmatter
+      @modified ? @frontmatter : @orig_frontmatter
+    end
+
+    private
+
+    def set_timestamp
+      @frontmatter["_last_proced"] = @now.to_i
+      @frontmatter["last_update"] = @now.strftime("%Y-%m-%d %H:%M:%S")
+    end
+  end
+end

data/lib/pbsimply/frontmatter.rb

@@ -211,6 +211,8 @@ module PBSimply::Frontmatter
     return frontmatter, pos
   end
 
+  private
+
   def outext frontmatter
     return frontmatter["force_ext"] if frontmatter["force_ext"]
 

data/lib/pbsimply/hooks.rb

@@ -107,11 +107,5 @@ class PBSimply::Hooks
     end
   end
 
-  attr :pre
-  attr :process
-  attr :delete
-  attr :post
-  attr :accs
-
-  attr :config
+  attr_reader :pre, :process, :delete, :post, :accs, :config
 end

data/lib/pbsimply.rb

@@ -8,6 +8,7 @@ require 'tmpdir'
 require 'fileutils'
 require 'optparse'
 require 'digest/sha1'
+require 'set' # It's not needed since Ruby 3.2
 
 # PureBuilder Simply Components
 require 'pbsimply/docdb'
@@ -15,16 +16,19 @@ require 'pbsimply/docengine/base'
 require 'pbsimply/prayer'
 require 'pbsimply/plugger'
 require 'pbsimply/hooks'
-require 'pbsimply/frontmatter'
 require 'pbsimply/accs'
 require 'pbsimply/config-checker.rb'
+require 'pbsimply/document'
 
 class PBSimply
   include Prayer
   include Plugger
-  include Frontmatter
   include ACCS
 
+  # Custom exception
+  class CommandLineError < StandardError
+  end
+
   # Use Oj as JSON library for frontmatter passing if possible.
   begin
     require 'oj'
@@ -118,6 +122,7 @@ class PBSimply
 
     @refresh = false # Force generate all documents.
     @skip_index = false # Don't register to index.
+    @preflight = false # Don't generate output document.
     @outfile = nil # Fixed output filename
     @add_meta = nil
     @accs = nil
@@ -136,8 +141,10 @@ class PBSimply
     opts.on("-X", "--ignore-ext") { @ignore_ext = true }
     opts.on("-I", "--skip-index") { @skip_index = true }
     opts.on("-A", "--skip-accs") { @skip_accs = true }
+    opts.on("-p", "--preflight") { @preflight = true }
     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.parse!(ARGV)
 
     if File.exist?(".pbsimply-bless.rb")
@@ -170,7 +177,7 @@ class PBSimply
     @docobject
   end
 
-  attr :indexes
+  attr_reader :indexes
 
   ###############################################
   #            PROCESSING FUNCTIONS             #
@@ -181,7 +188,6 @@ class PBSimply
   def proc_dir
     draft_articles = []
     target_docs = []
-    @indexes_orig = {}
     $stderr.puts "in #{@dir}..."
 
     $stderr.puts "Checking Frontmatter..."
@@ -201,11 +207,9 @@ class PBSimply
       end
 
       $stderr.puts "Checking frontmatter in #{filename}"
-      frontmatter, pos = read_frontmatter(@dir, filename)
-      frontmatter = @frontmatter.merge frontmatter
-      frontmatter.merge!(@add_meta) if @add_meta
+      doc = Document.new(@config, @dir, filename, @frontmatter, @now)
 
-      if frontmatter["draft"]
+      if doc.draft?
         draft_articles.push({
           article_filename: filename,
           filename: filename,
@@ -214,31 +218,31 @@ class PBSimply
         next
       end
 
-      @indexes_orig[filename] = @indexes[filename]
-      @indexes[filename] = frontmatter
+      doc.orig_frontmatter = @indexes[filename]
 
       # Push to target documents without checking modification.
-      target_docs.push([filename, frontmatter, pos])
+      target_docs.push(doc)
     end
     ENV.delete("pbsimply_currentdoc")
     ENV.delete("pbsimply_filename")
 
     delete_turn_draft draft_articles
 
-    # #proc_docs destructs target_docs
-    processed_docs = proc_docs target_docs.dup
+    proc_docs target_docs
 
     delete_missing
-    
-    # Restore skipped doc's frontmatter
-    orig_filelist = Set.new(target_docs.map {|i| i[0]})
-    proc_filelist = Set.new(processed_docs.map {|i| i[0]})
-    recov_filelist = orig_filelist - proc_filelist
-    pp recov_filelist
-    recov_filelist.each do |filename|
-      @indexes[filename] = @indexes_orig[filename]
-    end
 
+    # 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
 
@@ -250,37 +254,41 @@ class PBSimply
 
   def proc_docs target_docs
     # Exclude unchanged documents.
-    if @indexes && @indexes_orig
+    unless @singlemode
       $stderr.puts "Checking modification..."
-      target_docs.delete_if {|filename, frontmatter, pos| !check_modify(filename, frontmatter)}
+      if !@preflight
+        target_docs.delete_if do |doc|
+          next false if @refresh # Force refresh mode
+          !doc.modified?
+        end
+        # target_docs.delete_if {|filename, frontmatter, pos| !check_modify(filename, frontmatter)}
+      end
     end
 
     # Modify frontmatter `BLESSING'
-    target_docs.each do |filename, frontmatter, pos|
-      $stderr.puts "Blessing #{filename}..."
-      bless frontmatter
+    target_docs.each do |doc|
+      $stderr.puts "Blessing #{doc.filename}..."
+      bless doc.frontmatter
+    end
+
+    if !@singlemode && @preflight
+      $stderr.puts "Checking metadata modification..."
+      target_docs.each {|doc| doc.mark_meta_modified }
+      return # Resign processing document in preflight mode.
     end
 
     # Ready.
     $stderr.puts "Okay, Now ready. Process documents..."
 
     # Proccess documents
-    target_docs.each do |filename, frontmatter, pos|
-      ext = File.extname filename
-      ENV["pbsimply_currentdoc"] = File.join(@workdir, "current_document#{ext}")
-      ENV["pbsimply_filename"] = filename
-      @index = frontmatter
-      File.open(File.join(@dir, filename)) do |f|
-        f.seek(pos)
-        doc_content = f.read
-        if @config["unicode_normalize"] && !frontmatter["skip_normalize"]
-          doc_content.unicode_normalize!(@config["unicode_normalize"].to_sym)
-        end
-        File.open(File.join(@workdir, "current_document#{ext}"), "w") {|fo| fo.write doc_content }
-      end
-
-      $stderr.puts "Processing #{filename}"
-      generate(@dir, filename, frontmatter)
+    target_docs.each do |doc|
+      ENV["pbsimply_currentdoc"] = File.join(@workdir, "current_document#{doc.ext}")
+      ENV["pbsimply_filename"] = doc.filename
+      @index = doc.frontmatter
+      doc.read_document(workdir: @workdir)
+
+      $stderr.puts "Processing #{doc.filename}"
+      generate(doc)
     end
 
     # Call post plugins
@@ -337,11 +345,20 @@ class PBSimply
       ENV["pbsimply_frontmatter"] = @workfile_frontmatter
       @workfile_pandoc_defaultfiles ||= File.join(@workdir, "pbsimply-defaultfiles.yaml")
       # If target file is regular file, run as single mode.
-      @singlemode = true if File.file?(@dir)
+      @singlemode = File.file?(@dir)
+
+      if @accs_only && !@accs_processing
+        accs_only_mode_check
 
-      # Check single file mode.
-      if @singlemode
+        # Process ACCS without regular generating document
+        setup_config(@dir)
+        load_index
+
+        process_accs
+      elsif @singlemode # Check single file mode.
         # Single file mode
+        return if @preflight
+
         if @dir =~ %r:(.*)/([^/]+):
           dir = $1
           filename = $2
@@ -354,14 +371,13 @@ class PBSimply
 
         load_index
 
-        frontmatter, pos = read_frontmatter(dir, filename)
-        frontmatter = @frontmatter.merge frontmatter
-        @index = frontmatter
+        doc = Document.new(@config, dir, filename, @frontmatter, @now)
+        @index = doc.frontmatter
 
-        proc_docs([[filename, frontmatter, pos]])
+        proc_docs([doc])
 
         if File.exist?(File.join(@dir, ".accs.yaml")) && !@accs_processing && !@skip_accs
-          single_accs filename, frontmatter
+          single_accs doc.filename, doc.frontmatter
         end
       else
         # Normal (directory) mode.
@@ -379,13 +395,14 @@ class PBSimply
     @workfile_pandoc_defaultfiles = nil
   end
 
-  def generate(dir, filename, frontmatter)
+  def generate(doc)
+    dir, filename, frontmatter = *doc.to_a
     print_fileproc_msg(filename) # at sub-class
 
     # Preparing and pre script.
-    orig_filepath = [dir, filename].join("/")
-    ext = File.extname(filename)
-    procdoc = File.join(@workdir, "current_document#{ext}")
+    orig_filepath = doc.orig_filepath
+    ext = doc.ext
+    procdoc = doc.proc_doc_path
 
     pre_plugins(procdoc, frontmatter)
     @hooks.pre.run({procdoc: procdoc, frontmatter: frontmatter})
@@ -454,41 +471,12 @@ class PBSimply
     end
   end
 
-  # Check is the article modified? (or force update?)
-  def check_modify(filename, frontmatter)
-    modify = true
-    index = @indexes_orig[filename]&.dup || {}
-
-    case @config["detect_modification"]
-    when "changes"
-      # Use "changes"
-      modify = false if frontmatter["changes"] == index["changes"]
-    when "mtimesize"
-      # Use mtime and file size.
-      modify = false if frontmatter["_mtime"] <= (index["_last_proced"] || 0) && frontmatter["_size"] == index["_size"]
-    else
-      # Default method, use mtime.
-      modify = false if frontmatter["_mtime"] <= (index["_last_proced"] || 0)
-    end
-
-
-    if modify
-      $stderr.puts "#{filename} last modified at #{frontmatter["_mtime"]}, last processed at #{@indexes_orig[filename]&.[]("_last_proced") || 0}"
-    else
-      $stderr.puts "#{filename} is not modified."
+  def accs_only_mode_check
+    unless File.exist?(File.join(@dir, ".accs.yaml"))
+      raise CommandLineError.new "ACCS-only processing mode can only be performed on the ACCS directory."
     end
-
-    frontmatter["_last_proced"] = @now.to_i
-    frontmatter["last_update"] = @now.strftime("%Y-%m-%d %H:%M:%S")
-
-    if frontmatter["skip_update"]
-      # Document specific skip update
-      false
-    elsif @refresh
-      # Refresh (force update) mode.
-      true
-    else
-      modify
+    unless File.directory?(@dir)
+      raise CommandLineError.new "ACCS-only processing needs ACCS directory as an argument."
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pbsimply
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.5.0
 platform: ruby
 authors:
 - Masaki Haruka
@@ -36,6 +36,7 @@ files:
 - lib/pbsimply/docengine/misc.rb
 - lib/pbsimply/docengine/pandoc.rb
 - lib/pbsimply/docengine/rdoc.rb
+- lib/pbsimply/document.rb
 - lib/pbsimply/frontmatter.rb
 - lib/pbsimply/hooks.rb
 - lib/pbsimply/plugger.rb