jekyll-documents 0.1.1

data/lib/jekyll/documents/generator.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "date"
+
+module Jekyll
+  module Documents
+    # Main generator that scans document files and creates Jekyll collection items
+    # @api public
+    class Generator < ::Jekyll::Generator
+      safe true
+      priority :normal
+
+      # Generates document collection from files in configured root directory
+      # @param site [Jekyll::Site] the Jekyll site instance
+      # @return [void]
+      def generate(site)
+        @site   = site
+        @config = Configuration.read(site)
+
+        root = File.join(site.source, @config["root"])
+        unless Dir.exist?(root)
+          ::Jekyll.logger.warn "jekyll-documents", "Directory not found: #{root}"
+          return
+        end
+
+        collection = ensure_collection(site, "documents")
+
+        Dir.glob("#{root}/**/*").each do |path|
+          next unless File.file?(path)
+
+          ext = File.extname(path).downcase
+          if @config["strict_extensions"] && !@config["include_extensions"].include?(ext)
+            ::Jekyll.logger.abort_with "jekyll-documents",
+                                       "Unsupported file type: #{path} (#{ext})"
+          end
+          next unless @config["include_extensions"].include?(ext)
+
+          rel_path = path.start_with?(site.source) ? path[(site.source.length + 1)..-1] : path
+          category = infer_category_from(rel_path)
+          basename = File.basename(path, ext)
+
+          date, title, valid = parse_filename(basename)
+          if !valid && @config["strict_filename"]
+            ::Jekyll.logger.abort_with "jekyll-documents",
+              "Filename must be 'YYYY-MM-DD_Title.ext' → #{rel_path}"
+          end
+
+          slug = build_slug(basename)
+
+          doc = ::Jekyll::Document.new(
+            source_stub_for(basename, category),
+            site: site,
+            collection: collection
+          )
+
+          doc.data["layout"]     = @config["layout"]
+          doc.data["title"]      = title
+          doc.data["date"]       = date || File.mtime(path)
+          doc.data["category"]   = remap_category(category)
+          doc.data["file_url"]   = "/" + rel_path
+          doc.data["extension"]  = ext
+          doc.data["file_type"]  = ext.sub(".", "").downcase
+          doc.data["slug"]       = slug
+          doc.data["permalink"]  = @config["permalink"]
+            .gsub(":category", doc.data["category"].to_s)
+            .gsub(":slug", slug)
+
+          doc.content = "Auto-generated document page."
+
+          collection.docs << doc
+        end
+      end
+
+      private
+
+      # Ensures a collection exists and is configured for output
+      # @param site [Jekyll::Site] the Jekyll site instance
+      # @param label [String] the collection name
+      # @return [Jekyll::Collection] the collection
+      def ensure_collection(site, label)
+        unless site.collections[label]
+          site.collections[label] = ::Jekyll::Collection.new(site, label)
+          site.config["collections"] ||= {}
+          site.config["collections"][label] = { "output" => true }
+        end
+        site.collections[label]
+      end
+
+      # Creates a virtual source path for the document
+      # @param basename [String] the file basename
+      # @param category [String] the document category
+      # @return [String] virtual source path
+      def source_stub_for(basename, category)
+        File.join("_documents", "#{category}-#{basename}.md")
+      end
+
+      # Infers category from the file's directory path
+      # @param rel_path [String] relative path from site source
+      # @return [String] the category name
+      def infer_category_from(rel_path)
+        return "uncategorized" unless @config["categories_from_path"]
+        category_dir = File.dirname(rel_path).sub("#{@config['root']}", "")
+        category_dir.split("/").reject(&:empty?).last || "uncategorized"
+      end
+
+      # Remaps category name using category_map configuration
+      # @param cat [String] the original category
+      # @return [String] the remapped category (lowercased)
+      def remap_category(cat)
+        map = @config["category_map"] || {}
+        (map[cat] || cat).to_s.downcase
+      end
+
+      # Parses filename to extract date and title
+      # @param basename [String] the filename without extension
+      # @return [Array<Date, String, Boolean>] date, title, and validity flag
+      def parse_filename(basename)
+        if basename =~ /^(\d{4})-(\d{2})-(\d{2})_(.+)$/
+          date = Date.parse("#{Regexp.last_match(1)}-#{Regexp.last_match(2)}-#{Regexp.last_match(3)}")
+          title = Regexp.last_match(4).tr("_", " ")
+          [date, title, true]
+        else
+          [nil, basename.tr("_", " "), false]
+        end
+      rescue ArgumentError
+        [nil, basename.tr("_", " "), false]
+      end
+
+      # Builds a URL-safe slug from filename
+      # @param basename [String] the filename without extension
+      # @return [String] the generated slug
+      def build_slug(basename)
+        s = basename.sub(/^\d{4}-\d{2}-\d{2}_/, "")
+        s = s.gsub(/[æøåÆØÅ]/, {"æ"=>"ae","ø"=>"oe","å"=>"aa","Æ"=>"Ae","Ø"=>"Oe","Å"=>"Aa"}) if @config["slug_danish_map"]
+        s = s.downcase if @config["slug_downcase"]
+        s = s.gsub(/[^\p{Alnum}\-_\s]/u, "").tr("_ ", "--").gsub(/-+/, "-")
+        s = s.sub(/^-+/, "").sub(/-+$/, "")  # Remove leading/trailing hyphens
+        s.empty? ? "untitled" : s
+      end
+    end
+  end
+end

