qiita-markdown 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cb932dbc04905b9bb5693e8121d7b093cddda21af4c7de50783f4612e31e952
-  data.tar.gz: 2978a8d6dcf25ffb824e34627e46cb4f51050a6c266028702d38c847ae001b53
+  metadata.gz: 82135467b0d5d3bf73ec7e94d45f1cb48507eab15bcf0624f14d6cd33ee7b3df
+  data.tar.gz: 31ebd2cb70c3f3c9e632c49ea3baeb8dff5d869e9ecb3aac8051158054bccef7
 SHA512:
-  metadata.gz: b4c8394799c7da3685a1e520d0f6d172ce76f715038424acef1f73ab9f2c84188ed091a5cccd60ed82da38afb23c416ee95a9282ac6b4394e5102c9b6d2db23f
-  data.tar.gz: ff8ed533fb59242c8e8e31d4598faa4826e5369dd12437f4e67535c1ebf6468b8b3e0a2c18ad0a388a82fd43fc8348ce46743f69b7f62b1cbca6364db61c3388
+  metadata.gz: ce417c195faa1b52f8cb70f81a654efc5bacda6338aedff1e3a9601cb4b210280a25aa7a763a3fb59f229ac767659b5fcc31b8673e2199a35fbad583cfab69eb
+  data.tar.gz: bc58fbba5f0e8a56ebeed5b97b4f1c97f5fe6c91526aeccdd104b43cc02e7f0d850a4a26ce2b7b558382f4910da5a1da2e139d13f2c9a09ad32a38fdc940764e

data/.github/dependabot.yml

@@ -10,6 +10,8 @@ updates:
       timezone: "Asia/Tokyo"
     open-pull-requests-limit: 5
     rebase-strategy: "disabled"
+    cooldown:
+      default-days: 7
 
   - package-ecosystem: "github-actions"
     directories:
@@ -20,3 +22,5 @@ updates:
       timezone: "Asia/Tokyo"
     open-pull-requests-limit: 5
     rebase-strategy: "disabled"
+    cooldown:
+      default-days: 7

data/.github/workflows/test.yml

@@ -32,3 +32,18 @@ jobs:
           bundler-cache: true
       - name: Test
         run: bundle exec rake
+
+  qlty:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb # v1.244.0
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+      - name: Test
+        run: bundle exec rake
+      - uses: qltysh/qlty-action/coverage@a19242102d17e497f437d7466aa01b528537e899 # v2.2.0
+        with:
+          token: ${{secrets.QLTY_COVERAGE_TOKEN}}
+          files: ./coverage/coverage.json

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Unreleased
 
+## 1.6.1
+
+- Add a dependency on the uri gem to use version 1.0.4 or higher.
+
+## 1.6.0
+
+- Support for a new inline math syntax
+
 ## 1.5.0
 
 - Accept new figma script host (embed.figma.com)

data/Gemfile

@@ -10,3 +10,4 @@ gem "rake"
 gem "rspec", "~> 3.1"
 gem "rubocop", "~> 1.76.0"
 gem "simplecov", "!= 0.18.0", "!= 0.18.1", "!= 0.18.2", "!= 0.18.3", "!= 0.18.4", "!= 0.18.5", "!= 0.19.0", "!= 0.19.1"
+gem "simplecov_json_formatter"

data/README.md

@@ -2,6 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/qiita-markdown.svg)](https://badge.fury.io/rb/qiita-markdown)
 [![Build Status](https://travis-ci.org/increments/qiita-markdown.svg)](https://travis-ci.org/increments/qiita-markdown)
+[![Maintainability](https://qlty.sh/gh/increments/projects/qiita-markdown/maintainability.svg)](https://qlty.sh/gh/increments/projects/qiita-markdown)
+[![Code Coverage](https://qlty.sh/gh/increments/projects/qiita-markdown/coverage.svg)](https://qlty.sh/gh/increments/projects/qiita-markdown)
 
 Qiita-specified markdown processor.
 

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.1"
   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/qiita-markdown.gemspec

@@ -25,5 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "qiita_marker", "~> 0.23.9"
   spec.add_dependency "rouge", "~> 4.2"
   spec.add_dependency "sanitize"
+  spec.add_dependency "uri", ">= 1.0.4"
   spec.metadata["rubygems_mfa_required"] = "true"
 end

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

data/spec/spec_helper.rb

@@ -1,6 +1,14 @@
 if ENV["CI"]
   require "simplecov"
-  SimpleCov.start
+  require "simplecov_json_formatter"
+  SimpleCov.start do
+    SimpleCov.formatters = [
+      SimpleCov::Formatter::JSONFormatter,
+      SimpleCov::Formatter::HTMLFormatter,
+    ]
+
+    add_filter "/spec/"
+  end
 end
 
 require "qiita-markdown"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -121,6 +121,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
 email:
 - r7kamura@gmail.com
 executables: []
@@ -167,6 +181,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 +202,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