ruby_raider 0.1.7 → 0.2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-03 00:00:00.000000000 Z
+date: 2022-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 description: This gem contents everything you need to start doing web automation in
   one simple package
 email: agustin.pe94@gmail.com
@@ -61,51 +117,71 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".reek.yml"
+- ".rubocop.yml"
 - 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/automation_generator.rb
+- lib/generators/common_generator.rb
+- lib/generators/cucumber_generator.rb
+- lib/generators/generator.rb
+- lib/generators/helper_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/generators/rspec_generator.rb
+- lib/generators/templates/automation/abstract_component.tt
+- lib/generators/templates/automation/abstract_page.tt
+- lib/generators/templates/automation/appium_settings.tt
+- lib/generators/templates/automation/component.tt
+- lib/generators/templates/automation/confirmation_page.tt
+- 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/require_raider.tt
+- lib/generators/templates/automation/partials/selenium_login.tt
+- lib/generators/templates/automation/partials/url_methods.tt
+- lib/generators/templates/automation/partials/visit_method.tt
+- lib/generators/templates/automation/partials/watir_login.tt
+- lib/generators/templates/common/config.tt
+- lib/generators/templates/common/gemfile.tt
+- lib/generators/templates/common/partials/automation_gems.tt
+- lib/generators/templates/common/rakefile.tt
+- lib/generators/templates/common/read_me.tt
+- lib/generators/templates/cucumber/env.tt
+- lib/generators/templates/cucumber/feature.tt
+- lib/generators/templates/cucumber/partials/appium_env.tt
+- lib/generators/templates/cucumber/partials/mobile_steps.tt
+- lib/generators/templates/cucumber/partials/selenium_appium_env.tt
+- lib/generators/templates/cucumber/partials/watir_env.tt
+- lib/generators/templates/cucumber/partials/web_steps.tt
+- lib/generators/templates/cucumber/steps.tt
+- lib/generators/templates/helpers/allure_helper.tt
+- lib/generators/templates/helpers/browser_helper.tt
+- 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/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
 - 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/rspec_file_generator_spec.rb
-- spec/rspec_project_generator_spec.rb
+- spec/automation_generator_spec.rb
+- spec/common_generator_spec.rb
+- spec/cucumber_generator_spec.rb
+- spec/helpers_generator_spec.rb
+- spec/rspec_generator_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/aguspe/ruby_raider
 licenses:
@@ -126,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A gem to make setup and start of UI automation projects easier

data/lib/generators/files/automation_file_generator.rb

@@ -1,38 +0,0 @@
-require_relative 'file_generator'
-require_relative '../templates/automation/abstract_page_template'
-require_relative '../templates/automation/abstract_component_template'
-require_relative '../templates/automation/component_template'
-require_relative '../templates/automation/page_template'
-
-module RubyRaider
-  class AutomationFileGenerator < FileGenerator
-    class << self
-      def generate_automation_files(name, automation, framework)
-        generate_example_page(automation, name)
-        generate_abstract_page(automation, framework, name)
-        generate_example_component(name)
-        generate_abstract_component(framework, name)
-      end
-
-      def generate_example_page(automation, name)
-        generate_file('login_page.rb', "#{name}/page_objects/pages",
-                      PageTemplate.new(automation: automation, name: name).parsed_body)
-      end
-
-      def generate_abstract_page(automation, framework, name)
-        generate_file('abstract_page.rb', "#{name}/page_objects/abstract",
-                      AbstractPageTemplate.new(automation: automation, framework: framework, name: name).parsed_body)
-      end
-
-      def generate_example_component(name)
-        generate_file('header_component.rb',"#{name}/page_objects/components",
-        ComponentTemplate.new.parsed_body)
-      end
-
-      def generate_abstract_component(framework, name)
-        generate_file('abstract_component.rb',"#{name}/page_objects/abstract",
-                      AbstractComponentTemplate.new(framework: framework).parsed_body)
-      end
-    end
-  end
-end

data/lib/generators/files/common_file_generator.rb

@@ -1,34 +0,0 @@
-require_relative '../templates/common/config_template'
-require_relative '../templates/common/gemfile_template'
-require_relative '../templates/common/rake_file_template'
-require_relative '../templates/common/read_me_template'
-require_relative 'file_generator'
-
-module RubyRaider
-  class CommonFileGenerator < FileGenerator
-    class << self
-      def generate_common_files(name, framework)
-        generate_config_file(name)
-        generate_rake_file(name)
-        generate_readme_file(name)
-        generate_gemfile(framework, name)
-      end
-
-      def generate_readme_file(name)
-        generate_file('Readme.md', name.to_s, ReadMeTemplate.new.parsed_body)
-      end
-
-      def generate_config_file(name)
-        generate_file('config.yml', "#{name}/config", ConfigTemplate.new.parsed_body)
-      end
-
-      def generate_rake_file(name)
-        generate_file('Rakefile', name.to_s, ConfigTemplate.new.parsed_body)
-      end
-
-      def generate_gemfile(framework, name)
-        generate_file('Gemfile',name.to_s, GemfileTemplate.new(framework: framework).parsed_body)
-      end
-    end
-  end
-end

data/lib/generators/files/cucumber_file_generator.rb

@@ -1,33 +0,0 @@
-require_relative '../templates/cucumber/env_template'
-require_relative '../templates/cucumber/example_feature_template'
-require_relative '../templates/cucumber/example_steps_template'
-require_relative 'file_generator'
-
-module RubyRaider
-  class CucumberFileGenerator < FileGenerator
-    class << self
-      def generate_cucumber_files(name, automation)
-        AutomationFileGenerator.generate_automation_files(name, automation, 'framework')
-        CommonFileGenerator.generate_common_files(name, 'cucumber')
-        HelpersFileGenerator.generate_helper_files(name, automation, 'cucumber')
-        generate_env_file(automation, name)
-        generate_example_feature(name)
-        generate_example_steps(name)
-      end
-
-      def generate_example_feature(name)
-        generate_file('login.feature', "#{name}/features", ExampleFeatureTemplate.new.parsed_body)
-      end
-
-      def generate_example_steps(name)
-        generate_file('login_steps.rb', "#{name}/features/step_definitions",
-                      ExampleStepsTemplate.new.parsed_body)
-      end
-
-      def generate_env_file(automation, name)
-        generate_file('env.rb', "#{name}/features/support",
-                      EnvTemplate.new(automation: automation).parsed_body)
-      end
-    end
-  end
-end

data/lib/generators/files/file_generator.rb

@@ -1,11 +0,0 @@
-module RubyRaider
-  class FileGenerator
-    class << self
-      def generate_file(name, path, content)
-        file_path = "#{path}/#{name}"
-        File.new(file_path, 'w+')
-        File.write(file_path, content)
-      end
-    end
-  end
-end

data/lib/generators/files/helpers_file_generator.rb

@@ -1,63 +0,0 @@
-require_relative '../templates/helpers/allure_helper_template'
-require_relative '../templates/helpers/browser_helper_template'
-require_relative '../templates/helpers/driver_helper_template'
-require_relative '../templates/helpers/pom_helper_template'
-require_relative '../templates/helpers/raider_helper_template'
-require_relative '../templates/helpers/spec_helper_template'
-require_relative '../templates/helpers/selenium_helper_template'
-require_relative '../templates/helpers/watir_helper_template'
-require_relative 'file_generator'
-
-module RubyRaider
-  class HelpersFileGenerator < FileGenerator
-    class << self
-      def generate_helper_files(name, automation, framework)
-        path = framework == 'rspec' ? "#{name}/helpers" : "#{name}/features/support/helpers"
-        generate_raider_helper(automation, framework, path)
-        generate_allure_helper(framework, path)
-        generate_pom_helper(path)
-        generate_spec_helper(automation, path) if framework == 'rspec'
-        if automation == 'watir'
-          generate_watir_helper(path)
-          generate_browser_helper(path)
-        else
-          generate_selenium_helper(path)
-          generate_driver_helper(path)
-        end
-      end
-
-      def generate_raider_helper(automation, framework, path)
-        generate_file('raider.rb', path,
-                      RaiderHelperTemplate.new(automation: automation, framework: framework).parsed_body)
-      end
-
-      def generate_allure_helper(framework, path)
-        generate_file('allure_helper.rb', path, AllureHelperTemplate.new(framework: framework).parsed_body)
-      end
-
-      def generate_browser_helper(path)
-        generate_file('browser_helper.rb', path, BrowserHelperTemplate.new.parsed_body)
-      end
-
-      def generate_pom_helper(path)
-        generate_file('pom_helper.rb', path, PomHelperTemplate.new.parsed_body)
-      end
-
-      def generate_spec_helper(automation, path)
-        generate_file('spec_helper.rb', path, SpecHelperTemplate.new(automation: automation).parsed_body)
-      end
-
-      def generate_watir_helper(path)
-        generate_file('watir_helper.rb', path, WatirHelperTemplate.new.parsed_body)
-      end
-
-      def generate_selenium_helper(path)
-        generate_file('selenium_helper.rb', path, SeleniumHelperTemplate.new.parsed_body)
-      end
-
-      def generate_driver_helper(path)
-        generate_file('driver_helper.rb', path, DriverHelperTemplate.new.parsed_body)
-      end
-    end
-  end
-end

