ruby_raider 0.7.5 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6187527f5296b729b6b97dfc897beb9d60809db17ab34fece7673c53a247be0f
-  data.tar.gz: 2ac25c14abdc3c038390cf6ca0b1b1a36cab72366adef86c7cdf6d32984aadec
+  metadata.gz: e9cb054a366c6659aceb3252fbea25a07333f71224091584f2bd4c681b6c1203
+  data.tar.gz: d96e5fac73ec95f61b37f6b0de18905558b2060a02a7891fbb1052fcf1202122
 SHA512:
-  metadata.gz: d999412e75b3f5b595d3615bc4664c0bc2c059385d8d397e970cce48565caa11712223654b6c28ae2892ba1ce03c3e72ddb305f272d9c61228053d93a7b92e8e
-  data.tar.gz: 33f26594ee731b2dfce01861e13ee8423acca5411c583fe4d77784d54edea05f840cf95cdc85b70dcc15407ce041e8e3062dd46d35b9617a42c18e803dc5f276
+  metadata.gz: 17535a8af0e11cae31a6e2ff1e3edcafc252eb96fff79163918cefd259cc7d22c15cda67888ea558a437abadf3ba7c0febb37f4c10d77838b5265f2e647f3764
+  data.tar.gz: 8600c2438a466de652cfa93e1eede49967ac3422261d0e712677468bed91969d7746684d196b611a0076d44501ccbbe2aa007a05d588d95af5c831ee9c5b0b1b

data/README.md

@@ -56,6 +56,10 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 
 * Generating a visual testing framework with Cucumber, Applitools and Selenium
 
+* Generating a mobile testing framework with Rspec and Sparkling Watir for IOS
+
+* Generating a mobile testing framework with Cucumber and Sparkling Watir for IOS
+
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
 ***Remember to use the full path of the app that you download in the capabilities file***
 

data/Rakefile

@@ -2,6 +2,7 @@
 
 require_relative 'lib/ruby_raider'
 require_relative 'lib/commands/scaffolding_commands'
+require_relative 'lib/utilities/logger'
 
 desc 'Creates a new test project'
 task :new, [:name] do |_t, args|
