slacken 0.1.0 → 0.1.1

data/spec/slacken/filters/sanitize_link_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Slacken::Filters::SanitizeLink, dsl: true do
+  describe '#valid?' do
+    subject { described_class.new.valid?(component) }
+
+    context 'when a image occurs in a link' do
+      let(:component) do
+        c(:a, c(:img))
+      end
+
+      it { is_expected.to be_falsey }
+    end
+
+    context 'when a strong occurs in a link' do
+      let(:component) do
+        c(:a,  c(:strong, text('content')))
+      end
+
+      it { is_expected.to be_truthy }
+    end
+  end
+end

data/spec/slacken/filters/sanitize_list_spec.rb

@@ -0,0 +1,36 @@
+
+require 'spec_helper'
+
+describe Slacken::Filters::SanitizeList, dsl: true do
+  describe '#valid?' do
+    subject { described_class.new.valid?(component) }
+
+    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
+  end
+end

data/spec/slacken/filters/sanitize_table_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Slacken::Filters::SanitizeTable, dsl: true do
+  describe '#valid?' do
+    subject { described_class.new.valid?(component) }
+
+    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
+
+    context 'when only allowed tags occur in a table' do
+      let(:component) do
+        c(:table,
+          c(:thead,
+            c(:tr,
+              c(:th, text('Header1')),
+              c(:th, c(:span, c(:i, text('Header2')))))),
+          c(:tbody,
+            c(:tr,
+              c(:td, c(:code, text('Content1'))),
+              c(:td, c(:strong, text('Content2'))))))
+      end
+
+      it { is_expected.to be_truthy }
+    end
+  end
+end

data/spec/slacken_spec.rb

@@ -5,6 +5,9 @@ describe Slacken 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'))
     end

data/spec/spec_helper.rb

@@ -4,8 +4,7 @@ require 'slacken'
 require 'helpers/document_component_dsl'
 
 def fixture(name)
-  @fixture_cache ||= {}
-  @fixture_cache[name] ||= File.read(File.expand_path(name, File.expand_path('fixtures', __dir__)))
+  File.read(File.join(__dir__, 'fixtures', name))
 end
 
 RSpec.configure do |c|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slacken
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tomoya Chiba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2015-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,43 +116,51 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/out.txt
+- examples/source.html
 - lib/slacken.rb
 - lib/slacken/document_component.rb
-- lib/slacken/document_component/elim_blanks.rb
-- lib/slacken/document_component/elim_invalid_links.rb
-- lib/slacken/document_component/elim_line_breaks.rb
-- lib/slacken/document_component/extract_img_alt.rb
-- lib/slacken/document_component/group_indent.rb
-- lib/slacken/document_component/group_inlines.rb
-- lib/slacken/document_component/sanitize_link_containers.rb
-- lib/slacken/document_component/sanitize_special_tag_containers.rb
-- lib/slacken/document_component/stringfy_checkbox.rb
-- lib/slacken/document_component/stringfy_emoji.rb
 - lib/slacken/dom_container.rb
+- lib/slacken/filter.rb
+- lib/slacken/filters.rb
+- lib/slacken/filters/elim_blanks.rb
+- lib/slacken/filters/elim_invalid_links.rb
+- lib/slacken/filters/elim_line_breaks.rb
+- lib/slacken/filters/extract_img_alt.rb
+- lib/slacken/filters/group_indent.rb
+- lib/slacken/filters/group_inlines.rb
+- lib/slacken/filters/sanitize_headline.rb
+- lib/slacken/filters/sanitize_link.rb
+- lib/slacken/filters/sanitize_list.rb
+- lib/slacken/filters/sanitize_table.rb
+- lib/slacken/filters/stringfy_checkbox.rb
+- lib/slacken/filters/stringfy_emoji.rb
 - lib/slacken/node_type.rb
 - lib/slacken/render_element.rb
 - lib/slacken/rendering.rb
 - lib/slacken/slack_url.rb
 - lib/slacken/table_element.rb
 - lib/slacken/version.rb
-- sample/out.txt
-- sample/source.html
 - scripts/update_markup_fixture.rb
 - slacken.gemspec
 - spec/fixtures/example.html
 - spec/fixtures/markup_text.txt
 - spec/helpers/document_component_dsl.rb
-- spec/slacken/document_component/elim_blanks_spec.rb
-- spec/slacken/document_component/elim_invalid_links_spec.rb
-- spec/slacken/document_component/elim_line_breaks_spec.rb
-- spec/slacken/document_component/group_indent_spec.rb
-- spec/slacken/document_component/group_inlines_spec.rb
-- spec/slacken/document_component/sanitize_special_tag_containers_spec.rb
 - spec/slacken/document_component_spec.rb
+- spec/slacken/filters/elim_blanks_spec.rb
+- spec/slacken/filters/elim_invalid_links_spec.rb
+- spec/slacken/filters/elim_line_breaks_spec.rb
+- spec/slacken/filters/group_indent_spec.rb
+- spec/slacken/filters/group_inlines_spec.rb
+- spec/slacken/filters/sanitize_headline_spec.rb
+- spec/slacken/filters/sanitize_link_spec.rb
+- spec/slacken/filters/sanitize_list_spec.rb
+- spec/slacken/filters/sanitize_table_spec.rb
 - spec/slacken_spec.rb
 - spec/spec_helper.rb
 homepage: https://rubygems.org/gems/slacken
