ruby_raider 0.2.3 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56bd6a11e678cd280d2652e3f09772b3e30079c713870e1822047b68794a632b
-  data.tar.gz: 668dd6b2cf904d2a5f1c2dd917930fc0108a8d63aad8a41a71accff6a25552b2
+  metadata.gz: 5ae28c89e9e9716c7a75d97bbe0bc31bae51c3f18b85734492b5a4c5b7913a69
+  data.tar.gz: 3f6a53f7b30227c3cde2a965a9fe19547afd804484bbee5e3757f9cd65bfa6e8
 SHA512:
-  metadata.gz: 6a8aa084abb9dfb11ad52834f55b0f7d2c2f19df7e70bdfe2565faeaf831e1efd47e5e068f79d5d93323eee6808fc7ecded2669c62063d46cc3df2aa8dd00dc7
-  data.tar.gz: 31d7142a4b46e74ed855cc757d8038ae7dc8e2c60007d7847b705c17dc01bd3f879341b179a1840370ed9296dbdb59b51ea1ab5fe8f6e4e6bd8883f85af70881
+  metadata.gz: 866912f5d5c4a809dbf721d6629c03f26a5df60d3c5581c6af3b1cfc0884fd629b68af8543d4c630d0d7c736f6aff701aeb577d86538210d129221b42680771c
+  data.tar.gz: 153726f43cfed928c93457498b964b0f067b82f008ab8a8377828151dd12f4a01052cd7b1e3df5f2c3c89ca941af4d2fafc1c3972ac1ac22ad2fc73c30d06367

data/README.md

@@ -1,5 +1,6 @@
 # ruby_raider
-This is a gem to make setup and start of UI automation projects easier
+This is a gem to make setup and start of UI automation projects easier 
+You can find more information and updates on releaseas in : https://ruby-raider.com/
 
 Just do:
 
@@ -7,7 +8,7 @@ Just do:
 
 then do: 
 
-**raider [name_of_project]** 
+**raider new [name_of_project]** 
 
 and you will have a new project in the folder you are in
 

data/Rakefile

@@ -4,5 +4,12 @@ require_relative 'lib/ruby_raider'
 
 desc 'Create a new test projects'
 task :new, [:name] do |_t, args|
-  RubyRaider.generate_project(args.name)
+  RubyRaider.start
+  RubyRaider.new(args.name)
 end
+
+desc 'Create a page'
+task :page, [:name] do |_t, args|
+  RubyRaider.start
+  RubyRaider.page(args.page)
+end

data/bin/raider

@@ -3,4 +3,4 @@
 
 require_relative '../lib/ruby_raider'
 
-RubyRaider.generate_project ARGV[0]
+RubyRaider.start

data/lib/generators/automation_generator.rb

@@ -2,44 +2,42 @@
 
 require_relative 'generator'
 
-module RubyRaider
-  class AutomationGenerator < Generator
-    def generate_login_page
-      template('automation/login_page.tt', "#{name}/page_objects/pages/login_page.rb")
-    end
+class AutomationGenerator < Generator
+  def generate_login_page
+    template('automation/login_page.tt', "#{name}/page_objects/pages/login_page.rb")
+  end
 
-    def generate_abstract_page
-      template('automation/abstract_page.tt', "#{name}/page_objects/abstract/abstract_page.rb")
-    end
+  def generate_abstract_page
+    template('automation/abstract_page.tt', "#{name}/page_objects/abstract/abstract_page.rb")
+  end
 
-    def generate_home_page
-      if @_initializer.first.include?('appium_ios')
-        template('automation/home_page.tt', "#{name}/page_objects/pages/home_page.rb")
-      end
+  def generate_home_page
+    if @_initializer.first.include?('appium_ios')
+      template('automation/home_page.tt', "#{name}/page_objects/pages/home_page.rb")
     end
+  end
 
-    def generate_header_component
-      unless @_initializer.first.include?('appium_ios')
-        template('automation/component.tt', "#{name}/page_objects/components/header_component.rb")
-      end
+  def generate_header_component
+    unless @_initializer.first.include?('appium_ios')
+      template('automation/component.tt', "#{name}/page_objects/components/header_component.rb")
     end
