slacken 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 748574f85629230126187b4628430c5d8831f491
-  data.tar.gz: 8dfea56b37ed82aac7597ce7fd33fe3ed87b98dc
+  metadata.gz: 2833570db817e35c80edc5c2ec84657903c82a64
+  data.tar.gz: 3aa4ed03460af012db8137f15bc321df3426e1da
 SHA512:
-  metadata.gz: 4fbccd9ac94194719631dff4cef4d5ed07fecad897b6b55169162a0bb828c5d3b3ab1947595eb223f74d0c8283f4ed91f36ec9f1cca2a42dd7b6b489b9059f60
-  data.tar.gz: c5f1cf5dca2d0c5fb4cc24055a02a94101e3b46d8ed76652ab0c9605594a0ae1cccf1d95041cef1cc74bc5175291e209ef23bfd4c3dd28716442aa5edec0ad3f
+  metadata.gz: 52f1fc76598107f24e40e19aa76efe0fc8caa71ab87b552d6a70db3acbfc275fbd5b056d0add4fe7cd7f08b73aa31cddfc7f440aeb520272b183d7541314a9f9
+  data.tar.gz: 7d4884483a55ea08247ce1f586dfd0699ef10179c89f71aeba6e7ac1005f98944a0d6d87da9aaae31d6418a2cd7e55a3dd0ab415ac26470ca6af9dfbfddb3930

data/README.md

@@ -7,7 +7,7 @@ Official description of Slack message formatting is [here](https://api.slack.com
 
 ## Examples
 
-Sample input source and output texts are in `examples/`.
+The following code translates [a html source](https://github.com/increments/slacken/blob/master/examples/source.html) to [a markup text](https://github.com/increments/slacken/blob/master/examples/out.txt) for Slack
 
 ```
 > require 'slacken'
@@ -15,7 +15,7 @@ Sample input source and output texts are in `examples/`.
 # *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:.
+# <https://teams.qiita.com|Qiita:Team> uses this gem to decorate notification messages to Slack :trollface:.
 #
 # *Examples*
 #
@@ -32,7 +32,7 @@ Sample input source and output texts are in `examples/`.
 # *Citation*
 #
 # > Qiita is a technical information sharing site for programmers.
-# >  Kobito is an application for technical information recording.
+# > Kobito is an application for technical information recording.
 #
 # *Source Code*
 #
@@ -43,12 +43,12 @@ Sample input source and output texts are in `examples/`.
 # end
 # ```
 #
+# -----------
+#
 # *Image*
 #
 # This is a Qiita logo.
 #
-# -----------
-#
 # <http://cdn.qiita.com/assets/siteid-reverse-1949e989f9d8b2f6fad65a57292b2b01.png|Qiita logo>
 ```
 

data/examples/out.txt

@@ -1,7 +1,7 @@
 *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:.
+<https://teams.qiita.com|Qiita:Team> uses this gem to decorate notification messages to Slack :trollface:.
 
 *Examples*
 
@@ -18,7 +18,7 @@ This gem translates a html source into *a markup text for Slack*.
 *Citation*
 
 > Qiita is a technical information sharing site for programmers.
->  Kobito is an application for technical information recording.
+> Kobito is an application for technical information recording.
 
 *Source Code*
 
@@ -29,10 +29,10 @@ This gem translates a html source into *a markup text for Slack*.
 end
 ```
 
+-----------
+
 *Image*
 
 This is a Qiita logo.
 
------------
-
 <http://cdn.qiita.com/assets/siteid-reverse-1949e989f9d8b2f6fad65a57292b2b01.png|Qiita logo>

data/examples/source.html

@@ -2,7 +2,7 @@
 <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>
+<a href="https://teams.qiita.com">Qiita:Team</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>
 
@@ -46,10 +46,10 @@ Kobito is an application for technical information recording.</p>
 <span class="k">end</span>
 </pre></div></div>
 
+<hr>
+
 <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>

data/lib/slacken/filters/elim_blanks.rb

@@ -32,7 +32,7 @@ module Slacken::Filters
           false
         when :text, :emoji
           content = component.attrs[:content]
-          content.nil? || !content.match(/\A\s*\Z/).nil?
+          content.nil? || !content.match(/\A\n*\Z/).nil?
         else
           component.children.empty? || component.children.all?(&method(:blank?))
         end

data/lib/slacken/rendering.rb

@@ -1,10 +1,23 @@
 module Slacken
+  # Internal: Contain classes calculating proper spacing to serialize RenderElement.
+  #
+  # TODO: The class and module names are vague.
+  #       Give better names to these class and module.
   module Rendering
     def self.decorate(str)
       DecorationWrapper.new(str)
     end
 
-    # Private: A wrapper of string to concat node strings of a document tree.
+    # These StringWrapper and DecorationWrapper is to calculate spacing of
+    # each RenderElement's string representation.
+    #
+    # Most formatting expression in Slack messages should have distances from neighbor strings.
+    # For example, Slack does not make the following text `*should-be-bold*` bold.
+    #
+    #   previous-string-*should-be-bold*-next-string
+    #
+
+    # Internal: A string which may adjoin previous and next strings.
     class StringWrapper
       def self.wrap(str)
         str.kind_of?(StringWrapper) ? str : new(str)
@@ -18,18 +31,18 @@ module Slacken
         @str.to_s
       end
 
-      # Public: Append another string to self.
+      # Internal: Append another string to self.
       def append(other)
         other.concat_head(self)
       end
 
-      # Private: prepend another string to self.
+      # Internal: 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.
+    # Internal: A string which should put distances from previous and next strings.
     class DecorationWrapper < StringWrapper
 
       # Public: Append another string to self.
@@ -59,7 +72,25 @@ module Slacken
       end
     end
 
-    # Public: an intermediate object to stringfy RenderElements.
+    # These classes represents gruop of strings and they concat their strings with
+    # their own separator.
+    # They also works with StringWrapper and DecorationWrapper to avoid
+    # bad or unnecessary spacing.
+    #
+    # For example, Slack does not make the following text `* should-be-bold *` bold
+    # because there are spaces after the first asterisk and before the last asterisk.
+    #
+    #   * should-be-bold *
+    #
+    # Besides, for such the formatting expressions, it is unnecessary to put space on
+    # the beginning of each new line. Unnecessary spacing does not look good.
+    #
+    #   This is the first line.
+    #    *This* is the second line.
+    #   This is the third line.
+    #
+
+    # Internal: an intermediate object to stringfy RenderElements.
     class RenderingGroup
       attr_reader :children
       def initialize(children)
@@ -70,6 +101,7 @@ module Slacken
         fail NotImplementedError
       end
 
+      # Internal: Return Array of Strings, where there are separators between each string.
       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]

data/lib/slacken/version.rb

@@ -1,3 +1,3 @@
 module Slacken
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/slacken_spec.rb

@@ -319,11 +319,11 @@ describe Slacken do
       end
     end
 
-    context 'when a is given' do
-      let(:source) { '<p><a href="http://qiita.com">qiita</a></p>' }
+    context 'when space-separated links are given' do
+      let(:source) { '<p><a href="/alice">@alice</a> <a href="/bob">@bob</a></p>' }
 
-      it 'converts to link notation' do
-        should eq "<http://qiita.com|qiita>"
+      it 'preserves the space' do
+        should eq "@alice @bob"
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slacken
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Tomoya Chiba
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -200,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Translate HTML sources to markup texts for slack