jekyll-zettel 0.1.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 429c613abf3e702150740eb4c4442b2fe0fc49d7b3b4ec7e305c494c8dd13c61
-  data.tar.gz: 72c0c9abbb7f46d75ec514e87a4fad0b65eaabe38ed2814a02ad4964728abac6
+  metadata.gz: 7293e5026d2854b40b1cc8660fc31b22d98ab1080d803c052a2e619de24b8cff
+  data.tar.gz: f55cf5c4105f4589d6ba1663d18878dd4e4c7a70dbf05cbc6bca17e2760a2cf4
 SHA512:
-  metadata.gz: '09f66d5b88803ca6f018774e1f2eb09fe6145c9be6414b81b67b822204cc9ac4553987f814798efee58d351f29e0686013005235f5ba6899d3b6b7b56f499939'
-  data.tar.gz: dea14c69a5327cf527a2717de3834cc57bf4110ec32321004f13f418053c6a9be923729c477b529d98cb7a559e6def8e396bf2b300acd3d958c4e0319ebfff1e
+  metadata.gz: c07d939e66707568bb54bc640f2be09c771b21361d2e8e16a6d90fc0ab7c90dd33bd1cbb2b9eef71c4f7b3038c2d1ae85ec47fc438f11d817f54c4e71ccb9df7
+  data.tar.gz: 249459ea018980190901d630c0bdc16c05fae38974211a8051bbea3a1ff74de7d2f28352ae0c20c44a43f656fd70568b3a1eadd74020eb85cdae058b59071d36

data/README.md

@@ -24,9 +24,9 @@ TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Gem zusammenbauen mit `gem build jekyll-zettel.gemspec -V --debug`
+Gem publizieren mit `gem push jekyll-zettel-0.1.0.gem` (die Versionsnummer entsprechend anpassen).
+Verwendet Google Authenticator ;-)
 
 ## Contributing
 

data/jekyll-zettel.gemspec

@@ -27,6 +27,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'fileutils', '>= 1.4', '< 2.0'
-  spec.add_dependency 'jekyll', '>= 3.8', '< 5.0'
+  spec.add_runtime_dependency 'citeproc-ruby', '>= 2.0', '< 3.0'
+  spec.add_runtime_dependency 'csl-styles', '>= 2.0', '< 3.0'
+  spec.add_runtime_dependency 'fileutils', '>= 1.4', '< 2.0'
+  spec.add_runtime_dependency 'jekyll', '>= 3.8', '< 5.0'
 end

data/lib/jekyll/{zettel/stubs → 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/reference.rb

@@ -0,0 +1,15 @@
+module Jekyll
+  module Zettel
+    # Liquid tag that renders the reference the Zettel is based on
+    class Reference < Liquid::Tag
+
+      def render(context)
+        return unless context.registers[:page].key?('citekey')
+
+        context.registers[:site].config['citeproc'].render :bibliography, id: context.registers[:page]['citekey']
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('reference', Jekyll::Zettel::Reference)

data/lib/jekyll/zettel/references.rb

@@ -0,0 +1,57 @@
+module Jekyll
+  module Zettel
+    # Enrich page front matter with object meta data
+    class References < Jekyll::Generator
+      include Zettel
+
+      priority :highest
+
+      attr_reader :site
+
+      def generate(site)
+        @site = site
+
+        @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)
+        dir = File.dirname(doc.path)
+        file = @site.in_source_dir(dir, 'reference.json')
+        return unless File.exist?(file)
+
+        doc.data['reference'] = SafeYAML.load_file(file)
+
+        register_reference(doc, file)
+      end
+
+      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
+          Jekyll.logger.warn LOG_KEY, 'missing property @id'
+          Jekyll.logger.warn '', "./#{file}"
+        end
+      end
+
+    end
+  end
+end

data/lib/jekyll/zettel/tags.rb

@@ -0,0 +1,48 @@
+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'
+        }
+        register_tags(doc, parts[:slug])
+      end
+
+      def register_tags(doc, slug)
+        return unless doc.data.key?('tags')
+
+        doc.data['tags'].each { |tag|
+          @site.data['tag2glosse'][slug] = [] unless @site.data['tag2glosse'].key?(slug)
+
+          @site.data['tag2glosse'][slug] << tag
+        }
+      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.1.1'.freeze
+    VERSION = '0.4.1'.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

@@ -1,6 +1,8 @@
 require 'jekyll'
 require 'securerandom'
 require 'fileutils'
+require 'citeproc'
+require 'csl/styles'
 
 module Jekyll
   # Jekyll zettel to your service
@@ -8,10 +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/zettel/commands/zettel'
+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,15 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-zettel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Michael Gerzabek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-03 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: citeproc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: csl-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: fileutils
   requirement: !ruby/object:Gem::Requirement
@@ -65,10 +105,15 @@ files:
 - README.md
 - Rakefile
 - jekyll-zettel.gemspec
+- lib/jekyll/commands/zettel.rb
+- lib/jekyll/stubs/index.md
 - lib/jekyll/zettel.rb
-- lib/jekyll/zettel/commands/zettel.rb
-- lib/jekyll/zettel/stubs/index.md
+- 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