@@ -183,12 +191,15 @@ test_files:
 - spec/fixtures/example.html
 - spec/fixtures/markup_text.txt
 - spec/helpers/document_component_dsl.rb
-- spec/slacken/document_component/elim_blanks_spec.rb
-- spec/slacken/document_component/elim_invalid_links_spec.rb
-- spec/slacken/document_component/elim_line_breaks_spec.rb
-- spec/slacken/document_component/group_indent_spec.rb
-- spec/slacken/document_component/group_inlines_spec.rb
-- spec/slacken/document_component/sanitize_special_tag_containers_spec.rb
 - spec/slacken/document_component_spec.rb
+- spec/slacken/filters/elim_blanks_spec.rb
+- spec/slacken/filters/elim_invalid_links_spec.rb
+- spec/slacken/filters/elim_line_breaks_spec.rb
+- spec/slacken/filters/group_indent_spec.rb
+- spec/slacken/filters/group_inlines_spec.rb
+- spec/slacken/filters/sanitize_headline_spec.rb
+- spec/slacken/filters/sanitize_link_spec.rb
+- spec/slacken/filters/sanitize_list_spec.rb
+- spec/slacken/filters/sanitize_table_spec.rb
 - spec/slacken_spec.rb
 - spec/spec_helper.rb

data/lib/slacken/document_component/elim_blanks.rb

@@ -1,36 +0,0 @@
-class Slacken::DocumentComponent
-  module ElimBlanks
-    # Private: Reject blank elements
-    def elim_blanks
-      case type.name
-      when :pre
-        self
-      else
-        derive(children.reject(&:blank?).map(&:elim_blanks))
-      end
-    end
-
-    def blank?
-      return @is_blank if !@is_blank.nil?
-      @is_blank =
-        case type.name
-        when :pre, :ul, :li, :br, :hr, :img, :checkbox
-          false
-        when :text, :emoji
-          content = attrs[:content]
-          content.nil? || !content.match(/\A\s*\Z/).nil?
-        else
-          children.empty? || children.all?(&:blank?)
-        end
-    end
-
-    def has_no_blanks?
-      case type.name
-      when :pre
-        true
-      else
-        !blank? && children.all?(&:has_no_blanks?)
-      end
-    end
-  end
-end

data/lib/slacken/document_component/elim_invalid_links.rb

