jekyll-figure 0.0.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 776b90fa868d03ca9d14c13cec83536e4f6d7602a4f41617477273f8a376a150
-  data.tar.gz: 4a74ceebf5143fa1e0f7ca6259d29f37a5e7fab178d60d49af2872b859e90f9e
+  metadata.gz: d4ef02f57060db513906d950dbf708ddc1237495dd3df4ff783799fd049a908d
+  data.tar.gz: 46f4a6336c409de505479624196de701a22b9bd087a56939f552d24f9ffff987
 SHA512:
-  metadata.gz: 8f104190796ef31527fdf72010350d44e50df9b03db99579eedf7c739827d5915b7a56cdbbc9e52e4e1580529fa0b0cb294bf3cec90dd703b8ccf71e5114e7c3
-  data.tar.gz: cf4994bba1a2805bd07c1974e282f666c46c6956db138557a3e0f189736f814d230c85f1261e402a31908c35d014c0465a3c970d71ddc24b762e97625193c51d
+  metadata.gz: 844cd1bf4a667cf4f2fc006f8fc71d4b32c25cafadacdeab072add72c31cfd71ea07fce71f0871f6075aab42ab24a8d70213fbeb32f071b61f19caff097be094
+  data.tar.gz: 86e3492bcc24ab601d33362da912d227ac538282951589a0b80a72de3e08a3f6c678c5e08a1acec8cd2db94b994191fa43546b53af8b3a09bcd757761a8b4f31

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "monthly"

