ruby_raider 0.4.8 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 904822acb4d07440328f3b619533a79374988766b0882f668f31e32f8636adb3
-  data.tar.gz: e64bfe97f99255eac84ee1f6e850b5ce02293b0bc0314e031d047ee67071e3f3
+  metadata.gz: 3eb106f129e5b690948b563085637b1bf775ffbd0258972b8fd7551021abe64e
+  data.tar.gz: ad19ffdff7e43f3dc4f8a81f7720022c519070cc685bf9bd489ff130ad484fe6
 SHA512:
-  metadata.gz: c77b13d45b719d5ab8add012d22f9b2c1016d53877441dc7b6b1a9fde39553c1eac5f951d8c9f1e5d7012eb14b9da162fc12c0d08274eb24791cb0fefb462b48
-  data.tar.gz: 610e5101c0f09d3ba1898d03111745e0208705ad36a5337dce2fd44b381afa0116f1a050be4c19896f0a973ae36b26b81a65f0d009568821ea82fdfd162204d5
+  metadata.gz: a319a898af7c5d4282d06904bdf298efcb1aeff70715c8ba18bee62b5af289375d8fc398cfd2fe1d236518569f367500532989e55bac102ee6ea45397922d3c9
+  data.tar.gz: c4d26509776661ee9d52d8962f00929a8e50b3e7e14583b65568685b7f9562c3cc7412eb0151659f34c9cf7edccad8225238293c6187ab402919ab8964866204

data/README.md

