howitzer 2.0.3 → 2.3.0

data/lib/howitzer/web/section_dsl.rb

@@ -5,7 +5,7 @@ module Howitzer
     module SectionDsl
       include CapybaraContextHolder
 
-      def self.included(base) #:nodoc:
+      def self.included(base) # :nodoc:
         base.extend(ClassMethods)
       end
 
@@ -17,8 +17,9 @@ module Howitzer
 
           # Instantiates an anynomous or named section and executes block code in the section scope
 
-          def initialize(name, *args, &block)
+          def initialize(name, *args, **options, &block)
             @args = args
+            @options = options
             self.section_class =
               if block
                 Class.new(Howitzer::Web::BaseSection)
@@ -29,29 +30,40 @@ module Howitzer
           end
 
           # # Defines an element on the section
-          # # @see Howitzer::PageDsl::ClassMethods#element
+          # # @see Howitzer::Web::ElementDsl::ClassMethods#element
 
-          def element(*args)
-            section_class.send(:element, *args)
+          def element(*args, **options)
+            section_class.send(:element, *args, **options)
           end
 
           # Delegates a section describing to the section class
 
-          def section(name, *args, &block)
-            section_class.send(:section, name, *args, &block)
+          def section(name, *args, **options, &block)
+            section_class.send(:section, name, *args, **options, &block)
           end
 
-          # Returns a selector for the section.
+          # Returns selector arguments for the section.
           # @note If anonymous section uses, then inline selector should be specified.
           #   Otherwise arguments should be defined with `.me` dsl method in named section
           # @return [Array]
           # @raise [ArgumentError] when finder arguments were not specified
 
           def finder_args
-            @finder_args ||= begin
-              return @args if @args.present?
-              section_class.default_finder_args || raise(ArgumentError, 'Missing finder arguments')
-            end
+            return @args if @args.present?
+
+            @finder_args ||= (section_class.default_finder_args || raise(ArgumentError, 'Missing finder arguments'))
+          end
+
+          # Returns selector options for the section.
+          # @note If anonymous section uses, then inline selector should be specified.
+          #   Otherwise arguments should be defined with `.me` dsl method in named section
+          # @return [Array]
+          # @raise [ArgumentError] when finder arguments were not specified
+
+          def finder_options
+            @options if @args.present? # it is ok to have blank options, so we rely here on the argments
+
+            @finder_options ||= (section_class.default_finder_options || {})
           end
         end
 
@@ -74,6 +86,9 @@ module Howitzer
         # @param args [Array] original Capybara arguments. For details, see `Capybara::Node::Finders#all.
         #  (In most cases should be ommited for named sections because the section selector is specified
         #  with `#me` method. But must be specified for anonymous sections)
+        # @param options [Hash] original Capybara options. For details, see `Capybara::Node::Finders#all.
+        #  (In most cases should be ommited for named sections because the section selector is specified
+        #  with `#me` method. But may be specified for anonymous sections)
         # @param block [Proc] this block can contain nested sections and elements
         # @example Named section
         #   class MenuSection < Howitzer::Web::Section
@@ -109,37 +124,57 @@ module Howitzer
         #   HomePage.on { info_panel_section.edit_info(title: 'Test Title') }
         # @!visibility public
 
-        def section(name, *args, &block)
-          scope = SectionScope.new(name, *args, &block)
-          define_section_method(scope.section_class, name, scope.finder_args)
-          define_sections_method(scope.section_class, name, scope.finder_args)
-          define_has_section_method(name, scope.finder_args)
-          define_has_no_section_method(name, scope.finder_args)
+        def section(name, *args, **options, &block)
+          scope = SectionScope.new(name, *args, **options, &block)
+          define_section_method(scope.section_class, name, *scope.finder_args, **scope.finder_options)
+          define_sections_method(scope.section_class, name, *scope.finder_args, **scope.finder_options)
+          define_has_section_method(name, *scope.finder_args, **scope.finder_options)
+          define_has_no_section_method(name, *scope.finder_args, **scope.finder_options)
         end
 
         private
 
