ruby_raider 0.6.0 → 0.6.1

data/lib/generators/helper_generator.rb

@@ -3,53 +3,56 @@
 require_relative 'generator'
 
 class HelpersGenerator < Generator
+  def generate_helpers
+    generate_raider_helper
+    generate_browser_helper
+    generate_driver_helper
+    generate_appium_helper
+
+    if visual_selected?
+      generate_visual_helper
+      generate_visual_spec_helper
+    else
+      generate_allure_helper
+      generate_spec_helper
+    end
+  end
+
+  private
+
   def generate_raider_helper
     template('helpers/raider_helper.tt', "#{name}/helpers/raider.rb")
   end
 
   def generate_allure_helper
-    return if @_initializer.first.last
-
     template('helpers/allure_helper.tt', "#{name}/helpers/allure_helper.rb")
   end
 
   def generate_browser_helper
-    template('helpers/browser_helper.tt', "#{name}/helpers/browser_helper.rb") if @_initializer.first.include?('watir')
+    template('helpers/browser_helper.tt', "#{name}/helpers/browser_helper.rb") if args.include?('watir')
   end
 
   def generate_spec_helper
-    return if @_initializer.first.last
-
-    template('helpers/spec_helper.tt', "#{name}/helpers/spec_helper.rb") if @_initializer.first.include?('rspec')
-  end
-
-  def generate_selenium_helper
-    return unless @_initializer.first.include?('selenium')
-
-    template('helpers/selenium_helper.tt', "#{name}/helpers/selenium_helper.rb")
+    template('helpers/spec_helper.tt', "#{name}/helpers/spec_helper.rb") if args.include?('rspec')
   end
 
   def generate_driver_helper
-    return if @_initializer.first.include?('watir')
+    return if args.include?('watir')
 
     template('helpers/driver_helper.tt', "#{name}/helpers/driver_helper.rb")
   end
 
   def generate_appium_helper
-    return unless @_initializer.first.include?('cross_platform')
+    return unless args.include?('cross_platform')
 
     template('helpers/appium_helper.tt', "#{name}/helpers/appium_helper.rb")
   end
 
   def generate_visual_helper
-    return unless @_initializer.first.last
-
     template('helpers/visual_helper.tt', "#{name}/helpers/visual_helper.rb")
   end
 
   def generate_visual_spec_helper
-    return unless @_initializer.first.last
-
     template('helpers/visual_spec_helper.tt', "#{name}/helpers/spec_helper.rb")
   end
 end

data/lib/generators/invoke_generators.rb

@@ -7,15 +7,18 @@ require_relative 'helper_generator'
 require_relative 'rspec/rspec_generator'
 require_relative 'rspec/rspec_examples_generator'
 
+# :reek:FeatureEnvy { enabled: false }
+# :reek:UtilityFunction { enabled: false }
 module InvokeGenerators
   def generate_framework(structure = {})
     generators = %w[Automation Common Helpers]
