ruby_raider 0.1.8 → 0.1.9

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

@@ -0,0 +1,113 @@
+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/gemfile_template.rb

@@ -1,29 +1,52 @@
 require_relative '../template'
 
 class GemfileTemplate < Template
-  def body
-    if @framework == 'cucumber'
-      allure_cucumber = "gem 'allure-cucumber'"
-      rspec = "gem 'rspec'"
+  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
+      # frozen_string_literal: true
 
-          source 'https://rubygems.org'
+      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 'selenium-webdriver'
-          gem 'watir'
-          gem 'webdrivers'
+      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/helpers/driver_helper_template.rb

@@ -1,21 +1,51 @@
 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
-      require 'selenium-webdriver'
-      require 'watir'
-      require 'webdrivers'
-      require 'yaml'
+      #{requirements}
 
       module Raider
         module DriverHelper
           class << self
             attr_reader :driver
 
-            def new_driver
-              @driver = Selenium::WebDriver.for :chrome
-            end
+            #{new_driver}
           end
         end
       end

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

@@ -1,13 +1,25 @@
 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_relative 'spec_helper'" if @framework == 'rspec'}
-        require_relative '#{@automation}_helper'
+        #{require_spec_helper}
+        #{require_automation_helper}
         require_relative 'pom_helper'
-        require_relative '#{@automation == 'watir' ? 'browser_helper' : 'driver_helper'}'
+        #{require_driver_helper}
         require_relative 'allure_helper'
       end
     EOF

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

@@ -1,12 +1,54 @@
 require_relative '../template'
 
 class SpecHelperTemplate < Template
+  def require_driver
+    "require_relative '#{@automation == 'watir' ? 'browser_helper' : 'driver_helper'}'"
+  end
+
+  def select_helper
+    @automation == 'watir' ? 'BrowserHelper.new_browser' : 'DriverHelper.new_driver'
+  end
+
+  def before_configuration
+    driver_setup = if %w[selenium watir].include?(@automation)
+                     select_helper
+                   else
+                     <<-EOF.chomp
+#{select_helper}
+         DriverHelper.driver.start_driver
+                     EOF
+                   end
+
+    <<-EOF.chomp
+
+      config.before(:each) do
+        #{driver_setup}
+      end
+    EOF
+  end
+
+  def quit_driver
+    case @automation
+    when 'selenium'
+      'DriverHelper.driver.quit'
+    when 'watir'
+      'BrowserHelper.browser.quit'
+    else
+      'DriverHelper.driver.quit_driver'
+    end
+  end
+
+  def save_screenshot
+    driver = @automation == 'watir' ? 'browser' : 'driver'
+    "#{driver}.save_screenshot(\"allure-results/screenshots/\#{example_name}.png\") if status == :failed"
+  end
+
   def body
     <<~EOF
       require 'active_support/all'
       require 'rspec'
       require_relative 'allure_helper'
-      require_relative '#{@automation == 'watir' ? 'browser_helper' : 'driver_helper'}'
+      #{require_driver}
 
       module Raider
         module SpecHelper
@@ -15,17 +57,14 @@ class SpecHelperTemplate < Template
 
           RSpec.configure do |config|
             config.formatter = AllureHelper.formatter
-            config.before(:each) do
-              #{@automation == 'watir' ? 'BrowserHelper.new_browser' : 'DriverHelper.new_driver'}
-            end
+            #{before_configuration}
 
             config.after(:each) do
-              #{@automation == 'watir' ? 'browser = BrowserHelper.browser' : 'driver = DriverHelper.driver'}
               example_name = self.class.descendant_filtered_examples.first.description
               status = self.class.descendant_filtered_examples.first.execution_result.status
-              #{@automation == 'watir' ? 'browser' : 'driver'}.save_screenshot("allure-results/screenshots/#\{example_name}.png") if status == :failed
+              #{save_screenshot}
               AllureHelper.add_screenshot example_name if status == :failed
-              #{@automation == 'watir' ? 'browser.quit' : 'driver.quit'}
+              #{quit_driver}
             end
           end
         end

data/lib/generators/templates/rspec/example_spec_template.rb

@@ -1,32 +1,55 @@
 require_relative '../template'
 
 class ExampleSpecTemplate < Template
+  def examples
+    if %w[selenium watir].include? @automation
+      <<-EOF.chomp
+  describe 'Login' do
+    before(:each) do
+      LoginPage.visit
+    end
+
+    it 'can login with valid credentials' do
+      LoginPage.login('aguspe', '12341234')
+      expect(LoginPage.header.customer_name).to eq 'Welcome back Agustin'
+    end
+
+    it 'cannot login with wrong credentials' do
+      LoginPage.login('aguspe', 'wrongPassword')
+      expect(LoginPage.header.customer_name).to be_empty
+    end
+  end
+      EOF
+    else
+      <<-EOF.chomp
+  describe 'Login' do          
+    it 'Login with valid credentials' do
+      HomePage.go_to_login
+      LoginPage.login('alice', 'mypassword')
+      expect(ConfirmationPage.login_message).to eq 'You are logged in as alice'
+    end
+  end
+      EOF
+    end
+  end
+
+  def requirements
+    unless %w[selenium watir].include? @automation
+      <<~EOF.chomp
+        require_relative '../page_objects/pages/confirmation_page'
+        require_relative '../page_objects/pages/home_page'
+      EOF
+    end
+  end
+
   def body
     <<~EOF
+      #{requirements}
       require_relative 'base_spec'
       require_relative '../page_objects/pages/login_page'
-
+      
       class LoginSpec < BaseSpec
-        context 'On the Login Page' do
-
-          before(:each) do
-            LoginPage.visit
-          end
-
-          describe 'A user can' do
-            it 'login with the right credentials', :JIRA_123 do
-              LoginPage.login('aguspe', '12341234')
-              expect(LoginPage.header.customer_name).to eq 'Welcome back Agustin'
-            end
-          end
-
-          describe 'A user cannot' do
-            it 'login with the wrong credentials', :JIRA_123 do
-              LoginPage.login('aguspe', 'wrongPassword')
-              expect(LoginPage.header.customer_name).to be_empty
-            end
-          end
-        end
+      #{examples}
       end
     EOF
   end

data/ruby_raider.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.1.8'
+  s.version     = '0.1.9'
   s.summary     = 'A gem to make setup and start of UI automation projects easier'
   s.description = 'This gem contents everything you need to start doing web automation in one simple package'
   s.authors     = ['Agustin Pequeno']

data/spec/automation_file_generator_spec.rb

@@ -2,33 +2,58 @@ require_relative '../lib/generators/files/automation_file_generator'
 require_relative 'spec_helper'
 
 describe RubyRaider::AutomationFileGenerator do
-  before(:all) do
-    @name = 'Rspec-watir-1'
-    RubyRaider::RspecProjectGenerator.generate_rspec_project(@name, automation: 'watir')
-  end
-
-  it 'creates a login page file' do
-    expect(File.exist?("#{@name}/page_objects/pages/login_page.rb")).to be_truthy
-  end
-
-  it 'creates an abstract page file' do
-    expect(File.exist?("#{@name}/page_objects/abstract/abstract_page.rb")).to be_truthy
-  end
-
-  it 'creates an abstract component file' do
-    expect(File.exist?("#{@name}/page_objects/abstract/abstract_component.rb")).to be_truthy
-  end
-
-  it 'creates a component file' do
-    expect(File.exist?("#{@name}/page_objects/components/header_component.rb")).to be_truthy
-  end
-
-  it 'creates a gemfile file' do
-    expect(File.exist?("#{@name}/Gemfile")).to be_truthy
-  end
-
-  after(:all) do
-    FileUtils.rm_rf(@name)
+  context 'On a web project' do
+    before(:all) do
+      @name = 'Rspec-watir-1'
+      RubyRaider::RspecProjectGenerator.generate_rspec_project('watir', @name)
+    end
+
+    it 'creates a login page file' do
+      expect(File.exist?("#{@name}/page_objects/pages/login_page.rb")).to be_truthy
+    end
+
+    it 'creates an abstract page file' do
+      expect(File.exist?("#{@name}/page_objects/abstract/abstract_page.rb")).to be_truthy
+    end
+
+    it 'creates an abstract component file' do
+      expect(File.exist?("#{@name}/page_objects/abstract/abstract_component.rb")).to be_truthy
+    end
+
+    it 'creates a component file' do
+      expect(File.exist?("#{@name}/page_objects/components/header_component.rb")).to be_truthy
+    end
+
+    it 'creates a gemfile file' do
+      expect(File.exist?("#{@name}/Gemfile")).to be_truthy
+    end
+
+    after(:all) do
+      FileUtils.rm_rf(@name)
+    end
+
+    context 'On a mobile project' do
+      before(:all) do
+        @name = 'Rspec-appium-ios'
+        RubyRaider::RspecProjectGenerator.generate_rspec_project('appium_ios', @name)
+      end
+
+      it 'creates a login page file' do
+        expect(File.exist?("#{@name}/page_objects/pages/home_page.rb")).to be_truthy
+      end
+
+      it 'creates a login page file' do
+        expect(File.exist?("#{@name}/page_objects/pages/confirmation_page.rb")).to be_truthy
+      end
+
+      it 'creates a login page file' do
+        expect(File.exist?("#{@name}/appium.txt")).to be_truthy
+      end
+
+      after(:all) do
+        FileUtils.rm_rf(@name)
+      end
+    end
   end
 end
 

