ruby_raider 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8d336aefa187b06c4299321d8a8a4b66235dfd14974845e70006632a6450899
-  data.tar.gz: 10228a61500f16e12590d59f84363b7b85d186e79bf1cfb2967b63ae7788d00b
+  metadata.gz: 2b0c6d3fae74a6d921b96f3aeb216fef51378824aa78a24cbb5f9bb8a2f7c22e
+  data.tar.gz: 274ef6e35550c02473a6e6d6ffee85ca88f3a9279e379241da6b0177c7c1210e
 SHA512:
-  metadata.gz: b87195baaa2521f54deddc1c6e62ebf04a52f13f6e8880c5071f5a6ea43e3282ee14b7d121a98eee8435eb2d584fa4a5190675771eab8061409d7aeffb3d1e54
-  data.tar.gz: '0425969814d7f081fcacb71b510d5b5aa79d195a53511ab1b3028be602212533ad74e0150b53091ebbc43e27161c535e68c819ce483ffa8d2e423a9c1f2e814a'
+  metadata.gz: 0bc058b73aff5b99a92a06220c5d6f84e3314fca9eb99cb8a02f983308f755de245c751133fc9f9357bad8836c7cf575e0dddfd9ee83c2231e2ed5934ad71dc2
+  data.tar.gz: 5d45ba62bde3a8e3f317ec0392d3b7448b2b2ae56896f6d143916dcee9b4b37847b7fcc3e5e5dee2f1dcd8e1a735812744bc7c18943c08c4a130bffe0f653686

data/.gitignore

@@ -1 +1,2 @@
-ruby_raider-*.gem
+ruby_raider-*.gem
+.idea/

data/README.md

@@ -1,9 +1,18 @@
 # ruby_raider
 This is a gem to make setup and start of UI automation projects easier
 
-In order to run ruby raider you need to run the executable,
-after you can select the automation framework of your choice and the test framework of your choice.
+Just do:
+
+gem install ruby_raider
+
+then do raider [name_of_project] 
+
+and you will have a new project in the folder you are in
 
 Currently we only support Watir with Rspec.
 
 We have only tested this in mac and linux, so it works in both platforms.
+
+If you wanna follow the development progress 
+
+https://trello.com/b/Nj7UPy0w/ruby-raider

data/lib/generators/files/helpers_file_generator.rb

@@ -2,25 +2,31 @@ require_relative 'file_generator'
 
 module RubyRaider
   class HelpersFileGenerator < FileGenerator
-    def self.generate_helper_files(name)
-      generate_file('raider.rb', "#{name}/helpers", generate_raider_helper)
+    def self.generate_helper_files(name, automation)
+      generate_file('raider.rb', "#{name}/helpers", generate_raider_helper((automation)))
       generate_file('allure_helper.rb', "#{name}/helpers", generate_allure_helper)
-      generate_file('browser_helper.rb', "#{name}/helpers", generate_browser_helper)
       generate_file('pom_helper.rb', "#{name}/helpers", generate_pom_helper)
-      generate_file('watir_helper.rb', "#{name}/helpers", generate_watir_helper)
-      generate_file('spec_helper.rb', "#{name}/helpers", generate_spec_helper)
+      generate_file('spec_helper.rb', "#{name}/helpers", generate_spec_helper((automation)))
+      if automation == 'watir'
+        generate_file('watir_helper.rb', "#{name}/helpers", generate_watir_helper)
+        generate_file('browser_helper.rb', "#{name}/helpers", generate_browser_helper)
+      else
+        generate_file('selenium_helper.rb', "#{name}/helpers", generate_selenium_helper)
+        generate_file('driver_helper.rb', "#{name}/helpers", generate_driver_helper)
+      end
     end
 
-    def self.generate_raider_helper
+    def self.generate_raider_helper(automation)
       spec = ERB.new <<~EOF
         module Raider
           require_relative 'spec_helper'
-          require_relative 'watir_helper'
+          require_relative '#{automation}_helper'
           require_relative 'pom_helper'
-          require_relative 'browser_helper'
+          require_relative '#{automation == 'watir' ? 'browser_helper' : 'driver_helper'}'
           require_relative 'allure_helper'
         end
       EOF
+
       spec.result(binding)
     end
 
@@ -105,12 +111,12 @@ module RubyRaider
       spec.result(binding)
     end
 
