qiita-markdown 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6afb669f682c7011cb3d63a82f6eeb3b6a57ca2d
-  data.tar.gz: a648ad7e1cdf3a6b524c9457d4d6b2a72d411d54
+  metadata.gz: 778b3df4d04671c390617f51ec231bb2929fb77c
+  data.tar.gz: e5474939d020ce354844259c1f37d11e10567c4f
 SHA512:
-  metadata.gz: 565ff262b6b042f303519937c5a042f4343676f2cca01b57508f3e4eff6b2c95820452ff090a80612579d6fe8ef828cf2ad321c1dd083f5351514d5dc9c4fb34
-  data.tar.gz: 94c40140d79c856cb8fe9f5700984e0f20fd5051b27493c6a3a1249cba5f2b3a1329262c907817f262afe02281d7431d162563da39c488c15763c2a5aca9df4a
+  metadata.gz: 3ab6e4e68ce78816662dabe71a9a150fc10655be8933f65d8de26903608ef12dcdca53824e761e6e3d7acca7dda5327cd4714b1652e356a4cee11772779585d8
+  data.tar.gz: c567e7488ef2aae1065d5ad0ca4399102867464ef42fdbf6ec409c7ecb394b96e73851b3005d29951703eaf7256b8eb4e08f010178530d0b064a01ee28b2a7fd

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.0.7
+* Change dependent gem version
+
 ## 0.0.6
 * Remove target="_blank" from a element of mention
 

data/README.md

@@ -1,5 +1,14 @@
 # Qiita::Markdown [![Build Status](https://travis-ci.org/increments/qiita-markdown.svg)](https://travis-ci.org/increments/qiita-markdown)
-Qiita-specified markdown renderer.
+Qiita-specified markdown processor.
+
+* Markdown conversion
+* Sanitization
+* Code and language detection
+* Task list
+* ToC
+* Emoji
+* Syntax highlighting
+* Mention
 
 ## Usage
 Qiita::Markdown::Processor provides markdown rendering logic.

data/lib/qiita/markdown.rb

@@ -5,6 +5,7 @@ require "nokogiri"
 require "redcarpet"
 require "sanitize"
 
+require "qiita/markdown/filters/checkbox"
 require "qiita/markdown/filters/code"
 require "qiita/markdown/filters/mention"
 require "qiita/markdown/filters/redcarpet"

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

@@ -0,0 +1,87 @@
+module Qiita
+  module Markdown
+    module Filters
+      # Converts [ ] and [x] into checkbox elements.
+      #
+      # * [x] Foo
+      # * [ ] Bar
+      # * [ ] Baz
+      #
+      # Takes following context options:
+      #
+      # * :checkbox_disabled - Pass true to add `disabled` attribute to input element
+      #
+      class Checkbox < HTML::Pipeline::Filter
+        def call
+          doc.search("li").each_with_index do |li, index|
+            list = List.new(disabled: context[:checkbox_disabled], index: index, node: li)
+            list.convert if list.has_checkbox?
+          end
+          doc
+        end
+
+        class List
+          CHECKBOX_CLOSE_MARK = "[x] "
+          CHECKBOX_OPEN_MARK  = "[ ] "
+
+          def initialize(disabled: nil, index: nil, node: nil)
+            @disabled = disabled
+            @index = index
+            @node = node
+          end
+
+          def has_checkbox?
+            has_open_checkbox? || has_close_checkbox?
+          end
+
+          def convert
+            first_text_node.content = first_text_node.content.sub(checkbox_mark, "")
+            @node.prepend_child(checkbox_node)
+            @node["class"] = "task-list-item"
+          end
+
+          private
+
+          def checkbox_mark
+            case
+            when has_close_checkbox?
+              CHECKBOX_CLOSE_MARK
+            when has_open_checkbox?
+              CHECKBOX_OPEN_MARK
+            end
+          end
+
+          def checkbox_node
+            node = Nokogiri::HTML.fragment('<input type="checkbox" class="task-list-item-checkbox">')
+            node.children.first["data-checkbox-index"] = @index
+            node.children.first["checked"] = true if has_close_checkbox?
+            node.children.first["disabled"] = true if @disabled
+            node
+          end
+
+          def first_text_node
+            @first_text_node ||= @node.children.first
+          end
+
+          def has_close_checkbox?
+            if instance_variable_defined?(:@has_close_checkbox)
+              @has_close_checkbox
+            else
+              inner = @node.children.first
+              @has_close_checkbox = inner.text? && inner.content.start_with?(CHECKBOX_CLOSE_MARK)
+            end
+          end
+
+          def has_open_checkbox?
+            if instance_variable_defined?(:@has_open_checkbox)
+              @has_open_checkbox
+            else
+              inner = @node.children.first
+              @has_open_checkbox = inner.text? && inner.content.start_with?(CHECKBOX_OPEN_MARK)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module Qiita
       }
 
       # 1. Detects language written in <pre> element.
-      # 2. Adds lang attribute (but this attribute is consumed by syntax highliter).
+      # 2. Adds lang attribute (but this attribute is consumed by syntax highlighter).
       # 3. Adds detected code data into `result[:codes]`.
       #
       # You can pass language aliases table via context[:language_aliases].

data/lib/qiita/markdown/processor.rb

@@ -9,6 +9,7 @@ module Qiita
         Filters::Redcarpet,
         Filters::Sanitize,
         Filters::Code,
+        Filters::Checkbox,
         Filters::Toc,
         HTML::Pipeline::EmojiFilter,
         Filters::SyntaxHighlight,

data/lib/qiita/markdown/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Markdown
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

data/qiita-markdown.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = Qiita::Markdown::VERSION
   spec.authors       = ["Ryo Nakamura"]
   spec.email         = ["r7kamura@gmail.com"]
-  spec.summary       = "Qiita-specified markdown renderer."
+  spec.summary       = "Qiita-specified markdown processor."
   spec.homepage      = "https://github.com/increments/qiita-markdown"
   spec.license       = "MIT"
 
@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "github-linguist"
   spec.add_dependency "html-pipeline"
   spec.add_dependency "redcarpet"
+  spec.add_dependency "rugged", ">= 0.21.1b2"
   spec.add_dependency "sanitize"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "pry"

data/spec/qiita/markdown/processor_spec.rb

@@ -157,7 +157,7 @@ describe Qiita::Markdown::Processor do
       end
 
       it "removes script element" do
-        should eq "\n"
+        should eq "<p></p>\n"
       end
     end
 
@@ -168,7 +168,7 @@ describe Qiita::Markdown::Processor do
 
       let(:markdown) do
         <<-EOS.strip_heredoc
-          <script>alert(1)</script>
+          <p><script>alert(1)</script></p>
         EOS
       end
 
@@ -184,7 +184,7 @@ describe Qiita::Markdown::Processor do
 
       let(:markdown) do
         <<-EOS.strip_heredoc
-          <script async data-a="b">alert(1)</script>
+          <p><script async data-a="b">alert(1)</script></p>
         EOS
       end
 
@@ -375,5 +375,92 @@ describe Qiita::Markdown::Processor do
         EOS
       end
     end
+
+    context "with checkbox list" do
+      let(:markdown) do
+        <<-EOS.strip_heredoc
+          - [ ] a
+          - [x] b
+        EOS
+      end
+
+      it "inserts checkbox" do
+        should eq <<-EOS.strip_heredoc
+          <ul>
+          <li class="task-list-item">
+          <input type="checkbox" class="task-list-item-checkbox" data-checkbox-index="0">a</li>
+          <li class="task-list-item">
+          <input type="checkbox" class="task-list-item-checkbox" data-checkbox-index="1" checked>b</li>
+          </ul>
+        EOS
+      end
+    end
+
+    context "with nested checkbox list" do
+      let(:markdown) do
+        <<-EOS.strip_heredoc
+          - [ ] a
+           - [ ] b
+        EOS
+      end
+
+      it "inserts checkbox" do
+        should eq <<-EOS.strip_heredoc
+          <ul>
+          <li class="task-list-item">
+          <input type="checkbox" class="task-list-item-checkbox" data-checkbox-index="0">a
+
+          <ul>
+          <li class="task-list-item">
+          <input type="checkbox" class="task-list-item-checkbox" data-checkbox-index="1">b</li>
+          </ul>
+          </li>
+          </ul>
+        EOS
+      end
+    end
+
+    context 'with checkbox list in code block' do
+      let(:markdown) do
+        <<-EOS.strip_heredoc
+          ```
+          - [ ] a
+          - [x] b
+          ```
+        EOS
+      end
+
+      it "does not replace checkbox" do
+        should eq <<-EOS.strip_heredoc
+          <div class="code-frame" data-lang="text"><div class="highlight"><pre>- [ ] a
+          - [x] b
+          </pre></div></div>
+        EOS
+      end
+    end
+
+    context "with checkbox list and :checkbox_disabled context" do
+      before do
+        context[:checkbox_disabled] = true
+      end
+
+      let(:markdown) do
+        <<-EOS.strip_heredoc
+          - [ ] a
+          - [x] b
+        EOS
+      end
+
+      it "inserts checkbox with disabled attribute" do
+        should eq <<-EOS.strip_heredoc
+          <ul>
+          <li class="task-list-item">
+          <input type="checkbox" class="task-list-item-checkbox" data-checkbox-index="0" disabled>a</li>
+          <li class="task-list-item">
+          <input type="checkbox" class="task-list-item-checkbox" data-checkbox-index="1" checked disabled>b</li>
+          </ul>
+        EOS
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.1b2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.1b2
 - !ruby/object:Gem::Dependency
   name: sanitize
   requirement: !ruby/object:Gem::Requirement
@@ -167,6 +181,7 @@ files:
 - Rakefile
 - lib/qiita-markdown.rb
 - lib/qiita/markdown.rb
+- lib/qiita/markdown/filters/checkbox.rb
 - lib/qiita/markdown/filters/code.rb
 - lib/qiita/markdown/filters/mention.rb
 - lib/qiita/markdown/filters/redcarpet.rb
@@ -201,7 +216,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Qiita-specified markdown renderer.
+summary: Qiita-specified markdown processor.
 test_files:
 - spec/qiita/markdown/processor_spec.rb
 - spec/spec_helper.rb