ruby_raider 0.2.2 → 0.2.5

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

@@ -3,17 +3,18 @@ source 'https://rubygems.org'
 gem 'activesupport'
 gem 'allure-rspec'
 gem 'allure-ruby-commons'
-<% if framework == 'cucumber' %>
+<% if framework == 'cucumber' -%>
 gem 'allure-cucumber'
-<% end %>
+<% end -%>
 gem 'parallel_split_test'
 gem 'parallel_tests'
 gem 'rake'
 gem '<%= framework %>'
-<% if framework == 'cucumber' %>
+<% if framework == 'cucumber' -%>
 gem 'rspec'
-<% end %>
+gem 'ruby_raider'
+<% end -%>
 <%= ERB.new(File.read(File.expand_path('./partials/automation_gems.tt', __dir__))).result(binding).strip! %>
-<% if %w[selenium watir].include? automation %>
+<% if %w[selenium watir].include? automation -%>
 gem 'webdrivers'
-<% end %>
+<% end -%>

data/lib/generators/templates/cucumber/env.tt

@@ -1,8 +1,8 @@
 <% case automation
- when 'selenium' %>
+ when 'selenium' -%>
 <%= ERB.new(File.read(File.expand_path('./partials/selenium_appium_env.tt', __dir__))).result(binding).strip! -%>
-<% when 'watir' %>
+<% when 'watir' -%>
 <%= ERB.new(File.read(File.expand_path('./partials/watir_env.tt', __dir__))).result(binding).strip! -%>
-<% else %>
+<% else -%>
 <%= ERB.new(File.read(File.expand_path('./partials/appium_env.tt', __dir__))).result(binding).strip! -%>
-<% end %>
+<% end -%>

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

@@ -2,12 +2,12 @@ require_relative '../../helpers/driver_helper'
 
 Before do
   Raider::AllureHelper.configure
-  Raider::DriverHelper.new_driver
-  Raider::DriverHelper.driver.start_driver
+  @driver = Raider::DriverHelper.new_driver
+  @driver.start_driver
 end
 
 After do |scenario|
-  Raider::DriverHelper.driver.screenshot("allure-results/screenshots/#{scenario.name}.png")
+  @driver.screenshot("allure-results/screenshots/#{scenario.name}.png")
   Raider::AllureHelper.add_screenshot(scenario.name)
-  Raider::DriverHelper.driver.quit_driver
+  @driver.quit_driver
 end

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

@@ -5,13 +5,16 @@ require_relative '../../page_objects/pages/home_page'
 require_relative '../../page_objects/pages/login_page'
 
 Given("I'm a registered user on the login page") do
-    HomePage.go_to_login
+    home_page = HomePage.new(@driver)
+    home_page.go_to_login
 end
 
 When('I login with my credentials') do
-    LoginPage.login('alice', 'mypassword')
+    login_page = LoginPage.new(@driver)
+    login_page.login('alice', 'mypassword')
 end
 
 When('I can see the main page') do
-    expect(ConfirmationPage.login_message).to eq 'You are logged in as alice'
+    confirmation_page = ConfirmationPage.new(@driver)
+    expect(confirmation_page.login_message).to eq 'You are logged in as alice'
 end

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

@@ -1,13 +1,11 @@
 require_relative '../../helpers/driver_helper'
 
 Before do
-  Raider::AllureHelper.configure
-  Raider::DriverHelper.new_driver
+  @driver = Raider::DriverHelper.new_driver
 end
 
 After do |scenario|
-  driver = Raider::DriverHelper.driver
-  driver.save_screenshot("allure-results/screenshots/#{scenario.name}.png")
+  @driver.save_screenshot("allure-results/screenshots/#{scenario.name}.png")
   Raider::AllureHelper.add_screenshot(scenario.name)
-  driver.quit
+  @driver.quit
 end

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

@@ -2,12 +2,11 @@ require_relative '../../helpers/browser_helper'
 
 Before do
   Raider::AllureHelper.configure
-  Raider::BrowserHelper.new_browser
+  @browser = Raider::BrowserHelper.new_browser
 end
 
 After do |scenario|
-  browser = Raider::BrowserHelper.browser
-  browser.screenshot.save("allure-results/screenshots/#{scenario.name}.png")
+  @browser.screenshot.save("allure-results/screenshots/#{scenario.name}.png")
   Raider::AllureHelper.add_screenshot(scenario.name)
-  browser.quit
+  @browser.quit
 end

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

@@ -3,13 +3,14 @@
 require_relative '../../page_objects/pages/login_page'
 
 Given("I'm a registered user on the login page") do
-    LoginPage.visit
+    @login_page = LoginPage.new(<% if automation == 'watir'%>@browser<% else %>@driver<% end %>)
+    @login_page.visit
 end
 
 When('I login with my credentials') do
-    LoginPage.login('aguspe', '12341234')
+    @login_page.login('aguspe', '12341234')
 end
 
 When('I can see the main page') do
-    expect(LoginPage.header.customer_name).to eq 'Welcome back Agustin'
+    expect(@login_page.header.customer_name).to eq 'Welcome back Agustin'
 end

data/lib/generators/templates/cucumber/steps.tt

@@ -1,5 +1,5 @@
-<% if %w[selenium watir].include? automation %>
+<% if %w[selenium watir].include? automation -%>
 <%= ERB.new(File.read(File.expand_path('./partials/web_steps.tt', __dir__))).result(binding).strip! -%>
-<% else %>
+<% else -%>
 <%= ERB.new(File.read(File.expand_path('./partials/mobile_steps.tt', __dir__))).result(binding).strip! -%>
-<% end %>
+<% end -%>

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-<%= ERB.new(File.read(File.expand_path('./partials/allure_requirements.tt', __dir__))).result(binding).strip! %>
+<%= ERB.new(File.read(File.expand_path('./partials/allure_requirements.tt', __dir__))).result(binding).strip! -%>
 <% allure = ERB.new(File.read(File.expand_path('./partials/allure_imports.tt', __dir__))).result(binding).strip! %>
 
 module Raider

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-<% if automation == 'selenium' %>
+<% if automation == 'selenium' -%>
 require 'webdrivers'
-<% else %>
+<% else -%>
 require 'appium_lib'
-<% end %>
+<% end -%>
 require_relative 'driver_helper'
 
 module Raider

data/lib/generators/templates/helpers/partials/require_automation.tt

@@ -1,5 +1,3 @@
 <% if automation == 'selenium' %>
     require_relative 'selenium_helper'
-<% elsif automation == 'watir' %>
-    require_relative 'watir_helper'
 <% end %>

data/lib/generators/templates/helpers/partials/screenshot.tt

@@ -1,8 +1,8 @@
 <% case automation
  when 'selenium' %>
-driver.save_screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
+@driver.save_screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
 <% when 'watir' %>
-browser.save_screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
+@browser.save_screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
 <% else %>
-driver.screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
+@driver.screenshot("allure-results/screenshots/#{example_name}.png") if status == :failed
 <% end %>

data/lib/generators/templates/helpers/partials/select_driver.tt

@@ -0,0 +1,8 @@
+<% if automation == 'watir' %>
+@browser = BrowserHelper.new_browser
+<% else %>
+@driver = DriverHelper.new_driver
+<% end %>
+<% if %w[appium_ios].include? automation %>
+@driver.start_driver
+<% end %>

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

@@ -1,15 +1,14 @@
 # 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! %>
-  require_relative 'pom_helper'
-  <% if automation == 'watir' %>
+<% if automation == 'watir' -%>
   require_relative 'browser_helper'
-  <% else %>
+<% else -%>
   require_relative 'driver_helper'
-  <% end %>
+<% end -%>
   require_relative 'allure_helper'
 end

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

@@ -2,11 +2,11 @@
 
 require 'rspec'
 require_relative 'allure_helper'
-<% if automation == 'watir' %>
+<% if automation == 'watir' -%>
 require_relative 'browser_helper'
-<% else %>
+<% else -%>
 require_relative 'driver_helper'
-<% end %>
+<% end -%>
 
 module Raider
   module SpecHelper
@@ -15,14 +15,7 @@ module Raider
     RSpec.configure do |config|
       config.formatter = AllureHelper.formatter
       config.before(:each) do
