gb-firestarter 0.0.1 → 0.1.0

data/lib/firestarter/app_builder.rb

@@ -0,0 +1,297 @@
+module Firestarter
+  class AppBuilder < Rails::AppBuilder
+    include Firestarter::Actions
+
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+
+    def rakefile
+      template 'Rakefile.erb', 'Rakefile'
+    end
+
+    def raise_on_delivery_errors
+      replace_in_file 'config/environments/development.rb',
+        'raise_delivery_errors = false', 'raise_delivery_errors = true'
+    end
+
+    def raise_on_unpermitted_parameters
+      action_on_unpermitted_parameters = <<-RUBY
+
+  # Raise an ActionController::UnpermittedParameters exception when
+  # a parameter is not explcitly permitted but is passed anyway.
+  config.action_controller.action_on_unpermitted_parameters = :raise
+      RUBY
+      inject_into_file(
+        "config/environments/development.rb",
+        action_on_unpermitted_parameters,
+        before: "\nend"
+      )
+    end
+
+    def provide_setup_script
+      remove_file 'bin/setup'
+      copy_file 'bin_setup', 'bin/setup'
+      run 'chmod a+x bin/setup'
+    end
+
+    def provide_dev_prime_task
+      copy_file 'development_seeds.rb', 'lib/tasks/development_seeds.rake'
+    end
+
+    def configure_generators
+      config = <<-RUBY
+    config.generators do |generate|
+      generate.helper false
+      generate.javascript_engine false
+      generate.request_specs false
+      generate.routing_specs false
+      generate.stylesheets false
+      generate.test_framework :rspec
+      generate.view_specs false
+    end
+
+      RUBY
+
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def enable_factory_girl_syntax
+      copy_file 'factory_girl_syntax_rspec.rb', 'spec/support/factory_girl.rb'
+    end
+
+    def test_factories_first
+      copy_file 'factories_spec.rb', 'spec/models/factories_spec.rb'
+      append_file 'Rakefile', factories_spec_rake_task
+    end
+
+    def configure_smtp
+      copy_file 'smtp.rb', 'config/initializers/smtp.rb'
+
+      prepend_file 'config/environments/production.rb',
+        "require Rails.root.join('config/initializers/smtp')\n"
+
+      config = <<-RUBY
+
+  config.action_mailer.delivery_method = :smtp
+  config.action_mailer.smtp_settings = SMTP_SETTINGS
+      RUBY
+
+      inject_into_file 'config/environments/production.rb', config,
+        :after => 'config.action_mailer.raise_delivery_errors = false'
+    end
+
+    def enable_rack_deflater
+      config = <<-RUBY
+
+  # Enable deflate / gzip compression of controller-generated responses
+  config.middleware.use Rack::Deflater
+      RUBY
+
+      inject_into_file 'config/environments/production.rb', config,
+        :after => "config.serve_static_assets = false\n"
+    end
+
+    def setup_staging_environment
+      staging_file = 'config/environments/staging.rb'
+      copy_file 'staging.rb', staging_file
+
+      config = <<-RUBY
+
+#{app_name.classify}::Application.configure do
+  # ...
+end
+      RUBY
+
+      append_file staging_file, config
+    end
+
+    def setup_secret_token
+      template 'secret_token.rb',
+        'config/initializers/secret_token.rb',
+        :force => true
+    end
+
+    def create_partials_directory
+      empty_directory 'app/views/application'
+    end
+
+    def create_shared_flashes
+      copy_file '_flashes.slim', 'app/views/application/_flashes.slim'
+    end
+
+    def create_shared_javascripts
+      copy_file '_javascript.slim', 'app/views/application/_javascript.slim'
+    end
+
+    def create_application_layout
+      remove_file 'app/views/layouts/application.html.erb'
+      template 'firestarter_layout.slim.erb',
+        'app/views/layouts/application.slim',
+        force: true
+    end
+
+    def remove_turbolinks
+      replace_in_file 'app/assets/javascripts/application.js',
+        /\/\/= require turbolinks\n/,
+        ''
+    end
+
+    def use_postgres_config_template
+      template 'postgresql_database.yml.erb', 'config/database.yml',
+        force: true
+    end
+
+    def create_database
+      bundle_command 'exec rake db:create db:migrate'
+    end
+
+    def replace_gemfile
+      remove_file 'Gemfile'
+      template 'Gemfile.erb', 'Gemfile'
+    end
+
+    def set_ruby_to_version_being_used
+      template 'ruby-version.erb', '.ruby-version'
+    end
+
+    def enable_database_cleaner
+      copy_file 'database_cleaner_rspec.rb', 'spec/support/database_cleaner.rb'
+    end
+
+    def configure_spec_support_features
+      empty_directory_with_keep_file 'spec/features'
+      empty_directory_with_keep_file 'spec/support/features'
+    end
+
+    def configure_rspec
+      remove_file 'spec/spec_helper.rb'
+      copy_file 'spec_helper.rb', 'spec/spec_helper.rb'
+    end
+
+    def configure_i18n_in_specs
+      copy_file 'i18n.rb', 'spec/support/i18n.rb'
+    end
+
+    def configure_time_zone
+      config = <<-RUBY
+    config.active_record.default_timezone = :utc
+
+      RUBY
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def configure_time_formats
+      remove_file 'config/locales/en.yml'
+      copy_file 'config_locales_en.yml', 'config/locales/en.yml'
+    end
+
+    def configure_rack_timeout
+      copy_file 'rack_timeout.rb', 'config/initializers/rack_timeout.rb'
+    end
+
+    def configure_action_mailer
+      action_mailer_host 'development', "#{app_name}.local"
+      action_mailer_host 'test', 'www.example.com'
+      action_mailer_host 'staging', "staging.#{app_name}.com"
+      action_mailer_host 'production', "#{app_name}.com"
+    end
+
+    def fix_i18n_deprecation_warning
+      config = <<-RUBY
+    config.i18n.enforce_available_locales = true
+
+      RUBY
+      inject_into_class 'config/application.rb', 'Application', config
+    end
+
+    def generate_rspec
+      generate 'rspec:install'
+    end
+
+    def configure_puma
+      copy_file 'puma.rb', 'config/puma.rb'
+    end
+
+    def setup_foreman
+      copy_file 'sample.env', '.sample.env'
+      copy_file 'Procfile', 'Procfile'
+    end
+
+    def setup_stylesheets
+      remove_file 'app/assets/stylesheets/application.css'
+      copy_file 'application.sass',
+        'app/assets/stylesheets/application.sass'
+    end
+
+    def gitignore_files
+      remove_file '.gitignore'
+      copy_file 'firestarter_gitignore', '.gitignore'
+      [
+        'app/views/pages',
+        'spec/lib',
+        'spec/controllers',
+        'spec/helpers',
+        'spec/support/matchers',
+        'spec/support/mixins',
+        'spec/support/shared_examples'
+      ].each do |dir|
+        run "mkdir #{dir}"
+        run "touch #{dir}/.keep"
+      end
+    end
+
+    def init_git
+      run 'git init'
+    end
+
+    def copy_miscellaneous_files
+      copy_file 'errors.rb', 'config/initializers/errors.rb'
+    end
+
+    def customize_error_pages
+      meta_tags =<<-EOS
+  <meta charset='utf-8' />
+  <meta name='ROBOTS' content='NOODP' />
+      EOS
+
+      %w(500 404 422).each do |page|
+        inject_into_file "public/#{page}.html", meta_tags, :after => "<head>\n"
+        replace_in_file "public/#{page}.html", /<!--.+-->\n/, ''
+      end
+    end
+
+    def remove_routes_comment_lines
+      replace_in_file 'config/routes.rb',
+        /Rails.application\.routes\.draw do.*end/m,
+        "Rails.application.routes.draw do\nend"
+    end
+
+    def disable_xml_params
+      copy_file 'disable_xml_params.rb', 'config/initializers/disable_xml_params.rb'
+    end
+
+    def setup_default_rake_task
+      append_file 'Rakefile' do
+        "task(:default).clear\ntask :default => [:spec]\n"
+      end
+    end
+
+    private
+
+    def override_path_for_tests
+      if ENV['TESTING']
+        support_bin = File.expand_path(File.join('..', '..', 'spec', 'fakes', 'bin'))
+        "PATH=#{support_bin}:$PATH"
+      end
+    end
+
+    def factories_spec_rake_task
+      IO.read find_in_source_paths('factories_spec_rake_task.rb')
+    end
+
+    def generate_secret
+      SecureRandom.hex(64)
+    end
+  end
+end

