ruby_raider 0.1.2 → 0.1.7

data/lib/generators/templates/helpers/selenium_helper_template.rb

@@ -0,0 +1,42 @@
+require_relative '../template'
+
+class SeleniumHelperTemplate < Template
+  def body
+    <<~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
+  end
+end

data/lib/generators/templates/helpers/spec_helper_template.rb

@@ -0,0 +1,35 @@
+require_relative '../template'
+
+class SpecHelperTemplate < Template
+  def body
+    <<~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
+  end
+end

data/lib/generators/templates/helpers/watir_helper_template.rb

@@ -0,0 +1,24 @@
+require_relative '../template'
+
+class WatirHelperTemplate < Template
+  def body
+    <<~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
+  end
+end

data/lib/generators/templates/rspec/base_spec_template.rb

@@ -0,0 +1,13 @@
+require_relative '../template'
+
+class BaseSpecTemplate < Template
+  def body
+    <<~EOF
+       require_relative '../helpers/raider'
+
+      class BaseSpec
+        include Raider::SpecHelper
+      end
+    EOF
+  end
+end

data/lib/generators/templates/rspec/example_spec_template.rb

@@ -0,0 +1,33 @@
+require_relative '../template'
+
+class ExampleSpecTemplate < Template
+  def body
+    <<~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
+  end
+end

data/lib/generators/templates/template.rb

@@ -0,0 +1,14 @@
+require 'erb'
+
+class Template
+  def initialize(args = {})
+    @automation = args[:automation]
+    @name = args[:name]
+    @framework = args[:framework]
+  end
+
+  def parsed_body
+    parsed_body = ERB.new body
+    parsed_body.result(binding)
+  end
+end

data/lib/ruby_raider.rb

@@ -5,7 +5,7 @@ require_relative 'generators/projects/rspec_project_generator'
 
 module RubyRaider
   extend self
-    def generate_project(project_name)
-      MenuGenerator.generate_choice_menu(project_name)
-    end
+  def generate_project(project_name)
+    MenuGenerator.generate_choice_menu(project_name)
+  end
 end

data/ruby_raider.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.1.2'
+  s.version     = '0.1.7'
   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']
@@ -12,7 +12,8 @@ Gem::Specification.new do |s|
   s.files  = `git ls-files -z`.split("\x0")
   s.bindir = 'bin'
   s.executables << 'raider'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake', '~> 13.0.6'
+  s.add_development_dependency 'rspec', '~> 3.11.0'
 
-  s.add_runtime_dependency 'highline'
+  s.add_runtime_dependency 'highline', '~> 2.0.3'
 end

data/spec/automation_file_generator_spec.rb

@@ -0,0 +1,34 @@
+require_relative '../lib/generators/files/automation_file_generator'
+require_relative 'spec_helper'
+
+describe RubyRaider::AutomationFileGenerator do
+  before(:all) do
+    @name = 'Rspec-watir-1'
+    RubyRaider::RspecProjectGenerator.generate_rspec_project(@name, automation: 'watir')
+  end
+
+  it 'creates a login page file' do
+    expect(File.exist?("#{@name}/page_objects/pages/login_page.rb")).to be_truthy
+  end
+
+  it 'creates an abstract page file' do
+    expect(File.exist?("#{@name}/page_objects/abstract/abstract_page.rb")).to be_truthy
+  end
+
+  it 'creates an abstract component file' do
+    expect(File.exist?("#{@name}/page_objects/abstract/abstract_component.rb")).to be_truthy
+  end
+
+  it 'creates a component file' do
+    expect(File.exist?("#{@name}/page_objects/components/header_component.rb")).to be_truthy
+  end
+
+  it 'creates a gemfile file' do
+    expect(File.exist?("#{@name}/Gemfile")).to be_truthy
+  end
+
+  after(:all) do
+    FileUtils.rm_rf(@name)
+  end
+end
+

data/spec/common_file_generator_spec.rb

@@ -2,16 +2,25 @@ require_relative '../lib/generators/files/common_file_generator'
 require_relative 'spec_helper'
 
 describe RubyRaider::CommonFileGenerator do
+  before(:all) do
+    @name = 'Cucumber-watir-1'
+    RubyRaider::CucumberProjectGenerator.generate_cucumber_project(@name, automation: 'watir')
+  end
+
   it 'creates a config file' do
-    expect(File.exist?("#{@project_name}/config/config.yml")).to be_truthy
+    expect(File.exist?("#{@name}/config/config.yml")).to be_truthy
   end
 
   it 'creates a rake file' do
-    expect(File.exist?("#{@project_name}/Rakefile")).to be_truthy
+    expect(File.exist?("#{@name}/Rakefile")).to be_truthy
   end
 
   it 'creates a readMe file' do
-    expect(File.exist?("#{@project_name}/Readme.md")).to be_truthy
+    expect(File.exist?("#{@name}/Readme.md")).to be_truthy
+  end
+
+  after(:all) do
+    FileUtils.rm_rf(@name)
   end
 end
 

