hatemile 2.0

data/lib/hatemile/util/common_functions.rb

@@ -0,0 +1,106 @@
+# 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 CommonFunctions module contains the used methods by HaTeMiLe classes.
+    module CommonFunctions
+      ##
+      # The name of attribute for not modify the elements.
+      DATA_IGNORE = 'data-ignoreaccessibilityfix'.freeze
+
+      ##
+      # Copy a list of attributes of a element for other element.
+      #
+      # @param element1 [Hatemile::Util::Html::HTMLDOMElement] The element that
+      #   have attributes copied.
+      # @param element2 [Hatemile::Util::Html::HTMLDOMElement] The element that
+      #   copy the attributes.
+      # @param attributes [Array<String>] The list of attributes that will be
+      #   copied.
+      # @return [void]
+      def self.set_list_attributes(element1, element2, attributes)
+        attributes.each do |attribute|
+          if element1.has_attribute?(attribute)
+            element2.set_attribute(attribute, element1.get_attribute(attribute))
+          end
+        end
+      end
+
+      ##
+      # Increase a item in a HTML list.
+      #
+      # @param list [String] The list.
+      # @param string_to_increase [String] The value of item.
+      # @return [String] The HTML list with the item added, if the item not was
+      #   contained in list.
+      def self.increase_in_list(list, string_to_increase)
+        if !list.nil? &&
+           !list.empty? &&
+           !string_to_increase.nil? &&
+           !string_to_increase.empty?
+          return list if in_list?(list, string_to_increase)
+          return "#{list} #{string_to_increase}"
+        elsif !list.nil? && !list.empty?
+          return list
+        end
+        string_to_increase
+      end
+
+      ##
+      # Verify if the list contains the item.
+      #
+      # @param list [String] The list.
+      # @param string_to_search [String] The value of item.
+      # @return [Boolean] True if the list contains the item or false is not
+      #   contains.
+      def self.in_list?(list, string_to_search)
+        if !list.nil? &&
+           !list.empty? &&
+           !string_to_search.nil? &&
+           !string_to_search.empty?
+          elements = list.split(/[ \n\t\r]+/)
+          elements.each do |element|
+            return true if element == string_to_search
+          end
+        end
+        false
+      end
+
+      ##
+      # Check that the element can be manipulated by HaTeMiLe.
+      #
+      # @param element [Hatemile::Util::Html::HTMLDOMElement] The element.
+      # @return [Boolean] True if element can be manipulated or false if element
+      #   cannot be manipulated.
+      def self.is_valid_element?(element)
+        return false if element.has_attribute?(DATA_IGNORE)
+
+        parent_element = element.get_parent_element
+
+        return true if parent_element.nil?
+
+        tag_name = parent_element.get_tag_name
+        if (tag_name != 'BODY') && (tag_name != 'HTML')
+          return is_valid_element?(parent_element)
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/hatemile/util/configure.rb

