slacken 0.1.0

data/lib/slacken/document_component/stringfy_checkbox.rb

@@ -0,0 +1,20 @@
+class Slacken::DocumentComponent
+  module StringfyCheckbox
+    # Private: Reject blank elements
+    def stringfy_checkbox
+      if type.member_of?(:input) && attrs[:type] == 'checkbox'
+        self.class.new(:checkbox, [], checked: attrs[:checked])
+      else
+        derive(children.map(&:stringfy_checkbox))
+      end
+    end
+
+    def checkbox_stringfied?
+      if type.member_of?(:input) && attrs[:type] == 'checkbox'
+        false
+      else
+        children.all?(&:checkbox_stringfied?)
+      end
+    end
+  end
+end

data/lib/slacken/document_component/stringfy_emoji.rb

@@ -0,0 +1,20 @@
+class Slacken::DocumentComponent
+  module StringfyEmoji
+    # Private: Reject blank elements
+    def stringfy_emoji
+      if type.member_of?(:img) && attrs[:class].include?('emoji')
+        self.class.new(:emoji, [], content: attrs[:alt])
+      else
+        derive(children.map(&:stringfy_emoji))
+      end
+    end
+
+    def emoji_stringfied?
+      if type.member_of?(:img) && attrs[:class].include?('emoji')
+        false
+      else
+        children.all?(&:emoji_stringfied?)
+      end
+    end
+  end
+end

data/lib/slacken/dom_container.rb

@@ -0,0 +1,45 @@
+require 'nokogiri'
+
+# Public: a DOM tree container parsed by Nokogiri.
+module Slacken
+  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)
+    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
+    end
+
+    def attrs_of(node)
+      case node.name.to_sym
+      when :text
+        { content: node.content }
+      when :iframe, :a
+        { href: node['href'] }
+      when :input
+        { type: node['type'], checked: node['checked'] }
+      when :img
+        { src: node['src'], alt: node['alt'], class: (node['class'] || '').split }
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/slacken/node_type.rb

@@ -0,0 +1,53 @@
+module Slacken
+  class NodeType
+    def self.create(name)
+      name.is_a?(NodeType) ? name : new(name)
+    end
+
+    attr_reader :name
+    def initialize(name)
+      @name = name.to_sym
+    end
+
+    def member_of?(*names)
+      names.flatten.include?(name)
+    end
+
+    def text_types
+      %i(text emoji checkbox)
+    end
+
+    def block?
+      member_of?(%i(document div iframe p img ul ol dl dd li hr indent
+                    p h1 h2 h3 h4 h5 h6 h7 h8 pre blockquote body html))
+    end
+
+    def inline?
+      !block?
+    end
+
+    def text_type?
+      member_of?(text_types)
+    end
+
+    def allowed_in_list?
+      member_of?(%i(code b strong i em wrapper div indent span ol ul dl li dd dt).concat(text_types))
+    end
+
+    def allowed_as_list_item?
+      member_of?(%i(code b strong i em wrapper span).concat(text_types))
+    end
+
+    def allowed_in_headline?
+      member_of?(%i(i em wrapper span).concat(text_types))
+    end
+
+    def allowed_in_table?
+      member_of?(%i(code b strong i em wrapper span).concat(text_types))
+    end
+
+    def allowed_in_link?
+      member_of?(%i(b strong i em wrapper span).concat(text_types))
+    end
+  end
+end

data/lib/slacken/render_element.rb

