rudra 1.0.13 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a3a4f9fb5eee63f5a3f29102e0c1161256fb30b098c108ca3c415663b062113
-  data.tar.gz: 72bf75e1a6bdd4913c944944b6f0a7427082ce38fe7800202710e72a3f012e23
+  metadata.gz: b59cfa6497e4560d80369dc076df45638ec043abe069b5f6665e5749aefdef87
+  data.tar.gz: 51e97a957330ffce97411d9f3ad40e01a4be439cc677306d5507ae0136577beb
 SHA512:
-  metadata.gz: 7f6a25ab7afd10bdc21c73c3c09710791a69b7ffb3d887a285a2f94b6069d83c7ab07a0d1f62b541dfd7e20935661be94491f731c9a79a9d2f035a3b8e760538
-  data.tar.gz: adc43a16f2f13f0a59acaa41de6c790ab88f9c19caf8372b9951c79ca8428d206cf13d9f80806dc7252acc05174b81880f8f3c411447aefefbfa92d896c6216b
+  metadata.gz: f7984dccb05ea056c716dd533c5d4662e83ea8711c62a2fc3f02f95d0d7a795914d16c2ceacd2ef2cf1eff26374ae9c8ed795a14797186f696356f3c02c687bf
+  data.tar.gz: 4bfb07ee8abe3ce212c85ca19ab052fb134b47c42e225e7160ea6463795e425e22a594998d2e89365709a3d2b1495a2c5cbbb0894b64bd1bfc073a190519ef8f

data/lib/rudra.rb

@@ -1,9 +1,5 @@
 require 'selenium-webdriver'
-require 'webdrivers/chromedriver'
-require 'webdrivers/geckodriver'
-
-# Selenium::WebDriver::Chrome::Service.driver_path = './webdrivers/chromedriver'
-# Selenium::WebDriver::Firefox::Service.driver_path = './webdrivers/geckodriver'
+require 'webdrivers'
 
 # Selenium IDE-like WebDriver based upon Ruby binding
 # @author Aaron Chen
@@ -12,11 +8,16 @@ require 'webdrivers/geckodriver'
 #   of the chosen browser
 # @attr_reader [String] install_dir The install directory of WebDrivers
 # @attr_reader [String] locale The browser locale
+# @attr_reader [Boolean] headless Headless mode for Google Chrome
+# @attr_reader [String] window_size Chrome window size when headless
+# @attr_reader [String] screen_dir The screenshot directory of save_screenshot
+# @attr_reader [String] log_prefix Prefix for logging descriptions and methods
 # @attr_reader [Integer] timeout The driver timeout
-# @attr_reader [Boolean] verbose Verbose mode
+# @attr_reader [Boolean] verbose Turn on/off Verbose mode
+# @attr_reader [Boolean] silent Turn off Turn on/off descriptions
 class Rudra
   # Supported Browsers