data/spec/common_file_generator_spec.rb

@@ -4,7 +4,7 @@ require_relative 'spec_helper'
 describe RubyRaider::CommonFileGenerator do
   before(:all) do
     @name = 'Cucumber-watir-1'
-    RubyRaider::CucumberProjectGenerator.generate_cucumber_project(@name, automation: 'watir')
+    RubyRaider::CucumberProjectGenerator.generate_cucumber_project('watir', @name)
   end
 
   it 'creates a config file' do

data/spec/cucumber_file_generator_spec.rb

@@ -4,7 +4,7 @@ require_relative 'spec_helper'
 describe RubyRaider::RspecFileGenerator do
   before(:all) do
     @name = 'Cucumber-watir-2'
-    RubyRaider::CucumberProjectGenerator.generate_cucumber_project(@name, automation: 'watir')
+    RubyRaider::CucumberProjectGenerator.generate_cucumber_project('watir', @name)
   end
 
   it 'creates a feature file' do

data/spec/cucumber_project_generator_spec.rb

@@ -3,7 +3,7 @@ require_relative 'spec_helper'
 describe RubyRaider::CucumberProjectGenerator do
   before(:all) do
     @name = 'Cucumber'
-    RubyRaider::CucumberProjectGenerator.generate_cucumber_project(@name, automation: 'selenium')
+    RubyRaider::CucumberProjectGenerator.generate_cucumber_project('selenium', @name)
   end
 
   it 'creates a project folder' do

data/spec/helpers_file_generator_spec.rb

@@ -5,7 +5,7 @@ describe RubyRaider::HelpersFileGenerator do
   context 'When the users selects rspec' do
     before(:all) do
       @name = 'Rspec-watir-2'
-      RubyRaider::RspecProjectGenerator.generate_rspec_project(@name, automation: 'selenium')
+      RubyRaider::RspecProjectGenerator.generate_rspec_project('selenium', @name)
     end
 
     it 'creates a raider file' do
@@ -40,7 +40,7 @@ describe RubyRaider::HelpersFileGenerator do
   context 'when the user selects cucumber' do
     before(:all) do
       @name = 'Cucumber-watir-3'
-      RubyRaider::CucumberProjectGenerator.generate_cucumber_project(@name, automation: 'watir')
+      RubyRaider::CucumberProjectGenerator.generate_cucumber_project('watir', @name)
     end
 
     it 'creates a raider file' do

data/spec/rspec_file_generator_spec.rb

@@ -4,7 +4,7 @@ require_relative 'spec_helper'
 describe RubyRaider::RspecFileGenerator do
   before(:all) do
     @name = 'Rspec-watir-3'
-    RubyRaider::RspecProjectGenerator.generate_rspec_project(@name, automation: 'watir')
+    RubyRaider::RspecProjectGenerator.generate_rspec_project('watir', @name)
   end
 
   it 'creates a spec file' do