qiita-markdown 0.35.0 → 0.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23da6f6f9b37dafcbe18164c13d4531998cfca14e0891801b4e8a1fdab6d625c
-  data.tar.gz: 620e9a413d9d0649511a883d40c4a398260f739a2c01774645d1e717421d54f5
+  metadata.gz: fdacf171e87076c382a0a48c3470a46e7334965d3818a7b4041c8bd6d2a9af6c
+  data.tar.gz: e97066c81cca4c192b97de5956e6e7615a3946bcf5e3790d04d00908829a16f7
 SHA512:
-  metadata.gz: f2cfa06b888dd9e08a22a88b822a7a280afec1289c1f9f3833c64692e37edc3b637c26739ab1f607c2e4cab1da1559510bc7a63836e462dc3c4dcc81f4da8343
-  data.tar.gz: 125ff10aa432f848e8c790f497f2467f1f825431b1cdeed1a085f14da230fdc5800c752a64b86f90d5e4acf36fc4f4c8b9e2efd30f808cee6ac713b32ffc0b01
+  metadata.gz: 10b64682c5df3911eb1674315695b9798ac34f6877f553c477a4dfe67a43bcd2a731f4bbc6f24ef52b3930aeee527bd23469c8d691c0f3ab3fcb40e294c552ea
+  data.tar.gz: 1eca7b100285a88879a580ced3f868bc620b06c1181850e6082f3ac53ef7f7263db8da514b33c315ee402511d7c83ad1a7b20cd0ed4406efe1d08f23e9e5f645

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## Unreleased
 
+## 0.39.0
+- Fix an error when custom block type is empty
+
+## 0.38.0
+- Change default syntax highlighter from pygments to rouge
+
+## 0.37.0
+- Change keyword of notation
+
+## 0.36.0
+- Support message notation
+
 ## 0.35.0
 
 - Allow Relative URL in iframe src attributes

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

@@ -0,0 +1,65 @@
+module Qiita
+  module Markdown
+    module Filters
+      class CustomBlock < HTML::Pipeline::Filter
+        ALLOWED_TYPES = %w[note].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]
+          # @note Attribute `type` will be nil if `text` is nil
+          # @note Attribute `subtype` will be nil if `text` does not include white space.
+          def initialize(text)
+            # Discared after the second word.
+            @type, @subtype = text && text.split(" ")
+          end
+        end
+
+        class Note
+          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"] = "note #{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/syntax_highlight.rb

@@ -4,6 +4,7 @@ module Qiita
       class SyntaxHighlight < HTML::Pipeline::Filter
         DEFAULT_LANGUAGE = "text"
         DEFAULT_TIMEOUT = Float::INFINITY
+        DEFAULT_OPTION = "html_legacy"
 
         def call
           elapsed = 0
@@ -79,11 +80,11 @@ module Qiita
           end
 
           def highlight(language)
-            Pygments.highlight(code, lexer: language, options: pygments_options)
+            Rouge.highlight(code, language, DEFAULT_OPTION)
           end
 
           def highlighted_node
-            if specific_language && Pygments::Lexer.find(specific_language)
+            if specific_language && Rouge::Lexer.find(specific_language)
               begin
                 highlight(specific_language).presence or raise
               rescue
@@ -102,14 +103,6 @@ module Qiita
             Nokogiri::HTML.fragment(%Q[<div class="code-frame" data-lang="#{language}"></div>])
           end
 
-          def pygments_options
-            @pygments_options ||= begin
-              options = { encoding: "utf-8", stripnl: false }
-              options[:startinline] = true if has_inline_php?
-              options
-            end
-          end
-
           def specific_language
             @specific_language || @node["lang"]
           end

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.39.0"
   end
 end

data/lib/qiita/markdown.rb

@@ -4,7 +4,7 @@ require "html/pipeline"
 require "linguist"
 require "mem"
 require "nokogiri"
-require "pygments"
+require "rouge"
 require "sanitize"
 
 require "qiita/markdown/embed/code_pen"
@@ -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/qiita-markdown.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "github-linguist", "~> 4.0"
   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 "rouge", "3.26.0"
+  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

@@ -149,8 +149,8 @@ describe Qiita::Markdown::Processor do
           should eq <<-HTML.strip_heredoc
             <div class="code-frame" data-lang="ruby">
             <div class="code-lang"><span class="bold">example.rb</span></div>
-            <div class="highlight"><pre><span></span><span class="mi">1</span>
-            </pre></div>
+            <div class="highlight"><pre class="codehilite"><code><span class="mi">1</span>
+            </code></pre></div>
             </div>
           HTML
         end
@@ -169,8 +169,8 @@ describe Qiita::Markdown::Processor do
           should eq <<-HTML.strip_heredoc
             <div class="code-frame" data-lang="php">
             <div class="code-lang"><span class="bold">example.php</span></div>
-            <div class="highlight"><pre><span></span><span class="mi">1</span>
-            </pre></div>
+            <div class="highlight"><pre class="codehilite"><code><span class="mi">1</span>
+            </code></pre></div>
             </div>
           HTML
         end
@@ -187,8 +187,8 @@ describe Qiita::Markdown::Processor do
 
         it "returns code-frame and highlighted pre element" do
           should eq <<-HTML.strip_heredoc
-            <div class="code-frame" data-lang="ruby"><div class="highlight"><pre><span></span><span class="mi">1</span>
-            </pre></div></div>
+            <div class="code-frame" data-lang="ruby"><div class="highlight"><pre class="codehilite"><code><span class="mi">1</span>
+            </code></pre></div></div>
           HTML
         end
       end