+  end
 
-    def generate_abstract_component
-      unless @_initializer.first.include?('appium_ios')
-        template('automation/abstract_component.tt', "#{name}/page_objects/abstract/abstract_component.rb")
-      end
+  def generate_abstract_component
+    unless @_initializer.first.include?('appium_ios')
+      template('automation/abstract_component.tt', "#{name}/page_objects/abstract/abstract_component.rb")
     end
+  end
 
-    def generate_confirmation_page
-      if @_initializer.first.include?('appium_ios')
-        template('automation/confirmation_page.tt', "#{name}/page_objects/pages/confirmation_page.rb")
-      end
+  def generate_confirmation_page
+    if @_initializer.first.include?('appium_ios')
+      template('automation/confirmation_page.tt', "#{name}/page_objects/pages/confirmation_page.rb")
     end
+  end
 
-    def generate_appium_settings
-      if @_initializer.first.include?('appium_ios')
-        template('automation/appium_settings.tt', "#{name}/appium.txt")
-      end
+  def generate_appium_settings
+    if @_initializer.first.include?('appium_ios')
+      template('automation/appium_settings.tt', "#{name}/appium.txt")
     end
   end
 end

data/lib/generators/common_generator.rb

@@ -2,30 +2,29 @@
 
 require_relative 'generator'
 
-module RubyRaider
-  class CommonGenerator < Generator
-      def generate_readme_file
-        template('common/read_me.tt', "#{name}/Readme.md")
-      end
-
-      def generate_config_file
-        template('common/config.tt', "#{name}/config/config.yml")
-      end
-
-      def generate_rake_file
-        template('common/rakefile.tt', "#{name}/Rakefile")
-      end
-
-      def generate_gemfile
-        template('common/gemfile.tt', "#{name}/Gemfile")
-      end
-
-      def create_allure_folder
-        empty_directory "#{name}/allure-results"
-      end
-
-      def create_screenshots_folder
-        empty_directory "#{name}/allure-results/screenshots"
-      end
-    end
+class CommonGenerator < Generator
+  def generate_readme_file
+    template('common/read_me.tt', "#{name}/Readme.md")
+  end
+
+  def generate_config_file
+    template('common/config.tt', "#{name}/config/config.yml")
+  end
+
+  def generate_rake_file
+    template('common/rakefile.tt', "#{name}/Rakefile")
+  end
+
+  def generate_gemfile
+    template('common/gemfile.tt', "#{name}/Gemfile")
+  end
+
+  def create_allure_folder
+    empty_directory "#{name}/allure-results"
+  end
+
+  def create_screenshots_folder
+    empty_directory "#{name}/allure-results/screenshots"
+  end
 end
+

data/lib/generators/cucumber_generator.rb

@@ -2,18 +2,17 @@
 
 require_relative 'generator'
 
-module RubyRaider
-  class CucumberGenerator < Generator
-    def generate_feature
-      template('cucumber/feature.tt', "#{name}/features/login.feature")
-    end
+class CucumberGenerator < Generator
+  def generate_feature
+    template('cucumber/feature.tt', "#{name}/features/login.feature")
+  end
 
-    def generate_steps
-      template('cucumber/steps.tt', "#{name}/features/step_definitions/login_steps.rb")
-    end
+  def generate_steps
+    template('cucumber/steps.tt', "#{name}/features/step_definitions/login_steps.rb")
+  end
 
-    def generate_env_file
-      template('cucumber/env.tt', "#{name}/features/support/env.rb")
-    end
+  def generate_env_file
+    template('cucumber/env.tt', "#{name}/features/support/env.rb")
   end
 end
+

data/lib/generators/generator.rb

@@ -1,16 +1,15 @@
 # frozen_string_literal: true
 require 'thor'
 
-module RubyRaider
-  class Generator < Thor::Group
-    include Thor::Actions
+class Generator < Thor::Group
+  include Thor::Actions
 
