howitzer 1.0.2 → 1.1.0

data/spec/support/generator_helper.rb

@@ -1,3 +1,6 @@
+require 'fileutils'
+require_relative '../../generators/base_generator'
+
 module GeneratorHelper
   def file_tree_info(root)
     Dir["#{root}/**/*"].sort_by{|name| name.sub(root, '') }.map do |name|
@@ -10,4 +13,8 @@ module GeneratorHelper
   def template_file_size(root_directory, file)
     File.size(File.join(generators_path, root_directory, 'templates', file))
   end
-end
+end
+
+Howitzer::BaseGenerator.logger = StringIO.new
+Howitzer::BaseGenerator.destination = Dir.mktmpdir
+Dir[File.join(generators_path, '**', '*_generator.rb')].each{ |f| require f }

data/spec/unit/generators/base_generator_spec.rb

@@ -0,0 +1,242 @@
+require 'spec_helper'
+
+RSpec.describe Howitzer::BaseGenerator do
+  let(:output) { StringIO.new }
+  let(:destination) { Dir.mktmpdir }
+
+  describe '.logger' do
+    subject { described_class.logger }
+    before { described_class.instance_variable_set('@logger', output) }
+    it { is_expected.to eq(output) }
+  end
+
+  describe '.logger=' do
+    subject { described_class.instance_variable_get('@logger') }
+    before { described_class.logger = output }
+    it { is_expected.to eq(output) }
+  end
+
+  describe '.destination' do
+    subject { described_class.destination }
+    before { described_class.instance_variable_set('@destination', destination) }
+    it { is_expected.to eq(destination) }
+  end
+
+  describe '.destination=' do
+    subject { described_class.instance_variable_get('@destination') }
+    before { described_class.destination = destination }
+    it { is_expected.to eq(destination) }
+  end
+
+  describe 'constructor' do
+    let(:list1) { double(:list1) }
+    let(:list2) { double(:list2) }
+    subject { described_class.new }
+    before do
+      expect_any_instance_of(described_class).to receive(:print_banner).with(no_args).once
+      allow_any_instance_of(described_class).to receive(:manifest) do
+        {
+          files: list1,
+          templates: list2,
+          unknown: nil
+        }
+      end
+    end
+    it do
+      expect_any_instance_of(described_class).to receive(:copy_files).with(list1).once
+      expect_any_instance_of(described_class).to receive(:copy_templates).with(list2).once
+      subject
+    end
+  end
+
+  describe '#manifest' do
+    subject { described_class.new.manifest }
+    before { allow_any_instance_of(described_class).to receive(:initialize) { nil } }
+    it { is_expected.to be_nil }
+  end
+
+  describe '#banner' do
+    subject { described_class.new.send(:banner) }
+    before { allow_any_instance_of(described_class).to receive(:initialize) { nil } }
+    it { is_expected.to be_nil }
+  end
+
+  describe '#logger' do
+    subject { described_class.new.send(:logger) }
+    before { allow_any_instance_of(described_class).to receive(:initialize) { nil } }
+    context 'when not specified' do
+      before { described_class.instance_variable_set('@logger', nil) }
+      it { is_expected.to eq($stdout) }
+    end
+    context 'when custom' do
+      let(:output) { StringIO.new }
+      before { described_class.instance_variable_set('@logger', output) }
+      it { is_expected.to eq(output) }
+    end
+  end
+
+  describe '#destination' do
+    subject { described_class.new.send(:destination) }
+    before do
+      allow_any_instance_of(described_class).to receive(:initialize) { nil }
+      allow(described_class).to receive(:destination) { '/' }
+    end
+    it { is_expected.to eq('/') }
+  end
+
+  describe '#copy_files' do
+    let(:list) { [ {source: 'example.txt'} ] }
+    let(:source_path) { '/example_path/example.txt' }
+    let(:generator) { described_class.new }
+    subject { generator.send(:copy_files, list) }
+    before do
+      allow_any_instance_of(described_class).to receive(:initialize) { nil }
+      allow(generator).to receive(:source_path).with(list.first[:source]) { source_path }
+    end
+    after { subject }
+    context 'when source_file exists' do
+      before { allow(File).to receive(:exists?).with(source_path) { true } }
+      it { expect(generator).to receive(:copy_with_path).with(list.first).once }
+    end
+    context 'when source_file missing' do
+      before { allow(File).to receive(:exists?).with(source_path) { false } }
+      it { expect(generator).to receive(:puts_error).with("File '/example_path/example.txt' was not found.").once }
+    end
+  end
+
+  describe '#copy_templates' do
+    subject { described_class.new.send(:copy_templates, nil) }
+    before { allow_any_instance_of(described_class).to receive(:initialize) { nil } }
+    it { is_expected.to be_nil }
+  end
+
+  describe '#print_banner' do
+    let(:generator) { described_class.new }
+    subject { generator.send(:print_banner) }
+    before do
+      allow_any_instance_of(described_class).to receive(:initialize) { nil }
+      allow(generator).to receive(:banner) { banner }
+    end
+    after { subject }
+    context 'when banner present' do
+      let(:banner) { 'banner' }
+      it { expect(described_class.logger).to receive(:puts).with(banner).once }
+    end
+    context 'when banner blank' do
+      let(:banner) { '' }
+      it { expect(described_class.logger).not_to receive(:puts) }
+    end
+  end
+
+  describe '#print_info' do
+    subject { described_class.new.send(:print_info, 'data') }
+    before { allow_any_instance_of(described_class).to receive(:initialize) { nil } }
+    after { subject }
+    it { expect(described_class.logger).to receive(:print).with('      data')}
+  end
+
+  describe '#puts_info' do
+    subject { described_class.new.send(:puts_info, 'data') }
+    before { allow_any_instance_of(described_class).to receive(:initialize) { nil } }
+    after { subject }
+    it { expect(described_class.logger).to receive(:puts).with('      data')}
+  end
+
+  describe '#puts_error' do
+    subject { described_class.new.send(:puts_error, 'data') }
+    before { allow_any_instance_of(described_class).to receive(:initialize) { nil } }
+    after { subject }
+    it { expect(described_class.logger).to receive(:puts).with('      ERROR: data')}
+  end
+
+  describe '#source_path' do
+    subject { described_class.new.send(:source_path, 'example.txt') }
+    before do
+      allow_any_instance_of(described_class).to receive(:initialize) { nil }
+      allow(File).to receive(:dirname) { '/' }
+    end
+    it { is_expected.to eq('/base/templates/example.txt') }
+  end
+
+  describe '#dest_path' do
+    subject { described_class.new.send(:dest_path, 'example.txt') }
+    before { allow_any_instance_of(described_class).to receive(:initialize) { nil } }
+    it { is_expected.to include('/example.txt') }
+  end
+
+  describe '#copy_with_path' do
+    let(:generator) { described_class.new }
+    let(:data) { {source: 's.txt', destination: 'd.txt'} }
+    let(:src) { '/path/to/s.txt' }
+    let(:dst) { '/path/to/d.txt' }
+    subject { generator.send(:copy_with_path, data) }
+    before do
+      allow_any_instance_of(described_class).to receive(:initialize) { nil }
+      allow(generator).to receive(:source_path).with('s.txt') { src }
+      allow(generator).to receive(:dest_path).with('d.txt') { dst }
+      allow(FileUtils).to receive(:mkdir_p).with('/path/to') { true }
+    end
+    after { subject }
+    context 'when destination file present' do
+      before { allow(File).to receive(:exists?).with(dst) { true } }
+      context 'when identical with source file' do
+        before { allow(FileUtils).to receive(:identical?).with(src, dst) { true } }
+        it { expect(generator).to receive(:puts_info).with("Identical 'd.txt' file").once }
+      end
+      context 'when not identical with source file' do
+        before do
+          allow(FileUtils).to receive(:identical?).with(src, dst) { false }
+          expect(generator).to receive(:puts_info).with("Conflict with 'd.txt' file")
+          expect(generator).to receive(:print_info).with("  Overwrite 'd.txt' file? [Yn]:")
+        end
+        context 'when user typed Y' do
+          before { allow(generator).to receive(:gets) { 'Y' } }
+          it do
+            expect(FileUtils).to receive(:cp).with(src, dst) {nil}.once
+            expect(generator).to receive(:puts_info).with("    Forced 'd.txt' file")
+          end
+        end
+        context 'when user typed y' do
+          before { allow(generator).to receive(:gets) { 'y' } }
+          it do
+            expect(FileUtils).to receive(:cp).with(src, dst) {nil}.once
+            expect(generator).to receive(:puts_info).with("    Forced 'd.txt' file")
+          end
+        end
+        context 'when user typed N' do
+          before { allow(generator).to receive(:gets) { 'N' } }
+          it do
+            expect(generator).to receive(:puts_info).with("    Skipped 'd.txt' file")
+            expect(FileUtils).not_to receive(:cp)
+          end
+        end
+        context 'when user typed n' do
+          before { allow(generator).to receive(:gets) { 'n' } }
+          it do
+            expect(generator).to receive(:puts_info).with("    Skipped 'd.txt' file")
+            expect(FileUtils).not_to receive(:cp)
+          end
+        end
+        context 'when user typed hello' do
+          before { allow(generator).to receive(:gets) { 'hello' } }
+          it do
+            expect(generator).not_to receive(:puts_info)
+            expect(FileUtils).not_to receive(:cp)
+          end
+        end
+      end
+    end
+    context 'when destination file missing' do
+      before { allow(File).to receive(:exists?).with(dst) { false } }
+      it do
+        expect(generator).to receive(:puts_info).with("Added 'd.txt' file")
+        expect(FileUtils).to receive(:cp).with(src, dst).once
+      end
+    end
+    context 'when exception happened' do
+      before { allow(FileUtils).to receive(:mkdir_p).and_raise(StandardError.new('Some error')) }
+      it { expect(generator).to receive(:puts_error).with("Impossible to create 'd.txt' file. Reason: Some error")}
+    end
+  end
+
+end

