slacken 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fc0f32867586c7b5d1bcc0f8d6f50a7397c8fc7
-  data.tar.gz: 437c297ac0aec496d3002bc88770fce4919a5ec7
+  metadata.gz: 25a6903ad8c0859f0fd8140f05528957baf272aa
+  data.tar.gz: e251a3b49123a5fc4b04d20e07067bdacca79feb
 SHA512:
-  metadata.gz: 4e4283f2ff319d82403f1465b2e8fe74da8a7f2e6d61e3489bfd44224038e7e719e8cba5165a88b8fd3902ed4113810b0baf51e392450fec8d7fca1554251a47
-  data.tar.gz: 6ee2318990b5e0a67579a8114f5e9f1a5b8215b21b5f6110c717c3b154db4b5ae08a962628b057a97124eaa043ce9d5f0ce6f2cda80fd715b8c7b9c2311fecc0
+  metadata.gz: f603ab28cf2342146a68b18c0b154a8d776036494ff4cbb687ea52fce82745f8eb1091acb1bdb933f73be31d785ca4d30a5c855d5ff285a1ec77a1e50b41457e
+  data.tar.gz: 188a11057e56f4afb82720fb281e14948449da79a86ae948eb00a1faf7641126505274ab6595e516baa5c80a8b5a47f1aa776ea58919b37f6e97436ce0ac2135

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Tomoya Chiba
+Copyright (c) 2015 Increments inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/slacken.rb

@@ -9,13 +9,22 @@ module Slacken
   require 'slacken/version'
 
   class << self
+    # Public: Translate HTML string into Markdown string.
+    #
+    # html_source - A String or IO.
+    #
+    # Returns a markdown String.
     def translate(html_source)
-      convert(html_source).to_s
+      convert_html_to_document_component(html_source).to_element.to_s
     end
 
-    def convert(html_source)
-      Slacken::DomContainer.parse_html(html_source)
-        .to_component.to_element
+    private
+
+    # Internal: Parse a HTML string and convert it to a DocumentComponent object.
+    #
+    # Returns a DocumentComponent.
+    def convert_html_to_document_component(html_source)
+      DocumentComponent.build_by_html(html_source)
     end
   end
 end

data/lib/slacken/document_component.rb

@@ -6,7 +6,7 @@ module Slacken
   #         representing structure of a markup text.
   #         A DocumentComponent has tree structure and has child nodes as `children`.
   class DocumentComponent
-    NormalizeFilters = [
+    NORMALIZE_FILTERS = [
       Filters::StringfyEmoji,
       Filters::StringfyCheckbox,
       Filters::ExtractImgAlt,
@@ -26,6 +26,15 @@ module Slacken
 
     attr_reader :type, :attrs, :children, :marks
 
+    # Public: Parse a html source with nokogiri and create a component.
+    #
+    # html_source - A String or IO.
+    #
+    # Returns a DocumentComponent or nil.
+    def self.build_by_html(html_source)
+      DomContainer.new(Nokogiri::HTML(html_source)).to_component
+    end
+
     def initialize(type, children = [], attrs = {})
       @type = NodeType.create(type)
       @attrs = attrs
@@ -35,7 +44,10 @@ module Slacken
 
     def derive(new_children, updates = {})
       self.class.new(
-        updates[:type] || type, new_children, updates[:attrs] || attrs)
+        updates[:type] || type,
+        new_children,
+        updates[:attrs] || attrs
+      )
     end
 
     # Public: Normalize this object's structure and convert it to MarkupElement.
@@ -44,7 +56,7 @@ module Slacken
     end
 
     def normalize
-      NormalizeFilters.reduce(self) do |component, filter_klass|
+      NORMALIZE_FILTERS.reduce(self) do |component, filter_klass|
         filter_klass.new.call(component)
       end
     end

data/lib/slacken/dom_container.rb

@@ -3,28 +3,41 @@ require 'nokogiri'
 module Slacken
   # Public: a DOM tree container parsed by Nokogiri.
   class DomContainer
-    attr_reader :root
-
-    # Public: Parse a html source with nokogiri and create a container.
-    def self.parse_html(body)
-      new(Nokogiri::HTML(body))
-    end
-
     def initialize(root)
       @root = root
     end
 
-    def to_component(node = root)
-      children = node.children.map { |nd| to_component(nd) }.compact
-      leave(node, children)
+    # Public: Create a DocumentComponent of the root node.
+    #
+    # Returns a DocumentComponent or nil.
+    def to_component
+      build_document_component(@root)
     end
 
     private
 
-    def leave(node, children)
-      if !(node.respond_to?(:html_dtd?) && node.html_dtd?)
-        DocumentComponent.new(node.name.downcase, children, attrs_of(node))
-      end
+    # Internal: Build a DocumentComponent of the given node recursively.
+    #
+    # current_node - A Nokogiri::HTML::Document.
+    #
+    # Returns a DocumentComponent.
+    def build_document_component(node)
+      DocumentComponent.new(
+        node.name.downcase,
+        build_document_components_array(node.children),
+        attrs_of(node)
+      )
+    end
+
+    # Internal: Build sequence of DocumentComponent objects for each given nodes.
+    #
+    # nodes - A Nokogiri::XML::NodeSet.
+    #
+    # Returns an Array of DocumentComponents.
+    def build_document_components_array(node_set)
+      node_set
+        .reject { |node| node.respond_to?(:html_dtd?) && node.html_dtd? }
+        .map { |node| build_document_component(node) }
     end
 
     def attrs_of(node)

data/lib/slacken/filters/elim_blanks.rb

@@ -28,7 +28,7 @@ module Slacken::Filters
 
       component.marks[:blank] =
         case component.type.name
-        when :pre, :ul, :li, :br, :hr, :img, :checkbox
+        when :pre, :ul, :li, :br, :hr, :img, :checkbox, :td
           false
         when :text, :emoji
           content = component.attrs[:content]

data/lib/slacken/filters/sanitize_list.rb

@@ -23,16 +23,16 @@ module Slacken::Filters
 
     def sanitize_list(component)
       if component.type.member_of?(:li, :dd)
-          head, *tails = component.children
-          component.derive(
-            [sanitize_list_item(head), *tails.map(&method(:sanitize_list))]
-          )
+        head, *tails = component.children
+        component.derive(
+          [sanitize_list_item(head), *tails.map(&method(:sanitize_list))]
+        )
       elsif component.type.allowed_in_list?
         component.derive(component.children.map(&method(:sanitize_list)))
       else
         component.derive(
           component.children.map(&method(:sanitize_list)),
-          type: block? ? :div : :span
+          type: component.block? ? :div : :span
         )
       end
     end

data/lib/slacken/version.rb

@@ -1,3 +1,3 @@
 module Slacken
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/slacken.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   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.authors       = ["Tomoya Chiba", "Yuku Takahashi"]
+  gem.email         = ["tomo.asleep@qiita.com", "yuku@qiita.com"]
   gem.homepage      = "https://rubygems.org/gems/slacken"
 
   gem.files         = `git ls-files`.split($/)
@@ -22,6 +22,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rdoc', '~> 3.0'
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'unindent', '~> 1.0'
 
   gem.add_runtime_dependency 'nokogiri', '~> 1.6'
   gem.add_runtime_dependency 'kosi', '~> 1.0'

data/spec/helpers/document_component_dsl.rb

@@ -1,11 +1,15 @@
-# 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
+module Slacken
+  module Helpers
+    # 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)
+      def text(content)
+        Slacken::DocumentComponent.new(:text, [], content: content)
+      end
+    end
   end
 end

data/spec/slacken/document_component_spec.rb

@@ -1,16 +1,18 @@
 require 'spec_helper'
 
-module Slacken
-  describe DocumentComponent do
-    describe '#normalize' do
-      subject { DomContainer.parse_html(source).to_component.normalize }
-      let(:source) { fixture('example.html') }
+describe Slacken::DocumentComponent do
+  let(:document_component) { described_class.build_by_html(source) }
+  # If you change the behavior, you should run `scripts/update_markup_fixture.rb`
+  # to update fixture file.
+  let(:source) { fixture('example.html') }
 
-      DocumentComponent::NormalizeFilters.each do |klass|
-        context "when #{klass.name} checks the result's validity" do
-          let(:filter) { klass.new }
-          it { is_expected.to satisfy(&filter.method(:valid?)) }
-        end
+  describe '#normalize' do
+    subject { document_component.normalize }
+
+    Slacken::DocumentComponent::NORMALIZE_FILTERS.each do |klass|
+      context "when #{klass.name} checks the result's validity" do
+        let(:filter) { klass.new }
+        it { is_expected.to satisfy(&filter.method(:valid?)) }
       end
     end
   end

data/spec/slacken/filters/sanitize_list_spec.rb

@@ -33,4 +33,18 @@ describe Slacken::Filters::SanitizeList, dsl: true do
       it { is_expected.to be_truthy }
     end
   end
+
+  describe '#call' do
+    let(:filter) { described_class.new.call(component) }
+
+    context 'when a list has a img tag' do
+      let(:component) do
+        c(:ul, c(:img))
+      end
+
+      it 'changes img to div tag' do
+        expect(filter.children.first.type.name).to eq :div
+      end
+    end
+  end
 end

data/spec/slacken_spec.rb

@@ -3,13 +3,326 @@ require 'spec_helper'
 describe Slacken do
   describe '#translate' do
     subject { described_class.translate(source) }
-    let(:source) { fixture('example.html') }
 
-    # This test checks whether the behavior of this translation engine is unexpectedly broken.
-    # If you change the behavior, you should run `scripts/update_markup_fixture.rb`
-    # to update fixture file.
-    it 'translates as expected' do
-      expect(subject).to eq(fixture('markup_text.txt'))
+    context 'when h1 is given' do
+      let(:source) do
+        <<-EOS.unindent
+          <h1>
+            <span id="heading-bold"></span>
+            <a><i class="fa fa-link"></i></a>
+            heading <em>italic</em> <strong>bold</strong>
+          </h1>
+        EOS
+      end
+
+      it 'wraps inner text with "*"' do
+        should eq '*heading _italic_ bold*'
+      end
+    end
+
+    context 'when p is given' do
+      let(:source) { '<p>hello world</p>' }
+
+      it 'returns inner text' do
+        should eq "hello world"
+      end
+    end
+
+    context 'when br is given' do
+      let(:source) { '<p>hello<br>world</p>' }
+
+      it 'converts br into new line char' do
+        should eq "hello\nworld"
+      end
+    end
+
+    context 'when em is given' do
+      let(:source) { '<p><em>italic</em></p>' }
+
+      it 'wraps inner text with "_"' do
+        should eq '_italic_'
+      end
+    end
+
+    context 'when string is given' do
+      let(:source) { '<p><strong>bold</strong></p>' }
+
+      it 'wraps inner text with "*"' do
+        should eq '*bold*'
+      end
+    end
+
+    context 'when code is given' do
+      let(:source) { '<p><code>code</code></p>' }
+
+      it 'wraps inner text with "`"' do
+        should eq '`code`'
+      end
+    end
+
+    context 'when emoji img is given' do
+      let(:source) do
+        <<-EOS.unindent
+          <p>
+          hello
+          <img  class="emoji" title=":eyes:" alt=":eyes:" src="https://cdn.qiita.com/emoji/unicode/1f440.png" height="20" width="20" align="absmiddle">
+          world
+          <img class="emoji" title=":bowtie:" alt=":bowtie:" src="https://cdn.qiita.com/emoji/bowtie.png" height="20" width="20" align="absmiddle">
+          </p>
+        EOS
+      end
+
+      it 'replaces img elements with corresponding emoji notation' do
+        should eq 'hello :eyes: world :bowtie:'
+      end
+    end
+
+    context 'when nested ul, ol and li elements are given' do
+      let(:source) do
+        <<-EOS.unindent
+          <ol>
+          <li>リスト1
+          <ul>
+          <li>リスト1-1</li>
+          <li>リスト1-2</li>
+          </ul>
+          </li>
+          <li>リスト2
+          <ol>
+          <li>リスト2-1</li>
+          </ol>
+          </li>
+          </ol>
+        EOS
+      end
+
+      it 'converts to list notation' do
+        should eq <<-EOS.unindent.chomp
+        1. リスト1
+            • リスト1-1
+            • リスト1-2
+        2. リスト2
+            1. リスト2-1
+        EOS
+      end
+    end
+
+    context 'when task lists are given' do
+      let(:source) do
+        <<-EOS.unindent
+          <ul>
+          <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>
+        EOS
+      end
+
+      it 'converts to list notation with ascii checkbox' do
+        should eq <<-EOS.unindent.chomp
+          • [x] Checked item
+          • [ ] Unchecked item
+        EOS
+      end
+    end
+
+    context 'when dl is given' do
+      let(:source) do
+        <<-EOS.unindent
+          <dl>
+          <dt>定義語リストとは？</dt>
+          <dd>こんなかんじで単語の意味を説明していくリストです。</dd>
+          <dt>他の単語</dt>
+          <dd>ここに説明を書く</dd>
+          </dl>
+        EOS
+      end
+
+      it 'converts to list notation' do
+        should eq <<-EOS.unindent.chomp
+          • 定義語リストとは？
+          • こんなかんじで単語の意味を説明していくリストです。
+          • 他の単語
+          • ここに説明を書く
+        EOS
+      end
+    end
+
+    context 'when blockquote is given' do
+      let(:source) do
+        <<-EOS.unindent
+          <blockquote>
+          <p>この文字列は引用されたものです<br>
+          インデントされているはず<br>
+          これはもインデントされている</p>
+          </blockquote>
+
+          <p>これはインデントされない</p>
+        EOS
+      end
+
+      it 'inserts ">" to each lines' do
+        should eq <<-EOS.unindent.chomp
+          > この文字列は引用されたものです
+          > インデントされているはず
+          > これはもインデントされている
+
+          これはインデントされない
+        EOS
+      end
+    end
+
+    context 'when code block is given' do
+      let(:source) do
+        <<-EOS.unindent
+          <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>
+        EOS
+      end
+
+      it 'wraps inner text with "```"' do
+        should eq <<-EOS.unindent.chomp
+          ```class Klass
+            def method
+              puts 'method called!'
+            end
+          end
+          ```
+        EOS
+      end
+    end
+
+    context 'when table is given' do
+      let(:source) do
+        <<-EOS.unindent
+          <table>
+          <thead>
+          <tr>
+          <th>Header1</th>
+          <th>Header2</th>
+          </tr>
+          </thead>
+          <tbody>
+          <tr>
+          <td>Cell1</td>
+          <td>Cell2</td>
+          </tr>
+          <tr>
+          <td>hello</td>
+          <td>world</td>
+          </tr>
+          </tbody>
+          </table>
+        EOS
+      end
+
+      it 'converts html to table notation' do
+        should eq <<-EOS.unindent.chomp
+          +-------+-------+
+          |Header1|Header2|
+          +-------+-------+
+          |Cell1  |Cell2  |
+          |hello  |world  |
+          +-------+-------+
+        EOS
+      end
+    end
+
+    context 'when table with empty td is given' do
+      let(:source) do
+        <<-EOS.unindent
+          <table>
+          <thead>
+          <tr>
+          <th>Header1</th>
+          <th>Header2</th>
+          </tr>
+          </thead>
+          <tbody>
+          <tr>
+          <td>A</td>
+          <td></td>
+          </tr>
+          <tr>
+          <td>B</td>
+          <td>C</td>
+          </tr>
+          </tbody>
+          </table>
+        EOS
+      end
+
+      it 'converts html to table notation' do
+        should eq <<-EOS.unindent.chomp
+          +-------+-------+
+          |Header1|Header2|
+          +-------+-------+
+          |A      |       |
+          |B      |C      |
+          +-------+-------+
+        EOS
+      end
+    end
+
+    context 'when img is given' do
+      let(:source) { "<p><img src='#{src}' alt='#{alt}'></p>" }
+      let(:src) { 'http://cdn.qiita.com/logo.png' }
+      let(:alt) { 'Qiita logo' }
+
+      it 'convert inner text to img notation' do
+        should eq "<#{src}|#{alt}>"
+      end
+    end
+
+    context 'when img in a is given' do
+      let(:source) { "<p><a href='#{src}'><img src='#{src}' alt='#{alt}'></a></p>" }
+      let(:src) { 'http://cdn.qiita.com/logo.png' }
+      let(:alt) { 'Qiita logo' }
+
+      it 'ignores the link' do
+        should eq "<#{src}|#{alt}>"
+      end
+    end
+
+    context 'when a is given' do
+      let(:source) { '<p><a href="http://qiita.com">qiita</a></p>' }
+
+      it 'converts to link notation' do
+        should eq "<http://qiita.com|qiita>"
+      end
+    end
+
+    context 'when hr is given' do
+      let(:source) do
+        <<-EOS.unindent
+          <p>before</p>
+          <hr>
+          <p>after</p>
+        EOS
+      end
+
+      it 'converts to "-----------"' do
+        should eq <<-EOS.unindent.chomp
+          before
+
+          -----------
+
+          after
+        EOS
+      end
+    end
+
+    context 'when del is given' do
+      let(:source) { '<del>ignore</del>' }
+
+      it 'returns inner text' do
+        should eq 'ignore'
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rspec'
 require 'slacken'
+require 'unindent'
 
 require 'helpers/document_component_dsl'
 
@@ -8,5 +9,5 @@ def fixture(name)
 end
 
 RSpec.configure do |c|
-  c.include DocumentComponentDsl, dsl: true
+  c.include Slacken::Helpers::DocumentComponentDsl, dsl: true
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: slacken
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tomoya Chiba
+- Yuku Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: unindent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +124,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Translate HTML sources to markup texts for slack
-email: tomo.asleep@gmail.com
+email:
+- tomo.asleep@qiita.com
+- yuku@qiita.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -183,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Translate HTML sources to markup texts for slack