ppz 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50d999d54bdbf78556f37bac10260a0af9315e3b7c708f5e923140628ccbf56e
-  data.tar.gz: 2a5a604e6f6fdb05c0652322a35cb1231c3701157a189256c87e34fbd692c251
+  metadata.gz: d446dbd5570e54876363303e60e7d6b42c74074b231a62a7cd418fa4c241b768
+  data.tar.gz: cf6870884a629d64224f256ffe0c7e4620d525e1d1fa1fe7f7739a691981984a
 SHA512:
-  metadata.gz: 9f205f57824a0bef8e2f2284135e7da87373eb73cb11a4c635315564e707614328f08d6a34950b4f66bfca32de93b990e6dece6384e94580ff99eabee9f5faaa
-  data.tar.gz: fe94d84a488ebd411acdc724bcbfe4035011e7948970712b32df71bed3ac2296fde8d98ace6f6c79522ea09e28fb68e8c3616cac80e762ef2fa347e095b65cc3
+  metadata.gz: 9b5e40c14d3e4b916a35fbb27691b31d1dff0bda542d09fabbc53b764addd59251e47986e09371a5ac9d1046a0612e783ce7e435b2596019da944c436a0a5104
+  data.tar.gz: 572592413bf31f57f23c32d797bc716a849aa1132d0010924d05ea0955fe466e1227c1d977467130f440a0237cc144211573632f9c793301dbf5da15e261ca69

data/lib/doc/index.rb

@@ -0,0 +1,9 @@
+module PPZ
+  # model
+  require_relative './model/index'
+  # parser
+  require_relative './parser/context'
+  require_relative './parser/abstract'
+  require_relative './parser/file'
+  require_relative './parser/string'
+end

data/lib/{model → doc/model}/comment/container.rb

@@ -2,6 +2,6 @@ class PPZ::CommentContainerModel < PPZ::AbstractWrapperModel
   UpperClass = PPZ::AbstractSectionModel
 
   def to_html
-    "<div class=\"comment\">#{super}</div>"
+    "<div class=\"comment-container\">#{super}</div>"
   end
 end

data/lib/{model → doc/model}/comment/item.rb

@@ -7,6 +7,6 @@ class PPZ::CommentItemModel < PPZ::AbstractModel
   end
   
   def to_html
-    "<div>#{@content}</div>"
+    "<div class=\"comment-item\">#{@content}</div>"
   end
 end

data/lib/doc/model/index.rb

@@ -0,0 +1,17 @@
+module PPZ
+  require_relative './abstract/model'
+  require_relative './abstract/wrapper-model'
+  require_relative './section/abstract'
+  require_relative './section/leaf'
+  require_relative './section/root'
+  require_relative './comment/container'
+  require_relative './comment/item'
+  require_relative './common/escape'
+  require_relative './list/wrapper/abstract'
+  require_relative './list/wrapper/unordered'
+  require_relative './list/item/abstract'
+  require_relative './list/item/unordered'
+  require_relative './p/index'
+  require_relative './special-block/container'
+  require_relative './special-block/item'
+end

data/lib/doc/model/special-block/container.rb

@@ -0,0 +1,25 @@
+class PPZ::SpecialContainerModel < PPZ::AbstractWrapperModel
+  UpperClass = PPZ::AbstractSectionModel
+
+  REG_EXP = /^```( (.*))?$/
+  def self.from_line line
+    if REG_EXP.match line
+      if $2 && ($2.include? '```')
+        nil
+      else
+        PPZ::SpecialContainerModel.new $2
+      end
+    else
+      nil
+    end
+  end
+
+  def initialize name
+    @name = name
+    super()
+  end
+  
+  def to_html
+    "<div class=\"special-block-container #{@name}\">#{super}</div>"
+  end
+end

data/lib/{model → doc/model}/special-block/item.rb

@@ -3,6 +3,6 @@ class PPZ::SpecialItemModel < PPZ::AbstractModel
     @line = line
   end
   def to_html
