jekyll-tally-tags 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9f3b50581391cccac7bc2d547b81e9743ac18b50b67d1f45edb1ce33375bf5d
-  data.tar.gz: 6315e0acc2cb6ef41502c9c2f01802eda8cdc902f59a00fdd1a73f27e5671a41
+  metadata.gz: 5903dcfca2ed55cd34e7a86a40ca2565b2aa7981f2a3fe81d04a35d6a2bbe558
+  data.tar.gz: 4ece7a9e9aaa7ddbf1cfe54efea8f03d7c534c59e273d6f2cb501d71c7131346
 SHA512:
-  metadata.gz: fa45959ee8ef70b6bb4fd57471e726c64291a778d53daf4a1742afabf4f6adc040b0c0ed7fc9ccbefaaf12fb9420b8da4d71b0ea817ab126d10d7d9619e4c9f4
-  data.tar.gz: f3cade603df833c774ab36c095132e81b9f0083186dd823716d0909a7b7ab5a34f92745050aa11d89a93107deca98c8ee807d4c9085c3c648f266e6259b581be
+  metadata.gz: dfb1fa03b7ced48a5f6ee40cf228602166f4f063a877cc558ad6a61b045e0917b111ac4ce4ac4dc32fc02aa2a0c9afb064b8dac974017b0bb521eeea2704002c
+  data.tar.gz: 19dc53b00954e5f764310c8ee2438b6d7463dca92ccac0b3b32ca67f03146429030c14586cfb5a5b957737c390729c0885db5469f9cae2648588579ad5a419da

