howitzer 1.0.1 → 1.0.2

data/lib/howitzer/utils/locator_store.rb

@@ -1,3 +1,5 @@
+require 'howitzer/exceptions'
+
 #The following are locator aliases:
 #
 #1) locator
@@ -18,8 +20,6 @@
 
 
 module LocatorStore
-  BadLocatorParamsError = Class.new(StandardError)
-  LocatorNotDefinedError = Class.new(StandardError)
 
   def self.included(base)
     base.extend(ClassMethods)
@@ -27,8 +27,6 @@ module LocatorStore
 
   module ClassMethods
     LOCATOR_TYPES = [:base, :link, :field, :button]
-    class BadLocatorParamsError < StandardError; end
-    class LocatorNotSpecifiedError < StandardError; end
 
     ##
     #
@@ -157,6 +155,15 @@ module LocatorStore
       end
     end
 
+    def first_element(name)
+      type, locator = find_locator(name)
+      if type == :base
+        send :first, locator
+      else
+        send :first, type, locator
+      end
+    end
+
     protected
 
     def find_locator(name)
@@ -164,7 +171,7 @@ module LocatorStore
       LOCATOR_TYPES.each do|type|
         return [type, locator_by_type(type, name)] if (@locators || {}).fetch(self.name, {}).fetch(type, {})[name]
       end
-      raise(LocatorNotDefinedError, name)
+      log.error(Howitzer::LocatorNotDefinedError, name)
     end
 
     # looks up locator in current and all super classes
@@ -180,7 +187,7 @@ module LocatorStore
 
     def locator_by_type(type, name)
       locator = parent_locator(type, name)
-      raise(LocatorNotDefinedError, name) if locator.nil?
+      log.error(Howitzer::LocatorNotDefinedError, name) if locator.nil?
       locator
     end
 
@@ -188,7 +195,7 @@ module LocatorStore
       @locators ||= {}
       @locators[self.name] ||= {}
       @locators[self.name][type] ||= {}
-      raise BadLocatorParamsError, args.inspect if params.nil? || (!params.is_a?(Proc) && params.empty?)
+      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]

data/lib/howitzer/utils/log.rb

@@ -45,7 +45,9 @@ module Howitzer
            exception = args.first.new(args[1])
            exception.set_backtrace(args.last)
            exception
+          #:nocov:
           else nil
+          #:nocov:
         end
       end
       err_backtrace = object.backtrace ? "\n\t#{object.backtrace.join("\n\t")}" : nil

data/lib/howitzer/utils/page_validator.rb

@@ -1,11 +1,14 @@
+require 'howitzer/exceptions'
+
 module Howitzer
   module Utils
     module PageValidator
-      WrongOptionError = Class.new(StandardError)
-      NoValidationError = Class.new(StandardError)
-      UnknownValidationName = Class.new(StandardError)
       @validations = {}
 
+      def self.included(base)  #:nodoc:
+        base.extend(ClassMethods)
+      end
+
       ##
       #
       # Returns validation list
@@ -16,20 +19,40 @@ module Howitzer
         @validations
       end
 
-      def self.included(base)  #:nodoc:
-        base.extend(ClassMethods)
+      ##
+      #
+      # Returns page list
+      #
+      # @return [Array]
+      #
+      def self.pages
+        @pages ||= []
       end
 
       ##
+      # Check if any validations are defined, if no, tries to find old style, else raise error
       #
-      # Checks that correct page has been loaded
-      #
-      # @raise  [Howitzer::Utils::PageValidator::NoValidationError]   If no validation was specified
+      # @raise  [Howitzer::NoValidationError] If no one validation is defined for page
       #
-      def check_correct_page_loaded
-        validations = PageValidator.validations[self.class.name]
-        raise NoValidationError, "No any page validation was found" if validations.nil?
-        validations.each {|(_, validation)| validation.call(self)}
+
+      def check_validations_are_defined!
+        if validations.nil? && !old_url_validation_present?
+          log.error Howitzer::NoValidationError, "No any page validation was found for '#{self.class.name}' page"
+        end
+      end
+
+      private
+
+      def validations
+        PageValidator.validations[self.class.name]
+      end
+
+      def old_url_validation_present?
+        if self.class.const_defined?("URL_PATTERN")
+          self.class.validates :url, pattern: self.class.const_get("URL_PATTERN")
+          warn "[Deprecated] Old style page validation is using. Please use new style:\n\t validates :url, pattern: URL_PATTERN"
+          true
+        end
       end
 
       module ClassMethods
@@ -42,41 +65,65 @@ module Howitzer
         # @option options [Hash]                                            Validation options
         #    :pattern => [Regexp]                                             For :url and :title validation types
         #    :locator => [String]                                             For :element_presence (Existing locator name)