-    "<div>#{@line}</div>"
+    "<div class=\"special-block-item\">#{@line}</div>"
   end
 end

data/lib/{parser/doc → doc/parser}/abstract.rb

@@ -2,7 +2,7 @@
 
 class PPZ::AbstractDocParser
   def initialize
-    @context = PPZ::DocContext.new PPZ::RootSectionModel.new
+    @context = PPZ::ParserContext.new PPZ::RootSectionModel.new
   end
 
   def get_model

data/lib/{parser/common/context/doc.rb → doc/parser/context.rb}

@@ -1,4 +1,11 @@
-class PPZ::DocContext < PPZ::AbstractContext
+# 当前行，所处的上下文
+# 比如 一级 section 下面的 ul 下的 第 n 个 ul
+
+class PPZ::ParserContext
+  def initialize root
+    @stack = [root]
+  end
+
   def append target
     # ContainerClass: 容器类，如果上级不是，就造一个
     if(PPZ::Func::class_has_const? target, :ContainerClass) and (head.class != target.class::ContainerClass)
@@ -12,4 +19,24 @@ class PPZ::DocContext < PPZ::AbstractContext
     head.append target # 加入 model
     @stack.push target if target.is_a? PPZ::AbstractWrapperModel # 加入 stack
   end
+
+  def pop
+    @stack.pop
+  end
+
+  def head
+    @stack[-1]
+  end
+
+  def root
+    @stack[0]
+  end
+
+  private
+    def pop_to klass
+      loop do
+        break if head.is_a? klass
+        pop
+      end
+    end
 end

data/lib/folder/index.rb

@@ -0,0 +1,9 @@
+# 解析一个文件夹里的 .ppz 文件
+
+module PPZ::Folder
+  require_relative './model/abstract'
+  require_relative './model/folder'
+  require_relative './model/file/abstract'
+  require_relative './model/file/other'
+  require_relative './model/file/ppz'
+end

data/lib/folder/model/abstract.rb

@@ -0,0 +1,90 @@
+module PPZ::Folder
+  class AbstractModel
+    attr_reader :index, :name, :level
+    attr_accessor :prev_model, :next_model, :father_model
+
+    def initialize path, level
+      throw '文件（夹）的名字得是字符串啊' unless path.is_a? String
+      @path = path
+      @basename = File.basename path
+      @level = level
+    end
+
+    def self.from_path path, level
+      level += 1
+      if Dir.exist? path
+        FolderModel.new path, level
+      elsif File.exist? path
+        AbstractFileModel.from_path path, level
+      else
+        throw path + '不存在？'
+      end
+    end
+
+    def get_css_path
+      ('../' * @level) + 'style.css'
+    end
+
+    def relative_link target
+      relative_level = @level - target.level # relative_level 是“目标 model 比当前 level 高几级”
+
+      (if relative_level > 0
+        '../' * relative_level
+      elsif relative_level < 0
+        result = ''
+        father = target.father_model
+        (- relative_level).times do
+          result = father.name + '/' + result
+          father = father.father_model
+        end
+        result
+      else
+        ''
+      end) + target.name + '.html'
+    end
+
+    private
+      def to_html
+        get_head_html +
+        get_ancestor_html +
+        get_content_html +
+        get_nav_html
+      end
+
+      def get_head_html
+        %~<title>#{@name}</title><link rel="stylesheet" href="#{get_css_path}"/>~
+      end
+      
+      def get_ancestor_html
+        list = []
+        father = self
+        loop do
+          break unless father.father_model
+          father = father.father_model
+          list.unshift father
+        end
+        %~<div class="ancestor-nav"><ul>#{
+          (list.collect do |node|
+            %`<li><a href="#{relative_link node}">#{node.name}</a></li>`
+          end
+          .join) + %`<li class="self">#{self.name}</li>`
+        }</ul></div>~
+      end
+
+      def get_nav_html
+        # prev_model nav_html
+        prev_model_html = ''
+        if @prev_model
+          prev_link = relative_link @prev_model
+          prev_model_html = "<li class=\"prev\"><a href=\"#{prev_link}\">#{@prev_model.name}</a></li>"
+        end
+        next_model_html = ''
+        if @next_model
+          next_link = relative_link @next_model
+          next_model_html = "<li class=\"next\"><a href=\"#{next_link}\">#{@next_model.name}</a></li>"
+        end
+
+        %~<ul class="interpage-nav">#{prev_model_html}#{next_model_html}</ul>~
+      end
+  end
+end

