RubyGems - howitzer - Versions diffs - 1.0.1 → 1.0.2 - Mend

howitzer 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (81) hide show

checksums.yaml +7 -0
data/.gitignore +4 -1
data/.travis.yml +3 -2
data/CHANGELOG.md +25 -5
data/GETTING_STARTED.md +158 -13
data/README.md +49 -32
data/Rakefile +10 -1
data/bin/howitzer +49 -78
data/features/cli_help.feature +30 -0
data/features/cli_new.feature +263 -0
data/features/cli_unknown.feature +17 -0
data/features/cli_version.feature +14 -0
data/features/step_definitions/common_steps.rb +1 -0
data/features/support/env.rb +1 -0
data/features/support/transformers.rb +3 -0
data/generators/base_generator.rb +2 -0
data/generators/config/config_generator.rb +1 -1
data/generators/config/templates/default.yml +4 -14
data/generators/cucumber/cucumber_generator.rb +1 -1
data/generators/cucumber/templates/cucumber.yml +1 -2
data/generators/cucumber/templates/env.rb +8 -7
data/generators/emails/emails_generator.rb +1 -1
data/generators/pages/pages_generator.rb +1 -1
data/generators/pages/templates/example_page.rb +2 -2
data/generators/root/root_generator.rb +1 -1
data/generators/root/templates/Gemfile +1 -1
data/generators/rspec/rspec_generator.rb +1 -1
data/generators/rspec/templates/example_spec.rb +2 -2
data/generators/rspec/templates/rspec.rake +1 -1
data/generators/rspec/templates/spec_helper.rb +6 -5
data/generators/tasks/tasks_generator.rb +1 -1
data/generators/tasks/templates/common.rake +1 -0
data/howitzer.gemspec +8 -8
data/lib/howitzer.rb +4 -1
data/lib/howitzer/blank_page.rb +6 -0
data/lib/howitzer/capybara/dsl_ex.rb +15 -0
data/lib/howitzer/capybara/settings.rb +267 -0
data/lib/howitzer/email.rb +134 -0
data/lib/howitzer/exceptions.rb +18 -0
data/lib/howitzer/helpers.rb +34 -23
data/lib/howitzer/init.rb +1 -4
data/lib/howitzer/mailgun/client.rb +48 -0
data/lib/howitzer/mailgun/connector.rb +34 -0
data/lib/howitzer/mailgun/response.rb +28 -0
data/lib/howitzer/utils.rb +2 -2
data/lib/howitzer/utils/data_generator/data_storage.rb +15 -2
data/lib/howitzer/utils/data_generator/gen.rb +14 -10
data/lib/howitzer/utils/locator_store.rb +14 -7
data/lib/howitzer/utils/log.rb +2 -0
data/lib/howitzer/utils/page_validator.rb +74 -27
data/lib/howitzer/version.rb +1 -1
data/lib/howitzer/web_page.rb +83 -32
data/spec/config/default.yml +10 -12
data/spec/spec_helper.rb +12 -0
data/spec/support/mailgun_unit_client.rb +60 -0
data/spec/unit/generators/generators_spec.rb +7 -7
data/spec/unit/lib/capybara/dsl_ex_spec.rb +60 -0
data/spec/unit/lib/{capybara_settings_spec.rb → capybara/settings_spec.rb} +16 -10
data/spec/unit/lib/email_spec.rb +129 -0
data/spec/unit/lib/helpers_spec.rb +160 -34
data/spec/unit/lib/init_spec.rb +1 -12
data/spec/unit/lib/mailgun/client_spec.rb +36 -0
data/spec/unit/lib/mailgun/connector_spec.rb +70 -0
data/spec/unit/lib/mailgun/response_spec.rb +29 -0
data/spec/unit/lib/utils/data_generator/data_storage_spec.rb +23 -5
data/spec/unit/lib/utils/data_generator/gen_spec.rb +2 -63
data/spec/unit/lib/utils/locator_store_spec.rb +41 -6
data/spec/unit/lib/utils/log_spec.rb +1 -1
data/spec/unit/lib/utils/page_validator_spec.rb +149 -25
data/spec/unit/lib/web_page_spec.rb +127 -53
metadata +102 -142
data/lib/howitzer/utils/capybara_patched.rb +0 -23
data/lib/howitzer/utils/capybara_settings.rb +0 -247
data/lib/howitzer/utils/email/email.rb +0 -85
data/lib/howitzer/utils/email/mail_client.rb +0 -132
data/lib/howitzer/utils/email/mailgun.rb +0 -175
data/lib/howitzer/utils/email/mailgun_helper.rb +0 -61
data/spec/unit/bin/howitzer_spec.rb +0 -175
data/spec/unit/lib/utils/email/email_spec.rb +0 -75
data/spec/unit/lib/utils/email/mail_client_spec.rb +0 -115
data/spec/unit/lib/utils/email/mailgun_helper_spec.rb +0 -95

