qiita-markdown 0.35.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23da6f6f9b37dafcbe18164c13d4531998cfca14e0891801b4e8a1fdab6d625c
-  data.tar.gz: 620e9a413d9d0649511a883d40c4a398260f739a2c01774645d1e717421d54f5
+  metadata.gz: c87f030f51598557770e12094601817c916a8e468cd030aeead44855b982dd14
+  data.tar.gz: 93a458246834fe89530ae20396dbffc98436be494331df2505359727e4fea92d
 SHA512:
-  metadata.gz: f2cfa06b888dd9e08a22a88b822a7a280afec1289c1f9f3833c64692e37edc3b637c26739ab1f607c2e4cab1da1559510bc7a63836e462dc3c4dcc81f4da8343
-  data.tar.gz: 125ff10aa432f848e8c790f497f2467f1f825431b1cdeed1a085f14da230fdc5800c752a64b86f90d5e4acf36fc4f4c8b9e2efd30f808cee6ac713b32ffc0b01
+  metadata.gz: c94ef6737d7881c6ab6ebb7078eb9b24be05d3804362cdde38d37f16397cb2a635f1b1d7a215d61e57effa0f1043eb2c6f901d70dff6b70ae2595e2c446208e0
+  data.tar.gz: 7e8941da6683eb93716e05ecb89528b6208ceac2f02107c43aa3792ff6ddc302ed0fba27a7bf8a0cd488e8c66e27dc53a7c6432981e7c9b7961e24c41094cee3

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Unreleased
 
+## 0.36.0
+- Support message notation
+
 ## 0.35.0
 
 - Allow Relative URL in iframe src attributes

data/lib/qiita/markdown.rb

@@ -20,6 +20,7 @@ require "qiita/markdown/transformers/filter_iframe"
 require "qiita/markdown/transformers/strip_invalid_node"
 require "qiita/markdown/filters/checkbox"
 require "qiita/markdown/filters/code_block"
+require "qiita/markdown/filters/custom_block"
 require "qiita/markdown/filters/emoji"
 require "qiita/markdown/filters/external_link"
 require "qiita/markdown/filters/final_sanitizer"

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