data/lib/jekyll-tally-tags.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll-tally-tags/version"
+
+module Jekyll
+  module TallyTags
+
+    autoload :DocsToItems, "jekyll-tally-tags/docs_to_items"
+    autoload :Item, "jekyll-tally-tags/item"
+    autoload :ItemsToPage, "jekyll-tally-tags/items_to_page"
+    autoload :Methods, "jekyll-tally-tags/methods"
+    autoload :Utils, "jekyll-tally-tags/utils"
+    autoload :BasePage, "jekyll-tally-tags/pages/base_page"
+    autoload :DayPage, "jekyll-tally-tags/pages/day_page"
+    autoload :MonthPage, "jekyll-tally-tags/pages/month_page"
+    autoload :MultiplePage, "jekyll-tally-tags/pages/multiple_page"
+    autoload :SinglePage, "jekyll-tally-tags/pages/single_page"
+    autoload :WeeksPage, "jekyll-tally-tags/pages/weeks_page"
+    autoload :WeekPage, "jekyll-tally-tags/pages/week_page"
+    autoload :YearPage, "jekyll-tally-tags/pages/year_page"
+
+    DEBUG = false
+
+    Jekyll::Hooks.register :site, :after_init do |_|
+      puts 'site   after_init 在网站初始化时，但是在设置和渲染之前，适合用来修改网站的配置项' if DEBUG
+      # 修改正则让 `2021-01-01.md` 就算无后缀也可读
+      Jekyll::Document::DATE_FILENAME_MATCHER = NO_NAME
+    end
+
+    Jekyll::Hooks.register :site, :post_read do |site|
+      puts 'site   post_read 在网站数据从磁盘中读取并加载之后' if DEBUG
+      DocsToItems.read(site)
+    end
+
+    class ItemsToPage < Jekyll::Generator
+      safe true
+      # @param [Configuration] config
+      def initialize(config = nil)
+        @config  = Utils.get_permalink_config(config)
+        @enabled = Utils.get_permalink_config(config, ENABLED)
+      end
+
+      # @param [Site] site
+      def generate(site)
+        # 判断是否为空
+        return if @config.nil?
+        # 开始赋值
+        @site  = site
+        @posts = site.posts
+        @pages = []
+
+        read_all(@config[PERMALINKS], @site.posts.docs)
+        # 把所有的拼接到到 `pages` 里面
+        @site.pages.concat(@pages)
+        # 配置里面也放一份
+        @site.config[PAGES] = @pages
+      end
+
+      # @param [Hash{String => String}] permalinks
+      # @param [Array<Document>] scan_docs
+      def read_all(permalinks, scan_docs)
+        permalinks.each do |key, permalink|
+          # 判断 链接是否包含 :xxx :(\w+)
+          matches = []
+          permalink.scan(/:(\w+)/) { |match| matches << match[0] }
+          read_loop(key, {}, Array.new(scan_docs), matches, 0)
+        end
+      end
+
+      # @param [String] permalink_key
+      # @param [Hash{Symbol => String}] titles
+      # @param [Array<Document>] docs
+      # @param [Array<String>] matches
+      # @param [Integer] index
+      def read_loop(permalink_key, titles, docs, matches, index)
+        if index > matches.size - 1
+          return
+        end
+        match = matches[index]
+        # 找到对应的 docs
+        if DATE_HASH.keys.include?(match)
+          docs_hash = date_to_docs_hash(docs, DATE_HASH[match])
+          read_any(docs_hash, match.to_sym, permalink_key, titles, matches, index + 1)
+        else
+          begin
+            docs_hash = tags_to_docs_hash(docs, match)
+            read_any(docs_hash, match.to_sym, permalink_key, titles, matches, index + 1)
+          rescue
+            Jekyll.logger.warn CLASSIFY, "没有该keys ':#{match}'"
+          end
+        end
+      end
+
+      # @param [Hash{String => Array<Document>}] docs_hash
+      # @param [Symbol] symbol
+      # @param [String] permalink_key
+      # @param [Hash{Symbol => String}] titles
+      # @param [Array<String>] matches
+      # @param [Integer] index
+      def read_any(docs_hash, symbol, permalink_key, titles, matches, index)
+        docs_hash.each do |key, docs|
+          new_titles = titles.merge({ symbol => key })
+          # 开启了该字段 同时 是匹配的最后一项的时候 写入数组
+          if enabled?(permalink_key) && index == matches.size
+            clz = SinglePage
+            case permalink_key
+            when YEAR
+              clz = YearPage
+            when MONTH
+              clz = MonthPage
+            when DAY
+              clz = DayPage
+            when WEEK
+              clz = WeekPage
+            when WEEKS
+              clz = WeekPage
+            end
+            @pages << clz.new(@site, new_titles, permalink_key, docs.keep_if { |doc| doc.data[TEMPLATE] })
+          end
+          read_loop(permalink_key, new_titles, docs, matches, index)
+        end
+      end
+
+      private
+
+      # @param [String] type
+      def enabled?(type)
+        @enabled == true || @enabled == ALL || (@enabled.is_a?(Array) && @enabled.include?(type))
+      end
+
+      # @param [Array<Document>] docs
+      # @param [String] attr
+      # @return [Hash{String => Array<Document>}]
+      def tags_to_docs_hash(docs, attr)
+        hash = Hash.new { |h, key| h[key] = [] }
+        docs.each do |doc|
+          doc.data[attr]&.each { |key| hash[key] << doc }
+        end
+        hash.each_value { |docs| docs.sort!.reverse! }
+        hash
+      end
+
+      # @param [Array<Document>] docs `yaml` 头部信息
+      # @param [String] id ISO-8601
+      # @return [Hash{String=>Array<Document>}]
+      def date_to_docs_hash(docs, id)
+        hash = Hash.new { |h, k| h[k] = [] }
+        docs.each { |doc| hash[doc.date.strftime(id)] << doc }
+        hash.each_value { |docs| docs.sort!.reverse! }
+        hash
+      end
+
+    end
+
+    Jekyll::Hooks.register :site, :after_reset do |_|
+      puts 'site   after_reset 网站重置之后' if DEBUG
+    end
+    Jekyll::Hooks.register :site, :pre_render do |_|
+      puts 'site   pre_render 在渲染整个网站之前' if DEBUG
+    end
+    Jekyll::Hooks.register :site, :post_render do |_|
+      puts 'site   post_render 在渲染整个网站之后，但是在写入任何文件之前' if DEBUG
+    end
+    Jekyll::Hooks.register :site, :post_write do |_|
+      puts 'site   post_write 在将整个网站写入磁盘之后' if DEBUG
+    end
+    Jekyll::Hooks.register :pages, :post_init do |_|
+      puts 'pages   post_init 每次页面被初始化的时候' if DEBUG
+    end
+    Jekyll::Hooks.register :pages, :pre_render do |_|
+      puts 'pages   pre_render 在渲染页面之前' if DEBUG
+    end
+    Jekyll::Hooks.register :pages, :post_render do |_|
+      puts 'pages   post_render 在页面渲染之后，但是在页面写入磁盘之前' if DEBUG
+    end
+    Jekyll::Hooks.register :pages, :post_write do |_|
+      puts 'pages   post_write 在页面写入磁盘之后' if DEBUG
+    end
+    Jekyll::Hooks.register :posts, :post_init do |_|
+      puts 'posts   post_init 每次博客被初始化的时候' if DEBUG
+    end
+    Jekyll::Hooks.register :posts, :pre_render do |_|
+      puts 'posts   pre_render 在博客被渲染之前' if DEBUG
+    end
+    Jekyll::Hooks.register :posts, :post_render do |_|
+      puts 'posts   post_render 在博客渲染之后，但是在被写入磁盘之前' if DEBUG
+    end
+    Jekyll::Hooks.register :posts, :post_write do |_|
+      puts 'posts   post_write 在博客被写入磁盘之后' if DEBUG
+    end
+    Jekyll::Hooks.register :documents, :post_init do |_|
+      puts 'documents   post_init 每次文档被初始化的时候' if DEBUG
+    end
+    Jekyll::Hooks.register :documents, :pre_render do |_|
+      puts 'documents   pre_render 在渲染文档之前' if DEBUG
+    end
+    Jekyll::Hooks.register :documents, :post_render do |_|
+      puts 'documents   post_render 在渲染文档之后，但是在被写入磁盘之前' if DEBUG
+    end
+    Jekyll::Hooks.register :documents, :post_write do |_|
+      puts 'documents   post_write 在文档被写入磁盘之后' if DEBUG
+    end
+  end
+end

data/lib/jekyll-tally-tags/docs_to_items.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+module Jekyll
+  module TallyTags
+    class DocsToItems
+      # @param [Site] site
+      def self.read(site)
+        templates = Utils.get_templates(site.config)
+        return unless templates
+        date_hash = insert_to_date_hash(templates, site.posts.docs)
+        # 排序
+        date_hash.sort_by { |a, b| a }
+        items = read_csv(date_hash, templates)
+        items = combine_tags(items, site)
+        create_items(items, site)
+      end
+
+      # @param [Array<Hash{String => Object}>] items
+      # @param [Site] site
+      def self.create_items(items, site)
+        item_objects = []
+        items.each do |item|
+          item_objects << Item.new(item, site)
+        end
+        site.posts.docs += item_objects
+      end
+
+      # @param [Array<Hash>] items
+      # @param [Site] site
+      def self.combine_tags(items, site)
+        configs = site.config.fetch(TALLY, {})
+        return nil unless configs && !configs.empty?
+        if configs[COMBINE] && configs[COMBINE].is_a?(Array)
+          configs[COMBINE].each do |config|
+            find  = config[FIND]
+            to    = config[TO]
+            deep  = config[DEEP]
+            finds = []
+            items.each do |item|
+              if item.keys.include?(find)
+                # 找到所有 `key`
+                finds += item[find]
+              end
+            end
+            finds.uniq!
+            if finds.size >= 2
+              items.each { |item| item[to] = [] }
+              combines = Utils.combine_tags(finds, deep)
+              Utils.link_combines(combines, items, find, to)
+            end
+          end
+        end
+        items
+      end
+
+      # @param [Hash{Date => Hash{String => Array<String>}}] date_hash
+      # @param [Hash{String => Hash}] templates
+      # @return [Array[Hash{String => Object}]]
+      def self.read_csv(date_hash, templates)
+        items = []
+        date_hash.each do |date, hash|
+          hash.each do |temp, csv_list|
+            keys = nil
+            csv_list.each_with_index do |csv, index|
+              # 正则处理 把",,,"这样的 分割成" ,  ,  , "
+              csv.gsub!(/[，|,|\s]+/, " , ")
+              # lstrip rstrip 去掉前后空格
+              values = csv.split(',').each(&:lstrip!).each(&:rstrip!)
+              if !keys && index == 0
+                keys = values
+                next
+              end
+              dates       = {
+                DATES => date.to_s,
+                YEAR  => date.strftime("%Y"),
+                MONTH => date.strftime("%m"),
+                DAY   => date.strftime("%d"),
+                WEEKS => date.strftime("%W"),
+                WEEK  => date.strftime("%w"),
+              }
+              dates_array = {}
+              dates.each { |k, v| dates_array[k] = [v] }
+              item = {
+                ID            => items.size,
+                PERMALINK     => "/#{ID}/#{items.size}",
+                SLUG          => dates[DATES],
+                DATE          => date.to_time,
+                TEMPLATE      => temp,
+                KEYS          => keys,
+                KEYS_EXTEND   => dates.keys + keys,
+                VALUES        => values,
+                VALUES_EXTEND => dates.values + values,
+                LAYOUT        => DEFAULT
+              }.merge(dates_array)
+
+              # 附加内容
+              templates[temp].keep_if { |k, _| k != KEYS }.each do |key, formatters|
+                item[key] = Utils.format_values(values, formatters)
+              end
+              items << item
+            end
+          end
+        end
+        items
+      end
+
+      # @example 转为下面形式
+      # ``` yml
+      # 2001-01-01:
+      #   - template_key:
+      #     - A B C D E F G
+      #     - a b c d e f g
+      # ```
+      # @param [Hash{String => Hash}] templates
+      # @param [Array<Document>] docs
+      # @return [Hash{Date => Hash}]
+      def self.insert_to_date_hash(templates, docs)
+        date_hash = Hash.new { |h, k| h[k] = {} }
+        docs.each do |doc|
+          need_delete = false
+          # 找出 第一层就是模板的
+          items = doc.data.select { |k, _| templates.keys.include?(k) }
+          # 合并到第二层去
+          Utils.inner_merge(date_hash, doc.date.to_date, items)
+          # 把所有的日期合并到一起
+          doc.data.each do |key, value|
+            if key.is_a?(Date)
+              need_delete = true
+              Utils.inner_merge(date_hash, key.to_date, value)
+            end
+          end
+          # 这个文档可以被处理
+          if need_delete || items
+            docs.delete(doc)
+          end
+        end
+        # 把模板内自带有 `keys` 的加入进来
+        date_hash.each do |date, hash|
+          hash.each do |temp_key, csv_list|
+            if templates[temp_key][KEYS]
+              csv_list.insert(0, templates[temp_key][KEYS].join(" "))
+            end
+          end
+        end
+        date_hash
+      end
+    end
+  end
+end