@@ -0,0 +1,92 @@
+# 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 'yaml'
+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 Configure class contains the configuration of HaTeMiLe.
+    class Configure
+      ##
+      # Initializes a new object that contains the configuration of HaTeMiLe.
+      #
+      # @param files_name [Array<String>] The path of files.
+      # @param locales [Array<Symbol>] The locales.
+      def initialize(files_name = nil, locales = [:'en-US'])
+        Hatemile::Helper.require_valid_type(files_name, Array)
+        Hatemile::Helper.require_valid_type(files_name, Array)
+
+        if files_name.nil?
+          pattern = File.join(
+            File.dirname(File.dirname(File.dirname(__FILE__))),
+            'locale',
+            '*.yml'
+          )
+          files_name = Dir.glob(pattern)
+        end
+        @locales = locales
+        @parameters = {}
+        files_name.each do |file_name|
+          @parameters = @parameters.merge(YAML.load_file(file_name))
+        end
+      end
+
+      ##
+      # Returns the parameters of configuration.
+      #
+      # @return [Hash] The parameters of configuration.
+      def get_parameters
+        clone_parameters = {}
+        @locales.each do |locale|
+          clone_parameters = @parameters[locale.to_s]['hatemile'].merge(
+            clone_parameters
+          )
+        end
+        clone_parameters
+      end
+
+      ##
+      # Check that the configuration has an parameter.
+      #
+      # @param parameter [String] The parameter.
+      # @return [Boolean] True if the configuration has the parameter or false
+      #   if the configuration not has the parameter.
+      def has_parameter?(parameter)
+        @locales.each do |locale|
+          return true if @parameters[locale.to_s]['hatemile'].key?(parameter)
+        end
+        false
+      end
+
+      ##
+      # Returns the value of a parameter of configuration.
+      #
+      # @param parameter [String] The parameter.
+      # @return [String] The value of the parameter.
+      def get_parameter(parameter)
+        @locales.each do |locale|
+          next if @locales.last == locale
+
+          value = @parameters[locale.to_s]['hatemile'].fetch(parameter, nil)
+          return value unless value.nil?
+        end
+        @parameters[@locales.last.to_s]['hatemile'].fetch(parameter)
+      end
+    end
+  end
+end

data/lib/hatemile/util/css/rcp/rcp_declaration.rb

@@ -0,0 +1,77 @@
+# 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__)),
+  'style_sheet_declaration'
+)
+
+##
+# 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 Hatemile::Util::Css::Rcp module contains the implementation of CSS
+      # handles for Ruby CSS Parser library.
+      module Rcp
+        ##
+        # The RCPDeclaration class is official implementation of
+        # Hatemile::Util::Css::StyleSheetDeclaration for Ruby CSS Parser.
+        class RCPDeclaration < Hatemile::Util::Css::StyleSheetDeclaration
+          public_class_method :new
+
+          ##
+          # Initializes a new object that encapsulate the Ruby CSS Parser
+          # declaration.
+          #
+          # @param property_name [String] The property name of declaration.
+          # @param value [String] The value of declaration.
+          def initialize(property_name, value)
+            Hatemile::Helper.require_not_nil(property_name, value)
+            Hatemile::Helper.require_valid_type(property_name, String)
+            Hatemile::Helper.require_valid_type(value, String)
+
+            @property_name = property_name
+            @value = value
+          end
+
+          ##
+          # @see Hatemile::Util::Css::StyleSheetDeclaration#get_value
+          def get_value
+            @value
+          end
+
+          ##
+          # @see Hatemile::Util::Css::StyleSheetDeclaration#get_values
+          def get_values
+            get_value.split(/[ \n\t\r]+/)
+          end
+
+          ##
+          # @see Hatemile::Util::Css::StyleSheetDeclaration#get_property
+          def get_property
+            @property_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hatemile/util/css/rcp/rcp_parser.rb

