jekyll-figure 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 372f820a218473fad59e88084c452abe66156957
+  data.tar.gz: daa8dffcc22670969f62bcdd72b35747b3874d44
+SHA512:
+  metadata.gz: 83f69bb1bca5caa7e5011e3141df937f6064b42702d497d40a7c500be6a46b0436be3a2838d88c48676263e98c4f48628c66827d8bf31957203837adc2e2fd3f
+  data.tar.gz: 044b9339c6d4098d8c6cede43cd1664204d515107053f1453ce60cde73874bde8f493e38630fb5640059c8b479d98d80a9b029499f9bfd59871b2c64714bf72b

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+gemspec
+
+if ENV["JEKYLL_VERSION"]
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Paul Robert Lloyd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,112 @@
+# jekyll-figure
+
+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)
+
+## Installation
+
+1. Add `gem 'jekyll-figure'` to your site’s Gemfile and run `bundle`
+2. Add the following to your site’s `_config.yml`:
+
+```yml
+gems:
+  - jekyll-figure
+```
+
+## Usage
+
+This plugin provides a liquid tag that enables you to generate a `<figure>` element. It takes optional `caption` and `class` parameters.
+
+```
+{% figure [caption:"Caption (markdown)"] [class:"class1 class2"] %}
+Figure content (markdown)
+{% endfigure %}
+```
+
+### Examples
+
+In simplest usage:
+
+```
+{% figure %}
+Content
+{% endfigure %}
+```
+
+```html
+<figure>
+  <p>Content</p>
+</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:
+
+```
+{% figure caption:"*Markdown* caption" %}
+Content
+{% endfigure %}
+```
+
+```html
+<figure>
+  <p>Content</p>
+  <figcaption><em>Markdown</em> caption</figcaption>
+</figure>
+```
+
+You can also provide a class name(es) for CSS styling:
+
+```
+{% figure caption:"A caption" | class:"classname" %}
+Content
+{% endfigure %}
+```
+
+```html
+<figure class="classname">
+  <p>Content</p>
+  <figcaption>A caption</figcaption>
+</figure>
+```
+
+Finally, the `caption` parameter will accept liquid ouput markup:
+
+```
+{% figure caption:"{{ page.title }}" %}
+Content
+{% endfigure %}
+```
+
+```html
+<figure>
+  <p>Content</p>
+  <figcaption>The title of my post</figcaption>
+</figure>
+```
+
+## Testing
+
+1. `script/bootstrap`
+2. `script/cibuild`
+
+## Contributing
+
+1. Fork the project
+2. Create a descriptively named feature branch
+3. Add your feature
+4. Submit a pull request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/jekyll-figure.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/figure/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = "jekyll-figure"
+  spec.version     = Jekyll::Figure::VERSION
+  spec.summary     = "Jekyll plugin that generates <figure> elements."
+  spec.description = "A liquid tag for Jekyll that generates <figure> elements."
+  spec.authors     = ["Paul Robert Lloyd"]
+  spec.email       = "me+rubygems@paulrobertlloyd.com"
+  spec.files       = Dir.glob("lib/**/*.rb")
+  spec.homepage    = "https://github.com/paulrobertlloyd/jekyll-figure"
+  spec.license     = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "jekyll", [">= 2.0", "< 4.0"]
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency "bundler", "~> 1.6"
+end

data/lib/jekyll/figure.rb

@@ -0,0 +1,57 @@
+module Jekyll
+  module Figure
+
+    class FigureTag < Liquid::Block
+      def initialize(tag_name, markup, tokens)
+        @markup = markup
+        super
+      end
+
+      def render(context)
+        # Gather settings
+        site = context.registers[:site]
+        converter = site.find_converter_instance(::Jekyll::Converters::Markdown)
+
+        # Render any liquid variables
+        markup = Liquid::Template.parse(@markup).render(context)
+
+        # Extract tag attributes
+        attributes = {}
+        markup.scan(Liquid::TagAttributes) do |key, value|
+          attributes[key] = value
+        end
+
+        @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 = "  <figcaption>#{figure_caption}</figcaption>\n"
+        end
+
+        # Class name(s)
+        unless @class.nil?
+          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  ");
+
+        # Used to escape markdown parsing rendering
+        markdown_escape = "\ "
+
+        # Render <figure>
+        figure_tag =  "<figure#{figure_class}>"
+        figure_tag += "#{figure_main}\n"
+        figure_tag += "#{figure_caption}"
+        figure_tag += "</figure>"
+      end
+    end
+
+  end
+end
+
+Liquid::Template.register_tag('figure', Jekyll::Figure::FigureTag)

data/lib/jekyll/figure/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Figure
+    VERSION = "0.0.1"
+  end
+end

data/script/bootstrap

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

data/script/cibuild

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

data/script/console

@@ -0,0 +1,34 @@
+#! /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

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

data/spec/fixtures/_config.yml

@@ -0,0 +1,9 @@
+timezone: UTC
+
+defaults:
+  -
+    scope:
+      path: ""
+      type: page
+    values:
+      layout: some_default

data/spec/fixtures/_layouts/some_default.html

@@ -0,0 +1,25 @@
+---
+---
+{% figure %}
+Content
+{% endfigure %}
+
+{% figure %}
+![Image](#)
+{% endfigure %}
+
+{% figure caption:"A caption" %}
+Content
+{% endfigure %}
+
+{% figure caption:"A caption" | class:"red" %}
+Content
+{% endfigure %}
+
+{% figure caption:"*Markdown* content" %}
+**Markdown** content
+{% endfigure %}
+
+{% figure caption:"{{ page.test }}" %}
+Content
+{% endfigure %}

data/spec/fixtures/index.html

@@ -0,0 +1,5 @@
+---
+test:
+  - Page data
+---
+Each test should be an item in `page.test`

data/spec/jekyll-figure_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe(Jekyll) do
+  let(:overrides) do
+    {
+      "source"      => source_dir,
+      "destination" => dest_dir,
+      "url"         => "http://example.org",
+    }
+  end
+  let(:config) do
+    Jekyll.configuration(overrides)
+  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>/
+  end
+
+  it "creates a figure element with image content" do
+    expect(contents).to match /<figure>\n  <img src="#" alt="Image" \/>\n  \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>/
+  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>/
+  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>/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+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'
+
+  SOURCE_DIR = File.expand_path("../fixtures", __FILE__)
+  DEST_DIR   = File.expand_path("../dest", __FILE__)
+
+  def source_dir(*files)
+    File.join(SOURCE_DIR, *files)
+  end
+
+  def dest_dir(*files)
+    File.join(DEST_DIR, *files)
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-figure
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Robert Lloyd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: A liquid tag for Jekyll that generates <figure> elements.
+email: me+rubygems@paulrobertlloyd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-figure.gemspec
+- lib/jekyll/figure.rb
+- lib/jekyll/figure/version.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/release
+- spec/fixtures/_config.yml
+- spec/fixtures/_layouts/some_default.html
+- spec/fixtures/index.html
+- spec/jekyll-figure_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/paulrobertlloyd/jekyll-figure
+licenses:
+- MIT
+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.4.6
+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_spec.rb
+- spec/spec_helper.rb