pbsimply 2.0.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a59c6750364956392ea53e72b079a4233e94932240a4b1a6e121dfac7a6b875d
-  data.tar.gz: 73dd09f496e791ab26782d4f134363b03879d91eb061c4749e4795ab89ebe2f1
+  metadata.gz: 8646259ef8d789b45379e1a72d861f96dc6d17b7c11fb5a8efd8211abed803f2
+  data.tar.gz: 26624a779547dd0620130266dfad5bfebf0c23c65b3e6d4c2d6e2f937dc81b87
 SHA512:
-  metadata.gz: 141c14de48e9f48827780e8bda20989879ea91bec32a7ddf7de6b3c073141c6b3d566b957ecf83c7f655b14e1a2a5185527785999578d56e1e1056f667711a41
-  data.tar.gz: 39f02c1dd33c5fe9f458b6f964c5a1491d0538cff53c6aefb5766e1493fb9686c4a822a80484aceb6bb1776f1ba2ea22f7d23443d61bc8d5057bc8aedff4ec67
+  metadata.gz: 6f80e3b59ec6a78e9630602d4090af1ae1b5b444946fb638c6e60bbb1e47f3c6ee9c0f8e9869c82321d0db4884622cedd57fd1c24aff12a7675942fb7b2fc495
+  data.tar.gz: 57d20e28c25f2eb944d61557a63321ae4799b17e135ede66321a6957598a531c858b27ff80350b33a4295721b3962dfe38f046dbdc599440644aea8653171da6

data/bin/pbsimply

@@ -1,9 +1,12 @@
+#!/bin/env ruby
 
 require 'pbsimply'
 
 config = PBSimply.load_config
 
 pbs_class = case config["pbsimply_processor"]
+when "docutils"
+  PBSimply::Processor::Docutils
 when "redcarpet"
   PBSimply::Processor::PbsRedCarpet
 when "kramdown"

data/bin/pbsimply-testserver

@@ -9,7 +9,7 @@ File.open(".pbsimply.yaml") do |f|
 end
 
 srv = WEBrick::HTTPServer.new({ :DocumentRoot => @config["outdir"],
-                                :BindAddress => '127.0.0.1',
+                                :BindAddress => (@config["testserver_address"] || '127.0.0.1'),
                                 :Port => (@config["testserver_port"] || 8000 )})
 trap("INT"){ srv.shutdown }
 srv.start

