webdrone 1.7.8 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 79f6baed6b1b3a6dfa49139033fcf90ca441455f
-  data.tar.gz: e6db81816ea558f73cb6345fcb21e4f35f6cc880
+SHA256:
+  metadata.gz: 76c2f2e2bb45e0e189f030c402625b90b08e57e1628550a70e5415d7b109f489
+  data.tar.gz: 0714440a727a83fd63064acafc7c54e69b0803fd1b183f8e4033a3f07ff45eed
 SHA512:
-  metadata.gz: 5dae707651daccdae02d26ebe4f8322c9eddac50049bce86f21a15bc085df3ca18146f2c5426a35ec4d60ae105b3e0317f69e600c7d4bda127b7b78754a1b64d
-  data.tar.gz: aa2ba3f30b3c52ce3d62d0183397c93a64930e354f2f18ce1bbaad2a9d0ee44d67bd75e57e021e6f5dbaf571800b286ed328110ec5d5bc476e5c92f4f045ddf5
+  metadata.gz: 1c2396c6fa5fcd968b682221e1194cb5aa562cffa4408c28b41bc91c24a92a26adafeeb04d17ae5af12f53d0f81819046f3efb5c8b9e2f951efe11c72beebd61
+  data.tar.gz: bca0e11fc656f8a3d75ec7149dcc62937e38288c6aa8a7658b0ab9bfbab0675c2c89bcb050199302343ce3477cf2f4924faf8096c7262dd29e3e9c77921d5c9a

data/.rubocop.relaxed.yml

@@ -0,0 +1,165 @@
+# Relaxed.Ruby.Style
+## Version 2.2
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledocumentation
+
+Layout/DotPosition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutdotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
+
+Layout/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.5
+inherit_from:
+- .rubocop.relaxed.yml
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+Style/AccessModifierDeclarations:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-ruby-2.4.1
+ruby-2.5.1

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "webdrone"
+require 'bundler/setup'
+require 'webdrone'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "webdrone"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/webdrone.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'os'
 require 'selenium-webdriver'
 require 'xpath'
@@ -28,59 +30,65 @@ require 'webdrone/text'
 require 'webdrone/vrfy'
 require 'webdrone/html'
 require 'webdrone/logg'
+require 'webdrone/xpath'
 
 module Webdrone
-  def self.create(*args)
-    a0 = Webdrone::Browser.new *args
-    if block_given?
-      begin
-        yield a0
-      rescue => exception
-        Webdrone.report_error(a0, exception)
-      ensure
-        a0.quit
+  class << self
+    attr_accessor :running_pry, :irb_setup_done
+
+    def create(*args)
+      a0 = Webdrone::Browser.new(*args)
+      if block_given?
+        begin
+          yield a0
+        rescue StandardError => error
+          Webdrone.report_error(a0, error)
+        ensure
+          a0.quit
+        end
+      else
+        a0
       end
-    else
-      a0
     end
   end
 
   def self.irb_console(binding = nil)
     puts "Webdrone: Webdrone.irb_console IS DEPRECATED, please use a0.console instead."
-    return if IRB.CurrentContext and not binding
-    binding = Kernel.binding.of_caller(1) if binding == nil
+    return if IRB.CurrentContext && !binding
+    binding ||= Kernel.binding.of_caller(1)
     IRB.start_session(binding)
   end
 
-  @@running_pry = false
+  Webdrone.running_pry = false
   def self.pry_console(binding = nil)
-    if @@running_pry
+    if Webdrone.running_pry
       puts "Webdrone: pry console already running."
     else
-      @@running_pry = true
-      binding = Kernel.binding.of_caller(1) unless binding
+      Webdrone.running_pry = true
+      binding ||= Kernel.binding.of_caller(1)
       binding.pry
-      @@running_pry = false
+      Webdrone.running_pry = false
     end
   end
 end
 
 module IRB
   def self.start_session(binding)
-    unless $a0_irb_setup_done
+    unless Webdrone.irb_setup_done
       IRB.setup(nil)
-      $a0_irb_setup_done = true
+      Webdrone.irb_setup_done = true
     end
 
     workspace = WorkSpace.new(binding)
 
-    if @CONF[:SCRIPT]
-      irb = Irb.new(workspace, @CONF[:SCRIPT])
-    else
-      irb = Irb.new(workspace)
-    end
+    irb = \
+      if @CONF[:SCRIPT]
+        Irb.new(workspace, @CONF[:SCRIPT])
+      else
+        Irb.new(workspace)
+      end
 
-    @CONF[:IRB_RC].call(irb.context) if @CONF[:IRB_RC]
+    @CONF[:IRB_RC]&.call(irb.context)
     @CONF[:MAIN_CONTEXT] = irb.context
 
     trap("SIGINT") do