data/lib/folder/model/file/abstract.rb

@@ -0,0 +1,23 @@
+module PPZ::Folder
+class AbstractFileModel < AbstractModel
+  attr_reader :name
+  def self.from_path path, level
+    if (File.extname path) == '.ppz'
+      PPZFileModel.new path, level
+    else
+      OtherFileModel.new path, level
+    end
+  end
+
+  attr_reader :file_ext
+  def initialize path, level
+    super
+    unless /^((\d+)_)?([^\.]+)(\.[^\.]+)?$/.match @basename
+      throw '文件的命名方式不太理解哦:' + path
+    end
+    @index = $2?($2.to_i):(Float::INFINITY)
+    @name = $3
+    @file_ext = $4 || ''
+  end
+end
+end

data/lib/folder/model/file/other.rb

@@ -0,0 +1,7 @@
+module PPZ::Folder
+  class OtherFileModel < AbstractFileModel
+    def _compile dir_out
+      FileUtils.cp @path, (dir_out + '/' + @basename)
+    end
+  end
+end

data/lib/folder/model/file/ppz.rb

@@ -0,0 +1,15 @@
+module PPZ::Folder
+  class PPZFileModel < AbstractFileModel
+    attr_accessor :left, :right
+
+    def _compile dir_out
+      PPZ::Func::write_to_file (dir_out + '/' + @name + '.html'), to_html
+    end
+
+    private
+      def get_content_html
+        (PPZ::FileDocParser.new @path)
+          .get_model.to_html
+      end
+  end
+end

data/lib/folder/model/folder.rb

@@ -0,0 +1,101 @@
+module PPZ::Folder
+  class FolderModel < AbstractModel
+    attr_reader :children
+
+    def initialize path, level
+      super
+      /^((\d+)_)?(.+)/.match @basename
+      @index = $2?($2.to_i):(Float::INFINITY)
+      @name = $3
+
+      @children = []
+      (Dir.children path, encoding: 'utf-8').each do |child_name|
+        @children.push AbstractModel.from_path (path + '/' + child_name), level
+      end
+      @children.sort! do |a, b|
+        a.index <=> b.index
+      end
+
+      # 设置上级 和 左右
+      left = right = nil
+      @children.each do |child|
+        child.father_model = self # 上级
+
+        next unless child.is_a? PPZFileModel
+        if left
+          left.right = child
+          child.left = left
+        end
+        left = child
+      end
+    end
+
+    def _compile out_dir # compile 是 _compile 的安全版本
+      PPZ::Func.write_to_file (out_dir + '/' + @name + '.html'), to_html
+
+      children_dir = out_dir + '/' + @name
+      Dir.mkdir children_dir
+      @children.each { |child| child._compile children_dir }
+    end
+
+    def compile out_dir
+      set_prev_and_next_page
+
+      unless out_dir.is_a? String
+        throw 'out_dir 只能是字符串'
+      end
+      unless Dir.exist? out_dir
+        throw "out_dir #{out_dir} 不存在"
+      end
+      if ['/', '\\'].include? out_dir[-1]
+        _compile out_dir[0...-1]
+      else
+        _compile out_dir
+      end
+    end
+    
+    def get_content_table_html root
+      %~<ul>#{
+        @children
+        .select do |child|
+          (child.class == FolderModel) || (child.file_ext == '.ppz')
+        end
+        .map do |child|
+          result = "<li><a href=\"./#{root.relative_link child}\">#{child.name}</a></li>"
+          if child.is_a? FolderModel
+            result += child.get_content_table_html root
+          end
+          result
+        end
+        .join
+      }</ul>~
+    end
+
+    # 设置页面的“上一篇、下一篇”
+    private
+      def set_prev_and_next_page
+        list = []
+        linearize_children self, list
+        list.inject do |pre, nex|
+          pre.next_model = nex
+          nex.prev_model = pre
+          nex
+        end
+      end
+      
+      def linearize_children child, list
+        if child.is_a? PPZFileModel
+          list.push child
+        elsif child.is_a? FolderModel
+          list.push child
+          child.children.each do |cc|
+            linearize_children cc, list
+          end
+        end
+      end
+
+      def get_content_html
+        "<article>#{get_content_table_html self}</article>"
+      end
+  end
+end