@@ -0,0 +1,115 @@
+# 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 'css_parser'
+require 'uri'
+require File.join(
+  File.dirname(File.dirname(File.dirname(File.dirname(__FILE__)))),
+  'helper'
+)
+require File.join(File.dirname(File.dirname(__FILE__)), 'style_sheet_parser')
+require File.join(File.dirname(__FILE__), 'rcp_rule')
+
+##
+# 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 Hatemile::Util::Css::Rcp module contains the implementation of CSS
+      # handles for Ruby CSS Parser library.
+      module Rcp
+        ##
+        # The RCPParser class is official implementation of
+        # Hatemile::Util::Css::StyleSheetParser for Ruby CSS Parser.
+        class RCPParser < Hatemile::Util::Css::StyleSheetParser
+          include CssParser
+          public_class_method :new
+
+          protected
+
+          ##
+          # Load the stylesheets of page.
+          #
+          # @param html_parser [Hatemile::Util::Html::HTMLDOMParser] The HTML
+          #   parser.
+          # @param current_url [String] The current URL of page.
+          def load_stylesheets(html_parser, current_url)
+            elements = html_parser.find(
+              'style,link[rel="stylesheet"]'
+            ).list_results
+            elements.each do |element|
+              if element.get_tag_name == 'STYLE'
+                @css_parser.load_string!(element.get_text_content)
+              else
+                @css_parser.load_uri!(
+                  URI.join(current_url, element.get_attribute('href'))
+                )
+              end
+            end
+          end
+
+          public
+
+          ##
+          # Initializes a new object that encapsulate the Ruby CSS Parser.
+          #
+          # @param css_or_hp [String, Hatemile::Util::Html::HTMLDOMParser] The
+          #   HTML parser or CSS code of page.
+          # @param current_url [String] The current URL of page.
+          def initialize(css_or_hp, current_url = nil)
+            Hatemile::Helper.require_not_nil(css_or_hp)
+            Hatemile::Helper.require_valid_type(
+              css_or_hp,
+              Hatemile::Util::Html::HTMLDOMParser,
+              String
+            )
+            Hatemile::Helper.require_valid_type(current_url, String)
+
+            @css_parser = CssParser::Parser.new
+            if css_or_hp.is_a?(String)
+              @css_parser.load_string!(css_or_hp)
+            else
+              load_stylesheets(css_or_hp, current_url)
+            end
+          end
+
+          ##
+          # @see Hatemile::Util::Css::StyleSheetParser#get_rules
+          def get_rules(properties = nil)
+            rules = []
+            @css_parser.each_rule_set do |rule|
+              auxiliar_rule = RCPRule.new(rule)
+
+              if properties.nil?
+                rules.push(auxiliar_rule)
+                next
+              end
+
+              properties.each do |property_name|
+                if auxiliar_rule.has_property?(property_name)
+                  rules.push(auxiliar_rule)
+                  break
+                end
+              end
+            end
+            rules
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hatemile/util/css/rcp/rcp_rule.rb

@@ -0,0 +1,86 @@
+# 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__)), 'style_sheet_rule')
+require File.join(File.dirname(__FILE__), 'rcp_declaration')
+
+##
+# 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 Hatemile::Util::Css::Rcp module contains the implementation of CSS
+      # handles for Ruby CSS Parser library.
+      module Rcp
+        ##
+        # The RCPRule class is official implementation of
+        # Hatemile::Util::Css::StyleSheetRule for Ruby CSS Parser.
+        class RCPRule < Hatemile::Util::Css::StyleSheetRule
+          public_class_method :new
+
+          ##
+          # Initializes a new object that encapsulate the Ruby CSS Parser rule.
+          #
+          # @param rule [CssParser::RuleSet] The Ruby CSS Parser rule.
+          def initialize(rule)
+            Hatemile::Helper.require_not_nil(rule)
+            Hatemile::Helper.require_valid_type(rule, CssParser::RuleSet)
+
+            @rule = rule
+          end
+
+          ##
+          # @see Hatemile::Util::Css::StyleSheetRule#has_property?
+          def has_property?(property_name)
+            @rule.each_declaration do |property, _value, _important|
+              return true if property == property_name
+            end
+            false
+          end
+
+          ##
+          # @see Hatemile::Util::Css::StyleSheetRule#has_declarations?
+          def has_declarations?
+            true
+          end
+
+          ##
+          # @see Hatemile::Util::Css::StyleSheetRule#get_declarations
+          def get_declarations(property_name)
+            declarations = []
+            @rule.each_declaration do |property, value, _important|
+              if property == property_name
+                declarations.push(RCPDeclaration.new(property, value))
+              end
+            end
+            declarations
+          end
+
+          ##
+          # @see Hatemile::Util::Css::StyleSheetRule#get_selector
+          def get_selector
+            @rule.selectors.join(', ')
+          end
+        end
+      end
+    end
+  end
+end