howitzer 1.1.1 → 2.0.0

data/lib/howitzer/utils/log.rb

@@ -1,139 +0,0 @@
-require 'log4r'
-require 'fileutils'
-
-module Howitzer
-  class Log
-    include Singleton
-    include Log4r
-
-    [:debug, :info, :warn, :fatal].each do |method_name|
-      define_method method_name do |text|
-        @logger.send(method_name, text)
-      end
-    end
-
-    ##
-    #
-    # Prints log entry about error with ERROR severity
-    # *Examples:*
-    #  log.error MyException, 'Some error text', caller
-    #  log.error 'Some error text', caller
-    #  log.error MyException, 'Some caller text'
-    #  log.error 'Some error text'
-    #  log.error err_object
-    #
-    # *Parameters:*
-    # * +args+ - see example
-    #
-
-    def error(*args)
-      object = if args.first.nil?
-        $!
-      else
-        case args.size
-          when 1
-           args.first.is_a?(Exception) ? args.first : RuntimeError.new(args.first)
-          when 2
-            if args.first.is_a?(Class) && args.first < Exception
-              args.first.new(args.last)
-            else
-              exception = RuntimeError.new(args.first)
-              exception.set_backtrace(args.last)
-              exception
-            end
-          when 3
-           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
-      @logger.error("[#{object.class}] #{object.message}#{err_backtrace}")
-      fail(object)
-    end
-
-    ##
-    #
-    # Prints feature name into log with INFO severity
-    #
-    # *Parameters:*
-    # * +text+ - Feature name
-    #
-
-    def print_feature_name(text)
-      log_without_formatting{ info "*** Feature: #{text.upcase} ***" }
-    end
-
-    ##
-    #
-    # Returns formatted howitzer settings
-    #
-
-    def settings_as_formatted_text
-      log_without_formatting{ info settings.as_formatted_text }
-    end
-
-    ##
-    #
-    # Prints scenario name into log with INFO severity
-    #
-    # *Parameters:*
-    # * +text+ - Scenario name
-    #
-    def print_scenario_name(text)
-      log_without_formatting{ info " => Scenario: #{text}" }
-    end
-
-    private
-
-    def initialize
-      @logger = Logger.new("ruby_log")
-      @logger.add(console_log)
-      @logger.add(error_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
-    end
-
-    def log_without_formatting
-      self.base_formatter = blank_formatter
-      yield
-      self.base_formatter = default_formatter
-    end
-
-    def console_log
-      StdoutOutputter.new(:console).tap{|o| o.only_at(INFO, DEBUG, WARN)}
-    end
-
-    def error_log
-      StderrOutputter.new(:error, 'level' => ERROR)
-    end
-
-    def txt_log
-      FileUtils.mkdir_p(settings.log_dir) unless File.exists?(settings.log_dir)
-      filename = File.join(settings.log_dir, settings.txt_log)
-      FileOutputter.new(:txt_log, :filename => filename, :trunc => true)
-    end
-
-    def blank_formatter
-      PatternFormatter.new(:pattern => "%m")
-    end
-
-    def default_formatter
-      if settings.hide_datetime_from_log
-        params = {pattern: "[%l] %m"}
-      else
-        params = {pattern: "%d [%l] :: %m", date_pattern: "%Y/%m/%d %H:%M:%S"}
-      end
-      PatternFormatter.new(params)
-    end
-
-    def base_formatter=(formatter)
-      @logger.outputters.each {|outputter| outputter.formatter = formatter}
-    end
-  end
-end

data/lib/howitzer/utils/page_validator.rb

@@ -1,133 +0,0 @@
-require 'howitzer/exceptions'
-
-module Howitzer
-  module Utils
-    module PageValidator
-      @validations = {}
-
-      def self.included(base)  #:nodoc:
-        base.extend(ClassMethods)
-      end
-
-      ##
-      #
-      # Returns validation list
-      #
-      # @return [Hash]
-      #
-      def self.validations
-        @validations
-      end
-
-      ##
-      #
-      # 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
-      #
-      # @raise  [Howitzer::NoValidationError] If no one validation is defined for page
-      #
-
-      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
-
-        ##
-        #
-        # Adds validation to validation list
-        #
-        # @param [Symbol or String] name                                    Which validation type. Possible values [:url, :element_presence, :title]
-        # @option options [Hash]                                            Validation options
-        #    :pattern => [Regexp]                                             For :url and :title validation types
-        #    :locator => [String]                                             For :element_presence (Existing locator name)
-        # @raise  [Howitzer::UnknownValidationError]   If unknown validation type was passed
-        #
-        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_s.to_sym
-            when :url
-              validate_by_pattern(:url, options)
-            when :element_presence
-              validate_element options
-            when :title
-              validate_by_pattern(:title, options)
-            else
-              log.error Howitzer::UnknownValidationError, "unknown '#{name}' validation name"
-          end
-        end
-
-        ##
-        # Check whether page is opened or no
-        #
-        # @raise  [Howitzer::NoValidationError] If no one validation is defined for page
-        #
-        # *Returns:*
-        # * +boolean+
-        #
-
-        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"]
-          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_by_pattern(name, options)
-          pattern = options[:pattern] || options["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
-    end
-
-  end
-end

data/lib/howitzer/web_page.rb

@@ -1,253 +0,0 @@
-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
-
-  BLANK_PAGE = 'about:blank' # @deprecated , use BlankPage instead
-  UnknownPage = Class.new
-
-  include LocatorStore
-  include Howitzer::Utils::PageValidator
-  include RSpec::Matchers
-  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
-
-  ##
-  #
-  # Opens web-site by given url
-  #
-  # *Parameters:*
-  # * +url+ - Url string that will be opened
-  #
-  # *Returns:*
-  # * +WebPage+ - New instance of current class
-  #
-
-  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?
-      visit url
-    end
-    given
-  end
-
-  ##
-  #
-  # Returns singleton instance of current web page
-  #
-  # *Returns:*
-  # * +WebPage+ - Singleton instance
-  #
-
-  def self.given
-    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!
-    page.driver.browser.manage.window.maximize if settings.maximized_window
-  end
-
-  ##
-  #
-  # Fills in field that using Tinymce API
-  #
-  # *Parameters:*
-  # * +name+ - Frame name that contains Tinymce field
-  # * +Hash+ - Not required options
-  #
-
-  def tinymce_fill_in(name, options = {})
-    if %w[selenium selenium_dev sauce].include? settings.driver
-      page.driver.browser.switch_to.frame("#{name}_ifr")
-      page.find(:css, '#tinymce').native.send_keys(options[:with])
-      page.driver.browser.switch_to.default_content
-    else
-      page.execute_script("tinyMCE.get('#{name}').setContent('#{options[:with]}')")
-    end
-  end
-
-  ##
-  #
-  # Accepts or declines JS alert box by given flag
-  #
-  # *Parameters:*
-  # * +flag+ [TrueClass,FalseClass] - Determines accept or decline alert box
-  #
-
-   def click_alert_box(flag)
-    if %w[selenium selenium_dev sauce].include? settings.driver
-      if flag
-        page.driver.browser.switch_to.alert.accept
-      else
-        page.driver.browser.switch_to.alert.dismiss
-      end
-    else
-      if flag
-        page.evaluate_script('window.confirm = function() { return true; }')
-      else
-        page.evaluate_script('window.confirm = function() { return false; }')
-      end
-    end
-  end
-
-  ##
-  #
-  # Clicks on button or link using JS event call
-  #
-  # *Parameters:*
-  # * +css_locator+ - Css locator of link or button
-  #
-
-  def js_click(css_locator)
-    page.execute_script("$('#{css_locator}').trigger('click')")
-    sleep settings.timeout_tiny
-  end
-
-  # @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
-      return true if page.evaluate_script('$.active') == 0
-      sleep 0.25
-    end
-    log.error message || 'Timed out waiting for ajax requests to complete'
-  end
-  #:nocov:
-
-  ##
-  # @deprecated
-  #
-  # Waits until web page is loaded
-  #
-  # *Parameters:*
-  # * +expected_url+ - Url that will be waiting for
-  # * +time_out+ - Seconds that will be waiting for web-site to be loaded until raise error
-  #
-
-  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 Howitzer::IncorrectPageError, "Current url: #{current_url}, expected:  #{expected_url}"
-  end
-
-  ##
-  # @deprecated
-  #
-  # Waits until web is loaded with expected title
-  #
-  # *Parameters:*
-  # * +expected_title+ - Page title that will be waited for
-  # * +time_out+ - Seconds that will be waiting for web-site to be loaded until raise error
-  #
-
-  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 Howitzer::IncorrectPageError, "Current title: #{title}, expected:  #{expected_title}"
-  end
-
-  ##
-  #
-  # Reloads current page
-  #
-
-  def reload
-    log.info "Reload '#{current_url}'"
-    visit current_url
-  end
-
-  ##
-  #
-  # Returns Page title
-  #
-  # *Returns:*
-  # * +string+ - Page title
-  #
-
-  def title
-    page.title
-  end
-end