hatemile 2.0

data/lib/hatemile/util/css/style_sheet_declaration.rb

@@ -0,0 +1,59 @@
+# 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::Css module contains the interfaces of CSS handles.
+    module Css
+      ##
+      # The StyleSheetDeclaration interface contains the methods for access the
+      # CSS declaration.
+      #
+      # @abstract
+      class StyleSheetDeclaration
+        private_class_method :new
+
+        ##
+        # Returns the value of declaration.
+        #
+        # @abstract
+        # @return [String] The value of declaration.
+        def get_value
+          # Interface method
+        end
+
+        ##
+        # Returns a list with the values of declaration.
+        #
+        # @abstract
+        # @return [Array<String>] The list with the values of declaration.
+        def get_values
+          # Interface method
+        end
+
+        ##
+        # Returns the property of declaration.
+        #
+        # @abstract
+        # @return [String] The property of declaration.
+        def get_property
+          # Interface method
+        end
+      end
+    end
+  end
+end

data/lib/hatemile/util/css/style_sheet_parser.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.
+
+##
+# 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::Css module contains the interfaces of CSS handles.
+    module Css
+      ##
+      # The StyleSheetParser interface contains the methods for access the CSS
+      # parser.
+      #
+      # @abstract
+      class StyleSheetParser
+        private_class_method :new
+
+        ##
+        # Returns the rules of parser by properties.
+        #
+        # @abstract
+        # @param properties [Array<String>] The properties.
+        # @return [Array<Hatemile::Util::Css.stylesheetrule.StyleSheetRule>] The
+        #   rules.
+        def get_rules(properties)
+          # Interface method
+        end
+      end
+    end
+  end
+end

data/lib/hatemile/util/css/style_sheet_rule.rb

