watir-webdriver 0.7.0 → 0.8.0

data/lib/watir-webdriver/elements/table.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Watir
   class Table < HTMLElement
     include RowContainer

data/lib/watir-webdriver/elements/table_section.rb

@@ -9,7 +9,7 @@ module Watir
     #
 
     def [](idx)
-      row(:index => idx)
+      row(index: idx)
     end
   end # TableSection
 end # Watir

data/lib/watir-webdriver/elements/text_field.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Watir
   class TextField < Input
     include UserEditable
@@ -22,11 +21,11 @@ module Watir
 
   module Container
     def text_field(*args)
-      TextField.new(self, extract_selector(args).merge(:tag_name => "input"))
+      TextField.new(self, extract_selector(args).merge(tag_name: "input"))
     end
 
     def text_fields(*args)
-      TextFieldCollection.new(self, extract_selector(args).merge(:tag_name => "input"))
+      TextFieldCollection.new(self, extract_selector(args).merge(tag_name: "input"))
     end
   end # Container
 

data/lib/watir-webdriver/exception.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Watir
   module Exception
     class Error < StandardError; end

data/lib/watir-webdriver/extensions/nokogiri.rb

@@ -4,7 +4,7 @@ module Watir
   class Browser
 
     def text
-      doc = Nokogiri::HTML(body(:index => 0).html)
+      doc = Nokogiri::HTML(body(index: 0).html)
       doc.css("script").remove # encoding bug in older libxml?
 
       doc.inner_text

data/lib/watir-webdriver/generator.rb

@@ -0,0 +1,3 @@
+require "watir-webdriver/generator/base"
+require "watir-webdriver/generator/html"
+require "watir-webdriver/generator/svg"

data/lib/watir-webdriver/generator/base.rb

@@ -0,0 +1,11 @@
+require "nokogiri"
+require "open-uri"
+require "pp"
+require "webidl"
+require "active_support/inflector"
+
+require "watir-webdriver/generator/base/generator"
+require "watir-webdriver/generator/base/idl_sorter"
+require "watir-webdriver/generator/base/spec_extractor"
+require "watir-webdriver/generator/base/util"
+require "watir-webdriver/generator/base/visitor"

data/lib/watir-webdriver/{html → generator/base}/generator.rb

@@ -1,10 +1,6 @@
-# encoding: utf-8
-
 module Watir
-  module HTML
-    class Generator
-
-      IGNORED_ATTRIBUTES = %w(cells elements hash rows span text)
+  module Generator
+    class Base
 
       def generate(spec_url, io = StringIO.new)
         @spec_url, @io = spec_url, io
@@ -27,11 +23,11 @@ module Watir
       end
 
       def visitor
-        @visitor ||= Visitor.new
+        @visitor ||= visitor_class.new
       end
 
       def extractor
-        @extractor ||= SpecExtractor.new(@spec_url)
+        @extractor ||= extractor_class.new(@spec_url)
       end
 
       def extract_spec
@@ -44,20 +40,21 @@ module Watir
       end
 
       def cleanup_spec
-        # ignore the link element for now
-        @tag2interfaces.delete("link")
-        @sorted_interfaces.reject! { |intf| intf.name == "HTMLLinkElement" }
-        # frame is implemented manually, see https://github.com/watir/watir-webdriver/issues/204
-        @sorted_interfaces.reject! { |intf| intf.name == "HTMLFrameElement"  }
+        ignored_tags.each do |tag|
+          @tag2interfaces.delete(tag)
+        end
+
+        ignored_interfaces.each do |interface|
+          @sorted_interfaces.reject! { |intf| intf.name == interface }
+        end
 
-        # cleanup attributes
         @sorted_interfaces.each do |intf|
-          intf.members.delete_if { |member| IGNORED_ATTRIBUTES.include?(member.name) }
+          intf.members.delete_if { |member| ignored_attributes.include?(member.name) }
         end
       end
 
       def write_header
-        @io.puts "# Autogenerated from the HTML5 specification. Edits may be lost."
+        @io.puts "# Autogenerated from #{generator_implementation} specification. Edits may be lost."
         @io.puts "module Watir"
       end
 
@@ -67,42 +64,35 @@ module Watir
           unless interface.empty?
             interface.gsub!(/^\s+\n/, '') # remove empty lines
             @io.puts indent(interface)
+            @io.puts "\n"
           end
         end
       end
 
       def write_container_methods
-        @io.puts "\n\n"
+        @io.puts "\n"
         @io.puts indent("module Container")
 
         @tag2interfaces.sort.each do |tag, interfaces|
-          raise "multiple interfaces for tag #{tag.inspect}" unless interfaces.map { |e| e.name }.uniq.size == 1
+          raise "multiple interfaces for tag #{tag.inspect}" if interfaces.map(&:name).uniq.size != 1
 
           tag_string       = tag.inspect
-          singular         = Util.paramify(tag)
+          singular         = Util.paramify(visitor.classify_regexp, tag)
           plural           = singular.pluralize