-        def define_section_method(klass, name, args)
-          define_method("#{name}_section") do
-            klass.new(self, capybara_context.find(*args))
+        def define_section_method(klass, name, *args, **options)
+          define_method("#{name}_section") do |**block_options|
+            kwdargs = options.transform_keys(&:to_sym).merge(block_options.transform_keys(&:to_sym))
+            if kwdargs.present?
+              klass.new(self, capybara_context.find(*args, **kwdargs))
+            else
+              klass.new(self, capybara_context.find(*args))
+            end
           end
         end
 
-        def define_sections_method(klass, name, args)
-          define_method("#{name}_sections") do
-            capybara_context.all(*args).map { |el| klass.new(self, el) }
+        def define_sections_method(klass, name, *args, **options)
+          define_method("#{name}_sections") do |**block_options|
+            kwdargs = options.transform_keys(&:to_sym).merge(block_options.transform_keys(&:to_sym))
+            if kwdargs.present?
+              capybara_context.all(*args, **kwdargs).map { |el| klass.new(self, el) }
+            else
+              capybara_context.all(*args).map { |el| klass.new(self, el) }
+            end
           end
         end
 
-        def define_has_section_method(name, args)
-          define_method("has_#{name}_section?") do
-            capybara_context.has_selector?(*args)
+        def define_has_section_method(name, *args, **options)
+          define_method("has_#{name}_section?") do |**block_options|
+            kwdargs = options.transform_keys(&:to_sym).merge(block_options.transform_keys(&:to_sym))
+            if kwdargs.present?
+              capybara_context.has_selector?(*args, **kwdargs)
+            else
+              capybara_context.has_selector?(*args)
+            end
           end
         end
 
-        def define_has_no_section_method(name, args)
-          define_method("has_no_#{name}_section?") do
-            capybara_context.has_no_selector?(*args)
+        def define_has_no_section_method(name, *args, **options)
+          define_method("has_no_#{name}_section?") do |**block_options|
+            kwdargs = options.transform_keys(&:to_sym).merge(block_options.transform_keys(&:to_sym))
+            if kwdargs.present?
+              capybara_context.has_no_selector?(*args, **kwdarg)
+            else
+              capybara_context.has_no_selector?(*args)
+            end
           end
         end
       end

data/lib/howitzer.rb

@@ -2,6 +2,8 @@ require 'selenium-webdriver'
 require 'capybara'
 require 'sexy_settings'
 require 'rspec/wait'
+require 'howitzer/version'
+require 'howitzer/exceptions'
 
 SexySettings.configure do |config|
   config.path_to_default_settings = File.expand_path('config/default.yml', Dir.pwd)
@@ -27,28 +29,82 @@ module Howitzer
       ::SexySettings::Base.instance.all['mailgun_idle_timeout']
     end
 
+    # @return active session name
+
+    def session_name
+      @session_name ||= 'default'
+    end
+
+    # Sets new session name
+    #
+    # @param name [String] string identifier for the session
+    #
+    # @example Executing code in another browser
+    # Howitzer.session_name = 'browser2'
+    # LoginPage.on do
+    #   expect(title).to eq('Login Page')
+    # end
+    #
+    # # Switching back to main browser
+    # Howitzer.session_name = 'default'
+
+    def session_name=(name)
+      @session_name = name
+      Capybara.session_name = @session_name
+    end
+
+    # Yield a block using a specific session name
+    #
+    # @param name [String] string identifier for the session
+    #
+    # @example Opening page in another browser
+    # Howitzer.using_session('browser2') do
+    #   LoginPage.on do
+    #     expect(title).to eq('Login Page')
+    #   end
+    # end
+
+    def using_session(name, &block)
+      Capybara.using_session(name, &block)
+    end
+
     attr_accessor :current_rake_task
   end
 
-  # @return an application uri
+  # @return an application uri for particular application name
+  #
+  # @param name [Symbol, String] an application name from framework settings
   #
-  # @example returns url with auth
+  # @example returns default application url with auth
   #  app_uri.site
-  # @example returns url without auth
+  # @example returns example application url with auth
+  #  app_uri(:example).site
+  # @example returns default application url without auth
   #  app_uri.origin
 
