howitzer 2.1.1 → 2.2.0

data/lib/howitzer/mailgun_api/connector.rb

@@ -23,6 +23,7 @@ module Howitzer
       def client(api_key = Howitzer.mailgun_key)
         check_api_key(api_key)
         return @client if @api_key == api_key && @api_key
+
         @api_key = api_key
         @client = Client.new(api_key: @api_key)
       end

data/lib/howitzer/meta.rb

@@ -0,0 +1,11 @@
+module Howitzer
+  # This module holds meta-information about elements on the page
+  module Meta
+  end
+end
+
+require 'howitzer/meta/actions'
+require 'howitzer/meta/element'
+require 'howitzer/meta/section'
+require 'howitzer/meta/iframe'
+require 'howitzer/meta/entry'

data/lib/howitzer/meta/actions.rb

@@ -0,0 +1,38 @@
+module Howitzer
+  module Meta
+    # Module with utility actions for elements
+    module Actions
+      # Highlights element with red border on the page
+      # @param args [Array] arguments for elements described with lambda locators and
+      # inline options for element/s as a hash
+      def highlight(*args)
+        if xpath(*args).blank?
+          Howitzer::Log.debug("Element #{name} not found on the page")
+          return
+        end
+        context.execute_script("document.evaluate('#{escape(xpath(*args))}', document, null, " \
+                          'XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue.style.border = "thick solid red"')
+      end
+
+      # Returns xpath for the element
+      # @param args [Array] arguments for elements described with lambda locators and
+      # inline options for element/s as a hash
+      # @return [String, nil]
+      def xpath(*args)
+        capybara_element(*args).try(:path)
+      end
+
+      private
+
+      def escape(xpath)
+        xpath.gsub(/(['"])/, '\\\\\\1')
+      end
+
+      def convert_args(args)
+        new_args = []
+        params = args.reject { |v| new_args << v if v.is_a?(Hash) }
+        [params, new_args.reduce(:merge)].flatten
+      end
+    end
+  end
+end

data/lib/howitzer/meta/element.rb

@@ -0,0 +1,38 @@
+module Howitzer
+  module Meta
+    # This class represents element entity within howitzer meta information interface
+    class Element
+      attr_reader :name, :context
+
+      include Howitzer::Meta::Actions
+      # Creates new meta element with meta information and utility actions
+      # @param name [String] name of the element
+      # @param context [Howitzer::Web::Page] page element belongs to
+      def initialize(name, context)
+        @name = name
+        @context = context
+      end
+
+      # Finds all instances of element on the page and returns them as array of capybara elements
+      # @param args [Array] arguments for elements described with lambda locators and
+      # inline options for element/s as a hash
+      # @return [Array]
+      def capybara_elements(*args)
+        context.send("#{name}_elements", *args)
+      end
+
+      # Finds element on the page and returns as a capybara element
+      # @param args [Array] arguments for elements described with lambda locators and
+      # inline options for element/s as a hash
+      # @param wait [Integer] wait time for element search
+      # @return [Capybara::Node::Element, nil]
+      def capybara_element(*args, wait: 0)
+        args << { match: :first, wait: wait }
+        args = convert_args(args)
+        context.send("#{name}_element", *args)
+      rescue Capybara::ElementNotFound
+        nil
+      end
+    end
+  end
+end

data/lib/howitzer/meta/entry.rb

@@ -0,0 +1,62 @@
+module Howitzer
+  module Meta
+    # This class provides access to meta information entities
+    class Entry
+      attr_reader :context
+
+      # Creates new meta entry instance for the page which provides access to elements, iframes and sections
+      # @param context [Howitzer::Web::Page] page for which entry is created
+      def initialize(context)
+        @context = context
+      end
+
+      # Returns array of elements
+      # @return [Array]
+      def elements
+        @elements ||= context
+                      .private_methods
+                      .grep(/\A(?!wait_)\w+_element\z/)
+                      .map { |el| Meta::Element.new(el.to_s.gsub('_element', ''), context) }
+      end
+
+      # Finds element by name
+      # @param name [String, Symbol] element name
+      # @return [Meta::Element]
+      def element(name)
+        elements.find { |el| el.name == name.to_s }
+      end
+
+      # Returns array of sections
+      # @return [Array]
+      def sections
+        @sections ||= context
+                      .public_methods
+                      .grep(/\A(?!wait_)\w+_section$\z/)
+                      .map { |el| Meta::Section.new(el.to_s.gsub('_section', ''), context) }
+      end
+
+      # Finds section by name
+      # @param name [String, Symbol] section name
+      # @return [Meta::Section]
+      def section(name)
+        sections.find { |el| el.name == name.to_s }
+      end
+
+      # Returns array of iframes
+      # @return [Array]
+      def iframes
+        @iframes ||= context
+                     .public_methods
+                     .grep(/\A(?!wait_)\w+_iframe$\z/)
+                     .map { |el| Meta::Iframe.new(el.to_s.gsub('_iframe', ''), context) }
+      end
+
+      # Finds iframe by name
+      # @param name [String, Symbol] iframe name
+      # @return [Meta::Iframe]
+      def iframe(name)
+        iframes.find { |el| el.name == name.to_s }
+      end
+    end
+  end
+end

data/lib/howitzer/meta/iframe.rb

@@ -0,0 +1,41 @@
+module Howitzer
+  module Meta
+    # This class represents iframe entity within howitzer meta information interface
+    class Iframe
+      attr_reader :name, :context
+
+      include Howitzer::Meta::Actions
+
+      # Creates new meta iframe element with meta information and utility actions
+      # @param name [String] name of the iframe
+      # @param context [Howitzer::Web::Page] page which has this iframe
+      def initialize(name, context)
+        @name = name
+        @context = context
+      end
+
+      # Finds all instances of iframe on the page and returns them as array of capybara elements
+      # @return [Array]
+      def capybara_elements
+        context.capybara_context.all("iframe[src='#{site_value}']")
+      end
+
+      # Finds iframe on the page and returns as a capybara element
+      # @param wait [Integer] wait time for element search
+      # @return [Capybara::Node::Element, nil]
+      def capybara_element(wait: 0)
+        context.capybara_context.find("iframe[src='#{site_value}']", match: :first, wait: wait)
+      rescue Capybara::ElementNotFound
+        nil
+      end
+
+      # Returns url value for iframe
+      # @return [String]
+      def site_value
+        return @site_value if @site_value.present?
+
+        context.send("#{name}_iframe") { |frame| @site_value = frame.class.send(:site_value) }
+      end
+    end
+  end
+end

data/lib/howitzer/meta/section.rb

@@ -0,0 +1,30 @@
+module Howitzer
+  module Meta
+    # This class represents section entity within howitzer meta information interface
+    class Section
+      attr_reader :name, :context
+
+      include Howitzer::Meta::Actions
+      # Creates meta section element with meta information and utility actions
+      # @param name [String] name of the section
+      # @param context [Howitzer::Web::Page] page which has this section
+      def initialize(name, context)
+        @name = name
+        @context = context
+      end
+
+      # Finds all instances of section on the page and returns them as array of capybara elements
+      # @return [Array]
+      def capybara_elements
+        context.send("#{name}_sections").map(&:capybara_context)
+      end
+
+      # Finds section on the page and returns as a capybara element
+      # @return [Capybara::Node::Element, nil]
+      def capybara_element
+        section = context.send("#{name}_sections").first
+        section.try(:capybara_context)
+      end
+    end
+  end
+end

data/lib/howitzer/version.rb

@@ -1,4 +1,4 @@
 # This module holds howitzer version
 module Howitzer
-  VERSION = '2.1.1'.freeze #:nodoc:
+  VERSION = '2.2.0'.freeze #:nodoc:
 end

data/lib/howitzer/web/capybara_context_holder.rb

@@ -12,6 +12,7 @@ module Howitzer
 
       def capybara_scopes
         return super if defined?(super)
+
         raise NotImplementedError, "Please define 'capybara_scopes' method for class holder"
       end
     end

data/lib/howitzer/web/capybara_methods_proxy.rb

@@ -9,6 +9,7 @@ class Capybara::Selenium::Driver # rubocop:disable Style/ClassAndModuleChildren
   # https://github.com/teamcapybara/capybara/issues/1845
   def title
     return browser.title unless within_frame?
+
     find_xpath('/html/head/title').map { |n| n[:text] }.first.to_s
   end
 
@@ -16,6 +17,7 @@ class Capybara::Selenium::Driver # rubocop:disable Style/ClassAndModuleChildren
   # https://github.com/seleniumhq/selenium/issues/1727
   def current_url
     return browser.current_url unless within_frame?
+
     execute_script('return document.location.href')
   end
 
@@ -57,7 +59,8 @@ module Howitzer
       private
 
       def capybara_scopes
-        @_scopes ||= [Capybara.current_session]
+        @capybara_scopes ||= Hash.new { |hash, key| hash[key] = [Capybara.current_session] }
+        @capybara_scopes[Howitzer.session_name]
       end
     end
   end

data/lib/howitzer/web/element_dsl.rb

@@ -15,6 +15,7 @@ module Howitzer
         args, params, options = merge_element_options(args, params)
         args = args.map do |el|
           next(el) unless el.is_a?(Proc)
+
           el.call(*params.shift(el.arity))
         end
         args << options unless options.blank?

data/lib/howitzer/web/iframe_dsl.rb

@@ -84,8 +84,10 @@ module Howitzer
 
         def iframe(name, *args)
           raise ArgumentError, 'iframe selector arguments must be specified' if args.blank?
+
           klass = args.first.is_a?(Class) ? args.shift : find_matching_class(name)
           raise NameError, "class can not be found for #{name} iframe" if klass.blank?
+
           define_iframe(klass, name, args)
           define_has_iframe(name, args)
           define_has_no_iframe(name, args)

data/lib/howitzer/web/page.rb

@@ -1,6 +1,7 @@
 require 'singleton'
 require 'rspec/expectations'
 require 'addressable/template'
+require 'howitzer/meta'
 require 'howitzer/web/capybara_methods_proxy'
 require 'howitzer/web/page_validator'
 require 'howitzer/web/element_dsl'
@@ -65,6 +66,7 @@ module Howitzer
         page_list = matched_pages
         return UnknownPage if page_list.count.zero?
         return page_list.first if page_list.count == 1
+
         raise Howitzer::AmbiguousPageMatchingError, ambiguous_page_msg(page_list)
       end
 
@@ -77,6 +79,7 @@ module Howitzer
         end_time = ::Time.now + timeout
         until ::Time.now > end_time
           return true if opened?
+
           sleep(0.5)
         end
         raise Howitzer::IncorrectPageError, incorrect_page_msg
@@ -98,9 +101,16 @@ module Howitzer
         if defined?(path_value)
           return "#{site_value}#{Addressable::Template.new(path_value).expand(params, url_processor)}"
         end
+
         raise Howitzer::NoPathForPageError, "Please specify path for '#{self}' page. Example: path '/home'"
       end
 
+      # Provides access to meta information about entities on the page
+      # @return [Meta::Entry]
+      def meta
+        @meta ||= Meta::Entry.new(self)
+      end
+
       class << self
         protected
 

data/lib/howitzer/web/page_dsl.rb

@@ -32,6 +32,7 @@ module Howitzer
         def method_missing(name, *args, &block)
           return super if name =~ /\A(?:be|have)_/
           return eval_in_out_context(*args, &block) if name == :out
+
           page_klass.given.send(name, *args, &block)
         end
 
@@ -46,8 +47,10 @@ module Howitzer
 
         def eval_in_out_context(*args, &block)
           return nil if args.size.zero?
+
           name = args.shift
           return get_outer_instance_variable(name) if name.to_s.start_with?('@')
+
           outer_context.send(name, *args, &block)
         end
 

data/lib/howitzer/web/page_validator.rb

@@ -21,6 +21,7 @@ module Howitzer
 
       def check_validations_are_defined!
         return if self.class.validations.present?
+
         raise Howitzer::NoValidationError, "No any page validation was found for '#{self.class.name}' page"
       end
 
@@ -60,6 +61,7 @@ module Howitzer
 
         def opened?(sync: true)
           return validations.all? { |(_, validation)| validation.call(self, sync) } if validations.present?
+
           raise Howitzer::NoValidationError, "No any page validation was found for '#{name}' page"
         end
 

data/lib/howitzer/web/section.rb

@@ -1,9 +1,16 @@
 require 'howitzer/web/base_section'
+require 'howitzer/meta'
 
 module Howitzer
   module Web
     # This class uses for named sections which possible to reuse in different pages
     class Section < BaseSection
+      # Provides access to meta information about entities in section
+      # @return [Meta::Entry]
+      def meta
+        @meta ||= Meta::Entry.new(self)
+      end
+
       class << self
         protected
 
@@ -19,6 +26,7 @@ module Howitzer
 
         def me(*args)
           raise ArgumentError, 'Finder arguments are missing' if args.blank?
+
           @default_finder_args = args
         end
       end

data/lib/howitzer/web/section_dsl.rb

@@ -50,6 +50,7 @@ module Howitzer
           def finder_args
             @finder_args ||= begin
               return @args if @args.present?
+
               section_class.default_finder_args || raise(ArgumentError, 'Missing finder arguments')
             end
           end

data/spec/support/shared_examples/capybara_context_holder.rb

@@ -13,7 +13,7 @@ RSpec.shared_examples :capybara_context_holder do
       before do
         web_page_class.class_eval do
           def capybara_scopes
-            @_scopes ||= [true]
+            @capybara_scopes ||= [true]
           end
         end
       end

data/spec/support/shared_examples/meta_highlight_xpath.rb

@@ -0,0 +1,41 @@
+RSpec.shared_examples :meta_highlight_xpath do
+  let(:element) { described_class.new(name, context) }
+  describe '#xpath' do
+    let(:capybara_element) { double }
+    context 'when element is found' do
+      before { allow(element).to receive(:capybara_element) { capybara_element } }
+      it do
+        expect(capybara_element).to receive(:path)
+        element.xpath
+      end
+    end
+    context 'when element is blank' do
+      before { allow(element).to receive(:capybara_element) {} }
+      it do
+        expect(capybara_element).not_to receive(:path)
+        element.xpath
+      end
+    end
+  end
+
+  describe '#highlight' do
+    context 'when xpath blank' do
+      before { allow(element).to receive(:xpath) { nil } }
+      it do
+        expect(Howitzer::Log).to receive(:debug).with("Element #{name} not found on the page")
+        expect(context).not_to receive(:execute_script)
+        element.highlight
+      end
+    end
+    context 'when xpath is present' do
+      before { allow(element).to receive(:xpath) { '//a' } }
+      it do
+        expect(context).to receive(:execute_script).with(
+          "document.evaluate('//a', document, null, XPathResult.FIRST_ORDERED_NODE_TYPE,"\
+                             ' null).singleNodeValue.style.border = "thick solid red"'
+        )
+        element.highlight
+      end
+    end
+  end
+end