ruby_raider 0.1.5 → 0.1.7

data/lib/generators/files/helpers_file_generator.rb

@@ -1,244 +1,63 @@
+require_relative '../templates/helpers/allure_helper_template'
+require_relative '../templates/helpers/browser_helper_template'
+require_relative '../templates/helpers/driver_helper_template'
+require_relative '../templates/helpers/pom_helper_template'
+require_relative '../templates/helpers/raider_helper_template'
+require_relative '../templates/helpers/spec_helper_template'
+require_relative '../templates/helpers/selenium_helper_template'
+require_relative '../templates/helpers/watir_helper_template'
 require_relative 'file_generator'
 
 module RubyRaider
   class HelpersFileGenerator < FileGenerator
-    def self.generate_helper_files(name, automation, framework)
-      path = framework == 'rspec' ? "#{name}/helpers" : "#{name}/features/support/helpers"
-      generate_file('raider.rb', path, generate_raider_helper(automation, framework))
-      generate_file('allure_helper.rb', path, generate_allure_helper(framework))
-      generate_file('pom_helper.rb', path, generate_pom_helper)
-      generate_file('spec_helper.rb', path, generate_spec_helper((automation))) if framework == 'rspec'
-      if automation == 'watir'
-        generate_file('watir_helper.rb', path, generate_watir_helper)
-        generate_file('browser_helper.rb', path, generate_browser_helper)
-      else
-        generate_file('selenium_helper.rb', path, generate_selenium_helper)
-        generate_file('driver_helper.rb', path, generate_driver_helper)
-      end
-    end
-
-    def self.generate_raider_helper(automation, framework)
-      spec = ERB.new <<~EOF
-        module Raider
-          #{"require_relative 'spec_helper'" if framework == 'rspec'}
-          require_relative '#{automation}_helper'
-          require_relative 'pom_helper'
-          require_relative '#{automation == 'watir' ? 'browser_helper' : 'driver_helper'}'
-          require_relative 'allure_helper'
+    class << self
+      def generate_helper_files(name, automation, 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
-      EOF
-
-      spec.result(binding)
-    end
-
-    def self.generate_allure_helper(framework)
-      if framework == 'cucumber'
-        gems = "require 'allure-cucumber'"
-        allure = 'AllureCucumber'
-      else
-        gems = "require 'allure-ruby-commons'
-require 'allure-rspec'"
-        allure = 'AllureRspec'
       end
-      spec = ERB.new <<~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
-      spec.result(binding)
-    end
-
-    def self.generate_browser_helper
-      spec = ERB.new <<~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
-      spec.result(binding)
-    end
-
-    def self.generate_pom_helper
-      spec = ERB.new <<~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
-      spec.result(binding)
-    end
-
-    def self.generate_spec_helper(automation)
-      spec = ERB.new <<~EOF
-        require 'active_support/all'
-        require 'rspec'
-        require_relative 'allure_helper'
-        require_relative '#{automation == 'watir' ? 'browser_helper' : 'driver_helper'}'
 
-        module Raider
-          module SpecHelper
-
-            AllureHelper.configure
-
-            RSpec.configure do |config|
-              config.formatter = AllureHelper.formatter
-              config.before(:each) do
-                #{automation == 'watir' ? 'BrowserHelper.new_browser' : 'DriverHelper.new_driver'}
-              end
-
-              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
-                AllureHelper.add_screenshot example_name if status == :failed
-                #{automation == 'watir' ? 'browser.quit' : 'driver.quit'}
-              end
-            end
-          end
-        end
-      EOF
-      spec.result(binding)
-    end
-
-    def self.generate_watir_helper
-      spec = ERB.new <<~EOF
-        require 'watir'
-
-        module Raider
-          module WatirHelper
-            refine Watir::Element do
-              def click_when_present
-                wait_until_present
-                self.click
-              end
-
-              def wait_until_present
-                self.wait_until(&:present?)
-              end
-            end
-          end
-        end
-      EOF
-      spec.result(binding)
-    end
-
-    def self.generate_selenium_helper
-      spec = ERB.new <<~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 generate_raider_helper(automation, framework, path)
+        generate_file('raider.rb', path,
+                      RaiderHelperTemplate.new(automation: automation, framework: framework).parsed_body)
+      end
 
-            def hover
-              # Using actions to move the mouse over an element
-              DriverHelper.driver.action.move_to(self).perform
-            end
+      def generate_allure_helper(framework, path)
+        generate_file('allure_helper.rb', path, AllureHelperTemplate.new(framework: framework).parsed_body)
+      end
 
-            # How to perform right click through the context click method
-            def right_click
-              DriverHelper.driver.action.context_click(self).perform
-            end
-          end
+      def generate_browser_helper(path)
+        generate_file('browser_helper.rb', path, BrowserHelperTemplate.new.parsed_body)
+      end
 
-          # Here we are opening the selenium class and adding our custom method
-          class Selenium::WebDriver::Element
-            include SeleniumHelper
-          end
-        end
+      def generate_pom_helper(path)
+        generate_file('pom_helper.rb', path, PomHelperTemplate.new.parsed_body)
+      end
 
-      EOF
-      spec.result(binding)
-    end
+      def generate_spec_helper(automation, path)
+        generate_file('spec_helper.rb', path, SpecHelperTemplate.new(automation: automation).parsed_body)
+      end
 
-    def self.generate_driver_helper
-      spec = ERB.new <<~EOF
-        require 'selenium-webdriver'
-        require 'watir'
-        require 'webdrivers'
-        require 'yaml'
+      def generate_watir_helper(path)
+        generate_file('watir_helper.rb', path, WatirHelperTemplate.new.parsed_body)
+      end
 
-        module Raider
-          module DriverHelper
-            class << self
-              attr_reader :driver
+      def generate_selenium_helper(path)
+        generate_file('selenium_helper.rb', path, SeleniumHelperTemplate.new.parsed_body)
+      end
 
-              def new_driver
-                @driver = Selenium::WebDriver.for :chrome
-              end
-            end
-          end
-        end
-      EOF
-      spec.result(binding)
+      def generate_driver_helper(path)
+        generate_file('driver_helper.rb', path, DriverHelperTemplate.new.parsed_body)
+      end
     end
   end
 end

data/lib/generators/files/rspec_file_generator.rb

@@ -1,58 +1,28 @@
+require_relative '../templates/rspec/example_spec_template'
+require_relative '../templates/rspec/base_spec_template'
+require_relative 'automation_file_generator'
 require_relative 'common_file_generator'
 require_relative 'file_generator'
 require_relative 'helpers_file_generator'
-require_relative 'automation_file_generator'
 
 module RubyRaider
   class RspecFileGenerator < FileGenerator
-    def self.generate_rspec_files(name, automation)
-      CommonFileGenerator.generate_common_files(name, 'rspec')
-      HelpersFileGenerator.generate_helper_files(name, automation, 'rspec')
-      generate_file('login_page_spec.rb', "#{name}/spec", generate_example_spec)
-      generate_file('base_spec.rb', "#{name}/spec", generate_base_spec)
-      AutomationFileGenerator.generate_automation_files(name, automation, 'rspec')
-    end
-
-    def self.generate_example_spec
-      spec = ERB.new <<~EOF
-        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
-        end
-      EOF
-      spec.result(binding)
-    end
-
-    def self.generate_base_spec
-      spec = ERB.new <<~EOF
-         require_relative '../helpers/raider'
-
-        class BaseSpec
-          include Raider::SpecHelper
-        end
-      EOF
-      spec.result(binding)
+    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')
+        generate_base_spec(name)
+        generate_example_spec(name)
+      end
+
+      def generate_example_spec(name)
+        generate_file('login_page_spec.rb', "#{name}/spec", ExampleSpecTemplate.new.parsed_body)
+      end
+
+      def generate_base_spec(name)
+        generate_file('base_spec.rb', "#{name}/spec", BaseSpecTemplate.new.parsed_body)
+      end
     end
   end
 end

data/lib/generators/projects/cucumber_project_generator.rb

@@ -3,22 +3,24 @@ require_relative 'project_generator'
 
 module RubyRaider
   class CucumberProjectGenerator < ProjectGenerator
-    def self.generate_cucumber_project(name, automation: 'watir')
-      cucumber_folder_structure(name)
-      CucumberFileGenerator.generate_cucumber_files(name, automation)
-      ProjectGenerator.install_gems(name)
-    end
+    class << self
+      def generate_cucumber_project(name, automation: 'watir')
+        cucumber_folder_structure(name)
+        CucumberFileGenerator.generate_cucumber_files(name, automation)
+        ProjectGenerator.install_gems(name)
+      end
 
-    def self.cucumber_folder_structure(name)
-      Dir.mkdir name.to_s
-      folders = %w[features config page_objects allure-results]
-      create_children_folders("#{name}", folders)
-      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"
+      def cucumber_folder_structure(name)
+        Dir.mkdir name.to_s
+        folders = %w[features config page_objects allure-results]
+        create_children_folders("#{name}", folders)
+        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
 end

data/lib/generators/projects/project_generator.rb

@@ -1,11 +1,13 @@
 module RubyRaider
   class ProjectGenerator
-    def self.create_children_folders(parent, folders)
-      folders.each { |folder| Dir.mkdir "#{parent}/#{folder}" }
-    end
+    class << self
+      def create_children_folders(parent, folders)
+        folders.each { |folder| Dir.mkdir "#{parent}/#{folder}" }
+      end
 
-    def self.install_gems(name)
-      system "cd #{name} && gem install bundler && bundle install"
+      def install_gems(name)
+        system "cd #{name} && gem install bundler && bundle install"
+      end
     end
   end
 end

data/lib/generators/projects/rspec_project_generator.rb

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

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

@@ -0,0 +1,22 @@
+require_relative '../template'
+
+class AbstractComponentTemplate < Template
+  def body
+    raider = if @framework == 'rspec'
+               "require_relative '../../helpers/raider'"
+             else
+               "require_relative '../../features/support/helpers/raider'"
+             end
+
+    <<~EOF
+      #{raider}
+
+      class AbstractComponent
+
+          def initialize(component)
+            @component = component
+          end
+      end
+    EOF
+  end
+end

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

@@ -0,0 +1,48 @@
+require_relative '../template'
+
+class AbstractPageTemplate < Template
+  def body
+    browser = "def browser
+    Raider::BrowserHelper.browser
+  end"
+    driver = "def driver
+    Raider::DriverHelper.driver
+  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
+
+    <<~EOF
+        require 'rspec'
+        #{raider}
+
+        class AbstractPage
+
+          include RSpec::Matchers
+          extend Raider::PomHelper
+
+          #{@automation == 'watir' ? browser : driver}
+
+          def visit(*page)
+            #{visit}
+          end
+
+          def full_url(*page)
+            "#\{base_url}#\{url(*page)}"
+          end
+
+          def base_url
+            'https://automationteststore.com/'
+          end
+
+          def url(_page)
+            raise 'Url must be defined on child pages'
+          end
+        end
+    EOF
+  end
+end

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

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

@@ -0,0 +1,51 @@
+require_relative '../template'
+
+class PageTemplate < Template
+  def body
+    element = @automation == 'watir' ? 'browser.element' : 'driver.find_element'
+    helper = @automation == 'watir' ? 'Raider::WatirHelper' : 'Raider::SeleniumHelper'
+
+    <<~EOF
+      require_relative '../abstract/abstract_page'
+      require_relative '../components/header_component'
+
+      class LoginPage < AbstractPage
+        using #{helper}
+
+        def url(_page)
+          'index.php?rt=account/login'
+        end
+
+        # Actions
+
+        def login(username, password)
+          username_field.send_keys username
+          password_field.send_keys password
+          login_button.click_when_present
+        end
+
+        # Components
+
+        def header
+          HeaderComponent.new(#{element}(class: 'menu_text'))
+        end
+
+        private
+
+        # Elements
+
+        def username_field
+          #{element}(id: 'loginFrm_loginname')
+        end
+
+        def password_field
+          #{element}(id: 'loginFrm_password')
+        end
+
+        def login_button
+          #{element}(xpath: "//button[@title='Login']")
+        end
+      end
+    EOF
+  end
+end

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

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

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

@@ -0,0 +1,29 @@
+require_relative '../template'
+
+class GemfileTemplate < Template
+  def body
+    if @framework == 'cucumber'
+      allure_cucumber = "gem 'allure-cucumber'"
+      rspec = "gem 'rspec'"
+    end
+
+    <<~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 'selenium-webdriver'
+          gem 'watir'
+          gem 'webdrivers'
+    EOF
+  end
+end

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

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