jekyll-zettel 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03b4b5ab3ab0cf0cad1c75d6057cc06a22e85d52f9491959575ca581f03c844e
-  data.tar.gz: 8299238a6a4c7a45ab1453d400199e1bb069d29af578532e5a90bbed93579b82
+  metadata.gz: 2b04c909f6875c77d95d63e4870a2b4a9916249bb881bf602f709a9ff4aca381
+  data.tar.gz: e6edd7dc79d77bef7263be87e24b2c90af28ddfc0ae7270a70e63e9b1cc6fc72
 SHA512:
-  metadata.gz: 12e9340c17a691c6227c16988188b396d5b2b38d5df4396309a1d1ccf6d3a0eb67346751e19e9b051d97dfde1407c3f60ce07d7484d09a82dc1591e5a6677647
-  data.tar.gz: bd4ffbb27f55c0fcae8206041aa7699d23c0b6113c1e39931a3f9d2f73ba6d912ff9d08db028b5833994efdcee1b610724e743eac86ef6d10529faacc72959cc
+  metadata.gz: fb40a4449183978303653da1c54f8412ea4a3d7ec3664a7da420ea46b031fcfebf87a5bef7c40383337028bf5dc6f1a183a8d681888df4b30bbc2ab1c1a5dd0a
+  data.tar.gz: 6cdc3f9417565c49574eaf9cf3759192fa2fafebabe9551b00a33c14d2222179dcf73d41032d05cd5a17f97403b92e957be3303b58e3cdf78dc5ab68d42951d7

data/lib/jekyll/commands/scaffold.rb

@@ -0,0 +1,51 @@
+module Jekyll
+  module Commands
+    # Jekyll subcommand <scaffold>
+    class Scaffold < Command
+      class << self
+
+        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def init_with_program(prog)
+          prog.command(:scaffold) do |c|
+            c.syntax 'scaffold <option> [arg]'
+            c.description 'Create new infotype scaffold'
+            c.option 'akteur', '-a', '--akteur', 'scaffold a new Akteur; arg <full name> required'
+            c.option 'blatt', '-b', '--blatt', 'scaffold a new Arbeitsblatt; arg <title> required'
+            c.option 'glosse', '-g', '--glosse', 'scaffold a new Glosse; arg <title> required'
+            c.option 'zeitleiste', '-e', '--zeitleiste', 'scaffold a new Zeitleiste; arg <title> required'
+            c.option 'zettel', '-z', '--zettel', 'scaffold a new Zettel'
+            c.action do |args, options|
+
+              if options.empty?
+                Jekyll.logger.error Jekyll::Zettel::LOG_KEY, 'Missing infotype, use: jekyll scaffold <option> [arg]'
+              else
+                infotype = options.keys[0].capitalize
+                name = "Jekyll::Zettel::#{infotype}"
+                if class_exists?(name)
+                  clazz = name.split('::').inject(Object) do |o, c|
+                    o.const_get c
+                  end
+
+                  file = clazz.new.scaffold(args)
+                  system("code #{File.expand_path(file)}") unless file.nil?
+                  # puts file
+                else
+                  Jekyll.logger.error Jekyll::Zettel::LOG_KEY, "Infotype `#{infotype}` not yet implemented"
+                end
+              end
+            end
+          end
+        end
+
+        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+        def class_exists?(clazz)
+          klass = Module.const_get(clazz)
+          klass.is_a?(Class)
+        rescue NameError
+          false
+        end
+
+      end
+    end
+  end
+end

data/lib/jekyll/stubs/blatt.md

@@ -0,0 +1,30 @@
+---
+# created_at: #{Time.now}
+#
+# Never ever change the id of your page!
+#  Changing the id has manifold side effects. Most of them unwanted.
+#  If you want to move or rename the page do it within the realms of
+#  this project.
+#
+page_id: #{args['id']}
+#
+#
+# Be careful in changing the layout of this page.
+#  Additional meta data may be required.
+#
+layout: page
+#
+#
+# The following front-matter attributes are mandatory
+#
+title:
+description:
+#
+#
+# These front-matter attributes are optional, but support a nice
+#  look-and-feel. If you want to use them just delete the hash
+#  character at the beginning of the corresponding lines.
+#
+# kicker:
+# image:
+---

data/lib/jekyll/stubs/glosse.md