data/spec/unit/generators/config_generator_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+RSpec.describe 'Generators' do
+  let(:destination) { Howitzer::BaseGenerator.destination }
+  let(:output) { StringIO.new }
+  subject { file_tree_info(destination) }
+  before do
+    Howitzer::BaseGenerator.logger = output
+    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 { is_expected.to eql(expected_result) }
+    describe 'output' do
+      let(:expected_output) do
+        "  * Config files generation ...
+      Added 'config/custom.yml' file
+      Added 'config/default.yml' file\n"
+      end
+      subject { output.string }
+      it { is_expected.to eql(expected_output) }
+    end
+  end
+end

data/spec/unit/generators/cucumber_generator_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+RSpec.describe 'Generators' do
+  let(:destination) { Howitzer::BaseGenerator.destination }
+  let(:output) { StringIO.new }
+  subject { file_tree_info(destination) }
+  before do
+    Howitzer::BaseGenerator.logger = output
+    generator_name.new
+  end
+  after { FileUtils.rm_r(destination) }
+
+  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 { is_expected.to eql(expected_result) }
+    describe 'output' do
+      let(:expected_output) do
+        "  * 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\n"
+      end
+      subject { output.string }
+      it { is_expected.to eql(expected_output) }
+    end
+  end
+end

data/spec/unit/generators/emails_generator_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+RSpec.describe 'Generators' do
+  let(:destination) { Howitzer::BaseGenerator.destination }
+  let(:output) { StringIO.new }
+  subject { file_tree_info(destination) }
+  before do
+    Howitzer::BaseGenerator.logger = output
+    generator_name.new
+  end
+  after { FileUtils.rm_r(destination) }
+
+  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 { is_expected.to eql(expected_result) }
+    describe 'output' do
+      let(:expected_output) do
+        "  * Email example generation ...
+      Added '/emails/example_email.rb' file\n"
+      end
+      subject { output.string }
+      it { is_expected.to eql(expected_output) }
+    end
+  end
+end

