bluebase 0.0.2 → 1.0.0

data/lib/bluebase/generators/app_generator.rb

@@ -0,0 +1,129 @@
+require "rails/generators"
+require "rails/generators/rails/app/app_generator"
+
+module Bluebase
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :database, type: :string, aliases: "-d", default: "postgresql",
+      desc: "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+    class_option :heroku, type: :boolean, aliases: "-H", default: false,
+      desc: "Create staging and production Heroku apps"
+
+    class_option :skip_git, type: :boolean, default: false, desc: "Skip git init"
+
+    class_option :skip_bundle, type: :boolean, default: true, desc: "Don't run bundle install"
+
+    class_option :github, type: :string, aliases: "-G", default: nil,
+      desc: "Create Github repository and add remote origin pointed to repo"
+
+    class_option :skip_test_unit, type: :boolean, aliases: "-T", default: true,
+      desc: "Skip Test::Unit files"
+
+    # Invoked after Rails generates app
+    def finish_template
+      invoke :bluebase_customization
+      super
+    end
+
+    def bluebase_customization
+      invoke :customize_root_files
+      invoke :customize_app_files
+      invoke :customize_bin_files
+      invoke :customize_config_files
+      invoke :customize_spec_files
+      invoke :setup_git_and_github
+      invoke :setup_heroku_apps
+      invoke :outro
+    end
+
+    def customize_root_files
+      build :replace_gemfile
+      build :add_envrc
+      build :replace_gitignore
+      build :add_rubocop_and_hound_config
+      build :add_rvm_config
+      build :add_travis_config
+      build :add_guardfile
+      build :add_dot_rspec
+    end
+
+    def customize_app_files
+      build :add_vendor_dirs
+      build :replace_application_css_with_scss
+      build :add_application_folder_and_files_to_views
+      build :replace_application_erb_with_slim
+    end
+
+    def customize_bin_files
+      build :add_setup_to_bin
+    end
+
+    def customize_config_files
+      build :configure_application_environment
+      build :configure_development_environment
+      build :configure_test_environment
+      build :configure_production_environment
+      build :add_staging_environment
+      build :add_devise_config
+      build :add_figaro_config
+      build :replace_en_yml
+      build :add_application_yml
+      build :add_database_yml if options[:database] == 'postgresql'
+      build :add_travis_database_yml
+      build :add_i18n_tasks_yml
+      build :replace_secrets_yml
+      build :add_smtp_settings
+      build :remove_routes_comment_lines
+    end
+
+    def customize_spec_files
+      build :add_spec_dirs
+      build :configure_rspec
+      build :configure_factorygirl
+      build :configure_actionmailer
+      build :configure_i18n
+      build :configure_database_cleaner
+    end
+
+    def setup_git_and_github
+      if !options[:skip_git]
+        say "Initializing git"
+        build :git_init
+        if options[:github]
+          say "Creating github repo"
+          build :create_github_repo, options[:github]
+        end
+      end
+    end
+
+    def setup_heroku_apps
+      if options[:heroku]
+        say "Creating heroku apps"
+        build :create_heroku_apps
+        build :set_heroku_remotes
+        build :set_heroku_env_variables
+        build :add_heroku_addons
+        build :set_memory_management_variable
+      end
+    end
+
+    def outro
+      say "Your bluebase is complete!"
+      say "Remember to set:"
+      say "- Your database settings in config/database.yml"
+      say "- Your env variables in config/application.yml"
+      say "- Your Code Climate token in .travis.yml"
+      say "Afterward, you can now run bin/setup in your project directory to set up the app."
+    end
+
+    def run_bundle
+      # We'll run it ourselves
+    end
+
+    private
+
+    def get_builder_class
+      Bluebase::AppBuilder
+    end
+  end
+end

data/lib/bluebase/version.rb

@@ -1,5 +1,5 @@
 module Bluebase
   RAILS_VERSION = "4.1.7"
   RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/spec/fakes/bin/heroku

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join('..', '..', 'support', 'fake_heroku'), File.dirname(__FILE__))
+
+FakeHeroku.new(ARGV).run!

data/spec/fakes/bin/hub

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join('..', '..', 'support', 'fake_github'), File.dirname(__FILE__))
+
+FakeGithub.new(ARGV).run!

data/spec/features/github_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+feature 'GitHub' do
+  scenario 'Initialize a project with --github option' do
+    repo_name = 'test'
+    run_bluebase("--github=#{repo_name}")
+
+    expect(FakeGithub).to have_created_repo(repo_name)
+  end
+end

data/spec/features/heroku_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+feature 'Heroku' do
+  scenario 'Initialize a project with --heroku=true' do
+    run_bluebase('--heroku=true')
+
+    expect(FakeHeroku).to have_gem_included(project_path, 'rails_12factor')
+    expect(FakeHeroku).to have_created_app_for('staging')
+    expect(FakeHeroku).to have_created_app_for('production')
+
+    bin_setup = IO.read("#{project_path}/bin/setup")
+    app_name = BluebaseTestHelpers::APP_NAME
+
+    expect(bin_setup).to include("figaro heroku:set -a #{app_name}-production -e production")
+    expect(bin_setup).to include("figaro heroku:set -a #{app_name}-staging -e production")
+
+    expect(bin_setup).to include("heroku join --app #{app_name}-staging")
+    expect(bin_setup).to include("heroku join --app #{app_name}-production")
+
+    expect(bin_setup).to include("heroku addons:add mandrill --app #{app_name}-production")
+    expect(bin_setup).to include("heroku addons:add newrelic:stark --app #{app_name}-production")
+    expect(bin_setup).to include("heroku addons:add rollbar --app #{app_name}-production")
+  end
+end

data/spec/features/new_project_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+feature 'Initialize a new project with default configuration' do
+  # TODO: Write comprehensive specs
+  before { run_bluebase }
+
+  scenario 'staging config is inherited from production' do
+    staging_file = IO.read("#{project_path}/config/environments/staging.rb")
+    config_stub = "Rails.application.configure do"
+
+    expect(staging_file).to match(/^require_relative "production"/)
+    expect(staging_file).to match(/#{config_stub}/), staging_file
+  end
+
+  scenario 'generated .ruby-version is pulled from Bluebase .ruby-version' do
+    ruby_version_file = IO.read("#{project_path}/.ruby-version")
+
+    expect(ruby_version_file).to eq "#{RUBY_VERSION}\n"
+  end
+
+  scenario 'secrets.yml reads secret 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
+
+  scenario 'action mailer support file is added' do
+    expect(File).to exist("#{project_path}/spec/support/action_mailer.rb")
+  end
+
+  scenario "i18n support file is added" do
+    expect(File).to exist("#{project_path}/spec/support/i18n.rb")
+  end
+
+  scenario "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
+
+  scenario "raises on missing translations in development and test" do
+    %w[development test].each do |environment|
+      environment_file =
+        IO.read("#{project_path}/config/environments/#{environment}.rb")
+      expect(environment_file).to match(
+        /^ +config.action_view.raise_on_missing_translations = true$/
+      )
+    end
+  end
+
+  scenario "specs for missing or unused translations" do
+    bin_setup = IO.read("#{project_path}/bin/setup")
+    expect(bin_setup).to include("cp $(i18n-tasks gem-path)/templates/rspec/i18n_spec.rb spec/")
+  end
+
+  scenario "config file for i18n tasks" do
+    expect(File).to exist("#{project_path}/config/i18n-tasks.yml")
+  end
+
+  scenario "generated en.yml is evaluated" do
+    locales_en_file = IO.read("#{project_path}/config/locales/en.yml")
+    app_name = BluebaseTestHelpers::APP_NAME
+
+    expect(locales_en_file).to match(/application: #{app_name.humanize}/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'capybara/rspec'
+require 'bundler/setup'
+require 'pry'
+
+Bundler.require(:default, :test)
+
+require (Pathname.new(__FILE__).dirname + '../lib/bluebase').expand_path
+
+Dir['./spec/support/**/*.rb'].each { |file| require file }
+RSpec.configure do |config|
+  config.include BluebaseTestHelpers
+
+  config.before(:all) do
+    create_tmp_directory
+  end
+
+  config.before(:each) do
+    drop_dummy_database
+    remove_project_directory
+
+    FakeHeroku.clear!
+    FakeGithub.clear!
+  end
+end

data/spec/support/bluebase.rb

@@ -0,0 +1,49 @@
+module BluebaseTestHelpers
+  APP_NAME = "dummy"
+
+  def remove_project_directory
+    FileUtils.rm_rf(project_path)
+  end
+
+  def create_tmp_directory
+    FileUtils.mkdir_p(tmp_path)
+  end
+
+  def run_bluebase(arguments = nil)
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        ENV["TESTING"] = "1"
+
+        %x(#{bluebase_bin} #{APP_NAME} #{arguments})
+      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 project_path
+    @project_path ||= Pathname.new("#{tmp_path}/#{APP_NAME}")
+  end
+
+  private
+
+  def tmp_path
+    @tmp_path ||= Pathname.new("#{root_path}/tmp")
+  end
+
+  def bluebase_bin
+    File.join(root_path, "bin", "bluebase")
+  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

data/spec/support/fake_heroku.rb

@@ -0,0 +1,32 @@
+class FakeHeroku
+  RECORDER = File.expand_path(File.join('..', '..', 'tmp', 'heroku_commands'), File.dirname(__FILE__))
+
+  def initialize(args)
+    @args = args
+  end
+
+  def run!
+    File.open(RECORDER, 'a') do |file|
+      file.puts @args.join(' ')
+    end
+  end
+
+  def self.clear!
+    FileUtils.rm_rf RECORDER
+  end
+
+  def self.has_gem_included?(project_path, gem_name)
+    gemfile = File.open(File.join(project_path, 'Gemfile'), 'a')
+
+    File.foreach(gemfile).any? do |line|
+      line.match(/#{Regexp.quote(gem_name)}/)
+    end
+  end
+
+  def self.has_created_app_for?(remote_name)
+    app_name = "#{BluebaseTestHelpers::APP_NAME}-#{remote_name}"
+    expected_line = "create #{app_name} --remote #{remote_name}\n"
+
+    File.foreach(RECORDER).any? { |line| line == expected_line }
+  end
+end

data/templates/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/templates/.hound.yml

@@ -0,0 +1,4 @@
+inherit_from: ./.rubocop.yml
+
+# Show cop names by default; can commment out if needed
+ShowCopNames: true

data/templates/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/templates/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  Exclude:
+    - app/views/**/*
+    - app/helpers/ApplicationHelper
+    - bin/*
+    - config/initializers/*
+    - db/schema.rb
+    - db/migrate/**/*devise*.rb
+    - spec/spec_helper.rb
+    - Guardfile
+
+Metrics/LineLength:
+  Description: 'Limit lines to 110 characters.'
+  Max: 110
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/templates/.travis.yml.erb

@@ -0,0 +1,12 @@
+language: ruby
+
+install: bundle install --without development production --deployment --jobs=3 --retry=3
+addons:
+  postgresql: "9.3"
+before_script:
+  - psql -c 'create database "<%= app_name %>_test";' -U postgres
+  - cp config/database.yml.travis config/database.yml
+  - cp config/application.yml.travis config/application.yml
+
+# Replace YOUR_TOKEN with your Code Climate repo token to get test coverage stats
+script: CODECLIMATE_REPO_TOKEN=YOUR_TOKEN bundle exec rake

data/templates/Gemfile.erb

@@ -0,0 +1,74 @@
+source "https://rubygems.org"
+ruby "<%= Bluebase::RUBY_VERSION %>"
+
+# Core gems
+gem "rails", "<%= Bluebase::RAILS_VERSION %>"
+gem "thin"
+<% if options[:database] == 'postgresql' -%>
+gem "pg"
+<% else -%>
+gem "sqlite3"
+<% end -%>
+gem "figaro"
+
+# Components
+gem "turbolinks"
+gem "devise"
+gem "simple_form"
+gem "gon"
+gem "kaminari"
+gem "recipient_interceptor"
+
+# Frontend
+gem "sass-rails", "~> 4.0.3"
+gem "coffee-rails"
+gem "jquery-rails"
+gem "uglifier"
+gem "slim-rails"
+gem "autoprefixer-rails"
+
+gem "flutie"
+gem "title"
+
+# Error logging - requires setup with service
+gem "rollbar"
+
+group :development do
+  gem "annotate"
+  gem "better_errors"
+  gem "binding_of_caller"
+  gem "quiet_assets"
+  gem "spring"
+  gem "spring-commands-rspec"
+  gem "rubocop"
+  gem "guard-rubocop"
+  gem "guard-livereload"
+  gem "i18n-tasks"
+end
+
+group :development, :test do
+  gem "awesome_print"
+  gem "pry-rails"
+  gem "pry-byebug"
+
+  gem "rspec-rails", "~> 3.1.0"
+  gem "factory_girl_rails"
+  gem "ffaker"
+end
+
+group :test do
+  gem "shoulda-matchers", require: false
+  gem "database_cleaner"
+  gem "capybara"
+  gem "launchy"
+  gem "guard-rspec"
+
+  gem "codeclimate-test-reporter", require: nil
+end
+
+group :staging, :production do
+  gem "rails_12factor"
+
+  # Analytics - requires setup
+  gem "newrelic_rpm"
+end