welaika-suspenders 1.4.0 → 2.0.0.pre

data/lib/{welaika_suspenders → suspenders}/generators/app_generator.rb

@@ -1,7 +1,7 @@
 require 'rails/generators'
 require 'rails/generators/rails/app/app_generator'
 
-module WelaikaSuspenders
+module Suspenders
   class AppGenerator < Rails::Generators::AppGenerator
     class_option :database, :type => :string, :aliases => '-d', :default => 'postgresql',
       :desc => "Preconfigure for selected database (options: #{DATABASES.join('/')})"
@@ -21,37 +21,36 @@ module WelaikaSuspenders
     end
 
     def suspenders_customization
-      invoke :remove_files_we_dont_need
       invoke :customize_gemfile
-      invoke :setup_database
       invoke :setup_development_environment
       invoke :setup_test_environment
       invoke :setup_production_environment
       invoke :setup_staging_environment
+      invoke :setup_secret_token
       invoke :create_suspenders_views
-      invoke :setup_javascripts
-      invoke :setup_presenters
+      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 :configure_dragonfly
       invoke :setup_git
+      invoke :setup_database
       invoke :create_heroku_apps
       invoke :create_github_repo
       invoke :outro
     end
 
-    def remove_files_we_dont_need
-      build :remove_public_index
-      build :remove_rails_logo_image
-    end
-
     def customize_gemfile
       build :replace_gemfile
       build :set_ruby_to_version_being_used
-      bundle_command 'install --binstubs=bin/stubs'
+
+      if options[:heroku]
+        build :setup_heroku_specific_gems
+      end
+
+      bundle_command 'install'
     end
 
     def setup_database
@@ -67,32 +66,44 @@ module WelaikaSuspenders
     def setup_development_environment
       say 'Setting up the development environment'
       build :raise_on_delivery_errors
+      build :configure_letter_opener
       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 :enable_factory_girl_syntax
-      build :test_factories_first
+      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_capybara_webkit
-      build :setup_guard_spork
+      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
-      build :initialize_on_precompile
+    end
+
+    def setup_secret_token
+      say 'Moving secret token out of version control'
+      build :setup_secret_token
     end
 
     def create_suspenders_views
@@ -103,35 +114,20 @@ module WelaikaSuspenders
       build :create_application_layout
     end
 
-    def setup_javascripts
-      say 'Setting up javascripts'
-      build :setup_javascripts
-    end
-
-    def setup_presenters
-      say 'Setting up presenters'
-      build :setup_presenters
-    end
-
-    def setup_database
-      say 'Setting up database'
-
-      if 'postgresql' == options[:database]
-        build :use_postgres_config_template
-      end
-
-      build :create_database
+    def setup_coffeescript
+      say 'Setting up CoffeeScript defaults'
+      build :remove_turbolinks
     end
 
     def configure_app
       say 'Configuring app'
       build :configure_action_mailer
-      build :blacklist_active_record_attributes
-      build :configure_strong_parameters
       build :configure_time_zone
       build :configure_time_formats
       build :configure_rack_timeout
       build :disable_xml_params
+      build :configure_available_locales
+      build :fix_i18n_deprecation_warning
       build :setup_default_rake_task
       build :configure_unicorn
       build :setup_foreman
@@ -142,21 +138,31 @@ module WelaikaSuspenders
       build :setup_stylesheets
     end
 
+    def install_bitters
+      say 'Install Bitters'
+      build :install_bitters
+    end
+
     def setup_git
-      say 'Initializing git'
-      invoke :setup_gitignore
-      invoke :init_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
+        build :set_memory_management_variable
       end
     end
 
     def create_github_repo
-      if options[:github]
+      if !options[:skip_git] && options[:github]
         say 'Creating Github repo'
         build :create_github_repo, options[:github]
       end
@@ -170,11 +176,6 @@ module WelaikaSuspenders
       build :init_git
     end
 
-    def copy_libraries
-      say 'Copying libraries'
-      build :copy_libraries
-    end
-
     def copy_miscellaneous_files
       say 'Copying miscellaneous support files'
       build :copy_miscellaneous_files
@@ -189,13 +190,9 @@ module WelaikaSuspenders
       build :remove_routes_comment_lines
     end
 
-    def configure_dragonfly
-      say 'Configuring dragonfly'
-      build :configure_dragonfly
-    end
-
     def outro