-          element_class    = Util.classify(interfaces.first.name)
+          element_class    = Util.classify(visitor.classify_regexp, interfaces.first.name)
           collection_class = "#{element_class}Collection"
 
           # visitor.visit_tag(tag, interfaces.first.name) !?
-          @io.puts indent(<<-CODE, 3)
+          @io.puts indent(<<-CODE, 2)
 
-#
 # @return [#{element_class}]
-#
-
 def #{singular}(*args)
-  #{element_class}.new(self, extract_selector(args).merge(:tag_name => #{tag_string}))
+  #{element_class}.new(self, extract_selector(args).merge(tag_name: #{tag_string}))
 end
-
-#
 # @return [#{collection_class}]
-#
-
 def #{plural}(*args)
-  #{collection_class}.new(self, extract_selector(args).merge(:tag_name => #{tag_string}))
+  #{collection_class}.new(self, extract_selector(args).merge(tag_name: #{tag_string}))
 end
-
 Watir.tag_to_class[#{tag.to_sym.inspect}] = #{element_class}
 
 CODE
@@ -120,6 +110,6 @@ CODE
         code.split("\n").map { |line| line.empty? ? line : indent_string + line }.join("\n")
       end
 
-    end # Generator
-  end # HTML5
+    end # Base
+  end # Generator
 end # Watir

data/lib/watir-webdriver/{html → generator/base}/idl_sorter.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-
 require 'tsort'
 
 module Watir
-  module HTML
-    class IDLSorter
+  module Generator
+    class Base::IDLSorter
       include TSort
 
       def initialize(interfaces)
@@ -45,5 +43,5 @@ module Watir
       end
 
     end # IDLSorter
-  end # HTML
+  end # Generator
 end # Watir

data/lib/watir-webdriver/{html → generator/base}/spec_extractor.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
-
 module Watir
-  module HTML
-    class SpecExtractor
+  module Generator
+    class Base::SpecExtractor
 
-      class InterfaceNotFound < StandardError
-      end
+      IDL_SELECTOR = "//pre[@class='idl']"
+
+      class InterfaceNotFound < StandardError; end
 
       def initialize(uri)
         @uri = uri
@@ -15,6 +14,7 @@ module Watir
         download_and_parse
         extract_idl_parts
         extract_interface_map
+        drop_issued_interfaces
         build_result
       rescue
         p errors
@@ -53,7 +53,7 @@ module Watir
       end
 
       def extract_idl_parts
-        parsed = @doc.search("//pre[@class='idl']").map {  |e| parse_idl(e.inner_text) }.compact
+        parsed = @doc.search(IDL_SELECTOR).map {  |e| parse_idl(e.inner_text) }.compact
 
         implements = []
         @interfaces = []
@@ -73,43 +73,17 @@ module Watir
       end
 
       def extract_interface_map
-        # http://www.whatwg.org/specs/web-apps/current-work/#elements-1
-        table = @doc.search("//h3[@id='elements-3']/following-sibling::table[1]").first
-        table or raise "could not find elements-3 table"
-
-        @interface_map = {}
-
-        parse_table(table).each do |row|
-          row['Element'].split(", ").each { |tag| @interface_map[tag] = row['Interface'] }
-        end
+        raise NotImplementedError
       end
 
-      def build_result
-        # tag name => Interface instance(s)
-        result = {}
-
-        @interface_map.each do |tag, interface|
-          result[tag] = fetch_interface(interface)
+      def drop_issued_interfaces
+        @interface_map.delete_if do |_, interface|
+          issued_interfaces.include?(interface)
         end
-
-        # missing from the elements-1 table
-        result['frameset'] = fetch_interface('HTMLFrameSetElement')
-
-        result
       end
 
-      def parse_table(table)
-        headers = table.css("thead th").map { |e| e.inner_text.strip }
-
-        table.css("tbody tr").map do |row|
-          result = {}
-
-          row.css("th, td").each_with_index do |node, idx|
-            result[headers[idx]] = node.inner_text.strip
-          end
-
-          result
-        end
+      def build_result
+        raise NotImplementedError
       end
 
       def parse_idl(str)
@@ -156,9 +130,9 @@ module Watir
       end
 
       def sorter
-        @idl_sorter ||= IDLSorter.new(@interfaces)
+        @idl_sorter ||= Base::IDLSorter.new(@interfaces)
       end
 
     end # SpecExtractor
-  end # HTML
+  end # Generator
 end # Watir

data/lib/watir-webdriver/generator/base/util.rb

@@ -0,0 +1,21 @@
+module Watir
+  module Generator
+    module Util
+
+      module_function
+
+      def classify(regexp, str)
+        if str =~ regexp
+          $1
+        else
+          str
+        end
+      end
+
+      def paramify(regexp, str)
+        classify(regexp, str).snake_case
+      end
+
+    end # Util
+  end # Generator
+end # Watir

data/lib/watir-webdriver/{html → generator/base}/visitor.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
-
 module Watir
-  module HTML
-    class Visitor < WebIDL::RubySexpVisitor
+  module Generator
+    class Base::Visitor < WebIDL::RubySexpVisitor
 
       def initialize
         super
@@ -23,10 +21,10 @@ module Watir
         parent = interface.inherits.first
 
         $stderr.puts name
-        return unless name =~ /^HTML/ && name !~ /(Collection|Document)$/
+        return if name !~ interface_regexp || name =~ /(Collection|Document)$/
 
-        if name == "HTMLElement"
-          parent = 'Element'
+        if force_inheritance.keys.include?(name)
+          parent = force_inheritance[name]
         elsif parent
           @inheritance_map[name] ||= parent.name
           parent = parent.name
@@ -58,9 +56,9 @@ module Watir
       #
       # def visit_tag(tag_name, interface_name)
       #   tag_string       = tag.inspect
-      #   singular         = Util.paramify(tag)
+      #   singular         = Util.paramify(classify_regexp, tag)
       #   plural           = singular.pluralize
-      #   element_class    = Util.classify(interfaces.first.name)
+      #   element_class    = Util.classify(classify_regexp, interfaces.first.name)
       #   collection_class = "#{element_class}Collection"
       #
       #   [:defn,
@@ -82,7 +80,7 @@ module Watir
       private
 
       def element_class(name, attributes, parent)
-        [:class, Util.classify(name), [:const, Util.classify(parent)],
+        [:class, Util.classify(classify_regexp, name), [:const, Util.classify(classify_regexp, parent)],
           *attribute_calls(attributes)
         ]
       end
@@ -97,7 +95,7 @@ module Watir
       def collection_class(name)
         return if @already_defined.include?(name)
         @already_defined << name
-        name = Util.classify(name)
+        name = Util.classify(classify_regexp, name)
 
         [:class, "#{name}Collection", [:const, :ElementCollection],
           [:scope,
@@ -142,7 +140,8 @@ module Watir
         case type.name.to_s
         when 'DOMString', 'any'
           String
-        when 'UnsignedLong', 'Long', 'Integer', 'Short', 'UnsignedShort'
+        when 'UnsignedLong', 'Long', 'Integer', 'Short', 'UnsignedShort',
+             'SVGAnimatedLength'
           Fixnum
         when 'Float', /.*Double$/
           Float
@@ -152,8 +151,9 @@ module Watir
              'Any', 'TimedTrackArray', 'TimedTrack', 'TextTrackArray', 'TextTrack',
              /Media.+/, 'TextTrackKind', 'Function', /.*EventHandler$/,
              'Document', 'DocumentFragment', 'DOMTokenList', 'DOMSettableTokenList',
-             'DOMStringMap', 'HTMLPropertiesCollection', /HTML(.*)Element/, /HTML(.*)Collection/,
-             'CSSStyleDeclaration',  /.+List$/, 'Date', 'Element'
+             'DOMStringMap', 'HTMLPropertiesCollection', /HTML.*Element/, /HTML.*Collection/,
+             'CSSStyleDeclaration',  /.+List$/, 'Date', 'Element', /DOM.+ReadOnly/,
+             /SVGAnimated.+/, /SVG.*Element/, /SVG.*Collection/, 'SVGViewSpec'
           # probably completely wrong.
           String
         else
@@ -162,5 +162,5 @@ module Watir
       end
 
     end # Visitor
-  end # Support
+  end # Generator
 end # Watir

data/lib/watir-webdriver/{html.rb → generator/html.rb}

@@ -1,9 +1,3 @@
-require "nokogiri"
-require "open-uri"
-require "pp"
-require "webidl"
-require "active_support/inflector"
-
 ActiveSupport::Inflector.inflections do |inflect|
   inflect.plural 'body', 'bodys'
   inflect.plural 'tbody', 'tbodys'
@@ -16,8 +10,6 @@ ActiveSupport::Inflector.inflections do |inflect|
   inflect.plural 'datalist', 'datalists'
 end
 
-require "watir-webdriver/html/util"
-require "watir-webdriver/html/visitor"
-require "watir-webdriver/html/idl_sorter"
-require "watir-webdriver/html/spec_extractor"
-require "watir-webdriver/html/generator"
+require "watir-webdriver/generator/html/generator"
+require "watir-webdriver/generator/html/spec_extractor"
+require "watir-webdriver/generator/html/visitor"

data/lib/watir-webdriver/generator/html/generator.rb

@@ -0,0 +1,36 @@
+module Watir
+  module Generator
+    class HTML < Base
+
+      private
+
+      def ignored_tags
+        # ignore the link element for now
+        %w(link)
+      end
+
+      def ignored_interfaces
+        ignored = ignored_tags.map { |tag| "HTML#{tag.capitalize}Element" }
+        # frame is implemented manually, see https://github.com/watir/watir-webdriver/issues/204
+        ignored << 'HTMLFrameElement'
+      end
+
+      def ignored_attributes
+        %w(cells elements hash rows span text)
+      end
+
+      def generator_implementation
+        'HTML'
+      end
+
+      def visitor_class
+        HTML::Visitor
+      end
+
+      def extractor_class
+        HTML::SpecExtractor
+      end
+
+    end # Generator
+  end # HTML
+end # Watir