qiita-markdown 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aeafaca650b98a99a00e0735bde849f99faff1fb
-  data.tar.gz: 2911b685bc654da88a608ba1ee7c4636027c9a40
+  metadata.gz: 739494b992f30301e63c329ca71f822ef80bd67a
+  data.tar.gz: 6f925bef2e51205cec9f663e71ddae50ef6d2097
 SHA512:
-  metadata.gz: 019f1dd78735350a0e5c43f0c869fc3656ae858aaeec5d659b9eab64a1d040f3e0685a26313facb6fa750b526aecf676ad5b874aca06a49e18867fa384a60030
-  data.tar.gz: 26232bd99bac696a6eb05cd37054a53c0227773db46f78f0406abc63f0076d1b84ad06ca0058d53d8d2dcb18a4fbc5966f3f867f1f49f7d50f65f8d2eacbe7ff
+  metadata.gz: f002a9b803ff192b9139c8060dde2116e945aec2aec1fd9f02e3a09d45ad85c5654a7fdf8f2f7b31bd44a9f48293c693506d4b0cbeca15c9d41a2d4ae66cadf9
+  data.tar.gz: b718ef753796afa29aaed9dc72122a0bc88daa33db71cceea242ffe8192ff4f6238766e54ebe0f91821ebff7680b231457ce200ff7f6a0f3c38bb2936192d4af

data/CHANGELOG.md

@@ -1,5 +1,10 @@
+## 0.16.0
+- Add rel=noopener to all external a tags
+- Support HTML5 `<details>` and `<summary>` elements
+- Enable to change settings for footnotes
+
 ## 0.15.0
-- Append rel=nofollow and target=_blank to all external a tags
+- Append `rel=nofollow` and `target=_blank` to `a` tags for external link
 
 ## 0.14.0
 - Add some attributes to mentions for rendering hovercard

data/README.md

@@ -57,6 +57,8 @@ processor.call(text)
                        The original implementation is used when the generator returned a falsey value.
 :hostname            - FQDN. Used to check whether or not each URL of `href` attributes is external site. (String)
 :language_aliases    - Alias table for some language names. (Hash)
