jekyll-zettel 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86d3e01f1ce8dd712930648f3275e4d83233da974377133502b561ee456a5695
-  data.tar.gz: 67b8e434c7583fb9ffca4ce55d1598aab65bc3312558181525bd2a4f94d1464a
+  metadata.gz: 5cad30485acb8a165fe6513d503c7230c321a6c5b7ca47a3aff343feb98f552e
+  data.tar.gz: 31c461aa7b6f22745b55eed8d66c14ccc40e9a34945e17bc236170657d73a994
 SHA512:
-  metadata.gz: 7420a97a318c4fe0cdb9707ebdb1b1460c3bec6b7d9580fe88fd71cd944b10d6010f8e6882b024bcf72f3f6b01e478a6ddab232df57413f5f48388f0c7d12c89
-  data.tar.gz: '083f0d824f9df40b45b5685060082088ff3e63335550bf97d167b74e1f569cb1b9cf6a36535c9eff078ff9dafd19b46e97899e07806c79667ea8369507d2df64'
+  metadata.gz: 01f9dd813b5bdc69a49329d6b87fc04019313046f66efaed07286c04937eb0d604f9f8ab3be9a5026feed1f671ab9b365e9a7bb47def4dff65a405bc7ded5b4e
+  data.tar.gz: faecf137658c630d2a57c4979d7630154d6c6aa6ec251110e6bfdadf13668770887a6532c0570db783e242fd64429e128355226559f2e1a73d44d67f04e0c6f3

data/.gitignore

@@ -1,2 +1,3 @@
 .idea
-Gemfile.lock
+*.lock
+*.gem

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/commands → commands}/zettel.rb

@@ -10,9 +10,11 @@ module Jekyll
             c.description 'Creates a new Zettel within subdir zettel'
             c.action do |_args, _options|
               uuid = new_zettel
-              new_page(uuid, "zettel/#{uuid}/index.md")
+              file = "zettel/#{uuid}/index.md"
+              new_page(uuid, file)
 
               Jekyll.logger.info '✓', "Created new Zettel with UUID: `#{uuid}`"
+              system("code #{File.expand_path(file)}")
             end
           end
         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,36 @@
+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.pages.each do |page|
+          next unless SLUG_FORMAT.match?(page.path.to_s)
+
+          register_tag(page)
+        end
+
+        write_catalog 'tags'
+      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'
+        }
+      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.0'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

data/lib/jekyll/zettel/zettelkasten.rb

@@ -0,0 +1,41 @@
+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.pages.each do |page|
+          next unless SLUG_FORMAT.match?(page.path.to_s)
+
+          register_zettel(page)
+        end
+
+        write_catalog 'zettelkasten'
+      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
+
+    end
+  end
+end

data/lib/jekyll/zettel.rb

@@ -1,17 +1,40 @@
 require 'jekyll'
 require 'securerandom'
 require 'fileutils'
+require 'citeproc'
+require 'csl/styles'
 
 module Jekyll
   # Jekyll zettel to your service
   module Zettel
 
-    autoload :VERSION, 'jekyll/laravel/bridge/version'
+    autoload :VERSION, 'jekyll/zettel/version'
 
-    LOG_KEY = 'Laravel 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.0
+  version: 0.4.0
 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