howitzer 0.0.3 → 1.0.1

data/spec/config/custom.yml

@@ -0,0 +1 @@
+txt_log: log.txt

data/spec/config/default.yml

@@ -0,0 +1,28 @@
+###########################################################
+# LOGGER SETTINGS #
+###########################################################
+log_dir: "spec/log"
+txt_log: log.txt
+html_log: log.html
+rawler_log: rawler_log.txt
+selenium_server_log: selenium-server.log
+required_clean_logs: true
+hide_datetime_from_log: true
+
+driver: selenium
+
+###########################################################
+# MAIL SETTINGS                                           #
+###########################################################
+mail_smtp_server: smtp.demo.com
+mail_smtp_port: 25
+mail_smtp_domain: demo.com
+mail_smtp_user_name: test_user
+mail_smtp_user_pass: mypass
+
+mail_pop3_server: pop.demo.com
+mail_pop3_port: 995
+mail_pop3_timeout: 120
+mail_pop3_domain: ${mail_smtp_domain}
+mail_pop3_user_name: test_user
+mail_pop3_user_pass: mypass

data/spec/spec_helper.rb

@@ -1 +1,46 @@
-require 'howitzer'
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+require 'tmpdir'
+require 'ffaker'
+require 'capybara'
+require 'json'
+require 'capybara/dsl'
+
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter '/config/'
+  add_filter do |source_file|
+    source_file.lines.count < 5
+  end
+  add_group "generators", "/generators"
+  add_group "lib", "/lib"
+end
+
+Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each{ |f| require f }
+
+RSpec.configure do |config|
+  config.include GeneratorHelper
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def project_path
+  File.expand_path(File.join(File.dirname(__FILE__), '..'))
+end
+
+def lib_path
+  File.join(project_path, 'lib')
+end
+
+def generators_path
+  File.join(project_path, 'generators')
+end
+
+def log_path
+  File.join(project_path, 'spec/log')
+end

data/spec/support/boot_helper.rb

@@ -0,0 +1,15 @@
+require 'sexy_settings'
+SexySettings.configure do |config|
+  config.path_to_default_settings = File.expand_path("default.yml", File.join(File.dirname(__FILE__), '..', 'config'))
+  config.path_to_custom_settings = File.expand_path("custom.yml", File.join(File.dirname(__FILE__), '..', 'config'))
+end
+
+def settings
+  SexySettings::Base.instance
+end
+
+def log
+  Howitzer::Log.instance
+end
+
+ENV['TEST_MODE'] = "TRUE"

data/spec/support/generator_helper.rb

@@ -0,0 +1,13 @@
+module GeneratorHelper
+  def file_tree_info(root)
+    Dir["#{root}/**/*"].sort_by{|name| name.sub(root, '') }.map do |name|
+      hash = {name: name.sub(root, ''), is_directory: File.directory?(name)}
+      hash[:size] = File.stat(name).size unless hash[:is_directory]
+      hash
+    end
+  end
+
+  def template_file_size(root_directory, file)
+    File.size(File.join(generators_path, root_directory, 'templates', file))
+  end
+end

data/spec/support/logger_helper.rb

@@ -0,0 +1,12 @@
+module LoggerHelper
+  def read_file(file)
+    path = File.expand_path(file, __FILE__)
+    IO.read(path)
+  end
+
+  def clear_file(file)
+    path = File.expand_path(file, __FILE__)
+    File.open(path, "w"){ }
+  end
+end
+

data/spec/unit/bin/howitzer_spec.rb

