hatemile 2.0

data/lib/hatemile/util/html/html_dom_parser.rb

@@ -0,0 +1,150 @@
+# 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.
+
+##
+# 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 HTMLDOMParser interface contains the methods for access a native
+      # parser.
+      #
+      # @abstract
+      class HTMLDOMParser
+        private_class_method :new
+
+        ##
+        # Find all elements in the parser by selector.
+        #
+        # @abstract
+        # @param selector [String, Hatemile::Util::Html::HTMLDOMElement] The
+        #   selector.
+        # @return [Hatemile::Util::Html::HTMLDOMParser] The parser with the
+        #   elements found.
+        def find(selector)
+          # Interface method
+        end
+
+        ##
+        # Find all elements in the parser by selector, children of found
+        # elements.
+        #
+        # @abstract
+        # @param selector [String, Hatemile::Util::Html::HTMLDOMElement] The
+        #   selector.
+        # @return [Hatemile::Util::Html::HTMLDOMParser] The parser with the
+        #   elements found.
+        def find_children(selector)
+          # Interface method
+        end
+
+        ##
+        # Find all elements in the parser by selector, descendants of found
+        # elements.
+        #
+        # @abstract
+        # @param selector [String, Hatemile::Util::Html::HTMLDOMElement] The
+        #   selector.
+        # @return [Hatemile::Util::Html::HTMLDOMParser] The parser with the
+        #   elements found.
+        def find_descendants(selector)
+          # Interface method
+        end
+
+        ##
+        # Find all elements in the parser by selector, ancestors of found
+        # elements.
+        #
+        # @abstract
+        # @param selector [String, Hatemile::Util::Html::HTMLDOMElement] The
+        #   selector.
+        # @return [Hatemile::Util::Html::HTMLDOMParser] The parser with the
+        #   elements found.
+        def find_ancestors(selector)
+          # Interface method
+        end
+
+        ##
+        # Returns the first element found.
+        #
+        # @abstract
+        # @return [Hatemile::Util::Html::HTMLDOMElement] The first element found
+        #   or null if not have elements found.
+        def first_result
+          # Interface method
+        end
+
+        ##
+        # Returns the last element found.
+        #
+        # @abstract
+        # @return [Hatemile::Util::Html::HTMLDOMElement] The last element found
+        #   or null if not have elements found.
+        def last_result
+          # Interface method
+        end
+
+        ##
+        # Returns a list with all elements found.
+        #
+        # @abstract
+        # @return [Array<Hatemile::Util::Html::HTMLDOMElement>] The list with
+        #   all elements found.
+        def list_results
+          # Interface method
+        end
+
+        ##
+        # Create a element.
+        #
+        # @abstract
+        # @param tag [String] The tag of element.
+        # @return [Hatemile::Util::Html::HTMLDOMElement] The element created.
+        def create_element(tag)
+          # Interface method
+        end
+
+        ##
+        # Returns the HTML code of parser.
+        #
+        # @abstract
+        # @return [String] The HTML code of parser.
+        def get_html
+          # Interface method
+        end
+
+        ##
+        # Returns the parser.
+        #
+        # @abstract
+        # @return [Object] The parser or root element of the parser.
+        def get_parser
+          # Interface method
+        end
+
+        ##
+        # Clear the memory of this object.
+        #
+        # @abstract
+        # @return [void]
+        def clear_parser
+          # Interface method
+        end
+      end
+    end
+  end
+end

data/lib/hatemile/util/html/html_dom_text_node.rb

