howitzer 1.0.2 → 1.1.0

data/lib/howitzer/helpers.rb

@@ -1,121 +1,178 @@
 require 'howitzer/exceptions'
 
-CHECK_YOUR_SETTINGS_MSG = "Please check your settings"
+module Helpers
 
-def sauce_driver?
-  log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
-  settings.driver.to_sym == :sauce
-end
+  CHECK_YOUR_SETTINGS_MSG = "Please check your settings"
 
-def testingbot_driver?
-  log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
-  settings.driver.to_sym == :testingbot
-end
+  ##
+  #
+  # Returns whether or not the current driver is SauceLabs.
+  #
 
-def selenium_driver?
-  log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
-  settings.driver.to_sym == :selenium
-end
+  def sauce_driver?
+    log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
+    settings.driver.to_s.to_sym == :sauce
+  end
 
-def phantomjs_driver?
-  log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
-  settings.driver.to_sym == :phantomjs
-end
+  ##
+  #
+  # Returns whether or not the current driver is TestingBot.
+  #
 
-def ie_browser?
-  ie_browsers = [:ie, :iexplore]
-  if sauce_driver?
-    log.error Howitzer::SlBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sl_browser_name.nil?
-    ie_browsers.include?(settings.sl_browser_name.to_sym)
-  elsif testingbot_driver?
-    log.error Howitzer::TbBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.tb_browser_name.nil?
-    ie_browsers.include?(settings.tb_browser_name.to_sym)
-  elsif selenium_driver?
-    log.error Howitzer::SelBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sel_browser.nil?
-    ie_browsers.include?(settings.sel_browser.to_sym)
+  def testingbot_driver?
+    log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
+    settings.driver.to_s.to_sym == :testingbot
   end
-end
 
-def ff_browser?
-  ff_browsers = [:ff, :firefox]
-  if sauce_driver?
-    log.error Howitzer::SlBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sl_browser_name.nil?
-    ff_browsers.include?(settings.sl_browser_name.to_sym)
-  elsif testingbot_driver?
-    log.error Howitzer::TbBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.tb_browser_name.nil?
-    ff_browsers.include?(settings.tb_browser_name.to_sym)
-  elsif selenium_driver?
-    log.error Howitzer::SelBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sel_browser.nil?
-    ff_browsers.include?(settings.sel_browser.to_sym)
+  ##
+  #
+  # Returns whether or not the current driver is Selenium.
+  #
+
+  def selenium_driver?
+    log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
+    settings.driver.to_s.to_sym == :selenium
   end
-end
 
+  ##
+  #
+  # Returns whether or not the current driver is Selenium Grid.
+  #
 
-def chrome_browser?
-  chrome_browser = :chrome
-  if sauce_driver?
-    log.error Howitzer::SlBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sl_browser_name.nil?
-    settings.sl_browser_name.to_sym == chrome_browser
-  elsif testingbot_driver?
-    log.error Howitzer::TbBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.tb_browser_name.nil?
-    settings.tb_browser_name.to_sym == chrome_browser
-  elsif selenium_driver?
-    log.error Howitzer::SelBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sel_browser.nil?
-    settings.sel_browser.to_sym == chrome_browser
+  def selenium_grid_driver?
+    log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
+    settings.driver.to_s.to_sym == :selenium_grid
   end
-end
 
+  ##
+  #
+  # Returns whether or not the current driver is PhantomJS.
+  #
+
+  def phantomjs_driver?
+    log.error Howitzer::DriverNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.driver.nil?
+    settings.driver.to_s.to_sym == :phantomjs
+  end
 
-##
-#
-# Returns application url including base authentication (if specified in settings)
-#
+  ##
+  #
+  # Returns whether or not the current browser is Internet Explorer.
+  #
 
-def app_url                         
-  prefix = settings.app_base_auth_login.blank? ? '' : "#{settings.app_base_auth_login}:#{settings.app_base_auth_pass}@"
-  app_base_url prefix
-end
+  def ie_browser?
+    browser? :ie, :iexplore
+  end
 
-##
-# Returns application url without base authentication by default
-#
-# *Parameters:*
-# * +prefix+ - Sets base authentication prefix (defaults to: nil)
-#
+  ##
+  #
+  # Returns whether or not the current browser is FireFox.
+  #
 
-def app_base_url(prefix=nil)
-  "#{settings.app_protocol || 'http'}://#{prefix}#{settings.app_host}"
-end
+  def ff_browser?
+    browser? :ff, :firefox
+  end
 
-# *Parameters:*
-# * +time_in_numeric+ - Number of seconds
-#
-
-def duration(time_in_numeric)
-  secs = time_in_numeric.to_i
-  mins = secs / 60
-  hours = mins / 60
-  if hours > 0
-    "[#{hours}h #{mins % 60}m #{secs % 60}s]"
-  elsif mins > 0
-    "[#{mins}m #{secs % 60}s]"
-  elsif secs >= 0
-    "[0m #{secs}s]"
+  ##
+  #
+  # Returns whether or not the current browser is Google Chrome.
+  #
+
+  def chrome_browser?
+    browser? :chrome
   end