@@ -0,0 +1,175 @@
+require "spec_helper"
+load "bin/howitzer"
+
+HELP_MESSAGE = %{
+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.
+  }
+
+shared_examples "check argument" do |arg|
+  before do
+    stub_const("ARGV", [arg])
+    expect(self).to_not receive(:puts)
+    expect(self).to_not receive(:exit)
+  end
+  context "(#{arg})" do
+    let(:arg) { arg }
+    it { expect(subject).to be_nil }
+  end
+end
+
+describe Howitzer do
+  describe "#check_arguments" do
+    subject { check_arguments }
+    context "when right arguments specified" do
+      it_behaves_like "check argument", 'install --cucumber'
+      it_behaves_like "check argument", 'install --rspec'
+      it_behaves_like "check argument", 'install --cucumber --rspec'
+      it_behaves_like "check argument", 'install --rspec --cucumber'
+      it_behaves_like "check argument", '--version'
+      it_behaves_like "check argument", '--help'
+      it_behaves_like "check argument", '--HELP'
+    end
+    context "when arguments incorrect" do
+      before do
+        expect(self).to receive(:puts).with("ERROR: incorrect options. Please, see help for details").once
+        expect(self).to receive(:puts).with(HELP_MESSAGE)
+        expect(self).to receive(:exit).with(1)
+      end
+      context "(missing arguments)" do
+        it { expect(subject).to be_nil  }
+      end
+      context "UNKNOWN argument" do
+        let(:arg) { '--unknown' }
+        before { stub_const("ARGV", [arg]) }
+        it { expect(subject).to be_nil }
+      end
+    end
+  end
+
+  describe "#parse_options" do
+    subject { parse_options }
+    context "when correct argument received" do
+      before do
+        stub_const("ARGV", arg)
+        expect(self).not_to receive(:puts).with("ERROR: incorrect first argument '#{arg}'")
+      end
+      context "'--version' argument given" do
+        let(:arg) { ['--version'] }
+      before{ stub_const("Howitzer::VERSION", '1.0.0') }
+        it do
+          expect(self).to receive(:exit).with(0).once
+          expect(self).to receive(:puts).with("Version: 1.0.0")
+          subject
+        end
+      end
+      context "'--help' argument given" do
+        let(:arg) { ['--help'] }
+        it do
+          expect(self).to receive(:puts).with(HELP_MESSAGE)
+          subject
+        end
+      end
+      context "'install' argument" do
+        let(:primary_arg) { 'install' }
+        let(:generator) { double('generator') }
+        before do
+          expect(Howitzer::ConfigGenerator).to receive(:new)
+          expect(Howitzer::PagesGenerator).to receive(:new)
+          expect(Howitzer::TasksGenerator).to receive(:new)
+          expect(Howitzer::EmailsGenerator).to receive(:new)
+          expect(Howitzer::RootGenerator).to receive(:new)
+          expect(self).not_to receive(:puts).with("ERROR: Empty option specified.")
+          expect(self).not_to receive(:puts).with("ERROR: Unknown option specified.")
+          expect(self).not_to receive(:puts).with(HELP_MESSAGE)
+        end
+        context "with option '--cucumber'" do
+          let(:arg) { [primary_arg, '--cucumber'] }
+          it do
+            expect(Howitzer::RspecGenerator).to_not receive(:new)
+            expect(Howitzer::CucumberGenerator).to receive(:new)
+            subject
+           end
+        end
+        context "with option '--rspec'" do
+          let(:arg) {[primary_arg, '--rspec']}
+          it do
+            expect(Howitzer::RspecGenerator).to receive(:new)
+            expect(Howitzer::CucumberGenerator).to_not receive(:new)
+            subject
+          end
+        end
+      end
+    end
+    context "when incorrect arguments received" do
+      before { stub_const("ARGV", arg) }
+      context "with (missing) argument" do
+        let(:arg) {[]}
+        it do
+          expect(self).to receive(:puts).with("ERROR: incorrect first argument ('')")
+          expect(self).to receive(:puts).with(HELP_MESSAGE)
+          expect(self).to receive(:exit).with(1)
+          subject
+        end
+      end
+      context "with UNKNOWN argument" do
+        let(:arg) {['unknown']}
+        it do
+          expect(self).to receive(:puts).with("ERROR: incorrect first argument ('unknown')")
+          expect(self).to receive(:puts).with(HELP_MESSAGE)
+          expect(self).to receive(:exit).with(1)
+          subject
+        end
+      end
+    end
+
+    context "when 'install' option received with incorrect arguments" do
+      let(:primary_arg) { 'install' }
+      let(:generator) { double('generator') }
+      before { stub_const("ARGV", arg) }
+      context "with UNKNOWN option specified" do
+        let(:arg) {[primary_arg, '--unknown']}
+        before do
+          expect(Howitzer::ConfigGenerator).to_not receive(:new)
+          expect(Howitzer::PagesGenerator).to_not receive(:new)
+          expect(Howitzer::TasksGenerator).to_not receive(:new)
+          expect(Howitzer::EmailsGenerator).to_not receive(:new)
+          expect(Howitzer::RootGenerator).to_not receive(:new)
+          expect(Howitzer::RspecGenerator).to_not receive(:new)
+          expect(Howitzer::CucumberGenerator).to_not receive(:new)
+        end
+        it do
+          expect(self).to receive(:puts).with("ERROR: Unknown '--unknown' option specified.")
+          expect(self).to receive(:puts).with(HELP_MESSAGE)
+          expect(self).to receive(:exit).with(1)
+          subject
+        end
+      end
+      context "with no option specified" do
+        let(:arg) {[primary_arg]}
+        before do
+          expect(Howitzer::ConfigGenerator).to_not receive(:new)
+          expect(Howitzer::PagesGenerator).to_not receive(:new)
+          expect(Howitzer::TasksGenerator).to_not receive(:new)
+          expect(Howitzer::EmailsGenerator).to_not receive(:new)
+          expect(Howitzer::RootGenerator).to_not receive(:new)
+          expect(Howitzer::RspecGenerator).to_not receive(:new)
+          expect(Howitzer::CucumberGenerator).to_not receive(:new)
+        end
+        it do
+          expect(self).to receive(:puts).with("ERROR: No option specified for install command.")
+          expect(self).to receive(:puts).with(HELP_MESSAGE)
+          expect(self).to receive(:exit).with(1)
+          subject
+        end
+      end
+    end
+  end
+end