-        # @raise  [Howitzer::Utils::PageValidator::UnknownValidationName]   If unknown validation type was passed
+        # @raise  [Howitzer::UnknownValidationError]   If unknown validation type was passed
         #
         def validates(name, options)
-          raise TypeError, "Expected options to be Hash, actual is '#{options.class}'" unless options.class == Hash
+          log.error TypeError, "Expected options to be Hash, actual is '#{options.class}'" unless options.class == Hash
           PageValidator.validations[self.name] ||= {}
           case name.to_sym
             when :url
-              validate_url options
+              validate_by_pattern(:url, options)
             when :element_presence
               validate_element options
             when :title
-              validate_title options
+              validate_by_pattern(:title, options)
             else
-              raise UnknownValidationName, "unknown '#{name}' validation name"
+              log.error Howitzer::UnknownValidationError, "unknown '#{name}' validation name"
           end
         end
 
-        private
+        ##
+        # Check whether page is opened or no
+        #
+        # @raise  [Howitzer::NoValidationError] If no one validation is defined for page
+        #
+        # *Returns:*
+        # * +boolean+
+        #
 
-        def validate_url(options)
-          pattern = options[:pattern] || options["pattern"]
-          raise WrongOptionError, "Please specify ':pattern' option as Regexp object" if pattern.nil? || !pattern.is_a?(Regexp)
-          PageValidator.validations[self.name][:url] = lambda { |web_page| web_page.wait_for_url(pattern) }
+        def opened?
+          validation_list = PageValidator.validations[self.name]
+          if validation_list.blank?
+            log.error Howitzer::NoValidationError, "No any page validation was found for '#{self.name}' page"
+          else
+            !validation_list.any? {|(_, validation)| !validation.call(self)}
+          end
         end
 
+        ##
+        #
+        # Finds all matched pages which are satisfy of defined validations
+        #
+        # *Returns:*
+        # * +array+ - page names
+        #
+
+        def matched_pages
+          PageValidator.pages.select{|klass| klass.opened? }
+        end
+
+        private
+
         def validate_element(options)
           locator = options[:locator] || options["locator"]
-          raise WrongOptionError, "Please specify ':locator' option as one of page locator names" if locator.nil? || locator.empty?
-          PageValidator.validations[self.name][:element_presence] = lambda { |web_page| web_page.find_element(locator) }
+          log.error Howitzer::WrongOptionError, "Please specify ':locator' option as one of page locator names" if locator.nil? || locator.empty?
+          PageValidator.validations[self.name][:element_presence] = lambda { |web_page| web_page.first_element(locator) }
         end
 
-        def validate_title(options)
+        def validate_by_pattern(name, options)
           pattern = options[:pattern] || options["pattern"]
-          raise WrongOptionError, "Please specify ':pattern' option as Regexp object" if pattern.nil? || !pattern.is_a?(Regexp)
-          PageValidator.validations[self.name][:title] = lambda { |web_page| web_page.wait_for_title(pattern) }
+          log.error Howitzer::WrongOptionError, "Please specify ':pattern' option as Regexp object" if pattern.nil? || !pattern.is_a?(Regexp)
+          PageValidator.validations[self.name][name] = lambda { |web_page| pattern === web_page.send(name) }
         end
 
       end

data/lib/howitzer/version.rb

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

data/lib/howitzer/web_page.rb

@@ -1,22 +1,25 @@
+require "singleton"
 require "rspec/expectations"
 require "howitzer/utils/locator_store"
 require "howitzer/utils/page_validator"
-require "singleton"
+require "howitzer/capybara/dsl_ex"
+require 'howitzer/exceptions'
 
 class WebPage
 
-  BLANK_PAGE = 'about:blank'
-  IncorrectPageError = Class.new(StandardError)
+  BLANK_PAGE = 'about:blank' # @deprecated , use BlankPage instead
+  UnknownPage = Class.new
 
   include LocatorStore
   include Howitzer::Utils::PageValidator
   include RSpec::Matchers
-  include Capybara::DSL
-  extend  Capybara::DSL
+  include Howitzer::Capybara::DslEx
+  extend  Howitzer::Capybara::DslEx
   include Singleton
 
   def self.inherited(subclass)
     subclass.class_eval { include Singleton }
+    Howitzer::Utils::PageValidator.pages << subclass
   end
 
   ##
@@ -30,7 +33,7 @@ class WebPage
   # * +WebPage+ - New instance of current class
   #
 
-  def self.open(url="#{app_url}#{self::URL}")
+  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?
@@ -48,7 +51,72 @@ class WebPage
   #
 
   def self.given
