jekyll-gem-resolver 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0f73a1204ca5c056325db49d1ebec551d55edc8d276331d25bf5f03aef46615
-  data.tar.gz: cd4a9d219b18ca6908a9477703d957a825147ca28d20dba199db6375e16f1619
+  metadata.gz: cfcd692a085800c78674d3044c864a8c65a9ebb7a496a744b0e0ec22753c6293
+  data.tar.gz: 8118c58f5e4b8ffce5218e52bba1c330b203b2971f85650c4760aebf07f72811
 SHA512:
-  metadata.gz: 3866f9009290fb53aac6c39fde78af79897deb57f5ee30deaf3027a47b6b77fa7856fe38868634807ea66a1f4c43efeeae8ce76de5a344bf5b491dc59bf49114
-  data.tar.gz: 4ec3c3758a367f5060fc86f38b10c2e2b85b11ae6f18b22ac322b278caaf8431377931b9f144e41c0271807615759be36b2703800ed00c769a6694fa5128aff3
+  metadata.gz: 449d72929c3efd0d32b88d9839fb2a0e2e96fab28c58e8fc151db2d0c7a331ee18831cdb3b675037c076594c3adb6c5fa8049829024c8553bd9907bca9c1d400
+  data.tar.gz: 84e2fa62e10233514910ee9ac9dc5432f586269fa1cca93ef040f379bab460d3138e4b3856ef1457fd75f97f07725bda2b667f31e8d46d3e69f95f4dcdca8c3e

data/README.md

