ruby_raider 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83e7e23f59e2e6864f53d64723ce6c381b48790be638f1a6a68a443066ec79b0
-  data.tar.gz: 11e974c23bbea75f85cae9eeab28629e10bf29f2bf41666caf05e5f11131faa0
+  metadata.gz: 151af21fd6a33598fc5fef983b3d8277817e438445f8576d6f6135ce13d7cc4b
+  data.tar.gz: 0665e396c6246632ab922e62fac8dd3ef66701815b95bb8cdc03fa215b7a57b6
 SHA512:
-  metadata.gz: e73135a4d13b39478976fd99beb0dfe42da3038518e7616b21f6aba3449bb82994770fa90df827ab30ae1febfd0eb5b38b22aa492efdebc6ebf1cbbf6d541925
-  data.tar.gz: 69d1474035d9ac00aaae5bf940fc97856958a583b34514f088fbe0922144f1b9ded788ee9cf504d6c620345758676d1f49d01491fb647841b1b7cec5b9cbdbab
+  metadata.gz: 613640d0d946f4337bec680bdac7c86e4ae6f00534b7286d6e35a59788197b4f37dd110a4ee3990247e8b2dffee2f7eafc6d92de1b9a6f3216ae88343cd0cc43
+  data.tar.gz: 3391b2d3debb45de3d923954f64d8c866fb813f276312128c81a4fde78964a56084142ca6266399277b9c4280296da36f495ff3c9e754a4ef90fb16659fd3736

data/README.md

@@ -1,14 +1,15 @@
-# ruby_raider
-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/
+# Ruby Raider
+
+This is a gem to make setup and start of UI automation projects easier
+You can find more information and updates on releases in : https://ruby-raider.com/
 
 Just do:
 
 **gem install ruby_raider**
 
-then do: 
+then do:
 
-**raider new [name_of_project]** 
+**raider new [name_of_project]**
 
 and you will have a new project in the folder you are in
 
@@ -21,3 +22,36 @@ Currently we only support:
 In order to run the appium tests, download the example [app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0)
 
 This works in all the platforms (Tested on Mac OS, Linux and Windows)
+
+**Ruby raider provides the following list of commands**
+```
+  raider browser [BROWSER]       # Sets the default browser for a project
+
+  raider feature [FEATURE_NAME]  # Creates a new feature
+  
+  raider help [COMMAND]          # Describe available commands or one specific command
+  
+  raider new [PROJECT_NAME]      # Creates a new framework based on settings picked
+  
+  raider page [PAGE_NAME]        # Creates a new page object
+  
+  raider path [PATH]             # Sets the default path for scaffolding
+  
+  raider raid                    # It runs all the tests in a project
+  
+  raider spec [SPEC_NAME]        # Creates a new spec
+  
+  raider url [URL]               # Sets the default url for a project
+```
+
+It's possible to add the option --path or -p if you want to specify where to create your features, pages and specs.
+And also it's possible to delete them using --delete or -d.
+
+If you want to set the default path for the creation of your features, specs or pages you can do:
+
+```
+raider path [PATH_NAME] --feature or -f
+raider path [PATH_NAME] --spec or -s
+```
+
+If you don't specify an option path will assume you want to change the default path for pages

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

@@ -1,97 +1,56 @@
-What is Raider?
-===========
+# Ruby Raider
+This is a gem to make setup and start of UI automation projects easier
+You can find more information and updates on releases in : https://ruby-raider.com/
 
-Raider is a tool to make the setup and start of automation projects in ruby easier, with one command you are ready to go
+Just do:
 
-# Pre-requisites:
+**gem install ruby_raider**
 
-Install RVM:
-https://rvm.io/rvm/install
+then do:
 
-# How to use the framework:
+**raider new [name_of_project]**
 