-        <% if automation == 'watir' %>
-        BrowserHelper.new_browser
-        <% else %>
-        DriverHelper.new_driver
-        <% end %>
-        <% if %w[appium_ios].include? automation %>
-        DriverHelper.driver.start_driver
-        <% end %>
+        <%= ERB.new(File.read(File.expand_path('./partials/select_driver.tt', __dir__))).result(binding).strip! %>
       end
 
       config.after(:each) do

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

@@ -1,25 +1,34 @@
-<% if %w[selenium watir].include? automation %>
+<% if %w[selenium watir].include? automation -%>
 require_relative 'base_spec'
 require_relative '../page_objects/pages/login_page'
 
-class LoginSpec < BaseSpec
-  describe 'Login' do
-    before(:each) do
-      LoginPage.visit
-    end
+describe 'Login' do
+  let(:user_name) { 'aguspe' }
+  let(:login_page) { LoginPage.new(<% if automation == 'watir' -%>@browser<% else -%>@driver<% end -%>) }
+  subject { login_page.header.customer_name }
+
+  before(:example) do
+    login_page.visit
+    login_page.login(user_name, password)
+  end
 
-    it 'can login with valid credentials' do
-      LoginPage.login('aguspe', '12341234')
-      expect(LoginPage.header.customer_name).to eq 'Welcome back Agustin'
+  context 'with right credentials' do
+    let(:password) { '12341234' }
+
+    it 'can successfully log in' do
+      expect(subject).to eq 'Welcome back Agustin'
     end
+  end
+
+  context 'with wrong credentials' do
+    let(:password) { 'wrongPassword' }
 
-    it 'cannot login with wrong credentials' do
-      LoginPage.login('aguspe', 'wrongPassword')
-      expect(LoginPage.header.customer_name).to be_empty
+    it 'it cannot login in' do
+      expect(subject).to be_empty
     end
   end
 end
-<% else %>
+<% else -%>
 require_relative '../page_objects/pages/confirmation_page'
 require_relative '../page_objects/pages/home_page'
 require_relative 'base_spec'
@@ -27,11 +36,18 @@ require_relative '../page_objects/pages/login_page'
 
 class LoginSpec < BaseSpec
   describe 'Login' do
-    it 'Login with valid credentials' do
-      HomePage.go_to_login
-      LoginPage.login('alice', 'mypassword')
-      expect(ConfirmationPage.login_message).to eq 'You are logged in as alice'
+
+    let(:user_name) { 'alice' }
+    let(:password) { 'mypassword' }
+    let(:login_page) { LoginPage.new(@driver) }
+    let(:home_page) { HomePage.new(@driver) }
+    let(:confirmation_page) { ConfirmationPage.new(@driver) }
+
+    it 'can login' do
+      home_page.go_to_login
+      login_page.login(user_name, password)
+      expect(confirmation_page.login_message).to eq 'You are logged in as alice'
     end
   end
 end
-<% end %>
+<% end -%>

data/lib/ruby_raider.rb

@@ -1,12 +1,41 @@
-# frozen_string_literal: true
-
+require 'thor'
 require_relative 'generators/menu_generator'
+require_relative '../lib/scaffolding/scaffolding'
+require_relative '../lib/utilities/utilities'
 
-# Main module to load all the generators
-module RubyRaider
-  module_function
-
-  def generate_project(project_name)
+class RubyRaider < Thor
+  desc "new [PROJECT_NAME]", "Creates a new framework based on settings picked"
+  def new(project_name)
     MenuGenerator.generate_choice_menu(project_name)
   end
-end
+
+  desc "page [PAGE_NAME]", "Creates a new page object"
+  def page(name)
+    Scaffolding.new([name]).generate_class
+  end
+
+  desc "feature [FEATURE_NAME]", "Creates a new feature"
+  def feature(name)
+    Scaffolding.new([name]).generate_feature
+  end
+
+  desc "spec [SPEC_NAME]", "Creates a new spec"
+  def spec(name)
+    Scaffolding.new([name]).generate_spec
+  end
+
+  desc "path [PATH]", "Sets the default path for scaffolding"
+  def path(default_path)
+    Utilities.path = default_path
+  end
+
+  desc "url [URL]", "Sets the default url for a project"
+  def url(default_url)
+    Utilities.url = default_url
+  end
+
+  desc "browser [BROWSER]", "Sets the default browser for a project"
+  def browser(default_browser)
+    Utilities.browser = default_browser
+  end
+end

data/lib/scaffolding/scaffolding.rb

@@ -0,0 +1,23 @@
+require 'thor'
+
+class Scaffolding < Thor::Group
+  include Thor::Actions
+
+  argument :name
+
+  def self.source_root
+    File.dirname(__FILE__) + '/templates'
+  end
+
+  def generate_class
+    template('page_object.tt', "page_objects/pages/#{name}_page.rb")
+  end
+
+  def generate_feature
+    template('feature.tt', "features/#{name}.feature")
+  end
+
+  def generate_spec
+    template('spec.tt', "./spec/#{name}_page.rb")
+  end
+end

data/lib/scaffolding/templates/feature.tt

@@ -0,0 +1,6 @@
+Feature: <%= name %>
+
+Scenario: Scenario name
+    Given I am
+    When I do
+    Then I see

data/lib/scaffolding/templates/page_object.tt

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative '../abstract/abstract_page'
+
+class <%= name.split('_').map {|word| word.capitalize }.join + 'Page' %> < AbstractPage
+
+  #Actions
+
+  private
+
+  # Elements
+end

data/lib/scaffolding/templates/spec.tt

@@ -0,0 +1,5 @@
+require_relative 'base_spec'
+require_relative '../page_objects/pages/<%= name %>_page'
+
+describe <%= name.split('_').map {|word| word.capitalize }.join + 'Page' %> do
+end

data/lib/utilities/utilities.rb

@@ -0,0 +1,17 @@
+require 'thor'
+
+class Utilities < Thor::Group
+  include Thor::Actions
+
+  def browser=(browser)
+
+  end
+
+  def path=(path)
+
+  end
+
+  def url=(url)
+
+  end
+end

data/ruby_raider.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.2.2'
+  s.version     = '0.2.5'
   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.description = 'This gem has everything you need to start working with test automation'
   s.authors     = ['Agustin Pequeno']
   s.email       = 'agustin.pe94@gmail.com'
   s.homepage = 'http://github.com/aguspe/ruby_raider'

data/spec/cucumber_generator_spec.rb

@@ -22,6 +22,10 @@ describe RubyRaider::CucumberGenerator do
       expect(File.exist?("#{@name}/features/support/env.rb")).to be_truthy
     end
 
+    it 'does not create a spec file' do
+      expect(File.exist?("#{@name}/spec/login_spec.rb")).to be_falsey
+    end
+
     after(:all) do
       FileUtils.rm_rf(@name)
     end
@@ -44,6 +48,10 @@ describe RubyRaider::CucumberGenerator do
     it 'creates an env file' do
       expect(File.exist?("#{@name}/features/support/env.rb")).to be_truthy
     end
+
+    after(:all) do
+      FileUtils.rm_rf(@name)
+    end
   end
 
   context 'with appium' do

data/spec/helpers_generator_spec.rb

@@ -14,10 +14,6 @@ describe RubyRaider::HelpersGenerator do
       expect(File.exist?("#{@name}/helpers/raider.rb")).to be_truthy
     end
 
-    it 'creates a pom helper file' do
-      expect(File.exist?("#{@name}/helpers/pom_helper.rb")).to be_truthy
-    end
-
     it 'creates an allure helper file' do
       expect(File.exist?("#{@name}/helpers/allure_helper.rb")).to be_truthy
     end
@@ -45,10 +41,6 @@ describe RubyRaider::HelpersGenerator do
       expect(File.exist?("#{@name}/helpers/browser_helper.rb")).to be_truthy
     end
 
-    it 'creates a pom helper file' do
-      expect(File.exist?("#{@name}/helpers/pom_helper.rb")).to be_truthy
-    end
-
     it 'creates a raider file' do
       expect(File.exist?("#{@name}/helpers/raider.rb")).to be_truthy
     end
@@ -72,10 +64,6 @@ describe RubyRaider::HelpersGenerator do
       expect(File.exist?("#{@name}/helpers/raider.rb")).to be_truthy
     end
 
-    it 'creates a pom helper file' do
-      expect(File.exist?("#{@name}/helpers/pom_helper.rb")).to be_truthy
-    end
-
     it 'creates an allure helper file' do
       expect(File.exist?("#{@name}/helpers/allure_helper.rb")).to be_truthy
     end
@@ -94,10 +82,6 @@ describe RubyRaider::HelpersGenerator do
         RubyRaider::HelpersGenerator.new(['selenium', 'cucumber', @name]).invoke_all
       end
 
-      it 'creates a pom helper file' do
-        expect(File.exist?("#{@name}/helpers/pom_helper.rb")).to be_truthy
-      end
-
       it 'creates an allure helper file' do
         expect(File.exist?("#{@name}/helpers/allure_helper.rb")).to be_truthy
       end
@@ -106,6 +90,10 @@ describe RubyRaider::HelpersGenerator do
         expect(File.exist?("#{@name}/helpers/driver_helper.rb")).to be_truthy
       end
 
+      it 'does not create a spec helper' do
+        expect(File.exist?("#{@name}/helpers/spec_helper.rb")).to be_falsey
+      end
+
       after(:all) do
         FileUtils.rm_rf(@name)
       end
@@ -125,6 +113,10 @@ describe RubyRaider::HelpersGenerator do
         expect(File.exist?("#{@name}/helpers/raider.rb")).to be_truthy
       end
 
+      it 'does not create a spec helper' do
+        expect(File.exist?("#{@name}/helpers/spec_helper.rb")).to be_falsey
+      end
+
       after(:all) do
         FileUtils.rm_rf(@name)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-08 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -108,8 +108,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.1
-description: This gem contents everything you need to start doing web automation in
-  one simple package
+description: This gem has everything you need to start working with test automation
 email: agustin.pe94@gmail.com
 executables:
 - raider
@@ -138,8 +137,8 @@ files:
 - lib/generators/templates/automation/home_page.tt
 - lib/generators/templates/automation/login_page.tt
 - lib/generators/templates/automation/partials/appium_login.tt
-- lib/generators/templates/automation/partials/driver_selector.tt
 - lib/generators/templates/automation/partials/element.tt
+- lib/generators/templates/automation/partials/initialize_selector.tt
 - lib/generators/templates/automation/partials/require_raider.tt
 - lib/generators/templates/automation/partials/selenium_login.tt
 - lib/generators/templates/automation/partials/url_methods.tt
@@ -163,19 +162,22 @@ files:
 - lib/generators/templates/helpers/driver_helper.tt
 - lib/generators/templates/helpers/partials/allure_imports.tt
 - lib/generators/templates/helpers/partials/allure_requirements.tt
-- lib/generators/templates/helpers/partials/driver_requirements.tt
 - lib/generators/templates/helpers/partials/new_driver.tt
 - lib/generators/templates/helpers/partials/quit_driver.tt
 - lib/generators/templates/helpers/partials/require_automation.tt
 - lib/generators/templates/helpers/partials/screenshot.tt
-- lib/generators/templates/helpers/pom_helper.tt
+- lib/generators/templates/helpers/partials/select_driver.tt
 - lib/generators/templates/helpers/raider_helper.tt
 - lib/generators/templates/helpers/selenium_helper.tt
 - lib/generators/templates/helpers/spec_helper.tt
-- lib/generators/templates/helpers/watir_helper.tt
 - lib/generators/templates/rspec/base_spec.tt
 - lib/generators/templates/rspec/spec.tt
 - lib/ruby_raider.rb
+- lib/scaffolding/scaffolding.rb
+- lib/scaffolding/templates/feature.tt
+- lib/scaffolding/templates/page_object.tt
+- lib/scaffolding/templates/spec.tt
+- lib/utilities/utilities.rb
 - ruby_raider.gemspec
 - spec/automation_generator_spec.rb
 - spec/common_generator_spec.rb

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

@@ -1,9 +0,0 @@
-<% if automation == 'watir' %>
-  def browser
-    Raider::BrowserHelper.browser
-  end
-<% else %>
-  def driver
-    Raider::DriverHelper.driver
-  end
-<% end %>

data/lib/generators/templates/helpers/partials/driver_requirements.tt

@@ -1,14 +0,0 @@
-  def requirements
-    case automation
-    when 'selenium'
-        require 'selenium-webdriver'
-        require 'webdrivers'
-
-    when 'watir'
-
-        require 'watir'
-        require 'webdrivers'
-    else
-      "require 'appium_lib'"
-    end
-  end

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-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