qiita-markdown 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbb2dac9b43b2643084e6d84a2d551f820e27a89
-  data.tar.gz: dd080b685abeea4511ec66d89d7455f7b9465492
+  metadata.gz: 142f1f300d42442f62e84b3ffe54321caa229b2b
+  data.tar.gz: 8029e1417074df1acc82af5cfd075efebe87c959
 SHA512:
-  metadata.gz: 2326ffc02dafe386118f18416e1c0159a002714cb3a860547c74de0ee4e45983e90c1ef33903260215380a66f1d99ce8334dc893da99138e7f697c37f464af82
-  data.tar.gz: '01952a9b9e370f624b7b5b3806903cdb5d21b18eef87092cf585e88c64e6e526b41d3e1dc18e8336e082e27891c6b93067b4be653f9cb84c9727a3f5153b2242'
+  metadata.gz: db7ea2bc3c6e992848e569c695dddb5923d8aeba7f289eb845c6feea58b7150152317df655540350db6967d0871b93ebaa6e7fc82c475742b6ad95f98c779cb1
+  data.tar.gz: c98d93c9fd42393475a09560131d125eafe6d5f43ac429b333a2b2dfecfacf4c9fb8035c5a1cc3234c1209417591ba86aaac409501750a5c1b1c013198904b23

data/.rubocop.yml

@@ -34,3 +34,8 @@ Style/UnneededPercentQ:
 
 Metrics/LineLength:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - qiita-markdown.gemspec
+    - spec/**/*

data/.travis.yml

@@ -7,10 +7,11 @@ before_install:
   - gem update bundler
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.0
   - 2.1
   - 2.2
-  - 2.3.0
+  - 2.3
+  - 2.4
 env:
   global:
     secure: n8eyxYYfxLApgR4YGKqbrOgGlraIyLyoql4K4DvLZV4kqfGf9LLsPdP7Shudqrv5k2h8xIwnJVnwcPZx9YCu5WWYrJd7vmivpU2j52LwFPYRM+GFNcu7TXmzcNSPG8agnc5We9amF5zJY6XSTpzWpxyqfIwEZM75iR6XXuHuLFk=

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Unreleased
+
+## 0.18.0
+
+- Extract heading decoration logic from Greenmat renderer to `Toc` filter
+- Use greenmat 3.2.2.3
+
 ## 0.17.0
 
 - Require pygments.rb 1.0 or later

data/Rakefile

@@ -4,4 +4,4 @@ require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:style)
-task default: [:spec, :style]
+task default: %i[spec style]

data/benchmark/heading_anchor_rendering.rb

@@ -171,7 +171,7 @@ module Rendering
             # no-op
           end
 
-          private # rubocop:disable Lint/UselessAccessModifier
+          private
 
           def content
             body

data/lib/qiita/markdown.rb

@@ -19,6 +19,7 @@ require "qiita/markdown/filters/mention"
 require "qiita/markdown/filters/sanitize"
 require "qiita/markdown/filters/simplify"
 require "qiita/markdown/filters/syntax_highlight"
+require "qiita/markdown/filters/toc"
 require "qiita/markdown/filters/truncate"
 require "qiita/markdown/greenmat/heading_rendering"
 require "qiita/markdown/greenmat/html_renderer"

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

@@ -17,9 +17,9 @@ module Qiita
           result[:codes] ||= []
           doc.search("pre").each do |pre|
             if (code = pre.at("code"))
-              label = Label.new(code["class"])
-              filename = label.filename
-              language = label.language
+              metadata = Metadata.new(code["data-metadata"])
+              filename = metadata.filename
+              language = metadata.language
               language = language_aliases[language] || language
               pre["filename"] = filename if filename
               pre["lang"] = language if language
@@ -39,8 +39,8 @@ module Qiita
           context[:language_aliases] || DEFAULT_LANGUAGE_ALIASES
         end
 
-        # Detects language from code block label.
-        class Label
+        # Detects language from code block metadata.
+        class Metadata
           # @param text [String, nil]
           def initialize(text)
             @text = text
@@ -59,10 +59,10 @@ module Qiita
           end
 
           # @example
-          #   Label.new(nil).language #=> nil
-          #   Label.new("ruby").language #=> "ruby"
-          #   Label.new("ruby:foo.rb").language #=> "ruby"
-          #   Label.new("foo.rb").language #=> "ruby"
+          #   Metadata.new(nil).language #=> nil
+          #   Metadata.new("ruby").language #=> "ruby"
+          #   Metadata.new("ruby:foo.rb").language #=> "ruby"
+          #   Metadata.new("foo.rb").language #=> "ruby"
           # @return [String, nil]
           def language
             case

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

@@ -32,13 +32,13 @@ module Qiita
             )
           }x
 
-          IGNORED_ANCESTOR_ELEMENT_NAMES = %w(
+          IGNORED_ANCESTOR_ELEMENT_NAMES = %w[
             a
             blockquote
             code
             pre
             style
-          ).freeze
+          ].freeze
 
           # @param node [Nokogiri::XML::Node]
           # @param group_mention_url_generator [Proc]

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

