slodown 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69786a2c6984b3113df329ee878d76eb4de88655
-  data.tar.gz: 9daa0d51fa74d936cf5441d0aafd7013f88b2643
+  metadata.gz: 17d27e385e008db49b05bee1acfdb62f0953e0cd
+  data.tar.gz: 96ef1fff701724d5f1fd95edb5245f88f8d81f30
 SHA512:
-  metadata.gz: 37af9f2cf9371fac48f05e3301d916b5bf057980ff78b20f3b06848d9c7fbef5494e6604f658c69f89f063cd4cff11af9af53b941f78439bb3c163c6798abfaf
-  data.tar.gz: 70e96284fdb75a2d9ffa4025b5550c8c0f2f1bc8cfd53aef622b4bd1c2b511801123a32a9ed5a9a4529c1bf64a39465e79a66de4f3f86f1958c6f1b98cd28b4e
+  metadata.gz: 0a31d2f4bd14fdadad10efccac44ba2de170b4f67099cd93146f497733d71774b2355ed830065f26fd288ff9b2687d98f5d024c13a94b815ce5ca517fb52afb7
+  data.tar.gz: a0f19df43d274b5a0c748575a84474b2a85d4e175e43768fcb0387503b83f5293172572778ab24650d72474831dac580dc273e11613be5e6333d9f69dee2ec74

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.2
-  - 1.9.3
   - 2.0.0
   - 2.1.8
   - 2.2.4

data/README.md

@@ -8,7 +8,7 @@
 
 Here's what Slodown does by default:
 