@@ -0,0 +1,43 @@
+# 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__), '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 HTMLDOMTextNode interface contains the methods for access of the
+      # HTML TextNode.
+      #
+      # @abstract
+      class HTMLDOMTextNode < HTMLDOMNode
+        private_class_method :new
+
+        ##
+        # Change the text content of text node.
+        #
+        # @abstract
+        # @param text [String] The new text content.
+        def set_text_content(text)
+          # Interface method
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,302 @@
+# 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_element')
+require File.join(File.dirname(__FILE__), 'nokogiri_html_dom_node')
+require File.join(File.dirname(__FILE__), 'nokogiri_html_dom_text_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 NokogiriHTMLDOMElement class is official implementation of
+        # HTMLDOMElement interface for the Nokogiri library.
+        class NokogiriHTMLDOMElement < Hatemile::Util::Html::HTMLDOMElement
+          include NokogiriHTMLDOMNode
+
+          public_class_method :new
+
+          ##
+          # Tags that are self closing.
+          SELF_CLOSING_TAGS = %w[
+            area base br col embed hr img input keygen
+            link menuitem meta param source track wbr
+          ].freeze
+
+          ##
+          # Initializes a new object that encapsulate the Nokogiri element.
+          #
+          # @param element [Nokogiri::XML::Node] The Nokogiri element.
+          def initialize(element)
+            Hatemile::Helper.require_not_nil(element)
+            Hatemile::Helper.require_valid_type(element, Nokogiri::XML::Node)
+
+            @data = element
+            init(element, self)
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#get_tag_name
+          def get_tag_name
+            @data.name.upcase
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#get_attribute
+          def get_attribute(name)
+            @data.get_attribute(name)
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#set_attribute
+          def set_attribute(name, value)
+            @data.set_attribute(name, value)
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#remove_attribute
+          def remove_attribute(name)
+            @data.remove_attribute(name) if has_attribute?(name)
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#has_attribute?
+          def has_attribute?(name)
+            !@data.attributes[name].nil?
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#has_attributes?
+          def has_attributes?
+            !@data.attributes.empty?
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#append_element
+          def append_element(element)
+            @data.add_child(element.get_data)
+            self
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#prepend_element
+          def prepend_element(element)
+            @data.prepend_child(element.get_data)
+            self
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#get_children_elements
+          def get_children_elements
+            array = []
+            @data.element_children.each do |child|
+              array.push(NokogiriHTMLDOMElement.new(child))
+            end
+            array
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#get_children
+          def get_children
+            array = []
+            @data.children.each do |child|
+              array.push(NokogiriHTMLDOMElement.new(child)) if child.element?
+              array.push(NokogiriHTMLDOMTextNode.new(child)) if child.text?
+            end
+            array
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#normalize
+          def normalize
+            return self unless has_children?
+
+            last = nil
+            get_children.each do |child|
+              if child.is_a?(NokogiriHTMLDOMElement)
+                child.normalize
+              elsif child.is_a?(NokogiriHTMLDOMTextNode) &&
+                    last.is_a?(NokogiriHTMLDOMTextNode)
+                child.prepend_text(last.get_text_content)
+                last.remove_node
+              end
+              last = child
+            end
+
+            self
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#append_text
+          def append_text(text)
+            @data.add_child(Nokogiri::XML::Text.new(text, @data.document))
+            self
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#prepend_text
+          def prepend_text(text)
+            @data.prepend_child(Nokogiri::XML::Text.new(text, @data.document))
+            self
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#has_children_elements?
+          def has_children_elements?
+            @data.element_children.empty? == false
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#has_children?
+          def has_children?
+            @data.children.each do |child|
+              return true if child.element? || child.text?
+            end
+            false
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#get_inner_html
+          def get_inner_html
+            html = ''
+            @data.children.each do |child|
+              html += to_string(child)
+            end
+            html
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#get_outer_html
+          def get_outer_html
+            to_string(@data)
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMNode#set_data
+          def set_data(data)
+            @data = data
+            set_node(data)
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#clone_element
+          def clone_element
+            NokogiriHTMLDOMElement.new(@data.clone)
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#get_first_element_child
+          def get_first_element_child
+            return nil unless has_children_elements?
+            get_children_elements.first
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#get_last_element_child
+          def get_last_element_child
+            return nil unless has_children_elements?
+            get_children_elements.last
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#get_first_node_child
+          def get_first_node_child
+            return nil unless has_children?
+            get_children.first
+          end
+
+          ##
+          # @see Hatemile::Util::Html::HTMLDOMElement#get_last_node_child
+          def get_last_node_child
+            return nil unless has_children?
+            get_children.last
+          end
+
+          ##
+          # Convert a Nokogiri Node to a HTML code.
+          #
+          # @param node [Nokogiri::XML::Node] The Nokogiri Node.
+          # @return [String] The HTML code of the Nokogiri Node.
+          def to_string(node)
+            string = ''
+            if node.element?
+              string += "<#{node.name.downcase}"
+              node.attributes.each do |attribute, value|
+                string += " #{attribute}=\"#{value}\""
+              end
+              string += if node.children.empty? && self_closing_tag?(node.name)
+                          ' />'
+                        else
+                          '>'
+                        end
+            elsif node.comment?
+              string += node.to_s
+            elsif node.cdata?
+              string += node.to_s
+            elsif node.html?
+              document = node.to_s
+              string += document.split("\n")[0] + "\n"
+            elsif node.text?
+              string += node.text
+            end
+
+            node.children.each do |child|
+              string += to_string(child)
+            end
+
+            if node.element? &&
+               !(node.children.empty? && self_closing_tag?(node.name))
+              string += "</#{node.name.downcase}>"
+            end
+            string
+          end
+
+          ##
+          # Returns if the tag is self closing.
+          #
+          # @param tag [String] The element tag.
+          # @return [Boolean] True if the tag is self closing or false if not.
+          def self_closing_tag?(tag)
+            SELF_CLOSING_TAGS.include?(tag.downcase)
+          end
+
+          ##
+          # Compare if two elements object reference the same element.
+          #
+          # @param other [Hatemile::Util::Html::HTMLDOMElement] The other
+          #   object.
+          # @return [Boolean] True if the object reference the same element or
+          #   false if not.
+          def ==(other)
+            return false if other.nil?
+            return false unless other.is_a?(HTMLDOMElement)
+            get_data == other.get_data
+          end
+        end
+      end
+    end
+  end
+end