qiita-markdown 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20dde5cbdc1d2e970bb956c7b55ad0123e00dd95b2d60e4cdafd31782278c670
-  data.tar.gz: 4943b67271e3ad7e991815e22f867281e4e603ddb5641a013335d2d26b129089
+  metadata.gz: 7a030fef1d6e7c96945f3f3f32039906074ed0d7ca7773b857939740c2bbe2c1
+  data.tar.gz: 1fb0ec10eb4849a69f49942565b6fd2250c1548244267f3a29643f8a3558a3b7
 SHA512:
-  metadata.gz: 971bb032fff9ca87fd6756a37c3dbae98229d2a8ae3363731252b7ad4d82924ee912ee817e1d8c9cd5f499983abae473485b7f33268805cdc5bcd21346a641c0
-  data.tar.gz: 8afc2a7c23fe930fd4865ff779ec4735365e565a5f09070b74b9fddb4616da613c4cfc4abc78116be759b79385ef261867275ea0f8a4f44456d282ddc3b27ce5
+  metadata.gz: 7955e98dd0f03db994cd7e04060269aed6763bb17bf1742064098f193b53f22d0866a36cc1d18ac95502c667f807e7966a29144035e254d45578ca374a63cc6d
+  data.tar.gz: 7ef8f9c22b7159da5e02cf9366584d39cd375dafb6666dc364de22f204b724f391fecd3f16793388f2c090354204ef8cb6d6fc1f37282cf3abb4b11baa67b378

data/.github/dependabot.yml

@@ -5,8 +5,8 @@ updates:
     directories:
       - "/"
     schedule:
-      interval: "daily"
-      time: "14:00"
+      interval: "weekly"
+      day: "sunday"
       timezone: "Asia/Tokyo"
     open-pull-requests-limit: 5
     rebase-strategy: "disabled"
@@ -15,8 +15,8 @@ updates:
     directories:
       - "/"
     schedule:
-      interval: "daily"
-      time: "14:00"
+      interval: "weekly"
+      day: "sunday"
       timezone: "Asia/Tokyo"
     open-pull-requests-limit: 5
     rebase-strategy: "disabled"

data/.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - uses: ruby/setup-ruby@a4effe49ee8ee5b8b5091268c473a4628afb5651 # v1.245.0
+      - uses: ruby/setup-ruby@efbf473cab83af4468e8606cc33eca9281bb213f # v1.256.0
         with:
           ruby-version: 3.4.4 # Latest stable Ruby for release builds
           bundler-cache: true

data/.github/workflows/test.yml

@@ -11,27 +11,6 @@ permissions:
   contents: read
 
 jobs:
-  codeclimate:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Get branch names
-        id: branch-name
-        uses: tj-actions/branch-names@dde14ac574a8b9b1cedc59a1cf312788af43d8d8 # v8.2.1
-      - 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 & publish code coverage
-        if: "${{ env.CC_TEST_REPORTER_ID != '' }}"
-        uses: paambaati/codeclimate-action@7bcf9e73c0ee77d178e72c0ec69f1a99c1afc1f3 # v2.7.5
-        env:
-          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-          GIT_BRANCH: ${{ steps.branch-name.outputs.current_branch }}
-          GIT_COMMIT_SHA: ${{ github.sha }}
-        with:
-          coverageCommand: bundle exec rake
-
   test:
     strategy:
       fail-fast: false
@@ -47,7 +26,7 @@ jobs:
     continue-on-error: ${{ matrix.experimental }}
     steps:
       - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
-      - uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb # v1.244.0
+      - uses: ruby/setup-ruby@efbf473cab83af4468e8606cc33eca9281bb213f # v1.256.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Unreleased
 
+## 1.6.0
+
+- Support for a new inline math syntax
+
+## 1.5.0
+
+- Accept new figma script host (embed.figma.com)
+
 ## 1.4.0
 
 - Add support for embedding blueprintUE iframes

data/Gemfile

@@ -5,7 +5,6 @@ gemspec
 
 gem "activesupport", "~> 5.2.7"
 gem "bundler"
-gem "codeclimate-test-reporter", "0.4.4"
 gem "pry"
 gem "rake"
 gem "rspec", "~> 3.1"

data/README.md

