ruby_raider 0.7.9 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7c0a06c991fd4bbbf94bdf2ed6081b2177fa40d9ee7df174ff2d9bf5698c794
-  data.tar.gz: 3ea6fb9b0d3b7aa19b77b8f8815b709b75ec14aee59dafd6a8dbfc98659abe38
+  metadata.gz: 5dd7827d45155a3d24655334c4c43a818812cc541fd76955c57d7588bfe3cbdc
+  data.tar.gz: 99da1055ac90cf2787ddffe02cba3afe2a653fbc41adca96f376d00de21b3f05
 SHA512:
-  metadata.gz: 9194bd0c1e51230f6458e4aa038729e68301511227c4034130310894b278f57704a3fe9dc13e206b9df8ff419c9697370a1930a02a803e660bfa9409bfb11b01
-  data.tar.gz: b8c71e244cc25bb7c2b95d82abf37c1fbf1a0af32460ef4e514daf974bb7d1071deba7636df89279e80c9bb3d95eab5778fbd561a15947be2eba6719d972e475
+  metadata.gz: f37c2a6ef6760ef66cf2cbb1f4e936205ba042cff82ab7a213cb3334a64b27624f41dfcb40dd8fc0095ebc29a50e61f127277ae8f90b533dfd3c4cc53f442ab4
+  data.tar.gz: 76504d52c72488dd6f4cd305424b3796e4a8108b5a516e1c90652a568ad481d443dca30325d7600b0e41b3f367b736368f5782ca5e985502e6dfcaa2427c6035

data/lib/generators/actions/actions_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative '../generator'
+
+class ActionsGenerator < Generator
+  def generate_actions_file
+    return unless web?
+
+    template('actions.tt', "#{name}/.github/workflows/test_pipeline.yml")
+  end
+end

data/lib/generators/actions/templates/actions.tt

@@ -0,0 +1,64 @@
+name: <%- if framework == 'cucumber' -%>Cucumber Tests<%- else -%>Rspec Tests<%- end -%>
+
+on:
+  workflow_dispatch:
+    inputs:
+      browser:
+        type: choice
+        description: Which browser to test
+        required: true
+        options:
+          - chrome
+
+jobs:
+  build:
+    name: CI
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.0
+          bundler-cache: true
+
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Install gems
+        run: bundle install
+
+      - name: Create allure-results folder
+        run: mkdir -p allure-results
+
+      - name: Create screenshots folder
+        run: mkdir -p allure-results/screenshots
+
+      - name: Build and test with rspec
+        run: <%- if framework == 'cucumber' -%>cucumber features --format pretty <%- else -%>bundle exec rspec spec --format documentation<%- end -%>
+
+      - name: Get Allure history
+        uses: actions/checkout@v2
+        if: always()
+        continue-on-error: true
+        with:
+          ref: gh-pages
+          path: gh-pages
+
+      - name: Allure Report
+        uses: simple-elf/allure-report-action@master
+        if: always()
+        id: allure-report
+        with:
+          allure_results: allure-results
+          gh_pages: gh-pages
+          allure_report: allure-report
+          allure_history: allure-history
+
+      - name: Deploy report to Github Pages
+        if: always()
+        uses: peaceiris/actions-gh-pages@v2
+        env:
+          PERSONAL_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PUBLISH_BRANCH: gh-pages
+          PUBLISH_DIR: allure-history

data/lib/generators/automation/automation_generator.rb

@@ -70,7 +70,7 @@ class AutomationGenerator < Generator
   end
 
   def generate_header_component
-    template('component.tt', "#{name}/page_objects/components/header_component.rb")
+    template('component.tt', "#{name}/page_objects/components/header.rb")
   end
 
   def generate_model_factory

data/lib/generators/automation/templates/abstract_page.tt

@@ -14,14 +14,32 @@ class AbstractPage
   end
 end
 <%- else -%>
+<% if web? -%>
+require_relative '../components/header'
+<% end -%>
+
 class AbstractPage
-<% if automation == 'cross_platform' -%>
+
+<%- if automation == 'cross_platform' -%>
   include AppiumHelper
