jekyll-figure 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 776b90fa868d03ca9d14c13cec83536e4f6d7602a4f41617477273f8a376a150
-  data.tar.gz: 4a74ceebf5143fa1e0f7ca6259d29f37a5e7fab178d60d49af2872b859e90f9e
+  metadata.gz: a210f7cb78ffe64a2b89cb8d15f59c76ff97078827a602a5372eb1e16fa71b96
+  data.tar.gz: 20d71c89144d59e145201d17b7ff86575a31c256b98818db4524c0c5566d4628
 SHA512:
-  metadata.gz: 8f104190796ef31527fdf72010350d44e50df9b03db99579eedf7c739827d5915b7a56cdbbc9e52e4e1580529fa0b0cb294bf3cec90dd703b8ccf71e5114e7c3
-  data.tar.gz: cf4994bba1a2805bd07c1974e282f666c46c6956db138557a3e0f189736f814d230c85f1261e402a31908c35d014c0465a3c970d71ddc24b762e97625193c51d
+  metadata.gz: 6986384a4a6b14a34544984bd09fb59048258120a7137039b7e7f847bf01fcf579926585ed746960009e3310143338e03686f241f5a6932cce93851ddc15f941
+  data.tar.gz: c0f63044fb45aebb4e36da199d50a49f48c19ecb1e3543107ec0200bbbd1e842e4db6243b1f807f6b80f22632e06560c65326d2b969d243154623002a14f3403

data/.gitignore

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

data/README.md

@@ -43,21 +43,7 @@ Content
 </figure>
 ```
 
-If a figure contains an image (or multiple images), the surrounding `<p>` will be stripped:
-
-```
-{% figure %}
-![Image](/path/to/image.jpg)
-{% endfigure %}
-```
-
-```html
-<figure>
-  <img src="/path/to/image.jpg" alt="Image" />
-</figure>
-```
-
-You can provide a caption. Any markdown will be rendered:
+You can provide a caption, for which any markdown will be rendered:
 
 ```
 {% figure caption:"*Markdown* caption" %}
@@ -72,10 +58,10 @@ Content
 </figure>
 ```
 
-You can also provide a class name(es) for CSS styling:
+You can also provide a class name(s) for CSS styling:
 
 ```
-{% figure caption:"A caption" | class:"classname" %}
+{% figure caption:"A caption" class:"classname" %}
 Content
 {% endfigure %}
 ```
@@ -87,7 +73,7 @@ Content
 </figure>
 ```
 
-Finally, the `caption` parameter will accept liquid ouput markup:
+The `caption` parameter also accepts liquid markup:
 
 ```
 {% figure caption:"{{ page.title }}" %}
@@ -98,10 +84,32 @@ Content
 ```html
 <figure>
   <p>Content</p>
-  <figcaption>The title of my post</figcaption>
+  <figcaption>The title of my page</figcaption>
+</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><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`

data/lib/jekyll-figure.rb

@@ -21,31 +21,38 @@ module Jekyll
           attributes[key] = value
         end
 
-        @caption = attributes['caption']
-        @class = attributes['class']
+        @settings = site.config["jekyll-figure"]
+        @caption = attributes["caption"]
+        @class = attributes["class"]
 
         # 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 = "  <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  ");
+        # 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_main}"
         figure_tag += "#{figure_caption}"
         figure_tag += "</figure>"
       end
@@ -54,4 +61,4 @@ module Jekyll
   end
 end
 
-Liquid::Template.register_tag('figure', Jekyll::Figure::FigureTag)
+Liquid::Template.register_tag("figure", Jekyll::Figure::FigureTag)

data/lib/jekyll-figure/version.rb

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

data/spec/jekyll-figure_spec.rb

@@ -1,39 +1,57 @@
-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
+
+  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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-figure
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Paul Robert Lloyd