ruby_raider 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b40b177b2b89c4585ae988d6c1747e7eb58761d4817cac54a194ae532f80d77
-  data.tar.gz: e758ab9ef9922f963b5f3da0763713c7c1cba1890d1d6974b687a6fa62a7eaed
+  metadata.gz: 07240bddaf0b3edae4d1d8202df31ac428c143941680f02fb51ea54a8b478d37
+  data.tar.gz: 887a4fc52c2c5899cc5999292a1edd3a357d1ecedbac9dea691edb06f980c6f5
 SHA512:
-  metadata.gz: 574e301014b379f362a08aba90a5dda00391210c602d751a0f6e953c37f19c9c07364c9556944eae47b5ef15a58f2170b1530436fef6c520454895de72f8c253
-  data.tar.gz: a2f4a9319b508daf6ffb39498eeeacb97b1544ddd44eb19e9832c2db69c121c8df7c784002de9e5847e9d6732db997b63996d98ea285eda8f4c10544f170f8dd
+  metadata.gz: d4cf0f65241e104cb96ee22ee79e61a24e049cf834aed0ea0098ea801f64cabe0a037d3846f50c5d60148b50e4a2621fa06329f1a697ea2ee8750b6656c78a49
+  data.tar.gz: ed34541a0df8cf638630d6db03617e1aff99a0fb7432378971ccd371242be91624c3940e94769acc9d5058194b27a946d40c15a955291ff2d5dee5de5d413e55

data/Rakefile

@@ -12,4 +12,4 @@ desc 'Create a page'
 task :page, [:name] do |_t, args|
   RubyRaider.start
   RubyRaider.page(args.page)
-end
+end

data/lib/generators/automation_generator.rb

@@ -12,32 +12,30 @@ class AutomationGenerator < Generator
   end
 
   def generate_home_page
-    if @_initializer.first.include?('appium_ios')
-      template('automation/home_page.tt', "#{name}/page_objects/pages/home_page.rb")
-    end
+    return unless @_initializer.first.include?('appium_ios')
+
+    template('automation/home_page.tt', "#{name}/page_objects/pages/home_page.rb")
   end
 
   def generate_header_component
