hatemile 2.0

data/lib/hatemile/accessible_display.rb

@@ -0,0 +1,178 @@
+# 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 AccessibleDisplay interface improve accessibility, showing informations.
+  #
+  # @abstract
+  class AccessibleDisplay
+    private_class_method :new
+
+    ##
+    # Display the shortcuts of element.
+    #
+    # @abstract
+    # @param element [Hatemile::Util::Html::HTMLDOMElement] The element with
+    #   shortcuts.
+    # @return [void]
+    def display_shortcut(element)
+      # Interface method
+    end
+
+    ##
+    # Display all shortcuts of page.
+    #
+    # @abstract
+    # @return [void]
+    def display_all_shortcuts
+      # Interface method
+    end
+
+    ##
+    # Display the WAI-ARIA role of element.
+    #
+    # @abstract
+    # @param element [Hatemile::Util::Html::HTMLDOMElement] The element.
+    # @return [void]
+    def display_role(element)
+      # Interface method
+    end
+
+    ##
+    # Display the WAI-ARIA roles of all elements of page.
+    #
+    # @abstract
+    # @return [void]
+    def display_all_roles
+      # Interface method
+    end
+
+    ##
+    # Display the headers of each data cell of table.
+    #
+    # @abstract
+    # @param table_cell [Hatemile::Util::Html::HTMLDOMElement] The table cell.
+    # @return [void]
+    def display_cell_header(table_cell)
+      # Interface method
+    end
+
+    ##
+    # Display the headers of each data cell of all tables of page.
+    #
+    # @abstract
+    # @return [void]
+    def display_all_cell_headers
+      # Interface method
+    end
+
+    ##
+    # Display the WAI-ARIA attributes of element.
+    #
+    # @abstract
+    # @param element [Hatemile::Util::Html::HTMLDOMElement] The element with
+    #   WAI-ARIA attributes.
+    # @return [void]
+    def display_waiaria_states(element)
+      # Interface method
+    end
+
+    ##
+    # Display the WAI-ARIA attributes of all elements of page.
+    #
+    # @abstract
+    # @return [void]
+    def display_all_waiaria_states
+      # Interface method
+    end
+
+    ##
+    # Display the attributes of link.
+    #
+    # @abstract
+    # @param link [Hatemile::Util::Html::HTMLDOMElement] The link element.
+    # @return [void]
+    def display_link_attributes(link)
+      # Interface method
+    end
+
+    ##
+    # Display the attributes of all links of page.
+    #
+    # @abstract
+    # @return [void]
+    def display_all_links_attributes
+      # Interface method
+    end
+
+    ##
+    # Display the title of element.
+    #
+    # @abstract
+    # @param element [Hatemile::Util::Html::HTMLDOMElement] The element with
+    #   title.
+    # @return [void]
+    def display_title(element)
+      # Interface method
+    end
+
+    ##
+    # Display the titles of all elements of page.
+    #
+    # @abstract
+    # @return [void]
+    def display_all_titles
+      # Interface method
+    end
+
+    ##
+    # Display the language of element.
+    #
+    # @abstract
+    # @param element [Hatemile::Util::Html::HTMLDOMElement] The element.
+    # @return [void]
+    def display_language(element)
+      # Interface method
+    end
+
+    ##
+    # Display the language of all elements of page.
+    #
+    # @abstract
+    # @return [void]
+    def display_all_languages
+      # Interface method
+    end
+
+    ##
+    # Display the alternative text of image.
+    #
+    # @abstract
+    # @param image The image.
+    # @return [void]
+    def display_alternative_text_image(image)
+      # Interface method
+    end
+
+    ##
+    # Display the alternative text of all images of page.
+    #
+    # @abstract
+    # @return [void]
+    def display_all_alternative_text_images
+      # Interface method
+    end
+  end
+end

data/lib/hatemile/accessible_event.rb

@@ -0,0 +1,95 @@
+# 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 AccessibleEvent interface improve the accessibility, making elements
+  # events available from a keyboard.
+  #
+  # @abstract
+  class AccessibleEvent
+    private_class_method :new
+
+    ##
+    # Make the drop events of element available from a keyboard.
+    #
+    # @abstract
+    # @param element [Hatemile::Util::Html::HTMLDOMElement] The element with
+    #   drop event.
+    # @return [void]
+    def make_accessible_drop_events(element)
+      # Interface method
+    end
+
+    ##
+    # Make the drag events of element available from a keyboard.
+    #
+    # @abstract
+    # @param element [Hatemile::Util::Html::HTMLDOMElement] The element with
+    #   drag event.
+    # @return [void]
+    def make_accessible_drag_events(element)
+      # Interface method
+    end
+
+    ##
+    # Make all Drag-and-Drop events of page available from a keyboard.
+    #
+    # @abstract
+    # @return [void]
+    def make_accessible_all_drag_and_drop_events
+      # Interface method
+    end
+
+    ##
+    # Make the hover events of element available from a keyboard.
+    #
+    # @abstract
+    # @param element [Hatemile::Util::Html::HTMLDOMElement] The element with
+    #   hover event.
+    # @return [void]
+    def make_accessible_hover_events(element)
+      # Interface method
+    end
+
+    ##
+    # Make all hover events of page available from a keyboard.
+    #
+    # @abstract
+    # @return [void]
+    def make_accessible_all_hover_events
+      # Interface method
+    end
+
+    ##
+    # Make the click events of element available from a keyboard.
+    #
+    # @abstract
+    # @param element [Hatemile::Util::Html::HTMLDOMElement] The element with
+    #   click events.
+    # @return [void]
+    def make_accessible_click_events(element)
+      # Interface method
+    end
+
+    ##
+    # Make all click events of page available from a keyboard.
+    #
+    # @abstract
+    # @return [void]
+    def make_accessible_all_click_events
+      # Interface method
+    end
+  end
+end

data/lib/hatemile/accessible_form.rb

@@ -0,0 +1,101 @@
+# 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 AccessibleForm interface improve the accessibility of forms.
+  #
+  # @abstract
+  class AccessibleForm
+    private_class_method :new
+
+    ##
+    # Mark that the field is required.
+    #
+    # @abstract
+    # @param required_field [Hatemile::Util::Html::HTMLDOMElement] The required
+    #   field.
+    # @return [void]
+    def mark_required_field(required_field)
+      # Interface method
+    end
+
+    ##
+    # Mark that the fields is required.
+    #
+    # @abstract
+    # @return [void]
+    def mark_all_required_fields
+      # Interface method
+    end
+
+    ##
+    # Mark that the field have range.
+    #
+    # @abstract
+    # @param range_field [Hatemile::Util::Html::HTMLDOMElement] The range field.
+    # @return [void]
+    def mark_range_field(range_field)
+      # Interface method
+    end
+
+    ##
+    # Mark that the fields have range.
+    #
+    # @abstract
+    # @return [void]
+    def mark_all_range_fields
+      # Interface method
+    end
+
+    ##
+    # Mark that the field have autocomplete.
+    #
+    # @abstract
+    # @param autocomplete_field [Hatemile::Util::Html::HTMLDOMElement] The field
+    #   with autocomplete.
+    # @return [void]
+    def mark_autocomplete_field(autocomplete_field)
+      # Interface method
+    end
+
+    ##
+    # Mark that the fields have autocomplete.
+    #
+    # @abstract
+    # @return [void]
+    def mark_all_autocomplete_fields
+      # Interface method
+    end
+
+    ##
+    # Mark a solution to display that this field is invalid.
+    #
+    # @abstract
+    # @param field [Hatemile::Util::Html::HTMLDOMElement] The field.
+    # @return [void]
+    def mark_invalid_field(field)
+      # Interface method
+    end
+
+    ##
+    # Mark a solution to display that a fields are invalid.
+    #
+    # @abstract
+    # @return [void]
+    def mark_all_invalid_fields
+      # Interface method
+    end
+  end
+end

data/lib/hatemile/accessible_navigation.rb

@@ -0,0 +1,82 @@
+# 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 AccessibleNavigation interface improve the accessibility of navigation.
+  #
+  # @abstract
+  class AccessibleNavigation
+    private_class_method :new
+
+    ##
+    # Provide a content skipper for element.
+    #
+    # @abstract
+    # @param element [Hatemile::Util::Html::HTMLDOMElement] The element.
+    # @return [void]
+    def provide_navigation_by_skipper(element)
+      # Interface method
+    end
+
+    ##
+    # Provide navigation by content skippers.
+    #
+    # @abstract
+    # @return [void]
+    def provide_navigation_by_all_skippers
+      # Interface method
+    end
+
+    ##
+    # Provide navigation by heading.
+    #
+    # @abstract
+    # @param heading [Hatemile::Util::Html::HTMLDOMElement] The heading element.
+    # @return [void]
+    def provide_navigation_by_heading(heading)
+      # Interface method
+    end
+
+    ##
+    # Provide navigation by headings of page.
+    #
+    # @abstract
+    # @return [void]
+    def provide_navigation_by_all_headings
+      # Interface method
+    end
+
+    ##
+    # Provide an alternative way to access the long description of element.
+    #
+    # @abstract
+    # @param image [Hatemile::Util::Html::HTMLDOMElement] The image with long
+    #   description.
+    # @return [void]
+    def provide_navigation_to_long_description(image)
+      # Interface method
+    end
+
+    ##
+    # Provide an alternative way to access the longs descriptions of all
+    # elements of page.
+    #
+    # @abstract
+    # @return [void]
+    def provide_navigation_to_all_long_descriptions
+      # Interface method
+    end
+  end
+end