update_tags 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69ec4948120440a717e986fd4f234335e8dece80e0a81e7d780ae5a4d6baafc3
+  data.tar.gz: 02d4c89d961614bad98a3fab0734f604956999049b8ddcbef84dab1e474ef06a
+SHA512:
+  metadata.gz: 9ad03b9b42459a1dda150edae1e17bc6a251461c76c80d28b9f0e89927d259c61c804f5fafea9f656e23d31fc5749d4164e72c91c099583177c2df14757bf7fb
+  data.tar.gz: 91403efaea60abfadbdc1da19f6ad0e2f5036d7efcb6460c41247059f316542ca486d9bb1bd722c6880b737a8529a5bd912e2a3689f26db5564f0048d6bc2cf8

data/bin/update_tags

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby
+
+require "update_tags"
+require "thor"
+require "filewatcher"
+
+# update_tags now
+# update_tags now --at tag --template _includes/tag_index_page.md
+#
+# update_tags continuously
+# update_tags continuously --at tag --template _includes/tag_index_page.md
+
+class UpdateTagsCli < Thor
+  DEFAULT_TAG_DIRECTORY = "tag"
+  DEFAULT_PATH_TO_TAG_INDEX_PAGE_TEMPLATE = "_includes/tag_index_page.md"
+
+  class_option :at,
+    default: DEFAULT_TAG_DIRECTORY,
+    desc: "the directory in which to put the tag index pages"
+
+  class_option :template,
+    default: DEFAULT_PATH_TO_TAG_INDEX_PAGE_TEMPLATE,
+    desc: "the path to the file defining the tag index page template"
+
+  desc "now", "update your jekyll blog's tag index pages"
+
+  def now
+    UpdateTags.update(
+      tag_directory: options[:at],
+      path_to_tag_index_page_template: options[:template],
+    )
+  end
+
+  desc "continuously", "update your jekyll blog's tag index pages continuously"
+
+  def continuously
+    UpdateTags.update(
+      tag_directory: options[:at],
+      path_to_tag_index_page_template: options[:template],
+    )
+
+    Filewatcher.new(["_posts", options[:template]]).watch do |changes|
+      UpdateTags.update(
+        tag_directory: options[:at],
+        path_to_tag_index_page_template: options[:template],
+      )
+    end
+  end
+end
+
+UpdateTagsCli.start(ARGV)

data/lib/update_tags.rb

@@ -0,0 +1,103 @@
+require "front_matter_parser"
+require "fileutils"
+
+class UpdateTags
+  def self.update(tag_directory:, path_to_tag_index_page_template:)
+    new(tag_directory, path_to_tag_index_page_template).update
+  end
+
+  attr_reader :tag_directory, :path_to_tag_index_page_template
+
+  def initialize(tag_directory, path_to_tag_index_page_template)
+    @tag_directory = tag_directory
+    @path_to_tag_index_page_template = path_to_tag_index_page_template
+  end
+
+  def update
+    print "Updating tags..."
+    delete_tag_pages
+    create_tag_pages
+    print " Done.\n"
+  end
+
+  private
+
+  def delete_tag_pages
+    FileUtils.rm_rf(tag_directory)
+  end
+
+  def create_tag_pages
+    FileUtils.mkdir(tag_directory)
+
+    tags.each do |tag|
+      File.write(
+        tag_index_page_path(tag),
+        tag_index_page_source(tag),
+      )
+    end
+  end
+
+  def blog_post_filenames
+    @blog_post_filenames ||= Dir.entries("./_posts") - [".", ".."]
+  end
+
+  def tags
+    @tags ||= blog_post_filenames.inject([]) do |tags, blog_post_filename|
+      tags += FrontMatterParser::Parser
+        .parse_file(blog_post_file(blog_post_filename))
+        .front_matter["tags"]
+    end.uniq
+  end
+
+  def blog_post_file(blog_post_filename)
+    "./_posts/#{blog_post_filename}"
+  end
+
+  def tag_index_page_path(tag)
+    "#{tag_directory}/#{url_friendly_tag(tag)}.md"
+  end
+
+  def url_friendly_tag(tag)
+    tag.downcase.split(" ").join("-")
+  end
+
+  def tag_index_page_front_matter_parser
+    @tag_index_page_front_matter_parser ||= FrontMatterParser::Parser
+      .parse_file(path_to_tag_index_page_template)
+  end
+
+  def tag_index_page_front_matter
+    @tag_index_page_front_matter ||= \
+      tag_index_page_front_matter_parser.front_matter.map do |key, value|
+        "#{key}: #{value}"
+      end.join("\n")
+  end
+
+  def tag_index_page_content
+    @tag_index_page_content ||= tag_index_page_front_matter_parser.content
+  end
+
+  def injected_liquid_for_tag_index_page(tag)
+    <<~INJECTED_LIQUID
+      {% assign tag = "#{tag}" %}
+      {% assign tagged_posts = "" | split: "" %}
+      {% for post in site.posts %}
+        {% if post.tags contains tag %}
+          {% assign tagged_posts = tagged_posts | push: post %}
+        {% endif %}
+      {% endfor %}
+    INJECTED_LIQUID
+  end
+
+  def tag_index_page_source(tag)
+    <<~TAG_INDEX_PAGE
+      ---
+      #{tag_index_page_front_matter}
+      ---
+
+      #{injected_liquid_for_tag_index_page(tag)}
+
+      #{tag_index_page_content}
+    TAG_INDEX_PAGE
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: update_tags
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick Pachulski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: front_matter_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: Automatically update your jekyll blog's tag index pages for GitHub Pages
+email: nick@pachulski.me
+executables:
+- update_tags
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/update_tags
+- lib/update_tags.rb
+homepage: https://github.com/pachun/update_tags
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Jekyll blog post tags for GitHub Pages
+test_files: []