-If you want to run all the tests from your terminal do:
-*rspec spec/*
+and you will have a new project in the folder you are in
 
-If you want to run all the tests in parallel do:
-*parallel_rspec spec/*
+Currently we only support:
 
-# How are specs organized:
+* Gerating a Selenium with both Cucumber and Rspec framework
+* Gerating a Watir with both Cucumber and Rspec framework
+* Generating an Appium project with Rspec and Cucumber on IOS
 
-We use 'context' as the highest grouping level to indicate in which part of the application we are as an example:
+In order to run the appium tests, download the example [app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0)
 
-*context 'On the login page'/*
+This works in all the platforms (Tested on Mac OS, Linux and Windows)
 
-We use 'describe' from the user perspective to describe an action that the user can or cannot take:
-
-*describe 'A user can'/*
-
-or
-
-*describe 'A user cannot'/*
-
-This saves us repetition and forces us into an structure
-
-At last we use 'it' for the specific action the user can or cannot perform:
-
-it 'login with right credentials'
-
-If we group all of this together it will look like
-
-```ruby
-   context 'On the login page' do
-    describe 'A user can' do
-      it 'login with the right credentials' do
-      end
-    end
-
-    describe 'A user cannot' do
-      it 'login with the wrong credentials' do
-      end
-    end
-  end
+**Ruby raider provides the following list of commands**
 ```
-This is readed as 'On the login page a user can login with the right credentials' and 'On the login page a user cannot login with the wrong credentials'
+  raider browser [BROWSER]       # Sets the default browser for a project
 
-# How pages are organized:
+  raider feature [FEATURE_NAME]  # Creates a new feature
 
-```ruby#{' '}
-  require_relative '../abstract/base_page'
+  raider help [COMMAND]          # Describe available commands or one specific command
 
-  class MainPage < BasePage
+  raider new [PROJECT_NAME]      # Creates a new framework based on settings picked
 
-  using Raider::WatirHelper
+  raider page [PAGE_NAME]        # Creates a new page object
 
-  def url(_page)
-    '/'
-  end
+  raider path [PATH]             # Sets the default path for scaffolding
 
-  # Actions
+  raider raid                    # It runs all the tests in a project
 
-  def change_currency(currency)
-    currency_dropdown.select currency
-  end
+  raider spec [SPEC_NAME]        # Creates a new spec
 
-  # Validations
-
-  def validate_currency(currency)
-    expect(currency_dropdown.include?(currency)).to be true
-  end
+  raider url [URL]               # Sets the default url for a project
+```
 
-  private
+It's possible to add the option --path or -p if you want to specify where to create your features, pages and specs.
+And also it's possible to delete them using --delete or -d.
 
-  # Elements
+If you want to set the default path for the creation of your features, specs or pages you can do:
 
-  def currency_dropdown
-    browser.select(class: %w[dropdown-menu currency])
-  end
-end
+```
+raider path [PATH_NAME] --feature or -f
+raider path [PATH_NAME] --spec or -s
 ```
 
-Pages are organized in Actions (things a user can perform on the page), Validations (assertions), and Elements.
-Each page has to have a url define, and each page is using the module WatirHelper to add methods on runtime to the Watir elements
-
-# Mobile:
-
-For the appium base project to work you need to have [appium](https://appium.io)
-and download [the example app](https://github.com/cloudgrey-io/the-app/releases/tag/v1.10.0)
+If you don't specify an option path will assume you want to change the default path for pages

data/lib/ruby_raider.rb

@@ -18,7 +18,7 @@ class RubyRaider < Thor
          :type => :boolean, :required => false, :desc => 'This will delete the selected page', :aliases => '-d'
 
   def page(name)
-    path = options[:path].nil? ? load_config_path : options[:path]
+    path = options[:path].nil? ? load_config_path('page') : options[:path]
     if options[:delete]
       Scaffolding.new([name, path]).delete_class
     else
@@ -33,7 +33,7 @@ class RubyRaider < Thor
          :type => :boolean, :required => false, :desc => 'This will delete the selected feature', :aliases => '-d'
 
   def feature(name)
-    path = options[:path].nil? ? load_config_path : options[:path]
+    path = options[:path].nil? ? load_config_path('feature') : options[:path]
     if options[:delete]
       Scaffolding.new([name, path]).delete_feature
     else
@@ -48,7 +48,7 @@ class RubyRaider < Thor
          :type => :boolean, :required => false, :desc => 'This will delete the selected spec', :aliases => '-d'
 
   def spec(name)
-    path = options[:path].nil? ? load_config_path : options[:path]
+    path = options[:path].nil? ? load_config_path('spec') : options[:path]
     if options[:delete]
       Scaffolding.new([name, path]).delete_spec
     else
@@ -57,9 +57,13 @@ class RubyRaider < Thor
   end
 
   desc "path [PATH]", "Sets the default path for scaffolding"
-
+  option :feature,
+         :type => :boolean, :required => false, :desc => 'The default path for your features', :aliases => '-f'
+  option :spec,
+         :type => :boolean, :required => false, :desc => 'The default path for your specs', :aliases => '-s'
   def path(default_path)
-    Utilities.new.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"
@@ -81,8 +85,8 @@ class RubyRaider < Thor
   end
 
   no_commands do
-    def load_config_path
-      YAML.load_file('config/config.yml')['path'] unless YAML.load_file('config/config.yml').nil?
+    def load_config_path(type)
+      YAML.load_file('config/config.yml')["#{type}_path"] unless YAML.load_file('config/config.yml').nil?
     end
   end
 end

data/lib/utilities/utilities.rb

@@ -1,7 +1,6 @@
 require 'yaml'
 
 class Utilities
-
   def initialize
     @path = 'config/config.yml'
     @config = YAML.load_file(@path)
@@ -12,8 +11,18 @@ class Utilities
     overwrite_yaml
   end
 
-  def path=(path)
-    @config['path'] = path
+  def page_path=(path)
+    @config['page_path'] = path
+    overwrite_yaml
+  end
+
+  def spec_path=(path)
+    @config['spec_path'] = path
+    overwrite_yaml
+  end
+
+  def feature_path=(path)
+    @config['feature_path'] = path
     overwrite_yaml
   end
 

data/ruby_raider.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.3.0'
+  s.version     = '0.3.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']
   s.email       = 'agustin.pe94@gmail.com'
-  s.homepage = 'http://github.com/aguspe/ruby_raider'
+  s.homepage = 'https://github.com/RubyRaider/ruby_raider'
   s.files = %w[bin/* lib/* lib/**/*]
   s.license = 'MIT'
   s.required_ruby_version = '>= 3.0.0'