-    add_generator(generators, structure[:framework].capitalize)
+    framework = structure[:framework]
+    add_generator(generators, framework.capitalize)
     generators = add_examples(generators) if structure[:examples]
     generators.each do |generator|
       invoke_generator({
                          automation: structure[:automation],
-                         framework: structure[:framework],
+                         framework: framework,
                          generator: generator,
                          name: structure[:name],
                          visual: structure[:visual]

data/lib/generators/menu_generator.rb

@@ -3,6 +3,8 @@
 require 'tty-prompt'
 require_relative '../generators/invoke_generators'
 
+# :reek:FeatureEnvy { enabled: false }
+# :reek:UtilityFunction { enabled: false }
 class MenuGenerator
   attr_reader :prompt, :name
 
@@ -23,11 +25,7 @@ class MenuGenerator
   end
 
   def choose_visual_automation
-    prompt.select('Do you want to add visual automation with applitools?') do |menu|
-      menu.choice :Yes, -> { true }
-      menu.choice :No, -> { false }
-      menu.choice :Quit, -> { exit }
-    end
+    prompt.select('Do you want to add visual automation with applitools?', visual_automation_menu_choices)
   end
 
   def choose_test_framework(automation)
@@ -36,13 +34,13 @@ class MenuGenerator
     select_test_framework(automation)
   end
 
-  def set_up_framework(automation, framework, visual_automation, with_examples)
+  def set_up_framework(options)
     structure = {
-      automation: automation,
-      framework: framework,
+      automation: options[:automation],
+      framework: options[:framework],
       name: @name,
-      visual: visual_automation,
-      examples: with_examples
+      visual: options[:visual_automation],
+      examples: options[:with_examples]
     }
     generate_framework(structure)
     system "cd #{name} && gem install bundler && bundle install"
@@ -59,13 +57,6 @@ class MenuGenerator
 
   private
 
-  def framework_choice(framework, automation_type, with_examples: true)
-    visual_automation = choose_visual_automation if %w[selenium watir].include?(automation_type) && framework == 'Rspec'
-
-    set_up_framework(automation_type, framework.downcase, visual_automation, with_examples)
-    prompt.say("You have chosen to use #{framework} with #{automation_type}")
-  end
-
   def select_test_framework(automation)
     prompt.select('Please select your test framework') do |menu|
       menu.choice :Cucumber, -> { select_example_files('Cucumber', automation) }
@@ -76,9 +67,37 @@ class MenuGenerator
 
   def select_example_files(framework, automation)
     prompt.select('Would you like to create example files?') do |menu|
-      menu.choice :Yes, -> { framework_choice(framework, automation) }
-      menu.choice :No, -> { framework_choice(framework, automation, with_examples: false) }
+      menu.choice :Yes, -> { framework_with_examples(framework, automation) }
+      menu.choice :No, -> { framework_without_examples(framework, automation) }
       menu.choice :Quit, -> { exit }
     end
   end
+
+  FrameworkOptions = Struct.new(:automation, :framework, :visual_automation, :with_examples)
+
+  def create_framework_options(params)
+    FrameworkOptions.new(params[:automation], params[:framework], params[:visual_automation], params[:with_examples])
+  end
+
+  def framework_with_examples(framework, automation_type)
+    visual_automation = choose_visual_automation if %w[selenium watir].include?(automation_type) && framework == 'Rspec'
+    options = create_framework_options(automation: automation_type, framework: framework.downcase, visual_automation: visual_automation, with_examples: true)
+    set_up_framework(options)
+    prompt.say("You have chosen to use #{framework} with #{automation_type}")
+  end
+
+  def framework_without_examples(framework, automation_type)
+    visual_automation = choose_visual_automation if %w[selenium watir].include?(automation_type) && framework == 'Rspec'
+    options = create_framework_options(automation: automation_type, framework: framework.downcase, visual_automation: visual_automation, with_examples: false)
+    set_up_framework(options)
+    prompt.say("You have chosen to use #{framework} with #{automation_type}")
+  end
+
+  def visual_automation_menu_choices
+    {
+      Yes: -> { true },
+      No: -> { false },
+      Quit: -> { exit }
+    }
+  end
 end

data/lib/generators/rspec/rspec_examples_generator.rb

@@ -4,14 +4,26 @@ require_relative '../generator'
 
 class RspecExamplesGenerator < Generator
   def generate_login_spec
-    return unless (@_initializer.first & %w[android ios cross_platform]).empty?
+    return if mobile_platform?
 
     template('spec.tt', "#{name}/spec/login_page_spec.rb")
   end
 
   def generate_pdp_spec
-    return if (@_initializer.first & %w[android ios cross_platform]).empty?
+    return unless mobile_platform?
 
     template('spec.tt', "#{name}/spec/pdp_page_spec.rb")
   end
+
+  def generate_model_factory
+    return if args.include?(%w[selenium watir])
+
+    template('factory.tt', "#{name}/models/model_factory.rb")
+  end
+
+  def generate_model_data
+    return if args.include?(%w[selenium watir])
+
+    template('data.tt', "#{name}/models/data/users.yml")
+  end
 end

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

@@ -1,5 +1,7 @@
 require_relative '../helpers/raider'
-
+<% if %w[selenium watir].include?(automation) && visual_automation == false %>
+require_relative '../models/model_factory'
+<% end %>
 class BaseSpec
   include Raider::SpecHelper
 end

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

@@ -0,0 +1,4 @@
+Agustin:
+  username: aguspe
+  password: 12341234
+  name: Agustin

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+class ModelFactory
+  def self.for(model)
+    path = File.expand_path("models/data/#{model}.yml")
+    YAML.load_file(path)
+  end
+end

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

@@ -20,32 +20,36 @@ describe 'Login Page' do
   end
 end
 <%- elsif %w[selenium watir].include? automation -%>
+# frozen_string_literal: true
+
 require_relative 'base_spec'
+require_relative '../models/model_factory'
 require_relative '../page_objects/pages/login_page'
 
 describe 'Login' do
-  let(:user_name) { 'aguspe' }
+  subject(:header) { login_page.header.customer_name }
+
+  let(:user) { ModelFactory.for('users')['Agustin'] }
   let(:login_page) { LoginPage.new(<% if automation == 'watir' -%>browser<% else -%>driver<% end -%>) }
-  subject { login_page.header.customer_name }
 
   before do
     login_page.visit
-    login_page.login(user_name, password)
+    login_page.login(user['username'], password)
   end
 
   context 'with right credentials' do
-    let(:password) { '12341234' }
+    let(:password) { user['password'] }
 
     it 'can successfully log in' do
-      expect(subject).to eq 'Welcome back Agustin'
+      expect(header).to eq "Welcome back #{user['name']}"
     end
   end
 
   context 'with wrong credentials' do
     let(:password) { 'wrongPassword' }
 
-    it 'it cannot login in' do
-      expect(subject).to be_empty
+    it 'cannot login in' do
+      expect(header).to be_empty
     end
   end
 end

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

@@ -17,10 +17,15 @@ gem 'parallel_split_test'
 gem 'parallel_tests'
 <% end -%>
 gem 'rake'
+gem 'reek'
 gem '<%= framework %>'
 <% if framework == 'cucumber' -%>
 gem 'rspec'
 <% end -%>
+gem 'rubocop'
+<% if framework == 'rspec' -%>
+gem 'rubocop-rspec'
+<% end -%>
 gem 'ruby_raider'
 <%= 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/common/reek.tt

@@ -0,0 +1,9 @@
+detectors:
+  IrresponsibleModule:
+    enabled: false
+
+  TooManyStatements:
+    enabled: true
+    exclude:
+      - initialize
+    max_statements: 10

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

@@ -0,0 +1,92 @@
+<% if framework == 'rspec' -%>
+require:
+  - rubocop-rspec
+<% end -%>
+
+# Layout
+Layout/CaseIndentation:
+  Enabled: false
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 999
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  StyleGuide: '#spaces-operators'
+  Enabled: false
+
+# Lint
+
+# Metrics
+Metrics/AbcSize:
+  Max: 100
+
+Metrics/BlockLength:
+  Max: 150
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 500
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 150
+
+Metrics/ModuleLength:
+  Max: 600
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+# Migration
+
+# Naming
+Naming/PredicateName:
+  ForbiddenPrefixes:
+    - 'is_'
+
+# Security
+
+# Styles
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/SafeNavigation:
+  Description: "Use &. instead of checking if an object exists"
+  Enabled: true
+
+Style/SingleLineBlockParams:
+  Description: 'Enforces the names of some block params.'
+  Enabled: false

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

@@ -21,10 +21,10 @@ module Raider
     end
 <% end -%>
 <% if automation != 'selenium'  -%>
-
+    # :reek:UtilityFunction
     def caps
       YAML.load_file('config/capabilities.yml')
     end
 <% end -%>
+  end
 end
-end

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

@@ -10,8 +10,10 @@
       create_options(*opts)
     end
 
+    # :reek:FeatureEnvy
     def create_options(*opts)
-      browser = @config['browser'] == :ie ? @config['browser'].to_s.upcase : @config['browser'].to_s.capitalize
+      load_browser = @config['browser'].to_s
+      browser = load_browser == 'ie' ? load_browser.upcase : load_browser.capitalize
       caps = "Selenium::WebDriver::#{browser}::Options".constantize.new
       opts.each { |option| caps.add_argument(option) }
       caps

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

@@ -4,7 +4,6 @@ module Raider
 <%- if framework == 'rspec' -%>
   require_relative 'spec_helper'
 <%- end -%>
-  <%= ERB.new(File.read(File.expand_path('./partials/require_automation.tt', __dir__))).result(binding).strip! %>
 <%- if automation == 'watir' -%>
   require_relative 'browser_helper'
 <%- else -%>

data/lib/open_ai/open_ai.rb

@@ -28,25 +28,31 @@ module OpenAi
         })
     end
 
