ajmalafif-jumpstart 1.18.4

data/lib/jumpstart/generators/app_generator.rb

@@ -0,0 +1,215 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Jumpstart
+  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 :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'
+
+    def finish_template
+      invoke :jumpstart_customization
+      super
+    end
+
+    def jumpstart_customization
+      invoke :customize_gemfile
+      invoke :setup_development_environment
+      invoke :setup_test_environment
+      invoke :setup_production_environment
+      invoke :setup_staging_environment
+      invoke :setup_secret_token
+      invoke :create_jumpstart_views
+      invoke :setup_coffeescript
+      invoke :configure_app
+      invoke :setup_stylesheets
+      invoke :install_bitters
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_routes_comment_lines
+      invoke :setup_git
+      invoke :setup_database
+      invoke :create_heroku_apps
+      invoke :create_github_repo
+      invoke :setup_segment_io
+      invoke :outro
+    end
+
+    def customize_gemfile
+      build :replace_gemfile
+      build :set_ruby_to_version_being_used
+
+      if options[:heroku]
+        build :setup_heroku_specific_gems
+      end
+
+      bundle_command 'install'
+    end
+
+    def setup_database
+      say 'Setting up database'
+
+      if 'postgresql' == options[:database]
+        build :use_postgres_config_template
+      end
+
+      build :create_database
+    end
+
+    def setup_development_environment
+      say 'Setting up the development environment'
+      build :raise_on_delivery_errors
+      build :raise_on_unpermitted_parameters
+      build :provide_setup_script
+      build :provide_dev_prime_task
+      build :configure_generators
+      build :configure_i18n_for_missing_translations
+    end
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :set_up_factory_girl_for_rspec
+      build :generate_rspec
+      build :configure_rspec
+      build :configure_background_jobs_for_rspec
+      build :enable_database_cleaner
+      build :configure_spec_support_features
+      build :configure_travis
+      build :configure_i18n_for_test_environment
+      build :configure_i18n_tasks
+      build :configure_action_mailer_in_specs
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_newrelic
+      build :configure_smtp
+      build :enable_rack_deflater
+      build :setup_asset_host
+    end
+
+    def setup_staging_environment
+      say 'Setting up the staging environment'
+      build :setup_staging_environment
+    end
+
+    def setup_secret_token
+      say 'Moving secret token out of version control'
+      build :setup_secret_token
+    end
+
+    def create_jumpstart_views
+      say 'Creating jumpstart views'
+      build :create_partials_directory
+      build :create_shared_flashes
+      build :create_shared_javascripts
+      build :create_application_layout
+    end
+
+    def setup_coffeescript
+      say 'Setting up CoffeeScript defaults'
+      build :remove_turbolinks
+    end
+
+    def configure_app
+      say 'Configuring app'
+      build :configure_action_mailer
+      build :configure_time_zone
+      build :configure_time_formats
+      build :configure_rack_timeout
+      build :disable_xml_params
+      build :fix_i18n_deprecation_warning
+      build :setup_default_rake_task
+      build :configure_unicorn
+      build :setup_foreman
+    end
+
+    def setup_stylesheets
+      say 'Set up stylesheets'
+      build :setup_stylesheets
+    end
+
+    def install_bitters
+      say 'Install Bitters'
+      build :install_bitters
+    end
+
+    def setup_git
+      if !options[:skip_git]
+        say 'Initializing git'
+        invoke :setup_gitignore
+        invoke :init_git
+      end
+    end
+
+    def create_heroku_apps
+      if options[:heroku]
+        say 'Creating Heroku apps'
+        build :create_heroku_apps
+        build :set_heroku_remotes
+        build :set_heroku_rails_secrets
+      end
+    end
+
+    def create_github_repo
+      if !options[:skip_git] && options[:github]
+        say 'Creating Github repo'
+        build :create_github_repo, options[:github]
+      end
+    end
+
+    def setup_segment_io
+      say 'Setting up Segment.io'
+      build :setup_segment_io
+    end
+
+    def setup_gitignore
+      build :gitignore_files
+    end
+
+    def init_git
+      build :init_git
+    end
+
+    def copy_miscellaneous_files
+      say 'Copying miscellaneous support files'
+      build :copy_miscellaneous_files
+    end
+
+    def customize_error_pages
+      say 'Customizing the 500/404/422 pages'
+      build :customize_error_pages
+    end
+
+    def remove_routes_comment_lines
+      build :remove_routes_comment_lines
+    end
+
+    def outro
+      say 'Congratulations! You just pulled our jumpstart.'
+      say "Remember to run 'rails generate airbrake' with your API key."
+    end
+
+    def run_bundle
+      # Let's not: We'll bundle manually at the right spot
+    end
+
+    protected
+
+    def get_builder_class
+      Jumpstart::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+  end
+end