-  def self.app_uri
+  def self.app_uri(name = nil)
+    prefix = "#{name}_" if name.present?
     ::Addressable::URI.new(
-      user: Howitzer.app_base_auth_login,
-      password: Howitzer.app_base_auth_pass,
-      host: Howitzer.app_host,
-      scheme: Howitzer.app_protocol || 'http'
+      user: Howitzer.sexy_setting!("#{prefix}app_base_auth_login"),
+      password: Howitzer.sexy_setting!("#{prefix}app_base_auth_pass"),
+      host: Howitzer.sexy_setting!("#{prefix}app_host"),
+      scheme: Howitzer.sexy_setting!("#{prefix}app_protocol") || 'http'
     )
   end
+
+  # @return an setting value or raise error
+  #
+  # @param name [Symbol, String] an setting name
+  # @raise [Howitzer::UndefinedSexySettingError] when the setting is not specified
+
+  def self.sexy_setting!(name)
+    return Howitzer.public_send(name) if Howitzer.respond_to?(name)
+
+    raise UndefinedSexySettingError,
+          "Undefined '#{name}' setting. Please add the setting to config/default.yml:\n #{name}: some_value\n"
+  end
 end
 
-require 'howitzer/version'
-require 'howitzer/exceptions'
 require 'howitzer/log'
 require 'howitzer/utils'
 require 'howitzer/cache'

metadata

@@ -1,49 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: howitzer
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.3.0
 platform: ruby
 authors:
 - Roman Parashchenko
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2021-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
-    - - "<"
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +146,9 @@ dependencies:
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -139,6 +156,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -221,35 +241,27 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-gemset"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
-- Gemfile
 - LICENSE
-- MAINTENANCE.md
 - README.md
-- Rakefile
 - bin/howitzer
-- features/cli_help.feature
-- features/cli_new.feature
-- features/cli_unknown.feature
-- features/cli_update.feature
-- features/cli_version.feature
-- features/step_definitions/common_steps.rb
-- features/support/env.rb
-- features/support/transformers.rb
 - generators/base_generator.rb
 - generators/config/config_generator.rb
 - generators/config/templates/boot.rb
 - generators/config/templates/capybara.rb
 - generators/config/templates/custom.yml
 - generators/config/templates/default.yml
+- generators/config/templates/drivers/appium.rb
+- generators/config/templates/drivers/browserstack.rb
+- generators/config/templates/drivers/crossbrowsertesting.rb
+- generators/config/templates/drivers/headless_chrome.rb
+- generators/config/templates/drivers/headless_firefox.rb
+- generators/config/templates/drivers/sauce.rb
+- generators/config/templates/drivers/selenium.rb
+- generators/config/templates/drivers/selenium_grid.rb
+- generators/config/templates/drivers/testingbot.rb
 - generators/cucumber/cucumber_generator.rb
 - generators/cucumber/templates/common_steps.rb
 - generators/cucumber/templates/cucumber.rake
@@ -262,12 +274,10 @@ files:
 - generators/emails/templates/example_email.rb
 - generators/prerequisites/prerequisites_generator.rb
 - generators/prerequisites/templates/base.rb
-- generators/prerequisites/templates/factory_girl.rb
+- generators/prerequisites/templates/factory_bot.rb
 - generators/prerequisites/templates/user.rb
 - generators/prerequisites/templates/users.rb
 - generators/root/root_generator.rb
-- generators/root/templates/.gitignore
-- generators/root/templates/.rubocop.yml
 - generators/root/templates/Gemfile.erb
 - generators/root/templates/Rakefile
 - generators/rspec/rspec_generator.rb
@@ -276,7 +286,6 @@ files:
 - generators/rspec/templates/spec_helper.rb
 - generators/tasks/tasks_generator.rb
 - generators/tasks/templates/common.rake
-- generators/turnip/templates/.rspec
 - generators/turnip/templates/common_steps.rb
 - generators/turnip/templates/example.feature
 - generators/turnip/templates/spec_helper.rb
@@ -286,21 +295,31 @@ files:
 - generators/web/templates/example_page.rb
 - generators/web/templates/menu_section.rb
 - generators/web/web_generator.rb
-- howitzer.gemspec
 - lib/howitzer.rb
 - lib/howitzer/cache.rb
 - lib/howitzer/capybara_helpers.rb
 - lib/howitzer/email.rb
 - lib/howitzer/exceptions.rb