-    def self.generate_spec_helper
+    def self.generate_spec_helper(automation)
       spec = ERB.new <<~EOF
         require 'active_support/all'
         require 'rspec'
         require_relative 'allure_helper'
-        require_relative 'browser_helper'
+        require_relative '#{automation == 'watir' ? 'browser_helper' : 'driver_helper'}'
 
         module Raider
           module SpecHelper
@@ -120,16 +126,16 @@ module RubyRaider
             RSpec.configure do |config|
               config.formatter = AllureHelper.formatter
               config.before(:each) do
-                BrowserHelper.new_browser
+                #{automation == 'watir' ? 'BrowserHelper.new_browser' : 'DriverHelper.new_driver'}
               end
 
               config.after(:each) do
-                browser = BrowserHelper.browser
+                #{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
-                browser.save_screenshot("allure-results/screenshots/#\{example_name}.png") if status == :failed
+                #{automation == 'watir' ? 'browser' : 'driver'}.save_screenshot("allure-results/screenshots/#\{example_name}.png") if status == :failed
                 AllureHelper.add_screenshot example_name if status == :failed
-                browser.quit
+                #{automation == 'watir' ? 'browser.quit' : 'driver.quit'}
               end
             end
           end
@@ -159,5 +165,70 @@ module RubyRaider
       EOF
       spec.result(binding)
     end
+
+    def self.generate_selenium_helper
+      spec = ERB.new <<~EOF
+        require 'selenium-webdriver'
+        require_relative 'driver_helper'
+
+        module ExampleDsl
+          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
+      spec.result(binding)
+    end
+
+    def self.generate_driver_helper
+      spec = ERB.new <<~EOF
+        require 'selenium-webdriver'
+        require 'watir'
+        require 'webdrivers'
+        require 'yaml'
+
+        module Raider
+          module DriverHelper
+            class << self
+              attr_reader :driver
+
+              def new_driver
+                @driver = Selenium::WebDriver.for :chrome
+              end
+            end
+          end
+        end
+
+
+      EOF
+      spec.result(binding)
+    end
   end
 end

data/lib/generators/files/rspec_file_generator.rb

@@ -1,19 +1,20 @@
 require_relative 'common_file_generator'
 require_relative 'file_generator'
 require_relative 'helpers_file_generator'
+require_relative 'selenium_file_generator'
 require_relative 'watir_file_generator'
 
 module RubyRaider
   class RspecFileGenerator < FileGenerator
     def self.generate_rspec_files(name, automation)
+      CommonFileGenerator.generate_common_files(name)
+      HelpersFileGenerator.generate_helper_files(name, automation)
+      generate_file('login_page_spec.rb', "#{name}/spec", generate_example_spec)
+      generate_file('base_spec.rb', "#{name}/spec", generate_base_spec)
       if automation == 'watir'
-        CommonFileGenerator.generate_common_files(name)
         WatirFileGenerator.generate_watir_files(name)
-        HelpersFileGenerator.generate_helper_files(name)
-        generate_file('login_page_spec.rb', "#{name}/spec", generate_example_spec)
-        generate_file('base_spec.rb', "#{name}/spec", generate_base_spec)
       else
-        pp 'here goes selenium'
+        SeleniumFileGenerator.generate_selenium_files(name)
       end
     end
 
@@ -32,13 +33,14 @@ module RubyRaider
             describe 'A user can' do
               it 'login with the right credentials', :JIRA_123 do
                 LoginPage.login('aguspe', '12341234')
-                expect(LoginPage.customer_name).to eq 'Welcome back Agustin'
+                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
-                expect(LoginPage.customer_name).to eq 'Login or register'
+                LoginPage.login('aguspe', 'wrongPassword')
+                expect(LoginPage.header.customer_name).to be_empty
               end
             end
           end

data/lib/generators/files/selenium_file_generator.rb

