jekyll-zettel 0.2.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 921384cb754da348e878073a1ad14e05f84a530015d6dcab10be12c6c9f1d9fa
-  data.tar.gz: 1f2d96180b3177197c1436fe03c948ebb8811ca07a44871c728dc0ab376305f0
+  metadata.gz: 139c69b08fb7f8bacee03b6d1903f69e6de8f865a70e6cba2807d0d3f7097e8c
+  data.tar.gz: 501e5de45c6348d6510323d97e9e6e583b7807a4b80a312f919e7358a8c77e9c
 SHA512:
-  metadata.gz: 4b32fb9290c44c7b0eb6561578e9dc1a67bb4da9ee6ebc6396290c80dce04fb6bc3c756af2ee132ecca6e73ed02c1bfa59ab031d25f5e5317e57d7fa77ac969d
-  data.tar.gz: 56cd8b1aa65a850ba66997acc4040ab7b37c429086b1c43cea679c46ac84275bdd43b425416d58afe0d42bea18b821675c914b684b52a7034e14a413bf5b6dd2
+  metadata.gz: 4c41bcf8edd1a28185ef23f88ba2d8e8e199b5357a8c147edb7a1e97e37a7caab2738363badf144785e6e253cb2d2c8ac4d83e37e52403b231814775fce259e7
+  data.tar.gz: f150041e4a8b31d864c02bf1fe57bb521ab6e4689195d2fe5383e28a1decea536abce5369507aed2c8ac3f705377b728280c20e7b12817869e7bc7da6608dd55

data/lib/jekyll/stubs/index.md

@@ -1,4 +1,6 @@
 ---
+layout: zettel
+#
 # created_at: #{Time.now}
 #
 # Die UUID des Zettels entspricht dem Namen des Unterverzeichnisses.
@@ -9,14 +11,14 @@ zettel: #{uuid}
 # Die Dokumentation aller Properties findest du unter
 # https://jessas.org/dokumentation/zettel/#frontmatter
 #
-layout: 
 title: 
 description: 
+author:
 #
 # Optionale Properties
 #
-# author: 
 # tags: []
+# folgezettel: []
 # image:
 # via:
 #   text:

data/lib/jekyll/zettel/references.rb

@@ -2,6 +2,7 @@ module Jekyll
   module Zettel
     # Enrich page front matter with object meta data
     class References < Jekyll::Generator
+      include Zettel
 
       priority :highest
 
@@ -10,13 +11,24 @@ module Jekyll
       def generate(site)
         @site = site
 
-        @site.config['citeproc'] = CiteProc::Processor.new locale: 'de-AT', style: 'apa', format: 'html'
+        @site.data['references'] = {}
+        configure_citeproc
 
         site.pages.each do |page|
           next unless page.path.to_s.end_with?('index.html') || page.path.to_s.end_with?('index.md')
 
           tie_reference(page)
         end
+
+        write_catalog 'references'
+      end
+
+      def configure_citeproc
+        locale = @site.config['citation']['locale'] || 'en-US'
+        style = @site.config['citation']['style'] || 'apa'
+
+        @site.config['citeproc'] = CiteProc::Processor.new locale: locale, style: style, format: 'html'
+        Jekyll.logger.info LOG_KEY, "Configured cite processor `#{locale}`/`#{style}`"
       end
 
       def tie_reference(doc)
@@ -31,6 +43,7 @@ module Jekyll
 
       def register_reference(doc, file)
         if doc.data['reference'].include?('id')
+          @site.data['references'][doc.data['reference']['id']] = doc.data['reference']
           @site.config['citeproc'].register doc.data['reference']
           doc.data['citekey'] = doc.data['reference']['id']
         else
@@ -38,6 +51,7 @@ module Jekyll
           Jekyll.logger.warn '', "./#{file}"
         end
       end
+
     end
   end
 end

data/lib/jekyll/zettel/tags.rb

@@ -0,0 +1,50 @@
+module Jekyll
+  module Zettel
+    # Generate tags.json from page front matter
+    class Tags < Jekyll::Generator
+      include Zettel
+
+      SLUG_FORMAT = %r{glosse/(?<slug>.*)/index.(?<ext>html|md)}i.freeze
+
+      attr_reader :site
+
+      def generate(site)
+        @site = site
+        @site.data['tags'] = {}
+        @site.data['tag2glosse'] = {}
+
+        site.pages.each do |page|
+          next unless SLUG_FORMAT.match?(page.path.to_s)
+
+          register_tag(page)
+        end
+
+        write_catalog 'tags'
+        write_catalog 'tag2glosse'
+      end
+
+      def register_tag(doc)
+        parts = doc.path.to_s.match(SLUG_FORMAT)
+        @site.data['tags'][parts[:slug]] = {
+          'slug' => parts[:slug],
+          'tag' => doc.data['tag'] || 'Missing @tag',
+          'label' => doc.data['title'] || 'Missing @title',
+          'description' => doc.data['description'] || 'Missing @description',
+          'tags' => doc.data['tags']
+        }
+        doc.data['slug'] = parts[:slug]
+        register_tags(doc)
+      end
+
+      def register_tags(doc)
+        return unless doc.data.key?('tags')
+
+        doc.data['tags'].each { |tag|
+          @site.data['tag2glosse'][tag] = [] unless @site.data['tag2glosse'].key?(tag)
+
+          @site.data['tag2glosse'][tag] << doc.data['slug']
+        }
+      end
+    end
+  end
+end