data/lib/jekyll/documents/json_index_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "utils"
+
+module Jekyll
+  module Documents
+    class JsonIndexGenerator < ::Jekyll::Generator
+      safe true
+      priority :low
+
+      def generate(site)
+        cfg = Configuration.read(site)
+        return unless cfg["json_index"]
+
+        docs = site.collections["documents"]&.docs || []
+        return if docs.empty?
+
+        items = docs.map do |d|
+          {
+            "url"       => d.url,
+            "title"     => d.data["title"],
+            "category"  => d.data["category"],
+            "date"      => (d.data["date"] || Time.at(0)).strftime("%Y-%m-%d"),
+            "slug"      => d.data["slug"],
+            "file_type" => d.data["file_type"],
+            "extension" => d.data["extension"]
+          }
+        end
+
+        json = JSON.pretty_generate(items)
+        path = cfg["json_index_path"] || "/documents.json"
+
+        site.static_files << TextStaticFile.new(site, site.source, path, json)
+      end
+    end
+  end
+end

data/lib/jekyll/documents/tags/latest_documents.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Documents
+    class LatestDocumentsTag < Liquid::Tag
+      def initialize(tag_name, markup, tokens)
+        super
+        @args = parse_args(markup)
+      end
+      
+      public_class_method :new
+
+      def render(context)
+        site = context.registers[:site]
+        cfg  = Configuration.read(site)
+        count = (@args["count"] || cfg["latest_default_count"] || 5).to_i
+        category = @args["category"]
+
+        docs = site.collections["documents"]&.docs || []
+        docs = docs.select { |d| d.data["category"] == category } if category
+        docs = docs.sort_by { |d| d.data["date"] || Time.at(0) }.reverse.first(count)
+
+        out = +"<ul class=\"latest-documents\">\n"
+        docs.each do |d|
+          title = escape_html(d.data["title"])
+          url   = escape_html(d.url)
+          date  = (d.data["date"] || Time.at(0)).strftime("%Y-%m-%d")
+          out << %(<li><a href="#{url}">#{title}</a> <small>(#{date})</small></li>\n)
+        end
+        out << "</ul>\n"
+        out
+      end
+
+      private
+
+      def escape_html(text)
+        return "" unless text
+        text.to_s.gsub(/[&<>"']/, {
+          "&" => "&amp;",
+          "<" => "&lt;",
+          ">" => "&gt;",
+          '"' => "&quot;",
+          "'" => "&#39;"
+        })
+      end
+
+      def parse_args(markup)
+        # supports: count:5 category:'referat'
+        args = {}
+        markup.scan(/(\w+)\s*:\s*'([^']*)'|(\w+)\s*:\s*([^\s]+)/).each do |m|
+          if m[0]
+            args[m[0]] = m[1]
+          else
+            args[m[2]] = m[3]
+          end
+        end
+        args
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("latest_documents", Jekyll::Documents::LatestDocumentsTag)
+

data/lib/jekyll/documents/utils.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Documents
+    # A tiny StaticFile subclass for writing text files during build.
+    class TextStaticFile < ::Jekyll::StaticFile
+      def initialize(site, base, rel_dest, content)
+        @site = site
+        @base = base
+        @dir  = File.dirname(rel_dest)
+        @name = File.basename(rel_dest)
+        @content = content
+        super(site, base, @dir, @name)
+      end
+
+      def write(dest)
+        dest_path = destination(dest)
+        FileUtils.mkdir_p(File.dirname(dest_path))
+        File.write(dest_path, @content)
+        true
+      rescue StandardError => e
+        Jekyll.logger.error "jekyll-documents", "Failed to write #{dest_path}: #{e.message}"
+        false
+      end
+    end
+  end
+end

