jekyll-gem-resolver 0.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df12aeb5cce9d06a8d3d9e4f30392536cc1ba0c5f6609b222c4ce99a53715c53
-  data.tar.gz: 16bda06215ce5d58c6042c29e4f0d6ba5508a4a24dcf671bee5fff5f1cab6b20
+  metadata.gz: 64ccf81805c3c9bb6e50fb51149a41918d37c9c741c7a1245cbe0ddcfd7a5625
+  data.tar.gz: 4127d03e6f25a161128e8abfd3cfdb35b180fd24d09f5773f4eb5ed0546abdc0
 SHA512:
-  metadata.gz: 7219a8da49d88d054b355739af6a448cb4684ee5561ccb4ce862e98ddc05f65fc241113282ecdb097c94b5e3d7a819b4cde3236a498b86c191a9ebba88fdfdab
-  data.tar.gz: 705f9178c7b59202aa257543513c855ac6b02cadc7b5c36b48aedb39855aa7326b66a24a5c797e1d58685b80435f885d98cd179a13b2c1df37fc50475bd5b4f8
+  metadata.gz: 31f24e0884ae7151d1bdc4583081185286259c6c76d44b7a28de550e51b98978c70d3f18670cef80c95c63012fe5f2543afb363724694b9a72a376e57db9bcc0
+  data.tar.gz: 69076a96ca6a5efd9b70842d4ae3db02ec32afc4cb9de62d0f02d25e8259921e67a57fafd326836a60319ee951e11aba83f4a0896d8f2f01ebfcaf31880f4df0

data/README.md

@@ -1,6 +1,8 @@
 # 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 to allow including resources from non-Jekyll gems into the site build.
+Simple Jekyll plugin that enables including resources from non-Jekyll gems into the site build.
 
 ### Purpose
 

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 = '0.0.3'
+    VERSION = '1.1.0'
   end
 end

data/lib/jekyll_gem_resolver.rb

@@ -1,77 +1,5 @@
-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
+require 'jekyll/gem_resolver/transformer'
 
-  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
+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: 0.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Lukas Waslowksi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-13 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,6 +75,9 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- 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
@@ -87,6 +104,7 @@ requirements: []
 rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
-summary: This plugin provides simple support for resolving paths relative to the directory
-  of specific gems.
+summary: Simple Jekyll plugin that enables including resources from non-Jekyll gems
+  (primarily, but not limited to, SASS/SCSS files and static assets) into the site
+  build.
 test_files: []