data/spec/ruby_raider_spec.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'yaml'
 require_relative 'spec_helper'
 require_relative '../lib/ruby_raider'
 require_relative '../lib/generators/common_generator'
@@ -77,4 +78,82 @@ describe RubyRaider do
       FileUtils.rm_rf(path)
     end
   end
+
+  context 'changes the default path' do
+    let(:path) { 'test_folder' }
+
+    before(:all) do
+      CommonGenerator.new(%w[rspec cucumber test]).invoke(:generate_config_file)
+      FileUtils.cp_lr('test/config', './')
+    end
+
+    it 'changes the path for pages' do
+      raider.new.invoke(:path, nil, %W[#{path}])
+      config = YAML.load_file('config/config.yml')
+      expect(config['page_path']).to eql path
+    end
+
+    it 'changes the path for features' do
+      raider.new.invoke(:path, nil, %W[#{path} -f])
+      config = YAML.load_file('config/config.yml')
+      expect(config['feature_path']).to eql path
+    end
+
+    it 'changes the path for specs' do
+      raider.new.invoke(:path, nil, %W[#{path} -s])
+      config = YAML.load_file('config/config.yml')
+      expect(config['spec_path']).to eql path
+    end
+
+    it 'creates page' do
+      raider.new.invoke(:path, nil, %W[#{path}])
+      raider.new.invoke(:page, nil, %W[#{name}])
+      expect(Pathname.new("#{path}/#{name}_page.rb")).to be_file
+    end
+
+    it 'creates feature' do
+      raider.new.invoke(:path, nil, %W[#{path} -f])
+      raider.new.invoke(:feature, nil, %W[#{name}])
+      expect(Pathname.new("#{path}/#{name}.feature")).to be_file
+    end
+
+    it 'creates feature' do
+      raider.new.invoke(:path, nil, %W[#{path} -s])
+      raider.new.invoke(:spec, nil, %W[#{name}])
+      expect(Pathname.new("#{path}/#{name}_spec.rb")).to be_file
+    end
+
+    after(:all) do
+      folders = %w[test_folder test config]
+      folders.each do |folder|
+        FileUtils.rm_rf(folder)
+      end
+    end
+  end
+
+  context 'updates the config file' do
+    before(:all) do
+      CommonGenerator.new(%w[rspec cucumber test]).invoke(:generate_config_file)
+      FileUtils.cp_lr('test/config', './')
+    end
+
+    it 'updates the url' do
+      raider.new.invoke(:url, nil, %W[test.com])
+      config = YAML.load_file('config/config.yml')
+      expect(config['url']).to eql 'test.com'
+    end
+
+    it 'updates the browser' do
+      raider.new.invoke(:browser, nil, %W[:firefox])
+      config = YAML.load_file('config/config.yml')
+      expect(config['browser']).to eql ':firefox'
+    end
+
+    after(:all) do
+      folders = %w[test config]
+      folders.each do |folder|
+        FileUtils.rm_rf(folder)
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Agustin Pequeno
@@ -191,7 +191,7 @@ files:
 - spec/rspec_generator_spec.rb
 - spec/ruby_raider_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/aguspe/ruby_raider
+homepage: https://github.com/RubyRaider/ruby_raider
 licenses:
 - MIT
 metadata: {}