data/lib/firestarter/generators/app_generator.rb

@@ -0,0 +1,186 @@
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+
+module Firestarter
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :database, :type => :string, :aliases => '-d', :default => 'postgresql',
+      :desc => "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+    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 :firestarter_customization
+      super
+    end
+
+    def firestarter_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_firestarter_views
+      invoke :setup_coffeescript
+      invoke :configure_app
+      invoke :setup_stylesheets
+      invoke :copy_miscellaneous_files
+      invoke :customize_error_pages
+      invoke :remove_routes_comment_lines
+      invoke :setup_git
+      invoke :setup_database
+      invoke :outro
+    end
+
+    def customize_gemfile
+      build :replace_gemfile
+      build :set_ruby_to_version_being_used
+      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
+    end
+
+    def setup_test_environment
+      say 'Setting up the test environment'
+      build :enable_factory_girl_syntax
+      build :test_factories_first
+      build :generate_rspec
+      build :configure_rspec
+      build :enable_database_cleaner
+      build :configure_spec_support_features
+      build :configure_i18n_in_specs
+    end
+
+    def setup_production_environment
+      say 'Setting up the production environment'
+      build :configure_smtp
+      build :enable_rack_deflater
+    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_firestarter_views
+      say 'Creating firestarter 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_puma
+      build :setup_foreman
+    end
+
+    def setup_stylesheets
+      say 'Set up stylesheets'
+      build :setup_stylesheets
+    end
+
+    def setup_git
+      if !options[:skip_git]
+        say 'Initializing git'
+        invoke :setup_gitignore
+        invoke :init_git
+      end
+    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 started a fire.'
+    end
+
+    def run_bundle
+      # Let's not: We'll bundle manually at the right spot
+    end
+
+    def ruby_version_with_patch_level
+      "#{RUBY_VERSION}#{patch_level}"
+    end
+
+    protected
+
+    def get_builder_class
+      Firestarter::AppBuilder
+    end
+
+    def using_active_record?
+      !options[:skip_active_record]
+    end
+
+    def patch_level
+      if RUBY_PATCHLEVEL == 0 && RUBY_VERSION >= '2.1.0'
+        ''
+      else
+        "-p#{RUBY_PATCHLEVEL}"
+      end
+    end
+
+    def spring_install?
+      false
+    end
+  end
+end

