ruby_raider 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 343290e25435b54bda41d2a43a13eb23713e4ac1b89d773e1a981e250dce0bda
-  data.tar.gz: 72610baae56c1f6b22364d1ad5717425f781c987972a59470e831a2c8c627a8c
+  metadata.gz: c0bace14246d3e24dce83a371be3cd3b5149e7613a2f467e5258cf08f4f429c5
+  data.tar.gz: 25ff01178be1c28a0f8f183bbb7e1364b6205a0f941f6166e7b87281e36c7ba7
 SHA512:
-  metadata.gz: 8d2bbcec5a84038878369fb76d31ae8965abcf9300b7aa02957ca0ff2c4244e74c8ecd195dbb7eb053218974bc286b99fac6074baafdb40af021a5e75b56ed3b
-  data.tar.gz: 987a2a4fe907958384ba1e1ccd110987bbff1cd497577f5f51621fd3ab4bdaffdceff43bbe829ec0c9847fe7fe5ad470047da5a1c9040af29172458248f9cbd4
+  metadata.gz: 06372caf14ab5bf242cdf8a87843e1e4ccc078f7f65542580fb5c793f0c679834050f5661a6554c52bde84d95f63bf90f8db276f10d9e4c4563093ea83ac9702
+  data.tar.gz: 2b4ddad1c0743eb57f3b051c1c5abb7d28923b0a0f7fb2fa24309b9b357894b5e0257b721aa9e5a9e4986ad3bba02494a8328295a9a42f8237e0ed5c1252ad21

data/.github/auto_assign-issues.yml

@@ -0,0 +1,8 @@
+# If enabled, auto-assigns users when a new issue is created
+# Defaults to true, allows you to install the app globally, and disable on a per-repo basis
+addAssignees: true
+
+# The list of users to assign to new issues.
+# If empty or not provided, the repository owner is assigned
+assignees:
+  - aguspe

data/.github/workflows/rspec.yml

@@ -24,4 +24,6 @@ jobs:
         run: bundle install
 
       - name: Build and test with rspec
+        env:
+          OPENAI_ACCESS_TOKEN: ${{ secrets.OPENAI_ACCESS_TOKEN }}
         run: bundle exec rspec spec

data/.reek.yml

@@ -6,4 +6,8 @@ detectors:
     enabled: true
     exclude:
       - initialize
-    max_statements: 10
+    max_statements: 10
+
+exclude_paths:
+  - 'lib/desktop/components/*.rb'
+  - 'lib/desktop/screens/*.rb'

data/Rakefile

@@ -2,6 +2,7 @@
 
 require_relative 'lib/ruby_raider'
 require_relative 'lib/commands/scaffolding_commands'
+require_relative 'lib/desktop/screens/runner_screen'
 
 desc 'Creates a new test project'
 task :new, [:name] do |_t, args|
@@ -27,3 +28,8 @@ desc 'Download mobile builds'
 task :builds, [:type] do |_t, args|
   ScaffoldingCommands.new.invoke(:download_builds, nil, %W[#{args.type}])
 end
+
+desc 'Open the run screen'
+task :runner do
+  RunnerScreen.new.launch
+end

data/lib/commands/open_ai_commands.rb

@@ -10,16 +10,17 @@ class OpenAiCommands < Thor
 
   def make(request, path = nil)
     path ||= options[:path]
-    if options[:edit]
+    edit_path = options[:edit]
+    if edit_path
       pp 'Editing File...'
-      OpenAi.edit_file(options[:edit], request)
-      pp "File #{options[:edit]} edited"
+      OpenAi.edit_file(path: edit_path, request: request)
+      pp "File #{edit_path} edited"
     elsif path
       pp 'Generating File...'
-      OpenAi.create_file(path, request)
+      OpenAi.create_file(path: path, request: request)
       pp "File created in #{path}"
     else
-      puts OpenAi.output(request)
+      puts OpenAi.output(request: request)
     end
   end
 
@@ -48,9 +49,10 @@ class OpenAiCommands < Thor
 
   def steps(name)
     path = 'features/step_definitions'
-    if options[:input]
+    input = options[:input]
+    if input
       prompt = options[:prompt] || 'create cucumber steps for the following scenarios in ruby'
-      content = "#{prompt} #{File.read(options[:input])}"
+      content = "#{prompt} #{File.read(input)}"
       make(content, "#{path}/#{name}_steps.rb")
     else
       make(options[:open_ai], "#{path}/#{name}_steps.rb")

data/lib/commands/scaffolding_commands.rb

@@ -5,6 +5,8 @@ require_relative '../generators/menu_generator'
 require_relative '../scaffolding/scaffolding'
 require_relative '../commands/utility_commands'
 
+# :reek:FeatureEnvy { enabled: false }
+# :reek:UtilityFunction { enabled: false }
 class ScaffoldingCommands < Thor
   desc 'page [PAGE_NAME]', 'Creates a new page object'
   option :path,
@@ -13,12 +15,7 @@ class ScaffoldingCommands < Thor
          type: :boolean, required: false, desc: 'This will delete the selected page', aliases: '-d'
 
   def page(name)
-    path = options[:path] || load_config_path('page')
-    if options[:delete]
-      Scaffolding.new([name, path]).delete_class
-    else
-      Scaffolding.new([name, path]).generate_class
-    end
+    handle_scaffolding(name, 'page')
   end
 
   desc 'feature [NAME]', 'Creates a new feature'
@@ -30,12 +27,7 @@ class ScaffoldingCommands < Thor
          required: false, desc: 'This will delete the selected feature', aliases: '-d'
 
   def feature(name)
-    path = options[:path] || load_config_path('feature')
-    if options[:delete]
-      Scaffolding.new([name, path]).delete_feature
-    else
-      Scaffolding.new([name, path]).generate_feature
-    end
+    handle_scaffolding(name, 'feature')
   end
 
   desc 'spec [SPEC_NAME]', 'Creates a new spec'
@@ -45,12 +37,7 @@ class ScaffoldingCommands < Thor
          type: :boolean, required: false, desc: 'This will delete the selected spec', aliases: '-d'
 
   def spec(name)
-    path = options[:path] || load_config_path('spec')
-    if options[:delete]
-      Scaffolding.new([name, path]).delete_spec
-    else
-      Scaffolding.new([name, path]).generate_spec
-    end
+    handle_scaffolding(name, 'spec')
   end
 
   desc 'helper [HELPER_NAME]', 'Creates a new helper'
@@ -60,12 +47,7 @@ class ScaffoldingCommands < Thor
          type: :boolean, required: false, desc: 'This will delete the selected helper', aliases: '-d'
 
   def helper(name)
-    path = options[:path] || load_config_path('helper')
-    if options[:delete]
-      Scaffolding.new([name, path]).delete_helper
-    else
-      Scaffolding.new([name, path]).generate_helper
-    end
+    handle_scaffolding(name, 'helper')
   end
 
   desc 'scaffold [SCAFFOLD_NAME]', 'It generates everything needed to start automating'
@@ -87,5 +69,34 @@ class ScaffoldingCommands < Thor
     def load_config_path(type)
       YAML.load_file('config/config.yml')["#{type}_path"] if Pathname.new('config/config.yml').exist?
     end
+
+    def handle_scaffolding(name, type)
+      path = options[:path] || load_config_path(type)
+      scaffolding = Scaffolding.new([name, path])
+
+      if options[:delete]
+        case type
+        when 'page'
+          scaffolding.delete_class
+        when 'feature'
+          scaffolding.delete_feature
+        when 'spec'
+          scaffolding.delete_spec
+        when 'helper'
+          scaffolding.delete_helper
+        end
+      else
+        case type
+        when 'page'
+          scaffolding.generate_class
+        when 'feature'
+          scaffolding.generate_feature
+        when 'spec'
+          scaffolding.generate_spec
+        when 'helper'
+          scaffolding.generate_helper
+        end
+      end
+    end
   end
 end

data/lib/commands/utility_commands.rb

@@ -3,6 +3,8 @@
 require 'thor'
 require_relative '../utilities/utilities'
 
+# :reek:FeatureEnvy { enabled: false }
+# :reek:UtilityFunction { enabled: false }
 class UtilityCommands < Thor
   desc 'path [PATH]', 'Sets the default path for scaffolding'
   option :feature,
@@ -31,7 +33,8 @@ class UtilityCommands < Thor
 
   def browser(default_browser = nil)
     Utilities.browser = default_browser if default_browser
-    browser_options(options[:opts]) if options[:opts] || options[:delete]
+    selected_options = options[:opts]
+    browser_options(selected_options) if selected_options || options[:delete]
   end
 
   desc 'browser_options [OPTIONS]', 'Sets the browser options for the project'
@@ -50,10 +53,11 @@ class UtilityCommands < Thor
          type: :array, required: false, desc: 'The options that your run will run with', aliases: '-o'
 
   def raid
+    selected_options = options[:opts]
     if options[:parallel]
-      Utilities.parallel_run(options[:opts])
+      Utilities.parallel_run(selected_options)
     else
-      Utilities.run(options[:opts])
+      Utilities.run(selected_options)
     end
   end
 
@@ -69,10 +73,18 @@ class UtilityCommands < Thor
     Utilities.platform = platform
   end
 
-  desc 'builds [BUILD_TYPE]', 'It downloads the example builds for appium projects'
-  def builds(build_type)
-    raise 'Please select one of the following build types: android, ios, both' unless %w[android ios both].include?(build_type)
+  desc 'build [BUILD_TYPE]', 'It downloads the selected example build for appium projects'
 
-    Utilities.download_builds build_type
+  def build(build_type)
+    raise 'Please select one of the following build types: android, ios' unless %w[android ios].include?(build_type)
+
+    build_type == 'android' ? Utilities.download_android_build : Utilities.download_ios_build
+  end
+
+  desc 'builds', 'It downloads both builds for appium cross platform projects'
+
+  def builds
+    Utilities.download_android_build
+    Utilities.download_ios_build
   end
 end

data/lib/desktop/components/base_component.rb

@@ -0,0 +1,18 @@
+require 'glimmer-dsl-libui'
+
+class BaseComponent
+  include Glimmer
+
+  def initialize
+    super
+    if File.directory?('spec')
+      @folder = 'spec'
+      @framework = 'rspec'
+      @extension = '*_spec.rb'
+    else
+      @folder = 'features'
+      @framework = 'cucumber'
+      @extension = '*.features'
+    end
+  end
+end

data/lib/desktop/components/runner_components.rb

@@ -0,0 +1,195 @@
+require 'open3'
+require 'yaml'
+require_relative 'base_component'
+require_relative '../../scaffolding/scaffolding'
+
+class RunnerComponents < BaseComponent
+  attr_accessor :contacts
+
+  CONFIG_ITEM = Struct.new(:attribute, :value)
+  CAP = Struct.new(:attribute, :value)
+
+  def initialize
+    super
+    @folder_exist = File.directory?(@folder)
+  end
+
+  def header
+    grid do
+      stretchy false
+
+      button('▶') do
+        left 0
+        on_clicked do
+          output = Open3.popen3("#{@framework} #{@tests.selected_item}") do |_stdin, stdout, _stderr|
+            stdout.read
+          end
+          system "#{@framework} #{@tests.selected_item}"
+          @results.text = output
+        end
+      end
+      button('■') do
+        left 1
+        on_clicked do
+          pp 'The stop feature will be implemented in a later release'
+        end
+      end
+
+      @tests = combobox do
+        left 2
+        files = Dir.glob(File.join(@folder, @extension))
+        multiple_items = files.count.positive? ? files : ['There are no tests please create a new one']
+        items multiple_items
+        selected_item files.first
+        @file = files.count.positive? ? File.open(files.first) : ''
+
+        on_selected do |items|
+          @results.text = ''
+          path = items.selected_item
+          @file = File.open(path)
+          @text_box.text = @file.read
+        end
+      end
+
+      button('Open Dashboard') do
+        left 3
+        halign :end
+        on_clicked do
+          system 'allure serve allure-reports'
+        end
+      end
+    end
+  end
+
+  def tests_tab
+    tab_item('Tests') do
+      horizontal_box do
+        @text_box = multiline_entry do
+          test_code = @folder_exist ? @file.read : 'No tests have been created, please create your first test'
+          text test_code
+
+          on_changed do |e|
+            File.write(@tests.selected_item, e.text)
+            $stdout.flush # for Windows
+          end
+        end
+
+        @results = multiline_entry do
+          text ''
+        end
+      end
+    end
+  end
+
+  def config_tab
+    tab_item('Configuration') do
+      @config_data = load_or_create_config
+      @config_items = @config_data.map { |key, value| CONFIG_ITEM.new(key, value) }
+      vertical_box do
+        refined_table(
+          model_array: @config_items,
+          table_columns: {
+            'Attribute' => :text,
+            'Value' => { text: { editable: true } }
+          },
+          table_editable: true,
+          per_page: 20
+        )
+      end
+    end
+  end
+
+  def editor_tab
+    tab_item('Editor') do
+      horizontal_box do
+        vertical_box do
+          horizontal_box do
+            button('Create Test') do
+              on_clicked do
+                Scaffolding.new([@test_name.text]).generate_spec
+              end
+            end
+            @test_name = entry do
+              text 'test_example'
+            end
+          end
+          horizontal_box do
+            button('Create Page') do
+              on_clicked do
+                Scaffolding.new([@page_name.text]).generate_class
+              end
+            end
+            @page_name = entry do
+              text 'page_example'
+            end
+          end
+          horizontal_box do
+            button('Create Helper') do
+              on_clicked do
+                Scaffolding.new([@helper_name.text]).generate_helper
+              end
+            end
+            @helper_name = entry do
+              text 'helper_example'
+            end
+          end
+          vertical_separator do
+            stretchy false
+          end
+        end
+        vertical_box do
+          @editable_files = combobox do
+            @all_files = @folder_exist ? load_all_files : ['There are no files created']
+            stretchy false
+            visible true
+            items @all_files
+            selected_item @all_files.first
+
+            on_selected do |items|
+              if @folder_exist
+                path = items.selected_item
+                @edit_file = File.open(path)
+                @edit_box.text = @edit_file.read
+              end
+            end
+          end
+          @edit_box = multiline_entry do
+            text File.read(@all_files.first) if @folder_exist
+
+            on_changed do |e|
+              if @folder_exist
+                File.write(@editable_files.selected_item, e.text)
+                $stdout.flush # for Windows
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  private
+
+  def load_all_files
+    test_files = Dir.glob(File.join(@folder, @extension))
+    page_object_files = Dir.glob(File.join('page_objects/pages', '*.rb'))
+    helper_files = Dir.glob(File.join('helpers', '*.rb'))
+    test_files + page_object_files + helper_files
+  end
+
+  def load_or_create_config
+    file_paths = {
+      config: 'config/config.yml',
+      caps: 'config/capabilities.yml',
+      opts: 'config/options.yml'
+    }
+
+    loaded_files = file_paths.transform_values do |path|
+      File.exist?(path) ? YAML.load_file(path) : {}
+    end
+
+    return { message: 'Create a config file to access your attributes' } if loaded_files.values.all?(&:empty?)
+
+    loaded_files[:config].merge(loaded_files[:caps]).merge(loaded_files[:opts])
+  end
+end

data/lib/desktop/screens/runner_screen.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../components/runner_components'
+
+class RunnerScreen < RunnerComponents
+  def launch
+    window('Ruby Raider', 1200, 800) do
+      margined true
+      vertical_box do
+        header
+        tab do
+          stretchy true
+          tests_tab
+          editor_tab
+          config_tab
+        end
+      end
+    end.show
+  end
+end

data/lib/generators/automation/automation_examples_generator.rb

@@ -3,34 +3,37 @@
 require_relative '../generator'
 
 class AutomationExamplesGenerator < Generator
-  def generate_login_page
-    return unless (@_initializer.first & %w[android ios cross_platform]).empty?
+  def generate_example_files
+    if mobile_platform?
+      generate_home_page
+      generate_pdp_page
+    else
+      generate_login_page
+      generate_header_component unless visual_selected?
+    end
+
+    generate_app_page if visual_selected?
+  end
 
+  private
+
+  def generate_login_page
     template('login_page.tt', "#{name}/page_objects/pages/login_page.rb")
   end
 
   def generate_home_page
-    return if (@_initializer.first & %w[android ios cross_platform]).empty?
-
     template('home_page.tt', "#{name}/page_objects/pages/home_page.rb")
   end
 
   def generate_pdp_page
-    return if (@_initializer.first & %w[android ios cross_platform]).empty?
-
     template('pdp_page.tt', "#{name}/page_objects/pages/pdp_page.rb")
   end
 
   def generate_header_component
-    return unless (@_initializer.first & %w[android ios cross_platform]).empty?
-    return if @_initializer.first.last
-
     template('component.tt', "#{name}/page_objects/components/header_component.rb")
   end
 
   def generate_app_page
-    return unless @_initializer.first.last
-
     template('app_page.tt', "#{name}/page_objects/pages/app_page.rb")
   end
 end

data/lib/generators/automation/automation_generator.rb

@@ -8,20 +8,20 @@ class AutomationGenerator < Generator
   end
 
   def generate_abstract_component
-    return unless (@_initializer.first & %w[android ios cross_platform]).empty?
-    return if @_initializer.first.last
+    return if mobile_platform?
+    return if visual_selected?
 
     template('abstract_component.tt', "#{name}/page_objects/abstract/abstract_component.rb")
   end
 
   def generate_appium_settings
-    return if (@_initializer.first & %w[android ios cross_platform]).empty?
+    return unless mobile_platform?
 
     template('appium_caps.tt', "#{name}/config/capabilities.yml")
   end
 
   def generate_visual_options
-    return unless @_initializer.first.last
+    return unless visual_selected?
 
     template('visual_options.tt', "#{name}/config/options.yml")
   end

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

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 require_relative '../abstract/abstract_page'
 require_relative '../components/header_component'
 
 class LoginPage < AbstractPage
-  using Raider::SeleniumHelper
-
   def url(_page)
     'index.php?rt=account/login'
   end
@@ -13,13 +13,13 @@ class LoginPage < AbstractPage
   def login(username, password)
     username_field.send_keys username
     password_field.send_keys password
-    login_button.click_when_present
+    login_button.click
   end
 
   # Components
 
   def header
-    HeaderComponent.new(@driver.find_element(class: 'menu_text'))
+    HeaderComponent.new(driver.find_element(class: 'menu_text'))
   end
 
   private
@@ -37,4 +37,4 @@ class LoginPage < AbstractPage
   def login_button
     driver.find_element(xpath: "//button[@title='Login']")
   end
-end
+end

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

@@ -3,6 +3,7 @@
     "#{base_url}#{url(*page)}"
   end
 
+  # :reek:UtilityFunction
   def base_url
     YAML.load_file('config/config.yml')['url']
   end

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

@@ -18,7 +18,7 @@ class LoginPage < AbstractPage
   # Components
 
   def header
-    HeaderComponent.new(@browser.element(class: 'menu_text'))
+    HeaderComponent.new(browser.element(class: 'menu_text'))
   end
 
   private

data/lib/generators/common_generator.rb

@@ -8,7 +8,7 @@ class CommonGenerator < Generator
   end
 
   def generate_config_file
-    return unless (@_initializer.first & %w[android ios]).empty?
+    return if mobile_platform?
 
     template('common/config.tt', "#{name}/config/config.yml")
   end
@@ -21,11 +21,19 @@ class CommonGenerator < Generator
     template('common/gemfile.tt', "#{name}/Gemfile")
   end
 
+  def generate_reek_file
+    template('common/reek.tt', "#{name}/.reek.yml")
+  end
+
+  def generate_rubocop_file
+    template('common/rubocop.tt', "#{name}/.rubocop.yml")
+  end
+
   def create_allure_folder
-    empty_directory "#{name}/allure-results" unless @_initializer.first.last
+    empty_directory "#{name}/allure-results" unless visual_selected?
   end
 
   def create_screenshots_folder
-    empty_directory "#{name}/allure-results/screenshots" unless @_initializer.first.last
+    empty_directory "#{name}/allure-results/screenshots" unless visual_selected?
   end
 end

data/lib/generators/generator.rb

@@ -11,6 +11,26 @@ class Generator < Thor::Group
   argument :visual_automation, optional: true
 
   def self.source_paths
-    %W[#{File.dirname(__FILE__)}/automation/templates #{File.dirname(__FILE__)}/cucumber/templates #{File.dirname(__FILE__)}/rspec/templates #{File.dirname(__FILE__)}/templates]
+    base_path = File.dirname(__FILE__)
+    %W[#{base_path}/automation/templates #{base_path}/cucumber/templates #{base_path}/rspec/templates #{base_path}/templates]
   end
+
+  def args
+    initializer.first
+  end
+
+  def visual_selected?
+    initializer.first.last
+  end
+
+  def mobile_platform?
+    (args & %w[android ios cross_platform]).count.positive?
+  end
+
+  private
+
+  def _initializer
+    @_initializer ||= super
+  end
+  alias initializer _initializer
 end