ruby_raider 0.1.9 → 0.2.0

data/lib/generators/templates/automation/component_template.rb

@@ -1,16 +0,0 @@
-require_relative '../template'
-
-class ComponentTemplate < Template
-  def body
-    <<~EOF
-          require_relative '../abstract/abstract_component'
-
-          class HeaderComponent < AbstractComponent
-
-            def customer_name
-              @component.text
-            end
-          end
-    EOF
-  end
-end

data/lib/generators/templates/automation/confirmation_page_template.rb

@@ -1,26 +0,0 @@
-require_relative '../template'
-
-class ConfirmationPageTemplate < Template
-  def body
-    <<~EOF
-      require_relative '../abstract/abstract_page'
-
-      class ConfirmationPage < AbstractPage
-
-        #Values
-
-        def login_message
-          driver.wait { message_element }.text
-        end
-
-        private
-
-        # Elements
-
-        def message_element
-          driver.find_element(accessibility_id: 'You are logged in as alice')
-        end
-      end
-    EOF
-  end
-end

data/lib/generators/templates/automation/home_page_template.rb

@@ -1,26 +0,0 @@
-require_relative '../template'
-
-class HomePageTemplate < Template
-  def body
-    <<~EOF
-      require_relative '../abstract/abstract_page'
-
-      class HomePage < AbstractPage
-
-        #Actions
-
-        def go_to_login
-          driver.wait { login_button_navigator }.click
-        end
-
-        private
-
-        # Elements
-
-        def login_button_navigator
-          driver.find_element(accessibility_id: 'Login Screen')
-        end
-      end
-    EOF
-  end
-end

data/lib/generators/templates/automation/login_page_template.rb

