ruby_raider 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aed816df5e1abdc73f27322835a3ca84a2f5238a0a7d6c0a9905fe766fe8a78f
-  data.tar.gz: 041d4cac7ed5dbffa13369b65fa59b275ceaddbdae7b75149e2780eb2befc6e4
+  metadata.gz: 4dcbe671c993c24b4869fb0243906a8cd5d4614d7ea4690e0292cdb8c67a0b58
+  data.tar.gz: 39018ac4bf1d1148ad6a5308ca251d54de216154f774955c9c0c5c966b836019
 SHA512:
-  metadata.gz: 15f03089c0d4b633e647c802baaa93777eb9bfcc259023b63adb81ab6415b89e5488a5d043aa1234957e9570d22f3f82870d5e4d563ade1577d5a82b12eba2b5
-  data.tar.gz: 2a133387a4d7533f9b654aded174b64c56feb19a6ee2e860953d5c8dbac4c781ff0f86d798db03e31add9ab6eb9abc97a95e3c2c436197d1f6fdcbbf078737e4
+  metadata.gz: 0c9ae7dce2543807cf14ed1e51f0d81e015ef40b0e9d791209432cc954d55bb3fe39fe297fb43c4a7a07381431bd069ed4b33de98b30328f161ef25538d5ee6d
+  data.tar.gz: caefa842f497505b6dcfc64e1e35cd27ba4f31f41ec11ac635359acae7540296251b9523054e01fe75d3c247373707a8f669b39eaa2fff3130fc2a8a9e5eef15

data/lib/generators/files/automation_file_generator.rb

@@ -1,22 +1,31 @@
 require_relative 'file_generator'
 require_relative '../templates/automation/abstract_page_template'
 require_relative '../templates/automation/abstract_component_template'
+require_relative '../templates/automation/appium_settings_template'
 require_relative '../templates/automation/component_template'
-require_relative '../templates/automation/page_template'
+require_relative '../templates/automation/confirmation_page_template'
+require_relative '../templates/automation/login_page_template'
+require_relative '../templates/automation/home_page_template'
 
 module RubyRaider
   class AutomationFileGenerator < FileGenerator
     class << self
-      def generate_automation_files(name, automation, framework)
-        generate_example_page(automation, name)
+      def generate_automation_files(automation, name, framework)
+        generate_login_page(automation, name)
         generate_abstract_page(automation, framework, name)
-        generate_example_component(name)
-        generate_abstract_component(framework, name)
+        if %w[selenium watir].include?(automation)
+          generate_example_component(name)
+          generate_abstract_component(framework, name)
+        else
+          generate_home_page(name)
+          generate_confirmation_page(name)
+          generate_appium_settings(name)
+        end
       end
 
-      def generate_example_page(automation, name)
+      def generate_login_page(automation, name)
         generate_file('login_page.rb', "#{name}/page_objects/pages",
-                      PageTemplate.new(automation: automation, name: name).parsed_body)
+                      LoginPageTemplate.new(automation: automation, name: name).parsed_body)
       end
 
       def generate_abstract_page(automation, framework, name)
@@ -24,15 +33,29 @@ module RubyRaider
                       AbstractPageTemplate.new(automation: automation, framework: framework, name: name).parsed_body)
       end
 
+      def generate_home_page(name)
+        generate_file('home_page.rb', "#{name}/page_objects/pages",
+                      HomePageTemplate.new.parsed_body)
+      end
+
+      def generate_confirmation_page(name)
+        generate_file('confirmation_page.rb', "#{name}/page_objects/pages",
+                      ConfirmationPageTemplate.new.parsed_body)
+      end
+
       def generate_example_component(name)
-        generate_file('header_component.rb',"#{name}/page_objects/components",
-        ComponentTemplate.new.parsed_body)
+        generate_file('header_component.rb', "#{name}/page_objects/components",
+                      ComponentTemplate.new.parsed_body)
       end
 
       def generate_abstract_component(framework, name)