@@ -0,0 +1,73 @@
+# 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::Css module contains the interfaces of CSS handles.
+    module Css
+      ##
+      # The StyleSheetRule interface contains the methods for access the CSS
+      # rule.
+      #
+      # @abstract
+      class StyleSheetRule
+        private_class_method :new
+
+        ##
+        # Returns that the rule has a declaration with the property.
+        #
+        # @abstract
+        # @param property_name [String] The name of property.
+        # @return [Boolean] True if the rule has a declaration with the property
+        #   or false if the rule not has a declaration with the property.
+        def has_property?(property_name)
+          # Interface method
+        end
+
+        ##
+        # Returns that the rule has declarations.
+        #
+        # @abstract
+        # @return [Boolean] True if the rule has the property or False if the
+        #   rule not has declarations.
+        def has_declarations?
+          # Interface method
+        end
+
+        ##
+        # Returns the declarations with the property.
+        #
+        # @abstract
+        # @param property_name [String] The property.
+        # @return [Hatemile::Util::Css::StyleSheetDeclaration] The declarations
+        #   with the property.
+        def get_declarations(property_name)
+          # Interface method
+        end
+
+        ##
+        # Returns the selector of rule.
+        #
+        # @abstract
+        # @return [String] The selector of rule.
+        def get_selector
+          # Interface method
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,234 @@
+# 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 HTMLDOMElement interface contains the methods for access of the HTML
+      # element.
+      #
+      # @abstract
+      class HTMLDOMElement < HTMLDOMNode
+        private_class_method :new
+
+        ##
+        # Returns the tag name of element.
+        #
+        # @abstract
+        # @return [String] The tag name of element in uppercase letters.
+        def get_tag_name
+          # Interface method
+        end
+
+        ##
+        # Returns the value of a attribute.
+        #
+        # @abstract
+        # @param name [String] The name of attribute.
+        # @return [String] The value of the attribute or nil if the element not
+        #   contains the attribute.
+        def get_attribute(name)
+          # Interface method
+        end
+
+        ##
+        # Create or modify a attribute.
+        #
+        # @abstract
+        # @param name [String] The name of attribute.
+        # @param value [String] The value of attribute.
+        # @return [void]
+        def set_attribute(name, value)
+          # Interface method
+        end
+
+        ##
+        # Remove a attribute of element.
+        #
+        # @abstract
+        # @param name [String] The name of attribute.
+        # @return [void]
+        def remove_attribute(name)
+          # Interface method
+        end
+
+        ##
+        # Check that the element has an attribute.
+        #
+        # @abstract
+        # @param name [String] The name of attribute.
+        # @return [Boolean] True if the element has the attribute or false if
+        #   the element not has the attribute.
+        def has_attribute?(name)
+          # Interface method
+        end
+
+        ##
+        # Check that the element has attributes.
+        #
+        # @abstract
+        # @return [Boolean] True if the element has attributes or false if the
+        #   element not has attributes.
+        def has_attributes?
+          # Interface method
+        end
+
+        ##
+        # Append a element child.
+        #
+        # @abstract
+        # @param element [Hatemile::Util::Html::HTMLDOMElement] The element that
+        #   be inserted.
+        # @return [Hatemile::Util::Html::HTMLDOMElement] This element.
+        def append_element(element)
+          # Interface method
+        end
+
+        ##
+        # Prepend a element child.
+        #
+        # @abstract
+        # @param element [Hatemile::Util::Html::HTMLDOMElement] The element that
+        #   be inserted.
+        # @return [Hatemile::Util::Html::HTMLDOMElement] This element.
+        def prepend_element(element)
+          # Interface method
+        end
+
+        ##
+        # Returns the elements children of this element.
+        #
+        # @abstract
+        # @return [Array<Hatemile::Util::Html::HTMLDOMElement>] The elements
+        #   children of this element.
+        def get_children_elements
+          # Interface method
+        end
+
+        ##
+        # Returns the children of this element.
+        #
+        # @abstract
+        # @return [Array<Hatemile::Util::Html::HTMLDOMNode>] The children of
+        #   this element.
+        def get_children
+          # Interface method
+        end
+
+        ##
+        # Joins adjacent Text nodes.
+        #
+        # @abstract
+        # @return [Hatemile::Util::Html::HTMLDOMElement] This element.
+        def normalize
+          # Interface method
+        end
+
+        ##
+        # Check that the element has elements children.
+        #
+        # @abstract
+        # @return [Boolean] True if the element has elements children or false
+        #   if the element not has elements children.
+        def has_children_elements?
+          # Interface method
+        end
+
+        ##
+        # Check that the element has children.
+        #
+        # @abstract
+        # @return [Boolean] True if the element has children or false if the
+        #   element not has children.
+        def has_children?
+          # Interface method
+        end
+
+        ##
+        # Returns the inner HTML code of this element.
+        #
+        # @abstract
+        # @return [String] The inner HTML code of this element.
+        def get_inner_html
+          # Interface method
+        end
+
+        ##
+        # Returns the HTML code of this element.
+        #
+        # @abstract
+        # @return [String] The HTML code of this element.
+        def get_outer_html
+          # Interface method
+        end
+
+        ##
+        # Returns the first element child of this element.
+        #
+        # @abstract
+        # @return [Hatemile::Util::Html::HTMLDOMElement] The first element child
+        #   of this element.
+        def get_first_element_child
+          # Interface method
+        end
+
+        ##
+        # Returns the last element child of this element.
+        #
+        # @abstract
+        # @return [Hatemile::Util::Html::HTMLDOMElement] The last element child
+        #   of this element.
+        def get_last_element_child
+          # Interface method
+        end
+
+        ##
+        # Returns the first node child of this element.
+        #
+        # @abstract
+        # @return [Hatemile::Util::Html::HTMLDOMNode] The first node child of
+        #   this element.
+        def get_first_node_child
+          # Interface method
+        end
+
+        ##
+        # Returns the last node child of this element.
+        #
+        # @abstract
+        # @return [Hatemile::Util::Html::HTMLDOMNode] The last node child of
+        #   this element.
+        def get_last_node_child
+          # Interface method
+        end
+
+        ##
+        # Clone this element.
+        #
+        # @abstract
+        # @return [Hatemile::Util::Html::HTMLDOMElement] The clone.
+        def clone_element
+          # Interface method
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# 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 HTMLDOMNode interface contains the methods for access the Node.
+      #
+      # @abstract
+      class HTMLDOMNode
+        private_class_method :new
+
+        ##
+        # Returns the text content of node.
+        #
+        # @abstract
+        # @return [String] The text content of node.
+        def get_text_content
+          # Interface method
+        end
+
+        ##
+        # Insert a node before this node.
+        #
+        # @abstract
+        # @param new_node [Hatemile::Util::Html::HTMLDOMNode] The node that be
+        #   inserted.
+        # @return [Hatemile::Util::Html::HTMLDOMNode] This node.
+        def insert_before(new_node)
+          # Interface method
+        end
+
+        ##
+        # Insert a node after this node.
+        #
+        # @abstract
+        # @param new_node [Hatemile::Util::Html::HTMLDOMNode] The node that be
+        #   inserted.
+        # @return [Hatemile::Util::Html::HTMLDOMNode] This node.
+        def insert_after(new_node)
+          # Interface method
+        end
+
+        ##
+        # Remove this node of the parser.
+        #
+        # @abstract
+        # @return [Hatemile::Util::Html::HTMLDOMNode] This node.
+        def remove_node
+          # Interface method
+        end
+
+        ##
+        # Replace this node for other node.
+        #
+        # @abstract
+        # @param new_node [Hatemile::Util::Html::HTMLDOMNode] The node that
+        #   replace this node.
+        # @return [Hatemile::Util::Html::HTMLDOMNode] This node.
+        def replace_node(new_node)
+          # Interface method
+        end
+
+        ##
+        # Append a text content in node.
+        #
+        # @abstract
+        # @param text [String] The text content.
+        # @return [Hatemile::Util::Html::HTMLDOMNode] This node.
+        def append_text(text)
+          # Interface method
+        end
+
+        ##
+        # Prepend a text content in node.
+        #
+        # @abstract
+        # @param text [String] The text content.
+        # @return [Hatemile::Util::Html::HTMLDOMNode] This node.
+        def prepend_text(text)
+          # Interface method
+        end
+
+        ##
+        # Returns the parent element of this node.
+        #
+        # @abstract
+        # @return [Hatemile::Util::Html::HTMLDOMElement] The parent element of
+        #   this node.
+        def get_parent_element
+          # Interface method
+        end
+
+        ##
+        # Returns the native object of this node.
+        #
+        # @abstract
+        # @return [Object] The native object of this node.
+        def get_data
+          # Interface method
+        end
+
+        ##
+        # Modify the native object of this node.
+        #
+        # @abstract
+        # @param data [Object] The native object of this node.
+        # @return [void]
+        def set_data(data)
+          # Interface method
+        end
+      end
+    end
+  end
+end