@@ -23,13 +23,13 @@ module Qiita
           private
 
           def has_invalid_list_node?
-            name == "li" && !node.ancestors.any? do |ancestor|
+            name == "li" && node.ancestors.none? do |ancestor|
               %w[ol ul].include?(ancestor.name)
             end
           end
 
           def has_invalid_table_node?
-            %w[thead tbody tfoot tr td th].include?(name) && !node.ancestors.any? do |ancestor|
+            %w[thead tbody tfoot tr td th].include?(name) && node.ancestors.none? do |ancestor|
               ancestor.name == "table"
             end
           end
@@ -213,7 +213,7 @@ module Qiita
             "script",
           ],
           transformers: TransformableNode,
-        }
+        }.freeze
 
         SCRIPTABLE_RULE = RULE.dup.tap do |rule|
           rule[:attributes] = RULE[:attributes].dup

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

@@ -15,9 +15,9 @@ module Qiita
       #   `Sanitize` filter later.
       #   https://github.com/rgrove/sanitize/blob/v3.1.2/lib/sanitize.rb#L77-L100
       class Simplify < HTML::Pipeline::Filter
-        SIMPLE_ELEMENTS = %w(a b code em i ins q s samp span strike strong sub sup var)
+        SIMPLE_ELEMENTS = %w[a b code em i ins q s samp span strike strong sub sup var]
 
-        COMPLEX_CONTENT_ELEMENTS = %w(table)
+        COMPLEX_CONTENT_ELEMENTS = %w[table]
 
         def call
           remove_complex_contents

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

@@ -0,0 +1,39 @@
+module Qiita
+  module Markdown
+    module Filters
+      class Toc < HTML::Pipeline::Filter
+        def call
+          doc.css("h1[id], h2[id], h3[id], h4[id], h5[id], h6[id]").each do |node|
+            Heading.new(node).decorate
+          end
+          doc
+        end
+
+        class Heading
+          def initialize(node)
+            @node = node
+            @id = node.attr("id")
+            raise unless @id
+          end
+
+          def decorate
+            remove_heading_id
+            first_child.add_previous_sibling(anchor_element) if first_child
+          end
+
+          def remove_heading_id
+            @node.remove_attribute("id")
+          end
+
+          def anchor_element
+            %(<span id="#{@id}" class="fragment"></span><a href="##{@id}"><i class="fa fa-link"></i></a>)
+          end
+
+          def first_child
+            @first_child ||= @node.children.first
+          end
+        end
+      end
+    end
+  end
+end

data/lib/qiita/markdown/greenmat/html_renderer.rb

@@ -47,18 +47,12 @@ module Qiita
 
         class HeadingWithAnchor < AbstractHeading
           def to_s