data/spec/cucumber_file_generator_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../lib/generators/files/rspec_file_generator'
+require_relative 'spec_helper'
+
+describe RubyRaider::RspecFileGenerator do
+  before(:all) do
+    @name = 'Cucumber-watir-2'
+    RubyRaider::CucumberProjectGenerator.generate_cucumber_project(@name, automation: 'watir')
+  end
+
+  it 'creates a feature file' do
+    expect(File.exist?("#{@name}/features/login.feature")).to be_truthy
+  end
+
+  it 'creates a step definitions file' do
+    expect(File.exist?("#{@name}/features/step_definitions/login_steps.rb")).to be_truthy
+  end
+
+  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
+

data/spec/cucumber_project_generator_spec.rb

@@ -0,0 +1,60 @@
+require_relative 'spec_helper'
+
+describe RubyRaider::CucumberProjectGenerator do
+  before(:all) do
+    @name = 'Cucumber'
+    RubyRaider::CucumberProjectGenerator.generate_cucumber_project(@name, automation: 'selenium')
+  end
+
+  it 'creates a project folder' do
+    expect(Dir.exist?(@name)).to be_truthy
+  end
+
+  it 'creates a features folder' do
+    expect(Dir.exist?("#{@name}/features")).to be_truthy
+  end
+
+  it 'creates a config folder' do
+    expect(Dir.exist?("#{@name}/config")).to be_truthy
+  end
+
+  it 'creates a page_objects object folder' do
+    expect(Dir.exist?("#{@name}/page_objects")).to be_truthy
+  end
+
+  it 'creates an allure results folder' do
+    expect(Dir.exist?("#{@name}/allure-results")).to be_truthy
+  end
+
+  it 'creates a step definitions folder' do
+    expect(Dir.exist?("#{@name}/features/step_definitions")).to be_truthy
+  end
+
+  it 'creates a support folder' do
+    expect(Dir.exist?("#{@name}/features/support")).to be_truthy
+  end
+
+  it 'creates a helpers folder' do
+    expect(Dir.exist?("#{@name}/features/support/helpers")).to be_truthy
+  end
+
+  it 'creates an abstract folder' do
+    expect(Dir.exist?("#{@name}/page_objects/abstract")).to be_truthy
+  end
+
+  it 'creates a pages folder' do
+    expect(Dir.exist?("#{@name}/page_objects/pages")).to be_truthy
+  end
+
+  it 'creates a components folder' do
+    expect(Dir.exist?("#{@name}/page_objects/components")).to be_truthy
+  end
+
+  it 'creates a screenshot folder' do
+    expect(Dir.exist?("#{@name}/allure-results/screenshots")).to be_truthy
+  end
+
+  after(:all) do
+    FileUtils.rm_rf(@name)
+  end
+end

data/spec/helpers_file_generator_spec.rb

@@ -2,28 +2,70 @@ 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
+  context 'When the users selects rspec' do
+    before(:all) do
+      @name = 'Rspec-watir-2'
+      RubyRaider::RspecProjectGenerator.generate_rspec_project(@name, automation: 'selenium')
+    end
 