+- lib/howitzer/gmail_api.rb
+- lib/howitzer/gmail_api/client.rb
 - lib/howitzer/log.rb
 - lib/howitzer/mail_adapters.rb
 - lib/howitzer/mail_adapters/abstract.rb
-- lib/howitzer/mail_adapters/debugmail.rb
+- lib/howitzer/mail_adapters/gmail.rb
 - lib/howitzer/mail_adapters/mailgun.rb
+- lib/howitzer/mail_adapters/mailtrap.rb
 - lib/howitzer/mailgun_api.rb
 - lib/howitzer/mailgun_api/client.rb
 - lib/howitzer/mailgun_api/connector.rb
 - lib/howitzer/mailgun_api/response.rb
+- lib/howitzer/mailtrap_api.rb
+- lib/howitzer/mailtrap_api/client.rb
+- lib/howitzer/meta.rb
+- lib/howitzer/meta/actions.rb
+- lib/howitzer/meta/element.rb
+- lib/howitzer/meta/entry.rb
+- lib/howitzer/meta/iframe.rb
+- lib/howitzer/meta/section.rb
 - lib/howitzer/tasks/framework.rake
 - lib/howitzer/utils.rb
 - lib/howitzer/utils/string_extensions.rb
@@ -317,51 +336,15 @@ files:
 - lib/howitzer/web/page_validator.rb
 - lib/howitzer/web/section.rb
 - lib/howitzer/web/section_dsl.rb
-- spec/config/custom.yml
-- spec/spec_helper.rb
-- spec/support/generator_helper.rb
-- spec/support/logger_helper.rb
-- spec/support/mailgun_unit_client.rb
-- spec/support/shared_examples/capybara_context_holder.rb
-- spec/support/shared_examples/capybara_methods_proxy.rb
-- spec/support/shared_examples/dynamic_section_methods.rb
-- spec/support/shared_examples/element_dsl.rb
-- spec/unit/generators/base_generator_spec.rb
-- spec/unit/generators/config_generator_spec.rb
-- spec/unit/generators/cucumber_generator_spec.rb
-- spec/unit/generators/emails_generator_spec.rb
-- spec/unit/generators/prerequisites_generator_spec.rb
-- spec/unit/generators/root_generator_spec.rb
-- spec/unit/generators/rspec_generator_spec.rb
-- spec/unit/generators/tasks_generator_spec.rb
-- spec/unit/generators/turnip_generator_spec.rb
-- spec/unit/generators/web_generator_spec.rb
-- spec/unit/lib/cache_spec.rb
-- spec/unit/lib/capybara_helpers_spec.rb
-- spec/unit/lib/email_spec.rb
-- spec/unit/lib/howitzer_spec.rb
-- spec/unit/lib/init_spec.rb
-- spec/unit/lib/log_spec.rb
-- spec/unit/lib/mail_adapters/abstract_spec.rb
-- spec/unit/lib/mail_adapters/mailgun_spec.rb
-- spec/unit/lib/mailgun_api/client_spec.rb
-- spec/unit/lib/mailgun_api/connector_spec.rb
-- spec/unit/lib/mailgun_api/response_spec.rb
-- spec/unit/lib/utils/string_extensions_spec.rb
-- spec/unit/lib/web/base_section_spec.rb
-- spec/unit/lib/web/element_dsl_spec.rb
-- spec/unit/lib/web/iframe_dsl_spec.rb
-- spec/unit/lib/web/page_dsl_spec.rb
-- spec/unit/lib/web/page_spec.rb
-- spec/unit/lib/web/page_validator_spec.rb
-- spec/unit/lib/web/section_dsl_spec.rb
-- spec/unit/lib/web/section_spec.rb
-- spec/unit/version_spec.rb
-homepage: http://strongqa.github.io/howitzer/
+homepage: https://howitzer-framework.io/
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/strongqa/howitzer/issues
+  changelog_uri: https://github.com/strongqa/howitzer/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/howitzer/2.3.0
+  source_code_uri: https://github.com/strongqa/howitzer
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -369,64 +352,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: 2.6.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Ruby based framework for acceptance testing
-test_files:
-- features/cli_help.feature
-- features/cli_new.feature
-- features/cli_unknown.feature
-- features/cli_update.feature
-- features/cli_version.feature
-- features/step_definitions/common_steps.rb
-- features/support/env.rb
-- features/support/transformers.rb
-- spec/config/custom.yml
-- spec/spec_helper.rb
-- spec/support/generator_helper.rb
-- spec/support/logger_helper.rb
-- spec/support/mailgun_unit_client.rb
-- spec/support/shared_examples/capybara_context_holder.rb
-- spec/support/shared_examples/capybara_methods_proxy.rb
-- spec/support/shared_examples/dynamic_section_methods.rb
-- spec/support/shared_examples/element_dsl.rb
-- spec/unit/generators/base_generator_spec.rb
-- spec/unit/generators/config_generator_spec.rb
-- spec/unit/generators/cucumber_generator_spec.rb
-- spec/unit/generators/emails_generator_spec.rb
-- spec/unit/generators/prerequisites_generator_spec.rb
-- spec/unit/generators/root_generator_spec.rb
-- spec/unit/generators/rspec_generator_spec.rb
-- spec/unit/generators/tasks_generator_spec.rb
-- spec/unit/generators/turnip_generator_spec.rb
-- spec/unit/generators/web_generator_spec.rb
-- spec/unit/lib/cache_spec.rb
-- spec/unit/lib/capybara_helpers_spec.rb
-- spec/unit/lib/email_spec.rb
-- spec/unit/lib/howitzer_spec.rb
-- spec/unit/lib/init_spec.rb
-- spec/unit/lib/log_spec.rb
-- spec/unit/lib/mail_adapters/abstract_spec.rb
-- spec/unit/lib/mail_adapters/mailgun_spec.rb
-- spec/unit/lib/mailgun_api/client_spec.rb
-- spec/unit/lib/mailgun_api/connector_spec.rb
-- spec/unit/lib/mailgun_api/response_spec.rb
-- spec/unit/lib/utils/string_extensions_spec.rb
-- spec/unit/lib/web/base_section_spec.rb
-- spec/unit/lib/web/element_dsl_spec.rb
-- spec/unit/lib/web/iframe_dsl_spec.rb
-- spec/unit/lib/web/page_dsl_spec.rb
-- spec/unit/lib/web/page_spec.rb
-- spec/unit/lib/web/page_validator_spec.rb
-- spec/unit/lib/web/section_dsl_spec.rb
-- spec/unit/lib/web/section_spec.rb
-- spec/unit/version_spec.rb
+test_files: []

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.gitignore

