jekyll-id 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6d612e8b6adffc3bf1942aba34c9deb41af024c15690203a47d3aec02f57406
-  data.tar.gz: 137843c64bf07337eb0bd41c529983fa6d8a2dcae34d8697b1e33d56d967ff0e
+  metadata.gz: a752baec6b8cd1ed0166b772d833d8c0193705a991a22a1b1396aa350b9bc11c
+  data.tar.gz: 348a752ef9abb6ff465239f76b1b9111f540a511b4d851383e574dcd4067290a
 SHA512:
-  metadata.gz: b250239213feeda31ce106751b73ca4ed104212686b30288eea9a1f5a062bba9c18361d393cdb5518976cc340b93fb4912d24363f1edc47f8a2f9d90964ab8de
-  data.tar.gz: 33e13ee948dc4adfe49fee2c3b67f3a9b22b775b6ed261107db823bc6c42ac445c3cd0eb7640d35cb4a9f5d6c16890ab3e96c53d9f51cb7d7007cd77aa81a96d
+  metadata.gz: 9fd79dfbb882d4f5ae8841d0f835a591a92999e89198feed4491faec884863122100a29288bedfd283fb4c2b7d38a5788130b5abb06f9f85c30022750e4cdbcb
+  data.tar.gz: 5a606567d7217078b25eed300d2436b84dfd9f3590a6fc73cc8c680b3f7981599203b5aa180b164760a412602639fcf483f55814e923e8afe027ea992ab6a4f7

data/lib/jekyll-id/patch/url_drop.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+module Jekyll
+  module Drops
+
+    class UrlDrop
+      
+      def id
+        # 'to_s' is necessary for scenarios where all ID chars are numbers
+        @obj.data['id'].to_s
+      end
+
+    end
+
+  end
+end

data/lib/jekyll-id/version.rb

@@ -2,6 +2,8 @@
 
 module Jekyll
   module ID
-    VERSION = "0.0.1"
+
+    VERSION = "0.0.2"
+
   end
 end

data/lib/jekyll-id.rb

@@ -1,10 +1,171 @@
 # frozen_string_literal: true
+require 'jekyll'
+require 'nanoid'
 
+require_relative "jekyll-id/patch/url_drop"
 require_relative "jekyll-id/version"
 
 module Jekyll
   module ID