-<% end -%>
+<%- end -%>
 <%= ERB.new(File.read(File.expand_path('./partials/initialize_selector.tt', __dir__))).result(binding) -%>
 <%= ERB.new(File.read(File.expand_path('./partials/visit_method.tt', __dir__))).result(binding) -%>
 <%= ERB.new(File.read(File.expand_path('./partials/url_methods.tt', __dir__))).result(binding) -%>
 
+<%- if automation == 'selenium' -%>
+  # Components
+
+  def header
+    Header.new(driver.find_element(id: 'customernav'))
+  end
+<%- elsif automation == 'watir' -%>
+  # Components
+
+  def header
+    Header.new(browser.element(id: 'customernav'))
+  end
+<%- end -%>
   def to_s
     self.class.to_s.sub('Page', ' Page')
   end

data/lib/generators/automation/templates/component.tt

@@ -2,7 +2,7 @@
 
 require_relative '../abstract/abstract_component'
 
-class HeaderComponent < AbstractComponent
+class Header < AbstractComponent
   def customer_name
     component.text
   end

data/lib/generators/automation/templates/partials/selenium_account.tt

@@ -1,17 +1,9 @@
 # frozen_string_literal: true
 
 require_relative '../abstract/abstract_page'
-require_relative '../components/header_component'
 
 class AccountPage < AbstractPage
-
   def url(_page)
     'index.php?rt=account/account'
   end
-
-  # Components
-
-  def header
-    HeaderComponent.new(driver.find_element(class: 'menu_text'))
-  end
 end

data/lib/generators/automation/templates/partials/selenium_login.tt

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative '../abstract/abstract_page'
-require_relative '../components/header_component'
 
 class LoginPage < AbstractPage
   def url(_page)
@@ -16,12 +15,6 @@ class LoginPage < AbstractPage
     login_button.click
   end
 
-  # Components
-
-  def header
-    HeaderComponent.new(driver.find_element(class: 'menu_text'))
-  end
-
   private
 
   # Elements

data/lib/generators/automation/templates/partials/watir_account.tt

@@ -1,15 +1,7 @@
 require_relative '../abstract/abstract_page'
-require_relative '../components/header_component'
 
 class AccountPage < AbstractPage
-
   def url(_page)
     'index.php?rt=account/account'
   end
-
-  # Components
-
-  def header
-    HeaderComponent.new(browser.element(class: 'menu_text'))
-  end
 end

data/lib/generators/automation/templates/partials/watir_login.tt

@@ -1,8 +1,6 @@
 require_relative '../abstract/abstract_page'
-require_relative '../components/header_component'
 
 class LoginPage < AbstractPage
-
   def url(_page)
     'index.php?rt=account/login'
   end
@@ -15,12 +13,6 @@ class LoginPage < AbstractPage
     login_button.click
   end
 
-  # Components
-
-  def header
-    HeaderComponent.new(browser.element(class: 'menu_text'))
-  end
-
   private
 
   # Elements

data/lib/generators/common_generator.rb

@@ -29,6 +29,10 @@ class CommonGenerator < Generator
     template('common/rubocop.tt', "#{name}/.rubocop.yml")
   end
 
+  def generate_gitignore_file
+    template('common/git_ignore.tt', "#{name}/.gitignore")
+  end
+
   def create_allure_folder
     empty_directory "#{name}/allure-results"
   end

data/lib/generators/cucumber/templates/partials/selenium_env.tt

@@ -35,7 +35,7 @@ require_relative '../../helpers/allure_helper'
 include DriverHelper
 
 Before do
-  driver
+  driver.manage.window.maximize
 end
 
 After do |scenario|

data/lib/generators/cucumber/templates/partials/watir_env.tt

@@ -6,7 +6,7 @@ require_relative '../../helpers/browser_helper'
 include BrowserHelper
 
 Before do
-  browser
+  browser.window.maximize
 end
 
 After do |scenario|

data/lib/generators/generator.rb

@@ -12,7 +12,8 @@ class Generator < Thor::Group
 
   def self.source_paths
     base_path = File.dirname(__FILE__)
-    %W[#{base_path}/automation/templates #{base_path}/cucumber/templates #{base_path}/rspec/templates #{base_path}/templates]
+    %W[#{base_path}/automation/templates #{base_path}/cucumber/templates
+       #{base_path}/rspec/templates #{base_path}/templates #{base_path}/actions/templates ]
   end
 
   def args
@@ -53,7 +54,7 @@ class Generator < Thor::Group
   end
 
   def web?
-    args.include?(%w[selenium watir])
+    (args & (%w[selenium watir])).count.positive?
   end
 
   private
@@ -61,5 +62,6 @@ class Generator < Thor::Group
   def _initializer
     @_initializer ||= super
   end
+
   alias initializer _initializer
 end

data/lib/generators/invoke_generators.rb

@@ -1,3 +1,4 @@
+require_relative 'actions/actions_generator'
 require_relative 'automation/automation_generator'
 require_relative 'common_generator'
 require_relative 'cucumber/cucumber_generator'
@@ -8,7 +9,7 @@ require_relative 'rspec/rspec_generator'
 # :reek:UtilityFunction { enabled: false }
 module InvokeGenerators
   def generate_framework(structure = {})
-    generators = %w[Automation Common Helpers]
+    generators = %w[Automation Actions Common Helpers]
     framework = structure[:framework]
     add_generator(generators, framework.capitalize)
     generators.each do |generator|

data/lib/generators/rspec/rspec_generator.rb

@@ -4,7 +4,7 @@ require_relative '../generator'
 
 class RspecGenerator < Generator
   def generate_login_spec
-    return if mobile?
+    return unless web?
 
     template('spec.tt', "#{name}/spec/login_page_spec.rb")
   end

data/lib/generators/rspec/templates/spec.tt

@@ -37,7 +37,7 @@ describe 'Login' do
     <%- if visual_automation == true -%>
       check_page login_page
     <%- else -%>
-      expect(header).to be_empty
+      expect(header).to eql 'Login or register'
     <%- end -%>
     end
   end

data/lib/generators/templates/common/gemfile.tt

@@ -25,7 +25,7 @@ gem 'rubocop'
 <% if framework == 'rspec' -%>
 gem 'rubocop-rspec'
 <% end -%>
-gem 'ruby_raider', '~> 0.7.0'
+gem 'ruby_raider', '~> 0.8.0'
 <%= ERB.new(File.read(File.expand_path('./partials/automation_gems.tt', __dir__))).result(binding).strip! %>
 <% if automation == 'sparkling_ios' -%>
 gem 'sparkling_watir'

data/lib/generators/templates/common/git_ignore.tt

@@ -0,0 +1 @@
+allure-results

data/lib/generators/templates/helpers/spec_helper.tt

@@ -45,12 +45,20 @@ module SpecHelper
     config.before(:each) do
       driver.start_driver
     end
+    <%- elsif automation == 'selenium' -%>
+    config.before(:each) do
+      driver.manage.window.maximize
+    end
+    <%- elsif automation == 'watir' -%>
+    config.before(:each) do
+      browser.window.maximize
+    end
     <%- end -%>
 
     config.after(:each) do
       example_name = self.class.descendant_filtered_examples.first.description
       <%= ERB.new(File.read(File.expand_path('./partials/screenshot.tt', __dir__)), trim_mode: '-').result(binding).strip! %>
-       AllureHelper.add_screenshot example_name
+      AllureHelper.add_screenshot example_name
       <%= ERB.new(File.read(File.expand_path('./partials/quit_driver.tt', __dir__)), trim_mode: '-').result(binding).strip! %>
     end
   end

data/lib/ruby_raider.rb

@@ -19,7 +19,7 @@ module RubyRaider
     desc 'version', 'It shows the version of Ruby Raider you are currently using'
 
     def version
-      puts 'The Ruby Raider version is 0.7.9, Happy testing!'
+      puts 'The Ruby Raider version is 0.8.0, Happy testing!'
     end
 
     map 'v' => 'version'

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.7.9'
+  s.version     = '0.8.0'
   s.summary     = 'A gem to make setup and start of UI automation projects easier'
   s.description = 'This gem has everything you need to start working with test automation'
   s.authors     = ['Agustin Pequeno']

data/spec/actions_generator_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../lib/generators/actions/actions_generator'
+require_relative 'spec_helper'
+
+describe ActionsGenerator do
+  shared_examples 'creates web automation framework' do |name|
+    it 'creates a github actions file' do
+      expect(File).to exist("#{name}/.github/workflows/test_pipeline.yml")
+    end
+  end
+
+  context 'with rspec and selenium' do
+    include_examples 'creates web automation framework', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
+  end
+
+  context 'with rspec and watir' do
+    include_examples 'creates web automation framework', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}"
+  end
+
+  context 'with cucumber and selenium' do
+    include_examples 'creates web automation framework', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[2]}"
+  end
+
+  context 'with cucumber and watir' do
+    include_examples 'creates web automation framework', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[3]}"
+  end
+end