data/bin/howitzer CHANGED Viewed

@@ -1,89 +1,60 @@
 #!/usr/bin/env ruby
-require 'rubygems' unless ENV['NO_RUBYGEMS']
-Dir[File.join(File.dirname(__FILE__), '..', 'generators', '**', '*_generator.rb')].each{ |f| require File.expand_path(f) }
-def check_arguments
-  expected_option_list = [
-    'install --cucumber',
-    'install --rspec',
-    'install --cucumber --rspec',
-    'install --rspec --cucumber',
-    '--version',
-    '--help'
-  ]
-  actual_options = ARGV.map(&:downcase).join(' ')
-  unless expected_option_list.include?(actual_options)
-    puts "ERROR: incorrect options. Please, see help for details"
-    show_help
-    exit 1
+require 'gli'
+require_relative '../lib/howitzer/version'
+module HowitzerCli
+  extend GLI::App
+  synopsis_format :compact
+  program_desc 'Ruby based framework for acceptance testing'
+  version Howitzer::VERSION
+  desc 'Generate new project'
+  arg_name '<PROJECT NAME>'
+  command :new do |c|
+    c.desc 'Integrate Cucumber'
+    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
+        validate_options(options)
+        Dir[File.join(File.dirname(__FILE__), '..', 'generators', '**', '*_generator.rb')].each{ |f| require File.expand_path(f) }
+        path_to_dir = File.join(Dir.pwd, args.first)
+        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
+      elsif args.size.zero?
+        exit_now!("Please specify <PROJECT NAME>", 64)
+      end
+    end
   end
-end
-def parse_options
-  first_option = ARGV.shift.to_s.downcase
-  case first_option
-    when 'install' then execute_generator(ARGV.map(&:downcase))
-    when '--version' then show_version
-    when '--help' then show_help
-    else
-     puts "ERROR: incorrect first argument ('#{first_option}')"
-     show_help
-     exit 1
+  def self.call
+    exit run(ARGV)
   end
-end
-private
-def show_help
-  puts %{
-howitzer [command {--cucumber, --rspec}] | {options}
-Commands are ...
-    install                  Generate test framework units:
-          --rspec                add RSpec integration with framework
-          --cucumber             add Cucumber integration with framework
-Options are ...
-    --help                   Display this help message.
-    --version                Display the program version.
-  }
-end
-def show_version
-  require_relative "../lib/howitzer/version"
-  puts "Version: #{Howitzer::VERSION}"
-  exit 0
-end
-def execute_generator(options)
-  if %w[--cucumber --rspec].include?(options.first)
-    Howitzer::ConfigGenerator.new
-    Howitzer::PagesGenerator.new
-    Howitzer::TasksGenerator.new
-    Howitzer::EmailsGenerator.new
-    Howitzer::RootGenerator.new
-    options.each do |option|
-      case option
-        when '--cucumber' then Howitzer::CucumberGenerator.new
-        when '--rspec' then Howitzer::RspecGenerator.new
-        else nil
+  class << self
+    private
+    def validate_options(options)
+      if !options['cucumber'] && !options['rspec']
+        exit_now!("Provide --cucumber and/or --rspec option", 64)
       end
     end
-  else
-    if options.empty?
-      puts "ERROR: No option specified for install command."
-    else
-      puts "ERROR: Unknown '#{options.first}' option specified."
-    end
-    show_help
-    exit 1
   end
 end
 unless ENV['TEST_MODE']
-  check_arguments
-  parse_options
-end
+  HowitzerCli.call
+end

data/features/cli_help.feature ADDED Viewed

@@ -0,0 +1,30 @@
+Feature: Howitzer CLI Help
+  Scenario Outline: Run with help global option
+    When I run `howitzer <option>`
+    Then the output should contain exactly:
+    """
+    NAME
+        howitzer - Ruby based framework for acceptance testing
+    SYNOPSIS
+        howitzer [global options] command [command options] [arguments...]
+    VERSION
+        <HOWITZER_VERSION>
+    GLOBAL OPTIONS
+        --help    - Show this message
+        --version - Display the program version
+    COMMANDS
+        help - Shows a list of commands or help for one command
+        new  - Generate new project
+    """
+    And the exit status should be 0
+  Examples:
+    | option |
+    |        |
+    | --help |
+    | -h     |

data/features/cli_new.feature ADDED Viewed