data/lib/generators/files/rspec_file_generator.rb

@@ -1,28 +0,0 @@
-require_relative '../templates/rspec/example_spec_template'
-require_relative '../templates/rspec/base_spec_template'
-require_relative 'automation_file_generator'
-require_relative 'common_file_generator'
-require_relative 'file_generator'
-require_relative 'helpers_file_generator'
-
-module RubyRaider
-  class RspecFileGenerator < FileGenerator
-    class << self
-      def generate_rspec_files(name, automation)
-        AutomationFileGenerator.generate_automation_files(name, automation, 'rspec')
-        CommonFileGenerator.generate_common_files(name, 'rspec')
-        HelpersFileGenerator.generate_helper_files(name, automation, 'rspec')
-        generate_base_spec(name)
-        generate_example_spec(name)
-      end
-
-      def generate_example_spec(name)
-        generate_file('login_page_spec.rb', "#{name}/spec", ExampleSpecTemplate.new.parsed_body)
-      end
-
-      def generate_base_spec(name)
-        generate_file('base_spec.rb', "#{name}/spec", BaseSpecTemplate.new.parsed_body)
-      end
-    end
-  end
-end

data/lib/generators/projects/cucumber_project_generator.rb

@@ -1,26 +0,0 @@
-require_relative '../files/cucumber_file_generator'
-require_relative 'project_generator'
-
-module RubyRaider
-  class CucumberProjectGenerator < ProjectGenerator
-    class << self
-      def generate_cucumber_project(name, automation: 'watir')
-        cucumber_folder_structure(name)
-        CucumberFileGenerator.generate_cucumber_files(name, automation)
-        ProjectGenerator.install_gems(name)
-      end
-
-      def cucumber_folder_structure(name)
-        Dir.mkdir name.to_s
-        folders = %w[features config page_objects allure-results]
-        create_children_folders("#{name}", folders)
-        folders = %w[step_definitions support]
-        create_children_folders("#{name}/features", folders)
-        Dir.mkdir "#{name}/features/support/helpers"
-        folders = %w[abstract pages components]
-        create_children_folders("#{name}/page_objects", folders)
-        Dir.mkdir "#{name}/allure-results/screenshots"
-      end
-    end
-  end
-end

data/lib/generators/projects/project_generator.rb

@@ -1,13 +0,0 @@
-module RubyRaider
-  class ProjectGenerator
-    class << self
-      def create_children_folders(parent, folders)
-        folders.each { |folder| Dir.mkdir "#{parent}/#{folder}" }
-      end
-
-      def install_gems(name)
-        system "cd #{name} && gem install bundler && bundle install"
-      end
-    end
-  end
-end

data/lib/generators/projects/rspec_project_generator.rb

@@ -1,22 +0,0 @@
-require_relative 'project_generator'
-require_relative '../files/rspec_file_generator'
-
-module RubyRaider
-  class RspecProjectGenerator < ProjectGenerator
-    class << self
-      def generate_rspec_project(name, automation: 'watir')
-        rspec_folder_structure(name)
-        RspecFileGenerator.generate_rspec_files(name, automation)
-        ProjectGenerator.install_gems(name)
-      end
-
-      def rspec_folder_structure(name)
-        Dir.mkdir name.to_s
-        folders = %w[config data page_objects helpers spec]
-        create_children_folders(name, folders)
-        pages = %w[pages components abstract]
-        create_children_folders("#{name}/page_objects", pages)
-      end
-    end
-  end
-end

data/lib/generators/templates/automation/abstract_component_template.rb