@@ -27,3 +28,8 @@ desc 'Download mobile builds'
 task :builds, [:type] do |_t, args|
   ScaffoldingCommands.new.invoke(:download_builds, nil, %W[#{args.type}])
 end
+
+desc 'Logs a warning'
+task :log, [:message] do |_t, args|
+  RubyRaider::Logger.warn(args.message)
+end

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

@@ -1,7 +1,19 @@
-<%- if automation == 'cross_platform' -%>
-require_relative '../../helpers/appium_helper'
-<% end -%>
+<%- if automation == 'sparkling_ios' -%>
+require 'sparkling_watir/element'
+
+class AbstractPage
+
+  attr_reader :app
+
+  def initialize(app)
+    @app = app
+  end
 
+  def to_s
+    self.class.to_s.sub('Page', ' Page')
+  end
+end
+<%- else -%>
 class AbstractPage
 <% if automation == 'cross_platform' -%>
   include AppiumHelper
@@ -14,3 +26,4 @@ class AbstractPage
     self.class.to_s.sub('Page', ' Page')
   end
 end
+<%- end -%>

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

@@ -1,4 +1,4 @@
-<% if automation == 'ios' %>
+<% if automation.include?('ios') %>
 <%= ERB.new(File.read(File.expand_path('./partials/ios_caps.tt', __dir__))).result(binding) -%>
 <% elsif automation == 'android' %>
 <%= ERB.new(File.read(File.expand_path('./partials/android_caps.tt', __dir__))).result(binding) -%>

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

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
 require_relative '../abstract/abstract_page'
+<%- if automation == 'sparkling_ios' -%>
+class HomePage < AbstractPage
+
+  # Actions
 
+  def go_to_backpack_pdp
+    app.tap on: backpack_image.wait_until(&:present?)
+  end
+
+  private
+
+  # Elements
+
+  def backpack_image
+    app.element(predicate: 'label == "Sauce Labs Backpack"')
+  end
+end
+<%- else -%>
 class HomePage < AbstractPage
 
   # Actions
@@ -18,3 +35,4 @@ class HomePage < AbstractPage
     <%= ERB.new(File.read(File.expand_path('./partials/home_page_selector.tt', __dir__)), trim_mode: '-').result(binding) %>
   end
 end
+<%- end -%>

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

@@ -1,4 +1,22 @@
 require_relative '../abstract/abstract_page'
+<%- if automation == 'sparkling_ios' -%>
+class PdpPage < AbstractPage
+
+  # Actions
+
+  def add_to_cart_text
+    add_to_cart_button.wait_until(&:present?).text
+  end
+
+  private
+
+  # Elements
+
+  def add_to_cart_button
+    app.element(accessibility_id: 'Add To Cart button')
+  end
+end
+<%- else -%>
 
 class PdpPage < AbstractPage
 
@@ -16,3 +34,4 @@ class PdpPage < AbstractPage
     <%= ERB.new(File.read(File.expand_path('./partials/pdp_page_selector.tt', __dir__)), trim_mode: '-').result(binding) %>
   end
 end
+<%- end -%>

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

@@ -1,3 +1,19 @@
+<%- if automation == 'sparkling_ios' -%>
+require_relative '../../helpers/driver_helper'
+
+include DriverHelper
+
+Before do
+  AllureHelper.configure
+  app
+end
+
+After do |scenario|
+  app.screenshot.save("allure-results/screenshots/#{scenario.name}.png")
+  AllureHelper.add_screenshot(scenario.name)
+  app.close
+end
+<%- else -%>
 require_relative '../../helpers/driver_helper'
 
 include DriverHelper
@@ -11,4 +27,5 @@ After do |scenario|
   driver.screenshot("allure-results/screenshots/#{scenario.name}.png")
   AllureHelper.add_screenshot(scenario.name)
   driver.quit_driver
-end
+end
+<%- end -%>

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

@@ -1,3 +1,22 @@
+<%- if automation == 'sparkling_ios' -%>
+# frozen_string_literal: true
+
+require_relative '../../page_objects/pages/home_page'
+require_relative '../../page_objects/pages/pdp_page'
+
+Given("I'm an anonymous user on the home page") do
+    @home_page = HomePage.new(app)
+end
+
+When('I select one of the products') do
+    @home_page.go_to_backpack_pdp
+end
+
+When("I'm redirected to the product details page") do
+    pdp_page = PdpPage.new(app)
+    expect(pdp_page.add_to_cart_text).to eq 'Add To Cart'
+end
+<%- else -%>
 # frozen_string_literal: true
 
 require_relative '../../page_objects/pages/home_page'
@@ -15,3 +34,4 @@ When("I'm redirected to the product details page") do
     pdp_page = PdpPage.new(driver)
     expect(pdp_page.add_to_cart_text).to eq 'Add To Cart'
 end
+<%- end -%>

data/lib/generators/generator.rb

@@ -29,11 +29,11 @@ class Generator < Thor::Group
   end
 
   def mobile?
-    (args & %w[android ios cross_platform]).count.positive?
+    (args & %w[android ios cross_platform sparkling_ios]).count.positive?
   end
 
   def single_platform?
-    (args & %w[android ios]).count.positive?
+    (args & %w[android ios sparkling_ios]).count.positive?
   end
 
   def rspec?

data/lib/generators/menu_generator.rb

@@ -17,10 +17,7 @@ class MenuGenerator
 
   def generate_choice_menu
     prompt.select('Please select your automation framework') do |menu|
-      menu.choice :Appium, -> { choose_test_framework('appium') }
-      menu.choice :Selenium, -> { choose_test_framework('selenium') }
-      menu.choice :Watir, -> { choose_test_framework('watir') }
-      menu.choice :Quit, -> { exit }
+      select_automation_framework(menu)
     end
   end
 
@@ -30,6 +27,7 @@ class MenuGenerator
 
   def choose_test_framework(automation)
     return choose_mobile_platform if automation == 'appium'
+    return choose_sparkling_platform if automation == 'sparkling'
 
     select_test_framework(automation)
   end
@@ -45,6 +43,13 @@ class MenuGenerator
     system "cd #{name} && gem install bundler && bundle install"
   end
 
+  def choose_sparkling_platform
+    prompt.select('Please select your mobile platform') do |menu|
+      menu.choice :iOS, -> { choose_test_framework 'sparkling_ios' }
+      menu.choice :Quit, -> { exit }
+    end
+  end
+
   def choose_mobile_platform
     prompt.select('Please select your mobile platform') do |menu|
       menu.choice :iOS, -> { choose_test_framework 'ios' }
@@ -86,4 +91,12 @@ class MenuGenerator
       Quit: -> { exit }
     }
   end
+
+  def select_automation_framework(menu)
+    menu.choice :Appium, -> { choose_test_framework('appium') }
+    menu.choice :Selenium, -> { choose_test_framework('selenium') }
+    menu.choice 'Sparkling Watir', -> { choose_test_framework('sparkling') }
+    menu.choice :Watir, -> { choose_test_framework('watir') }
+    menu.choice :Quit, -> { exit }
+  end
 end

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

@@ -42,6 +42,23 @@ describe 'Login' do
     end
   end
 end
+<%- elsif automation == 'sparkling_ios' -%>
+require_relative '../helpers/spec_helper'
+require_relative '../page_objects/pages/home_page'
+require_relative '../page_objects/pages/pdp_page'
+
+class PdpSpec
+  describe 'PDP page' do
+
+    let(:home_page) { HomePage.new(app) }
+    let(:pdp_page) { PdpPage.new(app) }
+
+    it 'shows add to cart button' do
+      home_page.go_to_backpack_pdp
+      expect(pdp_page.add_to_cart_text).to eq 'Add To Cart'
+    end
+  end
+end
 <%- else -%>
 require_relative '../helpers/spec_helper'
 require_relative '../page_objects/pages/home_page'

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

@@ -30,3 +30,6 @@ gem 'ruby_raider', '~> 0.7.0'
 <% if %w[selenium watir].include? automation -%>
 gem 'webdrivers'
 <% end -%>
+<% if automation == 'sparkling_ios' -%>
+gem 'sparkling_watir'
+<% end -%>

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

@@ -52,6 +52,10 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 
 * Generating a visual testing framework with Cucumber, Applitools and Selenium
 
+* Generating a mobile testing framework with Rspec and Sparkling Watir for IOS
+
+* Generating a mobile testing framework with Cucumber and Sparkling Watir for IOS
+
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
 ***Remember to use the full path of the app that you download in the capabilities file***
 

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

@@ -1,3 +1,25 @@
+<%- if automation == 'sparkling_ios' -%>
+# frozen_string_literal: true
+require 'yaml'
+require 'sparkling_watir'
+
+module DriverHelper
+    def app
+      @app ||= create_app
+    end
+
+  private
+
+  def create_app
+    @app = SparklingWatir::App.new(caps: caps)
+  end
+
+  # :reek:UtilityFunction
+  def caps
+    YAML.load_file('config/capabilities.yml')
+  end
+end
+<%- else -%>
 # frozen_string_literal: true
 require 'yaml'
 <% if automation == 'selenium' -%>
@@ -29,3 +51,4 @@ module DriverHelper
   end
 <%- end -%>
 end
+<%- end -%>

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

@@ -1,3 +1,30 @@
+<%- if automation == 'sparkling_ios' -%>
+# frozen_string_literal: true
+
+require 'rspec'
+require_relative 'allure_helper'
+require_relative 'driver_helper'
+require 'sparkling_watir'
+
+module SpecHelper
+
+  AllureHelper.configure
+  RSpec.configure do |config|
+    config.formatter = AllureHelper.formatter
+    config.include(DriverHelper)
+    config.before(:each) do
+      app
+    end
+
+    config.after(:each) do
+      example_name = self.class.descendant_filtered_examples.first.description
+      app.screenshot.save("allure-results/screenshots/#{example_name}.png")
+      AllureHelper.add_screenshot example_name
+      app.close
+    end
+  end
+end
+<%- else -%>
 # frozen_string_literal: true
 
 require 'rspec'
@@ -27,4 +54,5 @@ module SpecHelper
       <%= ERB.new(File.read(File.expand_path('./partials/quit_driver.tt', __dir__)), trim_mode: '-').result(binding).strip! %>
     end
   end
-end
+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.4, Happy testing!'
+      puts 'The Ruby Raider version is 0.7.7, Happy testing!'
     end
 
     map 'v' => 'version'

data/lib/utilities/logger.rb

@@ -0,0 +1,26 @@
+require 'forwardable'
+require 'logger'
+
+module RubyRaider
+  module Logger
+    #
+    # @example Use logger manually
+    #   RubyRaider::Logger.debug('This is info message')
+    #   RubyRaider::Logger.warn('This is warning message')
+    #
+    class << self
+      extend Forwardable
+      def_delegators :logger, :fatal, :error, :warn, :info, :debug, :level, :level=, :formatter, :formatter=
+
+      def logger
+        @logger ||= begin
+          logger = ::Logger.new($stdout)
+          logger.progname = 'ruby_raider'
+          logger.level = ::Logger::WARN
+          logger.formatter = proc { |_severity, _datetime, _progname, msg| "#{msg}\n" }
+          logger
+        end
+      end
+    end
+  end
+end

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.7.5'
+  s.version     = '0.7.7'
   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']
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop-performance', '~> 1.15.0'
   s.add_development_dependency 'rubocop-rspec', '~> 2.9.0'
 
-  s.add_runtime_dependency 'faraday', '~> 1.2.0'
+  s.add_runtime_dependency 'faraday', '~> 2.7', '>= 2.7.10'
   s.add_runtime_dependency 'ruby-openai', '~> 3.5'
   s.add_runtime_dependency 'thor', '~> 1.2.1'
   s.add_runtime_dependency 'tty-prompt', '~> 0.23.1'

data/spec/common_generator_spec.rb

@@ -24,12 +24,6 @@ describe CommonGenerator do
     end
   end
 
-  shared_examples 'creates a config file' do |name|
-    it 'creates a config file' do
-      expect(File).to exist("#{name}/config/config.yml")
-    end
-  end
-
   shared_examples "doesn't create a config file" do |name|
     it "doesn't create a config file" do
       expect(File).not_to exist("#{name}/config/config.yml")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.7
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-15 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -114,14 +114,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.10
 - !ruby/object:Gem::Dependency
   name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
@@ -265,6 +271,7 @@ files:
 - lib/scaffolding/templates/helper.tt
 - lib/scaffolding/templates/page_object.tt
 - lib/scaffolding/templates/spec.tt
+- lib/utilities/logger.rb
 - lib/utilities/utilities.rb
 - ruby_raider.gemspec
 - spec/automation_generator_spec.rb