qiita-markdown 0.20.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28a5b7b0575729c0e1ee9badeed314471aceb1c4
-  data.tar.gz: 580ab1d79419424502c77fad83427f5e8384e5cb
+  metadata.gz: f4ebdec684801c23c2b2183ea2498383180d4382
+  data.tar.gz: ebaf06c2afa12f825f6b21a122e36705da59bf13
 SHA512:
-  metadata.gz: 52b5622f03f628a693e75f54db193dfb98a9debb16ffe91b11bf4b22aecbadee373093d9287b06a02e64a1e620dbdeb4116b3f303aa647546bd832e8e3271410
-  data.tar.gz: 69e71477b6a063f6e82482bedd333a49fd1d1206736620cdc98acd89a8d9cfe3c1634bffc4ba1270717b7064cbb1247508d8aa55679f3f9980cd3426cec007f8
+  metadata.gz: e237616c63dfb7d0a6f332c4b8327afcf39bfa3ea285767890efb49fcb43ffa1b7563b8943248fd5f8948abc4875d462c3382268f53b27214bd6e2d42a318dcb
+  data.tar.gz: 7c7d5e9a117e28d883ec45c2e7cab9dba35b39ad468ca16a372f7403a6b2f9c74fd74b2e151f42e1b497d525701a46c6c224e46a548fb481ccc7374f54473fe6

data/.rubocop_todo.yml

@@ -53,7 +53,7 @@ Style/FileName:
 Style/MutableConstant:
   Exclude:
     - 'lib/qiita/markdown/filters/checkbox.rb'
-    - 'lib/qiita/markdown/filters/code.rb'
+    - 'lib/qiita/markdown/filters/code_block.rb'
     - 'lib/qiita/markdown/filters/sanitize.rb'
     - 'lib/qiita/markdown/filters/simplify.rb'
     - 'lib/qiita/markdown/filters/syntax_highlight.rb'
@@ -67,7 +67,7 @@ Style/MutableConstant:
 # SupportedStyles: skip_modifier_ifs, always
 Style/Next:
   Exclude:
-    - 'lib/qiita/markdown/filters/code.rb'
+    - 'lib/qiita/markdown/filters/code_block.rb'
     - 'lib/qiita/markdown/filters/image_link.rb'
 
 # Offense count: 11
@@ -95,6 +95,7 @@ Style/PerlBackrefs:
 Style/RegexpLiteral:
   Exclude:
     - 'lib/qiita/markdown/filters/mention.rb'
+    - 'lib/qiita/markdown/filters/inline_code_color.rb'
 
 # Offense count: 3
 # Cop supports --auto-correct.

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Unreleased
 
+## 0.21.0
+
+- Rename `Code` to `CodeBlock`
+- Support CSS color in inline code
+
 ## 0.20.1
 
 - Fix to sanitize `<input>` which was unexpectedly permitted

data/README.md

@@ -56,20 +56,21 @@ processor.call(text)
 `.new` and `#call` can take optional context as a Hash with following keys:
 
 ```
-:allowed_usernames   - A list of usernames allowed to be username. (Array<String>)
-:asset_path          - URL path to link to emoji sprite. (String)
-:asset_root          - Base URL to link to emoji sprite. (String)
-:base_url            - Used to construct links to user profile pages for each. (String)
-:default_language    - Default language used if no language detected from code. (String)
-:emoji_names         - A list of allowed emoji names. (Array<String>)
-:emoji_url_generator - #call'able object that accepts emoji name as argument and returns emoji image URL. (#call)
-                       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)
+:allowed_usernames            - A list of usernames allowed to be username. (Array<String>)
+:asset_path                   - URL path to link to emoji sprite. (String)
+:asset_root                   - Base URL to link to emoji sprite. (String)
+:base_url                     - Used to construct links to user profile pages for each. (String)
+:default_language             - Default language used if no language detected from code. (String)
+:emoji_names                  - A list of allowed emoji names. (Array<String>)
+:emoji_url_generator          - #call'able object that accepts emoji name as argument and returns emoji image URL. (#call)
+                                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)
+:inline_code_color_class_name - Class name for inline code color. (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)
 ```
 
 ```ruby

data/lib/qiita/markdown.rb

@@ -8,7 +8,7 @@ require "pygments"
 require "sanitize"
 
 require "qiita/markdown/filters/checkbox"
-require "qiita/markdown/filters/code"
+require "qiita/markdown/filters/code_block"
 require "qiita/markdown/filters/emoji"
 require "qiita/markdown/filters/external_link"
 require "qiita/markdown/filters/final_sanitizer"
@@ -16,6 +16,7 @@ require "qiita/markdown/filters/footnote"
 require "qiita/markdown/filters/greenmat"
 require "qiita/markdown/filters/group_mention"
 require "qiita/markdown/filters/image_link"
+require "qiita/markdown/filters/inline_code_color"
 require "qiita/markdown/filters/mention"
 require "qiita/markdown/filters/simplify"
 require "qiita/markdown/filters/syntax_highlight"

data/lib/qiita/markdown/filters/{code.rb → code_block.rb}

@@ -12,7 +12,7 @@ module Qiita
       # 3. Adds detected code data into `result[:codes]`.
       #
       # You can pass language aliases table via context[:language_aliases].
-      class Code < HTML::Pipeline::Filter
+      class CodeBlock < HTML::Pipeline::Filter
         def call
           result[:codes] ||= []
           doc.search("pre").each do |pre|

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

@@ -85,6 +85,9 @@ module Qiita
               "src",
               "type",
             ],
+            "span" => [
+              "style",
+            ],
             "td" => [
               "style",
             ],
@@ -129,6 +132,7 @@ module Qiita
           css: {
             properties: [
               "text-align",
+              "background-color",
             ],
           },
           elements: [

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

@@ -0,0 +1,43 @@
+module Qiita
+  module Markdown
+    module Filters
+      class InlineCodeColor < HTML::Pipeline::Filter
+        DEFAULT_CLASS_NAME = "inline-code-color".freeze
+
+        REGEXPS = Regexp.union(
+          /\#(?:\h{3}|\h{6})/,
+          /rgba?\(\s*(?:\d+(?:\,|\s)\s*){2}\d+\s*\)/,
+          /rgba?\(\s*(?:\d+%(?:\,|\s)\s*){2}\d+%\s*\)/,
+          /rgba?\(\s*(?:\d+\,\s*){3}\d*\.?\d+%?\s*\)/,
+          /rgba?\(\s*(?:\d+\s*){2}\d+\s*\/\s*\d?\.?\d+%?\s*\)/,
+          /rgba?\(\s*(?:\d+%\s*){2}\d+%\s*\/\s*\d?\.?\d+%?\s*\)/,
+          /hsla?\(\s*\d+(?:deg|rad|grad|turn)?\,\s*\d+%\,\s*\d+%\s*\)/,
+          /hsla?\(\s*\d+(?:deg|rad|grad|turn)?\s+\d+%\s+\d+%\s*\)/,
+          /hsla?\(\s*\d+(?:deg|rad|grad|turn)?\,\s*(?:\d+%\,\s*){2}\d?\.?\d+%?\s*\)/,
+          /hsla?\(\s*\d+(?:deg|rad|grad|turn)?\s+\d+%\s+\d+%\s*\/\s*\d?\.?\d+%?\s*\)/,
+        )
+
+        COLOR_CODE_PATTERN = /\A\s*(#{REGEXPS})\s*\z/
+
+        def call
+          doc.search(".//code").each do |node|
+            if (color = node.inner_text) =~ COLOR_CODE_PATTERN
+              node.add_child(color_element(color.strip))
+            end
+          end
+          doc
+        end
+
+        private
+
+        def color_element(color)
+          %(<span class=#{inline_code_color_class_name} style="background-color: #{color};"></span>)
+        end
+
+        def inline_code_color_class_name
+          context[:inline_code_color_class_name] || DEFAULT_CLASS_NAME
+        end
+      end
+    end
+  end
+end

data/lib/qiita/markdown/processor.rb

@@ -13,7 +13,7 @@ module Qiita
           Filters::UserInputSanitizer,
           Filters::ImageLink,
           Filters::Footnote,
-          Filters::Code,
+          Filters::CodeBlock,
           Filters::Checkbox,
           Filters::Toc,
           Filters::Emoji,
@@ -21,6 +21,7 @@ module Qiita
           Filters::Mention,
           Filters::GroupMention,
           Filters::ExternalLink,
+          Filters::InlineCodeColor,
           Filters::FinalSanitizer,
         ]
       end

data/lib/qiita/markdown/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Markdown
-    VERSION = "0.20.1"
+    VERSION = "0.21.0"
   end
 end

data/spec/qiita/markdown/filters/inline_code_color_spec.rb

@@ -0,0 +1,205 @@
+describe Qiita::Markdown::Filters::InlineCodeColor do
+  subject(:filter) do
+    described_class.new(html)
+  end
+
+  let(:html) do
+    "<p><code>#{color}</code></p>"
+  end
+
+  shared_examples "adds span element for its color" do |color|
+    let(:color) { color }
+
+    it "adds span element for its color" do
+      expect(filter.call.to_s).to eq(%(<p><code>#{color}<span class="inline-code-color" style="background-color: #{color};"></span></code></p>))
+    end
+  end
+
+  shared_examples "does not add span element" do |color|
+    let(:color) { color }
+
+    it "does not add span element" do
+      expect(filter.call.to_s).to eq(%(<p><code>#{color}</code></p>))
+    end
+  end
+
+  context "when contents of code is hexadecimal color" do
+    %w[
+      #000
+      #f03
+      #F03
+      #fff
+      #FFF
+      #000000
+      #ff0033
+      #FF0033
+      #ffffff
+      #FFFFFF
+    ].each do |color|
+      context "when contents of code is #{color}" do
+        include_examples "adds span element for its color", color
+      end
+    end
+  end
+
+  context "when contents of code is not hexadecimal color" do
+    %w[
+      #-1-1-1
+      #ggg
+      #GGG
+      #gggggg
+      #gggGGG
+      #GGGGGG
+    ].each do |color|
+      context "when contents of code is #{color}" do
+        include_examples "does not add span element", color
+      end
+    end
+  end
+
+  context "when contents of code is rgb color" do
+    [
+      "rgb(255,0,51)",
+      "rgb(255, 0, 51)",
+      "rgb(100%,0%,20%)",
+      "rgb(100%, 0%, 20%)",
+      "rgb(255,0,0,0.4)",
+      "rgb(255, 0, 0, 0.4)",
+      "rgb(255,0,0,.4)",
+      "rgb(255, 0, 0, .4)",
+      "rgb(255,0,0,40%)",
+      "rgb(255, 0, 0, 40%)",
+      "rgb(255 0 0/0.4)",
+      "rgb(255 0 0 / 0.4)",
+      "rgb(255 0 0/.4)",
+      "rgb(255 0 0 / .4)",
+      "rgb(255 0 0/40%)",
+      "rgb(255 0 0 / 40%)",
+    ].each do |color|
+      context "when contents of code is #{color}" do
+        include_examples "adds span element for its color", color
+      end
+    end
+  end
+
+  context "when contents of code is not rgb color" do
+    [
+      "rgb(0)",
+      "rgb(0, 0)",
+      "rgb(0, 0, 0%)",
+      "rgb(0, 0, 0, 0, 0)",
+    ].each do |color|
+      context "when contents of code is #{color}" do
+        include_examples "does not add span element", color
+      end
+    end
+  end
+
+  context "when contents of code is rgba color" do
+    [
+      "rgba(255,0,0,0)",
+      "rgba(255, 0, 0, 0)",
+      "rgba(255,0,0,0.1)",
+      "rgba(255, 0, 0, 0.1)",
+      "rgba(255,0,0,.4)",
+      "rgba(255, 0, 0, .4)",
+      "rgba(255,0,0,1)",
+      "rgba(255, 0, 0, 1)",
+      "rgba(255 0 0/0.4)",
+      "rgba(255 0 0 / 0.4)",
+      "rgba(255 0 0/.4)",
+      "rgba(255 0 0 / .4)",
+      "rgba(255 0 0/40%)",
+      "rgba(255 0 0 / 40%)",
+    ].each do |color|
+      context "when contents of code is #{color}" do
+        include_examples "adds span element for its color", color
+      end
+    end
+  end
+
+  context "when contents of code is not rgba color" do
+    [
+      "rgba(0)",
+      "rgba(0, 0)",
+      "rgba(0, 0, 0%)",
+      "rgba(0, 0, 0, 0, 0)",
+    ].each do |color|
+      context "when contents of code is #{color}" do
+        include_examples "does not add span element", color
+      end
+    end
+  end
+
+  context "when contents of code is hsl color" do
+    [
+      "hsl(0,100%,50%)",
+      "hsl(0, 100%, 50%)",
+      "hsl(360,100%,50%)",
+      "hsl(360, 100%, 50%)",
+      "hsl(120 60% 70%)",
+      "hsl(120deg 60% 70%)",
+      "hsl(240,100%,50%,0.05)",
+      "hsl(240, 100%, 50%, 0.05)",
+      "hsl(240,100%,50%,.05)",
+      "hsl(240, 100%, 50%, .05)",
+      "hsl(240,100%,50%,5%)",
+      "hsl(240, 100%, 50%, 5%)",
+      "hsl(240 100% 50%/0.05)",
+      "hsl(240 100% 50% / 0.05)",
+      "hsl(240 100% 50%/.05)",
+      "hsl(240 100% 50% / .05)",
+      "hsl(240 100% 50%/5%)",
+      "hsl(240 100% 50% / 5%)",
+    ].each do |color|
+      context "when contents of code is #{color}" do
+        include_examples "adds span element for its color", color
+      end
+    end
+  end
+
+  context "when contents of code is not hsl color" do
+    [
+      "hsl(0)",
+      "hsl(0, 0)",
+      "hsl(0, 0, 0)",
+      "hsl(0, 0, 0, 0)",
+    ].each do |color|
+      context "when contents of code is #{color}" do
+        include_examples "does not add span element", color
+      end
+    end
+  end
+
+  context "when contents of code is hsla color" do
+    [
+      "hsla(240,100%,50%,0.05)",
+      "hsla(240, 100%, 50%, 0.05)",
+      "hsla(240,100%,50%,.05)",
+      "hsla(240, 100%, 50%, .05)",
+      "hsla(240 100% 50%/0.05)",
+      "hsla(240 100% 50% / 0.05)",
+      "hsla(240 100% 50%/5%)",
+      "hsla(240 100% 50% / 5%)",
+      "hsla(240deg 100% 50% / 5%)",
+      "hsla(240deg,100%,50%, 0.4)",
+    ].each do |color|
+      context "when contents of code is #{color}" do
+        include_examples "adds span element for its color", color
+      end
+    end
+
+    context "when contents of code is not hsla color" do
+      [
+        "hsla(0)",
+        "hsla(0, 0)",
+        "hsla(0, 0, 0)",
+        "hsla(0, 0, 0, 0)",
+      ].each do |color|
+        context "when contents of code is #{color}" do
+          include_examples "does not add span element", color
+        end
+      end
+    end
+  end
+end

data/spec/qiita/markdown/processor_spec.rb

@@ -971,6 +971,66 @@ describe Qiita::Markdown::Processor do
           should eq "<blockquote>\n<p>foo</p>\n</blockquote>\n"
         end
       end
+
+      context "with inline code containing hexadecimal color only" do
+        let(:markdown) do
+          "`#FF0000`"
+        end
+
+        it "returns code element with its color" do
+          should eq "<p><code>#FF0000<span class=\"inline-code-color\" style=\"background-color: #FF0000;\"></span></code></p>\n"
+        end
+
+        context "with class name of inline code color parameter" do
+          let(:context) do
+            super().merge(inline_code_color_class_name: "qiita-inline-code-color")
+          end
+
+          it "returns returns code element with its color whose class name is parameter value" do
+            should eq "<p><code>#FF0000<span class=\"qiita-inline-code-color\" style=\"background-color: #FF0000;\"></span></code></p>\n"
+          end
+        end
+      end
+
+      context "with inline code containing rgb color only" do
+        let(:markdown) do
+          "`rgb(255, 0, 0)`"
+        end
+
+        it "returns code element with its color" do
+          should eq "<p><code>rgb(255, 0, 0)<span class=\"inline-code-color\" style=\"background-color: rgb(255, 0, 0);\"></span></code></p>\n"
+        end
+
+        context "with class name of inline code color parameter" do
+          let(:context) do
+            super().merge(inline_code_color_class_name: "qiita-inline-code-color")
+          end
+
+          it "returns returns code element with its color whose class name is parameter value" do
+            should eq "<p><code>rgb(255, 0, 0)<span class=\"qiita-inline-code-color\" style=\"background-color: rgb(255, 0, 0);\"></span></code></p>\n"
+          end
+        end
+      end
+
+      context "with inline code containing hsl color only" do
+        let(:markdown) do
+          "`hsl(0, 100%, 50%)`"
+        end
+
+        it "returns code element with its color" do
+          should eq "<p><code>hsl(0, 100%, 50%)<span class=\"inline-code-color\" style=\"background-color: hsl(0, 100%, 50%);\"></span></code></p>\n"
+        end
+
+        context "with class name of inline code color parameter" do
+          let(:context) do
+            super().merge(inline_code_color_class_name: "qiita-inline-code-color")
+          end
+
+          it "returns returns code element with its color whose class name is parameter value" do
+            should eq "<p><code>hsl(0, 100%, 50%)<span class=\"qiita-inline-code-color\" style=\"background-color: hsl(0, 100%, 50%);\"></span></code></p>\n"
+          end
+        end
+      end
     end
 
     shared_examples_for "script element" do |allowed:|
@@ -1190,6 +1250,24 @@ describe Qiita::Markdown::Processor do
       end
     end
 
+    shared_examples_for "background-color" do |allowed:|
+      context "with style attribute" do
+        let(:markdown) do
+          "<span style=\"background-color: #000000\"></span>"
+        end
+
+        if allowed
+          it "does not sanitize span element" do
+            should eq "<p><span style=\"background-color: #000000\"></span></p>\n"
+          end
+        else
+          it "sanitizes span element" do
+            should eq "<p></p>\n"
+          end
+        end
+      end
+    end
+
     context "without script and strict context" do
       let(:context) do
         super().merge(script: false, strict: false)
@@ -1202,6 +1280,7 @@ describe Qiita::Markdown::Processor do
       include_examples "input element", allowed: true
       include_examples "data-attributes", allowed: false
       include_examples "class attribute", allowed: true
+      include_examples "background-color", allowed: true
     end
 
     context "with script context" do
@@ -1216,6 +1295,7 @@ describe Qiita::Markdown::Processor do
       include_examples "input element", allowed: true
       include_examples "data-attributes", allowed: true
       include_examples "class attribute", allowed: true
+      include_examples "background-color", allowed: true
     end
 
     context "with strict context" do
@@ -1230,6 +1310,7 @@ describe Qiita::Markdown::Processor do
       include_examples "input element", allowed: false
       include_examples "data-attributes", allowed: false
       include_examples "class attribute", allowed: false