-    class Error < StandardError; end
-    # Your code goes here...
+
+    class Generator < Jekyll::Generator
+      priority :highest
+
+      # for testing
+      attr_reader :config
+      
+      CONVERTER_CLASS = Jekyll::Converters::Markdown
+      # config
+      CONFIG_KEY = "ids"
+      ENABLED_KEY = "enabled"
+      EXCLUDE_KEY = "exclude"
+      FORMAT_KEY = "format"
+      ALPHA_KEY = "alpha"
+      SIZE_KEY = "size"
+
+      def initialize(config)
+        @config ||= config
+        @testing ||= config['testing'].nil? ? false : config['testing']
+      end
+
+      def generate(site)
+        return if disabled?
+
+        @site = site
+        @yesall = false
+        @noall = false
+
+        markdown_converter = site.find_converter_instance(CONVERTER_CLASS)
+        # filter docs based on configs
+        docs = []
+        docs += site.docs_to_write.filter { |d| !exclude?(d.type) }
+        @md_docs = docs.filter { |doc| markdown_converter.matches(doc.extname) }
+        if @md_docs.nil? || @md_docs.empty?
+          Jekyll.logger.warn("Jekyll-ID: No documents to process.")
+        end
+
+        @md_docs.each do |doc|
+          prep_id(doc)
+        end
+      end
+
+      # helpers
+
+      def prep_id(doc)
+        return if @noall
+        has_id = doc.data.keys.include?('id')
+        # 0   == is strict
+        # nil == isn't strict
+        is_strict_id = (alpha_formatted?(doc.data['id'].to_s) && size_formatted?(doc.data['id'].to_s))
+        # cases where we would want to generate a new id
+        case_1 = !has_id                   # no id exists
+        case_2 = strict? && !is_strict_id  # id isn't formatted properly
+        if (case_1 || case_2)
+          new_id = generate_id.to_s 
+          # populate missing id
+          if case_1
+            Jekyll.logger.info("\n> Generate frontmatter ID for \n> #{doc.inspect}\n>with new ID: '#{new_id}'")
+          # replace invalid format id
+          elsif case_2
+            Jekyll.logger.info("\n> Replace frontmatter ID for:\n> #{doc.inspect}\n> from:'#{doc.data['id']}'\n> to:'#{new_id}'")
+          # um...
+          else
+            Jekyll.logger.warn("Jekyll-ID: Invalid ID case")
+          end
+          resp = request if !@testing
+          if @testing || ((@yesall || resp == "yes") && !@noall)
+            write_id(doc, new_id)
+            doc.data['id'] = new_id
+          end
+        end
+      end
+
+      def generate_id
+        has_size  = (size.size != 0)
+        has_alpha = (alpha.size != 0)
+        return Nanoid.generate                              if !strict?
+        return Nanoid.generate(size: size, alphabet: alpha) if has_size && has_alpha
+        return Nanoid.generate(size: size)                  if has_size && !has_alpha
+        return Nanoid.generate(alphabet: alpha)             if !has_size && has_alpha
+      end
+
+      def request
+        if !@yesall && !@noall
+          Jekyll.logger.info("\n> Is that ok?")
+          Jekyll.logger.info("> (yes, no, yesall, or noall)")
+          cont = gets
+          if cont.strip == "yesall"
+            @yesall = true
+            Jekyll.logger.info("> Handle all IDs...")
+          elsif cont.strip == "noall"
+            @noall = true
+            Jekyll.logger.info("> Leaving all IDs alone...")
+          elsif cont.strip == "yes" 
+            Jekyll.logger.info("> Handling ID...")
+          elsif cont.strip == "no"
+            Jekyll.logger.info("> Leaving ID alone...")
+          else
+            Jekyll.logger.error("Jekyll-ID: Invalid response. Skipping...")
+          end
+          return cont.strip
+        end
+      end
+
+      def write_id(doc, id) 
+        lines = IO.readlines(doc.path)
+        lines.delete_if { |l| l.include?("id: #{doc.data['id']}") }
+        lines.insert(1, "id: #{id}\n")
+        File.open(doc.path, 'w') do |file|
+          file.puts lines
+        end
+      end
+
+      # descriptor methods
+      
+      def alpha_formatted?(id)
+        return true if !option_format(ALPHA_KEY)
+        return id.chars.all? { |char| alpha.include?(char) }
+      end
+
+      def size_formatted?(id)
+        return true if !option_format(SIZE_KEY)
+        return id.size == size
+      end
+
+      def strict?
+        return option(FORMAT_KEY) && (option_format(SIZE_KEY) || option_format(ALPHA_KEY))
+      end
+
+      # 'getters'
+
+      def alpha
+        return option_format(ALPHA_KEY).nil? ? '' : option_format(ALPHA_KEY)
+      end
+
+      def size
+        return option_format(SIZE_KEY).nil? ? '' : option_format(SIZE_KEY)
+      end
+
+      # config helpers
+
+      def disabled?
+        option(ENABLED_KEY) == false
+      end
+
+      def exclude?(type)
+        return false unless option(EXCLUDE_KEY)
+        return option(EXCLUDE_KEY).include?(type.to_s)
+      end
+
+      def option(key)
+        @config[CONFIG_KEY] && @config[CONFIG_KEY][key]
+      end
+
+      def option_format(key)
+        @config[CONFIG_KEY] && @config[CONFIG_KEY][FORMAT_KEY] && @config[CONFIG_KEY][FORMAT_KEY][key]
+      end
+
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-id
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - manunamz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: nanoid
+  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
 description:
 email:
 - manunamz@pm.me
@@ -32,10 +46,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll-id.rb
+- lib/jekyll-id/patch/url_drop.rb
 - lib/jekyll-id/version.rb
 homepage: https://github.com/manunamz/jekyll-id
 licenses:
-- MIT
+- GPL3
 metadata:
   homepage_uri: https://github.com/manunamz/jekyll-id
   source_code_uri: https://github.com/manunamz/jekyll-id
@@ -55,8 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.27
 signing_key:
 specification_version: 4
-summary: "You thought there was something in here, didn't you? \U0001F609"
+summary: Add unique ID support for jekyll (markdown) documents.
 test_files: []