-    unless @_initializer.first.include?('appium_ios')
-      template('automation/component.tt', "#{name}/page_objects/components/header_component.rb")
-    end
+    return if @_initializer.first.include?('appium_ios')
+
+    template('automation/component.tt', "#{name}/page_objects/components/header_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
+    return if @_initializer.first.include?('appium_ios')
+
+    template('automation/abstract_component.tt', "#{name}/page_objects/abstract/abstract_component.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
+    return unless @_initializer.first.include?('appium_ios')
+
+    template('automation/confirmation_page.tt', "#{name}/page_objects/pages/confirmation_page.rb")
   end
 
   def generate_appium_settings
-    if @_initializer.first.include?('appium_ios')
-      template('automation/appium_settings.tt', "#{name}/appium.txt")
-    end
+    template('automation/appium_settings.tt', "#{name}/appium.txt") if @_initializer.first.include?('appium_ios')
   end
 end

data/lib/generators/common_generator.rb

@@ -27,4 +27,3 @@ class CommonGenerator < Generator
     empty_directory "#{name}/allure-results/screenshots"
   end
 end
-

data/lib/generators/cucumber_generator.rb

@@ -15,4 +15,3 @@ class CucumberGenerator < Generator
     template('cucumber/env.tt', "#{name}/features/support/env.rb")
   end
 end
-

data/lib/generators/generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'thor'
 
 class Generator < Thor::Group
@@ -9,7 +10,6 @@ class Generator < Thor::Group
   argument :name
 
   def self.source_root
-    File.dirname(__FILE__) + '/templates'
+    "#{File.dirname(__FILE__)}/templates"
   end
 end
-

data/lib/generators/helper_generator.rb

@@ -3,7 +3,6 @@
 require_relative 'generator'
 
 class HelpersGenerator < Generator
-
   def generate_raider_helper
     template('helpers/raider_helper.tt', "#{name}/helpers/raider.rb")
   end
@@ -13,26 +12,22 @@ class HelpersGenerator < Generator
   end
 
   def generate_browser_helper
-    if @_initializer.first.include?('watir')
-      template('helpers/browser_helper.tt', "#{name}/helpers/browser_helper.rb")
-    end
+    template('helpers/browser_helper.tt', "#{name}/helpers/browser_helper.rb") if @_initializer.first.include?('watir')
   end
 
   def generate_spec_helper
-    if @_initializer.first.include?('rspec')
-      template('helpers/spec_helper.tt', "#{name}/helpers/spec_helper.rb")
-    end
+    template('helpers/spec_helper.tt', "#{name}/helpers/spec_helper.rb") if @_initializer.first.include?('rspec')
   end
 
   def generate_selenium_helper
-    if @_initializer.first.include?('selenium')
-      template('helpers/selenium_helper.tt', "#{name}/helpers/selenium_helper.rb")
-    end
+    return unless @_initializer.first.include?('selenium')
+
+    template('helpers/selenium_helper.tt', "#{name}/helpers/selenium_helper.rb")
   end
 
   def generate_driver_helper
-    unless @_initializer.first.include?('watir')
-      template('helpers/driver_helper.tt', "#{name}/helpers/driver_helper.rb")
-    end
+    return if @_initializer.first.include?('watir')
+
+    template('helpers/driver_helper.tt', "#{name}/helpers/driver_helper.rb")
   end
 end

data/lib/generators/rspec_generator.rb

@@ -3,7 +3,6 @@
 require_relative 'generator'
 
 class RspecGenerator < Generator
-
   def generate_spec
     template('rspec/spec.tt', "#{name}/spec/login_page_spec.rb")
   end
@@ -12,4 +11,3 @@ class RspecGenerator < Generator
     template('rspec/base_spec.tt', "#{name}/spec/base_spec.rb")
   end
 end
-

data/lib/ruby_raider.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'yaml'
 require_relative 'generators/menu_generator'
@@ -5,17 +7,17 @@ require_relative '../lib/scaffolding/scaffolding'
 require_relative '../lib/utilities/utilities'
 
 class RubyRaider < Thor
-  desc "new [PROJECT_NAME]", "Creates a new framework based on settings picked"
+  desc 'new [PROJECT_NAME]', 'Creates a new framework based on settings picked'
 
   def new(project_name)
     MenuGenerator.generate_choice_menu(project_name)
   end
 
-  desc "page [PAGE_NAME]", "Creates a new page object"
+  desc 'page [PAGE_NAME]', 'Creates a new page object'
   option :path,
-         :type => :string, :required => false, :desc => 'The path where your page will be created', :aliases => '-p'
+         type: :string, required: false, desc: 'The path where your page will be created', aliases: '-p'
   option :delete,
-         :type => :boolean, :required => false, :desc => 'This will delete the selected page', :aliases => '-d'
+         type: :boolean, required: false, desc: 'This will delete the selected page', aliases: '-d'
 
   def page(name)
     path = options[:path].nil? ? load_config_path('page') : options[:path]
@@ -26,11 +28,11 @@ class RubyRaider < Thor
     end
   end
 
-  desc "feature [FEATURE_NAME]", "Creates a new feature"
+  desc 'feature [FEATURE_NAME]', 'Creates a new feature'
   option :path,
-         :type => :string, :required => false, :desc => 'The path where your feature will be created', :aliases => '-p'
+         type: :string, required: false, desc: 'The path where your feature will be created', aliases: '-p'
   option :delete,
-         :type => :boolean, :required => false, :desc => 'This will delete the selected feature', :aliases => '-d'
+         type: :boolean, required: false, desc: 'This will delete the selected feature', aliases: '-d'
 
   def feature(name)
     path = options[:path].nil? ? load_config_path('feature') : options[:path]
@@ -41,11 +43,11 @@ class RubyRaider < Thor
     end
   end
 
-  desc "spec [SPEC_NAME]", "Creates a new spec"
+  desc 'spec [SPEC_NAME]', 'Creates a new spec'
   option :path,
-         :type => :string, :required => false, :desc => 'The path where your spec will be created', :aliases => '-p'
+         type: :string, required: false, desc: 'The path where your spec will be created', aliases: '-p'
   option :delete,
-         :type => :boolean, :required => false, :desc => 'This will delete the selected spec', :aliases => '-d'
+         type: :boolean, required: false, desc: 'This will delete the selected spec', aliases: '-d'
 
   def spec(name)
     path = options[:path].nil? ? load_config_path('spec') : options[:path]
@@ -56,11 +58,11 @@ class RubyRaider < Thor
     end
   end
 
-  desc "helper [HELPER_NAME]", "Creates a new helper"
+  desc 'helper [HELPER_NAME]', 'Creates a new helper'
   option :path,
-         :type => :string, :required => false, :desc => 'The path where your helper will be created', :aliases => '-p'
+         type: :string, required: false, desc: 'The path where your helper will be created', aliases: '-p'
   option :delete,
-         :type => :boolean, :required => false, :desc => 'This will delete the selected helper', :aliases => '-d'
+         type: :boolean, required: false, desc: 'This will delete the selected helper', aliases: '-d'
 
   def helper(name)
     path = options[:path].nil? ? load_config_path('helper') : options[:path]
@@ -71,36 +73,49 @@ class RubyRaider < Thor
     end
   end
 
-  desc "path [PATH]", "Sets the default path for scaffolding"
+  desc 'path [PATH]', 'Sets the default path for scaffolding'
   option :feature,
-         :type => :boolean, :required => false, :desc => 'The default path for your features', :aliases => '-f'
+         type: :boolean, required: false, desc: 'The default path for your features', aliases: '-f'
   option :helper,
-         :type => :boolean, :required => false, :desc => 'The default path for your helpers', :aliases => '-h'
+         type: :boolean, required: false, desc: 'The default path for your helpers', aliases: '-h'
   option :spec,
-         :type => :boolean, :required => false, :desc => 'The default path for your specs', :aliases => '-s'
+         type: :boolean, required: false, desc: 'The default path for your specs', aliases: '-s'
   def path(default_path)
     type = options.empty? ? 'page' : options.keys.first
     Utilities.new.send("#{type}_path=", default_path)
   end
 
-  desc "url [URL]", "Sets the default url for a project"
+  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"
+  desc 'browser [BROWSER]', 'Sets the default browser for a project'
 
   def browser(default_browser)
     Utilities.new.browser = default_browser
   end
 
-  desc "raid", "It runs all the tests in a project"
+  desc 'raid', 'It runs all the tests in a project'
 
   def raid
     Utilities.new.run
   end
 
+  desc 'scaffold [SCAFFOLD_NAME]', 'It generates everything needed to start automating'
+  def scaffold(name)
+    if Pathname.new('spec').exist? && !Pathname.new('features').exist?
+      Scaffolding.new([name, load_config_path('spec')]).generate_spec
+      Scaffolding.new([name, load_config_path('page')]).generate_class
+    elsif Pathname.new('features').exist?
+      Scaffolding.new([name, load_config_path('feature')]).generate_feature
+      Scaffolding.new([name, load_config_path('page')]).generate_class
+    else
+      raise 'No features or spec folders where found. We are not sure which type of project you are running'
+    end
+  end
+
   no_commands do
     def load_config_path(type)
       YAML.load_file('config/config.yml')["#{type}_path"] unless YAML.load_file('config/config.yml').nil?

data/lib/scaffolding/scaffolding.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 
 class Scaffolding < Thor::Group
@@ -7,7 +9,7 @@ class Scaffolding < Thor::Group
   argument :path, optional: true
 
   def self.source_root
-    File.dirname(__FILE__) + '/templates'
+    "#{File.dirname(__FILE__)}/templates"
   end
 
   def generate_class

data/lib/utilities/utilities.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 class Utilities

data/ruby_raider.gemspec

@@ -2,13 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.3.2'
+  s.version     = '0.3.3'
   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']
   s.email       = 'agustin.pe94@gmail.com'
   s.homepage = 'https://github.com/RubyRaider/ruby_raider'
-  s.files = %w[bin/* lib/* lib/**/*]
   s.license = 'MIT'
   s.required_ruby_version = '>= 3.0.0'
   s.files  = `git ls-files -z`.split("\x0")
@@ -16,9 +15,9 @@ Gem::Specification.new do |s|
   s.executables << 'raider'
   s.add_development_dependency 'rake', '~> 13.0.6'
   s.add_development_dependency 'reek', '~> 6.1.0'
+  s.add_development_dependency 'rspec', '~> 3.11.0'
   s.add_development_dependency 'rubocop', '~> 1.27'
   s.add_development_dependency 'rubocop-rspec', '~> 2.9.0'
-  s.add_development_dependency 'rspec', '~> 3.11.0'
 
   s.add_runtime_dependency 'highline', '~> 2.0.3'
   s.add_runtime_dependency 'thor', '~> 1.2.1'

data/spec/ruby_raider_spec.rb

@@ -155,7 +155,7 @@ describe RubyRaider do
 
   context 'updates the config file' do
     before(:all) do
-      CommonGenerator.new(%w[rspec cucumber test]).invoke(:generate_config_file)
+      CommonGenerator.new(%w[rspec selenium test]).invoke(:generate_config_file)
       FileUtils.cp_lr('test/config', './')
     end
 
@@ -178,4 +178,36 @@ describe RubyRaider do
       end
     end
   end
+
+  context 'scaffolding' do
+    before(:all) do
+      CommonGenerator.new(%w[rspec selenium test]).invoke(:generate_config_file)
+      FileUtils.cp_lr('test/config', './')
+    end
+
+    context 'with a spec folder' do
+      it 'scaffolds for rspec' do
+        raider.new.invoke(:scaffold, nil, %W[#{name}])
+        expect(Pathname.new("page_objects/pages/#{name}_page.rb")).to be_file
+        expect(Pathname.new("spec/#{name}_spec.rb")).to be_file
+      end
+    end
+
+    context 'with a features folder' do
+      it 'scaffolds for cucumber' do
+        FileUtils.mkdir 'features'
+        raider.new.invoke(:scaffold, nil, %W[#{name}])
+        expect(Pathname.new("page_objects/pages/#{name}_page.rb")).to be_file
+        expect(Pathname.new("features/#{name}.feature")).to be_file
+      end
+    end
+
+    after(:all) do
+      folders = %w[test config page_objects features]
+      folders.each do |folder|
+        FileUtils.rm_rf(folder)
+      end
+      FileUtils.rm('spec/test_spec.rb') if Pathname.new('spec/test_spec.rb').exist?
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-04 00:00:00.000000000 Z
+date: 2022-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,47 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.1.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '1.27'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '1.27'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 2.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement