howitzer 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 822093c8e01134d6819f07781fcfc9533ec21191
-  data.tar.gz: b6081c2e41b5c78b2c6cdbdb31e088021c9b1cad
+  metadata.gz: b3377af22722ffdd00c6ec6067a03d035550efa2
+  data.tar.gz: 1ddd61bd420afbd578e960f8056e1ccdd3efb261
 SHA512:
-  metadata.gz: 1374d0e20e3ffeeb0ac2feb61680b1edfef288cb56554b624adf2307e9f27b264111047692393ea117c4f60aebc4cd3fcdfab0810abaabeed1dd3b680063f779
-  data.tar.gz: 63bf664720ec9d50af9b3d0118dae1f7669ae4f0c47de50a589675fa86e3787528f95a33b06f77e0bb8b40c307c0858c2594f027dd4b135c009b08c7e35a0ce7
+  metadata.gz: f38792fab666d6b97c8b638214901522d2c2f75862619ef0afa64dc8d73df4dc85403b1366c7921eaf5f31c9048091f00d25b734fd619aa4d77d405fb357362f
+  data.tar.gz: 5f5a2b10f02da32f4d618f1192ce380a246998a2fa4cdd8692d12830ef2d2f62e6fea36b0a1d63c80c0cb905a3d80ae46a10fd4ba7b46ffd4971c72546afba28

data/.gitignore

@@ -11,3 +11,4 @@ tmp/*
 .bundle
 **/.DS_Store
 .ruby-version
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,32 @@
+# See full list of defaults here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+# To see all cops used see here: https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+LineLength:
+  Max: 120
+
+Style/CaseIndentation:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+MethodLength:
+  Max: 30
+
+Style/TrivialAccessors:
+  AllowDSLWriters: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Max: 150

data/.travis.yml

@@ -1,9 +1,6 @@
 language: ruby
 before_install:
   - gem install bundler
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.10
+rvm:  
   - 2.2.5
   - 2.3.1

data/.yardopts

@@ -1,5 +1,4 @@
 lib/**/*.rb
 -
-GETTING_STARTED.md
 CONTRIBUTING.md
-LICENSE
+LICENSE

data/CHANGELOG.md

@@ -1,9 +1,36 @@
-## [In git](https://github.com/strongqa/howitzer/compare/v1.1.1...master)
+## [In git](https://github.com/strongqa/howitzer/compare/v2.0.0...master)
 
 ### New Features
 
 ### Bugfixes
 
+## [v2.0.0](https://github.com/strongqa/howitzer/compare/v1.1.1...v2.0.0)
+
+### New Features
+- Added REST API prerequisites with FactoryGirl
+- Added Turnip supporting
+- Restricted using several bdd frameworks at the same time
+- Removed Opera browser supporting
+- Integrated Rubocop
+- Stopped Ruby supporting less than v2.2.2
+- Introduced /web folder for page object elements
+- Moved capybara settings to framework side
+- Integrated Capybara screenshots
+- Renamed and restructured default settings
+- Placed everything to own namespace
+- Introduced "subject" dsl method for emails
+- Moved framework dependent libraries from the gem
+- Introduced common tag groups for all BDD frameworks
+- Stopped Rawler supporting
+- Reimplemented page dsl methods from scratch
+- Introduced sections and iframes
+- Introduced email adapters
+- Stopped supporting of output to txt file
+- Removed raising error on log.error
+- Removed locator storage
+- Prevented capybara form dsl method usage
+- Introduced new Page.on method
+
 ## [v1.1.1](https://github.com/strongqa/howitzer/compare/v1.1.0...v1.1.1)
 
 ### Bugfixes

data/Gemfile

@@ -3,5 +3,11 @@ source 'https://rubygems.org'
 group :test do
   gem 'coveralls', require: false
   gem 'simplecov', require: false
+  gem 'repeater', require: false
+  gem 'rest-client', require: false
 end
 gemspec
+
+group :development do
+  gem 'rubocop'
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2015 Roman Parashchenko and StrongQA, Ltd.
+Copyright (c) 2012-2016 Roman Parashchenko and StrongQA, Ltd.
 
 MIT License
 

data/README.md

@@ -1,52 +1,50 @@
-# Howitzer
+<p align="center" style="overflow: hidden;">
+  <a href="http://howitzer-framework.io">
+    <img src="https://raw.githubusercontent.com/strongqa/howitzer/gh-pages/images/howitzer-logo.png" alt="Howitzer" />
+  </a>
+  <br/>
 