@@ -1,26 +0,0 @@
-class Slacken::DocumentComponent
-  module ElimInvalidLinks
-    # Private: Eliminate internal links and blank links
-    def elim_invalid_links
-      if invalid_link?
-        derive(children.map(&:elim_invalid_links), type: :span)
-      else
-        derive(children.map(&:elim_invalid_links))
-      end
-    end
-
-    def invalid_link?
-      if type.member_of?(:a)
-        link = attrs[:href]
-        link.nil? ||
-          !link.match(%r{\Ahttps?://})
-      else
-        false
-      end
-    end
-
-    def has_no_invalid_links?
-      !invalid_link? && children.all?(&:has_no_invalid_links?)
-    end
-  end
-end

data/lib/slacken/document_component/elim_line_breaks.rb

@@ -1,27 +0,0 @@
-class Slacken::DocumentComponent
-  module ElimLineBreaks
-    # Private: Reject blank elements
-    def elim_line_breaks
-      case type.name
-      when :text
-        new_content = attrs[:content].gsub(/[\r\n]/, '')
-        derive(children, attrs: attrs.merge(content: new_content))
-      when :pre
-        self
-      else
-        derive(children.map(&:elim_line_breaks))
-      end
-    end
-
-    def has_no_line_breaks?
-      case type.name
-      when :text
-        !attrs[:content].match(/[\r\n]/)
-      when :pre
-        true
-      else
-        children.all?(&:has_no_line_breaks?)
-      end
-    end
-  end
-end

data/lib/slacken/document_component/extract_img_alt.rb

@@ -1,12 +0,0 @@
-class Slacken::DocumentComponent
-  module ExtractImgAlt
-    def extract_img_alt
-      if type.member_of?(:img)
-        child = self.class.new(:text, [], content: attrs[:alt] || attrs[:src])
-        derive([child])
-      else
-        derive(children.map(&:extract_img_alt))
-      end
-    end
-  end
-end

data/lib/slacken/document_component/group_indent.rb

@@ -1,27 +0,0 @@
-class Slacken::DocumentComponent
-  module GroupIndent
-    # Private: Wrap contents to indent.
-    #          Childrens of li or dd tags are wrapped.
-    def group_indent
-      if type.member_of?(:li, :dd)
-        head, *tails = children.map(&:group_indent)
-        derive([head, self.class.new(:indent, tails)])
-      else
-        derive(children.map(&:group_indent))
-      end
-    end
-
-    def indent_grouped?
-      if type.member_of?(:li, :dd)
-        head, tail = children
-        if tail
-          tail.type.member_of?(:indent) && tail.indent_grouped?
-        else
-          true
-        end
-      else
-        children.all?(&:indent_grouped?)
-      end
-    end
-  end
-end

data/lib/slacken/document_component/group_inlines.rb

@@ -1,26 +0,0 @@
-class Slacken::DocumentComponent
-  module GroupInlines
-    # Private: Group inline elements and wrap them in a wrapper node.
-    #          Wrapper nodes are introduced to group inline nodes in a paragraph.
-    def group_inlines
-      if block?
-        new_children = children.map(&:group_inlines).chunk(&:inline?).map do |is_inline, group|
-          is_inline ? self.class.new(:wrapper, group) : group
-        end.flatten
-        derive(new_children)
-      else
-        derive(children.map(&:group_inlines))
-      end
-    end
-
-    def inlines_grouped?
-      if type.member_of?(:wrapper)
-        true
-      elsif inline?
-        false
-      else
-        children.all?(&:inlines_grouped?)
-      end
-    end
-  end
-end

data/lib/slacken/document_component/sanitize_link_containers.rb

@@ -1,40 +0,0 @@
-class Slacken::DocumentComponent
-  module SanitizeLinkContainers
-    # Private: Sanitize not allowed tags in links.
-    def sanitize_link_containers
-      case type.name
-      when :img, :a, :iframe
-        derive(children.map(&:sanitize_in_link))
-      else
-        derive(children.map(&:sanitize_link_containers))
-      end
-    end
-
-    def sanitize_in_link
-      if type.allowed_in_link?
-        derive(children.map(&:sanitize_in_link))
-      else
-        # No block tags are allowed.
-        derive(children.map(&:sanitize_in_link), type: :span)
-      end
-    end
-
-    def link_sanitized?
-      case type.name
-      when :img, :a, :iframe
-        children.all?(&:list_containers_sanitized?)
-      else
-        children.all?(&:link_sanitized?)
-      end
-    end
-
-    def link_container_sanitized?
-      if type.allowed_in_link?
-        children.all?(&:link_containers_sanitized?)
-      else
-        false
-      end
-    end
-
-  end
-end

data/lib/slacken/document_component/sanitize_special_tag_containers.rb

@@ -1,102 +0,0 @@
-class Slacken::DocumentComponent
-  module SanitizeSpecialTagContainers
-    # Private: Sanitize not allowed tags in list, headline, and table.
-    def sanitize_special_tag_containers
-      # NOTE: each special tag (list, headline, and table) is not allowed to occur
-      #       in another type special tags.
-      case type.name
-      when /h\d/
-        derive(children.map(&:sanitize_headline))
-      when :ul, :ol, :dl
-        derive(children.map(&:sanitize_list))
-      when :table
-        derive(children.map(&:sanitize_table))
-      else
-        derive(children.map(&:sanitize_special_tag_containers))
-      end
-    end
-
-    def sanitize_headline
-      if type.allowed_in_headline?
-        derive(children.map(&:sanitize_headline))
-      else
-        # No block tags are allowed.
-        derive(children.map(&:sanitize_headline), type: :span)
-      end
-    end
-
-    def sanitize_list
-      if type.member_of?(:li, :dd)
-          head, *tails = children
-          derive([head.sanitize_list_item, *tails.map(&:sanitize_list)])
-      elsif type.allowed_in_list?
-        derive(children.map(&:sanitize_list))
-      else
-        derive(children.map(&:sanitize_list), type: block? ? :div : :span)
-      end
-    end
-
-    def sanitize_list_item
-      if type.allowed_as_list_item?
-        derive(children.map(&:sanitize_list_item))
-      else
-        # No block tags are allowed.
-        derive(children.map(&:sanitize_list_item), type: :span)
-      end
-    end
-
-    def sanitize_table
-      if type.allowed_in_table?
-        derive(children.map(&:sanitize_table))
-      else
-        # No block tags are allowed.
-        derive(children.map(&:sanitize_table), type: :span)
-      end
-    end
-
-    def sanitized?
-      case type.name
-      when /h\d/
-        children.all?(&:headline_sanitized?)
-      when :ul, :ol, :dl
-        children.all?(&:list_sanitized?)
-      when :table
-        children.all?(&:table_sanitized?)
-      else
-        children.all?(&:sanitized?)
-      end
-    end
-
-    def headline_sanitized?
-      if type.allowed_in_headline?
-        children.all?(&:headline_sanitized?)
-      else
-        false
-      end
-    end
-
-    def list_sanitized?
-      if type.allowed_in_list?
-        children.all?(&:list_sanitized?)
-      else
-        false
-      end
-    end
-
-    def list_item_sanitized?
-      if type.allowed_as_list_item?
-        children.all?(&:list_item_sanitized?)
-      else
-        false
-      end
-    end
-
-    def table_sanitized?
-      if type.allowed_in_table?
-        children.all?(&:table_sanitized?)
-      else
-        false
-      end
-    end
-  end
-end