jekyll_dynamic_assets 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce45ad23c704195b61891db09c7f3d5e49c8152d5203d3ef1fb777eb82fa5c64
-  data.tar.gz: acdc459add9164deac556f9a018ae473f9393a1c93a1c42176f9a8c783210079
+  metadata.gz: 8f4102ebcc09a9c91ad535a06179560476217a410d75511df6fd78762b2227c5
+  data.tar.gz: 1255d4fc1b4de77e09c30d9d388fa7f0dd6f75c0ba65a1ef3c35ecc3314cbf75
 SHA512:
-  metadata.gz: 61e538c18026d13670756d41339abf91e41665e726ecf35f4a5aa9eff9f611febe9d3db84cb3686942bc414e23608d4baadc66fd84ef9445ab9439d2802301ba
-  data.tar.gz: e83ebbe0089fc6b435d40e40d7512e5ee3836f511d4765333b1282ff94651ccb11bd776c72e674707d700f80ebdd758504f213f02d52caea7a268ae417a725fb
+  metadata.gz: 5543ce35aeb57e5aa44624e89dbb2393863fd1b80e3d1d1ac1394dd6463cc428f6756b4f416d447c629797f92d00b4d37128feb2eec0ca2ced1aa3ebab69f8b3
+  data.tar.gz: 3586a4f15eaabc0acdfbffe6e8080069f809f6f64ad5c71e2f56a801b3a352d85b9db6d62f44fee3015c1351d6aad6b85d975a7909430e31a7303b855379774d

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 3.2
+  SuggestExtensions: false
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -17,4 +18,7 @@ Lint/ScriptPermission:
   Enabled: false
 
 Layout/EndOfLine:
+  Enabled: false
+
+Metrics/ClassLength:
   Enabled: false

data/CHANGELOG.md

@@ -23,4 +23,25 @@
   - woff2
   - ttf
   - otf
-- Added Source selection
+- Added Source selection
+
+## [1.2.0] - 2025-06-06
+
+- Added option to select formats
+
+## [1.3.0] - 2025-06-07
+
+- Added Sub directory options
+- Added Default Sub directories for
+  - css   >> styles
+  - js    >> scripts
+  - mjs   >> scripts
+  - ts    >> scripts
+  - json  >> data
+  - ico   >> icons
+  - woff  >> fonts
+  - woff2 >> fonts
+  - ttf   >> fonts
+  - otf   >> fonts
+- Updated Selection logic, added inline definition
+- Added Absolute URL

data/README.md

@@ -1,13 +1,16 @@
 # JekyllDynamicAssets
 
-JekyllDynamicAssets is a Jekyll plugin that allows you to dynamically manage and inject CSS, JS, and other head assets into your site using presets, per-page configuration, and flexible formatting.
+JekyllDynamicAssets is a powerful Jekyll plugin for dynamic, flexible, and DRY asset management. It lets you define, group, and inject CSS, JS, and other head assets using presets, per-page config, and custom formatting.
 
 ## Features
 - Define global (master) assets and per-page assets
 - Use asset presets for reusable asset groups
-- Pre-defined default formats for common assets, can be overwritten
+- Pre-defined and overrideable formats and sources for common assets
+- Auto, Select, and Inline formats and sources
 - Liquid tag `{% assets %}` for easy asset injection in templates and includes
-- Error reporting for missing presets
+- Error reporting for missing presets and formats
+- Absolute/relative URL support
+- Supports all head assets: CSS, JS, module JS, fonts, icons, JSON, etc.
 
 ## Installation
 
@@ -33,55 +36,96 @@ plugins:
 
 Finally, in your terminal run:
 
-```bash
+```powershell
 bundle install
 ```
 
 ## Usage
 
-1. **Configure your assets in `config.yml`:**
+### 1. Configure your assets in `config.yml`
 
 ```yaml
 assets:
-  master: # Master assets
+  master:
     - main.css
     - main.js
-  source: "/assets/" # Optional: base path for all assets
-  formats:
-    js:  "<script defer src='%s'></script>" # Overwrite defaults
-    xyz: "<custom> %s </custom>"  # Define Custom formats
-  presets:  # Create presets to include multiple assets
+
+  source:
+    base: /assets
+    github: https://github.com/assets/
+    css: /css
+    js: /js
+  absolute: true # Use absolute URLs (uses `url` and `baseurl` from config)
+
+  presets:
     blog: [blog.css, blog.js]
     project: [project.css, project.js, code-highlight.css, slideshow.js, myApp.js]
