slacken 0.1.0 → 0.1.1

data/lib/slacken/filters/sanitize_list.rb

@@ -0,0 +1,57 @@
+module Slacken::Filters
+  # Public: Sanitize not allowed tags in list.
+  class SanitizeList < Slacken::Filter
+    def call(component)
+      case component.type.name
+      when :ul, :ol, :dl
+        component.derive(component.children.map(&method(:sanitize_list)))
+      else
+        component.derive(component.children.map(&method(:call)))
+      end
+    end
+
+    def valid?(component)
+      case component.type.name
+      when :ul, :ol, :dl
+        component.children.all?(&method(:list_sanitized?))
+      else
+        component.children.all?(&method(:valid?))
+      end
+    end
+
+    private
+
+    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))]
+          )
+      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
+        )
+      end
+    end
+
+    def sanitize_list_item(component)
+      if component.type.allowed_as_list_item?
+        component.derive(component.children.map(&method(:sanitize_list_item)))
+      else
+        # No block tags are allowed.
+        component.derive(component.children.map(&method(:sanitize_list_item)), type: :span)
+      end
+    end
+
+    def list_sanitized?(component)
+      if component.type.allowed_in_list?
+        component.children.all?(&method(:list_sanitized?))
+      else
+        false
+      end
+    end
+  end
+end

data/lib/slacken/filters/sanitize_table.rb

@@ -0,0 +1,44 @@
+module Slacken::Filters
+  # Public: Sanitize not allowed tags in table.
+  class SanitizeTable < Slacken::Filter
+    def call(component)
+      if component.type.member_of?(:table)
+        component.derive(component.children.map(&method(:sanitize_table)))
+      else
+        component.derive(component.children.map(&method(:call)))
+      end
+    end
+
+    def valid?(component)
+      if component.type.member_of?(:table)
+        component.children.all?(&method(:table_sanitized?))
+      else
+        component.children.all?(&method(:valid?))
+      end
+    end
+
+    private
+
+    def sanitize_table(component)
+      if component.type.allowed_in_table?
+        component.derive(
+          component.children.map(&method(:sanitize_table))
+        )
+      else
+        # No block tags are allowed.
+        component.derive(
+          component.children.map(&method(:sanitize_table)),
+          type: :span
+        )
+      end
+    end
+
+    def table_sanitized?(component)
+      if component.type.allowed_in_table?
+        component.children.all?(&method(:table_sanitized?))
+      else
+        false
+      end
+    end
+  end
+end

data/lib/slacken/filters/stringfy_checkbox.rb

@@ -0,0 +1,26 @@
+module Slacken::Filters
+  # Public: Change checkbox input node to checkbox node.
+  class StringfyCheckbox < Slacken::Filter
+    def call(component)
+      if checkbox_input?(component)
+        component.class.new(:checkbox, [], checked: component.attrs[:checked])
+      else
+        component.derive(component.children.map(&method(:call)))
+      end
+    end
+
+    def valid?(component)
+      if checkbox_input?(component)
+        false
+      else
+        component.children.all?(&method(:valid?))
+      end
+    end
+
+    private
+
+    def checkbox_input?(component)
+      component.type.member_of?(:input) && component.attrs[:type] == 'checkbox'
+    end
+  end
+end

data/lib/slacken/filters/stringfy_emoji.rb

@@ -0,0 +1,26 @@
+module Slacken::Filters
+  # Public: Convert emoji image nodes to emoji nodes.
+  class StringfyEmoji < Slacken::Filter
+    def call(component)
+      if emoji_img_tag?(component)
+        component.class.new(:emoji, [], content: component.attrs[:alt])
+      else
+        component.derive(component.children.map(&method(:call)))
+      end
+    end
+
+    def valid?(component)
+      if emoji_img_tag?(component)
+        false
+      else
+        component.children.all?(&method(:valid?))
+      end
+    end
+
+    private
+
+    def emoji_img_tag?(component)
+      component.type.member_of?(:img) && component.attrs[:class].include?('emoji')
+    end
+  end
+end

data/lib/slacken/node_type.rb

@@ -1,4 +1,5 @@
 module Slacken
+  # Public: Representing type of DocumentComponent.
   class NodeType
     def self.create(name)
       name.is_a?(NodeType) ? name : new(name)
@@ -43,7 +44,7 @@ module Slacken
     end
 
     def allowed_in_table?
-      member_of?(%i(code b strong i em wrapper span).concat(text_types))
+      member_of?(%i(code b strong i em wrapper span thead tbody tr th td).concat(text_types))
     end
 
     def allowed_in_link?

data/lib/slacken/render_element.rb

@@ -1,4 +1,6 @@
 module Slacken
+  # Internal: Representing a tree structure of a document and
+  #           responsible for rendering the structure to string.
   class RenderElement
     attr_reader :type, :renderer, :attrs, :children
 

data/lib/slacken/rendering.rb

@@ -60,7 +60,6 @@ module Slacken
     end
 
     # Public: an intermediate object to stringfy RenderElements.
-    #
     class RenderingGroup
       attr_reader :children
       def initialize(children)

data/lib/slacken/version.rb

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

data/scripts/update_markup_fixture.rb

@@ -3,6 +3,6 @@ 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)))
-  )
+  File.join(fixture_dir, 'markup_text.txt'),
+  Slacken.translate(File.read(File.join(fixture_dir, 'example.html')))
+)

data/spec/slacken/document_component_spec.rb

@@ -6,14 +6,12 @@ module Slacken
       subject { DomContainer.parse_html(source).to_component.normalize }
       let(:source) { fixture('example.html') }
 
-      it { is_expected.to have_no_blanks }
-      it { is_expected.to have_no_invalid_links }
-      it { is_expected.to have_no_line_breaks }
-      it { is_expected.to be_indent_grouped }
-      it { is_expected.to be_inlines_grouped }
-      it { is_expected.to be_sanitized }
-      it { is_expected.to be_emoji_stringfied }
-      it { is_expected.to be_checkbox_stringfied }
+      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
+      end
     end
   end
 end

data/spec/slacken/filters/elim_blanks_spec.rb

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

data/spec/slacken/filters/elim_invalid_links_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Slacken::Filters::ElimInvalidLinks, dsl: true do
+  describe '#valid?' do
+    subject { described_class.new.valid?(component) }
+
+    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 component.derive' do
+      let(:component) do
+        c(:div, c(:span, c(:a, { href: '#hogehoge' })))
+      end
+
+      it { is_expected.to be_falsey }
+    end
+  end
+end

data/spec/slacken/filters/elim_line_breaks_spec.rb

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

data/spec/slacken/filters/group_indent_spec.rb

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

data/spec/slacken/filters/group_inlines_spec.rb

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

data/spec/slacken/filters/sanitize_headline_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Slacken::Filters::SanitizeHeadline, dsl: true do
+  describe '#valid?' do
+    subject { described_class.new.valid?(component) }
+
+    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 only allowed tags occur in a header' do
+      let(:component) do
+        c(:h3,
+          text('hoge'),
+          c(:i, text('fuga')),
+          c(:span, text('piyo')))
+      end
+
+      it { is_expected.to be_truthy }
+    end
+  end
+end