data/lib/func/util.rb

@@ -4,7 +4,7 @@ class PPZ::Func
       if File.exist? filepath
         throw '文件已存在'
       end
-      file = File.new filepath, 'w'
+      file = File.new filepath, mode: 'w:UTF-8'
       file.print data
       file.close
     end
@@ -17,5 +17,13 @@ class PPZ::Func
     def class_has_const? instance, const_name
       has_const? instance.class, const_name
     end
+
+    def format_path path
+      if ['/', '\\'].include? path[-1]
+        path[0...-1]
+      else
+        path
+      end
+    end
   end
 end

data/lib/ppz.rb

@@ -1,26 +1,5 @@
 module PPZ
   require_relative './func/util'
-
-  require_relative './model/abstract/model'
-  require_relative './model/abstract/wrapper-model'
-  require_relative './model/section/abstract'
-  require_relative './model/section/leaf'
-  require_relative './model/section/root'
-  require_relative './model/comment/container'
-  require_relative './model/comment/item'
-  require_relative './model/common/escape'
-  require_relative './model/list/wrapper/abstract'
-  require_relative './model/list/wrapper/unordered'
-  require_relative './model/list/item/abstract'
-  require_relative './model/list/item/unordered'
-  require_relative './model/p/index'
-  require_relative './model/special-block/container'
-  require_relative './model/special-block/item'
-
-  require_relative './parser/common/context/abstract'
-  require_relative './parser/common/context/doc'
-  require_relative './parser/doc/abstract'
-  require_relative './parser/doc/file'
-  require_relative './parser/doc/string'
-
+  require_relative './doc/index'
+  require_relative './folder/index'
 end

metadata

@@ -1,49 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: ppz
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - wuse
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies: []
 description:
 email: 372301467@qq.com
-executables:
-- ppz
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- asset/style/ppz.css
-- asset/style/ppz.styl
-- bin/common.rb
-- bin/ppz
+- lib/doc/index.rb
+- lib/doc/model/abstract/model.rb
+- lib/doc/model/abstract/wrapper-model.rb
+- lib/doc/model/comment/container.rb
+- lib/doc/model/comment/item.rb
+- lib/doc/model/common/escape.rb
+- lib/doc/model/common/tag.rb
+- lib/doc/model/index.rb
+- lib/doc/model/list/item/abstract.rb
+- lib/doc/model/list/item/unordered.rb
+- lib/doc/model/list/wrapper/abstract.rb
+- lib/doc/model/list/wrapper/unordered.rb
+- lib/doc/model/p/index.rb
+- lib/doc/model/section/abstract.rb
+- lib/doc/model/section/leaf.rb
+- lib/doc/model/section/root.rb
+- lib/doc/model/special-block/container.rb
+- lib/doc/model/special-block/item.rb
+- lib/doc/parser/abstract.rb
+- lib/doc/parser/context.rb
+- lib/doc/parser/file.rb
+- lib/doc/parser/string.rb
+- lib/folder/index.rb
+- lib/folder/model/abstract.rb
+- lib/folder/model/file/abstract.rb
+- lib/folder/model/file/other.rb
+- lib/folder/model/file/ppz.rb
+- lib/folder/model/folder.rb
 - lib/func/util.rb
