webdrone 1.7.8 → 1.8.0

data/lib/webdrone/shot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Webdrone
   class Browser
     def shot
@@ -6,7 +8,7 @@ module Webdrone
   end
 
   class Shot
-    attr_accessor :a0
+    attr_reader :a0
 
     def initialize(a0)
       @a0 = a0
@@ -14,12 +16,12 @@ module Webdrone
 
     def screen(name)
       @counter = (@counter || 0) + 1
-      filename = sprintf "screenshot-%04d-%s.png", @counter, name
+      filename = sprintf "screenshot-%04d-#{name}.png", @counter
       filename = File.join(@a0.conf.outdir, filename)
-      $a0_webdrone_screenshot = filename
+      ::Webdrone::MethodLogger.screenshot = filename
       @a0.driver.save_screenshot filename
-    rescue => exception
-      Webdrone.report_error(@a0, exception)
+    rescue StandardError => error
+      Webdrone.report_error(@a0, error)
     end
   end
 end

data/lib/webdrone/text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Webdrone
   class Browser
     def text
@@ -6,7 +8,7 @@ module Webdrone
   end
 
   class Text
-    attr_accessor :a0
+    attr_reader :a0
 
     def initialize(a0)
       @a0 = a0
@@ -19,8 +21,8 @@ module Webdrone
       else
         item.text
       end
-    rescue => exception
-      Webdrone.report_error(@a0, exception)
+    rescue StandardError => error
+      Webdrone.report_error(@a0, error)
     end
 
     alias_method :id,     :text
@@ -33,8 +35,8 @@ module Webdrone
 
     def page_title
       @a0.driver.title
-    rescue => exception
-      Webdrone.report_error(@a0, exception)
+    rescue StandardError => error
+      Webdrone.report_error(@a0, error)
     end
 
     protected :text

data/lib/webdrone/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Webdrone
-  VERSION = "1.7.8"
+  VERSION = "1.8.0"
 end

data/lib/webdrone/vrfy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Webdrone
   class Browser
     def vrfy
@@ -6,7 +8,7 @@ module Webdrone
   end
 
   class Vrfy
-    attr_accessor :a0
+    attr_reader :a0
 
     def initialize(a0)
       @a0 = a0
@@ -14,35 +16,33 @@ module Webdrone
 
     def vrfy(text, n: 1, all: false, visible: true, scroll: false, parent: nil, attr: nil, eq: nil, contains: nil, mark: false)
       item = @a0.find.send __callee__, text, n: n, all: all, visible: visible, scroll: scroll, parent: parent
+      @a0.mark.mark_item item if mark
       if item.is_a? Array
-        @a0.mark.mark_item item if mark
         item.each { |x| vrfy_item x, text: text, callee: __callee__, attr: attr, eq: eq, contains: contains }
       else
-        @a0.mark.mark_item item if mark
         vrfy_item item, text: text, callee: __callee__, attr: attr, eq: eq, contains: contains
       end
-    rescue => exception
-      Webdrone.report_error(@a0, exception)
+    rescue StandardError => error
+      Webdrone.report_error(@a0, error)
     end
 
     def vrfy_item(item, text: nil, callee: nil, attr: nil, eq: nil, contains: nil)
-      if attr != nil
-        r = item.attribute(attr) == eq if eq != nil
-        r = item.attribute(attr).include? contains if contains != nil
-      elsif eq != nil
+      if !attr.nil?
+        r = item.attribute(attr) == eq if !eq.nil?
+        r = item.attribute(attr).include? contains if !contains.nil?
+      elsif !eq.nil?
         r = item.text == eq
-      elsif contains != nil
+      elsif !contains.nil?
         r = item.text.include? contains
       end
-      if r == false
-        targ = "eq: [#{eq}]" if eq
-        targ = "contains: [#{contains}]" if contains
-        if attr != nil
-          raise "VRFY: #{callee} [#{text}] attr [#{attr}] value [#{item.attribute(attr)}] does not comply #{targ}"
-        else
-          raise "VRFY: #{callee} [#{text}] text value [#{item.text}] does not comply #{targ}"
-        end
-      end
+
+      return unless r == false
+
+      targ = "eq: [#{eq}]" if eq
+      targ = "contains: [#{contains}]" if contains
+
+      raise "VRFY: #{callee} [#{text}] text value [#{item.text}] does not comply #{targ}" if attr.nil?
+      raise "VRFY: #{callee} [#{text}] attr [#{attr}] value [#{item.attribute(attr)}] does not comply #{targ}"
     end
 
     alias_method :id,     :vrfy

data/lib/webdrone/wait.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Webdrone
   class Browser
     def wait
@@ -6,7 +8,8 @@ module Webdrone
   end
 
   class Wait
-    attr_accessor :a0, :ignore
+    attr_accessor :ignore
+    attr_reader :a0
 
     def initialize(a0)
       @a0 = a0
@@ -25,14 +28,14 @@ module Webdrone
       else
         yield
       end
-    rescue => exception
-      Webdrone.report_error(@a0, exception)
+    rescue StandardError => error
+      Webdrone.report_error(@a0, error)
     end
 
     def time(val)
       sleep val
-    rescue => exception
-      Webdrone.report_error(@a0, exception)
+    rescue StandardError => error
+      Webdrone.report_error(@a0, error)
     end
   end
 end

data/lib/webdrone/xlsx.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Webdrone
   class Browser
     def xlsx
@@ -6,7 +8,9 @@ module Webdrone
   end
 
   class Xlsx
-    attr_accessor :a0, :filename, :sheet, :dict, :rows, :both
+    attr_accessor :filename, :sheet
+    attr_reader :a0
+    attr_writer :dict, :rows, :both
 
     def initialize(a0)
       @a0 = a0
@@ -16,73 +20,80 @@ module Webdrone
 
     def dict(sheet: nil, filename: nil)
       update_sheet_filename(sheet, filename)
-      if @dict == nil
+
+      if @dict.nil?
         reset
         @dict = {}
         workbook = RubyXL::Parser.parse(@filename)
         worksheet = workbook[@sheet]
-        worksheet.sheet_data.rows.tap do |head, *body|
+        worksheet.sheet_data.rows.tap do |_head, *body|
           body.each do |row|
             k, v = row[0].value, row[1].value
             @dict[k] = v
           end
         end
       end
+
       @dict
-    rescue => exception
-      Webdrone.report_error(@a0, exception)
+    rescue StandardError => error
+      Webdrone.report_error(@a0, error)
     end
 
     def rows(sheet: nil, filename: nil)
       update_sheet_filename(sheet, filename)
-      if @rows == nil
+
+      if @rows.nil?
         reset
         workbook = RubyXL::Parser.parse(@filename)
         worksheet = workbook[@sheet]
         @rows = worksheet.sheet_data.rows.collect do |row|
           row.cells.collect do |cell|
-            cell.value if cell != nil
+            cell&.value
           end
         end
       end
+
       @rows
-    rescue => exception
-      Webdrone.report_error(@a0, exception)
+    rescue StandardError => error
+      Webdrone.report_error(@a0, error)
     end
 
     def both(sheet: nil, filename: nil)
       update_sheet_filename(sheet, filename)
-      if @both == nil
+
+      if @both.nil?
         reset
         workbook = RubyXL::Parser.parse(@filename)
         worksheet = workbook[@sheet]
         rows = worksheet.sheet_data.rows.collect do |row|
           row.cells.collect do |cell|
-            cell.value if cell != nil
+            cell&.value
           end
         end
         head = rows.shift
         @both = rows.collect do |row|
           dict = {}
           row.each_with_index do |val, i|
-            dict[head[i]] = val if head[i] != nil
+            dict[head[i]] = val if !head[i].nil?
           end
           dict
         end
       end
+
       @both
-    rescue => exception
-      Webdrone.report_error(@a0, exception)
+    rescue StandardError => error
+      Webdrone.report_error(@a0, error)
     end
 
-
     def save(sheet: nil, filename: nil, dict: nil, rows: nil)
-      @filename = filename if filename
       @sheet = sheet if sheet
+      @filename = filename if filename
+      @dict = dict if dict
+      @rows = rows if rows
       workbook = RubyXL::Parser.parse(@filename)
       worksheet = workbook[@sheet]
