ruby_raider 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8c15738eebba5735e6bcfa2af5c1f00e888eb86ca1de8d19bf7bc4603e4fe41
-  data.tar.gz: b799c4a2639ab0579125936236fcdf619a91a35d6e645bab6baf76fc5ec40c04
+  metadata.gz: c5a0388aca21402e7be2b8d5ca425f3041941f3ad881447bce6f90569414403a
+  data.tar.gz: 7efeafb1ac1f8ab1549f7105da42a5687ef493681816ecf814778eadfa084549
 SHA512:
-  metadata.gz: 8976146e76db3e511ab1dde689079479ca3ae76375cece5868505246fb7a0b9ad5e037c351c1046f7307e37cc18ec0d74f2df410eed91ee5fc1249163f503534
-  data.tar.gz: 3d6c1a42068b5130356bb3c8afd2cfa7ce88fdedae1f504b786d125b147d95b5b0198abb7fc1d9d68906860c6d5ad5577370f3db1cfe81cc959ed44b9647fb90
+  metadata.gz: a307df303d10f89f67a3efc9997d330ec2b29796f6ad29d5f7cddf4197e532a4bb545414a0a00a0503cfaa5bf34e1d936044e3119560157cd31c5b0194d17d55
+  data.tar.gz: b6e18d3e3fcb74f2127bea109c66e68302af4baf1def97ca3b6f6d3bc1ee027f642d4bbb7794f491477af7f5b00995abb4ec1b1977cde83687649737e2bb7a1b

data/.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [ruby_raider]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/Rakefile

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

data/lib/desktop/base_screen.rb

@@ -0,0 +1,5 @@
+require 'glimmer-dsl-libui'
+
+class BaseScreen
+  include Glimmer
+end

data/lib/desktop/installation_screen.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require_relative 'base_screen'
+require_relative '../generators/invoke_generators'
+
+class InstallationScreen < BaseScreen
+  include InvokeGenerators
+
+  attr_accessor :entry_text
+
+  def launch
+    window('Ruby Raider', 800, 600) do
+      margined true
+      tab do
+        tab_item('Installer') do
+          vertical_box do
+            vertical_box do
+              stretchy false
+              label('Project Name') do
+                stretchy false
+              end
+
+              entry do
+                stretchy false # Smart default option for appending to horizontal_box
+                text <=> [self, :entry_text, { after_write: lambda { |text|
+                  @project_name = text
+                  $stdout.flush
+                } }] # bidirectional data-binding between text property and entry_text attribute, printing after write to model.
+              end
+            end
+
+            vertical_box do
+              stretchy false
+
+              @radio = radio_buttons do
+                stretchy false
+
+                items 'Web', 'Mobile'
+                selected_item 'Web'
+                on_selected do |buttons|
+                  if buttons.selected_item == 'Web'
+                    @mobile_automation.hide
+                    @platforms.hide
+                    @web_automation.show
+                  else
+                    @web_automation.hide
+                    @mobile_automation.show
+                    @platforms.show
+                  end
+                end
+              end
+
+              @mobile_automation = combobox do
+                stretchy false
+                visible false
+                items 'Appium'
+                selected_item 'Appium'
+              end
+
+              @web_automation = combobox do
+                stretchy false
+                visible true
+                items 'Selenium', 'Watir'
+                selected_item 'Selenium'
+              end
+
+              @platforms = combobox do
+                stretchy false
+                visible false
+                items 'Android', 'iOS', 'Cross-Platform'
+                selected_item 'iOS'
+              end
+
+              @framework = combobox do
+                stretchy false
+                visible true
+                items 'Cucumber', 'Rspec'
+                selected_item 'Cucumber'
+
+                on_selected do |items|
+                  if items.selected_item == 'Rspec' && @radio.selected_item != 'Mobile'
+                    @visual_checkbox.show
+                  else
+                    @visual_checkbox.hide
+                  end
+                end
+              end
+
+              @visual_checkbox = checkbox('Applitools integration') do
+                stretchy false
+                visible false
+              end
+
+              @example_checkbox = checkbox('Add example files') do
+                stretchy false
+                visible true
+              end
+
+              button('Create Project') do
+                stretchy false
+                on_clicked do
+                  automation = if @web_automation.visible?
+                                 @web_automation.selected_item
+                               else
+                                 @mobile_automation.selected_item
+                               end
+                  structure = {
+                    automation: automation,
+                    examples: @example_checkbox.checked,
+                    framework: @framework.selected_item,
+                    generators: %w[Automation Common Helpers],
+                    name: @project_name,
+                    visual: @visual_checkbox.checked
+                  }
+                  generate_framework(structure)
+                  @installation_box.text = if File.directory?(@project_name)
+                                             "Your project has been created, close this window, go to the folder #{@project_name} and run 'raider open'"
+                                           else
+                                             'There was a problem creating your project try again'
+                                           end
+                end
+              end
+            end
+            vertical_box do
+              stretchy false
+              @installation_box = multiline_entry do
+                stretchy false
+                text 'Your installation result will appear here...'
+                $stdout.flush
+              end
+            end
+          end
+        end
+      end
+    end.show
+  end
+end