@@ -0,0 +1,159 @@
+require_relative 'file_generator'
+
+module RubyRaider
+  class SeleniumFileGenerator < FileGenerator
+    def self.generate_selenium_files(name)
+      generate_file('abstract_page.rb', "#{name}/page_objects/abstract", abstract_page)
+      generate_file('abstract_page_object.rb', "#{name}/page_objects/abstract", abstract_page_object)
+      generate_file('abstract_component.rb', "#{name}/page_objects/abstract", abstract_component)
+      generate_file('login_page.rb', "#{name}/page_objects/pages", example_page)
+      generate_file('header_component.rb', "#{name}/page_objects/components", example_component)
+      generate_file('Gemfile', name.to_s, gemfile_template)
+    end
+
+    def self.gemfile_template
+      gemfile = ERB.new <<~EOF
+        # frozen_string_literal: true
+
+        source 'https://rubygems.org'
+
+        gem 'activesupport'
+        gem 'allure-rspec'
+        gem 'allure-ruby-commons'
+        gem 'parallel_split_test'
+        gem 'parallel_tests'
+        gem 'rake'
+        gem 'rspec'
+        gem 'selenium-webdriver'
+        gem 'webdrivers'
+
+      EOF
+      gemfile.result(binding)
+    end
+
+    def self.example_page
+      gemfile = ERB.new <<~EOF
+        require_relative '../abstract/abstract_page'
+        require_relative '../components/header_component'
+        require_relative '../../helpers/selenium_helper'
+
+        class LoginPage < AbstractPage
+
+          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
+
+          def header
+            HeaderComponent.new(driver.find_element(class: 'menu_text'))
+          end
+
+          private
+
+          # Elements
+
+          def username_field
+            driver.find_element(id: 'loginFrm_loginname')
+          end
+
+          def password_field
+            driver.find_element(id: 'loginFrm_password')
+          end
+
+          def login_button
+            driver.find_element(xpath: "//button[@title='Login']")
+          end
+        end
+
+
+
+      EOF
+      gemfile.result(binding)
+    end
+
+    def self.abstract_page
+      abstract_file = ERB.new <<~EOF
+        require_relative '../components/header_component'
+        require_relative 'abstract_page_object'
+        require 'rspec'
+
+        class AbstractPage < AbstractPageObject
+          include RSpec::Matchers
+
+          def visit(*page)
+            driver.navigate.to full_url(page.first)
+          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
+
+          def header
+            HeaderComponent.new(driver.find_element(css: 'header'))
+          end
+        end
+
+      EOF
+      abstract_file.result(binding)
+    end
+
+    def self.abstract_component
+      abstract_file = ERB.new <<~EOF
+        require_relative '../../helpers/raider'
+
+         class AbstractComponent
+           def initialize(component)
+             @component = component
+           end
+         end
+      EOF
+      abstract_file.result(binding)
+    end
+
+    def self.abstract_page_object
+      abstract_file = ERB.new <<~EOF
+        require_relative '../../helpers/raider'
+
+        class AbstractPageObject
+          extend Raider::PomHelper
+
+          def driver
+            Raider::DriverHelper.driver
+          end
+        end
+
+      EOF
+      abstract_file.result(binding)
+    end
+
+    def self.example_component
+      page_file = ERB.new <<~EOF
+        require_relative '../abstract/abstract_component'
+
+        class HeaderComponent < AbstractComponent
+
+          def customer_name
+            @component.text
+          end
+        end
+
+      EOF
+      page_file.result(binding)
+    end
+  end
+end

data/lib/generators/files/watir_file_generator.rb

@@ -35,7 +35,7 @@ module RubyRaider
         require_relative '../abstract/abstract_page'
         require_relative '../components/header_component'
 
-        class LoginPage < BasePage
+        class LoginPage < AbstractPage
 
           using Raider::WatirHelper
 
@@ -51,6 +51,12 @@ module RubyRaider
             login_button.click_when_present
           end
 
+          # Components
+
+          def header
+            HeaderComponent.new(browser.element(class: 'menu_text'))
+          end
+
           private
 
           # Elements
@@ -74,12 +80,10 @@ module RubyRaider
     def self.abstract_page
       abstract_file = ERB.new <<~EOF
         require 'rspec'
-        require_relative '../components/header_component'
         require_relative '../../helpers/raider'
 
-        class BasePage
+        class AbstractPage
 
-          include HeaderComponent
           include RSpec::Matchers
           extend Raider::PomHelper
 
@@ -103,6 +107,7 @@ module RubyRaider
             raise 'Url must be defined on child pages'
           end
         end
+
       EOF
       abstract_file.result(binding)
     end
@@ -111,21 +116,10 @@ module RubyRaider
       page_file = ERB.new <<~EOF
         require_relative '../abstract/abstract_component'
 
