cs-webautomator 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65a0e138de2d9b33644e8d8e5ed83eced70014ec
-  data.tar.gz: a25b7ed66dbf09e9dfce3df7115e97149b92f8fb
+  metadata.gz: 74e7a731683e759d9bf74f8ca3b1a7ccf437c774
+  data.tar.gz: e0e20b93f4093665f8d18def462a749b287672ab
 SHA512:
-  metadata.gz: cb4353b9f5fa8f92b412e68490f16cee415266b8f06dd4f21a9d68ea38dcc9deca0219cb8e564e4102eb4cd3c12a8beb3fab3f74f75b2718abbbd047b24374b0
-  data.tar.gz: 200c23c966fc089f5802cb2baeec964a6b557d68a4890f84704cea3b0a01d99258569488bfe4141ea3e184a9311999cfde502a8dc620e066131d6b89473a44af
+  metadata.gz: 9b30226ac893e581dd89c3529c8d77d51238dfebe49c3014d1263f788d6f68f0d41d2ab183b91812e39d0cb9a118bccf42e930581b270ef5736ef24d15989302
+  data.tar.gz: a62156bae4e03f3cbe66d56d04eb7dfa74eaaff82d1ee34cc91cb13645f339e5e5c4ef7c334db87d5d574fff1a99e4155aeceb501c31c06d85da4cdec11379e7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cs-webautomator (0.1.0)
+    cs-webautomator (0.1.6)
       bundler (>= 1.7)
       gherkin (= 2.12.2)
       i18n (>= 0.6.11)

data/README.md

@@ -1,62 +1,99 @@
 # CS::WEBAUTOMATOR
 
-## Instalação
+A simple gem to generate web automation project with:
 
