slacken 0.1.0

data/scripts/update_markup_fixture.rb

@@ -0,0 +1,8 @@
+require 'slacken'
+
+fixture_dir = File.expand_path('../spec/fixtures', __dir__)
+
+File.write(
+  File.expand_path('markup_text.txt', fixture_dir),
+  Slacken.translate(File.read(File.expand_path('example.html', fixture_dir)))
+  )

data/slacken.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/slacken/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "slacken"
+  gem.version       = Slacken::VERSION
+  gem.summary       = %q{Translate HTML sources to markup texts for slack}
+  gem.description   = %q{Translate HTML sources to markup texts for slack}
+  gem.license       = "MIT"
+  gem.authors       = ["Tomoya Chiba"]
+  gem.email         = "tomo.asleep@gmail.com"
+  gem.homepage      = "https://rubygems.org/gems/slacken"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rdoc', '~> 3.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+
+  gem.add_runtime_dependency 'nokogiri', '~> 1.6'
+  gem.add_runtime_dependency 'kosi', '~> 1.0'
+end

data/spec/fixtures/example.html

@@ -0,0 +1,114 @@
+
+<h1>
+<span id="見出し-bold" class="fragment"></span><a href="#%E8%A6%8B%E5%87%BA%E3%81%97-bold"><i class="fa fa-link"></i></a>見出し <strong>bold</strong>
+</h1>
+
+<p>テキスト<em>イタリック</em> <strong>太字</strong><br>
+stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring</p>
+
+<p>hogehogehogehogehogehogehoge <img class="emoji" title=":eyes:" alt=":eyes:" src="https://cdn.qiita.com/emoji/unicode/1f440.png" height="20" width="20" align="absmiddle"> hogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehoge <img class="emoji" title=":bowtie:" alt=":bowtie:" src="https://cdn.qiita.com/emoji/bowtie.png" height="20" width="20" align="absmiddle"> </p>
+
+<h2>
+<span id="中見出し-italic" class="fragment"></span><a href="#%E4%B8%AD%E8%A6%8B%E5%87%BA%E3%81%97-italic"><i class="fa fa-link"></i></a>中見出し <em>italic</em>
+</h2>
+
+<p>内容をここに書く</p>
+
+<ul>
+<li>リスト
+
+<ul>
+<li>リスト1</li>
+<li>リスト2</li>
+</ul>
+</li>
+</ul>
+
+<ol>
+<li>Item 1</li>
+<li>Item 2</li>
+<li>Item 3
+
+<ul>
+<li>Item 3a</li>
+<li>Item 3b</li>
+</ul>
+</li>
+</ol>
+
+<ul>
+<li class="task-list-item">
+<input type="checkbox" class="task-list-item-checkbox" checked disabled><a href="/qiitan" class="user-mention" title="qiitan">@qiitan</a>, <a href="/tomoasleep_seed" class="user-mention" title="tomoasleep_seed">@tomoasleep_seed</a> </li>
+<li class="task-list-item">
+<input type="checkbox" class="task-list-item-checkbox" checked disabled>List items can have <strong>bold</strong> and <em>italic text</em>
+</li>
+<li class="task-list-item">
+<input type="checkbox" class="task-list-item-checkbox" checked disabled>Checkbox</li>
+<li class="task-list-item">
+<input type="checkbox" class="task-list-item-checkbox" checked disabled>Checked item</li>
+<li class="task-list-item">
+<input type="checkbox" class="task-list-item-checkbox" disabled>Unchecked item</li>
+</ul>
+
+<dl>
+<dt>定義語リストとは？</dt>
+<dd>こんなかんじで単語の意味を説明していくリストです。</dd>
+<dt>他の単語</dt>
+<dd>ここに説明を書く</dd>
+</dl>
+
+<p>引用してみるよ</p>
+
+<blockquote>
+<p>この文字列は引用されたものです<br>
+インデントされているはず<br>
+これはもインデントされている</p>
+</blockquote>
+
+<p>これはインデントされない</p>
+
+<p>まずは <strong>「自己紹介」</strong>してみましょう。<br>
+こんにちは <code>Hello, world!</code> 你好。
+</p>
+
+<div class="code-frame" data-lang="rb"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Klass</span>
+  <span class="k">def</span> <span class="nf">method</span>
+    <span class="nb">puts</span> <span class="s1">'method called!'</span>
+  <span class="k">end</span>
+<span class="k">end</span>
+</pre></div></div>
+
+<table>
+<thead>
+<tr>
+<th>ヘッダー</th>
+<th>Header</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Cell1</td>
+<td>セル1</td>
+</tr>
+<tr>
+<td>試しに長い文字列を入力してみるYo</td>
+<td>looooooooooooooooooong</td>
+</tr>
+</tbody>
+</table>
+
+<p><img src="http://cdn.qiita.com/assets/siteid-reverse-1949e989f9d8b2f6fad65a57292b2b01.png" alt="Qiita logo"></p>
+<p><a href="http://qiita.com"><img src="http://cdn.qiita.com/assets/siteid-reverse-1949e989f9d8b2f6fad65a57292b2b01.png" alt="Qiita logo"></a></p>
+
+<p><a href="http://qiita.com">http://qiita.com</a> - リンク<br>
+<a href="http://qiita.com">Qiita</a></p>
+
+<p>↓水平線</p>
+
+<hr>
+
+<p>↑水平線</p>
+
+<p><del>ignore it</del></p>
+
+<p><img class="emoji" title=":trollface:" alt=":trollface:" src="https://cdn.qiita.com/emoji/trollface.png" height="20" width="20" align="absmiddle"> <img class="emoji" title=":trollface:" alt=":trollface:" src="https://cdn.qiita.com/emoji/trollface.png" height="20" width="20" align="absmiddle"> <img class="emoji" title=":trollface:" alt=":trollface:" src="https://cdn.qiita.com/emoji/trollface.png" height="20" width="20" align="absmiddle"> <img class="emoji" title=":trollface:" alt=":trollface:" src="https://cdn.qiita.com/emoji/trollface.png" height="20" width="20" align="absmiddle"> <img class="emoji" title=":joy:" alt=":joy:" src="https://cdn.qiita.com/emoji/unicode/1f602.png" height="20" width="20" align="absmiddle"> <img class="emoji" title=":joy:" alt=":joy:" src="https://cdn.qiita.com/emoji/unicode/1f602.png" height="20" width="20" align="absmiddle"> <img class="emoji" title=":sob:" alt=":sob:" src="https://cdn.qiita.com/emoji/unicode/1f62d.png" height="20" width="20" align="absmiddle"> <img class="emoji" title=":sob:" alt=":sob:" src="https://cdn.qiita.com/emoji/unicode/1f62d.png" height="20" width="20" align="absmiddle"> </p>

data/spec/fixtures/markup_text.txt

@@ -0,0 +1,73 @@
+*見出し bold*
+
+テキスト _イタリック_ *太字*
+stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring
+
+hogehogehogehogehogehogehoge :eyes: hogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehogehoge :bowtie:
+
+*中見出し _italic_*
+
+内容をここに書く
+
+• リスト
+    • リスト1
+    • リスト2
+
+1. Item 1
+2. Item 2
+3. Item 3
+    • Item 3a
+    • Item 3b
+
+• [x]@qiitan, @tomoasleep_seed
+• [x] List items can have *bold* and _italic text_
+• [x] Checkbox
+• [x] Checked item
+• [ ] Unchecked item
+
+• 定義語リストとは？
+• こんなかんじで単語の意味を説明していくリストです。
+• 他の単語
+• ここに説明を書く
+
+引用してみるよ
+
+> この文字列は引用されたものです
+> インデントされているはず
+> これはもインデントされている
+
+これはインデントされない
+
+まずは *「自己紹介」* してみましょう。
+こんにちは `Hello, world!` 你好。
+
+```class Klass
+  def method
+    puts 'method called!'
+  end
+end
+```
+
++--------------------------------+----------------------+
+|ヘッダー                        |Header                |
++--------------------------------+----------------------+
+|Cell1                           |セル1                 |
+|試しに長い文字列を入力してみるYo|looooooooooooooooooong|
++--------------------------------+----------------------+
+
+<http://cdn.qiita.com/assets/siteid-reverse-1949e989f9d8b2f6fad65a57292b2b01.png|Qiita logo>
+
+<http://qiita.com|Qiita logo>
+
+<http://qiita.com|http://qiita.com> - リンク
+<http://qiita.com|Qiita>
+
+↓水平線
+
+-----------
+
+↑水平線
+
+ignore it
+
+:trollface::trollface::trollface::trollface::joy::joy::sob::sob:

data/spec/helpers/document_component_dsl.rb

@@ -0,0 +1,11 @@
+# Public: Provide DSL methods to build a DocumentComponent like S-exp.
+module DocumentComponentDsl
+  def c(type_name, *children)
+    options = children.first.is_a?(Hash) ? children.shift : {}
+    Slacken::DocumentComponent.new(type_name, children, options)
+  end
+
+  def text(content)
+    Slacken::DocumentComponent.new(:text, [], content: content)
+  end
+end

data/spec/slacken/document_component/elim_blanks_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+class Slacken::DocumentComponent
+  describe ElimBlanks, dsl: true do
+    describe '#has_no_blanks?' do
+      subject { component.has_no_blanks? }
+
+      context 'when a component obviously having no blanks is given' do
+        let(:component) do
+          c(:div, text('hello world!'))
+        end
+
+        it { is_expected.to be_truthy }
+      end
+
+      context 'when a component with blank children is given' do
+        let(:component) do
+          c(:div, text(''), c(:div), c(:span))
+        end
+
+        it { is_expected.to be_falsey }
+      end
+
+      context 'when a component with a img is given' do
+        let(:component) do
+          c(:div, c(:img))
+        end
+
+        it { is_expected.to be_truthy }
+      end
+
+    end
+  end
+end

data/spec/slacken/document_component/elim_invalid_links_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+class Slacken::DocumentComponent
+  describe ElimInvalidLinks, dsl: true do
+    describe '#has_no_invalid_links?' do
+      subject { component.has_no_invalid_links? }
+
+      context 'when a http link is given' do
+        let(:component) do
+          c(:a, { href: 'http://example.com' })
+        end
+
+        it { is_expected.to be_truthy }
+      end
+
+      context 'when a https link is given' do
+        let(:component) do
+          c(:a, { href: 'https://example.com' })
+        end
+
+        it { is_expected.to be_truthy }
+      end
+
+      context "when a disallowed link containing 'http://' is given" do
+        let(:component) do
+          c(:a, { href: '#hogefugahttp://' })
+        end
+
+        it { is_expected.to be_falsey }
+      end
+
+      context 'when a disallowed link is given' do
+        let(:component) do
+          c(:a, { href: '#hogehoge' })
+        end
+
+        it { is_expected.to be_falsey }
+      end
+
+      context 'when a disallowed link occurs as a component\'s children' do
+        let(:component) do
+          c(:div, c(:span, c(:a, { href: '#hogehoge' })))
+        end
+
+        it { is_expected.to be_falsey }
+      end
+    end
+  end
+end

data/spec/slacken/document_component/elim_line_breaks_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+class Slacken::DocumentComponent
+  describe ElimLineBreaks, dsl: true do
+    describe '#has_no_line_breaks?' do
+      subject { component.has_no_line_breaks? }
+
+      context 'when no linebreaks occur' do
+        let(:component) do
+          c(:div, c(:h1, text('yo!')), c(:wrapper, text('hello world!'), text('another')))
+        end
+
+        it { is_expected.to be_truthy }
+      end
+
+      context 'when a linebreak occurs in a inline component' do
+        let(:component) do
+          c(:div, c(:h1, text('yo!')), c(:wrapper, text('hello world!'), text("another\n")))
+        end
+
+        it { is_expected.to be_falsey }
+      end
+
+      context 'when a linebreak occurs in a block component' do
+        let(:component) do
+          c(:div, c(:h1, text("yo\n!")), c(:wrapper, text('hello world!'), text("another")))
+        end
+
+        it { is_expected.to be_falsey }
+      end
+
+      context 'when a linebreak occurs in a pre tag' do
+        let(:component) do
+          c(:div, c(:pre, text("yo\n!")), c(:wrapper, text('hello world!'), text("another")))
+        end
+
+        it { is_expected.to be_truthy }
+      end
+    end
+  end
+end

