jekyll-zettel 0.4.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b84091ada73cf6ccb4006208b9cdbb4a54ff1141d343a7345c5f9ac0be0b18bd
-  data.tar.gz: af6162e054dc208eaf165fa9249d8dcabe356ae4f4f3156762fb37957d312902
+  metadata.gz: 12c74e815bb55368376966e3efc0a84ef0635c0ee8d66cf02cded71b02c06f45
+  data.tar.gz: 24da14c57cb4a4105b5f6683613115635c67e96731e2936d893f39b0bbcdf1cd
 SHA512:
-  metadata.gz: 0051ac31d604711fe6e5b3f423f69e62df02bf2da14587afd41407b7d5e74fc59822803ece006854e37db6fb992d6877e9513deab47e4f340426c459bc0e818e
-  data.tar.gz: 6dc3d8fd4f4240b01302c1b781a67fc7798e8b5f0ca186bdda7e9422e941f39495ab092e37cca35e75c631aba891ca313d9802ae7bfc8243df77df9ca404ce1b
+  metadata.gz: 60e2815612ca85eae9dab3aa0c351e5086f2e221889884e14b3f1da70a953a8523c90064af774f6b9e18681fb3372b75fc479fbf09a2c9820c903e269459e833
+  data.tar.gz: 6c12f7259736d3ac70a07f207004a17558966fd9e6479829b7fceeffaf9b84f3254d74bdb5b6644602b965f3187da95ca28f1863c62906ca9320b3b51e288c35

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
@@ -17,10 +17,12 @@ author:
 #
 # Optionale Properties
 #
+# akteure: []
 # tags: []
 # folgezettel: []
 # image:
 # via:
 #   text:
 #   href:
+#   annotation:
 ---

data/lib/jekyll/zettel/globals.rb

@@ -0,0 +1,18 @@
+module Jekyll
+  module Zettel
+    # Enrich site variables with some meta data
+    class Globals < Jekyll::Generator
+
+      priority :lowest
+
+      def generate(site)
+        site.data['url_page'] = {}
+
+        site.pages.each do |page|
+          site.data['url_page'][page.url] = page
+        end
+      end
+
+    end
+  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/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Zettel
-    VERSION = '0.4.3'.freeze
+    VERSION = '0.6.0'.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.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 Jekyll::Zettel::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 Jekyll::Zettel::LOG_KEY, 'Missing argument slug'
+      Jekyll.logger.info Jekyll::Zettel::LOG_KEY, 'usage: jekyll scaffold --glosse <slug>'
+      true
+    end
   end
 end
 
-require 'jekyll/commands/zettel'
+require 'jekyll/zettel/globals'
 require 'jekyll/zettel/references'
 require 'jekyll/zettel/reference'
 require 'jekyll/zettel/timeline'
 require 'jekyll/zettel/tags'
 require 'jekyll/zettel/zettelkasten'
+require 'jekyll/commands/scaffold'
+require 'jekyll/zettel/glosse'
+require 'jekyll/zettel/zettel'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-zettel
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Michael Gerzabek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
@@ -105,14 +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