data/spec/unit/generators/pages_generator_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe 'Generators' do
+  let(:destination) { Howitzer::BaseGenerator.destination }
+  let(:output) { StringIO.new }
+  subject { file_tree_info(destination) }
+  before do
+    Howitzer::BaseGenerator.logger = output
+    generator_name.new
+  end
+  after { FileUtils.rm_r(destination) }
+
+  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 { is_expected.to eql(expected_result) }
+    describe 'output' do
+      let(:expected_output) do
+        "  * PageOriented pattern structure generation ...
+      Added 'pages/example_page.rb' file
+      Added 'pages/example_menu.rb' file\n"
+      end
+      subject { output.string }
+      it { is_expected.to eql(expected_output) }
+    end
+  end
+end

data/spec/unit/generators/root_generator_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+RSpec.describe 'Generators' do
+  let(:destination) { Howitzer::BaseGenerator.destination }
+  let(:output) { StringIO.new }
+  subject { file_tree_info(destination) }
+  before do
+    Howitzer::BaseGenerator.logger = output
+    generator_name.new
+  end
+  after { FileUtils.rm_r(destination) }
+
+  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 { is_expected.to eql(expected_result) }
+    describe 'output' do
+      let(:expected_output) do
+        "  * Root files generation ...
+      Added '.gitignore' file
+      Added 'Gemfile' file
+      Added 'Rakefile' file
+      Added 'boot.rb' file\n"
+      end
+      subject { output.string }
+      it { is_expected.to eql(expected_output) }
+    end
+  end
+end

data/spec/unit/generators/rspec_generator_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe 'Generators' do
+  let(:destination) { Howitzer::BaseGenerator.destination }
+  let(:output) { StringIO.new }
+  subject { file_tree_info(destination) }
+  before do
+    Howitzer::BaseGenerator.logger = output
+    generator_name.new
+  end
+  after { FileUtils.rm_r(destination) }
+
+  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 { is_expected.to eql(expected_result) }
+    describe 'output' do
+      let(:expected_output) do
+        "  * RSpec integration 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 { is_expected.to eql(expected_output) }
+    end
+  end
+end