data/lib/pbsimply/accs.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/ruby
+
+# ACCS namespace.
+module PBSimply::ACCS
+  DEFINITIONS = {}
+
+  # Built-in Accs index eRuby string.
+  INDEX = <<'EOF'
+<%= YAML.dump(
+  {
+    "title" => @index["title"],
+    "date" => @index["date"],
+    "author" => @index["author"]
+  }
+) %>
+---
+
+<%
+articles = Hash.new {|h,k| h[k] = Array.new }
+
+if @config["accs_across_category"]
+  @indexes.each {|filename, index| articles["default"].push index }
+else
+  @indexes.each {|filename, index| articles[(index["category"] || "default")].push index }
+end
+
+%>
+
+% articles.keys.sort.each do |catname|
+% cat = articles[catname]
+
+% unless articles.length == 1
+# <%= catname %>
+% end
+
+<%
+  sort_method = case @config["accs_sort_by"]
+  when "title"
+    lambda {|i| [i["title"].to_s, i["date"]] }
+  when "name"
+    lambda {|i| [i["_filename"].to_s, i["title"].to_s, i["date"]] }
+  when "serial"
+    lambda {|i| [i["serial"].to_s, i["date"], i["_filename"].to_s] }
+  else
+    lambda {|i| [i["date"], i["title"].to_s, i["_last_update"].to_i] }
+  end
+
+  list = if @config["accs_order"] == "desc"
+    cat.sort_by(&sort_method).reverse
+  else
+    cat.sort_by(&sort_method)
+  end
+
+  list.each do |i|
+%>* [<%= i["title"] %>](<%= i["page_url"] %>)
+<% end %>
+
+% end
+EOF
+
+  # letsaccs
+  #
+  # This method called on the assumption that processed all documents and run as directory mode.
+  def process_accs
+    STDERR.puts "Processing ACCS index..."
+    if File.exist?(File.join(@dir, ".accsindex.erb"))
+      erbtemplate = File.read(File.join(@dir, ".accsindex.erb"))
+    elsif File.exist?(".accsindex.erb")
+      erbtemplate = File.read(".accsindex.erb")
+    else
+      erbtemplate = INDEX
+    end
+
+    # Get infomation
+    @accs_index = Psych.unsafe_load(File.read([@dir, ".accs.yaml"].join("/")))
+
+    @accs_index["title"] ||= (@config["accs_index_title"] || "Index")
+    @accs_index["date"] ||= Time.now.strftime("%Y-%m-%d")
+    @accs_index["pagetype"] = "accs_index"
+
+    @index = @frontmatter.merge @accs_index
+
+    @hooks.accs.run({index: @index, indexes: @indexes})
+
+    doc = ERB.new(erbtemplate, trim_mode: "%<>").result(binding)
+    File.open(File.join(@dir, ".index.md"), "w") do |f|
+      f.write doc
+    end
+
+    accsmode
+    @dir = File.join(@dir, ".index.md")
+    main
+  end
+
+  # Turn on ACCS processing mode.
+  def accsmode
+    @accs_processing = true
+    @singlemode = true
+    @skip_index = true
+  end
+
+  # letsaccs in single page.
+  def single_accs filename, frontmatter
+    unless @skip_index
+      @indexes[filename] = frontmatter
+      @db.dump(@indexes)
+    end
+    process_accs
+  end
+end

data/lib/pbsimply/docdb.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/ruby
+require 'yaml'
+
+class PBSimply
+  class CustomYAML
+    def self.dump(*arg)
+      YAML.dump(*arg)
+    end
+
+    def self.load(*arg)
+      Psych.unsafe_load(*arg)
+    end
+  end
+
+  # Abstruct super class.
+  class DocDB
+    def dump(object)
+      File.open(File.join(@dir, ".indexes.#{@ext}"), "w") do |f|
+        f.write @store_class.dump(object)
+      end
+    end
+
+    def load
+      File.open(File.join(@dir, ".indexes.#{@ext}"), "r") do |f|
+        next @store_class.load(f)
+      end
+    end
+
+    def exist?
+      File.exist?(File.join(@dir, ".indexes.#{@ext}"))
+    end
+
+    def path
+      File.join(@dir, ".indexes.#{@ext}")
+    end
+
+    def cmp_obj(frontmatter)
+      @store_class.load(@store_class.dump(frontmatter))
+    end
+
+    # Use Ruby Marshal
+    class Marshal < DocDB
+      def initialize(dir)
+        @dir = dir
+        @store_class = ::Marshal
+        @ext = "rbm"
+      end
+
+      def cmp_obj(frontmatter)
+        frontmatter.dup
+      end
+    end
+
+    # Use JSON with bundled library
+    class JSON < DocDB
+      def initialize(dir)
+        require 'json'
+        @dir = dir
+        @store_class = ::JSON
+        @ext = "json"
+      end
+    end
+
+    # Use JSON with Oj gem
+    class Oj < DocDB::JSON
+      def initialize(dir)
+        require 'oj'
+        @dir = dir
+        @ext = "json"
+        @store_class = ::Oj
+      end
+    end
+
+    # Use YAML
+    class YAML < DocDB
+      def initialize(dir)
+        @dir = dir
+        @store_class = CustomYAML
+        @ext = "yaml"
+      end
+    end
+  end
+end

data/lib/pbsimply/docengine/base.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby
+require 'pbsimply/docengine/pandoc.rb'
+require 'pbsimply/docengine/rdoc.rb'
+require 'pbsimply/docengine/misc.rb'
+require 'pbsimply/docengine/docutils.rb'