-end
 
-##
-#
-# Evaluates given value
-#
-# *Parameters:*
-# * +value+ - Value to be evaluated
-#
+  ##
+  #
+  # Returns whether or not the current browser is Opera.
+  #
+
+  def opera_browser?
+    browser? :opera
+  end
+
+  ##
+  #
+  # Returns whether or not the current browser is Safari.
+  #
+
+  def safari_browser?
+    browser? :safari
+  end
+
+  ##
+  #
+  # Returns application url including base authentication (if specified in settings)
+  #
+
+  def app_url
+    prefix = settings.app_base_auth_login.blank? ? '' : "#{settings.app_base_auth_login}:#{settings.app_base_auth_pass}@"
+    app_base_url prefix
+  end
+
+  ##
+  #
+  # Returns application url without base authentication by default
+  #
+  # *Parameters:*
+  # * +prefix+ - Sets base authentication prefix (defaults to: nil)
+  #
+
+  def app_base_url(prefix=nil)
+    "#{settings.app_protocol || 'http'}://#{prefix}#{settings.app_host}"
+  end
+
+  ##
+  #
+  # Returns formatted duration time
+  #
+  # *Parameters:*
+  # * +time_in_numeric+ - Number of seconds
+  #
+
+  def duration(time_in_numeric)
+    secs = time_in_numeric.to_i
+    mins = secs / 60
+    hours = mins / 60
+    if hours > 0
+      "[#{hours}h #{mins % 60}m #{secs % 60}s]"
+    elsif mins > 0
+      "[#{mins}m #{secs % 60}s]"
+    elsif secs >= 0
+      "[0m #{secs}s]"
+    end
+  end
+
+  ##
+  #
+  # Evaluates given value
+  #
+  # *Parameters:*
+  # * +value+ - Value to be evaluated
+  #
+
+  def ri(value)
+    raise value.inspect
+  end
+
+  private
+
+  def browser?(*browser_aliases)
+    if sauce_driver?
+      log.error Howitzer::SlBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sl_browser_name.nil?
+      browser_aliases.include?(settings.sl_browser_name.to_s.to_sym)
+    elsif testingbot_driver?
+      log.error Howitzer::TbBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.tb_browser_name.nil?
+      browser_aliases.include?(settings.tb_browser_name.to_s.to_sym)
+    elsif selenium_driver? || selenium_grid_driver?
+      log.error Howitzer::SelBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG if settings.sel_browser.nil?
+      browser_aliases.include?(settings.sel_browser.to_s.to_sym)
+    end
+  end
 
-def ri(value)
-  raise value.inspect
 end
 
+include Helpers
+
 class String
 
   ##
@@ -139,6 +196,11 @@ class String
     as_page_class.given
   end
 
+  ##
+  #
+  # Waits until page is opened or raise error
+  #
+
   def wait_for_opened
     as_page_class.wait_for_opened
   end
@@ -152,6 +214,11 @@ class String
     as_class('Page')
   end
 
+  ##
+  #
+  # Returns email class
+  #
+
   def as_email_class
     as_class('Email')
   end

data/lib/howitzer/mailgun/client.rb

@@ -23,7 +23,7 @@ module Mailgun
     #
     # @param [String] resource_path This is the API resource you wish to interact
     # with. Be sure to include your domain, where necessary.
-    # @param [Hash] query_string This should be a standard Hash
+    # @param [Hash] params This should be a standard Hash for query
     # containing required parameters for the requested resource.
     # @return [Mailgun::Response] A Mailgun::Response object.
 

data/lib/howitzer/tasks/framework.rake

@@ -0,0 +1,3 @@
+namespace :howitzer do
+ #This is for future usage of built-in tasks
+end

data/lib/howitzer/utils.rb

@@ -1,5 +1,5 @@
 require 'repeater'
 require 'active_support'
-require 'active_support/core_ext'
+require 'active_support/all'
 
 Dir[File.join(File.dirname(__FILE__), "./utils/**/*.rb")].each {|f| require f}

data/lib/howitzer/utils/locator_store.rb

@@ -198,7 +198,7 @@ module LocatorStore
       log.error Howitzer::BadLocatorParamsError, args.inspect if params.nil? || (!params.is_a?(Proc) && params.empty?)
       case params.class.name
         when 'Hash'
-          @locators[self.name][type][name] = [params.keys.first.to_sym, params.values.first.to_s]
+          @locators[self.name][type][name] = [params.keys.first.to_s.to_sym, params.values.first.to_s]
         when 'Proc'
           @locators[self.name][type][name] = params
         else

data/lib/howitzer/utils/log.rb

@@ -93,7 +93,7 @@ module Howitzer
       @logger = Logger.new("ruby_log")
       @logger.add(console_log)
       @logger.add(error_log)