-      say 'Congratulations! You just pulled our suspenders.'
+      say "Congratulations!"
+      say "Remember to run 'bin/setup' and configure errbit"
     end
 
     def run_bundle
@@ -205,7 +202,7 @@ module WelaikaSuspenders
     protected
 
     def get_builder_class
-      WelaikaSuspenders::AppBuilder
+      Suspenders::AppBuilder
     end
 
     def using_active_record?
@@ -213,4 +210,3 @@ module WelaikaSuspenders
     end
   end
 end
-

data/lib/suspenders/version.rb

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

data/lib/suspenders.rb

@@ -0,0 +1,4 @@
+require 'suspenders/version'
+require 'suspenders/generators/app_generator'
+require 'suspenders/actions'
+require 'suspenders/app_builder'

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_suspenders("--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_suspenders('--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 = SuspendersTestHelpers::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,115 @@
+require 'spec_helper'
+
+feature 'Suspend a new project with default configuration' do
+  scenario 'specs pass' do
+    run_suspenders
+
+    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_suspenders
+
+    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 Suspenders .ruby-version' do
+    run_suspenders
+
+    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_suspenders
+
+    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_suspenders
+
+    expect(File).to exist("#{project_path}/spec/support/action_mailer.rb")
+  end
+
+  scenario "i18n support file is added" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/spec/support/i18n.rb")
+  end
+
+  scenario 'newrelic.yml reads NewRelic license from env' do
+    run_suspenders
+
+    newrelic_file = IO.read("#{project_path}/config/newrelic.yml")
+
+    expect(newrelic_file).to match(
+      /license_key: "<%= ENV\["NEW_RELIC_LICENSE_KEY"\] %>"/
+    )
+  end
+
+  scenario "set up available locales" do
+    run_suspenders
+
+    result = IO.read("#{project_path}/config/application.rb")
+
+    expect(result).to match(
+      /^ +config.i18n.available_locales = \[:en, :it\]$/
+    )
+  end
+
+  scenario "raises on unpermitted parameters in all environments" do
+    run_suspenders
+
+    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_suspenders
+
+    %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_suspenders
+
+    expect(File).to exist("#{project_path}/spec/i18n_spec.rb")
+  end
+
+  scenario "config file for i18n tasks" do
+    run_suspenders
+
+    expect(File).to exist("#{project_path}/config/i18n-tasks.yml")
+  end
+
+  scenario "generated en.yml is evaluated" do
+    run_suspenders
+
+    locales_en_file = IO.read("#{project_path}/config/locales/en.yml")
+    app_name = SuspendersTestHelpers::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'
+
+Bundler.require(:default, :test)
+
+require (Pathname.new(__FILE__).dirname + '../lib/suspenders').expand_path
+
+Dir['./spec/support/**/*.rb'].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include SuspendersTestHelpers
+
+  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/{features → spec}/support/fake_github.rb

@@ -16,6 +16,6 @@ class FakeGithub
   end
 
   def self.has_created_repo?(repo_name)
-    File.open(RECORDER, 'r').read.include?("create #{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 = "#{SuspendersTestHelpers::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

data/spec/support/suspenders.rb

@@ -0,0 +1,49 @@
+module SuspendersTestHelpers
+  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_suspenders(arguments = nil)
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        ENV['TESTING'] = '1'
+
+        %x(#{suspenders_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 suspenders_bin
+    File.join(root_path, 'bin', 'welaika-suspenders')
+  end
+
+  def root_path
+    File.expand_path('../../../', __FILE__)
+  end
+end

data/suspenders.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'suspenders/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = ">= #{Suspenders::RUBY_VERSION}"
+  s.authors = ['thoughtbot', 'weLaika']
+  s.date = Date.today.strftime('%Y-%m-%d')
+
+  s.description = <<-HERE
+weLaika's fork of the famous thoughbot suspenders gem.
+  HERE
+
+  s.email = 'info@welaika.com'
+  s.executables = ['welaika-suspenders']
+  s.extra_rdoc_files = %w[README.md LICENSE]
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'http://github.com/welaika/welaika-suspenders'
+  s.license = 'MIT'
+  s.name = 'welaika-suspenders'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.summary = "Generate a Rails app using thoughtbot's best practices."
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Suspenders::VERSION
+
+  s.add_dependency 'bitters', '~> 0.10.0'
+  s.add_dependency 'bundler', '~> 1.3'
+  s.add_dependency 'rails', Suspenders::RAILS_VERSION
+
+  s.add_development_dependency 'aruba', '~> 0.5'
+  s.add_development_dependency 'cucumber', '~> 1.2'
+  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'capybara', '~> 2.2', '>= 2.2.0'
+end

data/templates/Gemfile.erb

@@ -0,0 +1,58 @@
+source "https://rubygems.org"
+
+ruby "<%= Suspenders::RUBY_VERSION %>"
+
+gem "airbrake"
+gem "bourbon", "~> 3.2.1"
+gem "coffee-rails"
+gem "delayed_job_active_record"
+gem "email_validator"
+gem "flutie"
+gem "high_voltage"
+gem "i18n-tasks"
+gem "jquery-rails"
+gem "neat", "~> 1.5.1"
+gem "newrelic_rpm"
+gem "normalize-rails", "~> 3.0.0"
+gem "pg"
+gem "rack-timeout"
+gem "rails", "<%= Suspenders::RAILS_VERSION %>"
+gem "rails-i18n"
+gem "recipient_interceptor"
+gem "sass-rails", "~> 4.0.3"
+gem "slim-rails"
+gem "simple_form"
+gem "title"
+gem "uglifier"
+gem "unicorn"
+
+group :development do
+  gem "letter_opener"
+  gem "spring"
+  gem "spring-commands-rspec"
+end
+
+group :development, :test do
+  gem "awesome_print"
+  gem "byebug"
+  gem "dotenv-rails"
+  gem "faker"
+  gem "factory_girl_rails"
+  gem "priscilla"
+  gem "pry-bloodline"
+  gem "pry-rails"
+  gem "rspec-rails", "~> 3.0.0"
+end
+
+group :test do
+  gem "capybara-webkit", ">= 1.2.0"
+  gem "database_cleaner"
+  gem "formulaic"
+  gem "launchy"
+  gem "shoulda-matchers", require: false
+  gem "timecop"
+  gem "webmock"
+end
+
+group :staging, :production do
+end

data/templates/Procfile

@@ -1,3 +1,2 @@
 web: bundle exec unicorn -p $PORT -c ./config/unicorn.rb
-# worker: bundle exec rake jobs:work
-
+worker: bundle exec rake jobs:work

data/templates/README.md.erb

@@ -1,5 +1,31 @@
-You look great in Suspenders
-============================
+<%= app_name.humanize %>
+<%= '=' * app_name.humanize.length %>
+
+Getting Started
+---------------
+
+After you have cloned this repo, run this setup script to set up your machine
+with the necessary dependencies to run and test this app:
+
+    % ./bin/setup
+
+It assumes you have a machine equipped with Ruby, Postgres, etc. If not, set up
+your machine with [this script].
+
+[this script]: https://github.com/thoughtbot/laptop
+
+After setting up, you can run the application using [foreman]:
+
+    % foreman start
+
+If you don't have `foreman`, see [Foreman's install instructions][foreman]. It
+is [purposefully excluded from the project's `Gemfile`][exclude].
+
+[foreman]: https://github.com/ddollar/foreman
+[exclude]: https://github.com/ddollar/foreman/pull/437#issuecomment-41110407
+
+Guidelines
+----------
 
 Use the following guides for getting things done, programming well, and
 programming in style.

data/templates/_flashes.html.slim

@@ -1,3 +1,4 @@
-#flash
-  - flash.each do |key, value|
-    div id="flash_#{key}"= value
+- if flash.any?
+  #flash
+    - flash.each do |key, value|
+      div id="flash_#{key}"= value

data/templates/_javascript.html.slim

@@ -1,5 +1,8 @@
 = javascript_include_tag :application
+
 = yield :javascript
+
 - if Rails.env.test?
   javascript:
+    $.fx.off = true;
     $.ajaxSetup({ async: false });

data/templates/action_mailer.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before(:each) do
+    ActionMailer::Base.deliveries.clear
+  end
+end

data/templates/application.css.scss

@@ -1,8 +1,7 @@
 @charset 'utf-8';
 
-///////////////////////////////////////////////////////////////////////////////
-
+@import 'normalize-rails';
 @import 'bourbon';
+@import 'base/grid-settings';
 @import 'neat';
-
-///////////////////////////////////////////////////////////////////////////////
+@import 'base/base';