data/lib/firestarter/version.rb

@@ -0,0 +1,4 @@
+module Firestarter
+  RAILS_VERSION = ENV['RAILS_VERSION'] || '4.1.8'
+  VERSION = '0.1.0'
+end

data/lib/firestarter.rb

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

data/spec/features/new_project_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+feature 'Suspend a new project with default configuration' do
+  scenario 'specs pass' do
+    run_firestarter
+
+    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_firestarter
+
+    staging_file = IO.read("#{project_path}/config/environments/staging.rb")
+    config_stub = "Dummy::Application.configure do"
+    expect(staging_file).to match(/^require_relative 'production'/)
+    expect(staging_file).to match(/#{config_stub}/), staging_file
+  end
+
+  if RUBY_PATCHLEVEL == 0 && RUBY_VERSION >= '2.1.0'
+    scenario '.ruby-version does not include patchlevel for Ruby 2.1.0+' do
+      run_firestarter
+
+      ruby_version_file = IO.read("#{project_path}/.ruby-version")
+      expect(ruby_version_file).to eq "#{RUBY_VERSION}\n"
+    end
+  else
+    scenario '.ruby-version includes patchlevel for all pre-Ruby 2.1.0 versions' do
+      run_firestarter
+
+      ruby_version_file = IO.read("#{project_path}/.ruby-version")
+      expect(ruby_version_file).to eq "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}\n"
+    end
+  end
+end

data/spec/spec_helper.rb

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

data/spec/support/firestarter.rb

@@ -0,0 +1,49 @@
+module FirestarterTestHelpers
+  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_firestarter(arguments = nil)
+    Dir.chdir(tmp_path) do
+      Bundler.with_clean_env do
+        ENV['TESTING'] = '1'
+
+        %x(#{firestarter_bin} #{APP_NAME} #{arguments})
+      end
+    end
+  end
+
+  def drop_dummy_database
+    if File.exists?(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 firestarter_bin
+    File.join(root_path, 'bin', 'firestarter')
+  end
+
+  def root_path
+    File.expand_path('../../../', __FILE__)
+  end
+end

data/templates/Gemfile.erb

@@ -0,0 +1,55 @@
+source 'https://rubygems.org'
+
+ruby '<%= RUBY_VERSION %>'
+
+gem 'bourbon'
+gem 'coffee-rails'
+gem 'dotenv-rails'
+gem 'email_validator'
+gem 'foreman'
+gem 'jquery-rails'
+gem 'pg'
+gem 'pry-rails'
+gem 'puma'
+gem 'rack-timeout'
+gem 'rails', '~> <%= Firestarter::RAILS_VERSION %>'
+gem 'recipient_interceptor'
+gem 'sass-rails'
+gem 'slim-rails'
+gem 'title'
+gem 'uglifier'
+
+group :development do
+  gem 'better_errors'
+  gem 'binding_of_caller'
+  gem 'letter_opener'
+end
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'factory_girl_rails'
+  gem 'rspec-rails', '~> 3.0'
+end
+
+group :test do
+  gem 'capybara-webkit', '>= 1.0.0'
+  gem 'database_cleaner'
+  gem 'launchy'
+  gem 'simplecov', require: false
+  gem 'timecop'
+  gem 'webmock'
+  gem 'rubocop', require: false
+end
+
+group :production, :staging do
+  gem 'rails_12factor'
+end
+
+group :deploy do
+  gem 'capistrano', '~> 3.2.1', require: false
+  gem 'capistrano-rails', require: false
+  gem 'capistrano-rvm', require: false
+  gem 'capistrano-bundler', require: false
+  gem 'capistrano3-env', require: false
+  gem 'capistrano-foreman', github: 'groupbuddies/capistrano-foreman', branch: :master
+end

data/templates/Procfile

@@ -0,0 +1 @@
+web: bundle exec puma -C config/puma.rb

data/templates/README.md.erb

@@ -0,0 +1,25 @@
+<%= app_name.humanize %>
+<%= '=' * app_name.humanize.length %>
+
+Getting Started
+---------------
+
+This repository comes equipped with a self-setup script:
+
+    % ./bin/setup
+
+After setting up, you can run the application using [foreman]:
+
+    % foreman start
+
+[foreman]: http://ddollar.github.io/foreman/
+
+Guidelines
+----------
+
+Use the following guides for getting things done, programming well, and
+programming in style.
+
+* [Protocol](http://github.com/groupbuddies/guides/blob/master/protocol)
+* [Best Practices](http://github.com/groupbuddies/guides/blob/master/best-practices)
+* [Style](http://github.com/groupbuddies/guides/blob/master/style)

data/templates/Rakefile.erb

@@ -0,0 +1,10 @@
+require File.expand_path('../config/application', __FILE__)
+Rails.application.load_tasks
+
+if %w(development test).include? Rails.env
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+
+  task(:default).clear
+  task default: [:rubocop, :spec]
+end

data/templates/_flashes.slim

@@ -0,0 +1,3 @@
+#flash
+  - flash.each do |key, value|
+    #flash_#{key} = value