@@ -0,0 +1,22 @@
+---
+layout: glosse
+#
+# created_at: #{Time.now}
+#
+# Die ID der Glosse entspricht dem Namen des Unterverzeichnisses.
+# Dieser Wert darf auf keinen Fall geändert werden!
+#
+glosse: #{args['slug']}
+#
+# Die Dokumentation aller Properties findest du unter
+# https://jessas.org/projekt/dokumentation/glosse/#frontmatter
+#
+title: #{args['title']}
+description:
+author:
+#
+# Optionale Properties
+#
+# tags: []
+# image:
+---

data/lib/jekyll/stubs/{index.md → zettel.md}

@@ -6,7 +6,7 @@ layout: zettel
 # Die UUID des Zettels entspricht dem Namen des Unterverzeichnisses.
 # Dieser Wert darf auf keinen Fall geändert werden!
 #
-zettel: #{uuid}
+zettel: #{args['uuid']}
 #
 # Die Dokumentation aller Properties findest du unter
 # https://jessas.org/projekt/dokumentation/zettel/#frontmatter

data/lib/jekyll/zettel/globals.rb

@@ -3,13 +3,13 @@ module Jekyll
     # Enrich site variables with some meta data
     class Globals < Jekyll::Generator
 
-      priority :highest
+      priority :lowest
 
       def generate(site)
-        site.data['url2page'] = {}
+        site.data['url_page'] = {}
 
         site.pages.each do |page|
-          site.data['url2page'][page.url] = page
+          site.data['url_page'][page.url] = page
         end
       end
 

data/lib/jekyll/zettel/glosse.rb

@@ -0,0 +1,22 @@
+module Jekyll
+  module Zettel
+    # Scaffolder for infotype Glosse
+    class Glosse
+
+      include Jekyll::Zettel
+
+      def scaffold(args)
+        return nil if args_empty?(args)
+
+        slug = create_slug(args.first)
+        file = "glosse/#{slug}/index.md"
+        return file if create_dir_defensively('Glosse', slug, file).nil?
+
+        create_page({ 'slug' => slug, 'title' => args.first }, file, 'glosse.md')
+
+        Jekyll.logger.info '✓', "Created glosse with slug `#{slug}`"
+        file
+      end
+    end
+  end
+end

data/lib/jekyll/zettel/references.rb

@@ -2,7 +2,7 @@ module Jekyll
   module Zettel
     # Enrich page front matter with object meta data
     class References < Jekyll::Generator
-      include Zettel
+      include Jekyll::Zettel
 
       priority :highest
 

data/lib/jekyll/zettel/tags.rb

@@ -2,7 +2,7 @@ module Jekyll
   module Zettel
     # Generate tags.json from page front matter
     class Tags < Jekyll::Generator
-      include Zettel
+      include Jekyll::Zettel
 
       SLUG_FORMAT = %r{glosse/(?<slug>.*)/index.(?<ext>html|md)}i.freeze
 

data/lib/jekyll/zettel/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Zettel
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.6.1'.freeze
   end
 end

data/lib/jekyll/zettel/zettel.rb

@@ -0,0 +1,28 @@
+module Jekyll
+  module Zettel
+    # Scaffolder for infotype Zettel
+    class Zettel
+
+      include Jekyll::Zettel
+
+      def scaffold(_args)
+        uuid = create_uuid
+        file = "zettel/#{uuid}/index.md"
+        create_page({ 'uuid' => uuid }, file, 'zettel.md')
+
+        Jekyll.logger.info '✓', "Created new Zettel with UUID `#{uuid}`"
+        file
+      end
+
+      def create_uuid
+        uuid = SecureRandom.uuid
+        dir = "zettel/#{uuid}"
+        return create_uuid if File.directory?(dir)
+
+        FileUtils.mkdir_p(dir)
+        uuid
+      end
+
+    end
+  end
+end

data/lib/jekyll/zettel/zettelkasten.rb

@@ -2,7 +2,7 @@ module Jekyll
   module Zettel
     # Generate tags.json from page front matter
     class Zettelkasten < Jekyll::Generator
-      include Zettel
+      include Jekyll::Zettel
 
       priority :low
 

data/lib/jekyll/zettel.rb

@@ -29,12 +29,69 @@ module Jekyll
 
       @site.pages << page
     end