-- **render extended Markdown into HTML**. It uses the [kramdown](http://kramdown.rubyforge.org/) library, so yes, footnotes are supported!
+- **render extended Markdown into HTML**. It uses the [kramdown](http://kramdown.gettalong.org/) library, so yes, footnotes are supported!
 - **add syntax highlighting to Markdown code blocks** through [CodeRay](http://coderay.rubychan.de/), [Rouge](http://rouge.jneen.net/), or any other highlighter supported by kramdown.
 - **support super-easy rich media embeds**. Just point the Markdown image syntax at, say, a Youtube video, and Slodown will fetch the complete embed code through the magic of [ruby-oembed](https://github.com/judofyr/ruby-oembed).
 - **auto-link contained URLs** using [Rinku](https://github.com/vmg/rinku), which is smart enough to not auto-link URLs contained in, say, code blocks.
@@ -25,7 +25,7 @@ Slodown, out of the box, implements my preferred way of handling user input, whi
 - Auto-link contained URLs and email addresses.
 - Finally, and most importantly, run the entire HTML through a really, really good whitelist-based sanitizer.
 
-This allows users to still add their own HTML, if required. In fact, I typically encourage users to make use of [kramdown's inline attributes], leaving it up the sanitizer to make sure they don't go crazy.
+This allows users to still add their own HTML, if required. In fact, I typically encourage users to make use of [kramdown's inline attributes](http://kramdown.gettalong.org/syntax.html#inline-attribute-lists), leaving it up the sanitizer to make sure they don't go crazy.
 
 If this is not what you want, you will most likely be able to bend Slodown to your will -- it's pretty flexible.
 
@@ -149,6 +149,12 @@ If you're still set on submitting a pull request, please consider the following:
 
 ## Version History
 
+### 0.4.0 (2017-01-13)
+
+- Feature: Block-level images are now rendered as a complete `<figure>` structure (with optional `<figcaption>`.)
+- Change: The Slodown sanitizer now allows `<figure>`, `<figcaption>`, `<cite>`, `<mark>`, `<del>` and `<ins>` tags by default.
+- Change: The Slodown sanitizer was stripping HTML of table tags. Tables are harmless, so they're not being stripped any longer.
+
 ### 0.3.0 (2016-02-22)
 
 - Removed the dependency on CodeRay. If you want syntax highlighting in your Markdown parsing, simply add CodeRay (or Rouge, or any other highlighter supported by kramdown) to your project.

data/lib/kramdown/converter/slodown_html.rb

@@ -4,12 +4,33 @@
 # Markdown image elements.)
 #
 class Kramdown::Converter::SlodownHtml < Kramdown::Converter::Html
-  # Hook into image tags to allow oEmbed embeds.
+  # In Slodown, you can use block-level image attributes for oEmbed-based
+  # embeds. For this, we're hooking into #convert_p to find single block-level
+  # images.
   #
-  def convert_img(el, indent)
-    oembed = OEmbed::Providers.get(el.attr['src'])
-    %q(<div class="embedded %s %s">%s</div>) % [oembed.type, oembed.provider_name.parameterize, oembed.html]
-  rescue StandardError => e
-    super
+  # If we can't use OEmbed, we'll assume the image is an actual image, and
+  # convert it into a <figure> element (with optional <figcaption>.)
+  #
+  def convert_p(el, indent)
+    if el.options[:transparent]
+      inner(el, indent)
+    elsif !el.children.nil? && el.children.count == 1 && el.children.first.type == :img
+      # Try to handle the embedded object through OEmbed; if this fails,
+      # handle it as an image instead and create a <figure>.
+      child = el.children.first
+
+      begin
+        oembed = OEmbed::Providers.get(child.attr['src'])
+        %q(<div class="embedded %s %s">%s</div>) % [oembed.type, oembed.provider_name.downcase.gsub(/\W+/, '-'), oembed.html]
+      rescue OEmbed::NotFound => e
+        convert_figure(child, indent)
+      end
+    else
+      super
+    end
+  end
+
+  def convert_figure(el, indent)
+    "#{' '*indent}<figure><img#{html_attributes(el.attr)} />#{(el.attr['title'] ? "<figcaption>#{el.attr['title']}</figcaption>" : "")}</figure>\n"
   end
 end

data/lib/slodown/formatter.rb

@@ -84,12 +84,15 @@ module Slodown
         elements: %w(
           p br a span sub sup strong em div hr abbr s
           ul ol li
-          blockquote pre code kbd
+          blockquote cite pre code kbd
           h1 h2 h3 h4 h5 h6
           img object param del
+          table tr td th thead tbody
+          figure figcaption
+          mark del ins
         ),
         attributes: {
-          :all     => ['class', 'style', 'title', 'id'],
+          :all     => ['class', 'style', 'title', 'id', 'datetime'],
           'a'      => ['href', 'rel', 'name'],
           'li'     => ['id'],
           'sup'    => ['id'],
@@ -97,7 +100,9 @@ module Slodown
           'object' => ['width', 'height'],
           'param'  => ['name', 'value'],
           'embed'  => ['allowscriptaccess', 'width', 'height', 'src'],
-          'iframe' => ['width', 'height', 'src']
+          'iframe' => ['width', 'height', 'src'],
+          'td'     => ['colspan', 'rowspan'],
+          'th'     => ['colspan', 'rowspan']
         },
         protocols: {
           'a' => { 'href' => ['ftp', 'http', 'https', 'mailto', '#fn', '#fnref', :relative] },

data/lib/slodown/version.rb

@@ -1,3 +1,3 @@
 module Slodown
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/image_figures_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+def render(text)
+  Slodown::Formatter.new(text).complete.to_s
+end
+
+describe 'basic formatting syntax' do
+  it "converts a block-level image to a <figure> structure" do
+    expect(render %[check it out:\n\n![image](image.jpg "Cute Kitten!")])
+      .to eq %[<p>check it out:</p>\n\n<figure><img src="image.jpg" alt="image" title="Cute Kitten!"><figcaption>Cute Kitten!</figcaption></figure>\n]
+  end
+
+  it "doesn't affect OEmbed-enabled embeds" do
+    expect(render %[check it out:\n\n![video](https://www.youtube.com/watch?v=KilehMXMxo0)])
+      .to eq %[<p>check it out:</p>\n\n<div class="embedded video youtube"><iframe width="480" height="270" src="https://www.youtube.com/embed/KilehMXMxo0?feature=oembed" frameborder="0" allowfullscreen=""></iframe></div>]
+  end
+
+  it "doesn't affect inline images" do
+    expect(render %[here's an inline image: ![image](image.jpg)])
+      .to eq %[<p>here’s an inline image: <img src="image.jpg" alt="image"></p>\n]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slodown
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Hendrik Mans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -129,6 +129,7 @@ files:
 - lib/slodown/version.rb
 - slodown.gemspec
 - spec/basic_formatting_spec.rb
+- spec/image_figures_spec.rb
 - spec/metadata_extraction_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/hmans/slodown
@@ -150,12 +151,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Markdown + oEmbed + Sanitize + Syntax Highlighting = the ultimate user input
   rendering pipeline.
 test_files:
 - spec/basic_formatting_spec.rb
+- spec/image_figures_spec.rb
 - spec/metadata_extraction_spec.rb
 - spec/spec_helper.rb