-    argument :automation
-    argument :framework
-    argument :name
+  argument :automation
+  argument :framework
+  argument :name
 
-    def self.source_root
-      File.dirname(__FILE__) + '/templates'
-    end
+  def self.source_root
+    File.dirname(__FILE__) + '/templates'
   end
 end
+

data/lib/generators/helper_generator.rb

@@ -2,39 +2,37 @@
 
 require_relative 'generator'
 
-module RubyRaider
-  class HelpersGenerator < Generator
+class HelpersGenerator < Generator
 
-    def generate_raider_helper
-      template('helpers/raider_helper.tt', "#{name}/helpers/raider.rb")
-    end
+  def generate_raider_helper
+    template('helpers/raider_helper.tt', "#{name}/helpers/raider.rb")
+  end
 
-    def generate_allure_helper
-      template('helpers/allure_helper.tt', "#{name}/helpers/allure_helper.rb")
-    end
+  def generate_allure_helper
+    template('helpers/allure_helper.tt', "#{name}/helpers/allure_helper.rb")
+  end
 
-    def generate_browser_helper
-      if @_initializer.first.include?('watir')
-        template('helpers/browser_helper.tt', "#{name}/helpers/browser_helper.rb")
-      end
+  def generate_browser_helper
+    if @_initializer.first.include?('watir')
+      template('helpers/browser_helper.tt', "#{name}/helpers/browser_helper.rb")
     end
+  end
 
-    def generate_spec_helper
-      if @_initializer.first.include?('rspec')
-        template('helpers/spec_helper.tt', "#{name}/helpers/spec_helper.rb")
-      end
+  def generate_spec_helper
+    if @_initializer.first.include?('rspec')
+      template('helpers/spec_helper.tt', "#{name}/helpers/spec_helper.rb")
     end
+  end
 
-    def generate_selenium_helper
-      if @_initializer.first.include?('selenium')
-        template('helpers/selenium_helper.tt', "#{name}/helpers/selenium_helper.rb")
-      end
+  def generate_selenium_helper
+    if @_initializer.first.include?('selenium')
+      template('helpers/selenium_helper.tt', "#{name}/helpers/selenium_helper.rb")
     end
+  end
 
-    def generate_driver_helper
-      unless @_initializer.first.include?('watir')
-        template('helpers/driver_helper.tt', "#{name}/helpers/driver_helper.rb")
-      end
+  def generate_driver_helper
+    unless @_initializer.first.include?('watir')
+      template('helpers/driver_helper.tt', "#{name}/helpers/driver_helper.rb")
     end
   end
 end

data/lib/generators/menu_generator.rb

@@ -7,66 +7,64 @@ require_relative 'cucumber_generator'
 require_relative 'helper_generator'
 require_relative 'rspec_generator'
 
-module RubyRaider
-  class MenuGenerator
-    class << self
-      def generate_choice_menu(project_name)
-        @cli = HighLine.new
-        @cli.choose do |menu|
-          menu.prompt = 'Please select your automation framework'
-          menu.choice('Selenium') { choose_test_framework('selenium', project_name) }
-          menu.choice('Watir') { choose_test_framework('watir', project_name) }
-          menu.choice('Appium') { choose_test_framework('appium', project_name) }
-          menu.choice('Quit') { exit }
-        end
+class MenuGenerator
+  class << self
+    def generate_choice_menu(project_name)
+      @cli = HighLine.new
+      @cli.choose do |menu|
+        menu.prompt = 'Please select your automation framework'
+        menu.choice('Selenium') { choose_test_framework('selenium', project_name) }
+        menu.choice('Watir') { choose_test_framework('watir', project_name) }
+        menu.choice('Appium') { choose_test_framework('appium', project_name) }
+        menu.choice('Quit') { exit }
       end
+    end
 
-      def choose_test_framework(automation, project_name)
-        system('clear') || system('cls')
-        sleep 0.3
-        automation = automation == 'appium' ? choose_mobile_platform : automation
-        framework = ''
-        @cli.choose do |menu|
-          menu.prompt = 'Please select your test framework'
-          menu.choice('Rspec') do
-            framework = 'rspec'
-            set_framework(automation, framework, project_name)
-          end
-          menu.choice('Cucumber') do
-            framework = 'cucumber'
-            set_framework(automation, framework, project_name)
-          end
-          menu.choice('Quit') { exit }
+    def choose_test_framework(automation, project_name)
+      system('clear') || system('cls')
+      sleep 0.3
+      automation = automation == 'appium' ? choose_mobile_platform : automation
+      framework = ''
+      @cli.choose do |menu|
+        menu.prompt = 'Please select your test framework'
+        menu.choice('Rspec') do
+          framework = 'rspec'
+          set_framework(automation, framework, project_name)
         end
-        @cli.say("You have chosen to use #{framework} with #{automation}")
+        menu.choice('Cucumber') do
+          framework = 'cucumber'
+          set_framework(automation, framework, project_name)
+        end
+        menu.choice('Quit') { exit }
       end
+      @cli.say("You have chosen to use #{framework} with #{automation}")
+    end
 
-      def set_framework(automation, framework, project_name)
-        if framework == 'rspec'
-          RspecGenerator.new([automation, framework, project_name]).invoke_all
-        else
-          CucumberGenerator.new([automation, framework, project_name]).invoke_all
-        end
-        AutomationGenerator.new([automation, framework, project_name]).invoke_all
-        CommonGenerator.new([automation, framework, project_name]).invoke_all
-        HelpersGenerator.new([automation, framework, project_name]).invoke_all
-        system "cd #{project_name} && gem install bundler && bundle install"
+    def set_framework(automation, framework, project_name)
+      if framework == 'rspec'
+        RspecGenerator.new([automation, framework, project_name]).invoke_all
+      else
+        CucumberGenerator.new([automation, framework, project_name]).invoke_all
       end
+      AutomationGenerator.new([automation, framework, project_name]).invoke_all
+      CommonGenerator.new([automation, framework, project_name]).invoke_all
+      HelpersGenerator.new([automation, framework, project_name]).invoke_all
+      system "cd #{project_name} && gem install bundler && bundle install"
+    end
 
-      def choose_mobile_platform
-        @cli.choose do |menu|
-          menu.prompt = 'Please select your mobile platform'
-          menu.choice('iOS') { 'appium_ios' }
-          menu.choice('Android') do
-            pp 'Android appium is coming soon. Thank you for the interest'
-            exit
-          end
-          menu.choice('Cross Platform') do
-            pp 'Cross platform appium is coming soon. Thank you for the interest'
-            exit
-          end
-          menu.choice('Quit') { exit }
+    def choose_mobile_platform
+      @cli.choose do |menu|
+        menu.prompt = 'Please select your mobile platform'
+        menu.choice('iOS') { 'appium_ios' }
+        menu.choice('Android') do
+          pp 'Android appium is coming soon. Thank you for the interest'
+          exit
+        end
+        menu.choice('Cross Platform') do
+          pp 'Cross platform appium is coming soon. Thank you for the interest'
+          exit
         end
+        menu.choice('Quit') { exit }
       end
     end
   end

data/lib/generators/rspec_generator.rb

@@ -2,15 +2,14 @@
 
 require_relative 'generator'
 
-module RubyRaider
-  class RspecGenerator < Generator
+class RspecGenerator < Generator
 
-    def generate_spec
-      template('rspec/spec.tt', "#{name}/spec/login_page_spec.rb")
-    end
+  def generate_spec
+    template('rspec/spec.tt', "#{name}/spec/login_page_spec.rb")
+  end
 
-    def generate_base_spec
-      template('rspec/base_spec.tt', "#{name}/spec/base_spec.rb")
-    end
+  def generate_base_spec
+    template('rspec/base_spec.tt', "#{name}/spec/base_spec.rb")
   end
 end
+

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

@@ -1,4 +1,4 @@
-require 'rspec'
+require 'yaml'
 <%= ERB.new(File.read(File.expand_path('./partials/require_raider.tt', __dir__)), nil, '-').result(binding) -%>
 
 class AbstractPage

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

