hatemile 2.0

data/lib/hatemile/util/html/nokogiri/nokogiri_html_dom_node.rb

@@ -0,0 +1,112 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require File.join(
+  File.dirname(File.dirname(File.dirname(File.dirname(__FILE__)))),
+  'helper'
+)
+
+##
+# The Hatemile module contains the interfaces with the acessibility solutions.
+module Hatemile
+  ##
+  # The Hatemile::Util module contains the utilities of library.
+  module Util
+    ##
+    # The Hatemile::Util::Html module contains the interfaces of HTML handles.
+    module Html
+      ##
+      # The Hatemile::Util::NokogiriLib module contains the implementation of
+      # HTML handles for Nokogiri library.
+      module NokogiriLib
+        ##
+        # The NokogiriHTMLDOMNode module is official implementation of
+        # HTMLDOMNode methods.
+        module NokogiriHTMLDOMNode
+          ##
+          # Initializes a new object that encapsulate the Nokogiri node.
+          #
+          # @param node [Nokogiri::XML::Node] The Nokogiri node.
+          # @param hatemile_node [Hatemile::Util::Html::HTMLDOMNode] The
+          #   HaTeMiLe node.
+          def init(node, hatemile_node)
+            Hatemile::Helper.require_not_nil(node, hatemile_node)
+            Hatemile::Helper.require_valid_type(node, Nokogiri::XML::Node)
+            Hatemile::Helper.require_valid_type(
+              hatemile_node,
+              Hatemile::Util::Html::HTMLDOMNode
+            )
+
+            @node = node
+            @hatemile_node = hatemile_node
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#get_text_content
+          def get_text_content
+            @node.text
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#insert_before
+          def insert_before(new_node)
+            @node.before(new_node.get_data)
+            @hatemile_node
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#insert_after
+          def insert_after(new_node)
+            @node.after(new_node.get_data)
+            @hatemile_node
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#remove_node
+          def remove_node
+            @node.remove
+            @hatemile_node
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#replace_node
+          def replace_node(new_node)
+            @node.replace(new_node.get_data)
+            @hatemile_node
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#get_parent_element
+          def get_parent_element
+            parent = @node.parent
+            if !parent.nil? && parent.element?
+              return NokogiriHTMLDOMElement.new(parent)
+            end
+            nil
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#get_data
+          def get_data
+            @node
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#set_data
+          def set_node(node)
+            @node = node
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hatemile/util/html/nokogiri/nokogiri_html_dom_parser.rb

@@ -0,0 +1,208 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'nokogiri'
+require File.join(
+  File.dirname(File.dirname(File.dirname(File.dirname(__FILE__)))),
+  'helper'
+)
+require File.join(File.dirname(File.dirname(__FILE__)), 'html_dom_parser')
+require File.join(File.dirname(__FILE__), 'nokogiri_html_dom_element')
+
+##
+# The Hatemile module contains the interfaces with the acessibility solutions.
+module Hatemile
+  ##
+  # The Hatemile::Util module contains the utilities of library.
+  module Util
+    ##
+    # The Hatemile::Util::Html module contains the interfaces of HTML handles.
+    module Html
+      ##
+      # The Hatemile::Util::NokogiriLib module contains the implementation of
+      # HTML handles for Nokogiri library.
+      module NokogiriLib
+        ##
+        # The class NokogiriHTMLDOMParser is official implementation of
+        # HTMLDOMParser interface for the Nokogiri library.
+        class NokogiriHTMLDOMParser < Hatemile::Util::Html::HTMLDOMParser
+          public_class_method :new
+
+          ##
+          # Initializes a new object that encapsulate the parser of Jsoup.
+          #
+          # @param code_or_parser [String, Nokogiri::HTML::Document] The HTML
+          #   code or the parser of Nokogiri.
+          # @param encoding [String] The enconding of code.
+          def initialize(code_or_parser, encoding = 'UTF-8')
+            Hatemile::Helper.require_not_nil(code_or_parser, encoding)
+            Hatemile::Helper.require_valid_type(
+              code_or_parser,
+              String,
+              Nokogiri::HTML::Document
+            )
+            Hatemile::Helper.require_valid_type(encoding, String)
+
+            @document = if code_or_parser.class == String
+                          Nokogiri::HTML::Document.parse(
+                            code_or_parser,
+                            nil,
+                            encoding
+                          )
+                        else
+                          code_or_parser
+                        end
+            @results = nil
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMParser#find
+          def find(selector)
+            @results = if selector.is_a?(NokogiriHTMLDOMElement)
+                         [selector.get_data]
+                       elsif selector.is_a?(Array)
+                         selector.map(&:get_data)
+                       else
+                         @document.css(selector)
+                       end
+            self
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMParser#find_children
+          def find_children(selector)
+            array = []
+            selector = [selector] if selector.is_a?(NokogiriHTMLDOMElement)
+            if selector.is_a?(Array)
+              selector.each do |element|
+                native_element = element.get_data
+                @results.each do |result|
+                  if result.children.include?(native_element)
+                    array.push(native_element)
+                    break
+                  end
+                end
+              end
+            else
+              @results.each do |result|
+                result.css(selector).each do |found_element|
+                  array.push(found_element) if found_element.parent == result
+                end
+              end
+            end
+            @results = array
+            self
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMParser#find_descendants
+          def find_descendants(selector)
+            array = []
+            selector = [selector] if selector.is_a?(NokogiriHTMLDOMElement)
+            if selector.is_a?(Array)
+              selector.each do |element|
+                native_element = element.get_data
+                parents = native_element.ancestors
+                @results.each do |result|
+                  if parents.include?(result)
+                    array.push(native_element)
+                    break
+                  end
+                end
+              end
+            else
+              @results.each do |result|
+                array = array.concat(result.css(selector))
+              end
+            end
+            @results = array
+            self
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMParser#find_ancestors
+          def find_ancestors(selector)
+            array = []
+            selector = [selector] if selector.is_a?(NokogiriHTMLDOMElement)
+            if selector.is_a?(Array)
+              selector.each do |element|
+                native_element = element.get_data
+                @results.each do |result|
+                  parents = result.ancestors
+                  if parents.include?(native_element)
+                    array.push(native_element)
+                    break
+                  end
+                end
+              end
+            else
+              @results.each do |result|
+                array = array.concat(result.ancestors(selector))
+              end
+            end
+            @results = array
+            self
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMParser#first_result
+          def first_result
+            return nil if @results.nil? || @results.empty?
+            NokogiriHTMLDOMElement.new(@results[0])
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMParser#last_result
+          def last_result
+            return nil if @results.nil? || @results.empty?
+            NokogiriHTMLDOMElement.new(@results[@results.length - 1])
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMParser#list_results
+          def list_results
+            array = []
+            @results.each do |result|
+              array.push(NokogiriHTMLDOMElement.new(result))
+            end
+            array
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMParser#create_element
+          def create_element(tag)
+            NokogiriHTMLDOMElement.new(@document.create_element(tag))
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMParser#get_html
+          def get_html
+            NokogiriHTMLDOMElement.new(@document).get_outer_html
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMParser#get_parser
+          def get_parser
+            @document
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMParser#clear_parser
+          def clear_parser
+            @document = nil
+            @results = nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hatemile/util/html/nokogiri/nokogiri_html_dom_text_node.rb