@@ -0,0 +1,91 @@
+module Slacken
+  class RenderElement
+    attr_reader :type, :renderer, :attrs, :children
+
+    def initialize(type, children = [], attrs = {})
+      @type = NodeType.create(type)
+      @attrs = attrs
+      @children = children
+    end
+
+    def child
+      children.first
+    end
+
+    def render
+      case type.name
+      when :text
+        attrs[:content]
+      when :emoji
+        deco "#{attrs[:content]}"
+      when :checkbox
+        deco (attrs[:checked] ? '[x]' : '[ ]')
+      when :b, :strong
+        deco "*#{inner.to_s.strip}*"
+      when :i, :em
+        deco "_#{inner.to_s.strip}_"
+      when :iframe, :a
+        deco SlackUrl.link_tag(inner, attrs[:href])
+      when :img
+        deco SlackUrl.link_tag(inner, attrs[:src])
+      when :pre
+        deco "```#{inner}```"
+      when :blockquote
+        insert_head(inner.to_s, '> ')
+      when :code
+        deco "`#{inner}`"
+      when :br
+        "\n"
+      when :hr
+        '-----------'
+      when :li, :dd
+        # Item mark is appended by the parent list tag.
+        inner
+      when :ol, :ul, :dl
+        itemize
+      when :indent
+        insert_head(inner.to_s)
+      when /h\d/
+        "*#{inner.to_s.strip}*"
+      else
+        inner
+      end
+    end
+
+    def to_s
+      render.to_s
+    end
+
+    private
+
+    def itemize
+      children_strs = children.map.with_index(1) do |child, idx|
+        mark = type.member_of?(:ol) ? "#{idx}. " : '• '
+        "#{mark}#{child}"
+      end
+      grouping(children_strs)
+    end
+
+    def inner
+      grouping(children.map(&:render))
+    end
+
+    def grouping(children_strs)
+      if type.inline?
+        Rendering::Inlines.new(children_strs)
+      elsif type.member_of?(:ul, :ol, :dl, :li, :dd, :dt)
+        Rendering::Listings.new(children_strs)
+      elsif type.block?
+        Rendering::Paragraphs.new(children_strs)
+      end
+    end
+
+    def insert_head(str, head = ' ' * 4)
+      str.gsub(/^/, head)
+    end
+
+    def deco(str)
+      Rendering.decorate(str)
+    end
+  end
+end

data/lib/slacken/rendering.rb

@@ -0,0 +1,102 @@
+module Slacken
+  module Rendering
+    def self.decorate(str)
+      DecorationWrapper.new(str)
+    end
+
+    # Private: A wrapper of string to concat node strings of a document tree.
+    class StringWrapper
+      def self.wrap(str)
+        str.kind_of?(StringWrapper) ? str : new(str)
+      end
+
+      def initialize(str)
+        @str = str
+      end
+
+      def to_s
+        @str.to_s
+      end
+
+      # Public: Append another string to self.
+      def append(other)
+        other.concat_head(self)
+      end
+
+      # Private: prepend another string to self.
+      def concat_head(other)
+        StringWrapper.new(other.to_s + to_s)
+      end
+    end
+
+    # Private: A wrapper to space before and after the given string.
+    class DecorationWrapper < StringWrapper
+
+      # Public: Append another string to self.
+      #         If the other string begin with a word character,
+      #         A space is inserted between the two string.
+      def append(other)
+        if other.to_s.empty?
+          self
+        elsif other.to_s.match(/\A[\W&&[:ascii:]]/)
+          other.concat_head(self)
+        else
+          StringWrapper.new(to_s + " ").append(other)
+        end
+      end
+
+      # Private: Prepend another string to self.
+      #          If the other string end with a word character,
+      #          A space is inserted between the two string.
+      def concat_head(other)
+        if other.to_s.empty?
+          self
+        elsif other.to_s.match(/[\W&&[:ascii:]]\Z/)
+          DecorationWrapper.new(other.to_s + to_s)
+        else
+          DecorationWrapper.new("#{other} #{to_s}")
+        end
+      end
+    end
+
+    # Public: an intermediate object to stringfy RenderElements.
+    #
+    class RenderingGroup
+      attr_reader :children
+      def initialize(children)
+        @children = children
+      end
+
+      def separator
+        fail NotImplementedError
+      end
+
+      def to_a
+        extracted_children = children.map { |c| c.respond_to?(:to_a) ? c.to_a : c }
+        extracted_children.zip(Array.new(children.length, separator)).flatten[0..-2]
+      end
+
+      def to_s
+        to_a.reduce(StringWrapper.new('')) { |r, el| r.append(StringWrapper.wrap(el)) }.to_s
+      end
+    end
+
+    class Paragraphs < RenderingGroup
+      def separator
+        "\n\n"
+      end
+    end
+
+    class Listings < RenderingGroup
+      def separator
+        "\n"
+      end
+    end
+
+    class Inlines < RenderingGroup
+      def separator
+        ''
+      end
+    end
+  end
+end