data/spec/slacken/document_component/group_indent_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+class Slacken::DocumentComponent
+  describe GroupIndent, dsl: true do
+    describe '#indent_grouped?' do
+      subject { component.indent_grouped? }
+
+      context 'when a indented list component is given' do
+        let(:component) do
+          c(:ul,
+            c(:li,
+              text('List Heading'),
+              c(:indent,
+                text('List Content1'),
+                c(:span, text('List Content2'), text('List Content3'))
+            )))
+        end
+
+        it { is_expected.to be_truthy }
+      end
+
+      context 'when a indented list where child component is not indented is given' do
+        let(:component) do
+          c(:ul,
+            c(:li,
+              text('List Heading'),
+              c(:span,
+                text('List Content1'),
+                c(:span, text('List Content2'), text('List Content3'))
+            )))
+        end
+
+        it { is_expected.to be_falsey }
+      end
+    end
+  end
+end

data/spec/slacken/document_component/group_inlines_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+class Slacken::DocumentComponent
+  describe GroupInlines, dsl: true do
+    describe '#inlines_grouped?' do
+      subject { component.inlines_grouped? }
+
+      context 'when a grouped component is given' do
+        let(:component) do
+          c(:div, c(:wrapper, text('hello world!'), text('another')))
+        end
+
+        it { is_expected.to be_truthy }
+      end
+
+      context 'when a component whose inline components are exposed is given' do
+        let(:component) do
+          c(:div, text(''), c(:div), c(:span))
+        end
+
+        it { is_expected.to be_falsey }
+      end
+
+      context 'when a component with only block components is given' do
+        let(:component) do
+          c(:div, c(:div), c(:img), c(:p, c(:h1)))
+        end
+
+        it { is_expected.to be_truthy }
+      end
+    end
+  end
+end

data/spec/slacken/document_component/sanitize_special_tag_containers_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+class Slacken::DocumentComponent
+  describe SanitizeSpecialTagContainers, dsl: true do
+    describe '#sanitized?' do
+      subject { component.sanitized? }
+
+      context 'when a header occurs in a list' do
+        let(:component) do
+          c(:ul,
+            c(:li,
+              text('header'),
+              c(:indent,
+                c(:h1, text('hoge')))))
+        end
+
+        it { is_expected.to be_falsey }
+      end
+
+      context 'when a list occurs in another list' do
+        let(:component) do
+          c(:ul,
+            c(:li,
+              text('header'),
+              c(:indent,
+                c(:dl,
+                  c(:li,
+                    text('header2'),
+                    c(:indent,
+                      text('fuga')))))))
+        end
+
+        it { is_expected.to be_truthy }
+      end
+
+      context 'when a code occurs in a header' do
+        let(:component) do
+          c(:h3,
+            text('A Ruby Code is Given: '),
+            c(:span,
+              c(:code, text("puts('hello, world!')"))))
+        end
+
+        it { is_expected.to be_falsey }
+      end
+
+      context 'when a pre tag occurs in a table' do
+        let(:component) do
+          c(:table,
+            c(:thead,
+              c(:tr,
+                c(:th, text('Header1')),
+                c(:th, text('Header2')))),
+            c(:tbody,
+              c(:tr,
+                c(:td, text('Content1')),
+                c(:td, c(:pre, (text('Content2')))))))
+        end
+
+        it { is_expected.to be_falsey }
+      end
+    end
+  end
+end