+
+  formats:
+    js:  <script defer src='%s'></script>
+    xyz: <custom> %s </custom>
+    screen-css: <link rel="stylesheet" href="%s" media="screen">
+```
+
+If all your assets are in the same folder, you can simply do:
+
+```yaml
+assets:
+  source: /asset_folder
 ```
 
-2. **Per-page or per-collection configuration:**
+**Path rules:** Always use a leading slash, never a trailing slash.
+
+### 2. Per-page or per-collection configuration
 
 In your page or post front matter:
 
 ```yaml
 assets:
-  files:
-    - manual.css # include singular files
+  files:  # See Asset Definition Syntax below
+    - manual.css
+    - onscreen.css::screen-css
+    - no_script.css:::<noscript><link rel="stylesheet" href="%s"></noscript>
+    - github<<master.css
+    - /css/new<<<new-main.css
   presets:
-    - blog  # Use a preset
+    - blog
+    - project
 ```
 
-3. **Inject assets in your templates:**
+### 3. Inject assets in your templates
 
 Use the Liquid tag where you want the assets to appear (typically in your `<head>`):
 
 ```liquid
 <head>
   <!-- other tags like meta etc. -->
-
   {% assets %}
 </head>
 ```
 
 This will output the appropriate HTML tags for all configured assets. The tag should generally be used inside your `<head>` tag but can be used anywhere else.
 
-For assets which you haven't defined any format and there isn't any default for it either, the code will simply write the name of that asset.
+---
+
+### Asset Definition Syntax
+
+You can use the following syntax anywhere (config or front matter):
+
+```
+Source<<Asset::Format
+```
+
+- `<<` uses `Source` as a variable from config; `<<<` uses `Source` as a literal.
+- `::` uses `Format` as a variable from config; `:::` uses `Format` as a literal.
+- If either is not defined, source/format is taken from config using the file extension.
+- If the source is not external, it will be determined using `base + Source`.
+
+**NOTE:**
+- If JDA can't find a source, it will use the `base` without sub-directories.
+- If JDA can't find the format, it will raise an error. A format is required for each asset.
+
+---
 
 ## Contributing
 

data/lib/jekyll_dynamic_assets/defaults/sources.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module JekyllDynamicAssets
+  DEFAULT_SOURCES = {
+    "base" => "/assets",
+    "css" => "/styles",
+    "js" => "/scripts",
+    "mjs" => "/scripts",
+    "ts" => "/scripts",
+    "json" => "/data",
+    "ico" => "/icons",
+    "woff" => "/fonts",
+    "woff2" => "/fonts",
+    "ttf" => "/fonts",
+    "otf" => "/fonts"
+  }.freeze
+end

data/lib/jekyll_dynamic_assets/processor.rb

@@ -7,49 +7,111 @@ module JekyllDynamicAssets
       @config = site.config["assets"] || {}
       @page = page
       @page_config = page["assets"] || {}
+      @path = @page["path"] || @page["relative_path"] || "unknown"
+
+      sub_configs(site:)
     end
 
+    # Get all link tags to assets for this page
     def assets
       all_assets = combined_assets
       asset_insertions = []
-      all_assets.each do |asset|
-        extension = asset.split(".").last
-        asset_link = format_string(extension) % asset
-        asset_insertions << asset_link
+      all_assets.each do |dir, asset, format_string|
+        directory = dir.start_with?("http") ? dir : prepare_dir(dir)
+        asset_link = directory + asset
+        asset_insertions << format_string % asset_link
       end
       asset_insertions
     end
 
     private
 
-    def format_string(extension)
-      formats ||= formats_merge(DEFAULT_FORMATS, @config["formats"])
-      formats[extension] || "%s"
+    def sub_configs(site:)
+      @link_formats ||= setting_merge(DEFAULT_FORMATS, @config["formats"]) # Format Config
+
+      # Standardize Source Config
+      srcs ||= setting_merge(DEFAULT_SOURCES, @config["source"])
+      @asset_sources = if srcs.is_a?(String)
+                         {
+                           "base" => srcs
+                         }.freeze
+                       else
+                         srcs
+                       end
+
+      # Get URL for absolute_url filter
+      return unless @config["absolute"] == true
+
+      @url = (site.config["url"] || "") + (site.config["baseurl"] || "")
+    end
+
+    def setting_merge(default, custom)
+      if custom.nil?
+        default
+      elsif custom.is_a?(String)
+        custom
+      else
+        custom.merge default do |_key, custom_setting, default_setting|
+          custom_setting unless default_setting.respond_to? :merge
+        end
+      end
+    end
+
+    def prepare_dir(dir)
+      # Format URL assuming standard inputs, all leading slashes and no trailing
+      directory = @config["absolute"] ? @url : ""
+      directory += @asset_sources["base"] unless @asset_sources["base"] == ""
+      directory += dir unless dir.empty? || dir == ""
+      directory += "/"
+      directory
     end
 
-    def formats_merge(default, custom)
-      custom.merge default do |_key, custom_setting, default_setting|
-        custom_setting unless default_setting.respond_to? :merge
+    def get_sub_dir(string)
+      return string.split("<<<").first if string.include?("<<<")
+
+      hash = string.include?("<<") ? string.split("<<").first : string.split(".").last
+
+      @asset_sources.fetch(hash) do
+        warn "DynamicAssets: No source defined for #{hash.inspect} in #{@path} - using base source"
+        ""
+      end
+    end
+
+    def get_format(string)
+      return string.split(":::").last if string.include?(":::")
+
+      hash = string.include?("::") ? string.split("::").last : string.split(".").last
+
+      @link_formats.fetch(hash) do
+        raise KeyError, "DynamicAssets: No #{hash.inspect} format defined"
       end
     end
 
     def combined_assets
       # Container
+      raw_assets = []
       assets = []
 
       # Add assets
-      assets.concat(Array(@config["master"]))
-      assets.concat(Array(preset_files))
-      assets.concat(Array(@page_config["files"]))
+      raw_assets.concat(Array(@config["master"]))
+      raw_assets.concat(Array(preset_files))
+      raw_assets.concat(Array(@page_config["files"]))
 
-      append_base(assets.uniq)
+      raw_assets.uniq.each do |asset|
+        assets << asset_array(asset)
+      end
+      assets
     end
 
-    def append_base(assets)
-      base = @config["source"].to_s
-      base += "/" unless base.end_with?("/") || base.empty?
+    def asset_array(asset)
+      buff = Array.new(3)
+      buff[2] = get_format(asset)         # Store Format
+      asset = asset.split(/:{2,}/).first  # Remove Format selector
+      buff[0] = get_sub_dir(asset)        # Store Source
+      asset = asset.split(/<{2,}/).last   # Remove Source selector
+      buff[1] = asset                     # Store Asset path
 
-      assets.map { |asset| asset.start_with?("http") ? asset : base + asset }
+      buff
     end
 
     def preset_files
@@ -58,6 +120,7 @@ module JekyllDynamicAssets
       bad_presets = []
       selected_presets = Array(@page_config["presets"])
       preset_map = @config["presets"] || {}
+
       selected_presets.each do |preset|
         if preset_map.key?(preset)
           preset_assets.concat(Array(preset_map[preset]))
@@ -65,17 +128,18 @@ module JekyllDynamicAssets
           bad_presets << preset
         end
       end
-      remaining?(bad_presets) # Raise error for undefined errors
+
+      remaining_presets?(bad_presets) # Raise error for undefined errors
       preset_assets
     end
 
-    def remaining?(remaining_presets)
-      # Display the undefined presets
+    def remaining_presets?(remaining_presets)
+      # return if no undefined presets
       return if remaining_presets.empty?
 
-      location = @page["path"] || @page["relative_path"] || "unknown"
+      # Raise error for all undefined presets
       missing_list = remaining_presets.to_a.join(", ")
-      raise "DynamicAssets: No preset(s) defined: #{missing_list} at: #{location}"
+      raise KeyError, "DynamicAssets: No preset(s) defined: #{missing_list}"
     end
   end
 end

data/lib/jekyll_dynamic_assets/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllDynamicAssets
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

data/lib/jekyll_dynamic_assets.rb

@@ -4,6 +4,7 @@ require_relative "jekyll_dynamic_assets/version"
 require_relative "jekyll_dynamic_assets/processor"
 require_relative "jekyll_dynamic_assets/assets_tag"
 require_relative "jekyll_dynamic_assets/defaults/formats"
+require_relative "jekyll_dynamic_assets/defaults/sources"
 
 module JekyllDynamicAssets
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_dynamic_assets
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - M. Umar Shahbaz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-06 00:00:00.000000000 Z
+date: 2025-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -67,6 +67,7 @@ files:
 - lib/jekyll_dynamic_assets.rb
 - lib/jekyll_dynamic_assets/assets_tag.rb
 - lib/jekyll_dynamic_assets/defaults/formats.rb
+- lib/jekyll_dynamic_assets/defaults/sources.rb
 - lib/jekyll_dynamic_assets/processor.rb
 - lib/jekyll_dynamic_assets/version.rb
 - sig/jekyll_dynamic_assets.rbs