@@ -0,0 +1,83 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require File.join(
+  File.dirname(File.dirname(File.dirname(File.dirname(__FILE__)))),
+  'helper'
+)
+require File.join(File.dirname(File.dirname(__FILE__)), 'html_dom_text_node')
+require File.join(File.dirname(__FILE__), 'nokogiri_html_dom_node')
+
+##
+# The Hatemile module contains the interfaces with the acessibility solutions.
+module Hatemile
+  ##
+  # The Hatemile::Util module contains the utilities of library.
+  module Util
+    ##
+    # The Hatemile::Util::Html module contains the interfaces of HTML handles.
+    module Html
+      ##
+      # The Hatemile::Util::NokogiriLib module contains the implementation of
+      # HTML handles for Nokogiri library.
+      module NokogiriLib
+        ##
+        # The NokogiriHTMLDOMTextNode class is official implementation of
+        # HTMLDOMTextNode interface for the Nokogiri library.
+        class NokogiriHTMLDOMTextNode < Hatemile::Util::Html::HTMLDOMTextNode
+          include NokogiriHTMLDOMNode
+
+          public_class_method :new
+
+          ##
+          # Initializes a new object that encapsulate the Nokogiri text node.
+          #
+          # @param text_node [Nokogiri::XML::Text] The Nokogiri text node.
+          def initialize(text_node)
+            Hatemile::Helper.require_not_nil(text_node)
+            Hatemile::Helper.require_valid_type(text_node, Nokogiri::XML::Text)
+
+            @data = text_node
+            init(text_node, self)
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMTextNode#set_text_content
+          def set_text_content(text)
+            @data.content = text
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#append_text
+          def append_text(text)
+            set_text_content(get_text_content + text)
+            self
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#prepend_text
+          def prepend_text(text)
+            set_text_content(text + get_text_content)
+            self
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#set_data
+          def set_data(data)
+            @data = data
+            set_node(data)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hatemile/util/id_generator.rb

@@ -0,0 +1,53 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'securerandom'
+require File.join(File.dirname(File.dirname(__FILE__)), 'helper')
+
+##
+# The Hatemile module contains the interfaces with the acessibility solutions.
+module Hatemile
+  ##
+  # The Hatemile::Util module contains the utilities of library.
+  module Util
+    ##
+    # The IDGenerator class generate ids for
+    # Hatemile::Util::Html::HTMLDOMElement.
+    class IDGenerator
+      ##
+      # Initializes a new object that generate ids for elements.
+      #
+      # @param prefix_part [String] A part of prefix id.
+      def initialize(prefix_part = nil)
+        Hatemile::Helper.require_valid_type(prefix_part, String)
+
+        @prefix_id = if prefix_part.nil?
+                       "id-hatemile-#{SecureRandom.hex}-"
+                     else
+                       "id-hatemile-#{prefix_part}-#{SecureRandom.hex}-"
+                     end
+        @count = 0
+      end
+
+      ##
+      # Generate a id for a element.
+      #
+      # @param element [Hatemile::Util::Html::HTMLDOMElement] The element.
+      def generate_id(element)
+        return if element.has_attribute?('id')
+
+        element.set_attribute('id', "#{@prefix_id}#{@count}")
+        @count += 1
+      end
+    end
+  end
+end