-    def create_file(path, request, choice = 0)
-      File.write(path, output(request, choice))
+    def create_file(options)
+      path, request, choice = options.values_at(:path, :request, :choice)
+      File.write(path, output(request: request, choice: choice))
     end
 
-    def output(request, choice = 0)
+    def output(options)
+      request, choice = options.values_at(:request, :choice)
+      choice ||= 0
       extract_text(input(request), 'choices', choice, 'message', 'content')
     end
 
-    def edit_file(path, request, choice = 0)
+    def edit_file(options)
+      path, request, choice = options.values_at(:path, :request, :choice)
       content = File.read(path)
-      response = edit(content, request)
+      response = edit(content: content, request: request)
       File.write(path, extract_text(response, 'choices', choice, 'text'))
     end
 
-    def edit(input, request, model = 'text-davinci-edit-001')
+    def edit(options)
+      content, request, model = options.values_at(:content, :request, :model)
+      model ||= 'text-davinci-edit-001'
       client.edits(
         parameters: {
           model: model,
-          input: input,
+          input: content,
           instruction: request
         }
       )

data/lib/ruby_raider.rb

@@ -3,7 +3,10 @@
 require_relative '../lib/commands/open_ai_commands'
 require_relative '../lib/commands/scaffolding_commands'
 require_relative '../lib/commands/utility_commands'
+require_relative '../lib/desktop/screens/runner_screen'
 