@@ -4,7 +4,7 @@
   end
 
   def base_url
-    'https://automationteststore.com/'
+    YAML.load_file('config/config.yml')['url']
   end
 
   def url(_page)

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

@@ -1 +1,2 @@
 browser: :chrome
+url: 'https://automationteststore.com/'

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

@@ -12,6 +12,7 @@ gem 'rake'
 gem '<%= framework %>'
 <% if framework == 'cucumber' -%>
 gem 'rspec'
+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 -%>

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

@@ -10,9 +10,9 @@ module Raider
     class << self
       attr_reader :browser
 
-      def new_browser
+      def new_browser(options = {})
         config = YAML.load_file('config/config.yml')
-        @browser = Watir::Browser.new config['browser']
+        @browser = Watir::Browser.new(config['browser'], options: browser_opts)
       end
     end
   end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-
+require 'yaml'
 <% if automation == 'selenium' -%>
 require 'webdrivers'
 <% else -%>

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

@@ -1,6 +1,6 @@
 <% if automation == 'selenium' %>
-      def new_driver
-        @driver = Selenium::WebDriver.for :chrome
+      def new_driver(caps = {})
+        @driver = Selenium::WebDriver.for(YAML.load_file('config/config.yml')['browser'], desired_capabilities: caps)
       end
 <% else %>
       def new_driver

data/lib/ruby_raider.rb

@@ -1,12 +1,48 @@
-# frozen_string_literal: true
-
+require 'thor'
+require 'yaml'
 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, load_config_path]).generate_class
+  end
+
+  desc "feature [FEATURE_NAME]", "Creates a new feature"
+  def feature(name)
+    Scaffolding.new([name, load_config_path]).generate_feature
+  end
+
+  desc "spec [SPEC_NAME]", "Creates a new spec"
+  def spec(name)
+    Scaffolding.new([name, load_config_path]).generate_spec
+  end
+
+  desc "path [PATH]", "Sets the default path for scaffolding"
+  def path(default_path)
+    Utilities.new.path = default_path
+  end
+
+  desc "url [URL]", "Sets the default url for a project"
+  def url(default_url)
+    Utilities.new.url = default_url
+  end
+
+  desc "browser [BROWSER]", "Sets the default browser for a project"
+  def browser(default_browser)
+    Utilities.new.browser = default_browser
+  end
+
+  no_commands do
+    def load_config_path
+      YAML.load_file('config/config.yml')['path']
+    end
+  end
+end

data/lib/scaffolding/scaffolding.rb

@@ -0,0 +1,28 @@
+require 'thor'
+
+class Scaffolding < Thor::Group
+  include Thor::Actions
+
+  argument :name
+  argument :path, optional: true
+
+  def self.source_root
+    File.dirname(__FILE__) + '/templates'
+  end
+
+  def generate_class
+    template('page_object.tt', default_path("page_objects/pages/#{name}_page.rb") )
+  end
+
+  def generate_feature
+    template('feature.tt', default_path("features/#{name}.feature"))
+  end
+
+  def generate_spec
+    template('spec.tt', default_path("./spec/#{name}_page.rb"))
+  end
+
+  def default_path(standard_path)
+    path.nil? ? standard_path : "#{path}/#{name}"
+  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,28 @@
+require 'yaml'
+
+class Utilities
+
+  def initialize
+    @path = 'config/config.yml'
+    @config = YAML.load_file(@path)
+  end
+
+  def browser=(browser)
+    @config['browser'] = browser
+    overwrite_yaml
+  end
+
+  def path=(path)
+    @config['path'] = path
+    overwrite_yaml
+  end
+
+  def url=(url)
+    @config['url'] = url
+    overwrite_yaml
+  end
+
+  def overwrite_yaml
+    File.open(@path, 'w') { |file| YAML.dump(@config, file) }
+  end
+end

data/ruby_raider.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.2.3'
+  s.version     = '0.2.6'
   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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.6
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-05-26 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
@@ -174,6 +173,11 @@ files:
 - 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