data/spec/unit/generators/generators_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+require 'fileutils'
+
+Dir[File.join(generators_path, '**', '*_generator.rb')].each{ |f| require f }
+
+describe "Generators" do
+  let(:destination) { Dir.mktmpdir }
+  let(:output) { StringIO.new }
+  subject { file_tree_info(destination) }
+  before do
+    Howitzer::BaseGenerator.logger = output
+    Howitzer::BaseGenerator.destination = destination
+    generator_name.new
+  end
+
+  after { FileUtils.rm_r(destination) }
+
+  describe "ConfigGenerator" do
+    let(:generator_name) { Howitzer::ConfigGenerator }
+    let(:expected_result) do
+      [
+          {:name=>"/config", :is_directory=>true},
+          {:name=>"/config/custom.yml", :is_directory=>false, :size=>template_file_size('config', 'custom.yml')},
+          {:name=>"/config/default.yml", :is_directory=>false, :size=>template_file_size('config', 'default.yml')}
+      ]
+    end
+
+    it { expect(subject).to eql(expected_result) }
+    describe "output" do
+      let(:expected_output) do
+        "      Creates config files.
+      Added 'config/custom.yml' file
+      Added 'config/default.yml' file\n"
+    end
+      subject { output.string }
+      it { expect(subject).to eql(expected_output) }
+    end
+  end
+  describe "PagesGenerator" do
+    let(:generator_name) { Howitzer::PagesGenerator }
+    let(:expected_result) do
+      [
+          {:name=>"/pages", :is_directory=>true},
+          {:name=>"/pages/example_menu.rb", :is_directory=>false, :size=>template_file_size('pages', 'example_menu.rb')},
+          {:name=>"/pages/example_page.rb", :is_directory=>false, :size=>template_file_size('pages', 'example_page.rb')}
+      ]
+    end
+    it { expect(subject).to eql(expected_result) }
+    describe "output" do
+      let(:expected_output) do
+        "      Creates PageOriented pattern structure
+      Added 'pages/example_page.rb' file
+      Added 'pages/example_menu.rb' file\n"
+      end
+      subject { output.string }
+      it { expect(subject).to eql(expected_output) }
+    end
+  end
+  describe "TasksGenerator" do
+    let(:generator_name) { Howitzer::TasksGenerator }
+    let(:expected_result) do
+      [
+          {:name=>"/tasks", :is_directory=>true},
+          {:name=>"/tasks/common.rake", :is_directory=>false, :size=>template_file_size('tasks', 'common.rake')}
+      ]
+    end
+    it { expect(subject).to eql(expected_result) }
+    describe "output" do
+      let(:expected_output) do
+        "      Creates RAKE tasks folder and file.
+      Added 'tasks/common.rake' file\n"
+      end
+      subject { output.string }
+      it { expect(subject).to eql(expected_output) }
+    end
+  end
+  describe "EmailsGenerator" do
+    let(:generator_name) { Howitzer::EmailsGenerator }
+    let(:expected_result) do
+      [
+          {:name=>"/emails", :is_directory=>true},
+          {:name=>"/emails/example_email.rb", :is_directory=>false, :size=>template_file_size('emails', 'example_email.rb')}
+      ]
+    end
+    it { expect(subject).to eql(expected_result) }
+    describe "output" do
+      let(:expected_output) do
+        "  Creates a simple email class.\"
+      Added '/emails/example_email.rb' file\n"
+      end
+      subject { output.string }
+      it { expect(subject).to eql(expected_output) }
+    end
+  end
+  describe "RootGenerator" do
+    let(:generator_name) { Howitzer::RootGenerator }
+    let(:expected_result) do
+      [
+          {:name=>"/Gemfile", :is_directory=>false, :size=>template_file_size('root', 'Gemfile')},
+          {:name=>"/Rakefile", :is_directory=>false, :size=>template_file_size('root', 'Rakefile')},
+          {:name=>"/boot.rb", :is_directory=>false, :size=>template_file_size('root', 'boot.rb')}
+      ]
+    end
+    it { expect(subject).to eql(expected_result) }
+    describe "output" do
+      let(:expected_output) do
+        "      Creates root config files.
+      Added '.gitignore' file
+      Added 'Gemfile' file
+      Added 'Rakefile' file
+      Added 'boot.rb' file\n"
+      end
+      subject { output.string }
+      it { expect(subject).to eql(expected_output) }
+    end
+  end
+  describe "CucumberGenerator" do
+    let(:generator_name) { Howitzer::CucumberGenerator }
+    let(:expected_result) do
+      [
+        {:name=>"/config", :is_directory=>true},
+        {:name=>"/config/cucumber.yml", :is_directory=>false, :size=>template_file_size('cucumber', 'cucumber.yml')},
+        {:name=>"/features", :is_directory=>true},
+        {:name=>"/features/example.feature", :is_directory=>false, :size=>template_file_size('cucumber', 'example.feature')},
+        {:name=>"/features/step_definitions", :is_directory=>true},
+        {:name=>"/features/step_definitions/common_steps.rb", :is_directory=>false, :size=>template_file_size('cucumber', 'common_steps.rb')},
+        {:name=>"/features/support", :is_directory=>true},
+        {:name=>"/features/support/env.rb", :is_directory=>false, :size=>template_file_size('cucumber', 'env.rb')},
+        {:name=>"/features/support/transformers.rb", :is_directory=>false, :size=>template_file_size('cucumber', 'transformers.rb')},
+        {:name=>"/tasks", :is_directory=>true},
+        {:name=>"/tasks/cucumber.rake", :is_directory=>false, :size=>template_file_size('cucumber', 'cucumber.rake')}
+      ]
+    end
+    it { expect(subject).to eql(expected_result) }
+    describe "output" do
+      let(:expected_output) do
+        "      Integrates Cucumber 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\n"
+      end
+      subject { output.string }
+      it { expect(subject).to eql(expected_output) }
+    end
+  end
+  describe "RSpecGenerator" do
+    let(:generator_name) { Howitzer::RspecGenerator }
+    let(:expected_result) do
+      [
+          {:name=>"/spec", :is_directory=>true},
+          {:name=>"/spec/example_spec.rb", :is_directory=>false, :size=>template_file_size('rspec', 'example_spec.rb')},
+          {:name=>"/spec/spec_helper.rb", :is_directory=>false, :size=>template_file_size('rspec', 'spec_helper.rb')},
+          {:name=>"/tasks", :is_directory=>true},
+          {:name=>"/tasks/rspec.rake", :is_directory=>false, :size=>template_file_size('rspec', 'rspec.rake')}
+      ]
+    end
+    it { expect(subject).to eql(expected_result) }
+    describe "output" do
+      let(:expected_output) do
+        "      Integrates RSpec to the framework.
+      Added 'spec/spec_helper.rb' file
+      Added 'spec/example_spec.rb' file
+      Added 'tasks/rspec.rake' file\n"
+      end
+      subject { output.string }
+      it { expect(subject).to eql(expected_output) }
+    end
+  end
+
+
+end
+