data/lib/jekyll/zettel/timeline.rb

@@ -0,0 +1,29 @@
+module Jekyll
+  module Zettel
+    # Enrich page front matter with timeline data
+    class Timeline < Jekyll::Generator
+
+      attr_reader :site
+
+      def generate(site)
+        @site = site
+
+        site.pages.each do |page|
+          next unless page.path.to_s.end_with?('index.html') || page.path.to_s.end_with?('index.md')
+
+          tie_timeline(page)
+        end
+      end
+
+      def tie_timeline(doc)
+        dir = File.dirname(doc.path)
+        file = @site.in_source_dir(dir, 'timeline.json')
+        return unless File.exist?(file)
+
+        doc.data['timeline'] = SafeYAML.load_file(file)
+        doc.data['timeline']['src'] = "#{doc.url}timeline.json"
+      end
+
+    end
+  end
+end

data/lib/jekyll/zettel/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Zettel
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.4.2'.freeze
   end
 end

data/lib/jekyll/zettel/zettelkasten.rb

@@ -0,0 +1,53 @@
+module Jekyll
+  module Zettel
+    # Generate tags.json from page front matter
+    class Zettelkasten < Jekyll::Generator
+      include Zettel
+
+      priority :low
+
+      SLUG_FORMAT = %r{zettel/(?<uuid>.*)/index.(?<ext>html|md)}i.freeze
+
+      attr_reader :site
+
+      def generate(site)
+        @site = site
+        @site.data['zettelkasten'] = {}
+        @site.data['tag2zettel'] = {}
+
+        site.pages.each do |page|
+          next unless SLUG_FORMAT.match?(page.path.to_s)
+
+          register_zettel(page)
+          register_tags(page)
+        end
+
+        write_catalog 'zettelkasten'
+        write_catalog 'tag2zettel'
+      end
+
+      def register_zettel(doc)
+        @site.data['zettelkasten'][doc.data['zettel']] = {
+          'zettel' => doc.data['zettel'],
+          'title' => doc.data['title'],
+          'description' => doc.data['description'],
+          'author' => doc.data['author'],
+          'tags' => doc.data['tags'],
+          'folgezettel' => doc.data['folgezettel'],
+          'via' => doc.data['via'],
+          'citekey' => doc.data['citekey']
+        }
+      end
+
+      def register_tags(doc)
+        return unless doc.data.key?('tags')
+
+        doc.data['tags'].each { |tag|
+          @site.data['tag2zettel'][tag] = [] unless @site.data['tag2zettel'].key?(tag)
+
+          @site.data['tag2zettel'][tag] << doc.data['zettel']
+        }
+      end
+    end
+  end
+end

data/lib/jekyll/zettel.rb

@@ -10,12 +10,31 @@ module Jekyll
 
     autoload :VERSION, 'jekyll/zettel/version'
 
-    LOG_KEY = 'Jekyll Zettel'.freeze
+    LOG_KEY = 'Zettel:'.freeze
 
     class Error < StandardError; end
+
+    def write_catalog(object)
+      Jekyll.logger.info LOG_KEY, "Created references in `#{@site.in_dest_dir('.objects', "#{object}.json")}`"
+
+      page = Jekyll::PageWithoutAFile.new(@site, @site.source, '.objects', "#{object}.json").tap do |file|
+        file.content = JSON.pretty_generate(@site.data[object.to_s])
+        file.data.merge!(
+          'layout' => nil,
+          'sitemap' => false,
+        )
+
+        file.output
+      end
+
+      @site.pages << page
+    end
   end
 end
 
 require 'jekyll/commands/zettel'
 require 'jekyll/zettel/references'
 require 'jekyll/zettel/reference'
+require 'jekyll/zettel/timeline'
+require 'jekyll/zettel/tags'
+require 'jekyll/zettel/zettelkasten'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-zettel
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Michael Gerzabek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
@@ -110,7 +110,10 @@ files:
 - lib/jekyll/zettel.rb
 - lib/jekyll/zettel/reference.rb
 - lib/jekyll/zettel/references.rb
+- lib/jekyll/zettel/tags.rb
+- lib/jekyll/zettel/timeline.rb
 - lib/jekyll/zettel/version.rb
+- lib/jekyll/zettel/zettelkasten.rb
 homepage: https://michaelgerzabek.com/gems/jekyll-zettel
 licenses:
 - MIT