@@ -0,0 +1,63 @@
+module Qiita
+  module Markdown
+    module Filters
+      class CustomBlock < HTML::Pipeline::Filter
+        ALLOWED_TYPES = %(message).freeze
+
+        def call
+          doc.search('div[data-type="customblock"]').each do |div|
+            metadata = Metadata.new(div["data-metadata"])
+            next unless ALLOWED_TYPES.include?(metadata.type)
+            klass = Object.const_get("#{self.class}::#{metadata.type.capitalize}")
+            klass.new(div, metadata.subtype).convert
+          end
+          doc
+        end
+
+        class Metadata
+          attr_reader :type, :subtype
+
+          # @param text [String, nil]
+          def initialize(text)
+            # Discared after the second word.
+            @type, @subtype = text.split(" ")
+          end
+        end
+
+        class Message
+          attr_reader :node, :type
+
+          ALLOWED_TYPES = %w[info warn alert].freeze
+          DEFAULT_TYPE = "info".freeze
+
+          # @param node [Nokogiri::XML::Node]
+          # @param type [String, nil]
+          def initialize(node, type)
+            @node = node
+            @type = ALLOWED_TYPES.include?(type) ? type : DEFAULT_TYPE
+          end
+
+          def convert
+            node.inner_html = message
+            node["class"] = "message #{type}"
+            node.children.first.add_previous_sibling(icon) if icon
+          end
+
+          private
+
+          def message
+            "<p>#{node.text}</p>"
+          end
+
+          def icon
+            {
+              info: %(<span class="fa fa-fw fa-check-circle"></span>),
+              warn: %(<span class="fa fa-fw fa-exclamation-circle"></span>),
+              alert: %(<span class="fa fa-fw fa-times-circle"></span>),
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -20,6 +20,7 @@ module Qiita
             Qiita::Markdown::Greenmat::HTMLRenderer.new(hard_wrap: true, with_toc_data: true),
             autolink: true,
             fenced_code_blocks: true,
+            fenced_custom_blocks: true,
             footnotes: options[:footnotes],
             no_intra_emphasis: true,
             no_mention_emphasis: true,

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

@@ -13,7 +13,7 @@ module Qiita
             "a"          => %w[class href rel title],
             "blockquote" => %w[cite] + Embed::Tweet::ATTRIBUTES,
             "code"       => %w[data-metadata],
-            "div"        => %w[class],
+            "div"        => %w[class data-type data-metadata],
             "font"       => %w[color],
             "h1"         => %w[id],
             "h2"         => %w[id],

data/lib/qiita/markdown/processor.rb

@@ -14,6 +14,7 @@ module Qiita
           Filters::ImageLink,
           Filters::Footnote,
           Filters::CodeBlock,
+          Filters::CustomBlock,
           Filters::Checkbox,
           Filters::Toc,
           Filters::Emoji,

data/lib/qiita/markdown/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Markdown
-    VERSION = "0.35.0"
+    VERSION = "0.36.0"
   end
 end

data/qiita-markdown.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "html-pipeline", "~> 2.0"
   spec.add_dependency "mem"
   spec.add_dependency "pygments.rb", "~> 1.0"
-  spec.add_dependency "greenmat", "3.5.1.1"
+  spec.add_dependency "greenmat", "3.5.1.2"
   spec.add_dependency "sanitize"
   spec.add_dependency "addressable"
   spec.add_development_dependency "activesupport", "4.2.6"

data/spec/qiita/markdown/processor_spec.rb

@@ -1677,6 +1677,115 @@ describe Qiita::Markdown::Processor do
       end
     end
 
+    shared_examples_for "custom block" do |allowed:|
+      context "with custom block" do
+        let(:type) { "" }
+        let(:subtype) { "" }
+
+        let(:markdown) do
+          <<-MARKDOWN.strip_heredoc
+            :::#{[type, subtype].join(' ').rstrip}
+            Some kind of text is here.
+            :::
+          MARKDOWN
+        end
+
+        context "when type is not allowed" do
+          let(:type) { "anytype" }
+
+          if allowed
+            it "returns simple div element" do
+              should eq <<-HTML.strip_heredoc
+                <div data-type="customblock" data-metadata="anytype">Some kind of text is here.
+                </div>
+              HTML
+            end
+          else
+            it "returns simple div element" do
+              should eq <<-HTML.strip_heredoc
+                <div>Some kind of text is here.
+                </div>
+              HTML
+            end
+          end
+        end
+
+        context "when type is message" do
+          let(:type) { "message" }
+
+          context "when subtype is empty" do
+            if allowed
+              it "returns info message block with class including icon as default type" do
+                should eq <<-HTML.strip_heredoc
+                  <div data-type="customblock" data-metadata="message" class="message info">
+                  <span class="fa fa-fw fa-check-circle"></span><p>Some kind of text is here.
+                  </p>
+                  </div>
+                HTML
+              end
+            else
+              it "returns message block with class including icon" do
+                should eq <<-HTML.strip_heredoc
+                  <div class="message info">
+                  <span class="fa fa-fw fa-check-circle"></span><p>Some kind of text is here.
+                  </p>
+                  </div>
+                HTML
+              end
+            end
+          end
+
+          context "when subtype is warn" do
+            let(:subtype) { "warn" }
+
+            if allowed
+              it "returns warning message block with class including icon" do
+                should eq <<-HTML.strip_heredoc
+                  <div data-type="customblock" data-metadata="message warn" class="message warn">
+                  <span class="fa fa-fw fa-exclamation-circle"></span><p>Some kind of text is here.
+                  </p>
+                  </div>
+                HTML
+              end
+            else
+              it "returns message block with class including icon" do
+                should eq <<-HTML.strip_heredoc
+                  <div class="message warn">
+                  <span class="fa fa-fw fa-exclamation-circle"></span><p>Some kind of text is here.
+                  </p>
+                  </div>
+                HTML
+              end
+            end
+          end
+
+          context "when subtype is alert" do
+            let(:subtype) { "alert" }
+
+            if allowed
+              it "returns alerting message block with class including icon" do
+                should eq <<-HTML.strip_heredoc
+                  <div data-type="customblock" data-metadata="message alert" class="message alert">
+                  <span class="fa fa-fw fa-times-circle"></span><p>Some kind of text is here.
+                  </p>
+                  </div>
+                HTML
+              end
+            else
+              it "returns message block with class including icon" do
+                should eq <<-HTML.strip_heredoc
+                  <div class="message alert">
+                  <span class="fa fa-fw fa-times-circle"></span><p>Some kind of text is here.
+                  </p>
+                  </div>
+                HTML
+              end
+            end
+          end
+        end
+      end
+    end
+
     context "without script and strict context" do
       let(:context) do
         super().merge(script: false, strict: false)
@@ -1691,6 +1800,7 @@ describe Qiita::Markdown::Processor do
       include_examples "class attribute", allowed: true
       include_examples "background-color", allowed: true
       include_examples "override embed code attributes", allowed: false
+      include_examples "custom block", allowed: false
     end
 
     context "with script context" do
@@ -1707,6 +1817,7 @@ describe Qiita::Markdown::Processor do
       include_examples "class attribute", allowed: true
       include_examples "background-color", allowed: true
       include_examples "override embed code attributes", allowed: true
+      include_examples "custom block", allowed: true
     end
 
     context "with strict context" do
@@ -1723,6 +1834,7 @@ describe Qiita::Markdown::Processor do
       include_examples "class attribute", allowed: false
       include_examples "background-color", allowed: false
       include_examples "override embed code attributes", allowed: false
+      include_examples "custom block", allowed: false
     end
 
     context "with script and strict context" do
@@ -1739,6 +1851,7 @@ describe Qiita::Markdown::Processor do
       include_examples "class attribute", allowed: false
       include_examples "background-color", allowed: false
       include_examples "override embed code attributes", allowed: false
+      include_examples "custom block", allowed: true
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.36.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-05 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemoji
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.1.1
+        version: 3.5.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.1.1
+        version: 3.5.1.2
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
@@ -265,6 +265,7 @@ files:
 - lib/qiita/markdown/embed/youtube.rb
 - lib/qiita/markdown/filters/checkbox.rb
 - lib/qiita/markdown/filters/code_block.rb
+- lib/qiita/markdown/filters/custom_block.rb
 - lib/qiita/markdown/filters/emoji.rb
 - lib/qiita/markdown/filters/external_link.rb
 - lib/qiita/markdown/filters/final_sanitizer.rb
@@ -315,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Qiita-specified markdown processor.