-      if @dict != nil
-        worksheet.sheet_data.rows.tap do |head, *body|
+      if !@dict.nil?
+        worksheet.sheet_data.rows.tap do |_head, *body|
           body.each do |row|
             k = row[0].value
             if @dict.include?(k)
@@ -90,20 +101,20 @@ module Webdrone
             end
           end
         end
-      elsif @rows != nil
+      elsif !@rows.nil?
         @rows.each_with_index do |row, rowi|
           row.each_with_index do |data, coli|
-            if worksheet[rowi] == nil || worksheet[rowi][coli] == nil
+            if worksheet[rowi].nil? || worksheet[rowi][coli].nil?
               worksheet.add_cell(rowi, coli, data)
             else
               worksheet[rowi][coli].change_contents(data)
             end
           end
         end
-      elsif @both != nil
+      elsif !@both.nil?
         rows = worksheet.sheet_data.rows.collect do |row|
           row.cells.collect do |cell|
-            cell.value if cell != nil
+            cell&.value
           end
         end
         head = rows.shift
@@ -111,7 +122,7 @@ module Webdrone
           entry.each do |k, v|
             coli = head.index(k)
             if coli
-              if worksheet[rowi + 1] == nil || worksheet[rowi + 1][coli] == nil
+              if worksheet[rowi + 1].nil? || worksheet[rowi + 1][coli].nil?
                 worksheet.add_cell(rowi + 1, coli, v)
               else
                 worksheet[rowi + 1][coli].change_contents(v)
@@ -120,28 +131,32 @@ module Webdrone
           end
         end
       end
-      k = workbook.write(@filename)
+      workbook.write(@filename)
       reset
-    rescue => exception
-      Webdrone.report_error(@a0, exception)
+    rescue StandardError => error
+      Webdrone.report_error(@a0, error)
     end
 
-    def reset()
+    def reset
       @dict = @rows = @both = nil
-    rescue => exception
-      Webdrone.report_error(@a0, exception)
+    rescue StandardError => error
+      Webdrone.report_error(@a0, error)
     end
 
     protected
-      def update_sheet_filename(sheet, filename)
-        if sheet and sheet != @sheet
-          @sheet = sheet
-          reset
-        end
-        if filename and filename != @filename
-          @filename = filename
-          reset
-        end
+
+    def update_sheet_filename(sheet, filename)
+      if sheet && sheet != @sheet
+        @sheet = sheet
+        reset
       end
+
+      if filename && filename != @filename
+        @filename = filename
+        reset
+      end
+
+      nil
+    end
   end
 end