+# :reek:FeatureEnvy { enabled: false }
+# :reek:UtilityFunction { enabled: false }
 module RubyRaider
   class Raider < Thor
     desc 'new [PROJECT_NAME]', 'Creates a new framework based on settings picked'
@@ -14,6 +17,12 @@ module RubyRaider
 
     map '-n' => 'new'
 
+    desc 'open', 'It opens the Ruby Raider desktop app'
+
+    def open
+      RunnerScreen.new.launch
+    end
+
     desc 'version', 'It shows the version of Ruby Raider you are currently using'
 
     def version

data/lib/utilities/utilities.rb

@@ -62,24 +62,6 @@ module Utilities
       system "#{command} #{opts}"
     end
 
-    def download_builds(build_type)
-      case build_type
-      when 'android'
-        download_android_build
-      when 'ios'
-        download_ios_build
-      else
-        download_android_build
-        download_ios_build
-      end
-    end
-
-    private
-
-    def overwrite_yaml
-      File.open(@path, 'w') { |file| YAML.dump(config, file) }
-    end
-
     def download_android_build
       download_build('Android-MyDemoAppRN.1.3.0.build-244.apk',
                      'https://github.com/saucelabs/my-demo-app-rn/releases/download/v1.3.0/Android-MyDemoAppRN.1.3.0.build-244.apk')
@@ -99,6 +81,12 @@ module Utilities
       end
     end
 
+    private
+
+    def overwrite_yaml
+      File.open(@path, 'w') { |file| YAML.dump(config, file) }
+    end
+
     def config
       @config ||= File.exist?(@path) ? YAML.load_file(@path) : nil
     end

data/ruby_raider.gemspec

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

data/spec/common_generator_spec.rb

@@ -24,9 +24,9 @@ describe CommonGenerator do
     end
   end
 
-  shared_examples 'creates a capabilities file' do |name|
-    it 'creates a capabilities file' do
-      expect(File).to exist("#{name}/config/capabilities.yml")
+  shared_examples 'creates a config file' do |name|
+    it 'creates a config file' do
+      expect(File).to exist("#{name}/config/config.yml")
     end
   end
 
@@ -42,6 +42,12 @@ describe CommonGenerator do
     end
   end
 
+  shared_examples 'creates a capabilities file' do |name|
+    it 'creates a capabilities file' do
+      expect(File).to exist("#{name}/config/capabilities.yml")
+    end
+  end
+
   context 'with rspec and selenium' do
     include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
     include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
@@ -101,12 +107,12 @@ describe CommonGenerator do
   context 'with cucumber and appium cross platform' do
     include_examples 'creates common files', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
     include_examples 'creates a capabilities file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates a config file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
+    include_examples "doesn't create a config file", "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
   end
 
   context 'with rspec and appium cross platform' do
     include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
     include_examples 'creates a capabilities file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
-    include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
+    include_examples "doesn't create a config file", "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
   end
 end

data/spec/open_ai_commands_spec.rb

@@ -23,10 +23,11 @@ describe OpenAiCommands do
       FileUtils.rm_rf('joke.txt')
     end
 
-    it 'creates a file using open ai' do
-      open_ai.new.invoke(:make, nil, ['tell me a joke', '--path', 'joke.txt'])
-      expect(File).to be_size('joke.txt')
-    end
+    # TODO: Enable test once the paid account is setup
+    # it 'creates a file using open ai' do
+    #   open_ai.new.invoke(:make, nil, ['tell me a joke', '--path', 'joke.txt'])
+    #   expect(File).to be_size('joke.txt')
+    # end
 
     it 'edits an existing file using open ai' do
       FileUtils.touch('joke.txt')

data/spec/rspec_generator_spec.rb

@@ -14,6 +14,16 @@ describe RspecGenerator do
     end
   end
 
+  shared_examples 'creates factory files' do |project_name|
+    it 'creates a model factory file' do
+      expect(File).to exist("#{project_name}/models/model_factory.rb")
+    end
+
+    it 'creates the data for the factory' do
+      expect(File).to exist("#{project_name}/models/data/users.yml")
+    end
+  end
+
   shared_examples 'creates rspec files without examples' do |project_name, file_name|
     it 'creates a spec file' do
       expect(File).not_to exist("#{project_name}/spec/#{file_name}_page_spec.rb")
@@ -26,12 +36,14 @@ describe RspecGenerator do
 
   context 'with rspec and selenium' do
     include_examples 'creates rspec files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}", 'login'
+    include_examples 'creates factory files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
     include_examples 'creates rspec files without examples',
                      "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}_without_examples", 'login'
   end
 
   context 'with rspec and watir' do
     include_examples 'creates rspec files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}", 'login'
+    include_examples 'creates factory files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[2]}"
     include_examples 'creates rspec files without examples',
                      "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES[3]}_without_examples", 'login'
   end