-Executar:
+> Cucumber [(link)](https://cucumber.io/)
+
+> Capybara [(link)](https://github.com/jnicklas/capybara)
+
+> SitePrism [(link)](https://github.com/natritmeyer/site_prism)
+
+> Selenium Webdriver [(link)](http://www.seleniumhq.org/)
+
+ The structure is based on three layers: features, steps and pages.
+
+1. Features: Contains all the features of the project;
+2. Steps: Contains all the steps implementations;
+3. Pages: Contains all the pages in the website. A page must contain the declaration of all the elements of the page and the declaration of its actions.
+
+## Instalation
+
+Install it as:
 
     $ gem install cs-webautomator
 
-## Uso
+## Usage
 
-No terminal, para acessar o help:
+In the terminal, type for help:
 
 ```
   cs-webautomator
   cs-webautomator generate
 ```
 
-Ver a versão da gem:
+To see the gem version type:
 
 ```
   cs-webautomator version
 ```
 
-Gerar o projeto:
+To generate a project type:
 
 ```
-  cs-webautomator new Projeto
+  cs-webautomator new ProjectName
 ```
 
-Esse comando vai criar uma pasta com o nome Projeto no diretório corrente e criar os arquivos padrões. Projeto gerado em português por default.
-
-Para gerar em inglês, por exemplo, utilize:
+This command will create a folder named ProjectName in the current directory and will create all the needed files. This gem support localizations. To create a localized project, in Portuguese, type:
 
 ```
-  cs-webautomator new Projeto --lang=en
+  cs-webautomator new ProjectName --lang=pt
 ```
+> The default language is English ('en'). The elements of Gherkin such as Given, When, Then, And, Scenario will be translated to all Gherkin supported languages, but this gem has just a few translation files (see that in folder: `lib/cs/webautomator/locales`).
+
+  > **CS-WEBAUTOMATOR doesn't support your mother language?** No problem. Fork it, create your yml translation file, uses the en.yml file as a template. Translate it and make a pull request. There are only 15 lines to be translated, this will take no time.
 
-**Os comandos generate só funcionam dentro da raiz do projeto**.
+  > **Want to know how to name your translation yml file?** See the Gherkin supported languages [here](https://github.com/cucumber/gherkin/blob/master/lib/gherkin/i18n.json) for reference.
 
-####Features
+Once the project is created, open its folder (`cd ProjectName`) and run `bundle install`
+
+There are three generators that are responsible to create the templates for Features, Step definitions and Pages.
+
+**The generators commands ONLY WORK in the ROOT FOLDER of the project.**
+
+#### Features
 
 ```
-  cs-webautomator generate feature NomeFeature
+  cs-webautomator generate feature FeatureName
 ```
+The feature generator will create a feature and its files. So this command will create the FeatureName.feature file inside the folder `features/specifications`, the file FeatureName_steps.rb inside the folder `features/step_definitions`, the files FeatureName_page.rb inside the folder `features/pages`.
 
-Esse comando vai criar um arquivo NomeFeature.feature dentro de `features/specifications`, NomeFeature_steps.rb dentro de `features/step_definitions` e FeatureName_page.rb dentro de `features/pages`.
-
-####Steps
+#### Steps
 
 ```
-  cs-webautomator generate step NomeStep
+  cs-webautomator generate step StepName
 ```
-Esse comando vai criar um arquivo NomeStep_steps.rb na pasta `features/step_definitions`
+The step generator will create a step file named StepName_steps.rb in the folder  `features/step_definitions`
 
 
-####Pages
+#### Pages
 
 ```
   cs-webautomator generate page PageName
 ```
 
-Esse comando vai criar um arquivo NomeStep_page.rb na pasta `features/pages`
+The screen generator will create both Platform dependent screens in the folder `features/pages`
+
+## TODO
+
+1. Run tests in Remote Server
+2. Run tests in Internet Explorer and Safari
+3. Create base methods (click, set, etc) to use with elements
+
+
+## Contributing
+
+1. Fork it ( https://github.com/samycici/cs-webautomator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/bin/cs-webautomator

@@ -19,7 +19,7 @@ module CS
       desc 'feature [RESOURCE_NAME]', 'Generates a feature'
       option :lang,
              banner: 'any of the gherkin supported languages',
-             default: :pt
+             default: :en
       def feature(name)
         I18n.config.default_locale = options[:lang]
         in_root_project_folder?
@@ -32,7 +32,7 @@ module CS
       desc 'step [RESOURCE_NAME]', 'Generates a step'
       option :lang,
              banner: 'any of the gherkin supported languages',
-             default: :pt
+             default: :en
       def step(name)
         I18n.config.default_locale = options[:lang]
         in_root_project_folder?
@@ -43,7 +43,7 @@ module CS
            'Generates pages'
       option :lang,
              banner: 'any of the gherkin supported languages',
-             default: :pt
+             default: :en
       def page(name)
         I18n.config.default_locale = options[:lang]
         in_root_project_folder?
@@ -80,7 +80,7 @@ module CS
            'Capybara, SitePrism, Selenium and Cucumber'
       option :lang,
              banner: 'any of the gherkin supported languages',
-             default: :pt
+             default: :en
       def new(name)
         I18n.config.default_locale = options[:lang]
         # Thor will be responsible to look for identical

data/lib/cs/webautomator/version.rb

@@ -1,5 +1,5 @@
 module CS
   module WEBAUTOMATOR
-    VERSION = '0.1.5'
+    VERSION = '0.1.6'
   end
 end

data/lib/skeleton/README.md

@@ -1,96 +1,90 @@
-## Configurando o ambiente ##
+## Getting Started ##
 
-### Instalar rbenv ###
-Execute o seguinte comando:
+### Installing rbenv ###
+Run this:
 ```shell
 brew install rbenv
 ```
 
-Inclua no ~/.bash_profile:
+Add to ~/.bash_profile:
 ```shell
 eval "$(rbenv init -)"
 ```
 
-Listar as versões disponíveis:
+List all available versions:
 ```shell
 rbenv install -l
 ```
 
-Instalar uma versão:
+Install a Ruby version:
 ```shell
 rbenv install 2.3.1
 ```
 
-### Ativar rbenv 2.3.1 ###
-Navegar para pasta desejada e executar o seguinte comando:
+Sets a local application-specific Ruby 2.3.1:
 ```shell
 rbenv local 2.3.1
 ```
 
-### Instalando o bundler ###
-Navegar para pasta desejada e executar o seguinte comando:
+### Installing bundler ###
+Run this:
 ```shell
 gem install bundler
 ```
 
-### Instalando as gems ###
-Execute o seguinte comando dentro da raiz do projeto:
+### Installing gems ###
+Run this:
 ```shell
 bundle install
 ```
 
-### Drivers necessários: ###
-Instalar [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/) e [phantomjs](http://phantomjs.org/) e adicionar ao PATH
+### Drivers: ###
+Install [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/) and [phantomjs](http://phantomjs.org/).
+Remenber include in the PATH.
 
-### Executando os testes em DEV usando Chrome###
-Execute o seguinte comando dentro da raiz do projeto:
+### Run tests in DEV with Chrome###
+Run this in the tests folder:
 ```shell
 bundle exec cucumber
 ```
 
-### Executando os testes em DEV usando Firefox###
-Execute o seguinte comando dentro da raiz do projeto:
+### Run tests in DEV with Firefox###
+Run this in the tests folder:
 ```shell
 bundle exec cucumber -p firefox -p dev
 ```
 
-### Executando os testes em DEV usando Poltergeist###
-Execute o seguinte comando dentro da raiz do projeto:
+### Run tests in DEV with Poltergeist###
+Run this in the tests folder:
 ```shell
 bundle exec cucumber -p poltergeist -p dev
 ```
 
-### Executando os testes em HMG usando Chrome###
-Execute o seguinte comando dentro da raiz do projeto:
+### Run tests in HMG with Chrome###
+Run this in the tests folder:
 ```shell
 bundle exec cucumber -p chrome -p hmg
 ```
 
-### Executando os testes em HMG usando Firefox###
-Execute o seguinte comando dentro da raiz do projeto:
+### Run tests in HMG with Firefox###
+Run this in the tests folder:
 ```shell
 bundle exec cucumber -p firefox -p hmg
 ```
-### Executando os testes em HMG usando Poltergeist###
-Execute o seguinte comando dentro da raiz do projeto:
+### Run tests in HMG with Poltergeist###
+Run this in the tests folder:
 ```shell
 bundle exec cucumber -p poltergeist -p hmg
 ```
 
-### Gerando relatório HTML###
-Execute o seguinte comando dentro da raiz do projeto:
+### HTML Report###
+Run this in the tests folder:
 ```shell
 bundle exec cucumber -p html_report
 ```
 
-### Executando tags###
-Execute o seguinte comando dentro da raiz do projeto:
+### Run with tags###
+Run this in the tests folder:
 ```shell
 bundle exec cucumber --tags @run
 ```
-
-### Rodados specs de TDD###
-Execute o seguinte comando dentro de TDD:
-```shell
-bundle exec rspec
-```

data/lib/skeleton/features/support/env.rb

@@ -7,11 +7,19 @@ require 'yaml'
 require 'capybara/poltergeist'
 
 BROWSER = ENV['BROWSER']
-AMBIENTE = ENV['AMBIENTE']
+ENVIRONMENT_TYPE = ENV['ENVIRONMENT_TYPE']
 
+## register driver according with browser chosen
 Capybara.register_driver :selenium do |app|
   if BROWSER.eql?('chrome')
-    Capybara::Selenium::Driver.new(app, :browser => :chrome)
+    Capybara::Selenium::Driver.new(app,
+    :browser => :chrome,
+    :desired_capabilities => Selenium::WebDriver::Remote::Capabilities.chrome(
+      'chromeOptions' => {
+        'args' => [ "--start-maximized" ]
+      }
+    )
+  )
   elsif BROWSER.eql?('firefox')
     Capybara::Selenium::Driver.new(app, :browser => :firefox)
   elsif BROWSER.eql?('internet_explorer')

data/lib/skeleton/features/support/hooks.rb

@@ -1,22 +1,32 @@
 Before do |feature|
-  CONFIG = YAML.load_file(File.dirname(__FILE__) + "/config/#{AMBIENTE}.yaml")
+  ## variable which loads the data file according to the environment
+  CONFIG = YAML.load_file(File.dirname(__FILE__) + "/config/#{ENVIRONMENT_TYPE}.yaml")
+
+  ## configure the chosen browser
   Capybara.configure do |config|
     config.default_driver = :selenium
   end
+
+  ## set default max wait and maximize browser
   Capybara.default_max_wait_time = 20
+  Capybara.current_session.driver.browser.manage.window.maximize
 end
 
 After do |scenario|
+
+  ## take screenshot if scenario fail
   if scenario.failed?
-    diretorio = 'screenshots'
-    arquivo = "#{diretorio}/#{scenario.name}.png"
-    Dir.mkdir(diretorio) unless File.exist?(diretorio)
+    folder = 'screenshots'
+    file = "#{folder}/#{scenario.name}.png"
+    Dir.mkdir(folder) unless File.exist?(folder)
     if BROWSER.eql?('poltergeist')
-      Capybara.page.save_screenshot(arquivo)
+      Capybara.page.save_screenshot(file)
     else
-      Capybara.page.driver.browser.save_screenshot(arquivo)
+      Capybara.page.driver.browser.save_screenshot(file)
     end
   end
+
+  ## if the browser is different from poltergeist, kills instance
   unless BROWSER.eql?('poltergeist')
     Capybara.current_session.driver.quit
   end

data/lib/skeleton/features/support/matchers/custom.rb

@@ -1,5 +1,6 @@
 require 'rspec/expectations'
 
+## matcher to validate if all elements in list are equals
 RSpec::Matchers.define :all_list_elements_eq do |expected|
   match do |actual|
     actual.each do |i|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cs-webautomator
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Samanta Cicilia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2016-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler