qiita-markdown 0.42.0 → 0.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0430156d41ed0b17c5ba246e32ca78024e9d3fb834d8a003924a7e3526d9b278
-  data.tar.gz: cb4ea8e9542c5aaeffed2f8d359c06e3e72c3ff08e90f9c97cf3c6bc9c3f7f63
+  metadata.gz: 925ca9666fc91e263d0b8fb4d704900d52b92964d6d53d63730d84403304df3b
+  data.tar.gz: 47a27d59b58ced30484eadfc1dd59bfb94f96673a6e5e20fafc76f19c10065ea
 SHA512:
-  metadata.gz: 9488a97467616a4ca6e64a2483a4ba9789f3d69f1025aee5f5350a6baa6ada4e215de77af3dbb98f9ecb3a99c94680e6fc1dd7535a2acfccf70d82b1abd685db
-  data.tar.gz: 414798bddd8fc8d76e9f77d8165cb96907969c77b0e8c2e2678cbfeb5e44f1d43e2d888447005a1c9b7195f56e2757aa99f4ac6712933cdf5ea986ba0511d813
+  metadata.gz: d0613208602c957acd488a6050095a5ba79cc085fa08a8c18aa6ea98711e3ca61313cd68a9d166308b4d1cdd6efabe98e8a364c92635c82084374d765b069759
+  data.tar.gz: 9ac8835a36b9871c02981d64ee335fd8e7a1a390825e81f5536e57af0b4d5be5d5004236d40f45409294a73a739aa01d0a814d9a30d5e20643b3c6a725682faf

data/.github/workflows/test.yml

@@ -11,6 +11,27 @@ permissions:
   contents: read
 
 jobs:
+  codeclimate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get branch names
+        id: branch-name
+        uses: tj-actions/branch-names@v4.9
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+          bundler-cache: true
+      - name: Test & publish code coverage
+        if: "${{ env.CC_TEST_REPORTER_ID != '' }}"
+        uses: paambaati/codeclimate-action@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
@@ -25,19 +46,10 @@ jobs:
     runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.experimental }}
     steps:
-      - name: Get branch names
-        id: branch-name
-        uses: tj-actions/branch-names@v4.9
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - name: Test & publish code coverage
-        uses: paambaati/codeclimate-action@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
+      - name: Test
+        run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
 
+## 0.43.0
+
+- Fix GitHub Actions can't be executed when public fork
+- Support new embed scripts and iframes
+    - Docswell
+
 ## 0.42.0
 
 - Add for Ruby 3.0, 3.1 support

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Qiita
+  module Markdown
+    module Embed
+      module Docswell
+        SCRIPT_HOSTS = [
+          "docswell.com",
+          "www.docswell.com",
+        ].freeze
+        SCRIPT_URLS = [
+          "https://www.docswell.com/assets/libs/docswell-embed/docswell-embed.min.js",
+          "//www.docswell.com/assets/libs/docswell-embed/docswell-embed.min.js",
+        ].freeze
+        CLASS_NAME = %w[docswell-embed].freeze
+        DATA_ATTRIBUTES = %w[
+          data-src data-aspect data-height-offset data-width-offset
+        ].freeze
+        ATTRIBUTES = %w[class] + DATA_ATTRIBUTES
+      end
+    end
+  end
+end

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

