pbsimply 2.0.1 → 3.0.0

data/lib/pbsimply/frontmatter.rb

@@ -0,0 +1,204 @@
+#!/usr/bin/ruby
+require 'erb'
+require 'yaml'
+
+module PBSimply::Frontmatter
+  # Read Frontmatter from the document.
+  # This method returns frontmatter, pos.
+  # pos means position at end of Frontmatter on the file.
+  def read_frontmatter(dir, filename)
+    frontmatter = nil
+    pos = nil
+
+    source_path = File.join(dir, filename)
+
+    if File.exist? File.join(dir, ".meta." + filename)
+      # Load standalone metadata YAML.
+      frontmatter = Psych.unsafe_load(File.read(File.join(dir, (".meta." + filename))))
+      pos = 0
+    else
+
+      case File.extname filename
+      when ".md"
+
+        # Load Markdown's YAML frontmatter.
+        File.open(source_path) do |f|
+          l = f.gets
+          next unless l && l.chomp == "---"
+
+          lines = []
+
+          while l = f.gets
+            break if l.nil?
+
+            break if  l.chomp == "---"
+            lines.push l
+          end
+
+          next if f.eof?
+
+          begin
+            frontmatter = Psych.unsafe_load(lines.join)
+          rescue => e
+            STDERR.puts "!CRITICAL: Cannot parse frontmatter."
+            raise e
+          end
+
+          pos = f.pos
+        end
+
+      when ".rst"
+        # ReSTRUCTURED Text
+
+        File.open(source_path) do |f|
+          l = f.gets
+          if l =~ /:([A-Za-z_-]+): (.*)/ #docinfo
+            frontmatter = { $1 => [$2.chomp] }
+            last_key = $1
+
+            # Read docinfo
+            while(l = f.gets)
+              break if l =~ /^\s*$/ # End of docinfo
+              if l =~ /^\s+/ # Continuous line
+                docinfo_lines.last.push($'.chomp)
+              elsif l =~ /:([A-Za-z_-]+): (.*)/
+                frontmatter[$1] = [$2.chomp]
+                last_key = $1
+              end
+            end
+
+            # Treat docinfo lines
+            frontmatter.each do |k,v|
+              v = v.join(" ")
+              #if((k == "author" || k == "authors") && v.include?(";")) # Multiple authors.
+              if(v.include?(";")) # Multiple element.
+                v = v.split(/\s*;\s*/)
+
+              elsif k == "date" # Date?
+                # Datetime?
+                if v =~ /[0-2][0-9]:[0-6][0-9]/
+                  v = Time.parse(v)
+                else
+                  v = Date.parse(v)
+                end
+              elsif v == "yes" || v == "true"
+                v = true
+              else # Simple String.
+                nil # keep v
+              end
+
+              frontmatter[k] = v
+            end
+
+          elsif l && l.chomp == ".." #YAML
+            # Load ReST YAML that document begins comment and block is yaml.
+            lines = []
+
+            while(l = f.gets)
+              if(l !~ /^\s*$/ .. l =~ /^\s*$/)
+                if l=~ /^\s*$/
+                  break
+                else
+                  lines.push l
+                end
+              end
+            end
+            next if f.eof?
+
+
+            # Rescue for failed to read YAML.
+            begin
+              frontmatter = Psych.unsafe_load(lines.map {|i| i.sub(/^\s*/, "") }.join)
+            rescue
+              STDERR.puts "Error in parsing ReST YAML frontmatter (#{$!})"
+              next
+            end
+          else
+            next
+          end
+
+          pos = f.pos
+
+        end
+      end
+    end
+
+    abort "This document has no frontmatter" unless frontmatter
+    abort "This document has no title." unless frontmatter["title"]
+
+    outext = frontmatter["force_ext"] || ".html"
+    outpath = case
+    when @outfile
+      @outfile
+    when @accs_processing
+      File.join(@config["outdir"], @dir, "index") + outext
+    else
+      File.join(@config["outdir"], @dir, File.basename(filename, ".*")) + outext
+    end
+
+    absolute_current = File.absolute_path Dir.pwd
+    absolute_docdir = File.absolute_path dir
+    absolute_docpath = File.absolute_path source_path
+    pwd_length = absolute_current.length
+
+    ### Additional meta values. ###
+    frontmatter["source_directory"] = dir # Source Directory
+    frontmatter["source_filename"] = filename # Source Filename
+    frontmatter["source_path"] = source_path # Source Path
+    frontmatter["dest_path"] = outpath
+    frontmatter["normalized_docdir"] = absolute_docdir[pwd_length..]
+    frontmatter["normalized_docpath"] = absolute_docpath[pwd_length..]
+    # URL in site.
+    this_url = (source_path).sub(/^[\.\/]*/) { @config["self_url_prefix"] || "/" }.sub(/\.[a-zA-Z0-9]+$/, ".html")
+    frontmatter["page_url"] = this_url
+    # URL in site with URI encode.
+    frontmatter["page_url_encoded"] = ERB::Util.url_encode(this_url)
+    frontmatter["page_url_encoded_external"] = ERB::Util.url_encode((source_path).sub(/^[\.\/]*/) { @config["self_url_external_prefix"] || "/" }.sub(/\.[a-zA-Z0-9]+$/, ".html"))
+    frontmatter["page_html_escaped"] = ERB::Util.html_escape(this_url)
+    frontmatter["page_html_escaped_external"] = ERB::Util.html_escape((source_path).sub(/^[\.\/]*/) { @config["self_url_external_prefix"] || "/" }.sub(/\.[a-zA-Z0-9]+$/, ".html"))
+    # Title with URL Encoded.
+    frontmatter["title_encoded"] = ERB::Util.url_encode(frontmatter["title"])
+    frontmatter["title_html_escaped"] = ERB::Util.html_escape(frontmatter["title"])
+    fts = frontmatter["timestamp"]
+    fts = fts.to_datetime if Time === fts
+    if DateTime === fts
+      frontmatter["timestamp_xmlschema"] = fts.xmlschema
+      frontmatter["timestamp_jplocal"] = fts.strftime('%Y年%m月%d日 %H時%M分%S秒')
+      frontmatter["timestamp_rubytimestr"] = fts.strftime('%a %b %d %H:%M:%S %Z %Y')
+      frontmatter["timestamp_str"] = fts.strftime("%Y-%m-%d %H:%M:%S %Z")
+    elsif Date === fts
+      frontmatter["timestamp_xmlschema"] = fts.xmlschema
+      frontmatter["timestamp_jplocal"] = fts.strftime('%Y年%m月%d日')
+      frontmatter["timestamp_rubytimestr"] = fts.strftime('%a %b %d')
+      frontmatter["timestamp_str"] = fts.strftime("%Y-%m-%d")
+    elsif Date === frontmatter["Date"]
+      fts = frontmatter["Date"]
+      frontmatter["timestamp_xmlschema"] = fts.xmlschema
+      frontmatter["timestamp_jplocal"] = fts.strftime('%Y年%m月%d日')
+      frontmatter["timestamp_rubytimestr"] = fts.strftime('%a %b %d')
+      frontmatter["timestamp_str"] = fts.strftime("%Y-%m-%d")
+    end
+
+    fsize = FileTest.size(source_path)
+    mtime = File.mtime(source_path).to_i
+
+    frontmatter["_filename"] ||= filename
+    frontmatter["pagetype"] ||= "post"
+
+    frontmatter["_size"] = fsize
+    frontmatter["_mtime"] = mtime
+    frontmatter["_last_proced"] = @now.to_i
+
+    if File.extname(filename) == ".md"
+      frontmatter["_docformat"] = "Markdown"
+    elsif File.extname(filename) == ".rst" || File.extname(filename) == ".rest"
+      frontmatter["_docformat"] = "ReST"
+    elsif File.extname(filename) == ".rdoc"
+      frontmatter["_docformat"] = "RDoc"
+    end
+
+    frontmatter["date"] ||= @now.strftime("%Y-%m-%d %H:%M:%S")
+
+    return frontmatter, pos
+  end
+end

data/lib/pbsimply/hooks.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby
+
+# Hooks is new in PureBuilder Simply 2.2.
+# Hooks object has instance variables for each timing.
+# 
+class PBSimply::Hooks
+
+  # Timing object class.
+  class HooksHolder
+    def initialize name
+      @name = name
+      @hooks = []
+    end
+
+    def <<(proc)
+      @hooks << proc
+    end
+
+    alias :add :<<
+
+    def run(arg)
+      STDERR.puts "Hooks processing (#{@name})"
+      @hooks.each_with_index do |proc, index|
+        STDERR.puts "Hooks[#{index}]"
+        begin
+          proc.(arg)
+        rescue
+          STDERR.puts "*** HOOKS PROC ERROR ***"
+          raise
+        end
+      end
+    end
+  end
+
+  def initialize(pbsimply)
+    @pbsimply = pbsimply
+
+    # Called first phase before generate. This hooks called before blessing.
+    #
+    # Argument: frontmatter, procdoc.
+    # procdoc is processing source document path.
+    @pre = HooksHolder.new "pre"
+
+    # Called after document was generated.
+    # 
+    # Argument: outpath, frontmatter, procdoc.
+    # outpath is generated final document path. You can read output result.
+    # procdoc is source document path before generate.
+    @process = HooksHolder.new "process"
+
+    # Called each deleted document on ACCS final phase, before deletion.
+    #
+    # Argument: target_file_path, source_file_path.
+    # target_file_path is output file path (existing or non-existing.)
+    @delete = HooksHolder.new "delete"
+
+    # Called after all document were generated.
+    #
+    # Argument: this_time_processed([{source, dest, frontmatter}...])
+    # this_time_processed has actually processed documents.
+    # source is source file path, dest is generated file path.
+    @post = HooksHolder.new "post"
+
+    # Called before generating ACCS index.
+    #
+    # Argument: index, indexes.
+    #
+    # index is @index (frontmatter for ACCS index),
+    # indexes is @indexes.
+    @accs = HooksHolder.new "accs"
+  end
+
+  def load
+    if File.file?("./.pbsimply-hooks.rb")
+      require './.pbsimply-hooks.rb'
+      PBSimply::Hooks.load_hooks(self)
+    end
+  end
+
+  attr :pre
+  attr :process
+  attr :delete
+  attr :post
+  attr :accs
+end

data/lib/pbsimply/plugger.rb

@@ -0,0 +1,77 @@
+# Document tweaking module.
+# Provides deprected Pre-plugins and Post-plugins.
+module PBSimply::Plugger
+  POST_PROCESSORS = {
+    ".rb" => "ruby",
+    ".pl" => "perl",
+    ".py" => "python",
+    ".lua" => "lua",
+    ".bash" => "bash",
+    ".zsh" => "zsh",
+    ".php" => "php",
+    ".sed" => ["sed", ->(script, target) { ["-f", script, target] } ]
+  }
+
+  # Deprecated filter command feature.
+  #
+  # Pre plugins invoke each command on .pre_generate directory as filter command before process document.
+  # Porcessing document (same content as source document) path given as first argument.
+  def pre_plugins(procdoc, frontmatter)
+    if File.directory?(".pre_generate")
+      STDERR.puts("Processing with pre plugins")
+      script_file = File.join(".pre_generate", script_file)
+      Dir.entries(".pre_generate").sort.each do |script_file|
+        next if script_file =~ /^\./
+        STDERR.puts "Running script: #{File.basename script_file}"
+        pre_script_result = nil
+        script_cmdline = case
+        when File.executable?(script_file)
+          [script_file, procdoc]
+        when POST_PROCESSORS[File.extname(script_file)]
+          [POST_PROCESSORS[File.extname(script_file)], script_file, procdoc]
+        else
+          ["perl", script_file, procdoc]
+        end
+        IO.popen({"pbsimply_doc_frontmatter" => YAML.dump(frontmatter)}, script_cmdline) do |io|
+          pre_script_result = io.read
+        end
+        File.open(procdoc, "w") {|f| f.write pre_script_result}
+      end
+    end
+  end
+
+  # Post plugins invoke each command on .post_generate directory as filter command after processed.
+  # Generated document (typically HTML) path given as first argument.
+  def post_plugins(frontmatter=nil)
+    if File.directory?(".post_generate")
+
+      STDERR.puts("Processing with post plugins")
+
+      @this_time_processed.each do |v|
+        STDERR.puts "Processing #{v[:dest]} (from #{v[:source]})"
+        procdoc = v[:dest]
+        frontmatter ||= @indexes[File.basename v[:source]]
+        File.open(@workfile_frontmatter, "w") {|f| f.write JSON_LIB.dump(frontmatter)}
+        Dir.entries(".post_generate").sort.each do |script_file|
+          next if script_file =~ /^\./
+          STDERR.puts "Running script: #{script_file}"
+          script_file = File.join(".post_generate", script_file)
+          post_script_result = nil
+          script_cmdline = case
+          when File.executable?(script_file)
+            [script_file, procdoc]
+          when POST_PROCESSORS[File.extname(script_file)]
+            [POST_PROCESSORS[File.extname(script_file)], script_file, procdoc]
+          else
+            ["perl", script_file, procdoc]
+          end
+          IO.popen({"pbsimply_workdir" => @workdir,"pbsimply_frontmatter" => @workfile_frontmatter, "pbsimply_indexes" => @db.path}, script_cmdline) do |io|
+            post_script_result = io.read
+          end
+
+          File.open(procdoc, "w") {|f| f.write post_script_result}
+        end
+      end
+    end
+  end
+end

data/lib/pbsimply/prayer.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/ruby
+
+# Module for BLESSING feature.
+module PBSimply::Prayer
+  def bless frontmatter
+    if @config["bless_style"] == "cmd"
+      bless_cmd frontmatter
+    else
+      bless_ruby frontmatter
+    end
+  end
+  
+  def bless_ruby(frontmatter)
+    # BLESSING (Always)
+    if PureBuilder.const_defined?(:BLESS) && Proc === PureBuilder::BLESS
+      begin
+        PureBuilder::BLESS.(frontmatter, self)
+      rescue
+        STDERR.puts "*** BLESSING PROC ERROR ***"
+        raise
+      end
+    end
+
+    # BLESSING (ACCS)
+    if @accs && PureBuilder::ACCS.const_defined?(:BLESS) && Proc === PureBuilder::ACCS::BLESS
+      begin
+        PureBuilder::ACCS::BLESS.(frontmatter, self)
+      rescue
+        STDERR.puts "*** ACCS BLESSING PROC ERROR ***"
+        raise
+      end
+    end
+
+    # ACCS DEFINITIONS
+    if @accs
+      if Proc === PureBuilder::ACCS::DEFINITIONS[:next]
+        i = PureBuilder::ACCS::DEFINITIONS[:next].call(frontmatter, self)
+        frontmatter["next_article"] = i if i
+      end
+      if Proc === PureBuilder::ACCS::DEFINITIONS[:prev]
+        i = PureBuilder::ACCS::DEFINITIONS[:prev].call(frontmatter, self)
+        frontmatter["prev_article"] = i if i
+      end
+    end
+
+    autobless(frontmatter)
+  end
+
+  def bless_cmd(frontmatter)
+    File.open(@workfile_frontmatter, "w") {|f| f.write 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"
+    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"
+    end
+    mod_frontmatter = JSON.load(File.read(@workfile_frontmatter))
+    frontmatter.replace(mod_frontmatter)
+
+    autobless(frontmatter)
+  end
+
+  # Blessing automatic method with configuration.
+  def autobless(frontmatter)
+    catch(:accs_rel) do
+      # find Next/Prev page on accs
+      if @accs && @config["blessmethod_accs_rel"]
+        # Preparing. Run at once.
+        if !@article_order
+          @rev_article_order_index = {}
+
+          case @config["blessmethod_accs_rel"]
+          when "numbering"
+            @article_order = @indexes.to_a.sort_by {|i| i[1]["_filename"].to_i }
+          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."
+            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."
+            end
+          when "lexical"
+            @article_order = @indexes.to_a.sort_by {|i| i[1]["_filename"]}
+          end
+          @article_order.each_with_index {|x,i| @rev_article_order_index[x[0]] = i }
+        end
+
+        throw(:accs_rel) unless index = @rev_article_order_index[frontmatter["_filename"]]
+        if @article_order[index + 1]
+          frontmatter["next_article"] = {"url" => @article_order[index + 1][1]["page_url"],
+                                         "title" => @article_order[index + 1][1]["title"]}
+        end
+        if index > 0
+          frontmatter["prev_article"] = {"url" => @article_order[index - 1][1]["page_url"],
+                                         "title" => @article_order[index - 1][1]["title"]}
+        end
+      end
+    end
+  end
+end