-      @logger.add(txt_log)
+      @logger.add(txt_log) if !settings.log_dir.to_s.empty? && !settings.txt_log.to_s.empty?
       self.base_formatter = default_formatter
       Logger["ruby_log"].level = settings.debug_mode ? ALL : INFO
       Logger["ruby_log"].trace = true

data/lib/howitzer/utils/page_validator.rb

@@ -70,7 +70,7 @@ module Howitzer
         def validates(name, options)
           log.error TypeError, "Expected options to be Hash, actual is '#{options.class}'" unless options.class == Hash
           PageValidator.validations[self.name] ||= {}
-          case name.to_sym
+          case name.to_s.to_sym
             when :url
               validate_by_pattern(:url, options)
             when :element_presence

data/lib/howitzer/version.rb

@@ -1,3 +1,3 @@
 module Howitzer
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/howitzer/web_page.rb

@@ -1,8 +1,8 @@
-require "singleton"
-require "rspec/expectations"
-require "howitzer/utils/locator_store"
-require "howitzer/utils/page_validator"
-require "howitzer/capybara/dsl_ex"
+require 'singleton'
+require 'rspec/expectations'
+require 'howitzer/utils/locator_store'
+require 'howitzer/utils/page_validator'
+require 'howitzer/capybara/dsl_ex'
 require 'howitzer/exceptions'
 
 class WebPage
@@ -36,7 +36,7 @@ class WebPage
   def self.open(url = "#{app_url unless self == BlankPage}#{self::URL}")
     log.info "Open #{self.name} page by '#{url}' url"
     retryable(tries: 2, logger: log, trace: true, on: Exception) do |retries|
-      log.info "Retry..." unless retries.zero?
+      log.info 'Retry...' unless retries.zero?
       visit url
     end
     given
@@ -117,6 +117,7 @@ class WebPage
 
   def initialize
     check_validations_are_defined!
+    page.driver.browser.manage.window.maximize if settings.maximized_window
   end
 
   ##
@@ -184,7 +185,7 @@ class WebPage
       return true if page.evaluate_script('$.active') == 0
       sleep 0.25
     end
-    log.error message || "Timed out waiting for ajax requests to complete"
+    log.error message || 'Timed out waiting for ajax requests to complete'
   end
   #:nocov:
 
@@ -199,7 +200,7 @@ class WebPage
   #
 
   def wait_for_url(expected_url, timeout=settings.timeout_small)
-    warn "[Deprecated] This method is deprecated, and will be removed in next version of Howitzer"
+    warn '[Deprecated] This method is deprecated, and will be removed in next version of Howitzer'
     end_time = ::Time.now + timeout
     until ::Time.now > end_time
       operator = expected_url.is_a?(Regexp) ? :=~ : :==
@@ -219,7 +220,7 @@ class WebPage
   #
 
   def wait_for_title(expected_title, timeout=settings.timeout_small)
-    warn "[Deprecated] This method is deprecated, and will be removed in next version of Howitzer"
+    warn '[Deprecated] This method is deprecated, and will be removed in next version of Howitzer'
     end_time = ::Time.now + timeout
     until ::Time.now > end_time
       operator = expected_title.is_a?(Regexp) ? :=~ : :==
@@ -249,5 +250,4 @@ class WebPage
   def title
     page.title
   end
-
-end
+end

data/spec/spec_helper.rb

@@ -1,44 +1,33 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'simplecov'
+require 'coveralls'
 require 'tmpdir'
 require 'ffaker'
 require 'capybara'
 require 'json'
 require 'capybara/dsl'
 require 'active_support'
+require 'active_support/deprecation'
+require 'active_support/deprecation/method_wrappers'
 require 'active_support/core_ext'
 require 'repeater'
 require 'howitzer/exceptions'
 require 'howitzer/utils/log'
 
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+]
+
 SimpleCov.start do
-  add_filter "/spec/"
+  add_filter '/spec/'
   add_filter '/config/'
   add_filter do |source_file|
     source_file.lines.count < 5
   end
-  add_group "generators", "/generators"
-  add_group "lib", "/lib"
-end
-
-Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each{ |f| require f }
-
-RSpec.configure do |config|
-  config.include GeneratorHelper
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-  config.mock_with :rspec do |c|
-    c.syntax = :expect
-  end
-  config.around(:each) do |ex|
-    $stdout = StringIO.new
-    $stderr = StringIO.new
-    ex.run
-    $stdout = STDOUT
-    $stderr = STDERR
-  end
+  add_group 'generators', '/generators'
+  add_group 'lib', '/lib'
 end
 
 def project_path
@@ -56,3 +45,17 @@ end
 def log_path
   File.join(project_path, 'spec/log')
 end
+
+Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each{ |f| require f }
+
+RSpec.configure do |config|
+  config.include GeneratorHelper
+  config.disable_monkey_patching = true
+  config.around(:each) do |ex|
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+    ex.run
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end