data/lib/webdrone/xpath.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Webdrone
+  # Code from teamcapybara/xpath
+  # Copyright (c) 2016 Jonas Nicklas - MIT LICENSE
+  module XPath
+    include ::XPath::DSL
+    extend self
+
+    # Match an `a` link element.
+    #
+    # @param [String] locator
+    #   Text, id, title, or image alt attribute of the link
+    #
+    def link(locator)
+      locator = locator.to_s
+      link = descendant(:a)[attr(:href)]
+      link[attr(:id).equals(locator) | string.n.is(locator) | attr(:title).is(locator) | descendant(:img)[attr(:alt).is(locator)]]
+    end
+
+    # Match a `submit`, `image`, or `button` element.
+    #
+    # @param [String] locator
+    #   Value, title, id, or image alt attribute of the button
+    #
+    def button(locator)
+      locator = locator.to_s
+      button = descendant(:input)[attr(:type).one_of('submit', 'reset', 'image', 'button')][attr(:id).equals(locator) | attr(:value).is(locator) | attr(:title).is(locator)]
+      button += descendant(:button)[attr(:id).equals(locator) | attr(:value).is(locator) | string.n.is(locator) | attr(:title).is(locator)]
+      button += descendant(:input)[attr(:type).equals('image')][attr(:alt).is(locator)]
+    end
+
+    # Match anything returned by either {#link} or {#button}.
+    #
+    # @param [String] locator
+    #   Text, id, title, or image alt attribute of the link or button
+    #
+    def link_or_button(locator)
+      link(locator) + button(locator)
+    end
+
+    # Match any `fieldset` element.
+    #
+    # @param [String] locator
+    #   Legend or id of the fieldset
+    #
+    def fieldset(locator)
+      locator = locator.to_s
+      descendant(:fieldset)[attr(:id).equals(locator) | child(:legend)[string.n.is(locator)]]
+    end
+
+    # Match any `input`, `textarea`, or `select` element that doesn't have a
+    # type of `submit`, `image`, or `hidden`.
+    #
+    # @param [String] locator
+    #   Label, id, or name of field to match
+    #
+    def field(locator)
+      locator = locator.to_s
+      xpath = descendant(:input, :textarea, :select)[~attr(:type).one_of('submit', 'image', 'hidden')]
+      xpath = locate_field(xpath, locator)
+      xpath
+    end
+
+    # Match any `input` or `textarea` element that can be filled with text.
+    # This excludes any inputs with a type of `submit`, `image`, `radio`,
+    # `checkbox`, `hidden`, or `file`.
+    #
+    # @param [String] locator
+    #   Label, id, or name of field to match
+    #
+    def fillable_field(locator)
+      locator = locator.to_s
+      xpath = descendant(:input, :textarea)[~attr(:type).one_of('submit', 'image', 'radio', 'checkbox', 'hidden', 'file')]
+      xpath = locate_field(xpath, locator)
+      xpath
+    end
+
+    # Match any `select` element.
+    #
+    # @param [String] locator
+    #   Label, id, or name of the field to match
+    #
+    def select(locator)
+      locator = locator.to_s
+      locate_field(descendant(:select), locator)
+    end
+
+    # Match any `input` element of type `checkbox`.
+    #
+    # @param [String] locator
+    #   Label, id, or name of the checkbox to match
+    #
+    def checkbox(locator)
+      locator = locator.to_s
+      locate_field(descendant(:input)[attr(:type).equals('checkbox')], locator)
+    end
+
+    # Match any `input` element of type `radio`.
+    #
+    # @param [String] locator
+    #   Label, id, or name of the radio button to match
+    #
+    def radio_button(locator)
+      locator = locator.to_s
+      locate_field(descendant(:input)[attr(:type).equals('radio')], locator)
+    end
+
+    # Match any `input` element of type `file`.
+    #
+    # @param [String] locator
+    #   Label, id, or name of the file field to match
+    #
+    def file_field(locator)
+      locator = locator.to_s
+      locate_field(descendant(:input)[attr(:type).equals('file')], locator)
+    end
+
+    # Match an `optgroup` element.
+    #
+    # @param [String] name
+    #   Label for the option group
+    #
+    def optgroup(locator)
+      locator = locator.to_s
+      descendant(:optgroup)[attr(:label).is(locator)]
+    end
+
+    # Match an `option` element.
+    #
+    # @param [String] name
+    #   Visible text of the option
+    #
+    def option(locator)
+      locator = locator.to_s
+      descendant(:option)[string.n.is(locator)]
+    end
+
+    # Match any `table` element.
+    #
+    # @param [String] locator
+    #   Caption or id of the table to match
+    # @option options [Array] :rows
+    #   Content of each cell in each row to match
+    #
+    def table(locator)
+      locator = locator.to_s
+      descendant(:table)[attr(:id).equals(locator) | descendant(:caption).is(locator)]
+    end
+
+    # Match any 'dd' element.
+    #
+    # @param [String] locator
+    #   Id of the 'dd' element or text from preciding 'dt' element content
+    def definition_description(locator)
+      locator = locator.to_s
+      descendant(:dd)[attr(:id).equals(locator) | previous_sibling(:dt)[string.n.equals(locator)] ]
+    end
+
+    protected
+
+    def locate_field(xpath, locator)
+      locate_field = xpath[attr(:id).equals(locator) | attr(:name).equals(locator) | attr(:placeholder).equals(locator) | attr(:id).equals(anywhere(:label)[string.n.is(locator)].attr(:for))]
+      locate_field += descendant(:label)[string.n.is(locator)].descendant(xpath)
+      locate_field
+    end
+  end
+end