@@ -1,14 +0,0 @@
-coverage
-.idea
-.rvmrc
-*.gem
-vendor/bundle/*
-spec/log/*
-Gemfile.lock
-doc
-.yardoc
-tmp/*
-.bundle
-**/.DS_Store
-.ruby-version
-.byebug_history

data/.rspec

@@ -1,3 +0,0 @@
---color
---require fuubar
---format Fuubar

data/.rubocop.yml

@@ -1,44 +0,0 @@
-# See full list of defaults here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
-# To see all cops used see here: https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
-
-AllCops:
-  TargetRubyVersion: 2.3
-  DisplayCopNames: true
-
-LineLength:
-  Max: 120
-
-Style/CaseIndentation:
-  Enabled: false
-
-Style/EmptyElse:
-  Enabled: false
-
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-
-Lint/AmbiguousBlockAssociation:
-  Enabled: false  
-
-Style/CaseEquality:
-  Enabled: false
-
-MethodLength:
-  Max: 30
-
-Style/TrivialAccessors:
-  AllowDSLWriters: true
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Max: 150
-
-Metrics/BlockLength:
-  Enabled: false
-
-Style/MixinGrouping:
-  EnforcedStyle: separated
-  Exclude:
-    - '**/*_steps.rb'

data/.ruby-gemset

@@ -1 +0,0 @@
-howitzer

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-before_install:
-  - gem install bundler
-rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1

data/Gemfile

@@ -1,13 +0,0 @@
-source 'https://rubygems.org'
-# Specify your gem's dependencies in howitzer.gemspec
-group :test do
-  gem 'coveralls', require: false
-  gem 'repeater', require: false
-  gem 'rest-client', require: false
-  gem 'simplecov', require: false
-end
-gemspec
-
-group :development do
-  gem 'rubocop'
-end