jekyll-render-order 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36343d52dbb6f301baf05b68573c70f6cd74061ea9580ff74a661b6179bc2c3b
+  data.tar.gz: 2709c31f0db24251d8d9cf523821703bac611936c52f3f99e5549fb419923c22
+SHA512:
+  metadata.gz: 6016bfb9d8712bfe8fd4d09c782ab85130bc863a7dbfd19c50abe91fbd0d10bb4fd7a186593da7af32932991133aab44627939c8d3e866dcfd41ecb91594f18b
+  data.tar.gz: c2832e82f2d1f9d7ad5810b6012e8a3577a134748488f2c3ea15a872c8614397fb9b1aa1dd7326e6241d5210c5b835ba306d3b75df1a11a12466eb6916d79012

data/lib/jekyll-render-order.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "jekyll-render-order/sort"
+require_relative "jekyll-render-order/version"
+
+Jekyll::Hooks.register :site, :pre_render do |site, payload|
+	Jekyll::RenderOrder::sort(site)
+end

data/lib/jekyll-render-order/sort.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Jekyll
+	module RenderOrder
+		DEFAULT_ORDER = [
+			'assets/**/*.{css,sass,scss}',
+			'assets/**/*.js',
+			'*.{css,sass,scss}',
+			'*.js',
+		].freeze()
+
+		def self.sort(site)
+			render_order = site.config['render_order'] || DEFAULT_ORDER
+
+			site.pages.sort! { |a, b|
+				a_idx = render_order.index { |x| File.fnmatch?(x, a.path, File::FNM_EXTGLOB) }
+				b_idx = render_order.index { |x| File.fnmatch?(x, b.path, File::FNM_EXTGLOB) }
+
+				if not a_idx.nil? then
+					if b_idx.nil? then
+						-1
+					elsif a_idx != b_idx then
+						a_idx - b_idx
+					else
+						a.path.casecmp(b.path)
+					end
+				elsif not b_idx.nil? then
+					+1
+				else
+					a.path.casecmp(b.path)
+				end
+			}
+		end
+	end
+end

data/lib/jekyll-render-order/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+	module RenderOrder
+		VERSION = '1.0.0'
+	end
+end

data/test/test_sort.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'jekyll/site'
+require 'jekyll-render-order/sort'
+
+class SortTest < Minitest::Test
+	def test_default
+		order = nil
+
+		correct = [
+			# First CSS in assets
+			'assets/first/b.scss',
+			'assets/second/a.css',
+			# Then JS files in assets
+			'assets/first/a.js',
+			'assets/second/b.js',
+			# CSS files elsewhere
+			'page/style.scss',
+			# JS files elsewhere
+			'first.js',
+			'page/script.js',
+			'second.js',
+			# Unmatched
+			'index.md',
+		]
+
+		test_sort(order, correct)
+	end
+
+	def test_first
+		order = [
+			# Assets in first first
+			'assets/first/*',
+			# Then assets in second
+			'assets/second/*',
+		]
+		
+		correct = [
+			'assets/first/a.js',
+			'assets/first/b.css',
+
+			'assets/second/a.css',
+			'assets/second/b.js',
+
+			'first.js',
+			'index.md',
+			'page/script.js',
+			'page/style.css',
+			'second.js',
+		]
+
+		test_sort(order, correct)
+	end
+
+	def test_js_first
+		order = [
+			# JS first
+			'*.js',
+		]
+		
+		correct = [
+			'assets/first/a.js',
+			'assets/second/b.js',
+			'first.js',
+			'page/script.js',
+			'second.js',
+
+			'assets/first/b.css',
+			'assets/second/a.css',
+			'index.md',
+			'page/style.css',
+		]
+
+		test_sort(order, correct)
+	end
+
+	private
+
+	def test_sort(order, correct)
+		config = {
+			'render_order' => order
+		}
+
+		page_mocks = correct.sort().map { |x| PageMock.new(x) }
+		site = SiteMock.new(config, page_mocks)
+
+		Jekyll::RenderOrder::sort(site)
+
+		calculated = site.pages.map { |x| x.path }
+		assert_equal(correct, calculated)
+	end
+
+	class SiteMock
+		attr_reader :config, :pages
+
+		def initialize(config, pages)
+			@config = config
+			@pages = pages
+		end
+	end
+
+	class PageMock
+		attr_reader :path
+
+		def initialize(path)
+			@path = path
+		end
+	end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-render-order
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marcos Del Sol Vives
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: This plugin allows customization of the order in which Jekyll pages are
+  rendered. Ideal to ensure assets are generated before main files.
+email:
+- marcos@orca.pet
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-render-order.rb
+- lib/jekyll-render-order/sort.rb
+- lib/jekyll-render-order/version.rb
+- test/test_sort.rb
+homepage: https://github.com/socram8888/jekyll-render-order
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Customizes Jekyll page rendering order.
+test_files:
+- test/test_sort.rb