@@ -2,6 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/ruby_raider.svg)](https://badge.fury.io/rb/ruby_raider)
 [![Rubocop](https://github.com/RubyRaider/ruby_raider/actions/workflows/rspec.yml/badge.svg)](https://github.com/RubyRaider/ruby_raider/actions/workflows/rspec.yml)
+[![Gitter](https://badges.gitter.im/RubyRaider/community.svg)](https://gitter.im/RubyRaider/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 <!-- PROJECT LOGO -->
 <br />
@@ -53,6 +54,8 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 
 * Generating a visual testing framework with Rspec, Applitools and Selenium
 
+* Generating a visual testing framework with Rspec, Applitools and Watir
+
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
 
 ***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.).***

data/lib/commands/utility_commands.rb

@@ -2,6 +2,7 @@
 
 require 'thor'
 require_relative '../utilities/utilities'
+require_relative '../utilities/open_ai'
 
 class UtilityCommands < Thor
   desc 'path [PATH]', 'Sets the default path for scaffolding'
@@ -73,7 +74,7 @@ class UtilityCommands < Thor
   option :delete,
          type: :boolean, required: false, desc: 'This will delete the selected config file', aliases: '-d'
 
-  desc 'platform [platform]', 'Sets the default platform for a cross-platform project'
+  desc 'platform [PLATFORM]', 'Sets the default platform for a cross-platform project'
 
   def platform(platform)
     Utilities.new.platform = platform
@@ -81,7 +82,7 @@ class UtilityCommands < Thor
 
   map '-pl' => 'platform'
 
-  desc 'download_builds [build_type]', 'It downloads the example builds for appium projects'
+  desc 'download_builds [BUILD_TYPE]', 'It downloads the example builds for appium projects'
   def download_builds(build_type)
     if %w[android, ios, both].include?(build_type)
       raise 'Please select one of the following build types: android, ios, both'
@@ -94,8 +95,22 @@ class UtilityCommands < Thor
 
   desc 'version', 'It shows the version of Ruby Raider you are currently using'
   def version
-    puts 'The Ruby Raider version is 0.4.7, Happy testing!'
+    puts 'The Ruby Raider version is 0.5.0, Happy testing!'
   end
 
   map '-v' => 'version'
+
+  desc 'open_ai [REQUEST]', 'Uses open AI to create a file or generate output'
+  option :path,
+         type: :string, required: false, desc: 'The path where your file will be created', aliases: '-p'
+  option :output,
+         type: :string, required: false, desc: 'This will output the response from open AI on the terminal', aliases: '-o'
+
+  def open_ai(request)
+    if options[:path]
+      OpenAi.create_file(choice = 0, options[:path], request)
+    else
+      OpenAi.output(request)
+    end
+  end
 end

data/lib/generators/menu_generator.rb

@@ -67,18 +67,12 @@ class MenuGenerator
   private
 
   def framework_choice(framework, automation_type)
-    visual_automation = if automation_type == 'selenium' && framework == 'Rspec'
-                          choose_visual_automation
-                        end
+    visual_automation = choose_visual_automation if %w[selenium watir].include?(automation_type) && framework == 'Rspec'
 
     set_up_framework(automation_type, framework.downcase, visual_automation)
     prompt.say("You have chosen to use #{framework} with #{automation_type}")
   end
 
-  def error_handling(platform)
-    pp "#{platform} appium is coming soon. Thank you for the interest"
-  end
-
   def select_test_framework(automation)
     prompt.select('Please select your test framework') do |menu|
       menu.choice :Cucumber, -> { framework_choice('Cucumber', automation) }

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

@@ -3,8 +3,10 @@
 require_relative '../abstract/abstract_page'
 
 class AppPage < AbstractPage
+<%- if automation == 'selenium' -%>
   using Raider::SeleniumHelper
 
+<%- end -%>
   def url(_page)
     'app.html#'
   end

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

@@ -1,7 +1,7 @@
-<% if automation == 'selenium' && visual_automation == true %>
-<%= ERB.new(File.read(File.expand_path('./partials/visual_login.tt', __dir__))).result(binding) %>
+<% if %w[selenium watir].include?(automation) && visual_automation == true %>
+<%= ERB.new(File.read(File.expand_path('./partials/visual_login.tt', __dir__)), trim_mode: '-').result(binding) %>
 <% elsif automation == 'selenium' %>
-<%= ERB.new(File.read(File.expand_path('./partials/selenium_login.tt', __dir__))).result(binding) %>
+<%= ERB.new(File.read(File.expand_path('./partials/selenium_login.tt', __dir__)), trim_mode: '-').result(binding) %>
 <% elsif automation == 'watir' %>
-<%= ERB.new(File.read(File.expand_path('./partials/watir_login.tt', __dir__))).result(binding) %>
+<%= ERB.new(File.read(File.expand_path('./partials/watir_login.tt', __dir__)), trim_mode: '-').result(binding) %>
 <% end %>

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

@@ -3,7 +3,9 @@
 require_relative '../abstract/abstract_page'
 
 class LoginPage < AbstractPage
+<%- if automation == 'selenium' -%>
   using Raider::SeleniumHelper
+<%- end -%>
 
   def url(_page)
     'index.html'
@@ -12,7 +14,11 @@ class LoginPage < AbstractPage
   # Actions
 
   def login
+  <%- if automation == 'watir' -%>
+    login_button.click
+    <%- else -%>
     login_button.click_when_present
+    <%- end -%>
   end
 
   private
@@ -20,6 +26,10 @@ class LoginPage < AbstractPage
   # Elements
 
   def login_button
+  <%- if automation == 'watir' -%>
+    browser.element(id: 'log-in')
+  <%- else -%>
     driver.find_element(:id, 'log-in')
+  <%- end -%>
   end
-end
+end

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

@@ -10,6 +10,7 @@ gem 'allure-cucumber'
 <% end -%>
 <% if visual_automation -%>
 gem 'eyes_selenium'
+gem 'eyes_universal'
 <% end -%>
 <% unless visual_automation -%>
 gem 'parallel_split_test'

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

@@ -50,6 +50,8 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 
 * Generating a visual testing framework with Rspec, Applitools and Selenium
 
+* Generating a visual testing framework with Rspec, Applitools and Watir
+
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
 
 ***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.).***

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

@@ -1,22 +1,22 @@
 # frozen_string_literal: true
 
 module Raider
-<% if framework == 'rspec' -%>
+<%- if framework == 'rspec' -%>
   require_relative 'spec_helper'
-<% end -%>
+<%- end -%>
   <%= ERB.new(File.read(File.expand_path('./partials/require_automation.tt', __dir__))).result(binding).strip! %>
-<% if automation == 'watir' -%>
+<%- if automation == 'watir' -%>
   require_relative 'browser_helper'
-<% else -%>
+<%- else -%>
   require_relative 'driver_helper'
-<% end -%>
-<% unless visual_automation -%>
+<%- end -%>
+<%- unless visual_automation -%>
   require_relative 'allure_helper'
-<% end -%>
-<% if automation == 'cross_platform' -%>
+<%- end -%>
+<%- if automation == 'cross_platform' -%>
   require_relative 'appium_helper'
-<% end -%>
-<% if visual_automation -%>
+<%- end -%>
+<%- if visual_automation -%>
   require_relative 'visual_helper'
-<% end -%>
+<%- end -%>
 end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'active_support/inflector'
 require 'eyes_selenium'
 require 'yaml'
 

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

@@ -2,20 +2,28 @@
 
 require 'rspec'
 require 'eyes_selenium'
+<%- if automation == 'selenium' -%>
 require_relative 'driver_helper'
+<%- else -%>
+require_relative 'browser_helper'
+<%- end -%>
 require_relative 'visual_helper'
 
 module Raider
   module SpecHelper
     RSpec.configure do |config|
-      config.include(DriverHelper)
+      config.include(<%- if automation == 'watir' -%>BrowserHelper<% else -%>DriverHelper<%- end -%>)
       config.include(VisualHelper)
       config.before(:each) do
         OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
         @grid_runner = create_grid_runner
         @eyes = create_eyes(@grid_runner)
         configure_eyes @eyes
+        <%- if automation == 'selenium' -%>
         @driver = @eyes.open(driver: new_driver)
+        <%- else -%>
+        @driver = @eyes.open(driver: new_browser.driver)
+        <%- end -%>
       end
 
       config.after(:each) do

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

@@ -1,4 +1,4 @@
-<% if automation == 'selenium' && visual_automation == true %>
+<% if %w[selenium watir].include?(automation) && visual_automation == true %>
 # frozen_string_literal: true
 
 require_relative 'base_spec'
@@ -6,10 +6,10 @@ require_relative '../page_objects/pages/login_page'
 require_relative '../page_objects/pages/app_page'
 
 describe 'Login Page' do
-  let(:app_page) { AppPage.new(@driver) }
-  let(:login_page) { LoginPage.new(@driver) }
+  let(:app_page) { AppPage.new(<% if automation == 'watir' -%>browser<% else -%>driver<% end -%>) }
+  let(:login_page) { LoginPage.new(<% if automation == 'watir' -%>browser<% else -%>driver<% end -%>) }
 
-  before(:example) do
+  before do
     login_page.visit
   end
 
@@ -19,17 +19,16 @@ describe 'Login Page' do
     check_page app_page
   end
 end
-
-<% elsif %w[selenium watir].include? automation -%>
+<%- elsif %w[selenium watir].include? automation -%>
 require_relative 'base_spec'
 require_relative '../page_objects/pages/login_page'
 
 describe 'Login' do
   let(:user_name) { 'aguspe' }
-  let(:login_page) { LoginPage.new(<% if automation == 'watir' -%>@browser<% else -%>@driver<% end -%>) }
+  let(:login_page) { LoginPage.new(<% if automation == 'watir' -%>browser<% else -%>driver<% end -%>) }
   subject { login_page.header.customer_name }
 
-  before(:example) do
+  before do
     login_page.visit
     login_page.login(user_name, password)
   end
@@ -50,7 +49,7 @@ describe 'Login' do
     end
   end
 end
-<% else -%>
+<%- else -%>
 require_relative '../page_objects/pages/home_page'
 require_relative 'base_spec'
 require_relative '../page_objects/pages/pdp_page'
@@ -67,4 +66,4 @@ class PdpSpec < BaseSpec
     end
   end
 end
-<% end -%>
+<%- end -%>

data/lib/utilities/open_ai.rb

@@ -0,0 +1,37 @@
+require 'openai'
+require 'fileutils'
+
+module OpenAi
+  class << self
+    def create_client
+      configure_client
+      OpenAI::Client.new
+    end
+
+    def configure_client
+      OpenAI.configure do |config|
+        config.access_token = ENV.fetch('OPENAI_ACCESS_TOKEN')
+        config.organization_id = ENV.fetch('OPENAI_ORGANIZATION_ID', nil)
+      end
+    end
+
+    def input(model = "gpt-3.5-turbo", temperature = 0.7, request)
+      create_client.chat(
+        parameters: {
+          model: model,
+          messages: [{ role: "user", content: request }],
+          temperature: temperature
+        })
+    end
+
+    def create_file(choice = 0, path, request)
+      response = input(request)
+      File.write(path, response.dig("choices", choice, "message", "content"))
+    end
+
+    def output(choice = 0, request)
+      response = input(request)
+      puts response.dig("choices", choice, "message", "content")
+    end
+  end
+end

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.4.8'
+  s.version     = '0.5.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']
@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'thor', '~> 1.2.1'
   s.add_runtime_dependency 'tty-prompt', '~> 0.23.1'
+  s.add_runtime_dependency 'ruby-openai', '~> 3.5'
 end

data/spec/automation_generator_spec.rb

@@ -36,12 +36,28 @@ describe AutomationGenerator do
     end
   end
 
+  shared_examples 'creates web visual automation files' do |name|
+    it 'creates a login page file' do
+      expect(File).to exist("#{name}/page_objects/pages/login_page.rb")
+    end
+
+    it 'creates an abstract page file' do
+      expect(File).to exist("#{name}/page_objects/abstract/abstract_page.rb")
+    end
+
+    it 'creates an app page file' do
+      expect(File).to exist("#{name}/page_objects/pages/app_page.rb")
+    end
+  end
+
   context 'with rspec and selenium' do
     include_examples 'creates web automation files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
+    include_examples 'creates web visual automation files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
   end
 
   context 'with rspec and watir' do
     include_examples 'creates web automation files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}"
+    include_examples 'creates web visual automation files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
   end
 
   context 'with cucumber and selenium' do

data/spec/common_generator_spec.rb

@@ -25,7 +25,7 @@ describe CommonGenerator do
   end
 
   shared_examples 'creates a capabilities file' do |name|
-    it 'creates a config file' do
+    it 'creates a capabilities file' do
       expect(File).to exist("#{name}/config/capabilities.yml")
     end
   end
@@ -36,6 +36,12 @@ describe CommonGenerator do
     end
   end
 
+  shared_examples 'creates an options file' do |name|
+    it 'creates an options file' do
+      expect(File).to exist("#{name}/config/options.yml")
+    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]}"
@@ -46,6 +52,18 @@ describe CommonGenerator do
     include_examples 'creates a config 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"
