orats 0.6.3 → 0.6.4

data/lib/orats/templates/base.rb

@@ -1,49 +1,57 @@
-# =====================================================================================================
-# Template for generating an opinionated base Rails 4.1.0 project using Ruby 2.1.2
-# =====================================================================================================
-
-# ----- Helper functions and variables ----------------------------------------------------------------
-
 require 'securerandom'
 
+# =============================================================================
+# template for generating an orats base project for rails 4.1.x
+# =============================================================================
+# view the task list at the bottom of the file
+# -----------------------------------------------------------------------------
+
+# -----------------------------------------------------------------------------
+# private functions
+# -----------------------------------------------------------------------------
 def generate_token
   SecureRandom.hex(64)
 end
 
-def from_gem(source, destination = nil)
-  base_path = "#{File.expand_path File.dirname(__FILE__)}/includes"
-  file_name = source.split('/').last
-
-  if destination.present? && file_name != destination
-    if destination.include? '/'
-      run "mkdir -p #{destination}"
-    end
-  end
+def method_to_sentence(method)
+  method.tr!('_', ' ')
+  method[0] = method[0].upcase
+  method
+end
 
-  run "cp #{base_path}/#{file_name} #{destination}"
+def log_task(message)
+  puts
+  say_status  'task', "#{method_to_sentence(message.to_s)}:", :yellow
+  puts        '-'*80, ''; sleep 0.25
 end
 
-app_name_class = app_name.humanize
+def git_commit(message)
+  git add: '-A'
+  git commit: "-m '#{message}'"
+end
 
-# ----- Create the git repo ----------------------------------------------------------------------------
+def copy_from_local_gem(source, dest)
+  base_path = "#{File.expand_path File.dirname(__FILE__)}/includes"
+  file_name_of_source = File.basename(source)
 
-puts
-say_status  'git', 'Creating a new local git repo...', :yellow
-puts        '-'*80, ''; sleep 0.25
+  run "mkdir -p #{File.dirname(dest)}" if dest.present? && file_name_of_source != dest
+  run "cp #{base_path}/#{source} #{dest}"
+end
 
-git :init
-git add: '-A'
-git commit: "-m 'Initial commit'"
+# ---
 
-# ----- Modify the .gitignore file --------------------------------------------------------------------
+def initial_git_commit
+  log_task __method__
 
-puts
-say_status  'root', 'Modifying the .gitignore file...', :yellow
-puts        '-'*80, ''; sleep 0.25
+  git :init
+  git_commit 'Initial git commit'
+end
 
-append_to_file '.gitignore' do <<-TEXT
+def update_gitignore
+  log_task __method__
 