-- lib/model/abstract/model.rb
-- lib/model/abstract/wrapper-model.rb
-- lib/model/comment/container.rb
-- lib/model/comment/item.rb
-- lib/model/common/escape.rb
-- lib/model/common/tag.rb
-- lib/model/list/item/abstract.rb
-- lib/model/list/item/unordered.rb
-- lib/model/list/wrapper/abstract.rb
-- lib/model/list/wrapper/unordered.rb
-- lib/model/p/index.rb
-- lib/model/section/abstract.rb
-- lib/model/section/leaf.rb
-- lib/model/section/root.rb
-- lib/model/special-block/container.rb
-- lib/model/special-block/item.rb
-- lib/parser/common/context/abstract.rb
-- lib/parser/common/context/doc.rb
-- lib/parser/doc/abstract.rb
-- lib/parser/doc/file.rb
-- lib/parser/doc/string.rb
-- lib/parser/folder/index.rb
 - lib/ppz.rb
 homepage: https://github.com/daGaiGuanYu/ppz
 licenses:
@@ -67,5 +68,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: 写作
+summary: compile ppz to html
 test_files: []

data/asset/style/ppz.css

@@ -1,68 +0,0 @@
-html {
-  line-height: 1.5;
-}
-body,
-div,
-p,
-aside {
-  box-sizing: border-box;
-}
-body {
-  margin: 0;
-  padding: 0;
-  position: relative;
-}
-aside {
-  overflow-y: auto;
-  padding: 2rem 1rem;
-  position: fixed;
-  top: 0;
-  left: 0;
-  width: 188px;
-  height: 100vh;
-}
-aside ul {
-  margin: 0 0 0 1rem;
-  padding: 0;
-  list-style: none;
-}
-aside a {
-  width: 100%;
-  overflow: hidden;
-  text-overflow: ellipsis;
-  white-space: nowrap;
-}
-article {
-  margin-left: 188px;
-  padding: 1px 1rem;
-}
-h1 {
-  font-size: 2rem;
-}
-h2 {
-  font-size: 1.3rem;
-}
-h3 {
-  font-size: 1.1rem;
-  opacity: 0.9;
-}
-h1::before,
-h2::before,
-h3::before {
-  content: '# ';
-  opacity: 0.3;
-}
-.special-block {
-  white-space: pre;
-  background: #141c22;
-  overflow: auto;
-  border-radius: 4px;
-  color: #eee;
-  padding: 1rem;
-}
-.special-txt {
-  background: rgba(27,31,35,0.05);
-  border-radius: 4px;
-  font-size: 0.9em;
-  padding: 2px 4px;
-}

data/asset/style/ppz.styl

@@ -1,59 +0,0 @@
-html
-  line-height 1.5
-body, div, p, aside
-  box-sizing border-box
-
-body
-  margin 0
-  padding 0
-  position relative
-
-aside
-  overflow-y auto
-  padding: 2rem 1rem;
-
-  position fixed
-  top 0
-  left 0
-  width 188px
-  height 100vh
-
-  ul
-    margin 0 0 0 1rem
-    padding 0
-    list-style none
-  a
-    width 100%
-    overflow hidden
-    text-overflow ellipsis
-    white-space nowrap
-
-article
-  margin-left: 188px
-  padding: 1px 1rem
-h1
-  font-size 2rem
-h2
-  font-size 1.3rem
-h3
-  font-size 1.1rem
-  opacity 0.9
-
-h1, h2, h3
-  &::before
-    content '# '
-    opacity 0.3
-
-.special-block
-  white-space pre
-  background #141c22
-  overflow auto
-  border-radius 4px
-  color #eeeeee
-  padding 1rem
-
-.special-txt
-  background rgba(27, 31, 35, 0.05)
-  border-radius 4px
-  font-size 0.9em
-  padding 2px 4px