-            "\n<h#{level}>#{anchor_element}#{body}</h#{level}>\n"
+            %(\n<h#{level} id="#{suffixed_id}">#{body}</h#{level}>\n)
           end
 
           def increment
             counter[id] += 1
           end
-
-          private
-
-          def anchor_element
-            %(<span id="#{suffixed_id}" class="fragment"></span><a href="##{suffixed_id}"><i class="fa fa-link"></i></a>)
-          end
         end
       end
     end

data/lib/qiita/markdown/processor.rb

@@ -14,6 +14,7 @@ module Qiita
           Filters::Footnote,
           Filters::Code,
           Filters::Checkbox,
+          Filters::Toc,
           Filters::Emoji,
           Filters::SyntaxHighlight,
           Filters::Mention,

data/lib/qiita/markdown/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Markdown
-    VERSION = "0.17.0"
+    VERSION = "0.18.0"
   end
 end

data/qiita-markdown.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "html-pipeline", "~> 2.0"
   spec.add_dependency "mem"
   spec.add_dependency "pygments.rb", "~> 1.0"
-  spec.add_dependency "greenmat", ">= 3.2.0.2", "< 4"
+  spec.add_dependency "greenmat", "3.2.2.3"
   spec.add_dependency "sanitize"
   spec.add_dependency "addressable"
   spec.add_development_dependency "activesupport", "4.2.6"
@@ -33,5 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "rubocop", "0.40.0"
+  spec.add_development_dependency "rubocop", "0.49.1"
 end

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

@@ -0,0 +1,15 @@
+describe Qiita::Markdown::Filters::Greenmat do
+  subject(:filter) do
+    described_class.new(markdown)
+  end
+
+  context "with headings" do
+    let(:markdown) do
+      "# foo"
+    end
+
+    it "does not generate FontAwesome classes so that we can say that they're inputted by user" do
+      expect(filter.call.to_s).to eq(%(\n<h1 id="foo">foo</h1>\n))
+    end
+  end
+end

data/spec/qiita/markdown/processor_spec.rb

@@ -84,6 +84,37 @@ describe Qiita::Markdown::Processor do
       end
     end
 
+    context "with heading whose title includes special HTML characters" do
+      let(:markdown) do
+        <<-EOS.strip_heredoc
+          # <b>R&amp;B</b>
+        EOS
+      end
+
+      it "generates fragment identifier by sanitizing the special characters in the title" do
+        should eq <<-EOS.strip_heredoc
+
+          <h1>
+          <span id="rb" class="fragment"></span><a href="#rb"><i class="fa fa-link"></i></a><b>R&amp;B</b>
+          </h1>
+        EOS
+      end
+    end
+
+    context "with manually inputted heading HTML tags without id attribute" do
+      let(:markdown) do
+        <<-EOS.strip_heredoc
+          <h1>foo</h1>
+        EOS
+      end
+
+      it "does nothing" do
+        should eq <<-EOS.strip_heredoc
+          <h1>foo</h1>
+        EOS
+      end
+    end
+
     context "with code" do
       let(:markdown) do
         <<-EOS.strip_heredoc

data/spec/qiita/markdown/summary_processor_spec.rb

@@ -55,7 +55,7 @@ describe Qiita::Markdown::SummaryProcessor do
 
       it "returns simple code element" do
         should eq <<-EOS.strip_heredoc
-          <code class="ruby">puts 'hello world'
+          <code>puts 'hello world'
           </code>
         EOS
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-30 00:00:00.000000000 Z
+date: 2017-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemoji
@@ -84,22 +84,16 @@ dependencies:
   name: greenmat
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.0.2
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 3.2.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.0.2
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 3.2.2.3
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
@@ -232,14 +226,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.49.1
 description: 
 email:
 - r7kamura@gmail.com
@@ -274,6 +268,7 @@ files:
 - lib/qiita/markdown/filters/sanitize.rb
 - lib/qiita/markdown/filters/simplify.rb
 - lib/qiita/markdown/filters/syntax_highlight.rb
+- lib/qiita/markdown/filters/toc.rb
 - lib/qiita/markdown/filters/truncate.rb
 - lib/qiita/markdown/greenmat/heading_rendering.rb
 - lib/qiita/markdown/greenmat/html_renderer.rb
@@ -282,7 +277,7 @@ files:
 - lib/qiita/markdown/summary_processor.rb
 - lib/qiita/markdown/version.rb
 - qiita-markdown.gemspec
-- spec/qiita/markdown/greenmat/html_renderer_spec.rb
+- spec/qiita/markdown/filters/greenmat_spec.rb
 - spec/qiita/markdown/greenmat/html_toc_renderer_spec.rb
 - spec/qiita/markdown/processor_spec.rb
 - spec/qiita/markdown/summary_processor_spec.rb
@@ -312,7 +307,7 @@ signing_key:
 specification_version: 4
 summary: Qiita-specified markdown processor.
 test_files:
-- spec/qiita/markdown/greenmat/html_renderer_spec.rb
+- spec/qiita/markdown/filters/greenmat_spec.rb
 - spec/qiita/markdown/greenmat/html_toc_renderer_spec.rb
 - spec/qiita/markdown/processor_spec.rb
 - spec/qiita/markdown/summary_processor_spec.rb

data/spec/qiita/markdown/greenmat/html_renderer_spec.rb

@@ -1,68 +0,0 @@
-require "active_support/core_ext/string/strip"
-
-describe Qiita::Markdown::Greenmat::HTMLRenderer do
-  let(:renderer) { described_class.new(extension) }
-  let(:extension) { {} }
-  let(:greenmat) { ::Greenmat::Markdown.new(renderer) }
-  subject(:rendered_html) { greenmat.render(markdown) }
-
-  describe "headings" do
-    let(:markdown) do
-      <<-EOS.strip_heredoc
-        # a
-        ## a
-        ### a
-        ### a
-      EOS
-    end
-
-    context "with :with_toc_data extension" do
-      let(:extension) { { with_toc_data: true } }
-
-      it "renders headings with ToC anchor" do
-        should eq <<-EOS.strip_heredoc
-
-          <h1><span id="a" class="fragment"></span><a href="#a"><i class="fa fa-link"></i></a>a</h1>
-
-          <h2><span id="a-1" class="fragment"></span><a href="#a-1"><i class="fa fa-link"></i></a>a</h2>
-
-          <h3><span id="a-2" class="fragment"></span><a href="#a-2"><i class="fa fa-link"></i></a>a</h3>
-
-          <h3><span id="a-3" class="fragment"></span><a href="#a-3"><i class="fa fa-link"></i></a>a</h3>
-        EOS
-      end
-
-      context "and heading title including special HTML characters" do
-        let(:markdown) do
-          <<-EOS.strip_heredoc
-            # <b>R&amp;B</b>
-          EOS
-        end
-
-        it "generates fragment identifier by sanitizing the characters in the title" do
-          should eq <<-EOS.strip_heredoc
-
-            <h1><span id="rb" class="fragment"></span><a href="#rb"><i class="fa fa-link"></i></a><b>R&amp;B</b></h1>
-          EOS
-        end
-      end
-    end
-
-    context "without :with_toc_data extension" do
-      let(:extension) { { with_toc_data: false } }
-
-      it "renders headings without ToC anchor" do
-        should eq <<-EOS.strip_heredoc
-
-          <h1>a</h1>
-
-          <h2>a</h2>
-
-          <h3>a</h3>
-
-          <h3>a</h3>
-        EOS
-      end
-    end
-  end
-end