data/lib/pbsimply/docengine/docutils.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/ruby
+
+class PBSimply
+  module Processor
+    # Docutils processor (rst2html5 command)
+    class Docutils < PBSimply
+      def initialize(config)
+        @docutils_cli_options = []
+        super
+      end
+
+      def setup_config(dir)
+        super
+        @docutils_cli_options.push("--template=#{@config["template"]}") if @config["template"]
+
+        if @config["css"]
+          if @config["css"].kind_of?(String)
+            @docutils_cli_options.push("--stylesheet=#{@config["css"]}")
+          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."
+          end
+        end
+
+        if Array === @config["docutils_options"]
+          @docutils_cli_options.concat! @config["docutils_options"]
+        end
+      end
+
+      # Invoke pandoc, parse and format and write out.
+      def print_fileproc_msg(filename)
+        STDERR.puts "#{filename} is going Docutils."
+      end
+
+      def process_document(dir, filename, frontmatter, orig_filepath, ext, procdoc)
+        doc = nil
+
+        # Go Docutils
+        cmdline = ["rst2html5"]
+        cmdline += @docutils_cli_options
+        cmdline += [ procdoc ]
+        IO.popen((cmdline)) do |io|
+          doc = io.read
+        end
+
+        # Abort if pandoc returns non-zero status
+        if $?.exitstatus != 0
+          abort "Docutils (rst2html5) returns exit code #{$?.exitstatus}"
+        end
+
+        doc
+      end
+
+      def target_file_extensions
+        [".rst"]
+      end
+    end
+  end
+end

data/lib/pbsimply/docengine/misc.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby
+
+class PBSimply
+  module Processor
+    # RedCarpet Processor
+    class PbsRedCarpet < PBSimply
+      def initialize(config)
+        require 'redcarpet'
+        super
+      end
+
+      def setup_config(dir)
+        super
+        @rc_extension = @config["redcarpet_extensions"] || {}
+      end
+
+      def print_fileproc_msg(filename)
+        STDERR.puts "#{filename} generate with Redcarpet Markdown"
+      end
+
+      def process_document(dir, filename, frontmatter, orig_filepath, ext, procdoc)
+        # Getting HTML string.
+        markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, **@rc_extension)
+        article_body = markdown.render(File.read procdoc)
+
+        # Process with eRuby temaplte.
+        erb_template = ERB.new(File.read(@config["template"]), trim_mode: '%<>')
+        doc = erb_template.result(binding)
+
+        doc
+      end
+    end
+
+    # Kramdown Processor
+    class PbsKramdown < PBSimply
+      def initialize(config)
+        require 'kramdown'
+        super
+      end
+
+      def print_fileproc_msg(filename)
+        STDERR.puts "#{filename} generate with Kramdown"
+      end
+
+      def process_document(dir, filename, frontmatter, orig_filepath, ext, procdoc)
+        # Set feature options
+        features = @config["kramdown_features"] || {}
+
+        # Getting HTML string.
+        markdown = Kramdown::Document.new(File.read(procdoc), **features)
+        article_body = markdown.to_html
+
+        # Process with eRuby temaplte.
+        erb_template = ERB.new(File.read(@config["template"]), trim_mode: '%<>')
+        doc = erb_template.result(binding)
+
+        doc
+      end
+    end
+
+    # CommonMark Processor
+    class PbsCommonMark < PBSimply
+      def initialize(config)
+        require 'commonmarker'
+        super
+      end
+
+      def print_fileproc_msg(filename)
+        STDERR.puts "#{filename} generate with CommonMarker (cmark-gfm)"
+      end
+
+      def process_document(dir, filename, frontmatter, orig_filepath, ext, procdoc)
+        # Getting HTML string.
+        article_body = CommonMarker.render_doc(File.read(procdoc), :DEFAULT, [:table, :strikethrough]).to_html
+
+        # Process with eRuby temaplte.
+        erb_template = ERB.new(File.read(@config["template"]), trim_mode: '%<>')
+        doc = erb_template.result(binding)
+
+        doc
+      end
+    end
+  end
+end