+      include_examples "background-color", allowed: false
     end
 
     context "with script and strict context" do
@@ -1244,6 +1325,7 @@ describe Qiita::Markdown::Processor do
       include_examples "input element", allowed: false
       include_examples "data-attributes", allowed: false
       include_examples "class attribute", allowed: false
+      include_examples "background-color", allowed: false
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.21.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2017-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemoji
@@ -257,7 +257,7 @@ files:
 - 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/code_block.rb
 - lib/qiita/markdown/filters/emoji.rb
 - lib/qiita/markdown/filters/external_link.rb
 - lib/qiita/markdown/filters/final_sanitizer.rb
@@ -265,6 +265,7 @@ files:
 - lib/qiita/markdown/filters/greenmat.rb
 - lib/qiita/markdown/filters/group_mention.rb
 - lib/qiita/markdown/filters/image_link.rb
+- lib/qiita/markdown/filters/inline_code_color.rb
 - lib/qiita/markdown/filters/mention.rb
 - lib/qiita/markdown/filters/simplify.rb
 - lib/qiita/markdown/filters/syntax_highlight.rb
@@ -279,6 +280,7 @@ files:
 - lib/qiita/markdown/version.rb
 - qiita-markdown.gemspec
 - spec/qiita/markdown/filters/greenmat_spec.rb
+- spec/qiita/markdown/filters/inline_code_color_spec.rb
 - spec/qiita/markdown/greenmat/html_toc_renderer_spec.rb
 - spec/qiita/markdown/processor_spec.rb
 - spec/qiita/markdown/summary_processor_spec.rb
@@ -309,6 +311,7 @@ specification_version: 4
 summary: Qiita-specified markdown processor.
 test_files:
 - spec/qiita/markdown/filters/greenmat_spec.rb
+- spec/qiita/markdown/filters/inline_code_color_spec.rb
 - spec/qiita/markdown/greenmat/html_toc_renderer_spec.rb
 - spec/qiita/markdown/processor_spec.rb
 - spec/qiita/markdown/summary_processor_spec.rb