+:markdown            - A hash for enabling / disabling optional Markdown syntax. (Hash)
+                       Currently only :footnotes (default: true) is supported.
 :rule                - Sanitization rule table. (Hash)
 :script              - A flag to allow to embed script element. (Boolean)
 ```

data/lib/qiita/markdown.rb

@@ -23,6 +23,7 @@ require "qiita/markdown/filters/truncate"
 require "qiita/markdown/greenmat/heading_rendering"
 require "qiita/markdown/greenmat/html_renderer"
 require "qiita/markdown/greenmat/html_toc_renderer"
+require "qiita/markdown/base_processor"
 require "qiita/markdown/processor"
 require "qiita/markdown/summary_processor"
 require "qiita/markdown/version"

data/lib/qiita/markdown/base_processor.rb

@@ -0,0 +1,42 @@
+module Qiita
+  module Markdown
+    # An abstract base processor for rendering a Markdown document.
+    class BaseProcessor
+      # @return [Hash] the default context for HTML::Pipeline
+      def self.default_context
+        raise NotImplementedError
+      end
+
+      # @return [Array<Class>] the default HTML::Pipeline filter classes
+      def self.default_fiters
+        raise NotImplementedError
+      end
+
+      # @param [Hash] context Optional context for HTML::Pipeline.
+      def initialize(context = {})
+        @context = self.class.default_context.merge(context)
+      end
+
+      # Converts Markdown text into HTML string with extracted metadata.
+      #
+      # @param [String] input Markdown text.
+      # @param [Hash] context Optional context merged into default context.
+      # @return [Hash] Process result.
+      # @example
+      #   Qiita::Markdown::Processor.new.call(markdown) #=> {
+      #     codes: [...],
+      #     mentioned_usernames: [...],
+      #     output: "...",
+      #   }
+      def call(input, context = {})
+        HTML::Pipeline.new(filters, @context).call(input, context)
+      end
+
+      # @note Modify filters if you want.
+      # @return [Array<HTML::Pipeline::Filter>]
+      def filters
+        @filters ||= self.class.default_filters
+      end
+    end
+  end
+end

data/lib/qiita/markdown/filters/external_link.rb

@@ -11,7 +11,7 @@ module Qiita
             href_host = host_of(href)
             next unless href_host
             if href_host != hostname
-              anchor["rel"] = "nofollow"
+              anchor["rel"] = "nofollow noopener"
               anchor["target"] = "_blank"
             end
           end

data/lib/qiita/markdown/filters/greenmat.rb

@@ -2,6 +2,10 @@ module Qiita
   module Markdown
     module Filters
       class Greenmat < HTML::Pipeline::TextFilter
+        DEFAULT_OPTIONS = {
+          footnotes: true,
+        }.freeze
+
         # @return [Nokogiri::HTML::DocumentFragment]
         def call
           Nokogiri::HTML.fragment(greenmat.render(@text))
@@ -16,13 +20,17 @@ module Qiita
             Qiita::Markdown::Greenmat::HTMLRenderer.new(hard_wrap: true, with_toc_data: true),
             autolink: true,
             fenced_code_blocks: true,
-            footnotes: true,
+            footnotes: options[:footnotes],
             no_intra_emphasis: true,
             no_mention_emphasis: true,
             strikethrough: true,
             tables: true,
           )
         end
+
+        def options
+          @options ||= DEFAULT_OPTIONS.merge(context[:markdown] || {})
+        end
       end
     end
   end

data/lib/qiita/markdown/filters/sanitize.rb

@@ -133,6 +133,7 @@ module Qiita
             "code",
             "dd",
             "del",
+            "details",
             "div",
             "dl",
             "dt",
@@ -166,6 +167,7 @@ module Qiita
             "strike",
             "strong",
             "sub",
+            "summary",
             "sup",
             "table",
             "tbody",

data/lib/qiita/markdown/processor.rb

@@ -1,48 +1,26 @@
 module Qiita
   module Markdown
-    class Processor
-      DEFAULT_CONTEXT = {
-        asset_root: "/images",
-      }
-
-      DEFAULT_FILTERS = [
-        Filters::Greenmat,
-        Filters::ImageLink,
-        Filters::Footnote,
-        Filters::Code,
-        Filters::Checkbox,
-        Filters::Emoji,
-        Filters::SyntaxHighlight,
-        Filters::Mention,
-        Filters::GroupMention,
-        Filters::ExternalLink,
-        Filters::Sanitize,
-      ]
-
-      # @param [Hash] context Optional context for HTML::Pipeline.
-      def initialize(context = {})
-        @context = DEFAULT_CONTEXT.merge(context)
-      end
-
-      # Converts Markdown text into HTML string with extracted metadata.
-      #
-      # @param [String] input Markdown text.
-      # @param [Hash] context Optional context merged into default context.
-      # @return [Hash] Process result.
-      # @example
-      #   Qiita::Markdown::Processor.new.call(markdown) #=> {
-      #     codes: [...],
-      #     mentioned_usernames: [...],
-      #     output: "...",
-      #   }
-      def call(input, context = {})
-        HTML::Pipeline.new(filters, @context).call(input, context)
+    class Processor < BaseProcessor
+      def self.default_context
+        {
+          asset_root: "/images",
+        }
       end
 
-      # @note Modify filters if you want.
-      # @return [Array<HTML::Pipeline::Filter>]
-      def filters
-        @filters ||= DEFAULT_FILTERS.clone
+      def self.default_filters
+        [
+          Filters::Greenmat,
+          Filters::ImageLink,
+          Filters::Footnote,
+          Filters::Code,
+          Filters::Checkbox,
+          Filters::Emoji,
+          Filters::SyntaxHighlight,
+          Filters::Mention,
+          Filters::GroupMention,
+          Filters::ExternalLink,
+          Filters::Sanitize,
+        ]
       end
     end
   end

data/lib/qiita/markdown/summary_processor.rb

@@ -3,21 +3,26 @@ module Qiita
     # A processor for rendering a summary of markdown document. This simplifies
     # a document by removing complex markups and also truncates it to a
     # specific length without breaking the document structure.
-    class SummaryProcessor < Processor
-      DEFAULT_FILTERS = [
-        Filters::Greenmat,
-        Filters::Simplify,
-        Filters::Emoji,
-        Filters::Mention,
-        Filters::ExternalLink,
-        Filters::Sanitize,
-        Filters::Truncate,
-      ]
+    class SummaryProcessor < BaseProcessor
+      def self.default_context
+        {
+          asset_root: "/images",
+          markdown: {
+            footnotes: false,
+          },
+        }
+      end
 
-      # @note Modify filters if you want.
-      # @return [Array<HTML::Pipeline::Filter>]
-      def filters
-        @filters ||= DEFAULT_FILTERS.clone
+      def self.default_filters
+        [
+          Filters::Greenmat,
+          Filters::Simplify,
+          Filters::Emoji,
+          Filters::Mention,
+          Filters::ExternalLink,
+          Filters::Sanitize,
+          Filters::Truncate,
+        ]
       end
     end
   end

data/lib/qiita/markdown/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Markdown
-    VERSION = "0.15.0"
+    VERSION = "0.16.0"
   end
 end

data/spec/qiita/markdown/processor_spec.rb

@@ -482,7 +482,7 @@ describe Qiita::Markdown::Processor do
 
       it "replaces it with preferred link and updates :mentioned_groups" do
         is_expected.to eq <<-EOS.strip_heredoc
-          <p><a href="https://alice.example.com/groups/bob" rel="nofollow" target="_blank">@alice/bob</a></p>
+          <p><a href="https://alice.example.com/groups/bob" rel="nofollow noopener" target="_blank">@alice/bob</a></p>
         EOS
         expect(result[:mentioned_groups]).to eq [{
           group_url_name: "bob",
@@ -789,6 +789,25 @@ describe Qiita::Markdown::Processor do
       end
     end
 
+    context "with markdown: { footnotes: false } context" do
+      before do
+        context[:markdown] = { footnotes: false }
+      end
+
+      let(:markdown) do
+        <<-EOS.strip_heredoc
+          [^1]
+          [^1]: test
+        EOS
+      end
+
+      it "does not generate footnote elements" do
+        should eq <<-EOS.strip_heredoc
+          <p><a href="test">^1</a></p>
+        EOS
+      end
+    end
+
     context "with data-attributes" do
       let(:markdown) do
         <<-EOS.strip_heredoc
@@ -857,7 +876,7 @@ describe Qiita::Markdown::Processor do
         { hostname: "qiita.com" }
       end
 
-      it "creates link which does not have rel='nofollow' and target='_blank'" do
+      it "creates link which does not have rel='nofollow noopener' and target='_blank'" do
         should eq(
           '<p><a href="http://qiita.com/?a=b" class="autolink">' \
           "http://qiita.com/?a=b</a></p>\n"
@@ -874,9 +893,9 @@ describe Qiita::Markdown::Processor do
         { hostname: "qiita.com" }
       end
 
-      it "creates link which has rel='nofollow' and target='_blank'" do
+      it "creates link which has rel='nofollow noopener' and target='_blank'" do
         should eq(
-          '<p><a href="http://external.com/?a=b" class="autolink" rel="nofollow" target="_blank">' \
+          '<p><a href="http://external.com/?a=b" class="autolink" rel="nofollow noopener" target="_blank">' \
           "http://external.com/?a=b</a></p>\n"
         )
       end
@@ -891,7 +910,7 @@ describe Qiita::Markdown::Processor do
         { hostname: "qiita.com" }
       end
 
-      it "creates link which does not have rel='nofollow' and target='_blank'" do
+      it "creates link which does not have rel='nofollow noopener' and target='_blank'" do
         should eq(
           "<p><a href=\"http://qiita.com/?a=b\">foobar</a></p>\n"
         )
@@ -907,9 +926,9 @@ describe Qiita::Markdown::Processor do
         { hostname: "qiita.com" }
       end
 
-      it "creates link which has rel='nofollow' and target='_blank'" do
+      it "creates link which has rel='nofollow noopener' and target='_blank'" do
         should eq(
-          "<p><a href=\"http://external.com/?a=b\" rel=\"nofollow\" target=\"_blank\">foobar</a></p>\n"
+          "<p><a href=\"http://external.com/?a=b\" rel=\"nofollow noopener\" target=\"_blank\">foobar</a></p>\n"
         )
       end
     end
@@ -923,9 +942,9 @@ describe Qiita::Markdown::Processor do
         { hostname: "qiita.com" }
       end
 
-      it "creates link which has rel='nofollow' and target='_blank'" do
+      it "creates link which has rel='nofollow noopener' and target='_blank'" do
         should eq(
-          '<p><a href="http://qqqqqqiita.com/?a=b" class="autolink" rel="nofollow" target="_blank">' \
+          '<p><a href="http://qqqqqqiita.com/?a=b" class="autolink" rel="nofollow noopener" target="_blank">' \
           "http://qqqqqqiita.com/?a=b</a></p>\n"
         )
       end
@@ -940,9 +959,9 @@ describe Qiita::Markdown::Processor do
         { hostname: "qiita.com" }
       end
 
-      it "creates link which has rel='nofollow' and target='_blank'" do
+      it "creates link which has rel='nofollow noopener' and target='_blank'" do
         should eq(
-          "<p><a href=\"http://qqqqqqiita.com/?a=b\" rel=\"nofollow\" target=\"_blank\">foobar</a></p>\n"
+          "<p><a href=\"http://qqqqqqiita.com/?a=b\" rel=\"nofollow noopener\" target=\"_blank\">foobar</a></p>\n"
         )
       end
     end
@@ -956,9 +975,9 @@ describe Qiita::Markdown::Processor do
         { hostname: "qiita.com" }
       end
 
-      it "creates link which has rel='nofollow' and target='_blank'" do
+      it "creates link which has rel='nofollow noopener' and target='_blank'" do
         should eq(
-          '<p><a href="http://sub.qiita.com/?a=b" class="autolink" rel="nofollow" target="_blank">' \
+          '<p><a href="http://sub.qiita.com/?a=b" class="autolink" rel="nofollow noopener" target="_blank">' \
           "http://sub.qiita.com/?a=b</a></p>\n"
         )
       end
@@ -973,9 +992,9 @@ describe Qiita::Markdown::Processor do
         { hostname: "qiita.com" }
       end
 
-      it "creates link which has rel='nofollow' and target='_blank', and rel value is overwritten" do
+      it "creates link which has rel='nofollow noopener' and target='_blank', and rel value is overwritten" do
         should eq(
-          "<p><a href=\"http://external.com/?a=b\" rel=\"nofollow\" target=\"_blank\">foobar</a></p>\n"
+          "<p><a href=\"http://external.com/?a=b\" rel=\"nofollow noopener\" target=\"_blank\">foobar</a></p>\n"
         )
       end
     end

data/spec/qiita/markdown/summary_processor_spec.rb

@@ -243,5 +243,20 @@ describe Qiita::Markdown::SummaryProcessor do
         should eq %{<a href="/alice" class="user-mention js-hovercard" title="alice" data-hovercard-target-type="user" data-hovercard-target-name="alice">@alice</a>\n}
       end
     end
+
+    context "with footenote syntax" do
+      let(:markdown) do
+        <<-EOS.strip_heredoc
+          [^1]
+          [^1]: test
+        EOS
+      end
+
+      it "does not generate footnote elements by default" do
+        should eq <<-EOS.strip_heredoc
+          <a href="test">^1</a>
+        EOS
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-26 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemoji
@@ -261,6 +261,7 @@ files:
 - benchmark/sample.md
 - lib/qiita-markdown.rb
 - lib/qiita/markdown.rb
+- lib/qiita/markdown/base_processor.rb
 - lib/qiita/markdown/filters/checkbox.rb
 - lib/qiita/markdown/filters/code.rb
 - lib/qiita/markdown/filters/emoji.rb