-        generate_file('abstract_component.rb',"#{name}/page_objects/abstract",
+        generate_file('abstract_component.rb', "#{name}/page_objects/abstract",
                       AbstractComponentTemplate.new(framework: framework).parsed_body)
       end
+
+      def generate_appium_settings(name)
+        generate_file('appium.txt', name.to_s, AppiumSettingsTemplate.new.parsed_body)
+      end
     end
   end
 end

data/lib/generators/files/common_file_generator.rb

@@ -7,11 +7,14 @@ require_relative 'file_generator'
 module RubyRaider
   class CommonFileGenerator < FileGenerator
     class << self
-      def generate_common_files(name, framework)
-        generate_config_file(name)
-        generate_rake_file(name)
+      def generate_common_files(automation, name, framework)
+        if %w[selenium watir].include?(automation)
+          generate_config_file(name)
+          generate_rake_file(name)
+        end
+
         generate_readme_file(name)
-        generate_gemfile(framework, name)
+        generate_gemfile(automation, framework, name)
       end
 
       def generate_readme_file(name)
@@ -26,8 +29,9 @@ module RubyRaider
         generate_file('Rakefile', name.to_s, RakeFileTemplate.new.parsed_body)
       end
 
-      def generate_gemfile(framework, name)
-        generate_file('Gemfile',name.to_s, GemfileTemplate.new(framework: framework).parsed_body)
+      def generate_gemfile(automation, framework, name)
+        generate_file('Gemfile',name.to_s,
+                      GemfileTemplate.new(automation: automation, framework: framework).parsed_body)
       end
     end
   end

data/lib/generators/files/cucumber_file_generator.rb

@@ -6,10 +6,10 @@ require_relative 'file_generator'
 module RubyRaider
   class CucumberFileGenerator < FileGenerator
     class << self
-      def generate_cucumber_files(name, automation)
-        AutomationFileGenerator.generate_automation_files(name, automation, 'framework')
-        CommonFileGenerator.generate_common_files(name, 'cucumber')
-        HelpersFileGenerator.generate_helper_files(name, automation, 'cucumber')
+      def generate_cucumber_files(automation, name)
+        AutomationFileGenerator.generate_automation_files(automation, name, 'framework')
+        CommonFileGenerator.generate_common_files(automation, name, 'cucumber')
+        HelpersFileGenerator.generate_helper_files(automation, name, 'cucumber')
         generate_env_file(automation, name)
         generate_example_feature(name)
         generate_example_steps(name)

data/lib/generators/files/helpers_file_generator.rb

@@ -11,19 +11,13 @@ require_relative 'file_generator'
 module RubyRaider
   class HelpersFileGenerator < FileGenerator
     class << self
-      def generate_helper_files(name, automation, framework)
+      def generate_helper_files(automation, name, framework)
         path = framework == 'rspec' ? "#{name}/helpers" : "#{name}/features/support/helpers"
         generate_raider_helper(automation, framework, path)
         generate_allure_helper(framework, path)
         generate_pom_helper(path)
         generate_spec_helper(automation, path) if framework == 'rspec'
-        if automation == 'watir'
-          generate_watir_helper(path)
-          generate_browser_helper(path)
-        else
-          generate_selenium_helper(path)
-          generate_driver_helper(path)
-        end
+        select_helpers(automation, path)
       end
 
       def generate_raider_helper(automation, framework, path)
@@ -55,8 +49,21 @@ module RubyRaider
         generate_file('selenium_helper.rb', path, SeleniumHelperTemplate.new.parsed_body)
       end
 
-      def generate_driver_helper(path)
-        generate_file('driver_helper.rb', path, DriverHelperTemplate.new.parsed_body)
+      def generate_driver_helper(automation, path)
+        generate_file('driver_helper.rb', path, DriverHelperTemplate.new(automation: automation).parsed_body)
+      end
+
+      def select_helpers(automation, path)
+        case automation
+        when 'watir'
+          generate_watir_helper(path)
+          generate_browser_helper(path)
+        when 'selenium'
+          generate_selenium_helper(path)
+          generate_driver_helper(automation, path)
+        else
+          generate_driver_helper(automation, path)
+        end
       end
     end
   end

data/lib/generators/files/rspec_file_generator.rb

@@ -8,16 +8,17 @@ require_relative 'helpers_file_generator'
 module RubyRaider
   class RspecFileGenerator < FileGenerator
     class << self
-      def generate_rspec_files(name, automation)
-        AutomationFileGenerator.generate_automation_files(name, automation, 'rspec')
-        CommonFileGenerator.generate_common_files(name, 'rspec')
-        HelpersFileGenerator.generate_helper_files(name, automation, 'rspec')
+      def generate_rspec_files(automation, name)
+        AutomationFileGenerator.generate_automation_files(automation, name,'rspec')
+        CommonFileGenerator.generate_common_files(automation, name, 'rspec')
+        HelpersFileGenerator.generate_helper_files(automation, name, 'rspec')
         generate_base_spec(name)
-        generate_example_spec(name)
+        generate_example_spec(automation, name)
       end
 
-      def generate_example_spec(name)
-        generate_file('login_page_spec.rb', "#{name}/spec", ExampleSpecTemplate.new.parsed_body)
+      def generate_example_spec(automation, name)
+        generate_file('login_page_spec.rb', "#{name}/spec",
+                      ExampleSpecTemplate.new(automation: automation).parsed_body)
       end
 
       def generate_base_spec(name)

data/lib/generators/menu_generator.rb

@@ -4,41 +4,56 @@ require_relative '../generators/projects/rspec_project_generator'
 
 module RubyRaider
   class MenuGenerator
-    def self.generate_choice_menu(project_name)
-      cli = HighLine.new
-      cli.choose do |menu|
-        menu.prompt = 'Please select your automation framework'
-        menu.choice(:Selenium) { choose_test_framework('selenium', project_name) }
-        menu.choice(:Watir) { choose_test_framework('watir', project_name) }
-        menu.choice(:Quit, 'Exit program.') { exit }
+    class << self
+      def generate_choice_menu(project_name)
+        @cli = HighLine.new
+        @cli.choose do |menu|
+          menu.prompt = 'Please select your automation framework'
+          menu.choice('Selenium') { choose_test_framework('selenium', project_name) }
+          menu.choice('Watir') { choose_test_framework('watir', project_name) }
+          menu.choice('Appium') { choose_test_framework('appium', project_name) }
+          menu.choice('Quit') { exit }
+        end
       end
-    end
 
-    def self.choose_test_framework(automation, project_name)
-      system('clear') || system('cls')
-      sleep 0.3
-      cli = HighLine.new
-      framework = ''
-      cli.choose do |menu|
-        menu.prompt = 'Please select your test framework'
-        menu.choice(:Rspec) do
-          framework = 'rspec'
-          set_framework(automation, framework, project_name)
+      def choose_test_framework(automation, project_name)
+        system('clear') || system('cls')
+        sleep 0.3
+        automation = automation == 'appium' ? choose_mobile_platform : automation
+        framework = ''
+        @cli.choose do |menu|
+          menu.prompt = 'Please select your test framework'
+          menu.choice('Rspec') { framework = 'rspec'; set_framework(automation, framework, project_name) }
+          menu.choice('Cucumber') do
+            if %w[selenium watir].include? automation
+              framework = 'cucumber'
+              set_framework(automation, framework, project_name)
+            else
+              pp 'We will support iOS with cucumber on the next release'
+              exit
+            end
+          end
+          menu.choice('Quit') { exit }
         end
-        menu.choice(:Cucumber) do
-          framework = 'cucumber'
-          set_framework(automation, framework, project_name)
+        @cli.say("You have chosen to use #{framework} with #{automation}")
+      end
+
+      def set_framework(automation, framework, project_name)
+        if framework == 'rspec'
+          RspecProjectGenerator.generate_rspec_project(automation, project_name)
+        else
+          CucumberProjectGenerator.generate_cucumber_project(automation, project_name)
         end
-        menu.choice(:Quit, 'Exit program.') { exit }
       end
-      cli.say("You have chosen to use #{framework} with #{automation}")
-    end
 
-    def self.set_framework(automation, framework, project_name)
-      if framework == 'rspec'
-        RspecProjectGenerator.generate_rspec_project(project_name, automation: automation)
-      else
-        CucumberProjectGenerator.generate_cucumber_project(project_name, automation: automation)
+      def choose_mobile_platform
+        @cli.choose do |menu|
+          menu.prompt = 'Please select your mobile platform'
+          menu.choice('iOS') { 'appium_ios' }
+          menu.choice('Android') { pp 'Android appium is coming soon. Thank you for the interest'; exit }
+          menu.choice('Cross Platform') { pp 'Cross platform appium is coming soon. Thank you for the interest'; exit }
+          menu.choice('Quit') { exit }
+        end
       end
     end
   end

data/lib/generators/projects/cucumber_project_generator.rb

@@ -4,22 +4,30 @@ require_relative 'project_generator'
 module RubyRaider
   class CucumberProjectGenerator < ProjectGenerator
     class << self
-      def generate_cucumber_project(name, automation: 'watir')
-        cucumber_folder_structure(name)
-        CucumberFileGenerator.generate_cucumber_files(name, automation)
+      def generate_cucumber_project(automation, name)
+        cucumber_folder_structure(automation, name)
+        CucumberFileGenerator.generate_cucumber_files(automation, name)
         ProjectGenerator.install_gems(name)
       end
 
-      def cucumber_folder_structure(name)
-        Dir.mkdir name.to_s
-        folders = %w[features config page_objects allure-results]
+      def cucumber_folder_structure(automation, name)
+        create_project_folder(name)
+        create_base_folders(automation, name)
+        create_features_child_folders(name)
+        Dir.mkdir "#{name}/features/support/helpers"
+        create_po_child_folders(automation, name)
+        Dir.mkdir "#{name}/allure-results/screenshots"
+      end
+
+      def create_base_folders(automation, name)
+        folders = %w[features page_objects allure-results]
         create_children_folders("#{name}", folders)
+        Dir.mkdir "#{name}/config" if %w[selenium watir].include?(automation)
+      end
+
+      def create_features_child_folders(name)
         folders = %w[step_definitions support]
         create_children_folders("#{name}/features", folders)
-        Dir.mkdir "#{name}/features/support/helpers"
-        folders = %w[abstract pages components]
-        create_children_folders("#{name}/page_objects", folders)
-        Dir.mkdir "#{name}/allure-results/screenshots"
       end
     end
   end

data/lib/generators/projects/project_generator.rb

@@ -8,6 +8,20 @@ module RubyRaider
       def install_gems(name)
         system "cd #{name} && gem install bundler && bundle install"
       end
+
+      def create_project_folder(name)
+        Dir.mkdir name.to_s
+      end
+
+      def create_base_folders
+        raise 'Please specify the base folders for the projects'
+      end
+
+      def create_po_child_folders(automation, name)
+        folders = %w[pages abstract]
+        create_children_folders("#{name}/page_objects", folders)
+        Dir.mkdir "#{name}/page_objects/components" if %w[selenium watir].include?(automation)
+      end
     end
   end
 end

data/lib/generators/projects/rspec_project_generator.rb

@@ -4,18 +4,22 @@ require_relative '../files/rspec_file_generator'
 module RubyRaider
   class RspecProjectGenerator < ProjectGenerator
     class << self
-      def generate_rspec_project(name, automation: 'watir')
-        rspec_folder_structure(name)
-        RspecFileGenerator.generate_rspec_files(name, automation)
+      def generate_rspec_project(automation, name)
+        rspec_folder_structure(automation, name)
+        RspecFileGenerator.generate_rspec_files(automation, name)
         ProjectGenerator.install_gems(name)
       end
 
-      def rspec_folder_structure(name)
-        Dir.mkdir name.to_s
-        folders = %w[config data page_objects helpers spec]
+      def rspec_folder_structure(automation, name)
+        create_project_folder(name)
+        create_base_folders(automation, name)
+        create_po_child_folders(automation, name)
+      end
+
+      def create_base_folders(automation, name)
+        folders = %w[data page_objects helpers spec]
         create_children_folders(name, folders)
-        pages = %w[pages components abstract]
-        create_children_folders("#{name}/page_objects", pages)
+        Dir.mkdir "#{name}/config" if %w[selenium watir].include?(automation)
       end
     end
   end

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

@@ -1,48 +1,82 @@
 require_relative '../template'
 
 class AbstractPageTemplate < Template
-  def body
-    browser = "def browser
-    Raider::BrowserHelper.browser
-  end"
-    driver = "def driver
+
+  def raider
+    if @framework == 'rspec'
+      "require_relative '../../helpers/raider'\n"
+    else
+      "require_relative '../../features/support/helpers/raider'\n"
+    end
+  end
+
+  def helper_selector
+    if @automation == 'watir'
+      <<~EOF
+
+    def browser
+      Raider::BrowserHelper.browser
+    end
+
+      EOF
+    else
+      <<-EOF
+
+  def driver
     Raider::DriverHelper.driver
-  end"
+  end
+
+
+      EOF
+    end
+  end
 
-    visit = @automation == 'watir' ? 'browser.goto full_url(page.first)' : 'driver.navigate.to full_url(page.first)'
-    raider = if @framework == 'rspec'
-               "require_relative '../../helpers/raider'"
-             else
-               "require_relative '../../features/support/helpers/raider'"
-             end
+  def visit
+    if %w[selenium watir].include?(@automation)
+      <<-EOF
 
-    <<~EOF
-        require 'rspec'
-        #{raider}
 
-        class AbstractPage
+  def visit(*page)
+    #{@automation == 'selenium' ? 'driver.navigate.to full_url(page.first)' : 'browser.goto full_url(page.first)'}
+  end
 
-          include RSpec::Matchers
-          extend Raider::PomHelper
+      EOF
+    end
+  end
 
-          #{@automation == 'watir' ? browser : driver}
+  def url_methods
+    methods = <<-EOF
+  
 
-          def visit(*page)
-            #{visit}
-          end
+  def full_url(*page)
+    "#\{base_url}#\{url(*page)}"
+  end
 
-          def full_url(*page)
-            "#\{base_url}#\{url(*page)}"
-          end
+  def base_url
+    'https://automationteststore.com/'
+  end
 
-          def base_url
-            'https://automationteststore.com/'
-          end
+  def url(_page)
+    raise 'Url must be defined on child pages'
+  end
+    EOF
+
+
+    methods if %w[selenium watir].include?(@automation)
+  end
+
+  def body
+    <<~EOF.gsub(/\n{2}\s{4}/, '')
+      require 'rspec'
+      #{raider}
+      class AbstractPage
 
-          def url(_page)
-            raise 'Url must be defined on child pages'
-          end
-        end
+        include RSpec::Matchers
+        extend Raider::PomHelper
+        #{helper_selector}
+        #{visit}
+        #{url_methods}
+      end
     EOF
   end
 end

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

@@ -0,0 +1,16 @@
+require_relative '../template'
+
+class AppiumSettingsTemplate < Template
+  def body
+    <<~EOF
+      [caps]
+      platformName = "iOS"
+      platformVersion = "15.4"
+      deviceName = "iPhone SE (3rd generation)"
+      app = "TheApp.app"
+
+      [appium_lib]
+      server_url = "http://127.0.0.1:4723/wd/hub"
+    EOF
+  end
+end

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

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,26 @@
+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