+  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"
+  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]}"

data/spec/helpers_generator_spec.rb

@@ -44,6 +44,20 @@ describe HelpersGenerator do
     end
   end
 
+  shared_examples 'creates common visual helpers' do |name|
+    it 'does not create an allure helper file' do
+      expect(File).not_to exist("#{name}/helpers/allure_helper.rb")
+    end
+
+    it 'creates a raider file' do
+      expect(File).to exist("#{name}/helpers/raider.rb")
+    end
+
+    it 'creates a visual helper file' do
+      expect(File).to exist("#{name}/helpers/visual_helper.rb")
+    end
+  end
+
   context 'with rspec and selenium' do
     include_examples 'creates common helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
     include_examples 'creates selenium helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
@@ -56,6 +70,18 @@ describe HelpersGenerator do
     include_examples 'creates rspec helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}"
   end
 
+  context 'with rspec, selenium and applitools' do
+    include_examples 'creates common visual helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
+    include_examples 'creates selenium helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
+    include_examples 'creates rspec helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_visual"
+  end
+
+  context 'with rspec, watir and applitools' do
+    include_examples 'creates common visual helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
+    include_examples 'creates watir helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
+    include_examples 'creates rspec helpers', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_visual"
+  end
+
   context 'with cucumber and selenium' do
     include_examples 'creates common helpers', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[2]}"
     include_examples 'creates selenium helpers', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES[2]}"

data/spec/spec_helper.rb

@@ -12,13 +12,17 @@ RSpec.configure do |config|
     FRAMEWORKS.each do |framework|
       AUTOMATION_TYPES.each do |automation|
         MenuGenerator.new("#{framework}_#{automation}").generate_framework(automation, framework, false)
+        MenuGenerator.new("#{framework}_#{automation}_visual").generate_framework(automation, framework, true)
       end
     end
   end
 
   config.after(:all) do
     FRAMEWORKS.each do |framework|
-      AUTOMATION_TYPES.each { |automation| FileUtils.rm_rf("#{framework}_#{automation}") }
+      AUTOMATION_TYPES.each do |automation|
+        FileUtils.rm_rf("#{framework}_#{automation}")
+        FileUtils.rm_rf("#{framework}_#{automation}_visual")
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.5.0
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-22 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.23.1
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 description: This gem has everything you need to start working with test automation
 email: agustin.pe94@gmail.com
 executables:
@@ -217,6 +231,7 @@ files:
 - lib/scaffolding/templates/helper.tt
 - lib/scaffolding/templates/page_object.tt
 - lib/scaffolding/templates/spec.tt
+- lib/utilities/open_ai.rb
 - lib/utilities/utilities.rb
 - ruby_raider.gemspec
 - spec/automation_generator_spec.rb
@@ -245,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A gem to make setup and start of UI automation projects easier