-  BROWSERS = %i[chrome firefox safari].freeze
+  BROWSERS = %i[chrome firefox ie safari].freeze
 
   # Element Finder Methods
   HOWS = %i[
@@ -27,11 +28,13 @@ class Rudra
   # Attributes
   ATTRIBUTES = %i[
     browser driver install_dir locale
-    headless log_prefix timeout verbose
+    headless window_size screen_dir
+    log_prefix timeout verbose silent
   ].freeze
 
   attr_reader :browser, :driver, :install_dir, :locale,
-              :headless, :log_prefix, :timeout, :verbose
+              :headless, :window_size, :screen_dir,
+              :log_prefix, :timeout, :verbose, :silent
 
   # Initialize an instance of Rudra
   # @param [Hash] options the options to initialize Rudra
@@ -41,29 +44,27 @@ class Rudra
   #   directory of WebDrivers
   # @option options [Symbol] :locale (:en) the browser locale
   # @option options [Boolean] :headless (false) headless mode
-  # @option options [String] :log_prefix (' - ') log prefix
+  # @option options [String] :window_size ('1280,720') window size when headless
+  # @option options [String] :screen_dir ('./screens/') the location of screenshots
+  # @option options [String] :log_prefix (' - ') prefix for logging descriptions and methods
   # @option options [Integer] :timeout (30) implicit_wait timeout
-  # @option options [Boolean] :verbose (true) verbose mode
+  # @option options [Boolean] :verbose (false) Turn on/off verbose mode
+  # @option options [Boolean] :silent (false) Turn on/off descriptions
   def initialize(options = {})
     self.browser = options.fetch(:browser, :chrome)
     self.install_dir = options.fetch(:install_dir, './webdrivers/')
     self.locale = options.fetch(:locale, :en)
     self.headless = options.fetch(:headless, false)
+    self.window_size = options.fetch(:window_size, '1280,720')
+    self.screen_dir = options.fetch(:screen_dir, './screens/')
     self.log_prefix = options.fetch(:log_prefix, ' - ')
-    self.verbose = options.fetch(:verbose, true)
+    self.verbose = options.fetch(:verbose, false)
+    self.silent = options.fetch(:silent, false)
+    self.main_label = caller_locations(2, 1).first.label
 
     initialize_driver
 
     self.timeout = options.fetch(:timeout, 30)
-
-    @main_label = caller_locations(2, 1).first.label
-    @verbose && (
-        puts %(
-          ============ Rudra ============
-          Browser: #{@browser}, Locale: #{@locale}
-          ============  Log  ============
-        ).lines.map(&:strip).reject(&:empty?).join("\n")
-      )
   end
 
   #
@@ -104,6 +105,7 @@ class Rudra
   end
 
   # Send keys to an alert
+  # @param [String] keys keystrokes to send
   def alert_send_keys(keys)
     switch_to_alert.send_keys(keys)
   end
@@ -208,7 +210,7 @@ class Rudra
 
   # Maximize the current window
   def maximize
-    driver.manage.window.maximize
+    driver.manage.window.maximize unless headless
   end
 
   # Maximize the current window to the size of the screen
@@ -266,6 +268,12 @@ class Rudra
     driver.page_source
   end
 
+  # Print description in the console
+  # @param [String] description description to show
+  def puts(description)
+    $stdout.puts "#{log_prefix}#{description.chomp}" unless silent
+  end
+
   # Refresh the current pagef
   def refresh
     driver.navigate.refresh
@@ -278,11 +286,15 @@ class Rudra
     driver.manage.window.resize_to(width, height)
   end
 
-  # Save a PNG screenshot to the given path
-  # @param [String] png_path the path of PNG screenshot
-  def save_screenshot(png_path)
+  # Save a PNG screenshot to file
+  # @param [String] filename the filename of PNG screenshot
+  def save_screenshot(filename)
+    mkdir(@screen_dir) unless Dir.exist?(@screen_dir)
     driver.save_screenshot(
-      png_path.end_with?('.png') ? png_path : "#{png_path}.png"
+      File.join(
+        @screen_dir,
+        filename.end_with?('.png') ? filename : "#{filename}.png"
+      )
     )
   end
 
@@ -1066,9 +1078,7 @@ class Rudra
   end
 
   (instance_methods - superclass.instance_methods).map do |method_name|
-    if private_method_defined?(method_name) || ATTRIBUTES.include?(method_name)
-      next
-    end
+    next if private_method_defined?(method_name) || ATTRIBUTES.include?(method_name) || method_name == :puts
 
     original_method = instance_method(method_name)
 
@@ -1080,6 +1090,9 @@ class Rudra
 
   private
 
+  attr_accessor :main_label
+  attr_writer :silent, :window_size
+
   def browser=(brw)
     unless BROWSERS.include?(brw)
       browsers = BROWSERS.map { |b| ":#{b}" }.join(', ')
@@ -1105,6 +1118,10 @@ class Rudra
     @headless = true?(mode)
   end
 
+  def screen_dir=(path)
+    @screen_dir = File.join(path, @locale.to_s)
+  end
+
   def log_prefix=(prefix)
     @log_prefix = prefix.chomp
   end
@@ -1127,8 +1144,12 @@ class Rudra
   def initialize_driver
     @driver = if browser == :chrome
                 Selenium::WebDriver.for(:chrome, options: chrome_options)
+              # elsif browser == :edge
+              #   Selenium::WebDriver.for(:edge, options: edge_options)
               elsif browser == :firefox
                 Selenium::WebDriver.for(:firefox, options: firefox_options)
+              elsif browser == :ie
+                Selenium::WebDriver.for(:ie, options: ie_options)
               else
                 Selenium::WebDriver.for(:safari)
               end
@@ -1137,11 +1158,22 @@ class Rudra
   def chrome_options
     options = Selenium::WebDriver::Chrome::Options.new
     options.add_argument('--disable-notifications')
-    options.add_argument('--headless') if headless
+    if headless
+      options.add_argument('--headless')
+      options.add_argument("--window-size=#{window_size}")
+    end
+    options.add_option(
+      'excludeSwitches',
+      %w[enable-automation enable-logging]
+    )
     options.add_preference('intl.accept_languages', locale)
     options
   end
 
+  # def edge_options
+  #   Selenium::WebDriver::Edge::Options.new
+  # end
+
   def firefox_options
     options = Selenium::WebDriver::Firefox::Options.new
     options.add_preference('intl.accept_languages', locale)
@@ -1149,6 +1181,16 @@ class Rudra
     options
   end
 
+  def ie_options
+    options = Selenium::WebDriver::IE::Options.new
+    options.ensure_clean_session = true
+    options.full_page_screenshot = true
+    options.ignore_protected_mode_settings = true
+    options.ignore_zoom_level = true
+    options.native_events = false
+    options
+  end
+
   def parse_locator(locator)
     unmatched, how, what = locator.split(/^([A-Za-z]+)=(.+)/)
 
@@ -1170,11 +1212,11 @@ class Rudra
   end
 
   def log(method_name, *args)
-    return unless @verbose && caller_locations(2, 1).first.label == @main_label
+    return unless verbose && caller_locations(2, 1).first.label == main_label
 
     arguments = args.map(&:to_s).join(', ')
 
-    puts @log_prefix + (
+    puts log_prefix + (
       arguments.empty? ? method_name.to_s : "#{method_name}(#{arguments})"
     )
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rudra
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.1.0
 platform: ruby
 authors:
 - Aaron Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.24
+        version: 0.9.25
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.24
+        version: 0.9.25
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -48,24 +48,24 @@ dependencies:
   name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.3.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.3.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.1
 description: Selenium IDE alternative using selenium-webdriver
-email: aaron@oobo.be
+email: aaron@611b.com
 executables: []
 extensions: []
 extra_rdoc_files: []