-  it 'creates an allure helper file' do
-    expect(File.exist?("#{@project_name}/helpers/allure_helper.rb")).to be_truthy
-  end
+    it 'creates a raider file' do
+      expect(File.exist?("#{@name}/helpers/raider.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 an allure helper file' do
+      expect(File.exist?("#{@name}/helpers/allure_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 driver helper file', :watir do
+      expect(File.exist?("#{@name}/helpers/driver_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 spec helper file' do
+      expect(File.exist?("#{@name}/helpers/spec_helper.rb")).to be_truthy
+    end
+
+    it 'creates a watir helper file' do
+      expect(File.exist?("#{@name}/helpers/allure_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
+    after(:all) do
+      FileUtils.rm_rf(@name)
+    end
   end
 
-  it 'creates a watir helper file' do
-    expect(File.exist?("#{@project_name}/helpers/allure_helper.rb")).to be_truthy
+  context 'when the user selects cucumber' do
+    before(:all) do
+      @name = 'Cucumber-watir-3'
+      RubyRaider::CucumberProjectGenerator.generate_cucumber_project(@name, automation: 'watir')
+    end
+
+    it 'creates a raider file' do
+      expect(File.exist?("#{@name}/features/support/helpers/raider.rb")).to be_truthy
+    end
+
+    it 'creates an allure helper file' do
+      expect(File.exist?("#{@name}/features/support/helpers/allure_helper.rb")).to be_truthy
+    end
+
+    it 'creates a browser helper file', :watir do
+      expect(File.exist?("#{@name}/features/support/helpers/browser_helper.rb")).to be_truthy
+    end
+
+    it 'creates a pom helper file' do
+      expect(File.exist?("#{@name}/features/support/helpers/pom_helper.rb")).to be_truthy
+    end
+
+    it 'creates a watir helper file' do
+      expect(File.exist?("#{@name}/features/support/helpers/allure_helper.rb")).to be_truthy
+    end
+
+    after(:all) do
+      FileUtils.rm_rf(@name)
+    end
   end
 end
 

data/spec/rspec_file_generator_spec.rb

@@ -2,11 +2,20 @@ require_relative '../lib/generators/files/rspec_file_generator'
 require_relative 'spec_helper'
 
 describe RubyRaider::RspecFileGenerator do
+  before(:all) do
+    @name = 'Rspec-watir-3'
+    RubyRaider::RspecProjectGenerator.generate_rspec_project(@name, automation: 'watir')
+  end
+
   it 'creates a spec file' do
-    expect(File.exist?("#{@project_name}/spec/login_page_spec.rb")).to be_truthy
+    expect(File.exist?("#{@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
+    expect(File.exist?("#{@name}/spec/base_spec.rb")).to be_truthy
+  end
+
+  after(:all) do
+    FileUtils.rm_rf(@name)
   end
 end

data/spec/rspec_project_generator_spec.rb

@@ -1,39 +1,48 @@
 require_relative 'spec_helper'
 
 describe RubyRaider::RspecProjectGenerator do
+  before(:all) do
+    @name = 'Rspec'
+    RubyRaider::RspecProjectGenerator.generate_rspec_project(@name, automation: 'selenium')
+  end
+
   it 'creates a project folder' do
-    expect(Dir.exist?(@project_name)).to be_truthy
+    expect(Dir.exist?(@name)).to be_truthy
   end
 
   it 'creates a spec folder' do
-    expect(Dir.exist?("#{@project_name}/spec")).to be_truthy
+    expect(Dir.exist?("#{@name}/spec")).to be_truthy
   end
 
   it 'creates a page objects folder' do
-    expect(Dir.exist?("#{@project_name}/page_objects")).to be_truthy
+    expect(Dir.exist?("#{@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
+    expect(Dir.exist?("#{@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
+    expect(Dir.exist?("#{@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
+    expect(Dir.exist?("#{@name}/page_objects/components")).to be_truthy
   end
 
   it 'creates a helper folder' do
-    expect(Dir.exist?("#{@project_name}/helpers")).to be_truthy
+    expect(Dir.exist?("#{@name}/helpers")).to be_truthy
   end
 
   it 'creates a data folder' do
-    expect(Dir.exist?("#{@project_name}/data")).to be_truthy
+    expect(Dir.exist?("#{@name}/data")).to be_truthy
   end
 
   it 'creates a config folder' do
-    expect(Dir.exist?("#{@project_name}/config")).to be_truthy
+    expect(Dir.exist?("#{@name}/config")).to be_truthy
+  end
+
+  after(:all) do
+    FileUtils.rm_rf(@name)
   end
 end

data/spec/spec_helper.rb

@@ -1,14 +1,4 @@
 require_relative '../lib/generators/projects/rspec_project_generator'
+require_relative '../lib/generators/projects/cucumber_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
+require 'rspec'

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-09 00:00:00.000000000 Z
+date: 2022-04-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        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
@@ -47,29 +61,52 @@ 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/files/selenium_file_generator.rb
-- lib/generators/files/watir_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/generators/templates/automation/abstract_component_template.rb
+- lib/generators/templates/automation/abstract_page_template.rb
+- lib/generators/templates/automation/component_template.rb
+- lib/generators/templates/automation/page_template.rb
+- lib/generators/templates/common/config_template.rb
+- lib/generators/templates/common/gemfile_template.rb
+- lib/generators/templates/common/rake_file_template.rb
+- lib/generators/templates/common/read_me_template.rb
+- lib/generators/templates/cucumber/env_template.rb
+- lib/generators/templates/cucumber/example_feature_template.rb
+- lib/generators/templates/cucumber/example_steps_template.rb
+- lib/generators/templates/helpers/allure_helper_template.rb
+- lib/generators/templates/helpers/browser_helper_template.rb
+- lib/generators/templates/helpers/driver_helper_template.rb
+- lib/generators/templates/helpers/pom_helper_template.rb
+- lib/generators/templates/helpers/raider_helper_template.rb
+- lib/generators/templates/helpers/selenium_helper_template.rb
+- lib/generators/templates/helpers/spec_helper_template.rb
+- lib/generators/templates/helpers/watir_helper_template.rb
+- lib/generators/templates/rspec/base_spec_template.rb
+- lib/generators/templates/rspec/example_spec_template.rb
+- lib/generators/templates/template.rb
 - lib/ruby_raider.rb
 - ruby_raider.gemspec
+- spec/automation_file_generator_spec.rb
 - spec/common_file_generator_spec.rb
+- spec/cucumber_file_generator_spec.rb
+- spec/cucumber_project_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/selenium_file_generator_spec.rb
 - spec/spec_helper.rb
-- spec/watir_file_generator_spec.rb
 homepage: http://github.com/aguspe/ruby_raider
 licenses:
 - MIT