data/lib/pbsimply/docengine/pandoc.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/ruby
+
+###############################################
+#           DOCUMENT PROCESSORS               #
+###############################################
+
+class PBSimply
+  module Processor
+
+    # Pandoc processor
+    class Pandoc < PBSimply
+      def initialize(config)
+        @pandoc_default_file = {}
+
+        # -d
+        @pandoc_default_file = {
+          "to" => "html5",
+          "standalone" => true
+        }
+        super
+      end
+
+      def setup_config(dir)
+        super
+        @pandoc_default_file["template"] = @config["template"]
+
+        if @config["css"]
+          if @config["css"].kind_of?(String)
+            @pandoc_default_file["css"] = [@config["css"]]
+          elsif @config["css"].kind_of?(Array)
+            @pandoc_default_file["css"] = @config["css"]
+          else
+            abort "css in Config should be a String or an Array."
+          end
+        end
+
+        if @config["toc"]
+          @pandoc_default_file["toc"] = true
+        end
+
+        if Hash === @config["pandoc_additional_options"]
+          @pandoc_default_file.merge! @config["pandoc_additional_options"]
+        end
+
+      end
+
+      # Invoke pandoc, parse and format and write out.
+      def print_fileproc_msg(filename)
+        STDERR.puts "#{filename} is going Pandoc."
+      end
+
+      def process_document(dir, filename, frontmatter, orig_filepath, ext, procdoc)
+        doc = nil
+
+        File.open(@workfile_pandoc_defaultfiles, "w") {|f| YAML.dump(@pandoc_default_file, f)}
+        File.open(@workfile_frontmatter, "w") {|f| YAML.dump(frontmatter, f)}
+
+        # Go Pandoc
+        pandoc_cmdline = ["pandoc"]
+        pandoc_cmdline += ["-d", @workfile_pandoc_defaultfiles, "--metadata-file", @workfile_frontmatter, "-M", "title:#{frontmatter["title"]}"]
+        pandoc_cmdline += ["-f", frontmatter["input_format"]] if frontmatter["input_format"]
+        pandoc_cmdline += [ procdoc ]
+        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}"
+        end
+
+        doc
+      end
+
+      def target_file_extensions
+        [".md", ".rst"]
+      end
+    end
+  end
+end

data/lib/pbsimply/docengine/rdoc.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/ruby
+
+class PBSimply
+  module Processor
+    # RDoc family Base
+    class PbsRBase < PBSimply
+      def initialize(config)
+        require 'rdoc'
+        require 'rdoc/markup/to_html'
+
+        @rdoc_options = RDoc::Options.new
+        @rdoc_markup = RDoc::Markup.new
+
+        super
+      end
+
+      def process_document(dir, filename, frontmatter, orig_filepath, ext, procdoc)
+        # Getting HTML string.
+        rdoc = RDoc::Markup::ToHtml.new(@rdoc_options, @rdoc_markup)
+        article_body = rdoc.convert(get_markup_document(procdoc))
+
+        # Process with eRuby temaplte.
+        erb_template = ERB.new(File.read(@config["template"]), trim_mode: '%<>')
+        doc = erb_template.result(binding)
+
+        doc
+      end
+    end
+
+    # RDoc/Markdown processor
+    class PbsRMakrdown < PbsRBase
+      def initialize(config)
+        require 'rdoc'
+        require 'rdoc/markdown'
+        super
+      end
+
+      def print_fileproc_msg(filename)
+        STDERR.puts "#{filename} generate with RDoc/Markdown"
+      end
+
+      def get_markup_document procdoc
+        RDoc::Markdown.parse(File.read procdoc)
+      end
+    end
+
+    # RDoc processor
+    class PbsRDoc < PbsRBase
+      def print_fileproc_msg(filename)
+        STDERR.puts "#{filename} generate with RDoc"
+      end
+
+      def get_markup_document procdoc
+        File.read procdoc
+      end
+
+      def target_file_extensions
+        [".rdoc"]
+      end
+    end
+  end
+end