@@ -95,4 +103,4 @@ module IRB
       IRB.irb_at_exit
     end
   end
-end
+end

data/lib/webdrone/browser.rb

@@ -1,108 +1,82 @@
+# frozen_string_literal: true
+
 module Webdrone
   class Browser
-    @@firefox_profile = @@chrome_options = nil
-    attr_accessor :driver
-
-    def self.firefox_profile
-      if @@firefox_profile == nil
-        @@firefox_profile = Selenium::WebDriver::Firefox::Profile.new
-        @@firefox_profile['startup.homepage_welcome_url.additional'] = 'about:blank'
-        @@firefox_profile['browser.download.folderList'] = 2
-        @@firefox_profile['browser.download.manager.showWhenStarting'] = false
-        @@firefox_profile['browser.helperApps.neverAsk.saveToDisk'] = "images/jpeg, application/pdf, application/octet-stream, application/download"
-      end
-      @@firefox_profile
-    end
+    attr_reader :driver
 
-    def self.firefox_profile=(firefox_profile)
-      @@firefox_profile = firefox_profile
-    end
+    class << self
+      attr_writer :firefox_profile, :chrome_options
 
-    def self.chrome_options
-      if @@chrome_options == nil
-        @@chrome_options = Selenium::WebDriver::Chrome::Options.new
-        @@chrome_options.add_preference 'download.prompt_for_download', false
-        @@chrome_options.add_preference 'credentials_enable_service:', false
+      def firefox_profile
+        return @firefox_profile if defined? @firefox_profile
+
+        @firefox_profile = Selenium::WebDriver::Firefox::Profile.new
+        @firefox_profile['startup.homepage_welcome_url.additional'] = 'about:blank'
+        @firefox_profile['browser.download.folderList'] = 2
+        @firefox_profile['browser.download.manager.showWhenStarting'] = false
+        @firefox_profile['browser.helperApps.neverAsk.saveToDisk'] = "images/jpeg, application/pdf, application/octet-stream, application/download"
+
+        @firefox_profile
       end
-      @@chrome_options
-    end
 
-    def env_update(binding)
-      bool_vars = [:create_outdir, :developer, :quit_at_exit, :maximize]
-      ENV.keys.select { |env| env.start_with? 'WEBDRONE_' }.each do |env|
-        v = env[9..-1].downcase.to_sym
-        if binding.local_variable_defined? v
-          o = binding.local_variable_get(v)
-          n = ENV[env]
-          if bool_vars.include? v
-            if n == "true"
-              n = true
-            elsif n == "false"
-              n = false
-            else
-              puts "Webdrone: ignoring value '#{n}' for boolean parameter #{v}."
-              next
-            end
-          end
-          binding.local_variable_set(v, n)
-          puts "Webdrone: overriding #{v} from '#{o}' to '#{n}'."
-        elsif v == :mark_times
-          n = ENV[env].to_i
-          puts "Webdrone: setting mark times to #{n}"
-          self.mark.default_times = n
-        elsif v == :mark_sleep
-          n = ENV[env].to_f
-          puts "Webdrone: setting mark sleep to #{n}"
-          self.mark.default_sleep = n
-        else
-          puts "Webdrone: ignoring unknown parameter #{env}."
-        end
+      def chrome_options
+        return @chrome_options if defined? @chrome_options
+
+        @chrome_options = Selenium::WebDriver::Chrome::Options.new
+        @chrome_options.add_preference 'download.prompt_for_download', false
+        @chrome_options.add_preference 'credentials_enable_service:', false
+
+        @chrome_options
       end
     end
 
     def initialize(browser: 'firefox', create_outdir: true, outdir: nil, timeout: 30, developer: false, logger: true, quit_at_exit: true, maximize: true, error: :raise_report, win_x: nil, win_y: nil, win_w: nil, win_h: nil, use_env: true, chrome_options: nil, firefox_profile: nil, remote_url: nil, headless: false)
       env_update(Kernel.binding) if use_env
-      if create_outdir or outdir
+
+      if create_outdir || outdir
         outdir ||= File.join("webdrone_output", Time.new.strftime('%Y%m%d_%H%M%S'))
-        self.conf.outdir = outdir
+        conf.outdir = outdir
       end
-      outdir = File.join(Dir.pwd, outdir) if outdir != nil and not Pathname.new(outdir).absolute?
+      outdir = File.join(Dir.pwd, outdir) if !outdir.nil? && !Pathname.new(outdir).absolute?
+
       if remote_url
         @driver = Selenium::WebDriver.for :remote, url: remote_url, desired_capabilities: browser.to_sym
