jekyll-contentblocks 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5fa5ab18f418d6455911cf33dbb9ad6d8e08c52
-  data.tar.gz: 8da924d203b87c0afb2767872386287b7ad9e4a8
+SHA256:
+  metadata.gz: 9bf066a06d395aadfb1ca67328ee4bdb68bdd227799726da53acbbceafa81876
+  data.tar.gz: 585dc4dee4e35910d98f9fc756745e8608d79b7d3e52f73c9f893c3f5dd95044
 SHA512:
-  metadata.gz: 7247b7a4107c6d88be63576b06ea8dcd320c19e5b8a54509ebd3b2b1aef62bc3e5e756d1eb5269554e1e0c65d71d02bd4ff2238ad74b21a28256883808592112
-  data.tar.gz: 977e960485aabbc1f811a34561e805ea8fb4cabccab90d70258967b3d73d17e66268a595846c9f1012e1bd8b40ec5418da7bc639365b96fff43d3fb8c8e4374a
+  metadata.gz: 6640f56d91abeebc6f6c9c6ed74bfe0c250f921958fa7e0121fa2beb67d6947b64b69d719e202c4d7cd329640c9f1399dd3ae75e48937846b1b4e222b2d01dc4
+  data.tar.gz: c75c1b8e77f103916af0ff9f79b7ee25f45a20c232af2617971d0766835f1f4790c3ee457a73dc503f6c05adf4e10ccfc9839b35fb04b36f70a36cb4aec889ff

data/.github/workflows/ci.yml

@@ -0,0 +1,110 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+# One job per Ruby version, each with its own list of Jekyll versions.
+# Ruby 2.7 (Jekyll's supported minimum) runs the whole range; Ruby 3.3/3.4/4.0
+# run Jekyll 3.8+ only, since Jekyll 3.0–3.7 use APIs removed in Ruby 3
+# (URI.escape, Fixnum, positional Hash args to File.read). The generated
+# gemfiles carry no `ruby` pin, so each installs on whichever Ruby runs it.
+
+jobs:
+  # Formatting gate. The test jobs below `needs:` this, so a rubyfmt failure
+  # skips the whole matrix instead of burning runners on it.
+  rubyfmt:
+    name: rubyfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      # mise's github/ubi backends mislocate rubyfmt's oddly-nested release
+      # tarball on Linux, so install the standalone binary directly. The version
+      # is read from mise.toml, which stays the source of truth (and is what local
+      # dev uses via `mise install`). rubyfmt is self-contained — no Ruby needed.
+      - name: Install rubyfmt
+        run: |
+          version="$(grep -oE 'fables-tales/rubyfmt" = "[0-9.]+"' mise.toml | grep -oE '[0-9]+\.[0-9]+\.[0-9]+')"
+          echo "Installing rubyfmt $version"
+          curl -fsSL "https://github.com/fables-tales/rubyfmt/releases/download/v${version}/rubyfmt-v${version}-Linux-x86_64.tar.gz" \
+            | tar -xz -C "$RUNNER_TEMP"
+          echo "$RUNNER_TEMP/tmp/releases/v${version}-Linux" >> "$GITHUB_PATH"
+      - run: rubyfmt --check .
+
+  ruby-2-7:
+    name: Jekyll ${{ matrix.jekyll }} (Ruby 2.7)
+    runs-on: ubuntu-latest
+    needs: rubyfmt
+    strategy:
+      fail-fast: false
+      matrix:
+        jekyll: ['3.0.5', '3.1.6', '3.2.1', '3.3.1', '3.4.5', '3.5.2',
+                 '3.6.3', '3.7.4', '3.8.7', '3.9.5', '3.10.0',
+                 '4.0.1', '4.1.1', '4.2.2', '4.3.4', '4.4.1']
+    env:
+      BUNDLE_GEMFILE: gemfiles/jekyll_${{ matrix.jekyll }}.gemfile
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - run: bundle exec rspec
+
+  ruby-3-3:
+    name: Jekyll ${{ matrix.jekyll }} (Ruby 3.3)
+    runs-on: ubuntu-latest
+    needs: rubyfmt
+    strategy:
+      fail-fast: false
+      matrix:
+        # The Jekyll 3.8+ list is defined once here (&jekyll_3_8_plus) and reused
+        # by the Ruby 3.4 and 4.0 jobs below via the *jekyll_3_8_plus alias.
+        jekyll: &jekyll_3_8_plus ['3.8.7', '3.9.5', '3.10.0',
+                                  '4.0.1', '4.1.1', '4.2.2', '4.3.4', '4.4.1']
+    env:
+      BUNDLE_GEMFILE: gemfiles/jekyll_${{ matrix.jekyll }}.gemfile
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+      - run: bundle exec rspec
+
+  ruby-3-4:
+    name: Jekyll ${{ matrix.jekyll }} (Ruby 3.4)
+    runs-on: ubuntu-latest
+    needs: rubyfmt
+    strategy:
+      fail-fast: false
+      matrix:
+        jekyll: *jekyll_3_8_plus
+    env:
+      BUNDLE_GEMFILE: gemfiles/jekyll_${{ matrix.jekyll }}.gemfile
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - run: bundle exec rspec
+
+  ruby-4-0:
+    name: Jekyll ${{ matrix.jekyll }} (Ruby 4.0)
+    runs-on: ubuntu-latest
+    needs: rubyfmt
+    strategy:
+      fail-fast: false
+      matrix:
+        jekyll: *jekyll_3_8_plus
+    env:
+      BUNDLE_GEMFILE: gemfiles/jekyll_${{ matrix.jekyll }}.gemfile
+    steps:
+      - uses: actions/checkout@v5
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+      - run: bundle exec rspec

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
@@ -16,4 +15,5 @@ test/tmp
 test/version_tmp
 tmp
 test/_site/