@@ -49,6 +49,7 @@ module Qiita
               "type",
             ].concat(
               Embed::SpeekerDeck::ATTRIBUTES,
+              Embed::Docswell::ATTRIBUTES,
             ),
             "span" => [
               "style",

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

@@ -26,7 +26,7 @@ module Qiita
             "li"         => %w[id],
             "p"          => Embed::CodePen::ATTRIBUTES,
             "q"          => %w[cite],
-            "script"     => %w[async src id].concat(Embed::SpeekerDeck::ATTRIBUTES),
+            "script"     => %w[async src id].concat(Embed::SpeekerDeck::ATTRIBUTES, Embed::Docswell::ATTRIBUTES),
             "iframe"     => %w[
               allowfullscreen
               frameborder

data/lib/qiita/markdown/transformers/filter_iframe.rb

@@ -9,6 +9,7 @@ module Qiita
           Embed::Youtube::SCRIPT_HOSTS,
           Embed::SlideShare::SCRIPT_HOST,
           Embed::GoogleSlide::SCRIPT_HOST,
+          Embed::Docswell::SCRIPT_HOSTS,
         ].flatten.freeze
 
         def self.call(**args)

data/lib/qiita/markdown/transformers/filter_script.rb

@@ -6,6 +6,7 @@ module Qiita
           Embed::CodePen::SCRIPT_URLS,
           Embed::Tweet::SCRIPT_URL,
           Embed::SpeekerDeck::SCRIPT_URLS,
+          Embed::Docswell::SCRIPT_URLS,
         ].flatten.freeze
 
         HOST_WHITE_LIST = [

data/lib/qiita/markdown/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Markdown
-    VERSION = "0.42.0"
+    VERSION = "0.43.0"
   end
 end

data/lib/qiita/markdown.rb

@@ -14,6 +14,7 @@ require "qiita/markdown/embed/youtube"
 require "qiita/markdown/embed/slide_share"
 require "qiita/markdown/embed/google_slide"
 require "qiita/markdown/embed/speeker_deck"
+require "qiita/markdown/embed/docswell"
 require "qiita/markdown/transformers/filter_attributes"
 require "qiita/markdown/transformers/filter_script"
 require "qiita/markdown/transformers/filter_iframe"

data/spec/qiita/markdown/processor_spec.rb

@@ -1642,6 +1642,63 @@ describe Qiita::Markdown::Processor do
         end
       end
 
+      context "with HTML embed code for Docswell" do
+        let(:markdown) do
+          <<-MARKDOWN.strip_heredoc
+            <script async class="docswell-embed" src="https://www.docswell.com/assets/libs/docswell-embed/docswell-embed.min.js" data-src="https://www.docswell.com/slide/example/embed" data-aspect="0.5625"></script>
+          MARKDOWN
+        end
+
+        if allowed
+          it "does not sanitize embed code" do
+            should eq <<-HTML.strip_heredoc
+              <script async class="docswell-embed" src="https://www.docswell.com/assets/libs/docswell-embed/docswell-embed.min.js" data-src="https://www.docswell.com/slide/example/embed" data-aspect="0.5625"></script>
+            HTML
+          end
+        else
+          it "forces async attribute on script" do
+            should eq <<-HTML.strip_heredoc
+              <script async class="docswell-embed" src="https://www.docswell.com/assets/libs/docswell-embed/docswell-embed.min.js" data-src="https://www.docswell.com/slide/example/embed" data-aspect="0.5625"></script>
+            HTML
+          end
+        end
+
+        shared_examples "iframe code docswell example" do
+          let(:markdown) do
+            <<-MARKDOWN.strip_heredoc
+            <iframe src="#{url}" allowfullscreen="true" width="620" height="405" style="width:100%"></iframe>
+            MARKDOWN
+          end
+          let(:url) { "#{scheme}//www.docswell.com/slide/example/embed" }
+
+          if allowed
+            it "does not sanitize embed code" do
+              should eq <<-HTML.strip_heredoc
+              <iframe src="#{url}" allowfullscreen="true" width="620" height="405"></iframe>
+              HTML
+            end
+          else
+            it "forces width attribute on iframe" do
+              should eq <<-HTML.strip_heredoc
+              <iframe src="#{url}" allowfullscreen="true" width="100%" height="405"></iframe>
+              HTML
+            end
+          end
+        end
+
+        context "with scheme" do
+          let(:scheme) { "https:" }
+
+          include_examples "iframe code docswell example"
+        end
+
+        context "without scheme" do
+          let(:scheme) { "" }
+
+          include_examples "iframe code docswell example"
+        end
+      end
+
       context "with embed code for Tweet" do
         let(:markdown) do
           <<-MARKDOWN.strip_heredoc

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 0.42.0
+  version: 0.43.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-22 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemoji
@@ -314,6 +314,7 @@ files:
 - lib/qiita/markdown/base_processor.rb
 - lib/qiita/markdown/embed/asciinema.rb
 - lib/qiita/markdown/embed/code_pen.rb
+- lib/qiita/markdown/embed/docswell.rb
 - lib/qiita/markdown/embed/google_slide.rb
 - lib/qiita/markdown/embed/slide_share.rb
 - lib/qiita/markdown/embed/speeker_deck.rb
@@ -372,7 +373,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Qiita-specified markdown processor.