data/lib/jekyll-tally-tags/item.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+module Jekyll
+  module TallyTags
+    class Item < Document
+      # @param [Hash] item
+      # @param [Site] site
+      def initialize(item, site)
+        @data       = item
+        @site       = site
+        @path       = "#{site.collections_path}/_posts/#{item[DATE].to_date.to_s}-#{item[ID]}.md"
+        @extname    = File.extname(@path)
+        @collection = site.posts
+        @type       = @collection.label.to_sym
+
+        @has_yaml_header = nil
+
+        if draft?
+          categories_from_path("_drafts")
+        else
+          categories_from_path(collection.relative_directory)
+        end
+
+        data.default_proc = proc do |_, key|
+          site.frontmatter_defaults.find(relative_path, type, key)
+        end
+
+        # 加入 link
+        permalinks       = Utils.get_permalink_config(site.config, PERMALINKS)
+        item[PERMALINKS] = Hash.new { |h, k| h[k] = [] }
+        permalinks.each do |key, permalink|
+          permalink.scan(/:(\w+)/) do |match_data|
+            match = match_data[0]
+            if item.keys.include?(match)
+              item[match].each_with_index do |t, index|
+                permalink                    = item[PERMALINKS][key][index] ? item[PERMALINKS][key][index] : String.new(permalink)
+                item[PERMALINKS][key][index] = permalink.gsub(":#{match}", t.is_a?(Array) ? t.join('-') : t)
+              end
+            end
+          end
+        end
+        # 获取当前配置
+        template = Utils.get_templates(site.config)[item[TEMPLATE]]
+        template = {}.merge(template)
+        template.keep_if do |key, _|
+          key != TITLE && key != COUNT
+        end
+        # 分析内容
+        contents = []
+        item[KEYS].each_with_index do |key, index|
+          contents[index] = {
+            KEY   => key,
+            VALUE => item[VALUES][index],
+          }
+          template.each do |tag, indexes|
+            if indexes.include? index
+              contents[index][SYMBOL] = tag
+              # FIXME: 这里乱序就会出问题
+              contents[index][PERMALINK] = item[PERMALINKS][tag].delete_at(0)
+              contents[index][MD_URL]    = to_url(contents[index][VALUE], contents[index][PERMALINK])
+            end
+          end
+        end
+
+        year       = item[YEAR][0]
+        month      = item[MONTH][0]
+        day        = item[DAY][0]
+        week       = item[WEEK][0].to_i
+        permalinks = item[PERMALINKS]
+        # 加入时间
+        date_hash      = {
+          KEY    => "日期",
+          VALUE  => "#{year}/#{month}/#{day}-#{WEEK_VALUE[week]}",
+          SYMBOL => DATE,
+          MD_URL => "#{to_url(year, permalinks[YEAR][0])}/#{to_url(month, permalinks[MONTH][0])}/#{to_url(day, permalinks[DAY][0])}-#{to_url(WEEK_VALUE[week], permalinks[WEEK][0])}"
+        }
+        item[CONTENTS] = [] + contents
+        contents.insert(0, date_hash)
+        item[DATE_TITLE]    = date_hash
+        item[DATE_CONTENTS] = contents
+      end
+
+      def to_url(text, permalink)
+        "[#{text}](#{permalink})"
+      end
+    end
+  end
+end