-      elsif outdir != nil and browser.to_sym == :chrome
-        chrome_options = Browser.chrome_options if chrome_options == nil
+      elsif !outdir.nil? && browser.to_sym == :chrome
+        chrome_options ||= Browser.chrome_options
         chrome_options.add_preference 'download.default_directory', outdir
         chrome_options.add_argument '--disable-popup-blocking'
         chrome_options.add_argument '--headless' if headless
         @driver = Selenium::WebDriver.for browser.to_sym, options: chrome_options
-      elsif outdir != nil and browser.to_sym == :firefox
-        firefox_profile = Browser.firefox_profile if firefox_profile == nil
-        downdir = OS.windows? ? outdir.gsub("/", "\\") : outdir
+      elsif !outdir.nil? && browser.to_sym == :firefox
+        firefox_profile ||= Browser.firefox_profile
+        downdir = OS.windows? ? outdir.tr("/", "\\") : outdir
         firefox_profile['browser.download.dir'] = downdir
         @driver = Selenium::WebDriver.for browser.to_sym, profile: firefox_profile
       else
         @driver = Selenium::WebDriver.for browser.to_sym
       end
+
       if quit_at_exit
         at_exit do
-          begin
-            @driver.quit
-          rescue
-          end
+          @driver.quit
+        rescue StandardError
+          nil
         end
       end
-      self.conf.error = error.to_sym
-      self.conf.developer = developer
-      self.conf.timeout = timeout.to_i if timeout
-      self.conf.logger = logger
-      
+
+      conf.error = error.to_sym
+      conf.developer = developer
+      conf.timeout = timeout.to_i if timeout
+      conf.logger = logger
+
       if developer
         win_x = win_y = 0
         win_w = 0.5
         win_h = 1.0
       end
-      if win_x or win_y or win_w or win_h
-        x, y, w, h = self.exec.script 'return [window.screenLeft ? window.screenLeft : window.screenX, window.screenTop ? window.screenTop : window.screenY, window.screen.availWidth, window.screen.availHeight];'
+
+      if win_x || win_y || win_w || win_h
+        x, y, w, h = exec.script 'return [window.screenLeft ? window.screenLeft : window.screenX, window.screenTop ? window.screenTop : window.screenY, window.screen.availWidth, window.screen.availHeight];'
         win_x ||= x
         win_y ||= y
         if win_w.is_a? Float
@@ -118,11 +92,11 @@ module Webdrone
         begin
           @driver.manage.window.position = Selenium::WebDriver::Point.new win_x, win_y
           @driver.manage.window.resize_to(win_w, win_h)
-        rescue => e
+        rescue StandardError => e
           puts "Ignoring error on window position/resize: #{e}"
         end
-      else
-        self.maximize if maximize
+      elsif maximize
+        self.maximize
       end
     end
 
@@ -136,16 +110,56 @@ module Webdrone
 
     def console(binding = nil)
       return unless conf.developer
-      binding = Kernel.binding.of_caller(1) unless binding
-      old_error = self.conf.error
-      old_developer = self.conf.developer
+      binding ||= Kernel.binding.of_caller(1)
+      old_error = conf.error
+      old_developer = conf.developer
       begin
-        self.conf.error = :raise
-        self.conf.developer = false
+        conf.error = :raise
+        conf.developer = false
         Webdrone.pry_console binding
       ensure
-        self.conf.error = old_error
-        self.conf.developer = old_developer
+        conf.error = old_error
+        conf.developer = old_developer
+      end
+    end
+
+    protected
+
+    def env_update_bool(binding, var, val_old, val_new)
+      if val_new == "true"
+      elsif val_new == "false"
+      else
+        puts "Webdrone: ignoring value '#{val_new}' for boolean parameter #{var}."
+        return
+      end
+      binding.local_variable_set(var, val_new)
+      puts "Webdrone: overriding #{var} from '#{val_old}' to '#{val_new}'."
+    end
+
+    def env_update(binding)
+      bool_vars = %i[create_outdir developer quit_at_exit maximize]
+      ENV.keys.select { |env| env.start_with? 'WEBDRONE_' }.each do |env|
+        var = env[9..-1].downcase.to_sym
+        if binding.local_variable_defined? var
+          val_old = binding.local_variable_get(var)
+          val_new = ENV[env]
+          if bool_vars.include? var
+            env_update_bool(binding, var, val_old, val_new)
+          else
+            binding.local_variable_set(var, val_new)
+            puts "Webdrone: overriding #{var} from '#{val_old}' to '#{val_new}'."
+          end
+        elsif v == :mark_times
+          n = ENV[env].to_i
+          puts "Webdrone: setting mark times to #{n}"
+          mark.default_times = n
+        elsif v == :mark_sleep
+          n = ENV[env].to_f
+          puts "Webdrone: setting mark sleep to #{n}"
+          mark.default_sleep = n
+        else
+          puts "Webdrone: ignoring unknown parameter #{env}."
+        end
       end
     end
   end