ruby_raider 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19b563b9d03ec039ab3ca024593006e1ae78767a1005f8c8f7fa3f3182dbf5dc
-  data.tar.gz: 289e1c754007426dc2048e4eaa930ff96518057ec273f985b2a8c8273d044880
+  metadata.gz: 47cababb68c29a1a13ad36bb58a37f67aa9b0aad02a329a1fe3215af3cfa1174
+  data.tar.gz: 44f078d705101b3e233a06b1b5e6f30b7ff730a9923647c681faf7689c676d69
 SHA512:
-  metadata.gz: 9a91ae26cb2ca9425fd43a7c5a4e3c501d846c15d0e37794428df32c1702f6e2f3f35c7fcd7a5d0f164d8c5c818813060998bef64012d9f638794159409fcacc
-  data.tar.gz: 59fe1a44eef08555bf878615406a861378cc6d373a90eeeecfd0996b9bfecfff5b730543d9eab7eb503097e0614bf4d9930671011205d65087a60d9522ee8447
+  metadata.gz: a638b7050b95dfde750279a26722abb645f56f175f4729e02af8f6acad0f2b3448617aaddaf87dbc7fd14b417dca56048d52dfe2e936f26f52b94f2320818f02
+  data.tar.gz: 0e28acc526f8d775704e8642b3a7ac7a9da35d1d399acf7949b3c4bb6bd9a39694ce5f5e460ba5050d94923597c507f55561c64b94533da7ef58118385e18eb0

data/.gitignore

@@ -0,0 +1,3 @@
+ruby_raider-*.gem
+.idea/
+ruby_raider.iml

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,23 @@
+# ruby_raider
+This is a gem to make setup and start of UI automation projects easier
+
+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:
+
+* Gerating a Selenium with Rspec framework
+* Gerating a Watir with Rspec framework
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require_relative 'lib/ruby_raider'
+
+desc 'Create a new test projects'
+task :new, [:name] do |_t, args|
+  RubyRaider.generate_project(args.name)
+end

data/bin/raider

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/ruby_raider'
+
+RubyRaider.generate_project ARGV[0]

data/lib/generators/files/automation_file_generator.rb

@@ -0,0 +1,137 @@
+require_relative 'file_generator'
+
+module RubyRaider
+  class AutomationFileGenerator < FileGenerator
+    def self.generate_automation_files(name, automation, framework)
+      generate_file('abstract_page.rb', "#{name}/page_objects/abstract", abstract_page(automation, framework))
+      generate_file('abstract_component.rb', "#{name}/page_objects/abstract", abstract_component(framework))
+      generate_file('login_page.rb', "#{name}/page_objects/pages", example_page(automation))
+      generate_file('header_component.rb', "#{name}/page_objects/components", example_component)
+    end
+
+    def self.example_page(automation)
+      element = automation == 'watir' ? 'browser.element' : 'driver.find_element'
+      page_file = ERB.new <<~EOF
+        require_relative '../abstract/abstract_page'
+        require_relative '../components/header_component'
+
+        class LoginPage < AbstractPage
+
+          using #{automation == 'watir' ? 'Raider::WatirHelper' : 'Raider::SeleniumHelper'}
+
+          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
+      page_file.result(binding)
+    end
+
+    def self.abstract_page(automation, framework)
+      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
+      abstract_file = ERB.new <<~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
+      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
+
+    def self.abstract_component(framework)
+      raider = if framework == 'rspec'
+                 "require_relative '../../helpers/raider'"
+               else
+                 "require_relative '../../features/support/helpers/raider'"
+               end
+      abstract_file = ERB.new <<~EOF
+        #{raider}
+
+        class AbstractComponent
+
+            def initialize(component)
+              @component = component
+            end
+        end
+      EOF
+      abstract_file.result(binding)
+    end
+  end
+end

data/lib/generators/files/common_file_generator.rb

@@ -0,0 +1,162 @@
+require_relative 'file_generator'
+
+module RubyRaider
+  class CommonFileGenerator < FileGenerator
+    def self.generate_common_files(name, framework)
+      generate_file('config.yml', "#{name}/config", config_file)
+      generate_file('Rakefile', name.to_s, rake_file)
+      generate_file('Readme.md', name.to_s, readme_file)
+      generate_file('Gemfile', name.to_s, gemfile_template((framework)))
+    end
+
+    def self.readme_file
+      rake_file = ERB.new <<~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
+      rake_file.result(binding)
+    end
+
+    def self.config_file
+      config_file = ERB.new <<~EOF
+        browser: :chrome
+      EOF
+      config_file.result(binding)
+    end
+
+    def self.rake_file
+      rake_file = ERB.new <<~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
+      rake_file.result(binding)
+    end
+
+    def self.gemfile_template(framework)
+      if framework == 'cucumber'
+        allure_cucumber = "gem 'allure-cucumber'"
+        rspec = "gem 'rspec'"
+      end
+
+      gemfile = ERB.new <<~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
+      gemfile.result(binding)
+    end
+  end
+end