data/lib/slacken/slack_url.rb

@@ -0,0 +1,7 @@
+module Slacken
+  module SlackUrl
+    def self.link_tag(title, url)
+      "<#{url}|#{title}>"
+    end
+  end
+end

data/lib/slacken/table_element.rb

@@ -0,0 +1,23 @@
+require 'kosi'
+
+module Slacken
+  class TableElement
+    attr_reader :header, :columns
+    def initialize(children)
+      thead, tbody = children.slice(0, 2)
+      @header = thead.child # tr tag
+      @columns = tbody.children # tr tags
+    end
+
+    def render
+      head = header.children.map(&:to_s)
+      body = columns.map { |cl| cl.children.map(&:to_s) }
+      table = Kosi::Table.new(header: head).render(body)
+      table.to_s.chomp
+    end
+
+    def to_s
+      render
+    end
+  end
+end

data/lib/slacken/version.rb

@@ -0,0 +1,3 @@
+module Slacken
+  VERSION = "0.1.0"
+end

data/sample/out.txt

@@ -0,0 +1,38 @@
+*Slacken*
+
+This gem translates a html source into *a markup text for Slack*.
+<http://qiita.com|Qiita> uses this gem to decorate notification messages to Slack :trollface:.
+
+*Examples*
+
+*List*
+
+1. Item 1
+2. _Item 2 (italic)_
+    • [x] Checked
+    • [ ] Unchecked
+3. *Item 3 (bold)*
+    • Nested Item 1
+    • Nested Item 2
+
+*Citation*
+
+> Qiita is a technical information sharing site for programmers.
+>  Kobito is an application for technical information recording.
+
+*Source Code*
+
+```class World
+  def hello
+    puts 'Hello, world!'
+  end
+end
+```
+
+*Image*
+
+This is a Qiita logo.
+
+-----------
+
+<http://cdn.qiita.com/assets/siteid-reverse-1949e989f9d8b2f6fad65a57292b2b01.png|Qiita logo>

data/sample/source.html

@@ -0,0 +1,55 @@
+
+<h1>Slacken</h1>
+
+<p>This gem translates a html source into <strong>a markup text for Slack</strong>.<br>
+<a href="http://qiita.com">Qiita</a> uses this gem to decorate notification messages to Slack <img class="emoji" title=":trollface:" alt=":trollface:" src="https://cdn.qiita.com/emoji/trollface.png" height="20" width="20" align="absmiddle">.</p>
+
+<h2>Examples</h2>
+
+<h3>List</h3>
+
+<ol>
+<li>Item 1</li>
+<li>
+<em>Item 2 (italic)</em>
+
+<ul>
+<li class="task-list-item">
+<input type="checkbox" class="task-list-item-checkbox" checked disabled>Checked</li>
+<li class="task-list-item">
+<input type="checkbox" class="task-list-item-checkbox" disabled>Unchecked</li>
+</ul>
+</li>
+<li>
+<strong>Item 3 (bold)</strong>
+
+<ul>
+<li>Nested Item 1</li>
+<li>Nested Item 2</li>
+</ul>
+</li>
+</ol>
+
+<h3>Citation</h3>
+
+<blockquote>
+<p>Qiita is a technical information sharing site for programmers.<br>
+Kobito is an application for technical information recording.</p>
+</blockquote>
+
+<h3>Source Code</h3>
+
+<div class="code-frame" data-lang="rb"><div class="highlight"><pre><span class="k">class</span> <span class="nc">World</span>
+  <span class="k">def</span> <span class="nf">hello</span>
+    <span class="nb">puts</span> <span class="s1">'Hello, world!'</span>
+  <span class="k">end</span>
+<span class="k">end</span>
+</pre></div></div>
+
+<h3>Image</h3>
+
+<p>This is a Qiita logo.</p>
+
+<hr>
+
+<p><img src="http://cdn.qiita.com/assets/siteid-reverse-1949e989f9d8b2f6fad65a57292b2b01.png" alt="Qiita logo"></p>