-[![Join the chat at https://gitter.im/strongqa/howitzer](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/strongqa/howitzer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Gem Version](http://img.shields.io/gem/v/howitzer.svg)][gem]
-[![Build Status](https://travis-ci.org/strongqa/howitzer.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/strongqa/howitzer.svg)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/romikoops/howitzer.png)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/strongqa/howitzer/badge.png?branch=master)][coveralls]
-[![License](http://img.shields.io/badge/license-MIT-blue.svg)][license]
+  <p align="center"><b>Ruby-based framework for acceptance testing of web applications.</b></p>
 
-[gem]: https://rubygems.org/gems/howitzer
-[travis]: https://travis-ci.org/strongqa/howitzer
-[gemnasium]: https://gemnasium.com/strongqa/howitzer
-[codeclimate]: https://codeclimate.com/github/romikoops/howitzer
-[coveralls]: https://coveralls.io/r/strongqa/howitzer?branch=master
-[license]: https://github.com/strongqa/howitzer/blob/master/LICENSE
+  <p align="center">The framework was built with modern patterns, techniques, and tools in automated testing in order to speed up tests development and simplify supporting.</p>
 
-Howitzer is a Ruby-based framework for acceptance testing.
+  <p align="center">
+  <a href="https://gitter.im/strongqa/howitzer"><img src="https://badges.gitter.im/Join%20Chat.svg" /></a>
+  <a href="https://rubygems.org/gems/howitzer"><img src="http://img.shields.io/gem/v/howitzer.svg" /></a>
+  <a href="https://travis-ci.org/strongqa/howitzer"><img src="https://travis-ci.org/strongqa/howitzer.svg?branch=master" /></a>
+  <a href='https://gemnasium.com/strongqa/howitzer'><img src="https://gemnasium.com/strongqa/howitzer.svg" /></a>
+  <a href="https://codeclimate.com/github/strongqa/howitzer"><img src="https://codeclimate.com/github/strongqa/howitzer.png" /></a>
+  <a href='https://coveralls.io/github/strongqa/howitzer?branch=master'><img src='https://coveralls.io/repos/github/strongqa/howitzer/badge.svg?branch=master' alt='Coverage Status' /></a>
+  <a href="https://github.com/strongqa/howitzer/blob/master/LICENSE"><img src="http://img.shields.io/badge/license-MIT-blue.svg" /></a>
+  </p>
 
-It was originally developed for testing web applications, but you can also use it for API testing and web service testing.
-
-The framework was built with modern patterns, techniques, and tools in automated testing. For details, please see [Test Framework Design](https://github.com/strongqa/howitzer/wiki/Test-Framework-Design).
+</p>
 
 ## Key Benefits
-- Independent of test web application, its technologies and lanquage.
-- Fast installation of the complete testing infrastructure (takes less than 5 minutes).
-- Flexible configuration of the test framework.
-- Possibility to choose between Cucumber or RSpec BDD tool.
+- Independent of a web application technical stack, language and architecture.
+- Fast installation and configuration of the complete testing infrastructure (takes less than 5 minutes).
+- Elegant, intuitive and powerful Ruby language underneath.
+- Possibility to choose your favorite BDD tool (Cucumber, RSpec or Turnip).
 - Integration with SauceLabs, Testingbot, BrowserStack and MailGun web services.
-- Easy tests support.
+- Easy tests support based on the best patterns, techniques, principles.
 - Ability to execute tests against to both browserless driver and actual browsers with no changes in your tests.
-- Searches for broken links.
-
 
 ## Documentation
-Refer to the [GETTING STARTED](http://rubydoc.info/gems/howitzer/file/GETTING_STARTED.md) document to start working with *Howitzer*.
+Refer to the [GETTING STARTED](http://docs.howitzer-framework.io) document to start working with *Howitzer*.
 
 You can also find the Rdoc documentation on [Rubygems](https://rubygems.org/gems/howitzer).
 
 ## Related Products
-* [Howitzer Example](https://github.com/strongqa/howitzer_example) – an example of Howitzer based project for demo web application.
-* [Howitzer Stat](https://github.com/strongqa/howitzer_stat) – is the extension to Howitzer product. It is used for automated tests coverage visualization of web pages.
+* [Howitzer Example RSpec](https://github.com/strongqa/howitzer_example_rspec) – an example of Howitzer based project for demo web application based on RSpec.
+* [Howitzer Example Cucumber](https://github.com/strongqa/howitzer_example_cucumber) – an example of Howitzer based project for demo web application based on Cucumber.
+* [Howitzer Example Turnip](https://github.com/strongqa/howitzer_example_turnip) – an example of Howitzer based project for demo web application based on Turnip.
 
 ## Requirements
 * Supported OS: Mac OS X, Linux, Windows
-* [Ruby](https://www.ruby-lang.org/en/downloads/) 1.9.3+
+* [Ruby](https://www.ruby-lang.org/en/downloads/) 2.2.2+
 * [DevKit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit#installation-instructions) (For **Windows** only)
-* [PhantomJS](http://phantomjs.org/download.html)
-* [ChromeDriver](https://code.google.com/p/selenium/wiki/ChromeDriver)
+* [PhantomJS](http://phantomjs.org/download.html) (For **phantomjs** and **poltergeist** drivers only)
+* [ChromeDriver](https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver)
 * [QT](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit) (For **webkit** driver only)
 
 ## Setup
@@ -59,47 +57,22 @@ gem install howitzer
 ## Usage
 Browse to a desired directory where a new project will be created.
 
-To deploy the framework with Cucumber, type:
+To generate the project with [Cucumber](https://cucumber.io/), type:
 
 ```bash
 howitzer new <PROJECT NAME> --cucumber
 ```
 
-The following folders and files will be generated:
-```
-config/
-  cucumber.yml
-  default.yml
-  custom.yml
-tasks/
-  common.rake
-  cucumber.rake
-  rspec.rake
-emails/
-  example_email.rb
-features/
-  support/env.rb
-  step_definitions/common_steps.rb
-  example.feature
-pages/
-  example_page.rb
-  example_menu.rb
-boot.rb
-Gemfile
-Rakefile
-.gitignore
-```
-
-With Rspec:
+With [Rspec](http://rspec.info/):
 
 ```bash
 howitzer new <PROJECT NAME> --rspec
 ```
 
-With both Cucumber and Rspec:
+With [Turnip](https://github.com/jnicklas/turnip):
 
 ```bash
-howitzer new <PROJECT NAME> --cucumber --rspec
+howitzer new <PROJECT NAME> --turnip
 ```
 
 **Configuration**
@@ -108,19 +81,26 @@ Learn and specify correct default settings in the `config/default.yml` file. For
 
 ## Test Implementation Workflow
 
-- Prepare features and scenarios
-- Implement appropriate pages in the `pages` folder. For details, refer to  [Page Object Pattern](https://github.com/strongqa/howitzer/wiki/PageObject-pattern).
-- Implement emails in `emails` folder.
+- Prepare BDD feature with scenarios
+- Mark feature/scenarios with priority tags.
+- Implement prerequisites generation (optional):
+  * implement factories
+  * implement models
+- Implement appropriate pages in the `web/pages` folder. For details, refer to  [Page Object Pattern](https://github.com/strongqa/howitzer/wiki/PageObject-pattern).
+- Implement emails in `emails` folder (optional).
 - Implement scenarios:
   * For Cucumber:
     1. Read and learn [Cucumber Best Practices](https://github.com/strongqa/howitzer/wiki/Cucumber-Best-Practices)
-    2. Implement step definitions in the `features/step_definitions/common_steps.rb` file.
+    2. Implement step definitions in the `features/step_definitions` folder.
   * For Rspec: Use [DSL](https://github.com/jnicklas/capybara/blob/master/lib/capybara/rspec/features.rb) provided by Capybara to create descriptive acceptance tests.
-- Debug feature against to desired driver.
+  * For Turnip: Implement step definitions in the `spec/steps` folder.
+- Debug features against to desired drivers.
 - Enjoy it!
 
 ## Rake Tasks
 
+[Rake](https://ruby.github.io/rake/) was originally created to handle software build processes, but the combination of convenience and flexibility that it provides has made it the standard method of job automation for Ruby projects.
+
 You can get a list of all available tasks by typing the following command:
 
 ```bash
@@ -131,25 +111,15 @@ rake -T
 ## Upgrading Howitzer
 Before attempting to upgrade an existing project, you should be sure you have a good reason to upgrade. You need to balance several factors: the need for new features, the increasing difficulty of finding support for old code, and your available time and skills, to name a few.
 
-From version _v1.1.0_ howitzer provides **howitzer update** command. After updating the Howitzer version in the Gemfile, run this rake task. This will help you with the creation of new files and changes of old files in an interactive session.
+From version _v1.1.0_ howitzer provides **howitzer update** command. After updating the Howitzer version in the Gemfile, run following commands:
 
 ```
-$ howitzer update
-        *  Config files generation ...
-            Identical 'config/custom.yml' file
-            Added 'config/default.yml' file
-        * Root files generation ...
-            Added '.gitignore' file
-            Conflict with 'Gemfile' file
-              Overwrite 'Gemfile' file? [Yn]:Y
-                Forced 'Gemfile' file
-            Identical 'Rakefile' file
-            Conflict with 'boot.rb' file
-              Overwrite 'boot.rb' file? [Yn]:n
-                Skipped 'boot.rb' file
-
-...
+bundle update howitzer
+bundle exec howitzer update
 ```
+
+This will help you with the creation of new files and changes of old files in an interactive session.
+
 Don't forget to review the difference, to see if there were any unexpected changes and merge them. It is easy if your project is under revision control systems like _Git_.
 
 ## Additional Information
@@ -161,7 +131,7 @@ Don't forget to review the difference, to see if there were any unexpected chang
 Contributing
 ------------
 
-Please see [CONTRIBUTING.md](https://github.com/strongqa/howitzer/blob/master/CONTRIBUTING.md).
+Please see [CONTRIBUTING.md](CONTRIBUTING.md).
 
 howitzer was originally designed by Roman Parashchenko and is now maintained by StrongQA team. You can find list of contributors here [open source
 community](https://github.com/strongqa/howitzer/graphs/contributors).
@@ -169,14 +139,14 @@ community](https://github.com/strongqa/howitzer/graphs/contributors).
 License
 -------
 
-howitzer is Copyright © 2012-2015 Roman Parashchenko and StrongQA. It is free
+howitzer is Copyright © 2012-2016 Roman Parashchenko and StrongQA Ltd. It is free
 software, and may be redistributed under the terms specified in the
-[LICENSE](/LICENSE) file.
+[LICENSE](LICENSE) file.
 
 About StrongQA
 ----------------
 
-![StrongQA](http://strongqa.com/head_logo_big.png)
+![StrongQA](https://github.com/strongqa/howitzer/blob/gh-pages/images/strongqa-logo.png)
 
 howitzer is maintained and funded by StrongQA, Ltd.
 The names and logos for StrongQA are trademarks of StrongQA, Ltd.

data/Rakefile

@@ -1,22 +1,22 @@
 require 'rubygems'
-require "bundler"
+require 'bundler'
 Bundler.setup
 
 require 'rake'
 require 'yard'
 require 'rspec/core/rake_task'
 require 'cucumber/rake/task'
+require 'rubocop/rake_task'
+
 Bundler::GemHelper.install_tasks
-RSpec::Core::RakeTask.new(:spec) { |spec| }
+RSpec::Core::RakeTask.new(:spec) { |_spec| }
 
 Cucumber::Rake::Task.new(:cucumber, 'Run all cucumber features') do |t|
   t.fork = false
 end
 
-desc "All tests"
-task(all_tests: [:spec, :cucumber]) {}
+YARD::Rake::YardocTask.new { |_t| }
 
-YARD::Rake::YardocTask.new do |t|
-end
+RuboCop::RakeTask.new
 
-task :default => :all_tests
+task default: [:rubocop, :spec, :cucumber]

data/bin/howitzer

@@ -2,8 +2,8 @@
 require 'gli'
 require_relative '../lib/howitzer/version'
 
+# Howitzer Command line interface
 module HowitzerCli
-
   extend GLI::App
   synopsis_format :compact
   program_desc 'Ruby based framework for acceptance testing'
@@ -13,30 +13,39 @@ module HowitzerCli
   arg_name '<PROJECT NAME>'
   command :new do |c|
     c.desc 'Integrate Cucumber'
-    c.switch [:c, :cucumber] , negatable: false
+    c.switch [:c, :cucumber], negatable: false
 
     c.desc 'Integrate Rspec'
     c.switch [:r, :rspec], negatable: false
 
-    c.action do |global_options, options, args|
-      if args.size > 0
+    c.desc 'Integrate Turnip'
+    c.switch [:t, :turnip], negatable: false
+
+    c.action do |_global_options, options, args|
+      if !args.empty?
         validate_options(options)
         load_generators
         path_to_dir = File.join(Dir.pwd, args.first)
-        puts "  * New project directory creation ..."
+        puts '  * New project directory creation ...'
         Dir.mkdir(path_to_dir)
         puts "      Created new './#{args.first}' folder"
         Dir.chdir(path_to_dir)
-        Howitzer::ConfigGenerator.new
-        Howitzer::PagesGenerator.new
-        Howitzer::TasksGenerator.new
-        Howitzer::EmailsGenerator.new
-        Howitzer::RootGenerator.new
-        Howitzer::CucumberGenerator.new if options['cucumber']
-        Howitzer::RspecGenerator.new if options['rspec']
-        puts "[WARN] Extra parameters were skipped" if args.size > 1
+        Howitzer::ConfigGenerator.new(options)
+        Howitzer::WebGenerator.new(options)
+        Howitzer::TasksGenerator.new(options)
+        Howitzer::EmailsGenerator.new(options)
+        Howitzer::RootGenerator.new(options)
+        Howitzer::PrerequisitesGenerator.new(options)
+        if options[:cucumber]
+          Howitzer::CucumberGenerator.new(options)
+        elsif options[:rspec]
+          Howitzer::RspecGenerator.new(options)
+        elsif options['turnip']
+          Howitzer::TurnipGenerator.new(options)
+        end
+        puts '[WARN] Extra parameters were skipped' if args.size > 1
       elsif args.size.zero?
-        exit_now!("Please specify <PROJECT NAME>", 64)
+        exit_now!('Please specify <PROJECT NAME>', 64)
       end
     end
   end
@@ -44,22 +53,34 @@ module HowitzerCli
   desc 'Upgrade existing project'
   command :update do |c|
     c.action do
-        check_project_presence
-        load_generators
-        Howitzer::ConfigGenerator.new
-        Howitzer::RootGenerator.new
-        Howitzer::CucumberGenerator.new if cucumber_integrated?
-        Howitzer::RspecGenerator.new if rspec_integrated?
+      check_project_presence
+      load_generators
+      Howitzer::ConfigGenerator.new
+      Howitzer::WebGenerator.new
+      Howitzer::TasksGenerator.new
+      Howitzer::EmailsGenerator.new
+      Howitzer::PrerequisitesGenerator.new
+      if cucumber_integrated?
+        Howitzer::RootGenerator.new(cucumber: true)
+        Howitzer::CucumberGenerator.new
+      elsif rspec_integrated?
+        Howitzer::RootGenerator.new(rspec: true)
+        Howitzer::RspecGenerator.new
+      elsif turnip_integrated?
+        Howitzer::RootGenerator.new(turnip: true)
+        Howitzer::TurnipGenerator.new
+      end
     end
   end
 
-  #helpers
+  # helpers
   class << self
     private
+
     def validate_options(options)
-      if !options['cucumber'] && !options['rspec']
-        exit_now!("Provide --cucumber and/or --rspec option", 64)
-      end
+      return if [options[:cucumber], options[:rspec], options[:turnip]].count { |el| el } == 1
+
+      exit_now!('Provide --cucumber, --rspec or --turnip option', 64)
     end
 
     def check_project_presence
@@ -67,23 +88,27 @@ module HowitzerCli
     end
 
     def howitzer_project?
-      Dir.exists?('pages') && Dir.exists?('config') && File.exists?('boot.rb')
+      (Dir.exist?('web') || Dir.exist?('pages')) && Dir.exist?('config')
     end
 
     def load_generators
-      Dir[File.join(File.dirname(__FILE__), '..', 'generators', '**', '*_generator.rb')].each{ |f| require File.expand_path(f) }
+      Dir[
+          File.join(__dir__, '..', 'generators', '**', '*_generator.rb')
+      ].each { |f| require File.expand_path(f) }
     end
 
     def cucumber_integrated?
-      Dir.exists?('features')
+      Dir.exist?('features')
     end
 
     def rspec_integrated?
-      Dir.exists?('spec')
+      File.exist?('spec/spec_helper.rb') && !File.exist?('spec/turnip_helper.rb')
+    end
+
+    def turnip_integrated?
+      File.exist?('spec/spec_helper.rb') && File.exist?('spec/turnip_helper.rb')
     end
   end
 end
 
-unless ENV['TEST_MODE']
-  exit(HowitzerCli.run(ARGV))
-end
+exit(HowitzerCli.run(ARGV)) unless ENV['TEST_MODE']