@@ -1,22 +0,0 @@
-require_relative '../template'
-
-class AbstractComponentTemplate < Template
-  def body
-    raider = if @framework == 'rspec'
-               "require_relative '../../helpers/raider'"
-             else
-               "require_relative '../../features/support/helpers/raider'"
-             end
-
-    <<~EOF
-      #{raider}
-
-      class AbstractComponent
-
-          def initialize(component)
-            @component = component
-          end
-      end
-    EOF
-  end
-end

data/lib/generators/templates/automation/abstract_page_template.rb

@@ -1,48 +0,0 @@
-require_relative '../template'
-
-class AbstractPageTemplate < Template
-  def body
-    browser = "def browser
-    Raider::BrowserHelper.browser
-  end"
-    driver = "def driver
-    Raider::DriverHelper.driver
-  end"
-
-    visit = @automation == 'watir' ? 'browser.goto full_url(page.first)' : 'driver.navigate.to full_url(page.first)'
-    raider = if @framework == 'rspec'
-               "require_relative '../../helpers/raider'"
-             else
-               "require_relative '../../features/support/helpers/raider'"
-             end
-
-    <<~EOF
-        require 'rspec'
-        #{raider}
-
-        class AbstractPage
-
-          include RSpec::Matchers
-          extend Raider::PomHelper
-
-          #{@automation == 'watir' ? browser : driver}
-
-          def visit(*page)
-            #{visit}
-          end
-
-          def full_url(*page)
-            "#\{base_url}#\{url(*page)}"
-          end
-
-          def base_url
-            'https://automationteststore.com/'
-          end
-
-          def url(_page)
-            raise 'Url must be defined on child pages'
-          end
-        end
-    EOF
-  end
-end

data/lib/generators/templates/automation/component_template.rb

@@ -1,16 +0,0 @@
-require_relative '../template'
-
-class ComponentTemplate < Template
-  def body
-    <<~EOF
-          require_relative '../abstract/abstract_component'
-
-          class HeaderComponent < AbstractComponent
-
-            def customer_name
-              @component.text
-            end
-          end
-    EOF
-  end
-end

data/lib/generators/templates/automation/page_template.rb

@@ -1,51 +0,0 @@
-require_relative '../template'
-
-class PageTemplate < Template
-  def body
-    element = @automation == 'watir' ? 'browser.element' : 'driver.find_element'
-    helper = @automation == 'watir' ? 'Raider::WatirHelper' : 'Raider::SeleniumHelper'
-
-    <<~EOF
-      require_relative '../abstract/abstract_page'
-      require_relative '../components/header_component'
-
-      class LoginPage < AbstractPage
-        using #{helper}
-
-        def url(_page)
-          'index.php?rt=account/login'
-        end
-
-        # Actions
-
-        def login(username, password)
-          username_field.send_keys username
-          password_field.send_keys password
-          login_button.click_when_present
-        end
-
-        # Components
-
-        def header
-          HeaderComponent.new(#{element}(class: 'menu_text'))
-        end
-
-        private
-
-        # Elements
-
-        def username_field
-          #{element}(id: 'loginFrm_loginname')
-        end
-
-        def password_field
-          #{element}(id: 'loginFrm_password')
-        end
-
-        def login_button
-          #{element}(xpath: "//button[@title='Login']")
-        end
-      end
-    EOF
-  end
-end

data/lib/generators/templates/common/config_template.rb

@@ -1,9 +0,0 @@
-require_relative '../template'
-
-class ConfigTemplate < Template
-  def body
-    <<~EOF
-      browser: :chrome
-    EOF
-  end
-end

data/lib/generators/templates/common/gemfile_template.rb

@@ -1,29 +0,0 @@
-require_relative '../template'
-
-class GemfileTemplate < Template
-  def body
-    if @framework == 'cucumber'
-      allure_cucumber = "gem 'allure-cucumber'"
-      rspec = "gem 'rspec'"
-    end
-
-    <<~EOF
-          # frozen_string_literal: true
-
-          source 'https://rubygems.org'
-
-          gem 'activesupport'
-          gem 'allure-rspec'
-          gem 'allure-ruby-commons'
-          #{allure_cucumber}
-          gem 'parallel_split_test'
-          gem 'parallel_tests'
-          gem 'rake'
-          gem '#{@framework}'
-          #{rspec}
-          gem 'selenium-webdriver'
-          gem 'watir'
-          gem 'webdrivers'
-    EOF
-  end
-end