@@ -2,8 +2,6 @@
 
 [![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)
-[![Code Climate](https://codeclimate.com/github/increments/qiita-markdown/badges/gpa.svg)](https://codeclimate.com/github/increments/qiita-markdown)
-[![Test Coverage](https://codeclimate.com/github/increments/qiita-markdown/badges/coverage.svg)](https://codeclimate.com/github/increments/qiita-markdown)
 
 Qiita-specified markdown processor.
 

data/lib/qiita/markdown/embed/figma.rb

@@ -4,7 +4,10 @@ module Qiita
   module Markdown
     module Embed
       module Figma
-        SCRIPT_HOST = "www.figma.com"
+        SCRIPT_HOSTS = [
+          "www.figma.com",
+          "embed.figma.com",
+        ].freeze
       end
     end
   end

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/transformers/filter_iframe.rb

@@ -9,7 +9,7 @@ module Qiita
           Embed::SlideShare::SCRIPT_HOST,
           Embed::GoogleSlide::SCRIPT_HOST,
           Embed::Docswell::SCRIPT_HOSTS,
-          Embed::Figma::SCRIPT_HOST,
+          Embed::Figma::SCRIPT_HOSTS,
           Embed::GoogleDrive::SCRIPT_HOST,
           Embed::StackBlitz::SCRIPT_HOST,
           Embed::BlueprintUe::SCRIPT_HOST,

data/lib/qiita/markdown/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Markdown
-    VERSION = "1.4.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

data/spec/qiita/markdown/processor_spec.rb

@@ -1632,25 +1632,33 @@ describe Qiita::Markdown::Processor do
 
       context "with HTML embed code for Figma" do
         shared_examples "embed code figma example" do
-          let(:markdown) do
-            <<-MARKDOWN.strip_heredoc
-              <iframe style="border: 1px solid rgba(0, 0, 0, 0.1);" width="100" height="100" src="#{url}"></iframe>
-            MARKDOWN
-          end
-          let(:url) { "#{scheme}//www.figma.com/embed?embed_host=share&url=https%3A%2F%2Fwww.figma.com" }
-          let(:encoded_url) { CGI.escapeHTML(url) }
+          [
+            "www.figma.com/embed?embed_host=share&url=https%3A%2F%2Fwww.figma.com",
+            "embed.figma.com/design/nrPSsILSYjesyc5UHjYYa4?embed_host=share",
+          ].each do |script_url|
+            context "with HTML embed code for Figma using script url `#{script_url}`" do
+              let(:markdown) do
+                <<-MARKDOWN.strip_heredoc
+                  <iframe style="border: 1px solid rgba(0, 0, 0, 0.1);" width="100" height="100" src="#{url}"></iframe>
+                MARKDOWN
+              end
 
-          if allowed
-            it "does not sanitize embed code" do
-              should eq <<-HTML.strip_heredoc
-                <iframe style="border: 1px solid rgba(0, 0, 0, 0.1);" width="100" height="100" src="#{encoded_url}"></iframe>
-              HTML
-            end
-          else
-            it "forces width attribute on iframe" do
-              should eq <<-HTML.strip_heredoc
-                <iframe style="border: 1px solid rgba(0, 0, 0, 0.1);" width="100%" height="100" src="#{encoded_url}"></iframe>
-              HTML
+              let(:url) { "#{scheme}//#{script_url}" }
+              let(:encoded_url) { CGI.escapeHTML(url) }
+
+              if allowed
+                it "does not sanitize embed code" do
+                  should eq <<-HTML.strip_heredoc
+                    <iframe style="border: 1px solid rgba(0, 0, 0, 0.1);" width="100" height="100" src="#{encoded_url}"></iframe>
+                  HTML
+                end
+              else
+                it "forces width attribute on iframe" do
+                  should eq <<-HTML.strip_heredoc
+                    <iframe style="border: 1px solid rgba(0, 0, 0, 0.1);" width="100%" height="100" src="#{encoded_url}"></iframe>
+                  HTML
+                end
+              end
             end
           end
         end

data/spec/spec_helper.rb

@@ -1,11 +1,6 @@
 if ENV["CI"]
-  if ENV["GITHUB_ACTIONS"]
-    require "simplecov"
-    SimpleCov.start
-  else
-    require "codeclimate-test-reporter"
-    CodeClimate::TestReporter.start
-  end
+  require "simplecov"
+  SimpleCov.start
 end
 
 require "qiita-markdown"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 1.4.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