-    self.instance.tap{ |page| page.check_correct_page_loaded }
+    wait_for_opened
+    self.instance
+  end
+
+  ##
+  #
+  # Returns current url
+  #
+  # *Returns:*
+  # * +string+ - Current url
+  #
+
+  def self.url
+    self.current_url
+  end
+
+  ##
+  #
+  # Returns body text of html page
+  #
+  # *Returns:*
+  # * +string+ - Body text
+  #
+
+  def self.text
+    page.find('body').text
+  end
+
+  ##
+  #
+  # Tries to identify current page name or raise error if ambiguous page matching
+  #
+  # *Returns:*
+  # * +string+ - page name
+  #
+
+  def self.current_page
+    page_list = matched_pages
+    if page_list.count.zero?
+      UnknownPage
+    elsif page_list.count > 1
+      log.error Howitzer::AmbiguousPageMatchingError,
+                "Current page matches more that one page class (#{page_list.join(', ')}).\n\tCurrent url: #{current_url}\n\tCurrent title: #{title}"
+    elsif page_list.count == 1
+      page_list.first
+    end
+  end
+
+  ##
+  #
+  # Waits until web page is not opened, or raise error after timeout
+  #
+  # *Parameters:*
+  # * +time_out+ - Seconds that will be waiting for web page to be loaded
+  #
+
+  def self.wait_for_opened(timeout=settings.timeout_small)
+    end_time = ::Time.now + timeout
+    until ::Time.now > end_time
+      self.opened? ? return : sleep(0.5)
+    end
+    log.error Howitzer::IncorrectPageError, "Current page: #{self.current_page}, expected: #{self}.\n\tCurrent url: #{current_url}\n\tCurrent title: #{title}"
+  end
+
+  def initialize
+    check_validations_are_defined!
   end
 
   ##
@@ -109,6 +177,7 @@ class WebPage
 
   # @deprecated
   # With Capybara 2.x it is extra
+  #:nocov:
   def wait_for_ajax(timeout=settings.timeout_small, message=nil)
     end_time = ::Time.now + timeout
     until ::Time.now > end_time
@@ -117,8 +186,10 @@ class WebPage
     end
     log.error message || "Timed out waiting for ajax requests to complete"
   end
+  #:nocov:
 
   ##
+  # @deprecated
   #
   # Waits until web page is loaded
   #
@@ -128,15 +199,17 @@ 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"
     end_time = ::Time.now + timeout
     until ::Time.now > end_time
       operator = expected_url.is_a?(Regexp) ? :=~ : :==
       return true if current_url.send(operator, expected_url).tap{|res| sleep 1 unless res}
     end
-    log.error IncorrectPageError, "Current url: #{current_url}, expected:  #{expected_url}"
+    log.error Howitzer::IncorrectPageError, "Current url: #{current_url}, expected:  #{expected_url}"
   end
 
   ##
+  # @deprecated
   #
   # Waits until web is loaded with expected title
   #
@@ -146,12 +219,13 @@ 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"
     end_time = ::Time.now + timeout
     until ::Time.now > end_time
       operator = expected_title.is_a?(Regexp) ? :=~ : :==
       return true if title.send(operator, expected_title).tap{|res| sleep 1 unless res}
     end
-    log.error IncorrectPageError, "Current title: #{title}, expected:  #{expected_title}"
+    log.error Howitzer::IncorrectPageError, "Current title: #{title}, expected:  #{expected_title}"
   end
 
   ##
@@ -164,18 +238,6 @@ class WebPage
     visit current_url
   end
 
-  ##
-  #
-  # Returns current url
-  #
-  # *Returns:*
-  # * +string+ - Current url
-  #
-
-  def self.current_url
-    page.current_url
-  end
-
   ##
   #
   # Returns Page title
@@ -188,15 +250,4 @@ class WebPage
     page.title
   end
 
-  ##
-  #
-  # Returns body text of html page
-  #
-  # *Returns:*
-  # * +string+ - Body text
-  #
-
-  def self.text
-    page.find('body').text
-  end
 end

data/spec/config/default.yml

@@ -12,17 +12,15 @@ hide_datetime_from_log: true
 driver: selenium
 
 ###########################################################
-# MAIL SETTINGS                                           #
+# MAILGUN SETTINGS                                        #
 ###########################################################
-mail_smtp_server: smtp.demo.com
-mail_smtp_port: 25
-mail_smtp_domain: demo.com
-mail_smtp_user_name: test_user
-mail_smtp_user_pass: mypass
+mailgun_key: mailgun_account_private_key
+mailgun_domain: mailgun@test.domain
 
-mail_pop3_server: pop.demo.com
-mail_pop3_port: 995
-mail_pop3_timeout: 120
-mail_pop3_domain: ${mail_smtp_domain}
-mail_pop3_user_name: test_user
-mail_pop3_user_pass: mypass
+############################################################
+# TIMEOUTS                                                 #
+############################################################
+timeout_tiny: 1
+timeout_short: 2
+timeout_small: 5
+timeout_medium: 15