@@ -226,10 +226,10 @@ describe Qiita::Markdown::Processor do
 
         it "does not strip the newlines" do
           should eq <<-HTML.strip_heredoc
-            <div class="code-frame" data-lang="text"><div class="highlight"><pre><span></span>
+            <div class="code-frame" data-lang="text"><div class="highlight"><pre class="codehilite"><code>
             foo
 
-            </pre></div></div>
+            </code></pre></div></div>
            HTML
         end
       end
@@ -311,8 +311,8 @@ describe Qiita::Markdown::Processor do
           should include(<<-HTML.strip_heredoc.rstrip)
             <div class="code-frame" data-lang="ruby">
             <div class="code-lang"><span class="bold">@alice</span></div>
-            <div class="highlight"><pre><span></span><span class="mi">1</span>
-            </pre></div>
+            <div class="highlight"><pre class="codehilite"><code><span class="mi">1</span>
+            </code></pre></div>
             </div>
           HTML
         end
@@ -659,9 +659,9 @@ describe Qiita::Markdown::Processor do
 
         it "does not replace checkbox" do
           should eq <<-HTML.strip_heredoc
-            <div class="code-frame" data-lang="text"><div class="highlight"><pre><span></span>- [ ] a
+            <div class="code-frame" data-lang="text"><div class="highlight"><pre class="codehilite"><code>- [ ] a
             - [x] b
-            </pre></div></div>
+            </code></pre></div></div>
           HTML
         end
       end
@@ -768,9 +768,9 @@ describe Qiita::Markdown::Processor do
 
         it "generates only code blocks without footnotes" do
           should eq <<-HTML.strip_heredoc
-            <div class="code-frame" data-lang="text"><div class="highlight"><pre><span></span>[^1]
+            <div class="code-frame" data-lang="text"><div class="highlight"><pre class="codehilite"><code>[^1]
             [^1]: test
-            </pre></div></div>
+            </code></pre></div></div>
           HTML
         end
       end
@@ -1067,8 +1067,8 @@ describe Qiita::Markdown::Processor do
           expect(subject).to eq <<-HTML.strip_heredoc
             <p><details><summary>Folding sample</summary><div>
 
-            <div class="code-frame" data-lang="rb"><div class="highlight"><pre><span></span><span class="nb">puts</span> <span class="s2">"Hello, World"</span>
-            </pre></div></div>
+            <div class="code-frame" data-lang="rb"><div class="highlight"><pre class="codehilite"><code><span class="nb">puts</span> <span class="s2">"Hello, World"</span>
+            </code></pre></div></div>
 
             <p></p>
             </div></details></p>
@@ -1124,8 +1124,8 @@ describe Qiita::Markdown::Processor do
             should eq <<-HTML.strip_heredoc
               <div class="code-frame" data-lang="js">
               <div class="code-lang"><span class="bold">test<script>alert(1)</script></span></div>
-              <div class="highlight"><pre><span></span><span class="mi">1</span>
-              </pre></div>
+              <div class="highlight"><pre class="codehilite"><code><span class="mi">1</span>
+              </code></pre></div>
               </div>
             HTML
           end
@@ -1134,8 +1134,8 @@ describe Qiita::Markdown::Processor do
             should eq <<-HTML.strip_heredoc
               <div class="code-frame" data-lang="js">
               <div class="code-lang"><span class="bold">test</span></div>
-              <div class="highlight"><pre><span></span><span class="mi">1</span>
-              </pre></div>
+              <div class="highlight"><pre class="codehilite"><code><span class="mi">1</span>
+              </code></pre></div>
               </div>
             HTML
           end
@@ -1677,6 +1677,133 @@ 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 empty" do
+          if allowed
+            it "returns simple div element" do
+              should eq <<-HTML.strip_heredoc
+                <div data-type="customblock">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 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 note" do
+          let(:type) { "note" }
+
+          context "when subtype is empty" do
+            if allowed
+              it "returns info note block with class including icon as default type" do
+                should eq <<-HTML.strip_heredoc
+                  <div data-type="customblock" data-metadata="note" class="note info">
+                  <span class="fa fa-fw fa-check-circle"></span><p>Some kind of text is here.
+                  </p>
+                  </div>
+                HTML
+              end
+            else
+              it "returns note block with class including icon" do
+                should eq <<-HTML.strip_heredoc
+                  <div class="note 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 note block with class including icon" do
+                should eq <<-HTML.strip_heredoc
+                  <div data-type="customblock" data-metadata="note warn" class="note warn">
+                  <span class="fa fa-fw fa-exclamation-circle"></span><p>Some kind of text is here.
+                  </p>
+                  </div>
+                HTML
+              end
+            else
+              it "returns note block with class including icon" do
+                should eq <<-HTML.strip_heredoc
+                  <div class="note 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 note block with class including icon" do
+                should eq <<-HTML.strip_heredoc
+                  <div data-type="customblock" data-metadata="note alert" class="note alert">
+                  <span class="fa fa-fw fa-times-circle"></span><p>Some kind of text is here.
+                  </p>
+                  </div>
+                HTML
+              end
+            else
+              it "returns note block with class including icon" do
+                should eq <<-HTML.strip_heredoc
+                  <div class="note 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 +1818,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 +1835,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 +1852,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 +1869,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.39.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-05 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemoji
@@ -67,33 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pygments.rb
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 3.26.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 3.26.0
 - !ruby/object:Gem::Dependency
   name: greenmat
   requirement: !ruby/object:Gem::Requirement
     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.