data/lib/jekyll/documents/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Documents
+    VERSION = "0.1.1"
+  end
+end

data/lib/jekyll-documents.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "jekyll/documents/version"
+require_relative "jekyll/documents/configuration"
+require_relative "jekyll/documents/utils"
+require_relative "jekyll/documents/filters"
+require_relative "jekyll/documents/file_type_icons"
+require_relative "jekyll/documents/generator"
+require_relative "jekyll/documents/json_index_generator"
+
+# Liquid tag(s)
+require_relative "jekyll/documents/tags/latest_documents"
+
+module Jekyll
+  module Documents
+    # Namespace module for the plugin.
+  end
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-documents
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Svend Gundestrup
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A Jekyll plugin + theme that scans assets/documents/**, creates a collection
+  item per file, adds metadata (title/date/category), outputs pages, generates a JSON
+  index for Lunr, and integrates with jekyll-sitemap.
+email:
+- no-reply@borg-collective.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- _includes/category_list.html
+- _includes/documents_list.html
+- _includes/documents_search.html
+- _includes/latest_documents.html
+- _layouts/document.html
+- assets/icons/color/ai-document-svgrepo-com.svg
+- assets/icons/color/attachment-document-svgrepo-com.svg
+- assets/icons/color/audio-document-svgrepo-com.svg
+- assets/icons/color/box-notes-svgrepo-com.svg
+- assets/icons/color/csv-document-svgrepo-com.svg
+- assets/icons/color/eps-document-svgrepo-com.svg
+- assets/icons/color/excel-document-svgrepo-com.svg
+- assets/icons/color/exe-document-svgrepo-com.svg
+- assets/icons/color/flash-document-svgrepo-com.svg
+- assets/icons/color/folder-svgrepo-com.svg
+- assets/icons/color/gdoc-document-svgrepo-com.svg
+- assets/icons/color/gdocs-document-svgrepo-com.svg
+- assets/icons/color/gform-document-svgrepo-com.svg
+- assets/icons/color/gpres-document-svgrepo-com.svg
+- assets/icons/color/gsheet-document-svgrepo-com.svg
+- assets/icons/color/html-document-svgrepo-com.svg
+- assets/icons/color/image-document-svgrepo-com.svg
+- assets/icons/color/keynote-document-svgrepo-com.svg
+- assets/icons/color/library-folder-svgrepo-com.svg
+- assets/icons/color/link-svgrepo-com.svg
+- assets/icons/color/mp4-document-svgrepo-com.svg
+- assets/icons/color/overlay-document-svgrepo-com.svg
+- assets/icons/color/pack-document-svgrepo-com.svg
+- assets/icons/color/pages-document-svgrepo-com.svg
+- assets/icons/color/pdf-document-svgrepo-com.svg
+- assets/icons/color/ppt-document-svgrepo-com.svg
+- assets/icons/color/psd-document-svgrepo-com.svg
+- assets/icons/color/quip-doc-svgrepo-com.svg
+- assets/icons/color/quip-sheet-document-svgrepo-com.svg
+- assets/icons/color/quip-slide-document-svgrepo-com.svg
+- assets/icons/color/rtf-document-svgrepo-com.svg
+- assets/icons/color/slide-document-svgrepo-com.svg
+- assets/icons/color/stypi-document-svgrepo-com.svg
+- assets/icons/color/txt-document-svgrepo-com.svg
+- assets/icons/color/unknown-document-svgrepo-com.svg
+- assets/icons/color/video-document-svgrepo-com.svg
+- assets/icons/color/visio-document-svgrepo-com.svg
+- assets/icons/color/webex-document-svgrepo-com.svg
+- assets/icons/color/word-document-svgrepo-com.svg
+- assets/icons/color/xml-document-svgrepo-com.svg
+- assets/icons/color/zip-document-svgrepo-com.svg
+- assets/icons/lines/ae-file-type-svgrepo-com.svg
+- assets/icons/lines/ai-file-type-svgrepo-com.svg
+- assets/icons/lines/avi-file-type-svgrepo-com.svg
+- assets/icons/lines/css-file-type-svgrepo-com.svg
+- assets/icons/lines/csv-file-type-svgrepo-com (1).svg
+- assets/icons/lines/eps-file-type-svgrepo-com.svg
+- assets/icons/lines/excel-file-type-svgrepo-com.svg
+- assets/icons/lines/file-file-type-svgrepo-com.svg
+- assets/icons/lines/folder-svgrepo-com.svg
+- assets/icons/lines/html-file-type-svgrepo-com.svg
+- assets/icons/lines/jpg-file-type-svgrepo-com.svg
+- assets/icons/lines/mov-file-type-svgrepo-com.svg
+- assets/icons/lines/mp3-file-type-svgrepo-com.svg
+- assets/icons/lines/other-file-type-svgrepo-com.svg
+- assets/icons/lines/pdf-file-type-svgrepo-com.svg
+- assets/icons/lines/png-file-type-svgrepo-com.svg
+- assets/icons/lines/ppt-file-type-svgrepo-com.svg
+- assets/icons/lines/psd-file-type-svgrepo-com.svg
+- assets/icons/lines/rar-file-type-svgrepo-com.svg
+- assets/icons/lines/txt-file-type-svgrepo-com.svg
+- assets/icons/lines/wav-file-type-svgrepo-com.svg
+- assets/icons/lines/word-file-type-svgrepo-com.svg
+- assets/icons/lines/zip-file-type-svgrepo-com.svg
+- assets/icons/minimal/c-file-format-document-extension-file-format-2-svgrepo-com.svg
+- assets/icons/minimal/c-file-format-document-extension-file-format-svgrepo-com.svg
+- assets/icons/minimal/css-file-format-document-extension-file-format-svgrepo-com.svg
+- assets/icons/minimal/dwg-file-format-document-extension-file-format-svgrepo-com.svg
+- assets/icons/minimal/dxf-file-format-document-extension-file-format-svgrepo-com.svg
+- assets/icons/minimal/extension-file-format-document-file-format-2-svgrepo-com.svg
+- assets/icons/minimal/extension-file-format-document-file-format-svgrepo-com.svg
+- assets/icons/minimal/extension-file-format-html-document-file-format-svgrepo-com.svg
+- assets/icons/minimal/extension-file-format-jpg-document-file-format-svgrepo-com.svg
+- assets/icons/minimal/extension-file-format-json-document-file-format-svgrepo-com
+  (1).svg
+- assets/icons/minimal/extension-file-format-pdf-document-file-format-svgrepo-com.svg
+- assets/icons/minimal/extension-file-format-php-document-file-format-svgrepo-com.svg
+- assets/icons/minimal/extension-file-format-sql-document-file-format-svgrepo-com.svg
+- assets/icons/minimal/extension-file-format-txt-document-file-format-svgrepo-com.svg
+- assets/icons/minimal/file-format-gif-document-extension-file-format-svgrepo-com.svg
+- assets/icons/minimal/file-format-jpeg-document-extension-file-format-svgrepo-com.svg
+- assets/icons/minimal/file-format-js-document-extension-file-format-svgrepo-com.svg
+- assets/icons/minimal/file-format-vb-document-extension-file-format-svgrepo-com.svg
+- assets/icons/minimal/folder-svgrepo-com.svg
+- assets/icons/minimal/ico-file-format-svgrepo-com.svg
+- assets/icons/ultra-minimal/doc.svg
+- assets/icons/ultra-minimal/file.svg
+- assets/icons/ultra-minimal/folder-svgrepo-com.svg
+- assets/icons/ultra-minimal/jpg.svg
+- assets/icons/ultra-minimal/mp3.svg
+- assets/icons/ultra-minimal/mp4.svg
+- assets/icons/ultra-minimal/pdf.svg
+- assets/icons/ultra-minimal/png.svg
+- assets/icons/ultra-minimal/ppt.svg
+- assets/icons/ultra-minimal/txt.svg
+- assets/icons/ultra-minimal/xls.svg
+- assets/icons/ultra-minimal/zip.svg
+- assets/js/documents-search.js
+- jekyll-documents.gemspec
+- lib/jekyll-documents.rb
+- lib/jekyll/documents/configuration.rb
+- lib/jekyll/documents/file_type_icons.rb
+- lib/jekyll/documents/filters.rb
+- lib/jekyll/documents/generator.rb
+- lib/jekyll/documents/json_index_generator.rb
+- lib/jekyll/documents/tags/latest_documents.rb
+- lib/jekyll/documents/utils.rb
+- lib/jekyll/documents/version.rb
+homepage: https://github.com/gundestrup/jekyll-documents
+licenses:
+- AGPL-3.0-only
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Auto-generate Jekyll pages for documents (PDF/DOCX/...) with category/date/title
+  parsing.
+test_files: []