qiita-markdown 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cb932dbc04905b9bb5693e8121d7b093cddda21af4c7de50783f4612e31e952
-  data.tar.gz: 2978a8d6dcf25ffb824e34627e46cb4f51050a6c266028702d38c847ae001b53
+  metadata.gz: 7a030fef1d6e7c96945f3f3f32039906074ed0d7ca7773b857939740c2bbe2c1
+  data.tar.gz: 1fb0ec10eb4849a69f49942565b6fd2250c1548244267f3a29643f8a3558a3b7
 SHA512:
-  metadata.gz: b4c8394799c7da3685a1e520d0f6d172ce76f715038424acef1f73ab9f2c84188ed091a5cccd60ed82da38afb23c416ee95a9282ac6b4394e5102c9b6d2db23f
-  data.tar.gz: ff8ed533fb59242c8e8e31d4598faa4826e5369dd12437f4e67535c1ebf6468b8b3e0a2c18ad0a388a82fd43fc8348ce46743f69b7f62b1cbca6364db61c3388
+  metadata.gz: 7955e98dd0f03db994cd7e04060269aed6763bb17bf1742064098f193b53f22d0866a36cc1d18ac95502c667f807e7966a29144035e254d45578ca374a63cc6d
+  data.tar.gz: 7ef8f9c22b7159da5e02cf9366584d39cd375dafb6666dc364de22f204b724f391fecd3f16793388f2c090354204ef8cb6d6fc1f37282cf3abb4b11baa67b378

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
 
+## 1.6.0
+
+- Support for a new inline math syntax
+
 ## 1.5.0
 
 - Accept new figma script host (embed.figma.com)

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Qiita
+  module Markdown
+    module Filters
+      class InlineMath < HTML::Pipeline::Filter
+        def call
+          doc.search(".//code").each do |code|
+            opening = code.previous
+            closing = code.next
+            replace_with_math_span(code, opening, closing) if inline_math_code?(opening, closing)
+          end
+
+          doc
+        end
+
+        private
+
+        def inline_math_code?(opening, closing)
+          opening.present? && closing.present? && valid_opening?(opening) && valid_closing?(closing)
+        end
+
+        def valid_opening?(opening)
+          opening.text? && opening.content.end_with?("$") && !opening.content.end_with?("$$")
+        end
+
+        def valid_closing?(closing)
+          closing.text? && closing.content.start_with?("$") && !closing.content.start_with?("$$")
+        end
+
+        def replace_with_math_span(code, opening, closing)
+          span = Nokogiri::XML::Node.new("span", doc)
+          span.add_child(Nokogiri::XML::Text.new("$#{code.text}$", doc))
+          code.replace(span)
+          opening.content = opening.content.delete_suffix("$")
+          opening.remove if opening.content.empty?
+          closing.content = closing.content.delete_prefix("$")
+          closing.remove if closing.content.empty?
+        end
+      end
+    end
+  end
+end

data/lib/qiita/markdown/processor.rb

@@ -24,6 +24,7 @@ module Qiita
           Filters::GroupMention,
           Filters::ExternalLink,
           Filters::InlineCodeColor,
+          Filters::InlineMath,
           Filters::FinalSanitizer,
         ]
       end

data/lib/qiita/markdown/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Markdown
-    VERSION = "1.5.0"
+    VERSION = "1.6.0"
   end
 end

data/lib/qiita/markdown.rb

@@ -36,6 +36,7 @@ require "qiita/markdown/filters/heading_anchor"
 require "qiita/markdown/filters/html_toc"
 require "qiita/markdown/filters/image_link"
 require "qiita/markdown/filters/inline_code_color"
+require "qiita/markdown/filters/inline_math"
 require "qiita/markdown/filters/mention"
 require "qiita/markdown/filters/qiita_marker"
 require "qiita/markdown/filters/simplify"

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+describe Qiita::Markdown::Filters::InlineMath do
+  subject(:filter) do
+    described_class.new(html)
+  end
+
+  context "with dollar signs" do
+    let(:html) do
+      <<~HTML
+        <div>
+          $<code>A = B</code>$
+        </div>
+      HTML
+    end
+
+    it "replaces <code> to <span> with dollars" do
+      expect(filter.call.to_html).to eq(
+        <<~HTML,
+          <div>
+            <span>$A = B$</span>
+          </div>
+        HTML
+      )
+    end
+  end
+
+  context "with dollar signs with surrounding text" do
+    let(:html) do
+      <<~HTML
+        <div>
+          Some text before$<code>A = B</code>$Some text after
+        </div>
+      HTML
+    end
+
+    it "replaces <code> to <span> with dollars" do
+      expect(filter.call.to_html).to eq(
+        <<~HTML,
+          <div>
+            Some text before<span>$A = B$</span>Some text after
+          </div>
+        HTML
+      )
+    end
+  end
+
+  context "with double dollar signs" do
+    let(:html) do
+      <<~HTML
+        <div>
+          $$
+          <code>A = B</code>
+          $$
+        </div>
+      HTML
+    end
+
+    it "does not replace <code>" do
+      expect(filter.call.to_html).to eq(html)
+    end
+  end
+
+  context "without dollar signs" do
+    let(:html) do
+      <<~HTML
+        <div>
+          <code>A = B</code>
+        </div>
+      HTML
+    end
+
+    it "does not replace <code>" do
+      expect(filter.call.to_html).to eq(html)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -167,6 +167,7 @@ files:
 - lib/qiita/markdown/filters/html_toc.rb
 - lib/qiita/markdown/filters/image_link.rb
 - lib/qiita/markdown/filters/inline_code_color.rb
+- lib/qiita/markdown/filters/inline_math.rb
 - lib/qiita/markdown/filters/mention.rb
 - lib/qiita/markdown/filters/qiita_marker.rb
 - lib/qiita/markdown/filters/simplify.rb
@@ -187,6 +188,7 @@ files:
 - spec/qiita/markdown/filters/heading_anchor_spec.rb
 - spec/qiita/markdown/filters/html_toc_spec.rb
 - spec/qiita/markdown/filters/inline_code_color_spec.rb
+- spec/qiita/markdown/filters/inline_math_spec.rb
 - spec/qiita/markdown/filters/qiita_marker_spec.rb
 - spec/qiita/markdown/processor_spec.rb
 - spec/qiita/markdown/summary_processor_spec.rb