armadura 0.1.0

data/spec/features/new_project_spec.rb

@@ -0,0 +1,295 @@
+require "spec_helper"
+
+RSpec.describe "Suspend a new project with default configuration" do
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    run_armadura
+    setup_app_dependencies
+  end
+
+  it "uses custom Gemfile" do
+    gemfile_file = IO.read("#{project_path}/Gemfile")
+    expect(gemfile_file).to match(
+      /^ruby "#{Armadura::RUBY_VERSION}"$/,
+    )
+    expect(gemfile_file).to match(
+      /^gem "autoprefixer-rails"$/,
+    )
+    expect(gemfile_file).to match(
+      /^gem "rails", "#{Armadura::RAILS_VERSION}"$/,
+    )
+  end
+
+  it "ensures project specs pass" do
+    Dir.chdir(project_path) do
+      Bundler.with_clean_env do
+        expect(`rake`).to include('0 failures')
+      end
+    end
+  end
+
+  it "creates .ruby-version from Armadura .ruby-version" do
+    ruby_version_file = IO.read("#{project_path}/.ruby-version")
+
+    expect(ruby_version_file).to eq "#{RUBY_VERSION}\n"
+  end
+
+  it "copies dotfiles" do
+    %w[.ctags .env].each do |dotfile|
+      expect(File).to exist("#{project_path}/#{dotfile}")
+    end
+  end
+
+  it "loads secret_key_base from env" do
+    secrets_file = IO.read("#{project_path}/config/secrets.yml")
+
+    expect(secrets_file).
+      to match(/secret_key_base: <%= ENV\["SECRET_KEY_BASE"\] %>/)
+  end
+
+  it "adds bin/setup file" do
+    expect(File).to exist("#{project_path}/bin/setup")
+  end
+
+  it "makes bin/setup executable" do
+    bin_setup_path = "#{project_path}/bin/setup"
+
+    expect(File.stat(bin_setup_path)).to be_executable
+  end
+
+  it "adds support file for action mailer" do
+    expect(File).to exist("#{project_path}/spec/support/action_mailer.rb")
+  end
+
+  it "configures capybara-webkit" do
+    expect(File).to exist("#{project_path}/spec/support/capybara_webkit.rb")
+  end
+
+  it "adds support file for i18n" do
+    expect(File).to exist("#{project_path}/spec/support/i18n.rb")
+  end
+
+  it "creates good default .hound.yml" do
+    hound_config_file = IO.read("#{project_path}/.hound.yml")
+
+    expect(hound_config_file).to include "enabled: true"
+  end
+
+  it "ensures Gemfile contains `rack-mini-profiler`" do
+    gemfile = IO.read("#{project_path}/Gemfile")
+
+    expect(gemfile).to include %{gem "rack-mini-profiler", require: false}
+  end
+
+  it "ensures .sample.env defaults to RACK_MINI_PROFILER=0" do
+    env = IO.read("#{project_path}/.env")
+
+    expect(env).to include "RACK_MINI_PROFILER=0"
+  end
+
+  it "creates a rack-mini-profiler initializer" do
+    expect(File).
+      to exist("#{project_path}/config/initializers/rack_mini_profiler.rb")
+  end
+
+  it "records pageviews through Segment if ENV variable set" do
+    expect(analytics_partial).
+      to include(%{<% if ENV["SEGMENT_KEY"] %>})
+    expect(analytics_partial).
+      to include(%{window.analytics.load("<%= ENV["SEGMENT_KEY"] %>");})
+  end
+
+  it "raises on unpermitted parameters in all environments" do
+    result = IO.read("#{project_path}/config/application.rb")
+
+    expect(result).to match(
+      /^ +config.action_controller.action_on_unpermitted_parameters = :raise$/
+    )
+  end
+
+  it "adds explicit quiet_assets configuration" do
+    result = IO.read("#{project_path}/config/application.rb")
+
+    expect(result).to match(/^ +config.assets.quiet = true$/)
+  end
+
+  it "configures public_file_server.headers in production" do
+    expect(production_config).to match(
+      /^ +config.public_file_server.headers = {\n +"Cache-Control" => "public,/,
+    )
+  end
+
+  it "raises on missing translations in development and test" do
+    [development_config, test_config].each do |environment_file|
+      expect(environment_file).to match(
+        /^ +config.action_view.raise_on_missing_translations = true$/
+      )
+    end
+  end
+
+  it "evaluates en.yml.erb" do
+    locales_en_file = IO.read("#{project_path}/config/locales/en.yml")
+
+    expect(locales_en_file).to match(/application: #{app_name.humanize}/)
+  end
+
+  it "configs simple_form" do
+    expect(File).to exist("#{project_path}/config/initializers/simple_form.rb")
+  end
+
+  it "configs :test email delivery method for development" do
+    expect(development_config).
+      to match(/^ +config.action_mailer.delivery_method = :file$/)
+  end
+
+  it "uses APPLICATION_HOST, not HOST in the production config" do
+    expect(production_config).to match(/"APPLICATION_HOST"/)
+    expect(production_config).not_to match(/"HOST"/)
+  end
+
+  it "configures email interceptor in smtp config" do
+    smtp_file = IO.read("#{project_path}/config/smtp.rb")
+    expect(smtp_file).
+      to match(/RecipientInterceptor.new\(ENV\["EMAIL_RECIPIENTS"\]\)/)
+  end
+
+  it "configures language in html element" do
+    layout_path = "/app/views/layouts/application.html.erb"
+    layout_file = IO.read("#{project_path}#{layout_path}")
+    expect(layout_file).to match(/<html lang="en">/)
+  end
+
+  it "configures the test environment to process queues inline" do
+    test_config = IO.read("#{project_path}/config/environments/test.rb")
+
+    expect(test_config).to match(
+      "config.active_job.queue_adapter = :inline"
+    )
+  end
+
+  it "configs bullet gem in development" do
+    expect(development_config).to match /^ +Bullet.enable = true$/
+    expect(development_config).to match /^ +Bullet.bullet_logger = true$/
+    expect(development_config).to match /^ +Bullet.rails_logger = true$/
+  end
+
+  it "configs missing assets to raise in test" do
+    expect(test_config).to match(
+      /^ +config.assets.raise_runtime_errors = true$/,
+    )
+  end
+
+  it "adds spring to binstubs" do
+    expect(File).to exist("#{project_path}/bin/spring")
+
+    bin_stubs = %w(rake rails rspec)
+    bin_stubs.each do |bin_stub|
+      expect(IO.read("#{project_path}/bin/#{bin_stub}")).to match(/spring/)
+    end
+  end
+
+  it "removes comments and extra newlines from config files" do
+    config_files = [
+      IO.read("#{project_path}/config/application.rb"),
+      IO.read("#{project_path}/config/environment.rb"),
+      development_config,
+      test_config,
+      production_config,
+    ]
+
+    config_files.each do |file|
+      expect(file).not_to match(/.*#.*/)
+      expect(file).not_to match(/^$\n/)
+    end
+  end
+
+  it "copies factories.rb" do
+    expect(File).to exist("#{project_path}/spec/factories.rb")
+  end
+
+  it "creates review apps setup script" do
+    bin_setup_path = "#{project_path}/bin/setup_review_app"
+    bin_setup = IO.read(bin_setup_path)
+
+    expect(bin_setup).to include("heroku run rake db:migrate --exit-code "\
+                                 "--app #{app_name.dasherize}-staging-pr-$1")
+    expect(bin_setup).to include("heroku ps:scale worker=1 "\
+                                 "--app #{app_name.dasherize}-staging-pr-$1")
+    expect(bin_setup).to include("heroku restart "\
+                                 "--app #{app_name.dasherize}-staging-pr-$1")
+    expect(File.stat(bin_setup_path)).to be_executable
+  end
+
+  it "creates deploy script" do
+    bin_deploy_path = "#{project_path}/bin/deploy"
+    bin_deploy = IO.read(bin_deploy_path)
+
+    expect(bin_deploy).to include("heroku run rake db:migrate --exit-code")
+    expect(File.stat(bin_deploy_path)).to be_executable
+  end
+
+  it "creates heroku application manifest file with application name in it" do
+    app_json_file = IO.read("#{project_path}/app.json")
+
+    expect(app_json_file).to match(/"name":"#{app_name.dasherize}"/)
+  end
+
+  it "sets up heroku specific gems" do
+    gemfile_file = IO.read("#{project_path}/Gemfile")
+
+    expect(gemfile_file).to include %{gem "rails_stdout_logging"}
+  end
+
+  def app_name
+    ArmaduraTestHelpers::APP_NAME
+  end
+
+  it "adds high_voltage" do
+    gemfile = IO.read("#{project_path}/Gemfile")
+    expect(gemfile).to match(/high_voltage/)
+  end
+
+  it "adds and configures bourbon, neat, and refills" do
+    gemfile = read_project_file("Gemfile")
+
+    expect(gemfile).to match(/bourbon/)
+    expect(gemfile).to match(/neat/)
+    expect(gemfile).to match(/refills/)
+  end
+
+  it "configures bourbon, neat, and refills" do
+    flashes_path = %w(app assets stylesheets refills _flashes.scss)
+    expect(read_project_file(flashes_path)).to match(/\$flashes/m)
+
+    app_css = read_project_file(%w(app assets stylesheets application.scss))
+    expect(app_css).to match(/normalize-rails.*bourbon.*neat.*base.*refills/m)
+  end
+
+  it "doesn't use turbolinks" do
+    app_js = read_project_file(%w(app assets javascripts application.js))
+    expect(app_js).not_to match(/turbolinks/)
+  end
+
+  def development_config
+    @_development_config ||=
+      read_project_file %w(config environments development.rb)
+  end
+
+  def test_config
+    @_test_config ||= read_project_file %w(config environments test.rb)
+  end
+
+  def production_config
+    @_production_config ||=
+      read_project_file %w(config environments production.rb)
+  end
+
+  def analytics_partial
+    IO.read("#{project_path}/app/views/application/_analytics.html.erb")
+  end
+
+  def read_project_file(path)
+    IO.read(File.join(project_path, *path))
+  end
+end

data/spec/features/sidekiq_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+RSpec.describe "Sidekiq" do
+  before(:all) do
+    drop_dummy_database
+    remove_project_directory
+    run_armadura
+    setup_app_dependencies
+  end
+
+  it "adds Sidekiq to the Gemfile" do
+    gemfile = IO.read("#{project_path}/Gemfile")
+    expect(gemfile).to include("sidekiq")
+  end
+
+  it "creates a config/sidekiq.yml file configured with the default and mailers queues" do
+    sidekiq_config_file = "#{project_path}/config/sidekiq.yml"
+    expect(File.exist?(sidekiq_config_file)).to be true
+    expect(File.read(sidekiq_config_file)).to include "- default"
+    expect(File.read(sidekiq_config_file)).to include "- mailers"
+  end
+
+  it "configures ActiveJob to use Sidekiq" do
+    application_config = IO.read("#{project_path}/config/application.rb")
+
+    expect(application_config).to include(
+      "config.active_job.queue_adapter = :sidekiq"
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'bundler/setup'
+
+Bundler.require(:default, :test)
+
+require (Pathname.new(__FILE__).dirname + '../lib/armadura').expand_path
+
+Dir['./spec/support/**/*.rb'].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include ArmaduraTestHelpers
+
+  config.before(:all) do
+    add_fakes_to_path
+    create_tmp_directory
+  end
+
+  config.before(:each) do
+    FakeGithub.clear!
+  end
+end

data/spec/support/armadura.rb

@@ -0,0 +1,83 @@
+module ArmaduraTestHelpers
+  APP_NAME = "dummy_app"
+
+  def remove_project_directory
+    FileUtils.rm_rf(project_path)
+  end
+
+  def create_tmp_directory
+    FileUtils.mkdir_p(tmp_path)
+  end
+
+  def run_armadura(arguments = nil)
+    arguments = "--path=#{root_path} #{arguments}"
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        add_fakes_to_path
+        `
+          #{armadura_bin} #{APP_NAME} #{arguments}
+        `
+      end
+    end
+  end
+
+  def armadura_help_command
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        `
+          #{armadura_bin} -h
+        `
+      end
+    end
+  end
+
+  def setup_app_dependencies
+    if File.exist?(project_path)
+      Dir.chdir(project_path) do
+        Bundler.with_clean_env do
+          `bundle check || bundle install`
+        end
+      end
+    end
+  end
+
+  def drop_dummy_database
+    if File.exist?(project_path)
+      Dir.chdir(project_path) do
+        Bundler.with_clean_env do
+          `rake db:drop`
+        end
+      end
+    end
+  end
+
+  def add_fakes_to_path
+    ENV["PATH"] = "#{support_bin}:#{ENV['PATH']}"
+  end
+
+  def project_path
+    @project_path ||= Pathname.new("#{tmp_path}/#{APP_NAME}")
+  end
+
+  def usage_file
+    @usage_path ||= File.join(root_path, "USAGE")
+  end
+
+  private
+
+  def tmp_path
+    @tmp_path ||= Pathname.new("#{root_path}/tmp")
+  end
+
+  def armadura_bin
+    File.join(root_path, 'bin', 'armadura')
+  end
+
+  def support_bin
+    File.join(root_path, "spec", "fakes", "bin")
+  end
+
+  def root_path
+    File.expand_path('../../../', __FILE__)
+  end
+end

data/spec/support/fake_github.rb

@@ -0,0 +1,21 @@
+class FakeGithub
+  RECORDER = File.expand_path(File.join('..', '..', 'tmp', 'hub_commands'), File.dirname(__FILE__))
+
+  def initialize(args)
+    @args = args
+  end
+
+  def run!
+    File.open(RECORDER, 'a') do |file|
+      file.write @args.join(' ')
+    end
+  end
+
+  def self.clear!
+    FileUtils.rm_rf RECORDER
+  end
+
+  def self.has_created_repo?(repo_name)
+    File.read(RECORDER) == "create #{repo_name}"
+  end
+end