data/bin/common.rb

@@ -1,43 +0,0 @@
-require 'pathname'
-
-module PPZMain
-  CURRENT_PATH = File.dirname __FILE__
-  WORK_DIRECTORY = Pathname Dir.pwd
-  CSS_FILE_PATH = (Pathname CURRENT_PATH) + '../asset/style/ppz.css'
-
-  class Util
-    class << self
-      def get_in_and_out
-        target_in, target_out = ARGV
-
-        # + 输入文件
-        abort '要编译哪那个文件？请告诉我' unless target_in # 检查参数存在
-        target_in = (WORK_DIRECTORY + target_in).to_s # 绝对路径
-        unless File.exist? target_in # 不存在的话，看看加上 .ppz 后是否存在
-          target_in += '.ppz'
-          abort target_in[0..-5] + ' 不存在' unless File.exist? target_in # 还不存在的话，就说明是写错了
-        end
-        abort '尚未支持编译文件夹' if File.directory? target_in
-
-        # + 输出文件
-        unless target_out
-          # 从输入文件获取文件名
-          target_out = (/(.*).ppz$/.match target_in)?$1:target_in
-        end
-        target_out = WORK_DIRECTORY + target_out
-        # ++ 检查上级文件夹是否存在
-        upper_dir = (target_out + '..').to_s
-        abort upper_dir + ' 目录不存在' unless Dir.exist? upper_dir
-        # ++ 检查文件夹：有则检查里面有没有文件；无则创建文件夹
-        target_out = target_out.to_s
-        if Dir.exist? target_out
-          abort target_out + ' 不是一个空文件夹' unless (Dir.children target_out).size == 0
-        else
-          Dir.mkdir target_out
-        end
-        
-        [target_in, target_out]
-      end
-    end
-  end
-end

data/bin/ppz

@@ -1,18 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative '../lib/ppz'
-require_relative './common'
-require 'fileutils'
-require 'pathname'
-
-target_in, target_out = PPZMain::Util.get_in_and_out
-
-target_out = Pathname target_out
-output_html_path = target_out + 'index.html'
-output_css_path = target_out + 'index.css'
-
-parser = PPZ::FileDocParser.new target_in
-model = parser.get_model
-output_html = '<link rel="stylesheet" href="./index.css"/>' + model.to_html 
-PPZ::Func::write_to_file output_html_path.to_s, output_html
-FileUtils.cp PPZMain::CSS_FILE_PATH, output_css_path

data/lib/model/special-block/container.rb

@@ -1,18 +0,0 @@
-class PPZ::SpecialContainerModel < PPZ::AbstractWrapperModel
-  UpperClass = PPZ::AbstractSectionModel
-
-  REG_EXP = /^```( (.*))?/
-  def self.from_line line
-    return nil unless REG_EXP.match(line)
-    PPZ::SpecialContainerModel.new $2
-  end
-
-  def initialize name
-    @name = name
-    super()
-  end
-  
-  def to_html
-    "<div class=\"special-block #{@name}\">#{super}</div>"
-  end
-end

data/lib/parser/common/context/abstract.rb

@@ -1,30 +0,0 @@
-# 当前行，所处的上下文
-# 比如 一级 section 下面的 ul 下的 第 n 个 ul
-
-class PPZ::AbstractContext
-  def initialize root
-    @stack = [root]
-  end
-
-  # def append # 交给子类实现
-
-  def pop
-    @stack.pop
-  end
-
-  def head
-    @stack[-1]
-  end
-
-  def root
-    @stack[0]
-  end
-
-  private
-    def pop_to klass
-      loop do
-        break if head.is_a? klass
-        pop
-      end
-    end
-end

data/lib/parser/folder/index.rb

@@ -1,7 +0,0 @@
-# 解析一个文件夹里的 .ppz 文件
-
-class FolderParser
-  def initialize
-    @context = Context.new
-  end
-end