@@ -1,113 +0,0 @@
-require_relative '../template'
-
-class LoginPageTemplate < Template
-  def element
-    case @automation
-    when 'watir' then 'browser.element'
-    when 'selenium', 'appium_ios' then 'driver.find_element'
-    end
-  end
-
-  def helper
-    case @automation
-    when 'watir' then 'using Raider::WatirHelper'
-    when 'selenium' then 'using Raider::SeleniumHelper'
-    else nil
-    end
-  end
-
-  def require_header
-    "require_relative '../components/header_component'" if %w[selenium watir].include?(@automation)
-  end
-
-  def url
-    if %w[selenium watir].include?(@automation)
-      <<~EOF
-        def url(_page)
-            'index.php?rt=account/login' 
-          end
-      EOF
-    end
-  end
-
-  def header
-    if %w[selenium watir].include?(@automation)
-      <<~EOF
-        # Components
-
-            def header
-              HeaderComponent.new(#{element}(class: 'menu_text'))
-            end
-      EOF
-    end
-  end
-
-  def username_element
-    selector = if %w[selenium watir].include?(@automation)
-                 "(id: 'loginFrm_loginname')"
-               else
-                 "(xpath: \"//XCUIElementTypeTextField[@name=\\\"username\\\"]\")"
-               end
-    "#{element}#{selector}"
-  end
-
-  def password_element
-    selector = if %w[selenium watir].include?(@automation)
-                 "(id: 'loginFrm_password')"
-               else
-                 "(xpath: \"//XCUIElementTypeSecureTextField[@name=\\\"password\\\"]\")"
-               end
-    "#{element}#{selector}"
-  end
-
-  def button
-    if %w[selenium watir].include?(@automation)
-      "#{element}(xpath: \"//button[@title='Login']\")"
-    else
-      "driver.find_elements(xpath: \"//XCUIElementTypeOther[@name=\\\"loginBtn\\\"]\").last"
-    end
-  end
-
-  def click
-    %w[selenium watir].include?(@automation) ? 'click_when_present' : 'click'
-  end
-
-  def body
-    <<~EOF.gsub(/\n{2}\s{2}\n/, '')
-      require_relative '../abstract/abstract_page'
-      #{require_header}
-
-      class LoginPage < AbstractPage
-        #{helper}
-
-        #{url}
-
-        # Actions
-
-        def login(username, password)
-          username_field.send_keys username
-          password_field.send_keys password
-          login_button.#{click}
-        end
-
-        #{header}
-
-        private
-
-        # Elements
-
-        def username_field
-          #{username_element}
-        end
-
-        def password_field
-          #{password_element}
-        end
-
-        def login_button
-          #{button}
-        end
-      end
-    EOF
-  end
-end

data/lib/generators/templates/common/config_template.rb

@@ -1,9 +0,0 @@
-require_relative '../template'
-
-class ConfigTemplate < Template
-  def body
-    <<~EOF
-      browser: :chrome
-    EOF
-  end
-end

data/lib/generators/templates/common/gemfile_template.rb

@@ -1,52 +0,0 @@
-require_relative '../template'
-
-class GemfileTemplate < Template
-  def automation_gems
-    case @automation
-    when 'watir'
-      <<~EOF
-        gem 'selenium-webdriver'
-        gem 'watir'
-      EOF
-    when 'selenium'
-      "gem 'selenium-webdriver'"
-    else
-      <<~EOF
-        gem 'appium_lib'
-        gem 'appium_console'
-      EOF
-    end
-  end
-
-  def webdrivers
-    "gem 'webdrivers'" if %w[selenium watir].include?(@automation)
-  end
-
-  def allure_cucumber
-    "gem 'allure-cucumber'" if @framework == 'cucumber'
-  end
-
-  def rspec_gem
-    "gem 'rspec'" if @framework == 'cucumber'
-  end
-
-  def body
-    <<~EOF
-      # frozen_string_literal: true
-
-      source 'https://rubygems.org'
-
-      gem 'activesupport'
-      gem 'allure-rspec'
-      gem 'allure-ruby-commons'
-      #{allure_cucumber}
-      gem 'parallel_split_test'
-      gem 'parallel_tests'
-      gem 'rake'
-      gem '#{@framework}'
-      #{rspec_gem}
-      #{automation_gems}
-      #{webdrivers}
-    EOF
-  end
-end

data/lib/generators/templates/common/rake_file_template.rb

@@ -1,16 +0,0 @@
-require_relative '../template'
-
-class RakeFileTemplate < Template
-  def body
-    <<~EOF
-          require 'yaml'
-
-          desc 'Selects browser for automation run'
-          task :select_browser, [:browser] do |_t, args|
-            config = YAML.load_file('config/config.yml')
-            config['browser'] = args.browser
-            File.write('config/config.yml', config.to_yaml)
-          end
-    EOF
-  end
-end

data/lib/generators/templates/common/read_me_template.rb

@@ -1,104 +0,0 @@
-require_relative '../template'
-
-class ReadMeTemplate < Template
-  def body
-    <<~EOF
-          What is Raider?
-          ===========
-
-          Raider is a tool to make the setup and start of automation projects in ruby easier, with one command you are
-          ready to go
-
-          # Pre-requisites:
-
-          Install RVM:
-          https://rvm.io/rvm/install
-
-          # How to use the framework:
-
-          If you want to run all the tests from your terminal do:
-          *rspec spec/*
-
-          If you want to run all the tests in parallel do:
-          *parallel_rspec spec/*
-
-          # How are specs organized:
-
-          We use 'context' as the highest grouping level to indicate in which part of the application we are as an example:
-
-          *context 'On the login page'/*
-
-          We use 'describe' from the user perspective to describe an action that the user can or cannot take:
-
-          *describe 'A user can'/*
-
-          or
-
-          *describe 'A user cannot'/*
-
-          This saves us repetition and forces us into an structure
-
-          At last we use 'it' for the specific action the user can or cannot perform:
-
-          it 'login with right credentials'
-
-          If we group all of this together it will look like
-
-          ```ruby
-          context 'On the login page' do
-            describe 'A user can' do
-              it 'login with the right credentials' do
-              end
-          #{'   '}
-            end
-          #{'  '}
-            describe 'A user cannot' do
-              it 'login with the wrong credentials' do
-              end
-            end
-          end
-          ```
-          #{'    '}
-          This is readed as 'On the login page a user can login with the right credentials' and 'On the login page a user cannot login with the wrong credentials'
-
-          # How pages are organized:
-
-          ```ruby#{' '}
-          require_relative '../abstract/base_page'
-
-          class MainPage < BasePage
-
-            using Raider::WatirHelper
-
-            def url(_page)
-              '/'
-            end
-
-            # Actions
-
-            def change_currency(currency)
-              currency_dropdown.select currency
-            end
-
-            # Validations
-
-            def validate_currency(currency)
-              expect(currency_dropdown.include?(currency)).to be true
-            end
-
-            private
-
-            # Elements
-
-            def currency_dropdown
-              browser.select(class: %w[dropdown-menu currency])
-            end
-          end
-          ```
-
-          Pages are organized in Actions (things a user can perform on the page), Validations (assertions), and Elements.
-          Each page has to have a url define, and each page is using the module WatirHelper to add methods on runtime to the Watir elements
-
-    EOF
-  end
-end

data/lib/generators/templates/cucumber/env_template.rb

@@ -1,38 +0,0 @@
-require_relative '../template'
-
-class EnvTemplate < Template
-  def body
-
-    if @automation == 'watir'
-      helper = 'helpers/browser_helper'
-      browser = 'Raider::BrowserHelper.new_browser'
-      get_browser = 'browser = Raider::BrowserHelper.new_browser'
-      screenshot = 'browser.screenshot.save("allure-results/screenshots/#{scenario.name}.png")'
-      quit = 'browser.quit'
-    else
-      helper = 'helpers/driver_helper'
-      browser = 'Raider::DriverHelper.new_driver'
-      get_browser = 'driver = Raider::DriverHelper.driver'
-      screenshot = 'driver.save_screenshot("allure-results/screenshots/#{scenario.name}.png")'
-      quit = 'driver.quit'
-    end
-
-    <<~EOF
-      require 'active_support/all'
-      require_relative 'helpers/allure_helper'
-      require_relative '#{helper}'
-
-      Before do
-          Raider::AllureHelper.configure
-          #{browser}
-      end
-
-      After do |scenario|
-       #{get_browser}
-        #{screenshot}
-        Raider::AllureHelper.add_screenshot(scenario.name)
-        #{quit}
-      end
-    EOF
-  end
-end

data/lib/generators/templates/cucumber/example_feature_template.rb

@@ -1,15 +0,0 @@
-require_relative '../template'
-
-class ExampleFeatureTemplate < Template
-  def body
-    <<~EOF
-      Feature: Login Page
-
-      Scenario: A user can login
-        Given I'm a registered user on the login page
-        When I login with my credentials
-        Then I can see the main page
-
-    EOF
-  end
-end

data/lib/generators/templates/cucumber/example_steps_template.rb

@@ -1,21 +0,0 @@
-require_relative '../template'
-
-class ExampleStepsTemplate < Template
-  def body
-    <<~EOF
-          require_relative '../../page_objects/pages/login_page'
-
-          Given("I'm a registered user on the login page") do
-            LoginPage.visit
-          end
-
-          When('I login with my credentials') do
-            LoginPage.login('aguspe', '12341234')
-          end
-
-          When('I can see the main page') do
-            expect(LoginPage.header.customer_name).to eq 'Welcome back Agustin'
-          end
-    EOF
-  end
-end

data/lib/generators/templates/helpers/allure_helper_template.rb

@@ -1,47 +0,0 @@
-require_relative '../template'
-
-class AllureHelperTemplate < Template
-  def body
-    if @framework == 'cucumber'
-      gems = "require 'allure-cucumber'"
-      allure = 'AllureCucumber'
-    else
-      gems = "require 'allure-ruby-commons'
-require 'allure-rspec'"
-      allure = 'AllureRspec'
-    end
-    <<~EOF
-            #{gems}
-
-            module Raider
-              module AllureHelper
-                class << self
-
-                  def configure
-                    #{allure}.configure do |config|
-                      config.results_directory = 'allure-results'
-                      config.clean_results_directory = true
-                    end
-                  end
-
-                  def add_screenshot(screenshot_name)
-                    Allure.add_attachment(
-                      name: name,
-                      source: "File.open(allure-results/screenshots/\#{screenshot_name}.png)",
-                      type: Allure::ContentType::PNG,
-                      test_case: true
-                    )
-                  end
-
-                  #{
-      if @framework == 'rspec'
-        'def formatter
-            AllureRspecFormatter
-          end'
-      end }
-                end
-              end
-            end
-    EOF
-  end
-end

data/lib/generators/templates/helpers/browser_helper_template.rb

@@ -1,26 +0,0 @@
-require_relative '../template'
-
-class BrowserHelperTemplate < Template
-  def body
-    <<~EOF
-      require 'yaml'
-      require 'selenium-webdriver'
-      require 'watir'
-      require 'webdrivers'
-
-      module Raider
-        module BrowserHelper
-          class << self
-            attr_reader :browser
-
-            def new_browser
-              config = YAML.load_file('config/config.yml')
-              @browser = Watir::Browser.new config['browser']
-            end
-          end
-        end
-      end
-
-    EOF
-  end
-end

data/lib/generators/templates/helpers/driver_helper_template.rb

@@ -1,54 +0,0 @@
-require_relative '../template'
-
-class DriverHelperTemplate < Template
-  def new_driver
-    if @automation == 'selenium'
-      <<-EOF.chomp
-def new_driver
-        @driver = Selenium::WebDriver.for :chrome
-      end
-      EOF
-    else
-      <<-EOF.chomp
-def new_driver
-        appium_file = File.join(Dir.pwd, 'appium.txt')
-        caps = Appium.load_appium_txt(file: appium_file)
-        @driver = Appium::Driver.new(caps)
-      end
-      EOF
-    end
-  end
-
-  def requirements
-    case @automation
-    when 'selenium'
-      <<~EOF
-        require 'selenium-webdriver'
-        require 'webdrivers'
-      EOF
-    when 'watir'
-      <<~EOF
-        require 'watir'
-        require 'webdrivers'
-      EOF
-    else
-      "require 'appium_lib'"
-    end
-  end
-
-  def body
-    <<~EOF
-      #{requirements}
-
-      module Raider
-        module DriverHelper
-          class << self
-            attr_reader :driver
-
-            #{new_driver}
-          end
-        end
-      end
-    EOF
-  end
-end

data/lib/generators/templates/helpers/pom_helper_template.rb

@@ -1,25 +0,0 @@
-require_relative '../template'
-
-class PomHelperTemplate < Template
-  def body
-    <<~EOF
-      module Raider
-        module PomHelper
-          def instance
-            @instance ||= new
-          end
-
-          def method_missing(message, *args, &block)
-            return super unless instance.respond_to?(message)
-
-            instance.public_send(message, *args, &block)
-          end
-
-          def respond_to_missing?(method, *_args, &block)
-            instance.respond_to?(method) || super
-          end
-        end
-      end
-    EOF
-  end
-end

data/lib/generators/templates/helpers/raider_helper_template.rb

@@ -1,27 +0,0 @@
-require_relative '../template'
-
-class RaiderHelperTemplate < Template
-  def require_spec_helper
-    "require_relative 'spec_helper'" if @framework == 'rspec'
-  end
-
-  def require_automation_helper
-    "require_relative '#{@automation}_helper'" if %w[selenium watir].include?(@automation)
-  end
-
-  def require_driver_helper
-    "require_relative '#{@automation == 'watir' ? 'browser_helper' : 'driver_helper'}'"
-  end
-
-  def body
-    <<~EOF
-      module Raider
-        #{require_spec_helper}
-        #{require_automation_helper}
-        require_relative 'pom_helper'
-        #{require_driver_helper}
-        require_relative 'allure_helper'
-      end
-    EOF
-  end
-end

data/lib/generators/templates/helpers/selenium_helper_template.rb

@@ -1,42 +0,0 @@
-require_relative '../template'
-
-class SeleniumHelperTemplate < Template
-  def body
-    <<~EOF
-      require 'selenium-webdriver'
-      require_relative 'driver_helper'
-
-      module Raider
-        module SeleniumHelper
-          def click_when_present
-            # This is an example of an implicit wait in selenium
-            wait = Selenium::WebDriver::Wait.new(timeout: 15)
-            wait.until { present? }
-            click
-          end
-
-          def select_by(key, value)
-            # Creates new Select object to use the select by method
-            dropdown = Selenium::WebDriver::Support::Select.new self
-            dropdown.select_by(key, value)
-          end
-
-          def hover
-            # Using actions to move the mouse over an element
-            DriverHelper.driver.action.move_to(self).perform
-          end
-
-          # How to perform right click through the context click method
-          def right_click
-            DriverHelper.driver.action.context_click(self).perform
-          end
-        end
-
-        # Here we are opening the selenium class and adding our custom method
-        class Selenium::WebDriver::Element
-          include SeleniumHelper
-        end
-      end
-    EOF
-  end
-end