jekyll-contentblocks 1.1.0 → 2.0.0

data/gemfiles/jekyll_4.3.4.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "4.3.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_4.4.1.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "4.4.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/jekyll-contentblocks.gemspec

@@ -11,11 +11,16 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Provides a mechanism for passing content up to the layout, like Rails' content_for}
   gem.summary       = %q{A Jekyll plugin kind of like Rails' content_for}
   gem.homepage      = "https://github.com/rustygeldmacher/jekyll-contentblocks"
+  gem.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files`.split($/) - ["Gemfile.lock"]
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency('jekyll')
+  # Jekyll 3.0–3.7 rely on APIs removed in Ruby 3, so 2.7 is the effective floor.
+  gem.required_ruby_version = ">= 2.7.0"
+
+  # Supports the Jekyll 3.x and 4.x series; excludes the announced-breaking 5.x.
+  gem.add_dependency('jekyll', '>= 3.0', '< 5.0')
 end

data/lib/jekyll/content_blocks/content_block_tag.rb

@@ -7,7 +7,7 @@ module Jekyll
       def initialize(tag_name, markup, tokens)
         super
         parse_options(markup)
-        if content_block_name == ''
+        if content_block_name == ""
           raise SyntaxError.new("No block name given in #{tag_name} tag")
         end
       end
@@ -15,20 +15,47 @@ module Jekyll
       private
 
       def parse_options(markup)
-        options = (markup || '').split(' ').map(&:strip)
+        options = (markup || "").split(" ").map(&:strip)
         self.content_block_name = options.shift
         self.content_block_options = options
       end
 
       def block_has_content?(context)
-        block_content = content_for_block(context).join
-        !(block_content.nil? || block_content.empty?)
+        !raw_block_content(context).empty?
       end
 
+      # Write accessor for the contentfor tag: returns the block's array, creating
+      # it if needed. Each stored block is a hash: "raw" (the block body), "content"
+      # (that body converted) and "data" (its own front matter). The store is
+      # exposed to layouts as contentblocks.<name> so they can be looped over.
       def content_for_block(context)
-        environment = context.environments.first
-        environment['contentblocks'] ||= {}
-        environment['contentblocks'][content_block_name] ||= []
+        store = (context.environments.first["contentblocks"] ||= {})
+        store[content_block_name] ||= []
+      end
+
+      # Read-only view — does NOT create an empty entry. Reading a never-defined
+      # block therefore leaves contentblocks.<name> nil (falsy) rather than an
+      # empty array (which Liquid would treat as truthy).
+      def blocks_for(context)
+        (context.environments.first["contentblocks"] || {})[content_block_name] || []
+      end
+
+      def raw_block_content(context)
+        blocks_for(context).map { |block| block["raw"] }.join
+      end
+
+      # Convert content with the document's converters, derived from the render
+      # context (so we don't depend on the pre-render hook stashing them).
+      def converted_content(content, context)
+        Array(converters_for(context)).reduce(content) do |result, converter|
+          converter.convert(result)
+        end
+      end
+
+      def converters_for(context)
+        site = context.registers[:site]
+        extension = File.extname(context.registers[:page]["path"].to_s)
+        site.converters.select { |converter| converter.matches(extension) }
       end
     end
   end

data/lib/jekyll/content_blocks/pre_render_hook.rb

@@ -0,0 +1,11 @@
+module Jekyll
+  module ContentBlocks
+    class PreRenderHook
+      def self.call(document, payload)
+        # Reset the per-document block store. Converters are derived on demand by
+        # the contentblock tag from the render context, so they aren't stashed here.
+        payload["contentblocks"] = {}
+      end
+    end
+  end
+end

data/lib/jekyll/content_blocks/version.rb

@@ -1,6 +1,5 @@
 module Jekyll
   module ContentBlocks
-    VERSION = "1.1.0"
+    VERSION = "2.0.0"
   end
 end
-

data/lib/jekyll/tags/content_block.rb

@@ -4,7 +4,7 @@ module Jekyll
       include ::Jekyll::ContentBlocks::ContentBlockTag
 
       def render(context)
-        block_content = content_for_block(context).join
+        block_content = raw_block_content(context)
         if convert_content?
           converted_content(block_content, context)
         else
@@ -15,14 +15,7 @@ module Jekyll
       private
 
       def convert_content?
-        !content_block_options.include?('no-convert')
-      end
-
-      def converted_content(block_content, context)
-        converters = context.environments.first['converters']
-        Array(converters).reduce(block_content) do |content, converter|
-          converter.convert(content)
-        end
+        !content_block_options.include?("no-convert")
       end
     end
   end

data/lib/jekyll/tags/content_for.rb

@@ -5,10 +5,25 @@ module Jekyll
       alias_method :render_block, :render
 
       def render(context)
-        content_for_block(context) << render_block(context)
-        ''
+        data, body = split_front_matter(render_block(context))
+        content_for_block(context) <<
+          {
+            "raw" => body,
+            "content" => converted_content(body, context),
+            "data" => data
+          }
+        ""
+      end
+
+      private
+
+      def split_front_matter(rendered)
+        if rendered.lstrip =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
+          [SafeYAML.load(Regexp.last_match(1)) || {}, $POSTMATCH]
+        else
+          [{}, rendered]
+        end
       end
     end
   end
 end
-

data/lib/jekyll-contentblocks.rb

@@ -1,28 +1,21 @@
-require 'jekyll'
+require "jekyll"
 
-module Jekyll
-  def self.version_less_than?(version)
-    Gem::Version.new(VERSION) < Gem::Version.new(version)
-  end
+require "jekyll/content_blocks/pre_render_hook"
 
-  def self.supports_collections?
-    !version_less_than?('2.0.0')
+[:documents, :pages, :posts].each do |content_type|
+  Jekyll::Hooks.register(content_type, :pre_render) do |doc, payload|
+    Jekyll::ContentBlocks::PreRenderHook.call(doc, payload)
   end
 end
 
-require 'jekyll/content_blocks/convertible'
-unless Jekyll.version_less_than?('2.0.0')
-  require 'jekyll/content_blocks/renderer'
-end
-
-require 'jekyll/content_blocks/version'
-require 'jekyll/content_blocks/content_block_tag'
-require 'jekyll/tags/content_for'
-require 'jekyll/tags/if_has_content'
-require 'jekyll/tags/if_not_has_content'
-require 'jekyll/tags/content_block'
+require "jekyll/content_blocks/version"
+require "jekyll/content_blocks/content_block_tag"
+require "jekyll/tags/content_for"
+require "jekyll/tags/if_has_content"
+require "jekyll/tags/if_not_has_content"
+require "jekyll/tags/content_block"
 
-Liquid::Template.register_tag('contentfor', Jekyll::Tags::ContentFor)
-Liquid::Template.register_tag('ifhascontent', Jekyll::Tags::IfHasContent)
-Liquid::Template.register_tag('ifnothascontent', Jekyll::Tags::IfNotHasContent)
-Liquid::Template.register_tag('contentblock', Jekyll::Tags::ContentBlock)
+Liquid::Template.register_tag("contentfor", Jekyll::Tags::ContentFor)
+Liquid::Template.register_tag("ifhascontent", Jekyll::Tags::IfHasContent)
+Liquid::Template.register_tag("ifnothascontent", Jekyll::Tags::IfNotHasContent)
+Liquid::Template.register_tag("contentblock", Jekyll::Tags::ContentBlock)

data/mise.toml

@@ -0,0 +1,5 @@
+[tools]
+ruby = "3.3"
+# rubyfmt isn't in the mise registry, so install it from its GitHub releases
+# via the github backend (github.com/fables-tales/rubyfmt).
+"github:fables-tales/rubyfmt" = "0.14.1"

data/spec/jekyll_content_blocks_spec.rb

@@ -1,95 +1,155 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Jekyll::ContentBlocks do
-  puts "jekyll #{jekyll_version}"
+  puts("jekyll #{jekyll_version}")
 
-  context "against jekyll #{jekyll_version}" do
+  context("against jekyll #{jekyll_version}") do
     before(:all) do
-      expect(generate_test_site).to be true
+      expect(generate_test_site).to(be(true))
     end
 
-    let(:index) { load_html('index.html') }
+    let(:index) { load_html("index.html") }
 
-    describe 'index.html' do
-      let(:sidebar) { index.css('body > div > h2#sidebar').first }
+    describe "index.html" do
+      let(:sidebar) { index.css("body > div > h2#sidebar").first }
 
-      it 'does not render the css block' do
-        expect(index.css('style')).to be_empty
+      it "does not render the css block" do
+        expect(index.css("style")).to(be_empty)
       end
 
-      it 'renders the custom sidebar' do
-        expect(index.css('div.custom-sidebar')).not_to be_empty
-        expect(index.css('div.sidebar-default')).to be_empty
+      it "renders the custom sidebar" do
+        expect(index.css("div.custom-sidebar")).not_to(be_empty)
+        expect(index.css("div.sidebar-default")).to(be_empty)
       end
 
-      it 'renders the sidebar content block' do
-        expect(sidebar).not_to be_nil
-        expect(sidebar.text).to eq 'SIDEBAR'
+      it "renders the sidebar content block" do
+        expect(sidebar).not_to(be_nil)
+        expect(sidebar.text).to(eq("SIDEBAR"))
       end
 
-      it 'renders Liquid within a content block' do
-        rendered_liquid = sidebar.css('+ p')
-        expect(rendered_liquid).not_to be_nil
-        expect(rendered_liquid.text).to eq '3'
+      it "renders Liquid within a content block" do
+        rendered_liquid = sidebar.css("+ p")
+        expect(rendered_liquid).not_to(be_nil)
+        expect(rendered_liquid.text).to(eq("3"))
       end
 
-      it 'does not render a block without content' do
-        expect(index.css('head > style')).to be_empty
+      it "does not render a block without content" do
+        expect(index.css("head > style")).to(be_empty)
       end
     end
 
-    describe 'page.html' do
-      let(:page) { load_html('page.html') }
-      let(:sidebar) { index.css('body > div > h2#sidebar').first }
+    describe "page.html" do
+      let(:page) { load_html("page.html") }
 
-      it 'renders the css block' do
-        expect(page.css('style')).not_to be_empty
+      it "renders the css block" do
+        expect(page.css("style")).not_to(be_empty)
       end
 
-      it 'does not process Markdown in the CSS block' do
-        styles = page.css('style').text.gsub(/\s/, '')
-        expect(styles).to eq 'div{font-weight:bold;}'
+      it "does not process Markdown in the CSS block" do
+        styles = page.css("style").text.gsub(/\s/, "")
+        expect(styles).to(eq("div{font-weight:bold;}"))
       end
 
-      it 'renders the custom footer' do
-        expect(page.css('div#footer')).to be_empty
-        expect(page.css('div#custom-footer')).not_to be_empty
+      it "renders the custom footer" do
+        expect(page.css("div#footer")).to(be_empty)
+        expect(page.css("div#custom-footer")).not_to(be_empty)
       end
 
-      it 'renders the default sidebar' do
-        expect(page.css('div.sidebar-default')).not_to be_empty
-        expect(page.css('div.custom-sidebar')).to be_empty
+      it "renders the default sidebar" do
+        expect(page.css("div.sidebar-default")).not_to(be_empty)
+        expect(page.css("div.custom-sidebar")).to(be_empty)
       end
     end
 
-    describe 'ifnothascontent' do
-      it 'renders defaults when content is not supplied' do
-        expect(index.css('div#footer')).not_to be_empty
+    describe "page2.html" do
+      let(:page) { load_html("page2.html") }
+
+      it "renders only the page2 sidebar" do
+        sidebar = page.css("div.custom-sidebar")
+        expect(sidebar).not_to(be_empty)
+        expect(sidebar.text.strip).to(eq("A pretty simple sidebar."))
+      end
+    end
+
+    describe "ifnothascontent" do
+      it "renders defaults when content is not supplied" do
+        expect(index.css("div#footer")).not_to(be_empty)
       end
 
-      it 'does not render when there is content' do
-        expect(index.css('div[class=sidebar-default]')).to be_empty
+      it "does not render when there is content" do
+        expect(index.css("div[class=sidebar-default]")).to(be_empty)
       end
     end
 
-    if Jekyll.supports_collections?
-      describe 'content blocks in a collection' do
-        let(:item_one) { load_item_html('one') }
-        let(:item_two) { load_item_html('two') }
+    describe "content blocks in a collection" do
+      let(:item_one) { load_item_html("one") }
+      let(:item_two) { load_item_html("two") }
+
+      it "should render the content block" do
+        expect(item_one.css("div[class=sidebar-default]")).to(be_empty)
+        expect(item_one.css("div[class=custom-sidebar]")).not_to(be_empty)
+      end
+
+      it "should skip a content block that was not defined" do
+        expect(item_two.css("div[class=sidebar-default]")).not_to(be_empty)
+        expect(item_two.css("div[class=custom-sidebar]")).to(be_empty)
+      end
 
-        it 'should render the content block' do
-          expect(item_one.css('div[class=sidebar-default]')).to be_empty
-          expect(item_one.css('div[class=custom-sidebar]')).not_to be_empty
-        end
+      it "should process Markdown inside the content block" do
+        expect(item_one.css("div[class=custom-sidebar] ul li")).not_to(be_empty)
+      end
+    end
+
+    describe "page3.html (repeated blocks and front matter)" do
+      let(:page) { load_html("page3.html") }
+      let(:testimonials) { page.css("div.testimonials div.testimonial") }
+
+      it "collects each same-named block into contentblocks" do
+        expect(testimonials.length).to(eq(3))
+      end
+
+      it "exposes each block's front matter under data" do
+        expect(testimonials[0]["data-author"]).to(eq("Ada Lovelace"))
+        expect(testimonials[1]["data-author"]).to(eq("Alan Turing"))
+      end
 
-        it 'should skip a content block that was not defined' do
-          expect(item_two.css('div[class=sidebar-default]')).not_to be_empty
-          expect(item_two.css('div[class=custom-sidebar]')).to be_empty
-        end
+      it "leaves data empty for a block without front matter" do
+        expect(testimonials[2]["data-author"].to_s).to(eq(""))
+      end
+
+      it "converts each block's Markdown content" do
+        expect(testimonials[0].css("strong").text).to(eq("delightful"))
+      end
+
+      it "does not render the section on pages without those blocks" do
+        expect(index.css("div.testimonials")).to(be_empty)
+      end
+    end
+
+    describe "contentblocks variable" do
+      it "is present for a block that has content" do
+        expect(index.css("span#cb-sidebar-present")).not_to(be_empty)
+      end
+
+      it "stays nil for a block referenced by tags but with no content" do
+        # page.html renders {% ifhascontent sidebar %} but never defines a sidebar,
+        # so contentblocks.sidebar must not have been created as an empty array.
+        expect(load_html("page.html").css("span#cb-sidebar-present")).to(be_empty)
+      end
+    end
+
+    describe "a block defined but left empty" do
+      # `{% if contentblocks.x %}` tests whether the block was defined, while
+      # `ifhascontent` tests for non-empty content — so they diverge here.
+      let(:page) { load_html("emptyblock.html") }
+
+      it "is present in contentblocks (the block was defined)" do
+        expect(page.css("span#cb-sidebar-present")).not_to(be_empty)
+      end
 
-        it 'should process Markdown inside the content block' do
-          expect(item_one.css('div[class=custom-sidebar] ul li')).not_to be_empty
-        end
+      it "counts as no content for ifhascontent / ifnothascontent" do
+        expect(page.css("div.custom-sidebar")).to(be_empty)
+        expect(page.css("div.sidebar-default")).not_to(be_empty)
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,31 +1,30 @@
-require 'nokogiri'
-require 'jekyll-contentblocks'
-require 'pry-byebug'
+require "nokogiri"
+require "jekyll-contentblocks"
+require "open3"
 
 module SpecHelpers
   def jekyll_version
-    @jekyll_version ||= `jekyll --version`.strip.gsub('jekyll ', '')
+    @jekyll_version ||= `jekyll --version`.strip.gsub("jekyll ", "")
   end
 
   def generate_test_site
-    system 'rm -rf test/_site'
-    system 'jekyll build -s test/ -d test/_site &> /dev/null'
+    FileUtils.rm_rf("test/_site")
+    output, status = Open3.capture2e("jekyll build -s test/ -d test/_site")
+    # Keep passing runs quiet; only surface the build log when it actually fails.
+    warn(output) unless status.success?
+    status.success?
   end
 
   def load_html(file)
     path = "test/_site/#{file}"
-    if File.exists?(path)
+    if File.exist?(path)
       index_html = File.read(path)
       Nokogiri::Slop(index_html).html
     end
   end
 
   def load_item_html(item)
-    if Jekyll.version_less_than?('2.1.0')
-      load_html("items/#{item}.html")
-    else
-      load_html("items/#{item}/index.html")
-    end
+    load_html("items/#{item}/index.html")
   end
 end
 

data/test/_layouts/default.html

@@ -25,6 +25,10 @@
       </div>
     {% endifnothascontent %}
 
+    {% if contentblocks.sidebar %}
+      <span id="cb-sidebar-present"></span>
+    {% endif %}
+
     {% ifhascontent footer %}
       {% contentblock footer %}
     {% endifhascontent %}
@@ -34,6 +38,16 @@
       This is the default footer.
     </div>
     {% endifnothascontent %}
+
+    {% if contentblocks.testimonial %}
+      <div class="testimonials">
+        {% for testimonial in contentblocks.testimonial %}
+          <div class="testimonial" data-author="{{ testimonial.data.author }}">
+            {{ testimonial.content }}
+          </div>
+        {% endfor %}
+      </div>
+    {% endif %}
   </body>
 </html>
 

data/test/_plugins/require.rb

@@ -0,0 +1 @@
+require "jekyll-contentblocks"

data/test/emptyblock.md

@@ -0,0 +1,8 @@
+---
+title: Empty Block
+layout: default
+---
+
+This page defines a sidebar block but leaves it empty.
+
+{% contentfor sidebar %}{% endcontentfor %}

data/test/page2.md

@@ -0,0 +1,12 @@
+---
+title: Page Two
+layout: default
+---
+
+# CONTENT
+
+This page also has a sidebar.
+
+{% contentfor sidebar %}
+A pretty simple sidebar.
+{% endcontentfor %}

data/test/page3.md

@@ -0,0 +1,27 @@
+---
+title: Page Three
+layout: default
+---
+
+# CONTENT
+
+This page defines several blocks with the same name, each with its own front
+matter, and the layout loops over them.
+
+{% contentfor testimonial %}
+---
+author: Ada Lovelace
+---
+A **delightful** plugin.
+{% endcontentfor %}
+
+{% contentfor testimonial %}
+---
+author: Alan Turing
+---
+Saved us hours of work.
+{% endcontentfor %}
+
+{% contentfor testimonial %}
+Anonymous, but happy.
+{% endcontentfor %}