data/lib/jumpstart/version.rb

@@ -0,0 +1,5 @@
+module Jumpstart
+  RAILS_VERSION = "4.1.7"
+  RUBY_VERSION = IO.read("#{File.dirname(__FILE__)}/../../.ruby-version").strip
+  VERSION = "1.18.4"
+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 'Suspend a project with --github option' do
+    repo_name = 'test'
+    run_jumpstart("--github=#{repo_name}")
+
+    expect(FakeGithub).to have_created_repo(repo_name)
+  end
+end

data/spec/features/heroku_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+feature 'Heroku' do
+  scenario 'Suspend a project with --heroku=true' do
+    run_jumpstart('--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')
+    expect(FakeHeroku).to have_configured_vars('staging', 'SECRET_KEY_BASE')
+    expect(FakeHeroku).to have_configured_vars('production', 'SECRET_KEY_BASE')
+
+    bin_setup = IO.read("#{project_path}/bin/setup")
+    app_name = JumpstartTestHelpers::APP_NAME
+
+    expect(bin_setup).to include("heroku join --app #{app_name}-staging")
+    expect(bin_setup).to include("heroku join --app #{app_name}-production")
+  end
+end

data/spec/features/new_project_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+feature 'Suspend a new project with default configuration' do
+  scenario 'specs pass' do
+    run_jumpstart
+
+    Dir.chdir(project_path) do
+      Bundler.with_clean_env do
+        expect(`rake`).to include('0 failures')
+      end
+    end
+  end
+
+  scenario 'staging config is inherited from production' do
+    run_jumpstart
+
+    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 Jumpstart .ruby-version' do
+    run_jumpstart
+
+    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
+    run_jumpstart
+
+    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
+    run_jumpstart
+
+    expect(File).to exist("#{project_path}/spec/support/action_mailer.rb")
+  end
+
+  scenario "i18n support file is added" do
+    run_jumpstart
+
+    expect(File).to exist("#{project_path}/spec/support/i18n.rb")
+  end
+
+  scenario 'newrelic.yml reads NewRelic license from env' do
+    run_jumpstart
+
+    newrelic_file = IO.read("#{project_path}/config/newrelic.yml")
+
+    expect(newrelic_file).to match(
+      /license_key: "<%= ENV\["NEW_RELIC_LICENSE_KEY"\] %>"/
+    )
+  end
+
+  scenario 'records pageviews through Segment.io if ENV variable set' do
+    run_jumpstart
+
+    expect(analytics_partial).
+      to include(%{<% if ENV["SEGMENT_IO_KEY"] %>})
+    expect(analytics_partial).
+      to include(%{window.analytics.load("<%= ENV["SEGMENT_IO_KEY"] %>");})
+  end
+
+  scenario "raises on unpermitted parameters in all environments" do
+    run_jumpstart
+
+    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
+    run_jumpstart
+
+    %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
+    run_jumpstart
+
+    expect(File).to exist("#{project_path}/spec/i18n_spec.rb")
+  end
+
+  scenario "config file for i18n tasks" do
+    run_jumpstart
+
+    expect(File).to exist("#{project_path}/config/i18n-tasks.yml")
+  end
+
+  scenario "generated en.yml is evaluated" do
+    run_jumpstart
+
+    locales_en_file = IO.read("#{project_path}/config/locales/en.yml")
+    app_name = JumpstartTestHelpers::APP_NAME
+
+    expect(locales_en_file).to match(/application: #{app_name.humanize}/)
+  end
+
+  def analytics_partial
+    IO.read("#{project_path}/app/views/application/_analytics.html.erb")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'capybara/rspec'
+require 'bundler/setup'
+
+Bundler.require(:default, :test)
+
+require (Pathname.new(__FILE__).dirname + '../lib/jumpstart').expand_path
+
+Dir['./spec/support/**/*.rb'].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include JumpstartTestHelpers
+
+  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/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,38 @@
+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 = "#{JumpstartTestHelpers::APP_NAME}-#{remote_name}"
+    expected_line = "create #{app_name} --remote=#{remote_name}\n"
+
+    File.foreach(RECORDER).any? { |line| line == expected_line }
+  end
+
+  def self.has_configured_vars?(remote_name, var)
+    File.foreach(RECORDER).any? do |line|
+      line =~ /^config:add #{var}=.+ --remote=#{remote_name}\n$/
+    end
+  end
+end