data/lib/desktop/runner_screen.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'yaml'
+require_relative 'base_screen'
+
+class RunnerScreen < BaseScreen
+  attr_accessor :contacts
+
+  CONFIG_ITEM = Struct.new(:attribute, :value)
+  CAP = Struct.new(:attribute, :value)
+
+  if File.directory?('spec')
+    @folder = 'spec'
+    @framework = 'rspec'
+    @extension = '*_spec.rb'
+  else
+    @folder = 'features'
+    @framework = 'cucumber'
+    @extension = '*.features'
+  end
+
+  window('Ruby Raider', 1200, 800) do
+    margined true
+    vertical_box do
+      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 "rspec #{@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))
+          items files
+          selected_item files.first
+          @file = 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
+
+      tab do
+        stretchy true
+
+        tab_item('Tests') do
+          horizontal_box do
+            @text_box = multiline_entry do
+              text @file.read
+
+              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
+
+        tab_item('Configuration') do
+          @config = YAML.load_file('config/config.yml')
+          config_items = @config.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
+        tab_item('Capabilities') do
+          caps = File.exist?('config/capabilities.yml') ? YAML.load_file('config/capabilities.yml') : []
+          caps = caps.map { |key, value| CAP.new(key, value) }
+          vertical_box do
+            refined_table(
+              model_array: caps,
+              table_columns: {
+                'Attribute' => :text,
+                'Value' => { text: { editable: true } }
+              },
+              table_editable: true,
+              per_page: 20
+            )
+          end
+        end
+      end
+    end
+  end.show
+end

data/lib/generators/automation/automation_examples_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative '../generator'
+
+class AutomationExamplesGenerator < Generator
+  def generate_login_page
+    return unless (@_initializer.first & %w[android ios cross_platform]).empty?
+
+    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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../generator'
+
+class AutomationGenerator < Generator
+  def generate_abstract_page
+    template('abstract_page.tt', "#{name}/page_objects/abstract/abstract_page.rb")
+  end
+
+  def generate_abstract_component
+    return unless (@_initializer.first & %w[android ios cross_platform]).empty?
+    return if @_initializer.first.last
+
+    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?
+
+    template('appium_caps.tt', "#{name}/config/capabilities.yml")
+  end
+
+  def generate_visual_options
+    return unless @_initializer.first.last
+
+    template('visual_options.tt', "#{name}/config/options.yml")
+  end
+end

data/lib/generators/cucumber/cucumber_examples_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../generator'
+
+class CucumberExamplesGenerator < Generator
+  def generate_feature
+    template('feature.tt', "#{name}/features/#{template_name}.feature")
+  end
+
+  def generate_steps
+    template('steps.tt', "#{name}/features/step_definitions/#{template_name}_steps.rb")
+  end
+
+  def template_name
+    @template_name ||= (@_initializer.first & %w[android ios cross_platform]).empty? ? 'login' : 'home'
+  end
+end

data/lib/generators/cucumber/cucumber_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../generator'
+
+class CucumberGenerator < Generator
+  def generate_env_file
+    template('env.tt', "#{name}/features/support/env.rb")
+  end
+
+  def generate_world
+    template('world.tt', "#{name}/world.rb")
+  end
+end

data/lib/generators/generator.rb

@@ -10,7 +10,7 @@ class Generator < Thor::Group
   argument :name
   argument :visual_automation, optional: true
 
-  def self.source_root
-    "#{File.dirname(__FILE__)}/templates"
+  def self.source_paths
+    %W[#{File.dirname(__FILE__)}/automation/templates #{File.dirname(__FILE__)}/cucumber/templates #{File.dirname(__FILE__)}/rspec/templates #{File.dirname(__FILE__)}/templates]
   end
 end

data/lib/generators/invoke_generators.rb

@@ -0,0 +1,47 @@
+require_relative 'automation/automation_generator'
+require_relative 'automation/automation_examples_generator'
+require_relative 'common_generator'
+require_relative 'cucumber/cucumber_generator'
+require_relative 'cucumber/cucumber_examples_generator'
+require_relative 'helper_generator'
+require_relative 'rspec/rspec_generator'
+require_relative 'rspec/rspec_examples_generator'
+
+module InvokeGenerators
+  def generate_framework(structure = {})
+    generators = %w[Automation Common Helpers]
+    add_generator(generators, structure[:framework].capitalize)
+    generators = add_examples(generators) if structure[:examples]
+    generators.each do |generator|
+      invoke_generator({
+                         automation: structure[:automation],
+                         framework: structure[:framework],
+                         generator: generator,
+                         name: structure[:name],
+                         visual: structure[:visual]
+                       })
+    end
+  end
+
+  def add_generator(generators, *gens)
+    gens.each { |generator| generators.push generator }
+  end
+
+  def add_examples(generators)
+    if generators.include?('Cucumber')
+      generators.push('CucumberExamples')
+    else
+      generators.push('RspecExamples')
+    end
+
+    generators.push('AutomationExamples')
+  end
+
+  def invoke_generator(structure = {})
+    Object.const_get("#{structure[:generator]}Generator")
+          .new([structure[:automation],
+                structure[:framework],
+                structure[:name],
+                structure[:visual]]).invoke_all
+  end
+end

data/lib/generators/menu_generator.rb

@@ -1,19 +1,16 @@
 # frozen_string_literal: true
 
 require 'tty-prompt'
-require_relative 'automation_generator'
-require_relative 'common_generator'
-require_relative 'cucumber_generator'
-require_relative 'helper_generator'
-require_relative 'rspec_generator'
+require_relative '../generators/invoke_generators'
 
 class MenuGenerator
-  attr_reader :prompt, :name, :generators
+  attr_reader :prompt, :name
+
+  include InvokeGenerators
 
   def initialize(project_name)
     @prompt = TTY::Prompt.new
     @name = project_name
-    @generators = %w[Automation Common Helpers]
   end
 
   def generate_choice_menu
@@ -27,7 +24,7 @@ class MenuGenerator
 
   def choose_visual_automation
     prompt.select('Do you want to add visual automation with applitools?') do |menu|
-      menu.choice :Yes, -> { true  }
+      menu.choice :Yes, -> { true }
       menu.choice :No, -> { false }
       menu.choice :Quit, -> { exit }
     end
@@ -39,8 +36,15 @@ class MenuGenerator
     select_test_framework(automation)
   end
 
-  def set_up_framework(automation, framework, visual_automation)
-    generate_framework(automation, framework, visual_automation)
+  def set_up_framework(automation, framework, visual_automation, with_examples)
+    structure = {
+      automation: automation,
+      framework: framework,
+      name: @name,
+      visual: visual_automation,
+      examples: with_examples
+    }
+    generate_framework(structure)
     system "cd #{name} && gem install bundler && bundle install"
   end
 
@@ -53,35 +57,28 @@ class MenuGenerator
     end
   end
 
-  def generate_framework(automation, framework, visual_automation)
-    add_generator framework.capitalize
-    generators.each { |generator| invoke_generator(automation, framework, generator, visual_automation) }
-  end
-
-  protected
-
-  def add_generator(*opts)
-    opts.each { |opt| @generators.push opt }
-  end
-
   private
 
-  def framework_choice(framework, automation_type)
+  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)
+    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, -> { framework_choice('Cucumber', automation) }
-      menu.choice :Rspec, -> { framework_choice('Rspec', automation) }
+      menu.choice :Cucumber, -> { select_example_files('Cucumber', automation) }
+      menu.choice :Rspec, -> { select_example_files('Rspec', automation) }
       menu.choice :Quit, -> { exit }
     end
   end
 
-  def invoke_generator(automation, framework, generator, visual_automation)
-    Object.const_get("#{generator}Generator").new([automation, framework, name, visual_automation]).invoke_all
+  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 :Quit, -> { exit }
+    end
   end
 end

data/lib/generators/rspec/rspec_examples_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../generator'
+
+class RspecExamplesGenerator < Generator
+  def generate_login_spec
+    return unless (@_initializer.first & %w[android ios cross_platform]).empty?
+
+    template('spec.tt', "#{name}/spec/login_page_spec.rb")
+  end
+
+  def generate_pdp_spec
+    return if (@_initializer.first & %w[android ios cross_platform]).empty?
+
+    template('spec.tt', "#{name}/spec/pdp_page_spec.rb")
+  end
+end

data/lib/generators/rspec/rspec_generator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative '../generator'
+
+class RspecGenerator < Generator
+  def generate_base_spec
+    template('base_spec.tt', "#{name}/spec/base_spec.rb")
+  end
+end

data/lib/ruby_raider.rb

@@ -3,6 +3,8 @@
 require_relative '../lib/commands/open_ai_commands'
 require_relative '../lib/commands/scaffolding_commands'
 require_relative '../lib/commands/utility_commands'
+require_relative '../lib/desktop/installation_screen'
+require_relative '../lib/desktop/runner_screen'
 
 module RubyRaider
   class Raider < Thor
@@ -14,6 +16,11 @@ module RubyRaider
 
     map '-n' => 'new'
 
+    desc 'open', 'It opens the Ruby Raider desktop app'
+    def open
+      InstallationScreen.new.launch
+    end
+
     desc 'version', 'It shows the version of Ruby Raider you are currently using'
     def version
       spec = Gem::Specification.find_by_name('ruby_raider')

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.5.6'
+  s.version     = '0.5.7'
   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']
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop-rspec', '~> 2.9.0'
 
   s.add_runtime_dependency 'faraday', '~> 2.7'
+  s.add_runtime_dependency 'glimmer-dsl-libui', '~> 0.7.3'
   s.add_runtime_dependency 'ruby-openai', '~> 3.5'
   s.add_runtime_dependency 'thor', '~> 1.2.1'
   s.add_runtime_dependency 'tty-prompt', '~> 0.23.1'