data/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6.6]
+        jekyll: [3.0, 4.0]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+      env:
+        JEKYLL_VERSION: ${{ matrix.jekyll }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake spec

data/.gitignore

@@ -1,6 +1,5 @@
-*.gem
 Gemfile.lock
 spec/dest
 .bundle
 .jekyll-metadata
-.DS_Store
+*.gem

data/README.md

@@ -2,26 +2,26 @@
 
 A liquid tag for Jekyll that generates `<figure>` elements.
 
-[![Gem Version](https://img.shields.io/gem/v/jekyll-figure.svg)](https://rubygems.org/gems/jekyll-figure)
-[![Build Status](https://img.shields.io/travis/paulrobertlloyd/jekyll-figure/master.svg)](https://travis-ci.org/paulrobertlloyd/jekyll-figure)
+[![Gem version](https://img.shields.io/gem/v/jekyll-figure.svg)](https://rubygems.org/gems/jekyll-figure)
+[![Build status](https://github.com/paulrobertlloyd/jekyll-figure/workflows/test/badge.svg)](https://github.com/paulrobertlloyd/jekyll-figure/actions)
 
 ## Installation
 
 1. Add `gem 'jekyll-figure'` to your site’s Gemfile and run `bundle`
 2. Add the following to your site’s `_config.yml`:
 
-
 ```yaml
 plugins:
   - jekyll-figure
 ```
+
 Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
 
 ## Usage
 
 This plugin provides a liquid tag that enables you to generate a `<figure>` element. It takes optional `caption` and `class` parameters.
 
-```
+```liquid
 {% figure [caption:"Caption (markdown)"] [class:"class1 class2"] %}
 Figure content (markdown)
 {% endfigure %}
@@ -31,7 +31,7 @@ Figure content (markdown)
 
 In simplest usage:
 
-```
+```liquid
 {% figure %}
 Content
 {% endfigure %}
@@ -43,69 +43,98 @@ Content
 </figure>
 ```
 
-If a figure contains an image (or multiple images), the surrounding `<p>` will be stripped:
+You can provide a caption, for which any markdown will be rendered:
 
-```
-{% figure %}
-![Image](/path/to/image.jpg)
+```liquid
+{% figure caption:"*Markdown* caption" %}
+Content
 {% endfigure %}
 ```
 
 ```html
 <figure>
-  <img src="/path/to/image.jpg" alt="Image" />
+  <p>Content</p>
+  <figcaption><em>Markdown</em> caption</figcaption>
 </figure>
 ```
 
-You can provide a caption. Any markdown will be rendered:
+You can also provide a class name(s) for CSS styling:
 
-```
-{% figure caption:"*Markdown* caption" %}
+```liquid
+{% figure caption:"A caption" class:"classname" %}
 Content
 {% endfigure %}
 ```
 
 ```html
-<figure>
+<figure class="classname">
   <p>Content</p>
-  <figcaption><em>Markdown</em> caption</figcaption>
+  <figcaption>A caption</figcaption>
 </figure>
 ```
 
-You can also provide a class name(es) for CSS styling:
+The `caption` parameter also accepts liquid markup:
 
-```
-{% figure caption:"A caption" | class:"classname" %}
+```liquid
+{% figure caption:"{{ page.title }}" %}
 Content
 {% endfigure %}
 ```
 
 ```html
-<figure class="classname">
+<figure>
   <p>Content</p>
-  <figcaption>A caption</figcaption>
+  <figcaption>The title of my page</figcaption>
 </figure>
 ```
 
-Finally, the `caption` parameter will accept liquid ouput markup:
+You can also add labels and reference them:
 
-```
-{% figure caption:"{{ page.title }}" %}
-Content
+```liquid
+{% figure caption:"A caption." label:example %}
+An example figure that can be referenced later.
 {% endfigure %}
+
+You can see an example in {% figref example %}.
 ```
 
+```html
+<figure id="example">
+  <p>An example figure that can be referenced later.</p>
+  <figcaption><em>Figure 1:</em> A caption.</figcaption>
+</figure>
+
+<p>You can see an example in <a href="#example">figure 1</a></p>
+```
+
+The word ‘Figure’ in the figcaption is translated according to the `lang` you set in the yaml header of your post. If your language is not supported simple set `figure` to the yaml header of your post to the value you want to use instead of ‘Figure’.
+
+## Configuration
+
+Any markdown provided within the `{% figure %}` block is rendered using Jekyll’s Markdown parser, [Kramdown](https://kramdown.gettalong.org). However, this means images and other content will be wrapped within `<p>` tags, like so:
+
 ```html
 <figure>
-  <p>Content</p>
-  <figcaption>The title of my post</figcaption>
+  <p><img src="/path/to/image.jpg" alt="Image"></p>
 </figure>
 ```
 
+To disable this behaviour, in your Jekyll configuration set the `paragraphs` value for this plugin to `false`:
+
+```yaml
+plugins:
+  - jekyll-figure
+
+jekyll-figure:
+  paragraphs: false
+```
+
+Note however that this will remove *all* paragraph tags, even those nested within other elements.
+
 ## Testing
 
-1. `script/bootstrap`
-2. `script/cibuild`
+1. `bundle install`
+2. `bundle exec rake spec`
 
 ## Contributing
 

data/jekyll-figure.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "jekyll", [">= 3.0", "< 4.0"]
+  spec.add_development_dependency "jekyll", [">= 3.0", "< 5.0"]
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency 'rake', '~> 0'
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'rake', '~> 13.0.1'
+  spec.add_development_dependency "bundler", "~> 2.1"
 end

data/lib/jekyll-figure/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Figure
-    VERSION = "0.0.3"
+    VERSION = "0.2.0"
   end
 end

data/lib/jekyll-figure-ref.rb

@@ -0,0 +1,22 @@
+require 'utils'
+
+module Jekyll
+  module Figure
+
+    class FigRefTag < Liquid::Tag
+      include Utils
+
+      def initialize(tag_name, markup, tokens)
+        @label = markup
+        super
+      end
+
+      def render(context)
+        @context = context
+        print_reference(@label)
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("figref", Jekyll::Figure::FigRefTag)

data/lib/jekyll-figure.rb

@@ -1,7 +1,12 @@
+require 'utils'
+require 'jekyll-figure-ref'
+
 module Jekyll
   module Figure
 
     class FigureTag < Liquid::Block
+      include Utils
+
       def initialize(tag_name, markup, tokens)
         @markup = markup
         super
@@ -21,31 +26,43 @@ module Jekyll
           attributes[key] = value
         end
 
-        @caption = attributes['caption']
-        @class = attributes['class']
+        @settings = site.config["jekyll-figure"]
+        @caption = attributes["caption"]
+        @class = attributes["class"]
+        @label = attributes["label"]
+        @context = context
 
         # Caption: convert markdown and remove paragraphs
         unless @caption.nil?
-          figure_caption = @caption.gsub!(/\A"|"\Z/, '')
-          figure_caption = converter.convert(figure_caption).gsub(/<\/?p[^>]*>/, '').chomp
+          figure_caption = @caption.gsub!(/\A"|"\Z/, "")
+          figure_caption = converter.convert(figure_caption).gsub(/<\/?p[^>]*>/, "").chomp
+          figure_caption = print_figure_counter(@label) + figure_caption unless @label.nil? || @label.empty?
           figure_caption = "  <figcaption>#{figure_caption}</figcaption>\n"
         end
 
         # Class name(s)
         unless @class.nil?
-          figure_class = @class.gsub!(/\A"|"\Z/, '')
+          figure_class = @class.gsub!(/\A"|"\Z/, "")
           figure_class = " class\=\"#{figure_class}\""
         end
 
-        # Content: convert markdown and remove paragraphs containing images
-        figure_main = converter.convert(super(context)).gsub(/^<p>\s*((<img[^<]+?)+)\s*<\/p>(.*)/, '\\1').gsub!(/[\n]+/, "\n  ");
+        figure_label = @label.nil? || @label.empty? ? "" : ' id="' + @label.gsub(/A"|"\Z/, "") + '"'
+        
+        # Content
+        if @settings && @settings["paragraphs"] == false
+          # Strip paragraphs
+          figure_main = converter.convert(super(context)).gsub(/<\/?p[^>]*>/, "")
+        else
+          # Don't strip paragraphs
+          figure_main = converter.convert(super(context))
+        end
 
         # Used to escape markdown parsing rendering
         markdown_escape = "\ "
 
         # Render <figure>
-        figure_tag =  "<figure#{figure_class}>"
-        figure_tag += "#{figure_main}\n"
+        figure_tag =  "<figure#{figure_class}#{figure_label}>"
+        figure_tag += "#{figure_main}"
         figure_tag += "#{figure_caption}"
         figure_tag += "</figure>"
       end
@@ -54,4 +71,4 @@ module Jekyll
   end
 end
 
-Liquid::Template.register_tag('figure', Jekyll::Figure::FigureTag)
+Liquid::Template.register_tag("figure", Jekyll::Figure::FigureTag)

data/lib/utils.rb

@@ -0,0 +1,47 @@
+module Jekyll
+  module Figure
+    module Utils
+
+      class I18n
+        @figure_i18n = {'en' => "Figure",
+                        'de' => "Abbildung",
+                        'sv' => "Figur",
+                        'fr' => "Figure"}
+        def self.figure(lang)
+          return @figure_i18n[lang] if @figure_i18n.key?(lang)
+          @figure_i18n['en']
+        end
+      end
+
+      def lang
+        return @context.registers[:page]["lang"].to_s if @context.registers[:page].key?("lang")
+        "en".to_s
+      end
+
+      def figure
+        return @context.registers[:page]["figure"].to_s if @context.registers[:page].key?("figure")
+        I18n.figure(lang)
+      end
+      
+      def print_figure_counter(label)
+        label.gsub!(/\s/, '')
+        @context.registers[:page]["figure_labels"] ||= {}
+        
+        if @context.registers[:page]["figure_labels"].key?(label)
+          value = @context.registers[:page]["figure_labels"][label]
+        else
+          value = @context.registers[:page]["figure_labels"].length + 1
+          @context.registers[:page]["figure_labels"][label] = value
+        end
+        "<em>" + figure + " " + value.to_s + ":</em> "
+      end
+
+      def print_reference(label)
+        label.gsub!(/\s/, '')
+        "<a href=\"\##{label.to_s}\">" + figure.downcase + " " +
+          @context.registers[:page]["figure_labels"][label.to_s].to_s +
+        "</a>"
+      end
+    end
+  end
+end

data/spec/fixtures/_layouts/some_default.html

@@ -23,3 +23,9 @@ Content
 {% figure caption:"{{ page.test }}" %}
 Content
 {% endfigure %}
+
+{% figure caption:"A caption" label:example %}
+Content
+{% endfigure %}
+
+See {% figref example %}

data/spec/jekyll-figure-ref_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe(Jekyll) do
+  Jekyll.logger.log_level = :error
+
+  let(:config_overrides) { {} }
+  let(:config) do
+    Jekyll.configuration(
+      config_overrides.merge(
+        "source" => source_dir,
+        "destination" => dest_dir,
+        "url" => "http://example.org",
+      )
+    )
+  end
+  let(:site) { Jekyll::Site.new(config) }
+  let(:contents) { File.read(dest_dir("index.html")) }
+  before(:each) do
+    site.process
+  end
+
+  it "creates a figref element" do
+    expect(contents).to match /See <a href="#example">figure 1<\/a>/
+  end
+end

data/spec/jekyll-figure_spec.rb

@@ -1,39 +1,61 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe(Jekyll) do
-  let(:overrides) do
-    {
-      "source"      => source_dir,
-      "destination" => dest_dir,
-      "url"         => "http://example.org",
-    }
-  end
+  Jekyll.logger.log_level = :error
+
+  let(:config_overrides) { {} }
   let(:config) do
-    Jekyll.configuration(overrides)
-  end
-  let(:site)     { Jekyll::Site.new(config) }
+    Jekyll.configuration(
+      config_overrides.merge(
+        "source" => source_dir,
+        "destination" => dest_dir,
+        "url" => "http://example.org",
+      )
+    )
+  end
+  let(:site) { Jekyll::Site.new(config) }
   let(:contents) { File.read(dest_dir("index.html")) }
   before(:each) do
     site.process
   end
 
   it "creates a figure element" do
-    expect(contents).to match /<figure>\n  <p>Content<\/p>\n  \n<\/figure>/
+    expect(contents).to match /<figure>\n<p>Content<\/p>\n<\/figure>/
   end
 
   it "creates a figure element with image content" do
-    expect(contents).to match /<figure>\n  <img src="#" alt="Image" \/>\n  \n<\/figure>/
+    expect(contents).to match /<figure>\n<p><img src="#" alt="Image" \/><\/p>\n<\/figure>/
   end
 
   it "creates a figure element with caption" do
-    expect(contents).to match /<figure>\n  <p>Content<\/p>\n  \n  <figcaption>A caption<\/figcaption>\n<\/figure>/
+    expect(contents).to match /<figure>\n<p>Content<\/p>\n  <figcaption>A caption<\/figcaption>\n<\/figure>/
   end
 
   it "creates a figure element with caption and class name" do
-    expect(contents).to match /<figure>\n  <p><strong>Markdown<\/strong> content<\/p>\n  \n  <figcaption><em>Markdown<\/em> content<\/figcaption>\n<\/figure>/
+    expect(contents).to match /<figure>\n<p><strong>Markdown<\/strong> content<\/p>\n  <figcaption><em>Markdown<\/em> content<\/figcaption>\n<\/figure>/
   end
 
   it "creates a figure element with liquid variable for caption" do
-    expect(contents).to match /<figure>\n  <p>Content<\/p>\n  \n  <figcaption>Page data<\/figcaption>\n<\/figure>/
+    expect(contents).to match /<figure>\n<p>Content<\/p>\n  <figcaption>Page data<\/figcaption>\n<\/figure>/
+  end
+
+  it "creates a figure element with caption and label" do
+    expect(contents).to match /<figure id="example">\n<p>Content<\/p>\n  <figcaption><em>Figure 1:<\/em> A caption<\/figcaption>\n<\/figure>/
+  end
+
+  context "with paragraphs stripped" do
+    let(:config_overrides) do
+      {
+        "jekyll-figure" => { "paragraphs" => false },
+      }
+    end
+
+    it "creates a figure element" do
+      expect(contents).to match /<figure>\nContent\n<\/figure>/
+    end
+
+    it "creates a figure element with image content" do
+      expect(contents).to match /<figure>\n<img src="#" alt="Image" \/>\n<\/figure>/
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,12 +1,12 @@
-require 'jekyll'
-require File.expand_path('../lib/jekyll-figure', File.dirname(__FILE__))
+require "jekyll"
+require File.expand_path("../lib/jekyll-figure", File.dirname(__FILE__))
 
 Jekyll.logger.log_level = :error
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
-  config.order = 'random'
+  config.order = "random"
 
   SOURCE_DIR = File.expand_path("../fixtures", __FILE__)
   DEST_DIR   = File.expand_path("../dest", __FILE__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-figure
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Robert Lloyd
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-22 00:00:00.000000000 Z
+date: 2023-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -19,7 +19,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -50,57 +50,57 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.1'
 description: A liquid tag for Jekyll that generates <figure> elements.
 email: me+rubygems@paulrobertlloyd.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - jekyll-figure.gemspec
+- lib/jekyll-figure-ref.rb
 - lib/jekyll-figure.rb
 - lib/jekyll-figure/version.rb
-- script/bootstrap
-- script/cibuild
-- script/console
-- script/release
+- lib/utils.rb
 - spec/fixtures/_config.yml
 - spec/fixtures/_layouts/some_default.html
 - spec/fixtures/index.html
+- spec/jekyll-figure-ref_spec.rb
 - spec/jekyll-figure_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/paulrobertlloyd/jekyll-figure
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,14 +115,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Jekyll plugin that generates <figure> elements.
 test_files:
 - spec/fixtures/_config.yml
 - spec/fixtures/_layouts/some_default.html
 - spec/fixtures/index.html
+- spec/jekyll-figure-ref_spec.rb
 - spec/jekyll-figure_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-script: "script/cibuild"
-matrix:
-  include:
-  - rvm: 2.0
-    env: ""
-  - rvm: 2.0
-    env: JEKYLL_VERSION=3.0.0
-  - rvm: 2.1
-    env: ""
-  - rvm: 2.1
-    env: JEKYLL_VERSION=3.0.0
-  - rvm: 2.1
-    env: JEKYLL_VERSION=3.7.4

data/script/bootstrap

@@ -1,3 +0,0 @@
-#! /bin/bash
-
-bundle install

data/script/cibuild

@@ -1,3 +0,0 @@
-#! /bin/bash
-
-bundle exec rspec

data/script/console

@@ -1,34 +0,0 @@
-#! /usr/bin/env ruby
-
-def relative_to_root(path)
-  File.expand_path(path, File.dirname(File.dirname(__FILE__)))
-end
-
-require 'jekyll'
-require relative_to_root('lib/jekyll-figure.rb')
-require 'pry-debugger'
-
-SOURCE_DIR = relative_to_root('spec/fixtures')
-DEST_DIR   = relative_to_root('spec/dest')
-
-def source_dir(*files)
-  File.join(SOURCE_DIR, *files)
-end
-
-def dest_dir(*files)
-  File.join(DEST_DIR, *files)
-end
-
-def config(overrides = {})
-  Jekyll.configuration({
-    "source"      => source_dir,
-    "destination" => dest_dir,
-    "url"         => "http://example.org"
-  }).merge(overrides)
-end
-
-def site(configuration = config)
-  Jekyll::Site.new(configuration)
-end
-
-binding.pry

data/script/release

@@ -1,7 +0,0 @@
-#!/bin/sh
-# Tag and push a release.
-
-set -e
-
-script/cibuild
-bundle exec rake release