@@ -0,0 +1,263 @@
+Feature: Howitzer CLI Version
+  Scenario: Run with new command without argument and options
+    When I run `howitzer new`
+    Then the output should contain exactly:
+    """
+    error: Please specify <PROJECT NAME>
+    """
+    And the exit status should be 64
+  Scenario: Run with new command with argument and without options
+    When I run `howitzer new test_automation`
+    Then the output should contain exactly:
+    """
+    error: Provide --cucumber and/or --rspec option
+    """
+    And the exit status should be 64
+  Scenario: Run with new command with argument and unknown option
+    When I run `howitzer new test_automation --unknown`
+    Then the output should contain:
+    """
+    error: Unknown option --unknown
+    """
+    And the exit status should be 64
+  Scenario Outline: Run with new command with help option
+    When I run `howitzer new <option>`
+    Then the output should contain exactly:
+    """
+    NAME
+        new - Generate new project
+    SYNOPSIS
+        howitzer [global options] new [command options] <PROJECT NAME>
+    COMMAND OPTIONS
+        -c, --cucumber - Integrate Cucumber
+        -r, --rspec    - Integrate Rspec
+    """
+    And the exit status should be 0
+  Examples:
+    | option |
+    | --help |
+    | -h     |
+  Scenario Outline: Run with new command with argument and with rspec option
+    When I run `howitzer new test_automation <option>`
+    Then the output should contain exactly:
+    """
+      * New project directory creation ...
+          Created new './test_automation' folder
+      * Config files generation ...
+          Added 'config/custom.yml' file
+          Added 'config/default.yml' file
+      * PageOriented pattern structure generation ...
+          Added 'pages/example_page.rb' file
+          Added 'pages/example_menu.rb' file
+      * Base rake task generation ...
+          Added 'tasks/common.rake' file
+      * Email example generation ...
+          Added '/emails/example_email.rb' file
+      * Root files generation ...
+          Added '.gitignore' file
+          Added 'Gemfile' file
+          Added 'Rakefile' file
+          Added 'boot.rb' file
+      * RSpec integration to the framework ...
+          Added 'spec/spec_helper.rb' file
+          Added 'spec/example_spec.rb' file
+          Added 'tasks/rspec.rake' file
+    """
+    Then a directory named "test_automation" should exist
+    Then the following files should exist:
+      | test_automation/config/custom.yml       |
+      | test_automation/config/default.yml      |
+      | test_automation/emails/example_email.rb |
+      | test_automation/pages/example_menu.rb   |
+      | test_automation/pages/example_page.rb   |
+      | test_automation/spec/example_spec.rb    |
+      | test_automation/spec/spec_helper.rb     |
+      | test_automation/tasks/common.rake       |
+      | test_automation/tasks/rspec.rake        |
+      | test_automation/boot.rb                 |
+      | test_automation/Gemfile                 |
+      | test_automation/Rakefile                |
+      | test_automation/.gitignore              |
+    And the exit status should be 0
+  Examples:
+    | option  |
+    | --rspec |
+    | -r      |
+  Scenario Outline: Run with new command with argument and with cucumber option
+    When I run `howitzer new test_automation <option>`
+    Then the output should contain exactly:
+    """
+      * New project directory creation ...
+          Created new './test_automation' folder
+      * Config files generation ...
+          Added 'config/custom.yml' file
+          Added 'config/default.yml' file
+      * PageOriented pattern structure generation ...
+          Added 'pages/example_page.rb' file
+          Added 'pages/example_menu.rb' file
+      * Base rake task generation ...
+          Added 'tasks/common.rake' file
+      * Email example generation ...
+          Added '/emails/example_email.rb' file
+      * Root files generation ...
+          Added '.gitignore' file
+          Added 'Gemfile' file
+          Added 'Rakefile' file
+          Added 'boot.rb' file
+      * Cucumber integration to the framework ...
+          Added 'features/step_definitions/common_steps.rb' file
+          Added 'features/support/env.rb' file
+          Added 'features/support/transformers.rb' file
+          Added 'features/example.feature' file
+          Added 'tasks/cucumber.rake' file
+          Added 'config/cucumber.yml' file
+    """
+    Then a directory named "test_automation" should exist
+    Then the following files should exist:
+      | test_automation/config/cucumber.yml                       |
+      | test_automation/config/custom.yml                         |
+      | test_automation/config/default.yml                        |
+      | test_automation/emails/example_email.rb                   |
+      | test_automation/features/step_definitions/common_steps.rb |
+      | test_automation/features/support/env.rb                   |
+      | test_automation/features/support/transformers.rb          |
+      | test_automation/features/example.feature                  |
+      | test_automation/pages/example_menu.rb                     |
+      | test_automation/pages/example_page.rb                     |
+      | test_automation/tasks/common.rake                         |
+      | test_automation/tasks/cucumber.rake                       |
+      | test_automation/boot.rb                                   |
+      | test_automation/Gemfile                                   |
+      | test_automation/Rakefile                                  |
+      | test_automation/.gitignore                                |
+    And the exit status should be 0
+  Examples:
+    | option     |
+    | --cucumber |
+    | -c         |
+  Scenario Outline: Run with new command with argument and with cucumber and rspec option
+    When I run `howitzer new test_automation <options>`
+    Then the output should contain exactly:
+    """
+      * New project directory creation ...
+          Created new './test_automation' folder
+      * Config files generation ...
+          Added 'config/custom.yml' file
+          Added 'config/default.yml' file
+      * PageOriented pattern structure generation ...
+          Added 'pages/example_page.rb' file
+          Added 'pages/example_menu.rb' file
+      * Base rake task generation ...
+          Added 'tasks/common.rake' file
+      * Email example generation ...
+          Added '/emails/example_email.rb' file
+      * Root files generation ...
+          Added '.gitignore' file
+          Added 'Gemfile' file
+          Added 'Rakefile' file
+          Added 'boot.rb' file
+      * Cucumber integration to the framework ...
+          Added 'features/step_definitions/common_steps.rb' file
+          Added 'features/support/env.rb' file
+          Added 'features/support/transformers.rb' file
+          Added 'features/example.feature' file
+          Added 'tasks/cucumber.rake' file
+          Added 'config/cucumber.yml' file
+      * RSpec integration to the framework ...
+          Added 'spec/spec_helper.rb' file
+          Added 'spec/example_spec.rb' file
+          Added 'tasks/rspec.rake' file
+    """
+    Then a directory named "test_automation" should exist
+    Then the following files should exist:
+      | test_automation/config/cucumber.yml                       |
+      | test_automation/config/custom.yml                         |
+      | test_automation/config/default.yml                        |
+      | test_automation/emails/example_email.rb                   |
+      | test_automation/features/step_definitions/common_steps.rb |
+      | test_automation/features/support/env.rb                   |
+      | test_automation/features/support/transformers.rb          |
+      | test_automation/features/example.feature                  |
+      | test_automation/pages/example_menu.rb                     |
+      | test_automation/pages/example_page.rb                     |
+      | test_automation/spec/spec_helper.rb                       |
+      | test_automation/spec/example_spec.rb                      |
+      | test_automation/tasks/common.rake                         |
+      | test_automation/tasks/cucumber.rake                       |
+      | test_automation/tasks/rspec.rake                          |
+      | test_automation/boot.rb                                   |
+      | test_automation/Gemfile                                   |
+      | test_automation/Rakefile                                  |
+      | test_automation/.gitignore                                |
+    And the exit status should be 0
+  Examples:
+    | options            |
+    | --cucumber --rspec |
+    | --rspec --cucumber |
+    | -c -r              |
+    | -r -c              |
+    | -cr                |
+    | -rc                |
+  Scenario Outline: Run with new command with options and with rspec argument
+    When I run `howitzer new <option> test_automation`
+    Then the output should contain exactly:
+    """
+      * New project directory creation ...
+          Created new './test_automation' folder
+      * Config files generation ...
+          Added 'config/custom.yml' file
+          Added 'config/default.yml' file
+      * PageOriented pattern structure generation ...
+          Added 'pages/example_page.rb' file
+          Added 'pages/example_menu.rb' file
+      * Base rake task generation ...
+          Added 'tasks/common.rake' file
+      * Email example generation ...
+          Added '/emails/example_email.rb' file
+      * Root files generation ...
+          Added '.gitignore' file
+          Added 'Gemfile' file
+          Added 'Rakefile' file
+          Added 'boot.rb' file
+      * RSpec integration to the framework ...
+          Added 'spec/spec_helper.rb' file
+          Added 'spec/example_spec.rb' file
+          Added 'tasks/rspec.rake' file
+    """
+    Then a directory named "test_automation" should exist
+    Then the following files should exist:
+      | test_automation/config/custom.yml       |
+      | test_automation/config/default.yml      |
+      | test_automation/emails/example_email.rb |
+      | test_automation/pages/example_menu.rb   |
+      | test_automation/pages/example_page.rb   |
+      | test_automation/spec/example_spec.rb    |
+      | test_automation/spec/spec_helper.rb     |
+      | test_automation/tasks/common.rake       |
+      | test_automation/tasks/rspec.rake        |
+      | test_automation/boot.rb                 |
+      | test_automation/Gemfile                 |
+      | test_automation/Rakefile                |
+      | test_automation/.gitignore              |
+    And the exit status should be 0
+  Examples:
+    | option  |
+    | --rspec |

data/features/cli_unknown.feature ADDED Viewed

@@ -0,0 +1,17 @@
+Feature: Howitzer CLI Version
+  Scenario: Run with --unknown global option
+    When I run `howitzer --unknown`
+    Then the output should contain:
+    """
+    error: Unknown option --unknown
+    """
+    And the exit status should be 64
+  Scenario: Run with unknown command
+    When I run `howitzer unknown`
+    Then the output should contain:
+    """
+    error: Unknown command 'unknown'
+    """
+    And the exit status should be 64