jekyll-zettel 0.5.3 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5996b719e0aab85cc7a2b63e4463ea3285a29446602e65062886afa3ccc94b25
-  data.tar.gz: 2ebf053164cbaa31206ad9c1f8f8e05608b62f9172e475a8125efd6bfc1740f3
+  metadata.gz: 51a5c32e36a7b3917ba21eb4962a0778185d661ea7696e4f091814cf77e3227b
+  data.tar.gz: 57fd94df848c4efcbd98a575ff2c1bf9ee0267b4d087d078ff46aeb8d0cc21c2
 SHA512:
-  metadata.gz: 73f5d566617cc067433031c652760b77f0192d975bc63234f06d91c165b123c9b8c3b13fb91c3c2dc4f7d3829a0ee71edab68174106c6f15be8bcc88fc0e8958
-  data.tar.gz: eb86bc4170690f4ae4e7d5ca0b6282576dbc84077e5e7b5d85abe589ffd97c5b9f2743548d26f0637f201a6f9227c61c7a4b3012b0249d2533668817624b7caf
+  metadata.gz: 91bc3e64237d83ac01516fc1dbc639bc4bff1346adee7d139c428fc39b357c9f73b36c7f4ba636d4bb9b78c6aca06dff906af9b07355f2f8ffb2510091e1153d
+  data.tar.gz: e5fff6f734ce34f308d673a9861492f5c04d97824e47bde23503b57b1d571a6d3f7af5f89bc11ac3bd66c24a1421ecc4dbd4e918297e18d025d922a3b3b0b706

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,35 @@
+---
+# 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.
+#
+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:
+---
+
+
+<!-- Fußnoten -->
+
+<!-- Links -->

data/lib/jekyll/stubs/glosse.md

@@ -6,12 +6,13 @@ layout: glosse
 # Die ID der Glosse entspricht dem Namen des Unterverzeichnisses.
 # Dieser Wert darf auf keinen Fall geändert werden!
 #
-glosse: #{args['slug']}
+id: #{args['slug']} 
+tag: #{args['title']}
 #
 # Die Dokumentation aller Properties findest du unter
 # https://jessas.org/projekt/dokumentation/glosse/#frontmatter
 #
-title: #{args['title']}
+title:
 description:
 author:
 #
@@ -20,3 +21,8 @@ author:
 # tags: []
 # image:
 ---
+
+
+<!-- Fußnoten -->
+
+<!-- Links -->

data/lib/jekyll/stubs/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: #{args['uuid']}
+id: #{args['uuid']}
 #
 # Die Dokumentation aller Properties findest du unter
 # https://jessas.org/projekt/dokumentation/zettel/#frontmatter
@@ -26,3 +26,8 @@ author:
 #   href:
 #   annotation:
 ---
+
+
+<!-- Fußnoten -->
+
+<!-- Links -->

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.3'.freeze
+    VERSION = '0.6.3'.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,13 +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/commands/scaffold'
 require 'jekyll/zettel/globals'
-require 'jekyll/zettel/references'
+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.3
+  version: 0.6.3
 platform: ruby
 authors:
 - Michael Gerzabek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
@@ -105,16 +105,19 @@ files:
 - README.md
 - Rakefile
 - jekyll-zettel.gemspec
-- lib/jekyll/commands/zettel.rb
+- 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,110 +0,0 @@
-module Jekyll
-  module Commands
-    # Jekyll subcommand <zettel>
-    class Zettel < Command
-      class << self
-
-        # rubocop:disable Metrics/MethodLength
-        def init_with_program(prog)
-          prog.command(:zettel) do |c|
-            c.syntax 'zettel'
-            c.description 'Creates a new Infotype'
-            c.action do |args, _options|
-
-              infotype = args[0] || 'zettel'
-
-              if respond_to?("new_#{infotype}")
-
-                file = public_send("new_#{infotype}", args)
-                system("code #{File.expand_path(file)}") unless file.nil?
-
-              else
-                Jekyll.logger.error Jekyll::Zettel::LOG_KEY, "Invalid infotype #{infotype}"
-              end
-
-            end
-          end
-        end
-
-        def new_glosse(args)
-          if args[1].nil?
-            Jekyll.logger.error Jekyll::Zettel::LOG_KEY, 'Missing argument slug'
-            Jekyll.logger.info Jekyll::Zettel::LOG_KEY, 'usage: jekyll zettel glosse <slug>'
-            nil
-          else
-            slug = create_slug(args[1])
-            file = "glosse/#{slug}/index.md"
-            return file if create_dir_defensively('Glosse', slug, file).nil?
-
-            create_page({ 'slug' => slug, 'title' => args[1] }, file, 'glosse.md')
-
-            Jekyll.logger.info '✓', "Created glosse with slug `#{slug}`"
-            file
-          end
-        end
-
-        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 new_zettel(_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
-
-        def create_page(args, file, template)
-          File.open(file, 'w') { |out| out.write 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}", __dir__))
-          eval("\"#{string}\"")
-        end
-
-      end
-    end
-  end
-end