data/lib/generators/files/cucumber_file_generator.rb

@@ -0,0 +1,81 @@
+require_relative 'file_generator'
+
+module RubyRaider
+  class CucumberFileGenerator < FileGenerator
+    def self.generate_cucumber_files(name, automation)
+      CommonFileGenerator.generate_common_files(name, 'cucumber')
+      HelpersFileGenerator.generate_helper_files(name, automation, 'cucumber')
+      generate_file('login.feature', "#{name}/features", example_feature)
+      generate_file('login_steps.rb', "#{name}/features/step_definitions", example_steps)
+      generate_file('env.rb', "#{name}/features/support", env(automation))
+      AutomationFileGenerator.generate_automation_files(name, automation, 'framework')
+    end
+
+    def self.example_feature
+      gemfile = ERB.new <<~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
+      gemfile.result(binding)
+    end
+
+    def self.example_steps
+      gemfile = ERB.new <<~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
+      gemfile.result(binding)
+    end
+
+    def self.env(automation)
+      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
+
+      gemfile = ERB.new <<~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
+      gemfile.result(binding)
+    end
+  end
+end

data/lib/generators/files/file_generator.rb

@@ -0,0 +1,9 @@
+module RubyRaider
+  class FileGenerator
+    def self.generate_file(name, path, content)
+      file_path = "#{path}/#{name}"
+      File.new(file_path, 'w+')
+      File.write(file_path, content)
+    end
+  end
+end

data/lib/generators/files/helpers_file_generator.rb

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

@@ -0,0 +1,58 @@
+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)
+    end
+  end
+end

data/lib/generators/menu_generator.rb

@@ -0,0 +1,45 @@
+require 'highline'
+require_relative '../generators/projects/cucumber_project_generator'
+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 }
+      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)
+        end
+        menu.choice(:Cucumber) do
+          framework = 'cucumber'
+          set_framework(automation, framework, 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)
+      end
+    end
+  end
+end

data/lib/generators/projects/cucumber_project_generator.rb

@@ -0,0 +1,24 @@
+require_relative '../files/cucumber_file_generator'
+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
+
+    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"
+    end
+  end
+end

data/lib/generators/projects/project_generator.rb

@@ -0,0 +1,11 @@
+module RubyRaider
+  class ProjectGenerator
+    def self.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"
+    end
+  end
+end

data/lib/generators/projects/rspec_project_generator.rb

@@ -0,0 +1,20 @@
+require_relative 'project_generator'
+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
+
+    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)
+    end
+  end
+end

data/lib/ruby_raider.rb

@@ -1,4 +1,11 @@
-class RubyRaider
+require_relative 'generators/menu_generator'
+require_relative 'generators/projects/cucumber_project_generator'
+require_relative 'generators/projects/project_generator'
+require_relative 'generators/projects/rspec_project_generator'
 
+module RubyRaider
+  extend self
+  def generate_project(project_name)
+    MenuGenerator.generate_choice_menu(project_name)
+  end
 end
-

data/ruby_raider.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'ruby_raider'
+  s.version     = '0.1.4'
+  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']
+  s.email       = 'agustin.pe94@gmail.com'
+  s.homepage = 'http://github.com/aguspe/ruby_raider'
+  s.files = %w[bin/* lib/* lib/**/*]
+  s.license = 'MIT'
+  s.required_ruby_version = '>= 3.0.0'
+  s.files  = `git ls-files -z`.split("\x0")
+  s.bindir = 'bin'
+  s.executables << 'raider'
+  s.add_development_dependency 'rake', '~> 13.0.6'
+  s.add_development_dependency 'rspec', '~> 3.11.0'
+
+  s.add_runtime_dependency 'highline', '~> 2.0.3'
+end

data/spec/automation_file_generator_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../lib/generators/files/automation_file_generator'
+require_relative 'spec_helper'
+
+describe RubyRaider::AutomationFileGenerator 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 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
+

data/spec/common_file_generator_spec.rb

@@ -0,0 +1,18 @@
+require_relative '../lib/generators/files/common_file_generator'
+require_relative 'spec_helper'
+
+describe RubyRaider::CommonFileGenerator do
+  it 'creates a config file' do
+    expect(File.exist?("#{@project_name}/config/config.yml")).to be_truthy
+  end
+
+  it 'creates a rake file' do
+    expect(File.exist?("#{@project_name}/Rakefile")).to be_truthy
+  end
+
+  it 'creates a readMe file' do
+    expect(File.exist?("#{@project_name}/Readme.md")).to be_truthy
+  end
+end
+
+