@@ -1,5 +1,6 @@
 # jekyll-gem-resolver
 [![Gem Version](https://badge.fury.io/rb/jekyll-gem-resolver.png)](https://badge.fury.io/rb/jekyll-gem-resolver)
+[![Continuous Integration](https://github.com/cr7pt0gr4ph7/jekyll-gem-resolver/actions/workflows/ci.yml/badge.svg)](https://github.com/cr7pt0gr4ph7/jekyll-gem-resolver/actions/workflows/ci.yml)
 
 Simple Jekyll plugin that enables including resources from non-Jekyll gems into the site build.
 
@@ -12,7 +13,7 @@ When enabled, the plugin scans certain, configurable parts of your `_config.yml`
 The origin of this plugin is that I wanted to build [Bootstrap][bootstrap-website]
 from source using Jekyll's SASS processor and the [boostrap gem][bootstrap-rubygem]. But there is no easy way to reference the external files of the `bootstrap` gem
 in your `_config.yml`, except for using absolute paths, which feels unsatisfying for a number of reasons.
-This plugin was born to resolve this problem.
+This plugin was born to resolve this problem, as described in [this blog post](https://blog.taktgeber.it/2024/02/13/jekyll-gem-resolver#how-to-build-bootstrap-from-source-using-jekyll).
 
 ## Installation
 

data/lib/jekyll/gem_resolver/parser.rb

@@ -0,0 +1,28 @@
+module Jekyll
+  module GemResolver
+    class PackageReference
+      attr_reader :type, :name, :relative_path
+
+      def initialize(package_type, package_name, relative_path)
+        @type = package_type
+        @name = package_name
+        @relative_path = relative_path
+      end
+    end
+
+    class PackageReferenceParser
+      def try_parse(value)
+        return nil unless value.is_a? String
+
+        if /^gem:(?<gem_name>[^:]+):(?<relative_path>.*)/ =~ value
+          PackageReference.new('gem', gem_name, "/#{relative_path}")
+        elsif /^gem:(?<gem_name>[^\/:]+)(?<relative_path>.*)/ =~ value
+          PackageReference.new('gem', gem_name, relative_path)
+        else
+          nil
+        end
+      end
+
+    end
+  end
+end

data/lib/jekyll/gem_resolver/resolver.rb

@@ -0,0 +1,23 @@
+require 'jekyll'
+
+module Jekyll
+  module GemResolver
+    class PackageReferenceResolver
+      def resolve_reference(pkg)
+        case pkg.type
+        when 'gem'
+          resolve_gem(pkg.name, pkg.relative_path)
+        else
+          Jekyll.logger.error("Unsupported package reference type #{package_type.inspect}")
+        end
+      end
+
+      private
+
+      def resolve_gem(gem_name, relative_path)
+        spec = Gem::Specification.find_by_name(gem_name)
+        spec.gem_dir + relative_path
+      end
+    end
+  end
+end

data/lib/jekyll/gem_resolver/transformer.rb

@@ -0,0 +1,83 @@
+require 'jekyll'
+require 'jekyll/gem_resolver/parser'
+require 'jekyll/gem_resolver/resolver'
+
+module Jekyll
+  module GemResolver
+    class ConfigTransformer
+      def initialize(parser = nil, resolver = nil)
+        @parser = parser || Jekyll::GemResolver::PackageReferenceParser.new()
+        @resolver = resolver || Jekyll::GemResolver::PackageReferenceResolver.new()
+      end
+
+      def transform_site_config(site)
+        transform_yaml(site.config)
+      end
+
+      def transform_yaml(config)
+        options = config['gem_resolver'] || {}
+        (options['transform'] || []).each { |path_to_transform| transform_config_node(config, path_to_transform.split('.')) }
+        config
+      end
+
+      private
+
+      def transform_config_node(node, path, use_fallbacks = true)
+        # Have we arrived at the last segment of the path?
+        if path.nil? || path.empty?
+          # Special behavior: If this node is an array, behave as if path contains an additional '.*'
+          return transform_config_node(node, ['*'], false) if node.is_a?(Array) && use_fallbacks
+
+          # Not an array: Directly process this node
+          return transform_config_value(node)
+        end
+
+        # The path has at least one remaining segment
+        key = strip_brackets(path[0])
+        remaining_path = path[1..-1]
+
+        if node.is_a? Array
+          if key == '*'
+            # Transform each value in this array recursively
+            node.map! { |value| transform_config_node(value, remaining_path)  }
+          else
+            # Recurse into the specified array item
+            index = Integer(key)
+            node[index] = transform_config_node(node[index], remaining_path)
+          end
+        elsif node.is_a? Hash
+          if key == '*'
+            # Transform each value in this hash recursively
+            node.transform_values! { |value| transform_config_node(value, remaining_path)  }
+          else
+            # Recurse into the specified hash value
+            node[key] = transform_config_node(node[key], remaining_path)
+          end
+        else
+          # The path has remaining segments, but this is a leaf node.
+          # This means that the specified path does not match, and we therefore
+          # do not modify or transform this node.
+        end
+
+        return node
+      end
+
+      def strip_brackets(text)
+          return text unless text
+          return text.gsub(/^\[(.+)\]$/, '\1')
+      end
+
+      def transform_config_value(value)
+        return value unless value.is_a? String # Not a package reference, ignore
+
+        package_ref = @parser.try_parse(value)
+        return value if package_ref.nil? # Not a package reference, ignore
+
+        result = @resolver.resolve(package_ref)
+        Jekyll.logger.error("Failed to resolve package reference #{value}") if result.nil?
+        Jekyll.logger.info("Resolved #{value} to #{result}") unless result.nil?
+        result
+      end
+    end
+  end
+end

data/lib/jekyll/gem_resolver/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module GemResolver
-    VERSION = '1.0.0'
+    VERSION = '1.1.1'
   end
 end

data/lib/jekyll-gem-resolver.rb

@@ -0,0 +1,5 @@
+require 'jekyll/gem_resolver/transformer'
+
+Jekyll::Hooks.register :site, :after_init do |site|
+  Jekyll::GemResolver::ConfigTransformer.new().transform_site_config(site)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-gem-resolver
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Lukas Waslowksi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 2024-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gem resolver plugin for Jekyll
 email:
 - cr7pt0gr4ph7@gmail.com
@@ -61,8 +75,11 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/jekyll-gem-resolver.rb
+- lib/jekyll/gem_resolver/parser.rb
+- lib/jekyll/gem_resolver/resolver.rb
+- lib/jekyll/gem_resolver/transformer.rb
 - lib/jekyll/gem_resolver/version.rb
-- lib/jekyll_gem_resolver.rb
 homepage: https://github.com/cr7pt0gr4ph7/jekyll-gem-resolver
 licenses:
 - MIT

data/lib/jekyll_gem_resolver.rb

@@ -1,77 +0,0 @@
-module JekyllGemResolver
-  def self.transform_config(site)
-    options = site.config['gem_resolver'] || {}
-    (options['transform'] || []).each { |path_to_transform| transform_config_node(site.config, path_to_transform.split('.')) }
-  end
-
-  private
-
-  def self.transform_config_node(node, path, use_fallbacks = true)
-    # Have we arrived at the last segment of the path?
-    if path.nil? || path.empty?
-      # Special behavior: If this node is an array, behave as if path contains an additional '.*'
-      return transform_config_node(node, ['*'], false) if node.is_a?(Array) && use_fallbacks
-
-      # Not an array: Directly process this node
-      return transform_config_value(node)
-    end
-
-    # The path has at least one remaining segment
-    key = strip_brackets(path[0])
-    remaining_path = path[1..-1]
-
-    if node.is_a? Array
-      if key == '*'
-        # Transform each value in this array recursively
-        node.map! { |value| transform_config_node(value, remaining_path)  }
-      else
-        # Recurse into the specified array item
-        index = Integer(key)
-        node[index] = transform_config_node(node[index], remaining_path)
-      end
-    elsif node.is_a? Hash
-      if key == '*'
-        # Transform each value in this hash recursively
-        node.transform_values! { |value| transform_config_node(value, remaining_path)  }
-      else
-        # Recurse into the specified hash value
-        node[key] = transform_config_node(node[key], remaining_path)
-      end
-    else
-      # The path has remaining segments, but this is a leaf node.
-      # This means that the specified path does not match, and we therefore
-      # do not modify or transform this node.
-    end
-
-    return node
-  end
-
-  def self.strip_brackets(text)
-      return text unless text
-      return text.gsub(/^\[(.+)\]$/, '\1')
-  end
-
-  def self.transform_config_value(value)
-    return value unless value.is_a? String
-
-    result = if /^gem:(?<gem_name>[^:]+):(?<relative_path>.*)/ =~ value
-      resolve_gem(gem_name, "/#{relative_path}")
-    elsif /^gem:(?<gem_name>[^\/]+)(?<relative_path>.*)/ =~ value
-      resolve_gem(gem_name, relative_path)
-    else
-      nil
-    end
-
-    Jekyll.logger.info("Resolved #{value} to #{result}") unless result.nil?
-    result
-  end
-
-  def self.resolve_gem(gem_name, relative_path)
-    spec = Gem::Specification.find_by_name(gem_name)
-    spec.gem_dir + relative_path
-  end
-
-  Jekyll::Hooks.register :site, :after_init do |site|
-    transform_config(site)
-  end
-end