data/spec/automation_generator_spec.rb

@@ -18,7 +18,7 @@ describe AutomationGenerator do
     end
 
     it 'creates a component file' do
-      expect(File).to exist("#{name}/page_objects/components/header_component.rb")
+      expect(File).to exist("#{name}/page_objects/components/header.rb")
     end
   end
 

data/spec/common_generator_spec.rb

@@ -42,71 +42,89 @@ describe CommonGenerator do
     end
   end
 
+  shared_examples 'creates a gitignore file' do |name|
+    it 'creates a gitignore file' do
+      expect(File).to exist("#{name}/.gitignore")
+    end
+  end
+
   context 'with rspec and selenium' do
     include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
     include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
   end
 
   context 'with rspec and watir' do
     include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}"
     include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}"
   end
 
   context 'with rspec, selenium and applitools' do
     include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
     include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
     include_examples 'creates an options file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
   end
 
   context 'with rspec, watir and applitools' do
     include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
     include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
     include_examples 'creates an options file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
   end
 
   context 'with cucumber and selenium' do
     include_examples 'creates common files', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[2]}"
     include_examples 'creates a config file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[2]}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[2]}"
   end
 
   context 'with cucumber and watir' do
     include_examples 'creates common files', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[3]}"
     include_examples 'creates a config file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[3]}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[3]}"
   end
 
   context 'with rspec and appium android' do
     include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.first}"
     include_examples 'creates a capabilities file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.first}"
     include_examples "doesn't create a config file", "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.first}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.first}"
   end
 
   context 'with rspec and appium ios' do
     include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[1]}"
     include_examples 'creates a capabilities file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[1]}"
     include_examples "doesn't create a config file", "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[1]}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[1]}"
   end
 
   context 'with cucumber and appium android' do
     include_examples 'creates common files', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.first}"
     include_examples 'creates a capabilities file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.first}"
     include_examples "doesn't create a config file", "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.first}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.first}"
   end
 
   context 'with cucumber and appium ios' do
     include_examples 'creates common files', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[1]}"
     include_examples 'creates a capabilities file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[1]}"
     include_examples "doesn't create a config file", "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[1]}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.first}"
   end
 
   context 'with cucumber and appium cross platform' do
     include_examples 'creates common files', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
     include_examples 'creates a capabilities file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
     include_examples 'creates a config file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
   end
 
   context 'with rspec and appium cross platform' do
     include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
     include_examples 'creates a capabilities file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
     include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates a gitignore file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.7.9
+  version: 0.8.0
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-27 00:00:00.000000000 Z
+date: 2023-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -197,6 +197,8 @@ files:
 - lib/commands/open_ai_commands.rb
 - lib/commands/scaffolding_commands.rb
 - lib/commands/utility_commands.rb
+- lib/generators/actions/actions_generator.rb
+- lib/generators/actions/templates/actions.tt
 - lib/generators/automation/automation_generator.rb
 - lib/generators/automation/templates/abstract_component.tt
 - lib/generators/automation/templates/abstract_page.tt
@@ -245,6 +247,7 @@ files:
 - lib/generators/rspec/templates/spec.tt
 - lib/generators/templates/common/config.tt
 - lib/generators/templates/common/gemfile.tt
+- lib/generators/templates/common/git_ignore.tt
 - lib/generators/templates/common/partials/automation_gems.tt
 - lib/generators/templates/common/partials/mobile_config.tt
 - lib/generators/templates/common/partials/web_config.tt
@@ -274,6 +277,7 @@ files:
 - lib/utilities/logger.rb
 - lib/utilities/utilities.rb
 - ruby_raider.gemspec
+- spec/actions_generator_spec.rb
 - spec/automation_generator_spec.rb
 - spec/common_generator_spec.rb
 - spec/cucumber_generator_spec.rb