data/spec/helpers_file_generator_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../lib/generators/files/helpers_file_generator'
+require_relative 'spec_helper'
+
+describe RubyRaider::HelpersFileGenerator do
+  it 'creates a raider file' do
+    expect(File.exist?("#{@project_name}/helpers/raider.rb")).to be_truthy
+  end
+
+  it 'creates an allure helper file' do
+    expect(File.exist?("#{@project_name}/helpers/allure_helper.rb")).to be_truthy
+  end
+
+  it 'creates a browser helper file' do
+    expect(File.exist?("#{@project_name}/helpers/browser_helper.rb")).to be_truthy
+  end
+
+  it 'creates a pom helper file' do
+    expect(File.exist?("#{@project_name}/helpers/pom_helper.rb")).to be_truthy
+  end
+
+  it 'creates a spec helper file' do
+    expect(File.exist?("#{@project_name}/helpers/spec_helper.rb")).to be_truthy
+  end
+
+  it 'creates a watir helper file' do
+    expect(File.exist?("#{@project_name}/helpers/allure_helper.rb")).to be_truthy
+  end
+end
+
+
+

data/spec/menu_generator_spec.rb

@@ -0,0 +1,8 @@
+require_relative '../lib/generators/menu_generator'
+
+describe 'A menu is generated' do
+  it 'generates a menu' do
+    menu = RubyRaider::MenuGenerator.new
+    menu.generate_choice_menu
+  end
+end

data/spec/rspec_file_generator_spec.rb

@@ -0,0 +1,12 @@
+require_relative '../lib/generators/files/rspec_file_generator'
+require_relative 'spec_helper'
+
+describe RubyRaider::RspecFileGenerator do
+  it 'creates a spec file' do
+    expect(File.exist?("#{@project_name}/spec/login_page_spec.rb")).to be_truthy
+  end
+
+  it 'creates the base spec file' do
+    expect(File.exist?("#{@project_name}/spec/base_spec.rb")).to be_truthy
+  end
+end

data/spec/rspec_project_generator_spec.rb

@@ -0,0 +1,39 @@
+require_relative 'spec_helper'
+
+describe RubyRaider::RspecProjectGenerator do
+  it 'creates a project folder' do
+    expect(Dir.exist?(@project_name)).to be_truthy
+  end
+
+  it 'creates a spec folder' do
+    expect(Dir.exist?("#{@project_name}/spec")).to be_truthy
+  end
+
+  it 'creates a page objects folder' do
+    expect(Dir.exist?("#{@project_name}/page_objects")).to be_truthy
+  end
+
+  it 'creates an abstract page object folder' do
+    expect(Dir.exist?("#{@project_name}/page_objects/abstract")).to be_truthy
+  end
+
+  it 'creates a pages folder' do
+    expect(Dir.exist?("#{@project_name}/page_objects/pages")).to be_truthy
+  end
+
+  it 'creates a components folder' do
+    expect(Dir.exist?("#{@project_name}/page_objects/components")).to be_truthy
+  end
+
+  it 'creates a helper folder' do
+    expect(Dir.exist?("#{@project_name}/helpers")).to be_truthy
+  end
+
+  it 'creates a data folder' do
+    expect(Dir.exist?("#{@project_name}/data")).to be_truthy
+  end
+
+  it 'creates a config folder' do
+    expect(Dir.exist?("#{@project_name}/config")).to be_truthy
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require_relative '../lib/generators/projects/rspec_project_generator'
+require 'fileutils'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.before(:all) do
+    @project_name = 'test'
+    RubyRaider::RspecProjectGenerator.generate_rspec_project @project_name
+  end
+
+  config.after(:all) do
+   FileUtils.rm_rf(@project_name)
+  end
+end

metadata

@@ -1,38 +1,90 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-20 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
 description: This gem contents everything you need to start doing web automation in
   one simple package
 email: agustin.pe94@gmail.com
-executables: []
+executables:
+- raider
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/raider
+- lib/generators/files/automation_file_generator.rb
+- lib/generators/files/common_file_generator.rb
+- lib/generators/files/cucumber_file_generator.rb
+- lib/generators/files/file_generator.rb
+- lib/generators/files/helpers_file_generator.rb
+- lib/generators/files/rspec_file_generator.rb
+- lib/generators/menu_generator.rb
+- lib/generators/projects/cucumber_project_generator.rb
+- lib/generators/projects/project_generator.rb
+- lib/generators/projects/rspec_project_generator.rb
 - lib/ruby_raider.rb
-homepage: https://rubygems.org/gems/ruby_raider
+- ruby_raider.gemspec
+- spec/automation_file_generator_spec.rb
+- spec/common_file_generator_spec.rb
+- spec/helpers_file_generator_spec.rb
+- spec/menu_generator_spec.rb
+- spec/rspec_file_generator_spec.rb
+- spec/rspec_project_generator_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/aguspe/ruby_raider
 licenses:
 - MIT
 metadata: {}
@@ -44,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="