+
+    def create_page(args, file, template)
+      File.open(file, 'w') { |out| out.write evaluate_template(args, template) }
+      # puts evaluate_template(args, template)
+    end
+
+    # rubocop:disable Style/EvalWithLocation, Security/Eval, Lint/UnusedMethodArgument
+    def evaluate_template(args, template)
+      string = File.read(File.expand_path("../stubs/#{template}", __FILE__))
+      eval("\"#{string}\"")
+    end
+
+    # rubocop:enable Style/EvalWithLocation, Security/Eval, Lint/UnusedMethodArgument
+    # rubocop: disable Layout/FirstHashElementIndentation, Metrics/MethodLength
+    def create_slug(title)
+      I18n.config.available_locales = :de
+      I18n.locale = :de
+      I18n.backend.store_translations(:de, i18n: {
+        transliterate: {
+          rule: {
+            'Ä' => 'Ae',
+            'Ö' => 'Oe',
+            'Ü' => 'Ue',
+            'ü' => 'ue',
+            'ö' => 'oe',
+            'ä' => 'ae',
+            'ß' => 'sz'
+          }
+        }
+      })
+      Jekyll::Utils.slugify(title, mode: 'latin')
+    end
+
+    def create_dir_defensively(infotype, slug, file)
+      dir = File.dirname(file)
+      if File.directory?(dir)
+        if File.exist?(file)
+          Jekyll.logger.error LOG_KEY, "#{infotype} `#{slug}` already present"
+          nil
+        else
+          dir
+        end
+      else
+        FileUtils.mkdir_p(dir)
+      end
+    end
+
+    def args_empty?(args)
+      return false unless args.empty?
+
+      Jekyll.logger.error LOG_KEY, 'Missing argument slug'
+      Jekyll.logger.info LOG_KEY, 'usage: jekyll scaffold --glosse <slug>'
+      true
+    end
   end
 end
 
-require 'jekyll/commands/zettel'
-require 'jekyll/zettel/references'
+require 'jekyll/commands/scaffold'
+require 'jekyll/zettel/globals'
+require 'jekyll/zettel/glosse'
 require 'jekyll/zettel/reference'
-require 'jekyll/zettel/timeline'
+require 'jekyll/zettel/references'
 require 'jekyll/zettel/tags'
+require 'jekyll/zettel/timeline'
+require 'jekyll/zettel/zettel'
 require 'jekyll/zettel/zettelkasten'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-zettel
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Michael Gerzabek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
@@ -105,15 +105,19 @@ files:
 - README.md
 - Rakefile
 - jekyll-zettel.gemspec
-- lib/jekyll/commands/zettel.rb
-- lib/jekyll/stubs/index.md
+- lib/jekyll/commands/scaffold.rb
+- lib/jekyll/stubs/blatt.md
+- lib/jekyll/stubs/glosse.md
+- lib/jekyll/stubs/zettel.md
 - lib/jekyll/zettel.rb
 - lib/jekyll/zettel/globals.rb
+- lib/jekyll/zettel/glosse.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/zettel.rb
 - lib/jekyll/zettel/zettelkasten.rb
 homepage: https://michaelgerzabek.com/gems/jekyll-zettel
 licenses:

data/lib/jekyll/commands/zettel.rb

@@ -1,47 +0,0 @@
-module Jekyll
-  module Commands
-    # Jekyll subcommand <zettel>
-    class Zettel < Command
-      class << self
-
-        def init_with_program(prog)
-          prog.command(:zettel) do |c|
-            c.syntax 'zettel'
-            c.description 'Creates a new Zettel within subdir zettel'
-            c.action do |_args, _options|
-              uuid = new_zettel
-              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
-
-        def new_zettel
-          uuid = SecureRandom.uuid
-          dir = "zettel/#{uuid}"
-          return new_zettel if File.directory?(dir)
-
-          FileUtils.mkdir_p(dir)
-          uuid
-        end
-
-        def new_page(uuid, file)
-          File.open(file, 'w') { |out|
-            out.write evaluate_template(uuid, 'index.md')
-          }
-        end
-
-        # rubocop:disable Style/EvalWithLocation, Security/Eval, Lint/UnusedMethodArgument
-        def evaluate_template(uuid, file)
-          template = File.read(File.expand_path("../stubs/#{file}", __dir__))
-          eval("\"#{template}\"")
-        end
-        # rubocop:enable Style/EvalWithLocation, Security/Eval, Lint/UnusedMethodArgument
-
-      end
-    end
-  end
-end