-        module HeaderComponent
-
-          include BaseComponent
+        class HeaderComponent < AbstractComponent
 
           def customer_name
-            sleep 2
-            customer_menu.text
-          end
-
-          private
-
-          # Elements
-
-          def customer_menu
-            browser.element(id: 'customer_menu_top')
+            @component.text
           end
         end
       EOF
@@ -136,7 +130,11 @@ module RubyRaider
       abstract_file = ERB.new <<~EOF
         require_relative '../../helpers/raider'
 
-        module BaseComponent; end
+         class AbstractComponent
+           def initialize(component)
+             @component = component
+           end
+         end
       EOF
       abstract_file.result(binding)
     end

data/lib/generators/menu_generator.rb

@@ -7,8 +7,8 @@ module RubyRaider
       cli = HighLine.new
       cli.choose do |menu|
         menu.prompt = 'Please select your automation framework'
-        menu.choice(:Selenium) { 'We are still working on supporting this' }
-        menu.choice(:Watir) {choose_test_framework('watir', project_name) }
+        menu.choice(:Selenium) { choose_test_framework('selenium', project_name) }
+        menu.choice(:Watir) { choose_test_framework('watir', project_name) }
         menu.choice(:Quit, 'Exit program.') { exit }
       end
     end

data/ruby_raider.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.1.1'
+  s.version     = '0.1.2'
   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/selenium_file_generator_spec.rb

@@ -0,0 +1,29 @@
+require_relative '../lib/generators/files/selenium_file_generator'
+require_relative 'spec_helper'
+
+describe RubyRaider::SeleniumFileGenerator do
+  it 'creates a login page file' do
+    expect(File.exist?("#{@project_name}/page_objects/pages/login_page.rb")).to be_truthy
+  end
+
+  it 'creates an abstract page file' do
+    expect(File.exist?("#{@project_name}/page_objects/abstract/abstract_page.rb")).to be_truthy
+  end
+
+  it 'creates an abstract page object file' do
+    expect(File.exist?("#{@project_name}/page_objects/abstract/abstract_page_object.rb")).to be_truthy
+  end
+
+  it 'creates an abstract component file' do
+    expect(File.exist?("#{@project_name}/page_objects/abstract/abstract_component.rb")).to be_truthy
+  end
+
+  it 'creates a component file' do
+    expect(File.exist?("#{@project_name}/page_objects/components/header_component.rb")).to be_truthy
+  end
+
+  it 'creates a gemfile file' do
+    expect(File.exist?("#{@project_name}/Gemfile")).to be_truthy
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -47,9 +47,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".idea/.gitignore"
-- ".idea/modules.xml"
-- ".idea/ruby_raider.iml"
 - README.md
 - Rakefile
 - bin/raider
@@ -57,6 +54,7 @@ files:
 - lib/generators/files/file_generator.rb
 - lib/generators/files/helpers_file_generator.rb
 - lib/generators/files/rspec_file_generator.rb
+- lib/generators/files/selenium_file_generator.rb
 - lib/generators/files/watir_file_generator.rb
 - lib/generators/menu_generator.rb
 - lib/generators/projects/cucumber_project_generator.rb
@@ -69,6 +67,7 @@ files:
 - spec/menu_generator_spec.rb
 - spec/rspec_file_generator_spec.rb
 - spec/rspec_project_generator_spec.rb
+- spec/selenium_file_generator_spec.rb
 - spec/spec_helper.rb
 - spec/watir_file_generator_spec.rb
 homepage: http://github.com/aguspe/ruby_raider

data/.idea/.gitignore

@@ -1,8 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml

data/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/ruby_raider.iml" filepath="$PROJECT_DIR$/.idea/ruby_raider.iml" />
-    </modules>
-  </component>
-</project>

data/.idea/ruby_raider.iml

@@ -1,20 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="RUBY_MODULE" version="4">
-  <component name="ModuleRunConfigurationManager">
-    <shared />
-  </component>
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
-      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
-      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
-    </content>
-    <orderEntry type="jdk" jdkName="RVM: ruby-3.0.0" jdkType="RUBY_SDK" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-  <component name="RakeTasksCache">
-    <option name="myRootTask">
-      <RakeTaskImpl id="rake" />
-    </option>
-  </component>
-</module>