-# Ignore OS and editor files.
+  append_to_file '.gitignore' do <<-S
+# OS and editor files
 .DS_Store
 */**.DS_Store
 ._*
@@ -51,41 +59,37 @@ append_to_file '.gitignore' do <<-TEXT
 *~
 .idea/
 
-# Ignore the dotenv file.
+# the dotenv file
 .env
 
-# Ignore app specific folders.
+# app specific folders
 /vendor/bundle
 /public/assets/*
-TEXT
+  S
+  end
+  git_commit 'Add common OS files, editor files and other paths'
 end
 
-git add: '-A'
-git commit: "-m 'Add common OS and editor files to the .gitignore file'"
-
-# ----- Add a bundler config --------------------------------------------------------------------
+def copy_gemfile
+  log_task __method__
 
-# puts
-# say_status  'bundle', 'Creating bundle config...', :yellow
-# puts        '-'*80, ''; sleep 0.25
-#
-# file '.bundle/config' do <<-CODE
-# ---
-# BUNDLE_WITHOUT: production:staging
-# CODE
-# end
-#
-# git add: '-A'
-# git commit: "-m 'Add .bundle/config to ignore production:staging in development mode'"
+  run 'rm -f Gemfile'
+  copy_from_local_gem 'Gemfile', 'Gemfile'
+  git_commit 'Add Gemfile'
+end
 
+def copy_base_favicon
+  log_task __method__
 
-# ----- Create a development environment file ---------------------------------------------------
+  copy_from_local_gem 'app/assets/favicon/favicon_base.png',
+                      'app/assets/favicon/favicon_base.png'
+  git_commit 'Add a 256x256 base favicon'
+end
 
-puts
-say_status  'root', 'Creating development environment file...', :yellow
-puts        '-'*80, ''; sleep 0.25
+def add_dotenv
+  log_task 'add_dotenv'
 
-file '.env' do <<-CODE
+  file '.env' do <<-S
 RAILS_ENV: development
 
 PROJECT_PATH: /full/path/to/your/project
@@ -127,43 +131,28 @@ PUMA_THREADS_MAX: 1
 PUMA_WORKERS: 0
 
 SIDEKIQ_CONCURRENCY: 25
-CODE
+  S
+  end
+  git_commit 'Add development environment file'
 end
 
-git add: '-A'
-git commit: "-m 'Add development environment file'"
-
-# ----- Create the foreman Procfile ------------------------------------------------------------------------
+def add_procfile
+  log_task __method__
 
-puts
-say_status  'start', 'Creating the Procfile for foreman...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-file 'Procfile' do <<-CODE
+  file 'Procfile' do <<-S
 web: puma -C config/puma.rb
 worker: sidekiq -C config/sidekiq.yml
-CODE
+log: tail -f log/development.log
+  S
+  end
+  git_commit 'Add a Procfile'
 end
 
-git add:    '-A'
-git commit: "-m 'Add a basic Procfile to start the puma and sidekiq processes'"
-
-# ----- Modify the secrets yaml file -----------------------------------------------------------------------
-
-gsub_file 'config/secrets.yml', /.*\n/, ''
-append_file 'config/secrets.yml' do <<-FILE
-# Be sure to restart your server when you modify this file.
-
-# Your secret key is used for verifying the integrity of signed cookies.
-# If you change this key, all old signed cookies will become invalid!
-
-# Make sure the secret is at least 30 characters and all random,
-# no regular words or you'll be exposed to dictionary attacks.
-# You can use `rake secret` to generate a secure secret key.
-
-# Make sure the secrets in this file are kept private
-# if you're sharing your code publicly.
+def update_app_secrets
+  log_task __method__
 
+  gsub_file 'config/secrets.yml', /.*\n/, ''
+  append_file 'config/secrets.yml' do <<-S
 development: &default
   secret_key_base: <%= ENV['TOKEN_RAILS_SECRET'] %>
 
@@ -175,19 +164,15 @@ staging:
 
 production:
   <<: *default
-FILE
+  S
+  end
+  git_commit 'DRY out the yaml'
 end
 
-git add:    '-A'
-git commit: "-m 'Dry up the secrets settings'"
+def update_app_config
+  log_task __method__
 
-# ----- Modify the application file -------------------------------------------------------------------
-
-puts
-say_status  'config', 'Modifying the application file...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-inject_into_file 'config/application.rb', after: "automatically loaded.\n" do <<-CODE
+  inject_into_file 'config/application.rb', after: "automatically loaded.\n" do <<-S
     config.action_mailer.delivery_method = :smtp
     config.action_mailer.smtp_settings = {
       :address              => ENV['SMTP_ADDRESS'],
@@ -197,9 +182,9 @@ inject_into_file 'config/application.rb', after: "automatically loaded.\n" do <<
       :password             => ENV['SMTP_PASSWORD'],
       :authentication       => ENV['SMTP_AUTH']
     }
+
     config.action_mailer.smtp_settings[:enable_starttls_auto] = true if ENV['SMTP_ENCRYPTION'] == 'starttls'
     config.action_mailer.smtp_settings[:ssl] = true if ENV['SMTP_ENCRYPTION'] == 'ssl'
-
     config.action_mailer.default_options = { from: ENV['ACTION_MAILER_DEFAULT_FROM'] }
     config.action_mailer.default_url_options = { host: ENV['ACTION_MAILER_HOST'] }
 
@@ -208,15 +193,15 @@ inject_into_file 'config/application.rb', after: "automatically loaded.\n" do <<
                             db: ENV['CACHE_DATABASE'].to_i,
                             namespace: '#{app_name}::cache'
                           }
-    redis_store_options[:password] = ENV['CACHE_PASSWORD'] if ENV['CACHE_PASSWORD'].present?
 
+    redis_store_options[:password] = ENV['CACHE_PASSWORD'] if ENV['CACHE_PASSWORD'].present?
     config.cache_store = :redis_store, redis_store_options
-CODE
-end
-
-gsub_file 'config/application.rb', "# config.time_zone = 'Central Time (US & Canada)'", "config.time_zone = 'Eastern Time (US & Canada)'"
+  S
+  end
 
-append_file 'config/application.rb' do <<-'FILE'
+  gsub_file 'config/application.rb',
+            "# config.time_zone = 'Central Time (US & Canada)'","config.time_zone = 'Eastern Time (US & Canada)'"
+  append_file 'config/application.rb' do <<-'S'
 
 ActionView::Base.field_error_proc = Proc.new do |html_tag, instance|
   if html_tag =~ /\<label/
@@ -226,20 +211,16 @@ ActionView::Base.field_error_proc = Proc.new do |html_tag, instance|
     %(#{html_tag}<p class="validation-error"> #{errors}</p>).html_safe
   end
 end
-FILE
+  S
+  end
+  git_commit 'Configure the mailer/redis, update the timezone and adjust the validation output'
 end
 
-git add:    '-A'
-git commit: "-m 'Add tweakable settings, update the timezone and change the way validation errors are shown'"
-
-# ----- Modify the config files -----------------------------------------------------------------------
+def update_database_config
+  log_task __method__
 
-puts
-say_status  'config', 'Modifying the config files...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-gsub_file 'config/database.yml', /.*\n/, ''
-append_file 'config/database.yml' do <<-FILE
+  gsub_file 'config/database.yml', /.*\n/, ''
+  append_file 'config/database.yml' do <<-S
 development: &default
   adapter: postgresql
   database: <%= ENV['DATABASE_NAME'] %>
@@ -258,13 +239,15 @@ staging:
 
 production:
   <<: *default
-FILE
+  S
+  end
+  git_commit 'DRY out the yaml'
 end
 
-git add:    '-A'
-git commit: "-m 'Dry up the database settings'"
+def add_puma_config
+  log_task __method__
 
-file 'config/puma.rb', <<-'CODE'
+  file 'config/puma.rb', <<-'S'
 environment ENV['RAILS_ENV']
 
 threads ENV['PUMA_THREADS_MIN'].to_i,ENV['PUMA_THREADS_MAX'].to_i
@@ -285,28 +268,32 @@ restart_command 'bundle exec bin/puma'
 
 on_worker_boot do
   require 'active_record'
-  config_path = File.expand_path('../database.yml', __FILE__)
 
+  config_path = File.expand_path('../database.yml', __FILE__)
   ActiveRecord::Base.connection.disconnect! rescue ActiveRecord::ConnectionNotEstablished
   ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'] || YAML.load_file(config_path)[ENV['RAILS_ENV']])
 end
-CODE
+  S
+  git_commit 'Add the puma config'
+end
 
-git add:    '-A'
-git commit: "-m 'Add the puma config'"
+def add_sidekiq_config
+  log_task __method__
 
-file 'config/sidekiq.yml', <<-CODE
+  file 'config/sidekiq.yml', <<-S
 ---
 :pidfile: <%= ENV['PROJECT_PATH'] %>/tmp/sidekiq.pid
 :concurrency: <%= ENV['SIDEKIQ_CONCURRENCY'].to_i %>
 :queues:
   - default
-CODE
+  S
+  git_commit 'Add the sidekiq config'
+end
 
-git add:    '-A'
-git commit: "-m 'Add the sidekiq config'"
+def add_sitemap_config
+  log_task __method__
 
-file 'config/sitemap.rb', <<-'CODE'
+  file 'config/sitemap.rb', <<-'S'
 # Set the host name for URL creation
 SitemapGenerator::Sitemap.default_host = "http://www.app_name.com"
 
@@ -327,14 +314,15 @@ SitemapGenerator::Sitemap.create do
   #   add article_path("#{article.id}-#{article.permalink}"), priority: 0.9, lastmod: article.updated_at
   # end
 end
-CODE
-
-gsub_file 'config/sitemap.rb', 'app_name', app_name
+  S
+  gsub_file 'config/sitemap.rb', 'app_name', app_name
+  git_commit 'Add the sitemap config'
+end
 
-git add:    '-A'
-git commit: "-m 'Add the sitemap config'"
+def add_whenever_config
+  log_task __method__
 
-file 'config/schedule.rb', <<-CODE
+  file 'config/schedule.rb', <<-S
 every 1.day, at: '3:00 am' do
   rake 'orats:backup'
 end
@@ -342,52 +330,14 @@ end
 every 1.day, at: '4:00 am' do
   rake 'sitemap:refresh'
 end
-CODE
-
-git add:    '-A'
-git commit: "-m 'Add a sitemap rake task that occurs at 4am'"
-
-# ----- Modify the environment files ------------------------------------------------------------------
-
-puts
-say_status  'Config', 'Modifying the environment files...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-file 'config/environments/staging.rb', <<-CODE
-require_relative 'production.rb'
-
-#{app_name_class}::Application.configure do
-  # Overwrite any production settings here, or if you want to start from scratch then remove line 1.
-end
-CODE
-
-git add:    '-A'
-git commit: "-m 'Add add staging environment'"
-
-inject_into_file 'config/environments/production.rb', after: "config.log_level = :info\n" do <<-"CODE"
-  config.logger = Logger.new(config.paths['log'].first, 'daily')
-CODE
+  S
+  git_commit 'Add the whenever config'
 end
 
-inject_into_file 'config/environments/production.rb', after: "%w( search.js )\n" do <<-"CODE"
-  config.assets.precompile << Proc.new { |path|
-    if path =~ /\.(eot|svg|ttf|woff|png)\z/
-      true
-    end
-  }
-CODE
-end
-
-git add:    '-A'
-git commit: "-m 'Change production config options'"
-
-# ----- Modify the initializer files ------------------------------------------------------------------
-
-puts
-say_status  'config', 'Modifying the initializer files...', :yellow
-puts        '-'*80, ''; sleep 0.25
+def add_sidekiq_initializer
+  log_task __method__
 
-file 'config/initializers/sidekiq.rb', <<-'CODE'
+  file 'config/initializers/sidekiq.rb', <<-'S'
 ENV['CACHE_PASSWORD'].present? ? pass_string = ":#{ENV['CACHE_PASSWORD']}@" :  pass_string = ''
 
 redis_host = "#{pass_string}#{ENV['CACHE_HOST']}"
@@ -404,145 +354,83 @@ end
 Sidekiq.configure_client do |config|
   config.redis = sidekiq_config
 end
-CODE
-
-gsub_file 'config/initializers/sidekiq.rb', 'ns_app', app_name
+  S
+  gsub_file 'config/initializers/sidekiq.rb', 'ns_app', app_name
+  git_commit 'Add the sidekiq initializer'
+end
 
-git add:    '-A'
-git commit: "-m 'Add the sidekiq initializer'"
+def add_mini_profiler_initializer
+  log_task __method__
 
-file 'config/initializers/mini_profiler.rb', <<-CODE
+  file 'config/initializers/mini_profiler.rb', <<-S
 if defined? Rack::MiniProfiler
   # Toggle with ALT+p
   Rack::MiniProfiler.config.start_hidden = true
 end
-CODE
-
-git add:    '-A'
-git commit: "-m 'Add the rack mini profiler initializer'"
-
-# ----- Modify the routes file ------------------------------------------------------------------------
-
-puts
-say_status  'config', 'Modifying the routes file...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-prepend_file 'config/routes.rb', "require 'sidekiq/web'\n\n"
-
-git add:    '-A'
-git commit: "-m 'Add sidekiq to the routes file'"
-
-inject_into_file 'config/routes.rb', after: "draw do\n" do <<-CODE
-  concern :pageable do
-    get 'page/:page', action: :index, on: :collection
-  end
-CODE
+  S
+  git_commit 'Add the mini profiler initializer'
 end
 
-git add:    '-A'
-git commit: "-m 'Add a route concern for pagination'"
-
-# ----- Creating application tasks --------------------------------------------------------------------
-
-puts
-say_status  'tasks', 'Creating application tasks...', :yellow
-puts        '-'*80, ''; sleep 0.25
+def add_staging_environment
+  log_task __method__
 
-file 'lib/tasks/orats/favicon.rake', <<-'CODE'
-namespace :orats do
-  desc 'Create favicons from a single base png'
-  task :favicons do
-    require 'favicon_maker'
-
-    FaviconMaker.generate do
-      setup do
-        template_dir Rails.root.join('app', 'assets', 'favicon')
-        output_dir Rails.root.join('public')
-      end
+  file 'config/environments/staging.rb', <<-S
+require_relative 'production.rb'
 
-      favicon_base_path = "#{template_dir}/favicon_base.png"
+#{app_name.humanize}::Application.configure do
+  # Overwrite any production settings here, or if you want to start from scratch then remove line 1.
+end
+  S
+  git_commit 'Add a staging environment'
+end
 
-      unless File.exist?(favicon_base_path)
-        puts
-        puts 'A base favicon could not be found, make sure one exists at:'
-        puts base_favicon
-        puts
-        exit 1
-      end
+def update_production_environment
+  log_task __method__
 
-      from File.basename(favicon_base_path) do
-        icon 'speeddial-160x160.png'
-        icon 'apple-touch-icon-228x228-precomposed.png'
-        icon 'apple-touch-icon-152x152-precomposed.png'
-        icon 'apple-touch-icon-144x144-precomposed.png'
-        icon 'apple-touch-icon-120x120-precomposed.png'
-        icon 'apple-touch-icon-114x114-precomposed.png'
-        icon 'apple-touch-icon-76x76-precomposed.png'
-        icon 'apple-touch-icon-72x72-precomposed.png'
-        icon 'apple-touch-icon-60x60-precomposed.png'
-        icon 'apple-touch-icon-57x57-precomposed.png'
-        icon 'favicon-196x196.png'
-        icon 'favicon-160x160.png'
-        icon 'favicon-96x96.png'
-        icon 'favicon-64x64.png'
-        icon 'favicon-32x32.png'
-        icon 'favicon-24x24.png'
-        icon 'favicon-16x16.png'
-        icon 'favicon.ico', size: '64x64,32x32,24x24,16x16'
-      end
+  inject_into_file 'config/environments/production.rb', after: "config.log_level = :info\n" do <<-'S'
+config.logger = Logger.new(config.paths['log'].first, 'daily')
+  S
+  end
+  git_commit 'Update the logger to rotate daily'
 
-      each_icon do |filepath|
-        puts "Creating favicon for: #{File.basename filepath}"
-      end
-    end
+  inject_into_file 'config/environments/production.rb', after: "%w( search.js )\n" do <<-'S'
+config.assets.precompile << Proc.new { |path|
+  if path =~ /\.(eot|svg|ttf|woff|png)\z/
+    true
+  end
+}
+  S
   end
+  git_commit 'Update the assets precompiler to include common file types'
 end
-CODE
 
-git add:    '-A'
-git commit: "-m 'Add a favicon generator task'"
+def update_routes
+  log_task __method__
 
-file 'lib/tasks/orats/backup.rake', <<-'CODE'
-namespace :orats do
-  desc 'Create a backup of your application for a specific environment'
-  task :backup do
-    if File.exist?('.env') && File.file?('.env')
-      require 'dotenv'
-      Dotenv.load
-
-      source_external_env = ''
-    else
-      source_external_env = '. /etc/default/app_name &&'
-    end
+  prepend_file 'config/routes.rb', "require 'sidekiq/web'\n\n"
 
-    # hack'ish way to run the backup command with elevated privileges, it won't prompt for a password on the production
-    # server because passwordless sudo has been enabled if you use the ansible setup provided by orats
-    system 'sudo whoami'
+  inject_into_file 'config/routes.rb', after: "draw do\n" do <<-S
+  concern :pageable do
+    get 'page/:page', action: :index, on: :collection
+  end
 
-    system "#{source_external_env} backup perform -t backup -c '#{File.join('lib', 'backup', 'config.rb')}' --log-path='#{File.join('log')}'"
+  # you may want to protect this behind authentication
+  mount Sidekiq::Web => '/sidekiq'
+  S
   end
+  git_commit 'Add a concern for pagination and mount sidekiq'
 end
-CODE
-
-gsub_file 'lib/tasks/orats/backup.rake', 'app_name', app_name
-
-git add:    '-A'
-git commit: "-m 'Add a backup task'"
-
-# ----- Creating application backup --------------------------------------------------------------------
 
-puts
-say_status  'backup', 'Creating application backup script...', :yellow
-puts        '-'*80, ''; sleep 0.25
+def add_backup_lib
+  log_task __method__
 
-file 'lib/backup/config.rb', <<-'CODE'
+  file 'lib/backup/config.rb', <<-'S'
 ##
 # Backup v4.x Configuration
 #
 # Documentation: http://meskyanichi.github.io/backup
 # Issue Tracker: https://github.com/meskyanichi/backup/issues
 
-##
 # Config Options
 #
 # The options here may be overridden on the command line, but the result
@@ -564,27 +452,21 @@ file 'lib/backup/config.rb', <<-'CODE'
 #
 # Sets the root path for all relative paths, including default paths.
 # May be an absolute path, or relative to the current working directory.
-#
 
 root_path 'lib/backup'
 
-#
 # Sets the path where backups are processed until they're stored.
 # This must have enough free space to hold apx. 2 backups.
 # May be an absolute path, or relative to the current directory or +root_path+.
-#
 
 tmp_path  '../../tmp'
 
-#
 # Sets the path where backup stores persistent information.
 # When Backup's Cycler is used, small YAML files are stored here.
 # May be an absolute path, or relative to the current directory or +root_path+.
-#
 
 data_path '../../tmp/backup/data'
 
-##
 # Utilities
 #
 # If you need to use a utility other than the one Backup detects,
@@ -595,7 +477,6 @@ data_path '../../tmp/backup/data'
 #     redis_cli '/opt/redis/redis-cli'
 #   end
 
-##
 # Logging
 #
 # Logging options may be set on the command line, but certain settings
@@ -613,7 +494,6 @@ data_path '../../tmp/backup/data'
 # to disable syslog and enable console output.
 #   backup perform --trigger my_backup --no-syslog --no-quiet
 
-##
 # Component Defaults
 #
 # Set default options to be applied to components in all models.
@@ -636,7 +516,6 @@ data_path '../../tmp/backup/data'
 #     mail.encryption           = :starttls
 #   end
 
-##
 # Preconfigured Models
 #
 # Create custom models with preconfigured components.
@@ -662,19 +541,15 @@ data_path '../../tmp/backup/data'
 #       mail.to = 'john.smith@email.com'
 #     end
 #   end
-CODE
-
-git add:    '-A'
-git commit: "-m 'Add backup config'"
+  S
 
-file 'lib/backup/models/backup.rb', <<-'CODE'
+  file 'lib/backup/models/backup.rb', <<-'S'
 Model.new(:backup, 'Backup for the current RAILS_ENV') do
   split_into_chunks_of 10
   compress_with Gzip
 
   database PostgreSQL do |db|
     db.sudo_user          = ENV['DATABASE_USERNAME']
-
     # To dump all databases, set `db.name = :all` (or leave blank)
     db.name               = ENV['DATABASE_NAME']
     db.username           = ENV['DATABASE_USERNAME']
@@ -713,7 +588,6 @@ Model.new(:backup, 'Backup for the current RAILS_ENV') do
     mail.on_success           = false
     #mail.on_warning           = true
     mail.on_failure           = true
-
     mail.from                 = ENV['ACTION_MAILER_DEFAULT_FROM']
     mail.to                   = ENV['ACTION_MAILER_DEFAULT_TO']
     mail.address              = ENV['SMTP_ADDRESS']
@@ -725,18 +599,97 @@ Model.new(:backup, 'Backup for the current RAILS_ENV') do
     mail.encryption           = mail_encryption.to_sym
   end
 end
-CODE
+  S
+  git_commit 'Add backup library'
+end
+
+def add_favicon_task
+  log_task __method__
+
+  file 'lib/tasks/orats/favicon.rake', <<-'S'
+namespace :orats do
+  desc 'Create favicons from a single base png'
+  task :favicons do
+    require 'favicon_maker'
+
+    FaviconMaker.generate do
+      setup do
+        template_dir Rails.root.join('app', 'assets', 'favicon')
+        output_dir Rails.root.join('public')
+      end
 
-git add:    '-A'
-git commit: "-m 'Add backup model'"
+      favicon_base_path = "#{template_dir}/favicon_base.png"
 
-# ----- Creating application helpers ------------------------------------------------------------------
+      unless File.exist?(favicon_base_path)
+        puts
+        puts 'A base favicon could not be found, make sure one exists at:'
+        puts favicon_base_path
+        puts
+        exit 1
+      end
 
-puts
-say_status  'helpers', 'Creating application helpers...', :yellow
-puts        '-'*80, ''; sleep 0.25
+      from File.basename(favicon_base_path) do
+        icon 'speeddial-160x160.png'
+        icon 'apple-touch-icon-228x228-precomposed.png'
+        icon 'apple-touch-icon-152x152-precomposed.png'
+        icon 'apple-touch-icon-144x144-precomposed.png'
+        icon 'apple-touch-icon-120x120-precomposed.png'
+        icon 'apple-touch-icon-114x114-precomposed.png'
+        icon 'apple-touch-icon-76x76-precomposed.png'
+        icon 'apple-touch-icon-72x72-precomposed.png'
+        icon 'apple-touch-icon-60x60-precomposed.png'
+        icon 'apple-touch-icon-57x57-precomposed.png'
+        icon 'favicon-196x196.png'
+        icon 'favicon-160x160.png'
+        icon 'favicon-96x96.png'
+        icon 'favicon-64x64.png'
+        icon 'favicon-32x32.png'
+        icon 'favicon-24x24.png'
+        icon 'favicon-16x16.png'
+        icon 'favicon.ico', size: '64x64,32x32,24x24,16x16'
+      end
 
-inject_into_file 'app/helpers/application_helper.rb', after: "ApplicationHelper\n" do <<-CODE
+      each_icon do |filepath|
+        puts "Creating favicon @ #{filepath}"
+      end
+    end
+  end
+end
+  S
+  git_commit 'Add a favicon generator task'
+end
+
+def add_backup_task
+  log_task __method__
+
+  file 'lib/tasks/orats/backup.rake', <<-'S'
+namespace :orats do
+  desc 'Create a backup of your application for a specific environment'
+  task :backup do
+    if File.exist?('.env') && File.file?('.env')
+      require 'dotenv'
+      Dotenv.load
+      source_external_env = ''
+    else
+      source_external_env = '. /etc/default/app_name &&'
+    end
+
+    # hack'ish way to run the backup command with elevated privileges, it won't prompt for a password on the production
+    # server because passwordless sudo has been enabled if you use the ansible setup provided by orats
+    system 'sudo whoami'
+
+    system "#{source_external_env} backup perform -t backup -c '#{File.join('lib', 'backup', 'config.rb')}' --log-path='#{File.join('log')}'"
+  end
+end
+  S
+  gsub_file 'lib/tasks/orats/backup.rake', 'app_name', app_name
+  git_commit 'Add an application backup task'
+end
+
+def add_helpers
+  log_task __method__
+
+  inject_into_file 'app/helpers/application_helper.rb', after: "ApplicationHelper\n" do <<-S
   def title(page_title)
     content_for(:title) { page_title }
   end
@@ -773,7 +726,6 @@ inject_into_file 'app/helpers/application_helper.rb', after: "ApplicationHelper\
 
   def humanize_boolean(input)
     input ||= ''
-
     case input.to_s.downcase
     when 't', 'true'
       'Yes'
@@ -789,21 +741,16 @@ inject_into_file 'app/helpers/application_helper.rb', after: "ApplicationHelper\
       'danger'
     end
   end
-CODE
+  S
+  end
+  git_commit 'Add various helpers'
 end
 
-git add:    '-A'
-git commit: "-m 'Add favicon and boolean view helpers'"
-
-# ----- Creating view files ---------------------------------------------------------------------------
+def add_layout
+  log_task __method__
 
-puts
-say_status  'views', 'Creating view files...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-run 'rm -f app/views/layouts/application.html.erb'
-
-file 'app/views/layouts/application.html.erb', <<-HTML
+  run 'rm -f app/views/layouts/application.html.erb'
+  file 'app/views/layouts/application.html.erb', <<-S
 <!doctype html>
 <html lang="en">
   <head>
@@ -813,7 +760,8 @@ file 'app/views/layouts/application.html.erb', <<-HTML
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <meta name="description" content="<%= yield :meta_description %>" />
   <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
-  <%= javascript_include_tag '//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js', 'application', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag '//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js',
+                             'application', 'data-turbolinks-track' => true %>
   <%= csrf_meta_tags %>
   <%= link_to_all_favicons %>
   <!--[if lt IE 9]>
@@ -823,6 +771,7 @@ file 'app/views/layouts/application.html.erb', <<-HTML
   <![endif]-->
   <%= render 'layouts/google_analytics_snippet' %>
 </head>
+
 <body>
   <%= render 'layouts/google_analytics_tracker' %>
   <header>
@@ -833,26 +782,6 @@ file 'app/views/layouts/application.html.erb', <<-HTML
     <div class="page-header">
       <h1><%= yield :heading %></h1>
     </div>
-    <h4>Using disqus</h4>
-    <p>Disqus related html and javascript will only be loaded when the short name is not empty.</p>
-    <ul>
-      <li>Set the <code>DISQUS_SHORT_NAME</code> env variable in <code>.env</code> and restart the server</li>
-      <li>
-        To output the main comments (place this where you want it):
-        <ul><li>&lt;%= render 'layouts/disqus_comments_snippet' %&gt;</li></ul>
-      </li>
-      <li>
-        <strong>(optional)</strong> The count snippet is already right before &lt;/body&gt;
-        <ul>
-          <li>
-            <strong>(optional)</strong> Append #disqus_thread to the href attribute in your links.<br />
-            This will tell Disqus which links to look up and return the comment count.<br />
-            For example: <a href="http://foo.com/bar.html#disqus_thread">Link</a>.
-          </li>
-        </ul>
-      </li>
-    </ul>
-
     <%= render 'layouts/flash' %>
     <%= yield %>
   </main>
@@ -867,12 +796,14 @@ file 'app/views/layouts/application.html.erb', <<-HTML
   <%= render 'layouts/disqus_count_snippet' %>
 </body>
 </html>
-HTML
+  S
+  git_commit 'Add layout'
+end
 
-git add:    '-A'
-git commit: "-m 'Add new layout view'"
+def add_layout_partials
+  log_task __method__
 
-file 'app/views/layouts/_flash.html.erb', <<-'HTML'
+  file 'app/views/layouts/_flash.html.erb', <<-'S'
 <% flash.each do |key, msg| %>
   <% unless key == :timedout %>
     <%= content_tag :div, class: "alert alert-dismissable alert-#{key}" do -%>
@@ -883,12 +814,9 @@ file 'app/views/layouts/_flash.html.erb', <<-'HTML'
     <% end %>
   <% end %>
 <% end %>
-HTML
-
-git add:    '-A'
-git commit: "-m 'Add flash message partial'"
+  S
 
-file 'app/views/layouts/_navigation.html.erb', <<-HTML
+  file 'app/views/layouts/_navigation.html.erb', <<-S
 <nav class="navbar navbar-default">
   <div class="container">
     <div class="navbar-header">
@@ -898,7 +826,7 @@ file 'app/views/layouts/_navigation.html.erb', <<-HTML
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
       </button>
-      <%= link_to '#{app_name}', '#root_path_would_go_here', class: 'navbar-brand' %>
+      <%= link_to '#{app_name}', root_path, class: 'navbar-brand' %>
     </div>
     <div class="collapse navbar-collapse">
       <ul class="nav navbar-nav">
@@ -907,33 +835,23 @@ file 'app/views/layouts/_navigation.html.erb', <<-HTML
     </div>
   </div>
 </nav>
-HTML
+  S
 
-git add:    '-A'
-git commit: "-m 'Add navigation partial'"
-
-file 'app/views/layouts/_navigation_links.html.erb', <<-HTML
-<li class="active">
-  <%= link_to 'Bar', '#' %>
+  file 'app/views/layouts/_navigation_links.html.erb', <<-S
+<li>
+  <%= link_to 'Sidekiq dashboard', '/sidekiq' %>
 </li>
-HTML
-
-git add:    '-A'
-git commit: "-m 'Add navigation links partial'"
+  S
 
-file 'app/views/layouts/_footer.html.erb', <<-HTML
+  file 'app/views/layouts/_footer.html.erb', <<-S
 <p class="text-muted">&copy; #{Time.now.year.to_s} #{app_name} - All rights reserved</p>
-HTML
+  S
 
-git add:    '-A'
-git commit: "-m 'Add footer partial'"
-
-file 'app/views/layouts/_google_analytics_snippet.html.erb', <<-HTML
+  file 'app/views/layouts/_google_analytics_snippet.html.erb', <<-S
 <script type="text/javascript">
   var _gaq = _gaq || [];
 <% if ENV['GOOGLE_ANALYTICS_UA'].present? %>
   _gaq.push(['_setAccount', '<%= ENV["GOOGLE_ANALYTICS_UA"] %>']);
-
   (function() {
     var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
     ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
@@ -941,41 +859,38 @@ file 'app/views/layouts/_google_analytics_snippet.html.erb', <<-HTML
   })();
 <% end %>
 </script>
-HTML
+  S
 
-file 'app/views/layouts/_google_analytics_tracker.html.erb', <<-HTML
+  file 'app/views/layouts/_google_analytics_tracker.html.erb', <<-S
 <script type="text/javascript">
   // This is added in the body to track both turbolinks and regular hits.
   _gaq.push(['_trackPageview']);
 </script>
-HTML
-
-git add:    '-A'
-git commit: "-m 'Add google analytics partials'"
+  S
 
-file 'app/views/layouts/_disqus_comments_snippet.html.erb', <<-HTML
+  file 'app/views/layouts/_disqus_comments_snippet.html.erb', <<-S
 <% if ENV['DISQUS_SHORT_NAME'].present? %>
 <div id="disqus_thread"></div>
 <script type="text/javascript">
     var disqus_shortname = '<%= ENV["DISQUS_SHORT_NAME"] %>';
-
     (function() {
         var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
         dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
         (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
     })();
 </script>
-<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+<noscript>
+  Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a>
+</noscript>
 <a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
 <% end %>
-HTML
+  S
 
-file 'app/views/layouts/_disqus_count_snippet.html.erb', <<-HTML
+  file 'app/views/layouts/_disqus_count_snippet.html.erb', <<-S
 <% if ENV['DISQUS_SHORT_NAME'].present? %>
 <div id="disqus_thread"></div>
 <script type="text/javascript">
     var disqus_shortname = '<%= ENV["DISQUS_SHORT_NAME"] %>';
-
     (function () {
         var s = document.createElement('script'); s.async = true;
         s.type = 'text/javascript';
@@ -983,22 +898,17 @@ file 'app/views/layouts/_disqus_count_snippet.html.erb', <<-HTML
         (document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
     }());
 <% end %>
-HTML
-
-git add:    '-A'
-git commit: "-m 'Add disqus partials'"
-
-# ----- Creating public files -------------------------------------------------------------------------
-
-puts
-say_status  'public', 'Creating public files...', :yellow
-puts        '-'*80, ''; sleep 0.25
+  S
+  git_commit 'Add layout partials'
+end
 
-run 'rm -f public/404.html'
-run 'rm -f public/422.html'
-run 'rm -f public/500.html'
+def add_http_error_pages
+  log_task __method__
 
-file 'public/404.html', <<-HTML
+  run 'rm -f public/404.html'
+  run 'rm -f public/422.html'
+  run 'rm -f public/500.html'
+  file 'public/404.html', <<-S
 <!DOCTYPE html>
 <html>
 <head>
@@ -1012,9 +922,9 @@ file 'public/404.html', <<-HTML
   <h1>Error 404</h1>
 </body>
 </html>
-HTML
+  S
 
-file 'public/422.html', <<-HTML
+  file 'public/422.html', <<-S
 <!DOCTYPE html>
 <html>
 <head>
@@ -1028,9 +938,9 @@ file 'public/422.html', <<-HTML
   <h1>Error 422</h1>
 </body>
 </html>
-HTML
+  S
 
-file 'public/500.html', <<-HTML
+  file 'public/500.html', <<-S
 <!DOCTYPE html>
 <html>
 <head>
@@ -1044,47 +954,34 @@ file 'public/500.html', <<-HTML
   <h1>Error 500</h1>
 </body>
 </html>
-HTML
+  S
 
-file 'public/502.html', <<-HTML
+  file 'public/502.html', <<-S
 <!DOCTYPE html>
 <html>
 <head>
+
   <title>Error 502</title>
   <meta charset="utf-8" />
   <style>
   </style>
 </head>
-
 <body>
   <h1>Error 502</h1>
 </body>
 </html>
-HTML
-
-git add:    '-A'
-git commit: "-m 'Add public 404, 422, 500 and 502 error pages'"
-
-# ----- Modifying sass files --------------------------------------------------------------------------
-
-puts
-say_status  'assets', 'Modifying sass files...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-run 'mv app/assets/stylesheets/application.css app/assets/stylesheets/application.css.scss'
-
-git add:    '-A'
-git commit: "-m 'Rename application.css to application.scss'"
-git add:    '-u'
-
-inject_into_file 'app/assets/stylesheets/application.css.scss',
-                 " *= require font-awesome\n",
-                 before: " *= require_self\n"
+  S
+  git_commit 'Add http status code pages'
+end
 
-git add:    '-A'
-git commit: "-m 'Add font-awesome to the application.scss file'"
+def update_sass
+  log_task __method__
 
-append_file 'app/assets/stylesheets/application.css.scss' do <<-SCSS
+  run 'mv app/assets/stylesheets/application.css app/assets/stylesheets/application.css.scss'
+  inject_into_file 'app/assets/stylesheets/application.css.scss',
+                   " *= require font-awesome\n",
+                   before: " *= require_self\n"
+  append_file 'app/assets/stylesheets/application.css.scss' do <<-S
 
 // Core variables and mixins
 @import "bootstrap/variables";
@@ -1146,7 +1043,6 @@ append_file 'app/assets/stylesheets/application.css.scss' do <<-SCSS
 
 img {
   @extend .img-responsive;
-  margin: 0 auto;
 }
 
 .validation-error {
@@ -1154,28 +1050,21 @@ img {
   color: $brand-danger;
   font-size: $font-size-small;
 }
-SCSS
+  S
+  end
+  git_commit 'Add font-awesome, bootstrap and a few default styles'
 end
 
-# ----- Modifying javascript and coffeescript files ------------------------------------------------------------------
-
-puts
-say_status  'assets', 'Modifying javascript and coffeescript files...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-gsub_file 'app/assets/javascripts/application.js', "//= require jquery\n", ''
+def update_coffeescript
+  log_task __method__
 
-git add:    '-A'
-git commit: "-m 'Remove jquery from the application.js file because it is loaded from a CDN'"
+  gsub_file 'app/assets/javascripts/application.js', "//= require jquery\n", ''
+  git_commit 'Remove jquery because it is loaded from a CDN'
 
-inject_into_file 'app/assets/javascripts/application.js',
-                 "//= require jquery.turbolinks\n",
-                 before: "//= require_tree .\n"
-
-git add:    '-A'
-git commit: "-m 'Add jquery-turbolinks to the application.js file'"
-
-inject_into_file 'app/assets/javascripts/application.js', before: "//= require_tree .\n" do <<-CODE
+  inject_into_file 'app/assets/javascripts/application.js',
+                   "//= require jquery.turbolinks\n",
+                   before: "//= require_tree .\n"
+  inject_into_file 'app/assets/javascripts/application.js', before: "//= require_tree .\n" do <<-S
 //= require bootstrap/affix
 //= require bootstrap/alert
 //= require bootstrap/button
@@ -1183,38 +1072,50 @@ inject_into_file 'app/assets/javascripts/application.js', before: "//= require_t
 //= require bootstrap/collapse
 //= require bootstrap/dropdown
 //= require bootstrap/modal
+//= require bootstrap/tooltip
 //= require bootstrap/popover
 //= require bootstrap/scrollspy
 //= require bootstrap/tab
-//= require bootstrap/tooltip
 //= require bootstrap/transition
-CODE
+  S
+  end
+  git_commit 'Add jquery.turbolinks and bootstrap'
 end
 
-git add:    '-A'
-git commit: "-m 'Add bootstrap to the application.js file'"
-
-# ----- Modifying gem file ----------------------------------------------------------------------------
-
-puts
-say_status  'root', 'Copying Gemfile...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-run 'rm -f Gemfile'
-from_gem 'Gemfile', 'Gemfile'
+def remove_unused_files_from_git
+  log_task __method__
 
-git add:    '-A'
-git commit: "-m 'Add basic gems to the Gemfile'"
-
-# ----- Adding default favicon-------------------------------------------------------------------------
-
-puts
-say_status  'assets', 'Copying default favicon...', :yellow
-puts        '-'*80, ''; sleep 0.25
+  git add: '-u'
+  git_commit 'Remove unused files'
+end
 
-base_path = "#{File.expand_path File.dirname(__FILE__)}/includes"
-run 'mkdir -p app/assets/favicon'
-run "cp #{base_path}/app/assets/favicon/favicon_base.png app/assets/favicon/favicon_base.png"
+# ---
 
-git add:    '-A'
-git commit: "-m 'Add default 256x256 favicon'"
+initial_git_commit
+update_gitignore
+copy_gemfile
+copy_base_favicon
+add_dotenv
+add_procfile
+update_app_secrets
+update_app_config
+update_database_config
+add_puma_config
+add_sidekiq_config
+add_sitemap_config
+add_whenever_config
+add_sidekiq_initializer
+add_mini_profiler_initializer
+add_staging_environment
+update_production_environment
+update_routes
+add_backup_lib
+add_favicon_task
+add_backup_task
+add_helpers
+add_layout
+add_layout_partials
+add_http_error_pages
+update_sass
+update_coffeescript
+remove_unused_files_from_git