+.jekyll-cache/
 gemfiles/*.lock

data/Appraisals

@@ -1,47 +1,73 @@
-appraise "jekyll-1.0.4" do
-  gem "jekyll", "1.0.4"
+# Every version runs against Ruby 2.7 in CI (Jekyll's supported minimum).
+# Jekyll 3.8+ (including 4.x) is additionally tested against Ruby 3.3, 3.4 and 4.0;
+# Jekyll 3.0–3.7 can't run on Ruby 3 (they use APIs removed in it: URI.escape,
+# Fixnum, and positional Hash args to File.read). See .github/workflows/ci.yml.
+
+appraise "jekyll-3.0.5" do
+  gem "jekyll", "3.0.5"
+end
+
+appraise "jekyll-3.1.6" do
+  gem "jekyll", "3.1.6"
+end
+
+appraise "jekyll-3.2.1" do
+  gem "jekyll", "3.2.1"
+end
+
+appraise "jekyll-3.3.1" do
+  gem "jekyll", "3.3.1"
+end
+
+appraise "jekyll-3.4.5" do
+  gem "jekyll", "3.4.5"
 end
 
-appraise "jekyll-1.1.2" do
-  gem "jekyll", "1.1.2"
+appraise "jekyll-3.5.2" do
+  gem "jekyll", "3.5.2"
 end
 
-appraise "jekyll-1.2.1" do
-  gem "jekyll", "1.2.1"
+appraise "jekyll-3.6.3" do
+  gem "jekyll", "3.6.3"
 end
 
-appraise "jekyll-1.3.1" do
-  gem "jekyll", "1.3.1"
+appraise "jekyll-3.7.4" do
+  gem "jekyll", "3.7.4"
 end
 
-appraise "jekyll-1.4.3" do
-  gem "jekyll", "1.4.3"
+appraise "jekyll-3.8.7" do
+  gem "jekyll", "3.8.7"
 end
 
-appraise "jekyll-1.5.1" do
-  gem "jekyll", "1.5.1"
+appraise "jekyll-3.9.5" do
+  gem "jekyll", "3.9.5"
+  # Jekyll 3.9+ uses kramdown 2.x, which extracted the GFM parser into its own gem
+  gem "kramdown-parser-gfm"
 end
 
-appraise "jekyll-2.0.3" do
-  gem "jekyll", "2.0.3"
+appraise "jekyll-3.10.0" do
+  gem "jekyll", "3.10.0"
+  # Jekyll 3.9+ uses kramdown 2.x, which extracted the GFM parser into its own gem
+  gem "kramdown-parser-gfm"
 end
 
-appraise "jekyll-2.1.1" do
-  gem "jekyll", "2.1.1"
+# Jekyll 4 depends on kramdown-parser-gfm itself, so it isn't listed here.
+appraise "jekyll-4.0.1" do
+  gem "jekyll", "4.0.1"
 end
 
-appraise "jekyll-2.2.0" do
-  gem "jekyll", "2.2.0"
+appraise "jekyll-4.1.1" do
+  gem "jekyll", "4.1.1"
 end
 
-appraise "jekyll-2.3.0" do
-  gem "jekyll", "2.3.0"
+appraise "jekyll-4.2.2" do
+  gem "jekyll", "4.2.2"
 end
 
-appraise "jekyll-2.4.0" do
-  gem "jekyll", "2.4.0"
+appraise "jekyll-4.3.4" do
+  gem "jekyll", "4.3.4"
 end
 
-appraise "jekyll-2.5.3" do
-  gem "jekyll", "2.5.3"
+appraise "jekyll-4.4.1" do
+  gem "jekyll", "4.4.1"
 end

data/Gemfile

@@ -1,11 +1,21 @@
 source 'https://rubygems.org'
 
-gem 'jekyll', '> 1.0.0'
-gem 'appraisal', '1.0.2'
+# No `ruby` pin here on purpose: Appraisal copies this Gemfile's directives into
+# every generated gemfiles/*.gemfile, and those run across a Ruby matrix (all
+# versions on 2.7, plus Jekyll 3.8+ on 3.3/3.4/4.0). See .github/workflows/ci.yml and Appraisals.
+gem 'jekyll', '~> 3.8.0'
+gem 'rexml'
+gem 'appraisal', '~> 2.5.0'
 
 gem 'pry'
-gem 'pry-byebug'
-gem 'rspec', '~> 3.3.0'
-gem 'nokogiri', '~> 1.6.6.0'
+gem 'rspec', '~> 3.13.0'
+gem 'nokogiri'
+
+# Declared here (not in the gemspec) so they are not forced on consumers of the
+# gem. They silence "loaded from the standard library" warnings that Jekyll's own
+# deps (safe_yaml, liquid) trigger on Ruby 3.3+, where these leave the default gems.
+gem 'base64'
+gem 'bigdecimal'
+gem 'csv'
 
 gemspec

data/README.md

@@ -1,15 +1,44 @@
 # jekyll-contentblocks
 
+[![CI](https://github.com/rustygeldmacher/jekyll-contentblocks/actions/workflows/ci.yml/badge.svg)](https://github.com/rustygeldmacher/jekyll-contentblocks/actions/workflows/ci.yml)
+
 Gives you a mechanism in Jekyll to pass content up from pages into their parent
 layouts. It's kind of like having Rails' content_for available for Jekyll.
 
 ## Installation
 
+jekyll-contentblocks supports Jekyll 3.0 and above. Jekyll 3.0–3.7 require
+Ruby 2.7 (they use APIs removed in Ruby 3), while Jekyll 3.8 and above run on
+Ruby 2.7 through 4.0. Jekyll versions below 3.0 are no longer supported.
+
+The combinations exercised in CI (Ruby across the top, Jekyll down the side):
+
+| Jekyll \ Ruby | 2.7.x | 3.3.x | 3.4.x | 4.0.x |
+| --- | :---: | :---: | :---: | :---: |
+| 3.0.x  | ✅ | ❌ | ❌ | ❌ |
+| 3.1.x  | ✅ | ❌ | ❌ | ❌ |
+| 3.2.x  | ✅ | ❌ | ❌ | ❌ |
+| 3.3.x  | ✅ | ❌ | ❌ | ❌ |
+| 3.4.x  | ✅ | ❌ | ❌ | ❌ |
+| 3.5.x  | ✅ | ❌ | ❌ | ❌ |
+| 3.6.x  | ✅ | ❌ | ❌ | ❌ |
+| 3.7.x  | ✅ | ❌ | ❌ | ❌ |
+| 3.8.x  | ✅ | ✅ | ✅ | ✅ |
+| 3.9.x  | ✅ | ✅ | ✅ | ✅ |
+| 3.10.x | ✅ | ✅ | ✅ | ✅ |
+| 4.0.x  | ✅ | ✅ | ✅ | ✅ |
+| 4.1.x  | ✅ | ✅ | ✅ | ✅ |
+| 4.2.x  | ✅ | ✅ | ✅ | ✅ |
+| 4.3.x  | ✅ | ✅ | ✅ | ✅ |
+| 4.4.x  | ✅ | ✅ | ✅ | ✅ |
+
 ### Bundler (recommended)
 
 Add this line to your Jekyll project's `Gemfile`:
 ```ruby
-gem 'jekyll-contentblocks'
+ group :jekyll_plugins do
+   gem 'jekyll-contentblocks'
+ end
 ```
 
 Then execute:
@@ -17,15 +46,8 @@ Then execute:
 $ bundle install
 ```
 
-Make sure your have a plugin that initializes Bundler:
-```ruby
-# _plugins/bundler.rb
-require "rubygems"
-require "bundler/setup"
-Bundler.require(:default)
-```
-
 ### Standalone
+
 Execute:
 ```bash
 $ gem install jekyll-contentblocks
@@ -95,27 +117,88 @@ formatting applied.
 
 ### Checking if a block has content
 
-We might want to check if the particular contentblock has content before using
-it in our template. To do this, use the `ifhascontent` tag:
+We might want to check whether a block has content before using it in our
+template. The simplest way is a plain Liquid `if` — each block name is exposed
+under `contentblocks`:
+
+```liquid
+{% if contentblocks.sidebar %}
+  {% contentblock sidebar %}
+{% else %}
+  <div>This is our default sidebar.</div>
+{% endif %}
+```
+
+`contentblocks.<name>` is truthy whenever the block was defined on the page, and
+`nil` otherwise. Unlike the tags below, it also composes with other conditions:
+
+```liquid
+{% if contentblocks.sidebar or page.force_sidebar %}
+  ...
+{% endif %}
+```
+
+The `ifhascontent` and `ifnothascontent` tags are also available:
 
 ```liquid
 {% ifhascontent javascripts %}
-  <script type="text/javascript>
-    {% contentfor javascripts %}
+  <script type="text/javascript">
+    {% contentblock javascripts %}
   </script>
 {% endifhascontent %}
 ```
 
-Similarly, there's the opposite tag, `ifnothascontent`:
+The difference is subtle: these tags test for **non-empty** content, whereas
+`{% if contentblocks.name %}` tests whether the block was *defined* at all. So a
+block that a page defines but leaves empty counts as "no content" for
+`ifhascontent`, yet is still present in `contentblocks`.
+
+### Repeating a block and reading its front matter
+
+You can use the same block name more than once on a page. Each block is
+collected into an array available in the layout at `contentblocks.<name>`,
+so you can loop over the individual blocks instead of rendering them as one
+concatenated chunk.
+
+Each block may also start with its own YAML front matter. The front matter is
+parsed into a `data` hash, and the remaining Markdown becomes `content`
+(converted just like a normal block). This lets an author write a few simple
+Markdown blocks while the layout arranges them into something richer.
+
+For example, a page with a list of testimonials:
 
 ```liquid
-{% ifnothascontent sidebar %}
-  <div>
-    This is our default sidebar.
-  </div>
-{% endifnothascontent %}
+{% contentfor testimonial %}
+---
+author: Ada Lovelace
+---
+A **delightful** plugin.
+{% endcontentfor %}
+
+{% contentfor testimonial %}
+---
+author: Alan Turing
+---
+Saved us hours of work.
+{% endcontentfor %}
+```
+
+The layout can then loop over them, reading each block's `content` and `data`:
+
+```liquid
+<ul class="testimonials">
+  {% for testimonial in contentblocks.testimonial %}
+    <li>
+      {{ testimonial.content }}
+      <cite>{{ testimonial.data.author }}</cite>
+    </li>
+  {% endfor %}
+</ul>
 ```
 
+The original `{% contentblock testimonial %}` tag still works too — it renders
+all of the blocks together.
+
 ## Contributing
 
 1. Fork it
@@ -132,5 +215,20 @@ of Jekyll. To do this, run the test suite:
 ```bash
 > bundle
 > bundle exec appraisal install
-> bundle exec appraisal rpsec
+> bundle exec appraisal rspec
 ```
+
+### Formatting
+
+Ruby code is formatted with [rubyfmt](https://github.com/fables-tales/rubyfmt),
+which is installed (along with Ruby) via [mise](https://mise.jdx.dev) from the
+versions pinned in `mise.toml`:
+
+```bash
+> mise install                     # install Ruby + the pinned rubyfmt
+> mise exec -- rubyfmt -i .         # format in place
+> mise exec -- rubyfmt --check .    # check formatting (what CI runs)
+```
+
+CI runs `rubyfmt --check` as a gate before the test matrix, so unformatted
+code fails the build early.

data/gemfiles/jekyll_3.0.5.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.0.5"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"

data/gemfiles/jekyll_3.1.6.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.1.6"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"

data/gemfiles/jekyll_3.10.0.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.10.0"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+gem "kramdown-parser-gfm"
+
+gemspec path: "../"

data/gemfiles/jekyll_3.2.1.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.2.1"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"

data/gemfiles/jekyll_3.3.1.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.3.1"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"

data/gemfiles/jekyll_3.4.5.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.4.5"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"

data/gemfiles/jekyll_3.5.2.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.5.2"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"

data/gemfiles/jekyll_3.6.3.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.6.3"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"

data/gemfiles/jekyll_3.7.4.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.7.4"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"

data/gemfiles/jekyll_3.8.7.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.8.7"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"

data/gemfiles/jekyll_3.9.5.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "3.9.5"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+gem "kramdown-parser-gfm"
+
+gemspec path: "../"

data/gemfiles/jekyll_4.0.1.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "4.0.1"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"

data/gemfiles/jekyll_4.1.1.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "4.1.1"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"

data/gemfiles/jekyll_4.2.2.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "4.2.2"
+gem "rexml"
+gem "appraisal", "~> 2.5.0"
+gem "pry"
+gem "rspec", "~> 3.13.0"
+gem "nokogiri"
+gem "base64"
+gem "bigdecimal"
+gem "csv"
+
+gemspec path: "../"