orats 0.6.3 → 0.6.4

data/lib/orats/commands/common.rb

@@ -77,6 +77,45 @@ module Orats
           exit 1
         end
       end
+
+      def exit_if_path_exists
+        log_task 'Check if this path exists'
+
+        if Dir.exist?(@active_path) || File.exist?(@active_path)
+          log_error 'error', 'A file or directory already exists at this location', 'path', @active_path
+          exit 1
+        end
+      end
+
+      def exit_if_process(check_for, *processes)
+        case check_for
+          when :not_found
+            command = 'which'
+            phrase = 'on your system path'
+          when :not_running
+            command = 'ps cax | grep'
+            phrase = 'running'
+          else
+            command = ''
+            phrase = ''
+        end
+
+        processes.each do |process|
+          log_task "Check if #{process} is #{phrase}"
+
+          exit 1 if process_unusable?("#{command} #{process}", process, phrase)
+        end
+      end
+
+      def process_unusable?(command, process, phrase)
+        command_output = run(command, capture: true)
+
+        log_error 'error', "Cannot detect #{process}", 'question', "Are you sure #{process} is #{phrase}?", true do
+          log_status_bottom 'tip', "#{process} must be #{phrase} before running this orats command", :white
+        end if command_output.empty?
+
+        command_output.empty?
+      end
     end
   end
 end

data/lib/orats/commands/new/ansible.rb

@@ -10,21 +10,21 @@ module Orats
           secrets_path = "#{@target_path}/secrets"
           create_secrets secrets_path
 
-          log_thor_task 'shell', 'Modifying secrets path in group_vars/all.yml'
+          log_task 'Update secrets path in group_vars/all.yml'
           gsub_file "#{@target_path}/#{fix_path_for_user(Commands::Common::RELATIVE_PATHS[:inventory])}",
                     '~/tmp/testproj/secrets/', File.expand_path(secrets_path)
 
-          log_thor_task 'shell', 'Modifying the place holder app name in group_vars/all.yml'
+          log_task 'Update place holder app name in group_vars/all.yml'
           gsub_file "#{@target_path}/#{fix_path_for_user(Commands::Common::RELATIVE_PATHS[:inventory])}",
                     'testproj', File.basename(@target_path)
 
-          log_thor_task 'shell', 'Creating ssh keypair'
+          log_task 'Add ssh keypair'
           run "ssh-keygen -t rsa -P '' -f #{secrets_path}/id_rsa"
 
-          log_thor_task 'shell', 'Creating self signed ssl certificates'
+          log_task 'Add self signed ssl certificates'
           run create_rsa_certificate(secrets_path, 'sslkey.key', 'sslcert.crt')
 
-          log_thor_task 'shell', 'Creating monit pem file'
+          log_task 'Add monit pem file'
           run "#{create_rsa_certificate(secrets_path,
                                         'monit.pem', 'monit.pem')} && openssl gendh 512 >> #{secrets_path}/monit.pem"
 
@@ -34,7 +34,7 @@ module Orats
         private
 
         def create_inventory
-          log_thor_task 'shell', 'Creating ansible inventory'
+          log_task 'Add ansible inventory'
           run "mkdir -p #{@target_path}/inventory/group_vars"
 
           local_to_user Commands::Common::RELATIVE_PATHS[:hosts]
@@ -44,12 +44,12 @@ module Orats
         def local_to_user(file)
           fixed_file = fix_path_for_user(file)
 
-          log_thor_task 'shell', "Creating #{fixed_file}"
+          log_task "Add #{fixed_file}"
           run "cp #{base_path}/#{file} #{@target_path}/#{fixed_file}"
         end
 
         def create_secrets(secrets_path)
-          log_thor_task 'shell', 'Creating ansible secrets'
+          log_task 'Add ansible secrets'
           run "mkdir #{secrets_path}"
 
           save_secret_string "#{secrets_path}/postgres_password"
@@ -69,7 +69,7 @@ module Orats
         end
 
         def install_role_dependencies
-          log_thor_task 'shell', 'Updating ansible roles from the galaxy'
+          log_task 'Update ansible roles from the galaxy'
 
           galaxy_install =
               "ansible-galaxy install -r #{base_path}/#{Commands::Common::RELATIVE_PATHS[:galaxyfile]} --force"

data/lib/orats/commands/new/exec.rb

@@ -18,6 +18,8 @@ module Orats
         end
 
         def init
+          check_exit_conditions
+
           rails_template 'base' do
             gsub_postgres_info
             gsub_redis_info unless @options[:redis_password].empty?
@@ -28,6 +30,7 @@ module Orats
             spring_binstub
 
             create_and_migrate_database
+            generate_home_page
             run_rake 'orats:favicons'
           end
 

data/lib/orats/commands/new/rails.rb

@@ -2,10 +2,13 @@ module Orats
   module Commands
     module New
       module Rails
-        def rails_template(command, flags = '')
-          exit_if_cannot_rails
-          exit_if_exists unless flags.index(/--skip/)
+        def check_exit_conditions
+          exit_if_process :not_found, 'rails', 'git'
+          exit_if_process :not_running, 'postgres', 'redis'
+          exit_if_path_exists
+        end
 
+        def rails_template(command, flags = '')
           orats_template = "--template #{base_path}/templates/#{command}.rb"
 
           run "rails new #{@active_path} #{flags} --skip-bundle #{orats_template unless command.empty?}"
@@ -13,7 +16,7 @@ module Orats
         end
 
         def custom_rails_template
-          log_thor_task 'shell', 'Running custom rails template'
+          log_task 'Run custom rails template'
 
           @options[:template].include?('://') ? url_to_string(@options[:template])
                                                : file_to_string(@options[:template])
@@ -22,82 +25,149 @@ module Orats
         end
 
         def gsub_postgres_info
-          log_thor_task 'root', 'Changing the postgres information'
+          log_task 'Update the postgres connection details'
           gsub_file "#{@active_path}/.env", 'DATABASE_HOST: localhost', "DATABASE_HOST: #{@options[:pg_location]}"
           gsub_file "#{@active_path}/.env", ': postgres', ": #{@options[:pg_username]}"
           gsub_file "#{@active_path}/.env", ': supersecrets', ": #{@options[:pg_password]}"
 
-          git_commit 'Change the postgres information'
+          git_commit 'Update the postgres connection details'
         end
 
         def gsub_redis_info
-          log_thor_task 'root', 'Changing the redis password'
+          log_task 'Update the redis connection details'
           gsub_file "#{@active_path}/.env", 'HE_PASSWORD: ""', "HE_PASSWORD: #{@options[:redis_password]}"
           gsub_file "#{@active_path}/.env", 'CACHE_HOST: localhost', "CACHE_HOST: #{@options[:redis_location]}"
 
-          git_commit 'Add the redis password'
+          git_commit 'Update the redis connection details'
         end
 
         def gsub_project_path
-          log_thor_task 'root', 'Changing the project path'
+          log_task 'Update the project path'
           gsub_file "#{@active_path}/.env", ': /full/path/to/your/project', ": #{File.expand_path(@active_path)}"
 
-          git_commit 'Add the development project path'
+          git_commit 'Update the project path'
         end
 
         def bundle_install
-          log_thor_task 'shell', 'Running bundle install, this may take a while'
+          log_task 'Run bundle install, this may take a while'
           run_from @active_path, 'bundle install'
 
-          git_commit 'Add gem lock file'
+          git_commit 'Add Gemfile.lock'
         end
 
         def bundle_binstubs
-          log_thor_task 'shell', 'Running bundle binstubs for a few gems'
+          log_task 'Run bundle binstubs for a few gems'
           run_from @active_path, 'bundle binstubs whenever puma sidekiq backup'
 
           git_commit 'Add binstubs for the important gems'
         end
 
         def spring_binstub
-          log_thor_task 'shell', 'Running spring binstub'
+          log_task 'Run spring binstub'
           run_from @active_path, 'bundle exec spring binstub --all'
 
-          git_commit 'Springify all of the bins'
+          git_commit 'Add spring binstubs for all of the bins'
         end
 
         def run_rake(command)
-          log_thor_task 'shell', 'Running rake commands'
+          log_task 'Run rake command'
 
           run_from @active_path, "bundle exec rake #{command}"
         end
 
-        def create_and_migrate_database
-          run_rake 'db:create:all db:migrate'
-          git_commit 'Add the database schema file'
-        end
-
-        private
-
-        def exit_if_cannot_rails
-          log_thor_task 'shell', 'Checking for rails'
+        def generate_home_page
+          log_task 'Add pages controller with static page'
+          run_from @active_path, 'bundle exec rails g controller Pages home'
 
-          has_rails = run('which rails', capture: true)
-
-          log_error 'error', 'Cannot access rails', 'question', 'Are you sure you have rails setup correctly?', true do
-            log_status_bottom 'tip', 'You can install it by running `gem install rails`', :white
-          end if has_rails.empty?
-
-          exit 1 if has_rails.empty?
+          gsub_file "#{@active_path}/config/routes.rb", "  # root 'welcome#index'" do <<-S
+  root 'pages#home'
+          S
+          end
+          gsub_file "#{@active_path}/config/routes.rb", "  get 'pages/home'\n\n", ''
+
+          gsub_file "#{@active_path}/test/controllers/pages_controller_test.rb",
+                    '"should get home"', "'expect home page'"
+          gsub_file "#{@active_path}/app/views/pages/home.html.erb", /.*\n/, ''
+          append_file "#{@active_path}/app/views/pages/home.html.erb" do <<-S
+<%
+  title 'Welcome to Ruby on Rails'
+  meta_description '...'
+  heading 'Welcome to Ruby on Rails'
+%>
+
+<div class="row">
+  <div class="col-sm-9">
+    <p class="lead">
+      You have successfully generated a project with <%= link_to 'orats', 'https://github.com/nickjj/orats' %> v#{VERSION}.
+    </p>
+
+    <hr />
+
+    <p>
+      <%= image_tag 'https://badge.fury.io/rb/orats.png', alt: 'Gem badge' %> is the latest version of orats.
+    </p>
+
+    <hr />
+
+    <h3>Custom rake tasks</h3>
+    <pre>
+      <code>
+      # backup the database to S3 or any other location
+      bundle exec rake orats:backup
+
+      # generate a new set of favicons to the public directory
+      bundle exec rake orats:favicons
+      </code>
+    </pre>
+
+    <hr />
+
+    <h3>Trying to figure out what to do next?</h3>
+    <p>
+      Visit the wiki guide for <%= link_to 'what to look at after making a new project', 'https://github.com/nickjj/orats/wiki/What-to-look-at-after-making-a-new-project' %>.
+    </p>
+
+    <hr />
+
+    <h3>Looking to deploy your application?</h3>
+    <p>
+      Visit the wiki guide for <%= link_to 'get your application on a server ', 'https://github.com/nickjj/orats/wiki/Get-your-application-on-a-server' %>.
+    </p>
+
+    <hr />
+
+    <h3>Want to get rid of the pages controller?</h3>
+    <p>
+      No problem, just follow these steps:
+      <ul>
+        <li>
+          Run <code>bundle exec rails d controller Pages</code>
+        </li>
+        <li>
+          Remove the root route from <code>config/routes.rb</code>
+        </li>
+        <li>
+          Remove the link in the navigation partial at <code>app/views/layouts/_navigation_links.html.erb</code>
+        </li>
+        <li>
+          Restart the server
+        </li>
+      </ul>
+    </p>
+  </div>
+
+  <div class="col-sm-3">
+    <%= image_tag '/apple-touch-icon-228x228-precomposed.png', size: '228x228', alt: 'A ruby image I found on Google' %>
+  </div>
+</div>
+          S
+          end
+          git_commit 'Add pages controller with home page'
         end
 
-        def exit_if_exists
-          log_thor_task 'shell', 'Checking if a file or directory already exists'
-
-          if Dir.exist?(@active_path) || File.exist?(@active_path)
-            log_error 'error', 'A file or directory already exists at this location', 'path', @active_path
-            exit 1
-          end
+        def create_and_migrate_database
+          run_rake 'db:create:all db:migrate'
+          git_commit 'Add the database schema file'
         end
       end
     end

data/lib/orats/commands/nuke.rb

@@ -51,7 +51,7 @@ module Orats
 
       def nuke_data
         valid_rails_directories.each do |directory|
-          log_thor_task 'root', 'Removing postgres databases'
+          log_task 'Remove postgres databases'
           run_from directory, 'bundle exec rake db:drop:all'
 
           nuke_redis File.basename(directory)
@@ -59,7 +59,7 @@ module Orats
       end
 
       def nuke_redis(namespace)
-        log_thor_task 'root', 'Removing redis keys'
+        log_task 'Remove redis keys'
 
         while not_able_to_nuke_redis?(@options[:redis_password], namespace)
           log_status_top 'error', "The redis password you supplied was incorrect\n", :red
@@ -78,7 +78,7 @@ module Orats
       end
 
       def nuke_directory
-        log_thor_task 'root', 'Deleting directory'
+        log_task 'Delete directory'
         run "rm -rf #{@active_path}"
       end
     end

data/lib/orats/commands/outdated/compare.rb

@@ -3,7 +3,7 @@ module Orats
     module Outdated
       module Compare
         def remote_to_local_gem_versions
-          log_remote_info 'gem', 'Comparing this version of orats to the latest orats version',
+          log_remote_info 'gem', 'Compare this version of orats to the latest orats version',
                           'version', "Latest: #{@remote_gem_version}, Yours: v#{VERSION}"
         end
 
@@ -13,7 +13,7 @@ module Orats
           local_galaxyfile_roles = @local_galaxyfile.size
           roles_diff_count = galaxyfile_diff.size
 
-          log_status_top 'roles', "Comparing this version of orats' roles to the latest version:", :green
+          log_status_top 'roles', "Compare this version of orats' roles to the latest version:", :green
 
           if roles_diff_count == 0
             log_status_bottom 'message', "All #{local_galaxyfile_roles} roles are up to date", :yellow
@@ -41,7 +41,7 @@ module Orats
           item_diff = remote - local
           item_diff_count = item_diff.size
 
-          log_remote_info label, "Comparing this version of orats' #{label} to the latest version",
+          log_remote_info label, "Compare this version of orats' #{label} to the latest version",
                           'file', label == 'playbook' ? 'site.yml' : 'all.yml'
 
           item_diff.each do |line|
@@ -59,7 +59,7 @@ module Orats
         def local_to_user(label, keyword, flag_path, local)
           user = yield
 
-          log_local_info label, "Comparing this version of orats' #{label} to #{File.basename(flag_path)}",
+          log_local_info label, "Compare this version of orats' #{label} to #{File.basename(flag_path)}",
                          'path', flag_path
 
           missing_count = log_unmatched(local, user, 'missing', :red)

data/lib/orats/commands/play.rb

@@ -11,24 +11,11 @@ module Orats
       end
 
       def init
-        return unless can_play?
+        exit_if_path_exists
+
         rails_template 'play'
         custom_rails_template unless @options[:template].empty?
       end
-
-      private
-
-      def can_play?
-        log_thor_task 'shell', 'Checking for the ansible binary'
-
-        has_ansible = run('which ansible', capture: true)
-
-        log_error 'error', 'Cannot access ansible', 'question', 'Are you sure you have ansible setup correctly?', true do
-          log_status_bottom 'tip', 'http://docs.ansible.com/intro_installation.html', :white
-        end if has_ansible.empty?
-
-        !has_ansible.empty?
-      end
     end
   end
 end

data/lib/orats/commands/ui.rb

@@ -3,9 +3,9 @@ module Orats
     module UI
       include Thor::Shell
 
-      def log_thor_task(type, message)
+      def log_task(message)
         puts
-        say_status  type, "#{message}...", :yellow
+        say_status  'task', "#{message}:", :yellow
         puts        '-'*80, ''; sleep 0.25
       end
 

data/lib/orats/templates/auth.rb

@@ -1,16 +1,36 @@
-# =====================================================================================================
-# Template for generating authentication and authorization on top of the base template
-# =====================================================================================================
-
-# ----- Helper functions and variables ----------------------------------------------------------------
-
 require 'securerandom'
 
+# =============================================================================
+# template for generating an orats auth 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 create_migration(table_name, migration='')
+def method_to_sentence(method)
+  method.tr!('_', ' ')
+  method[0] = method[0].upcase
+  method
+end
+
+def log_task(message)
+  puts
+  say_status  'task', "#{method_to_sentence(message.to_s)}:", :yellow
+  puts        '-'*80, ''; sleep 0.25
+end
+
+def git_commit(message)
+  git add: '-A'
+  git commit: "-m '#{message}'"
+end
+
+def migrate(table_name, migration='')
   utc_now = Time.now.getutc.strftime("%Y%m%d%H%M%S")
   class_name = table_name.to_s.classify.pluralize
 
@@ -23,172 +43,197 @@ end
   }
 end
 
-# ----- Delete application.css ------------------------------------------------------------------------
+# ---
 
-# This gets created by rails automatically when you make a new project
-run 'rm -f app/assets/stylesheets/application.css'
-
-# ----- Modify Gemfile --------------------------------------------------------------------------------
+def delete_app_css
+  run 'rm -f app/assets/stylesheets/application.css'
+end
 
-puts
-say_status  'root', 'Modifying Gemfile..', :yellow
-puts        '-'*80, ''; sleep 0.25
+def update_gemfile
+  log_task __method__
 
-inject_into_file 'Gemfile', before: "\ngem 'kaminari'" do <<-CODE
+  inject_into_file 'Gemfile', before: "\ngem 'kaminari'" do <<-S
 
 gem 'devise', '~> 3.2.4'
 gem 'devise-async', '~> 0.9.0'
 gem 'pundit', '~> 0.2.3'
-CODE
+  S
+  end
+  git_commit 'Add authentication related gems'
 end
 
-git add: '-A'
-git commit: "-m 'Add devise, devise-async and pundit gems'"
-
-# ----- Run bundle install ----------------------------------------------------------------------------
-
-puts
-say_status  'action', 'Running bundle install, it should not take too long', :yellow
-puts        '-'*80, ''; sleep 0.25
+def update_dotenv
+  log_task __method__
 
-run 'bundle install'
+  inject_into_file '.env', before: "\nSMTP_ADDRESS" do <<-CODE
+TOKEN_DEVISE_SECRET: #{generate_token}
+TOKEN_DEVISE_PEPPER: #{generate_token}
+  CODE
+  end
 
-# ----- Modify sidekiq config -------------------------------------------------------------------------
+  inject_into_file '.env', before: "\nDATABASE_NAME" do <<-CODE
+ACTION_MAILER_DEVISE_DEFAULT_FROM: info@#{app_name}.com
+  CODE
+  end
+  git_commit 'Add devise tokens and default e-mail'
+end
 
-puts
-say_status  'config', 'Modifying the sidekiq config', :yellow
-puts        '-'*80, ''; sleep 0.25
+def run_bundle_install
+  log_task __method__
 
-append_file 'config/sidekiq.yml' do <<-FILE
-  - mailer
-FILE
+  run 'bundle install'
 end
 
-git add: '-A'
-git commit: "-m 'Add the devise mailer queue to the sidekiq config'"
+def add_pundit
+  log_task __method__
 
-# ----- Create the account fixtures -------------------------------------------------------------------
+  generate 'pundit:install'
+  inject_into_file 'app/controllers/application_controller.rb', after: "::Base\n" do <<-S
+  include Pundit
 
-puts
-say_status  'test', 'Creating the account fixtures...', :yellow
-puts        '-'*80, ''; sleep 0.25
+  S
+  end
 
-file 'test/fixtures/accounts.yml' do <<-'CODE'
-foo:
-  id: 1
-  email: foo@bar.com
-  encrypted_password: passwordisnotreallyencrypted
-  role: admin
-  created_at: 2012-01-01 01:45:17
-  current_sign_in_at: 2013-03-15 11:22:33
+  inject_into_file 'app/controllers/application_controller.rb', after: ":exception\n" do <<-S
 
-no_role:
-  id: 2
-  email: joey@almostcool.com
-  encrypted_password: hackthegibson
-  created_at: 1995-09-15 08:10:12
+  rescue_from Pundit::NotAuthorizedError, with: :account_not_authorized
+  S
+  end
 
-bad_role:
-  id: 3
-  email: hello@world.com
-  encrypted_password: reallysecure
-  role: ahhhh
-  created_at: 2011-09-20 10:10:10
+  inject_into_file 'app/controllers/application_controller.rb', after: "  #end\n" do <<-S
 
-beep:
-  id: 4
-  email: beep@beep.com
-  encrypted_password: beepbeepbeep
-  created_at: 2010-03-6 05:15:45
-CODE
+    def account_not_authorized
+      redirect_to request.headers['Referer'] || root_path, flash: { error: I18n.t('authorization.error') }
+    end
+  S
+  end
+  git_commit 'Add pundit policy and controller logic'
 end
 
-git add: '-A'
-git commit: "-m 'Add the account model'"
+def add_devise_initializers
+  log_task __method__
 
-# ----- Modify the test helper ------------------------------------------------------------------------
+  file 'config/initializers/devise_async.rb', 'Devise::Async.backend = :sidekiq'
+  generate 'devise:install'
+  git_commit 'Add the devise and devise async initializers'
+end
 
-puts
-say_status  'test', 'Modifying the test helper...', :yellow
-puts        '-'*80, ''; sleep 0.25
+def update_devise_initializer
+  log_task 'Update the devise initializer'
 
-inject_into_file 'test/test_helper.rb', after: "end\n" do <<-CODE
+  gsub_file 'config/initializers/devise.rb',
+            "'please-change-me-at-config-initializers-devise@example.com'", "ENV['ACTION_MAILER_DEVISE_DEFAULT_EMAIL']"
+  gsub_file 'config/initializers/devise.rb', /(?<=key = )'\w{128}'/, "ENV['TOKEN_DEVISE_SECRET']"
+  gsub_file 'config/initializers/devise.rb', /(?<=pepper = )'\w{128}'/, "ENV['TOKEN_DEVISE_PEPPER']"
+  gsub_file 'config/initializers/devise.rb', '# config.timeout_in = 30.minutes',
+            'config.timeout_in = 2.hours'
 
-class ActionController::TestCase
-  include Devise::TestHelpers
+  gsub_file 'config/initializers/devise.rb', '# config.expire_auth_token_on_timeout = false',
+            'config.expire_auth_token_on_timeout = true'
+  gsub_file 'config/initializers/devise.rb', '# config.lock_strategy = :failed_attempts',
+            'config.lock_strategy = :failed_attempts'
+  gsub_file 'config/initializers/devise.rb', '# config.unlock_strategy = :both',
+            'config.unlock_strategy = :both'
+  gsub_file 'config/initializers/devise.rb', '# config.maximum_attempts = 20',
+            'config.maximum_attempts = 7'
+  gsub_file 'config/initializers/devise.rb', '# config.unlock_in = 1.hour',
+            'config.unlock_in = 2.hours'
+  gsub_file 'config/initializers/devise.rb', '# config.last_attempt_warning = false',
+            'config.last_attempt_warning = true'
+  git_commit 'Update the devise defaults'
 end
-CODE
+
+def update_sidekiq_config
+  log_task __method__
+
+  append_file 'config/sidekiq.yml' do <<-S
+  - mailer
+  S
+  end
+  git_commit 'Add the devise mailer queue to sidekiq'
 end
 
-git add: '-A'
-git commit: "-m 'Add the devise helpers to test helper'"
+def update_routes
+  log_task __method__
 
-# ----- Create the account unit tests -----------------------------------------------------------------
+  gsub_file 'config/routes.rb', "mount Sidekiq::Web => '/sidekiq'\n", ''
+  inject_into_file 'config/routes.rb', after: "collection\n  end\n" do <<-S
 
-puts
-say_status  'test', 'Creating the account unit tests...', :yellow
-puts        '-'*80, ''; sleep 0.25
+  # disable users from being able to register by uncommenting the lines below
+  # get 'accounts/sign_up(.:format)', to: redirect('/')
+  # post 'accounts(.:format)', to: redirect('/')
 
-file 'test/models/account_test.rb' do <<-'CODE'
-require 'test_helper'
+  # disable users from deleting their own account by uncommenting the line below
+  # delete 'accounts(.:format)', to: redirect('/')
 
-class AccountTest < ActiveSupport::TestCase
-  def setup
-    @account = accounts(:foo)
-  end
+  devise_for :accounts
 
-  def teardown
-    @account = nil
+  authenticate :account, lambda { |account| account.is?(:admin) } do
+    mount Sidekiq::Web => '/sidekiq'
   end
 
-  test 'expect new account' do
-    assert @account.valid?
-    assert_not_nil @account.email
-    assert_not_nil @account.encrypted_password
+  S
   end
+  git_commit 'Add the devise route and protect sidekiq with authentication'
+end
 
-  test 'expect guest to be default role' do
-    no_role = accounts(:no_role)
-    assert_equal 'guest', no_role.role
-  end
+def add_en_locale_for_authorization
+  log_task __method__
 
-  test 'expect invalid role to not save' do
-    bad_role = accounts(:bad_role)
-    assert_not bad_role.valid?
+  gsub_file 'config/locales/en.yml', "hello: \"Hello world\"\n", ''
+  append_file 'config/locales/en.yml' do <<-S
+authorization:
+    error: 'You are not authorized to perform this action.'
+  S
   end
+  git_commit 'Add en locale entry for authorization errors'
+end
 
-  test 'expect e-mail to be unique' do
-    duplicate = Account.create(email: 'foo@bar.com')
+def add_devise_migration
+  log_task __method__
 
-    assert_not duplicate.valid?
-  end
+  migrate :accounts, %{
+    create_table(:accounts) do |t|
+      ## Database authenticatable
+      t.string :email,              :null => false, :default => ''
+      t.string :encrypted_password, :null => false, :default => ''
 
-  test 'expect random password if password is empty' do
-    @account.password = ''
-    @account.encrypted_password = ''
-    @account.save
+      ## Recoverable
+      t.string   :reset_password_token
+      t.datetime :reset_password_sent_at
 
-    random_password = Account.generate_password
-    assert_equal 10, random_password.length
-  end
+      ## Rememberable
+      t.datetime :remember_created_at
 
-  test 'expect random password of 20 characters' do
-    assert_equal 20, Account.generate_password(20).length
-  end
-end
-CODE
-end
+      ## Trackable
+      t.integer  :sign_in_count, :default => 0, :null => false
+      t.datetime :current_sign_in_at
+      t.datetime :last_sign_in_at
+      t.string   :current_sign_in_ip
+      t.string   :last_sign_in_ip
+
+      ## Lockable
+      t.integer  :failed_attempts, :default => 0, :null => false # Only if lock strategy is :failed_attempts
+      t.string   :unlock_token # Only if unlock strategy is :email or :both
+      t.datetime :locked_at
+
+      ## Role
+      t.string :role, default: 'guest'
 
-git add: '-A'
-git commit: "-m 'Add the account unit tests'"
+      t.timestamps
+    end
 
-# ----- Create the account model ----------------------------------------------------------------------
+    add_index :accounts, :email,                :unique => true
+    add_index :accounts, :reset_password_token, :unique => true
+    add_index :accounts, :unlock_token,         :unique => true
+  }
+  git_commit 'Add devise model migration'
+end
 
-puts
-say_status  'models', 'Creating the account model...', :yellow
-puts        '-'*80, ''; sleep 0.25
+def add_account_model
+  log_task __method__
 
-file 'app/models/account.rb' do <<-'CODE'
+  file 'app/models/account.rb' do <<-'S'
 class Account < ActiveRecord::Base
   ROLES = %w[admin guest]
 
@@ -229,105 +274,138 @@ class Account < ActiveRecord::Base
       Rails.cache.delete("account:#{id}")
     end
 end
-CODE
+  S
+  end
+  git_commit 'Add account model'
 end
 
-git add: '-A'
-git commit: "-m 'Add the account model'"
+def add_seed_user
+  log_task __method__
 
-# ----- Create devise migration -----------------------------------------------------------------------
+  append_file 'db/seeds.rb', "\nAccount.create({ email: \"admin@#{app_name}.com\", password: \"password\",
+                                                                                 role: \"admin\" })"
+  git_commit 'Add seed user'
+end
 
-puts
-say_status  'db', 'Creating devise model migration...', :yellow
-puts        '-'*80, ''; sleep 0.25
+def update_test_helper
+  log_task __method__
+  inject_into_file 'test/test_helper.rb', after: "end\n" do <<-S
 
-create_migration :accounts, %{
-    create_table(:accounts) do |t|
-      ## Database authenticatable
-      t.string :email,              :null => false, :default => ''
-      t.string :encrypted_password, :null => false, :default => ''
+class ActionController::TestCase
+  include Devise::TestHelpers
+end
+  S
+  end
+  git_commit 'Add devise test helper'
+end
 
-      ## Recoverable
-      t.string   :reset_password_token
-      t.datetime :reset_password_sent_at
+def add_account_fixtures
+  log_task __method__
+  file 'test/fixtures/accounts.yml' do <<-S
+foo:
+  id: 1
+  email: foo@bar.com
+  encrypted_password: passwordisnotreallyencrypted
+  role: admin
+  created_at: 2012-01-01 01:45:17
+  current_sign_in_at: 2013-03-15 11:22:33
 
-      ## Rememberable
-      t.datetime :remember_created_at
+no_role:
+  id: 2
+  email: joey@almostcool.com
+  encrypted_password: hackthegibson
+  created_at: 1995-09-15 08:10:12
 
-      ## Trackable
-      t.integer  :sign_in_count, :default => 0, :null => false
-      t.datetime :current_sign_in_at
-      t.datetime :last_sign_in_at
-      t.string   :current_sign_in_ip
-      t.string   :last_sign_in_ip
+bad_role:
+  id: 3
+  email: hello@world.com
+  encrypted_password: reallysecure
+  role: ahhhh
+  created_at: 2011-09-20 10:10:10
 
-      ## Lockable
-      t.integer  :failed_attempts, :default => 0, :null => false # Only if lock strategy is :failed_attempts
-      t.string   :unlock_token # Only if unlock strategy is :email or :both
-      t.datetime :locked_at
+beep:
+  id: 4
+  email: beep@beep.com
+  encrypted_password: beepbeepbeep
+  created_at: 2010-03-6 05:15:45
+  S
+  end
+  git_commit 'Add account fixtures'
+end
 
-      ## Role
-      t.string :role, default: 'guest'
+def add_account_unit_tests
+  log_task __method__
 
-      t.timestamps
-    end
+  file 'test/models/account_test.rb' do <<-S
+require 'test_helper'
 
-    add_index :accounts, :email,                :unique => true
-    add_index :accounts, :reset_password_token, :unique => true
-    add_index :accounts, :unlock_token,         :unique => true
-  }
+class AccountTest < ActiveSupport::TestCase
+  def setup
+    @account = accounts(:foo)
+  end
 
-git add: '-A'
-git commit: "-m 'Add devise model migration'"
+  def teardown
+    @account = nil
+  end
 
-# ----- Create a seed user ----------------------------------------------------------------------------
+  test 'expect new account' do
+    assert @account.valid?
+    assert_not_nil @account.email
+    assert_not_nil @account.encrypted_password
+  end
 
-puts
-say_status  'db', 'Creating a seed user...', :yellow
-puts        '-'*80, ''; sleep 0.25
+  test 'expect guest to be default role' do
+    no_role = accounts(:no_role)
+    assert_equal 'guest', no_role.role
+  end
 
-append_file 'db/seeds.rb', "\nAccount.create({ email: \"admin@#{app_name}.com\", password: \"password\", role: \"admin\" })"
+  test 'expect invalid role to not save' do
+    bad_role = accounts(:bad_role)
+    assert_not bad_role.valid?
+  end
 
-git add: '-A'
-git commit: "-m 'Add a seed user'"
+  test 'expect e-mail to be unique' do
+    duplicate = Account.create(email: 'foo@bar.com')
 
-# ----- Create en i18n entries ------------------------------------------------------------------------
+    assert_not duplicate.valid?
+  end
 
-puts
-say_status  'db', 'Creating en i18n entries...', :yellow
-puts        '-'*80, ''; sleep 0.25
+  test 'expect random password if password is empty' do
+    @account.password = ''
+    @account.encrypted_password = ''
+    @account.save
 
-gsub_file 'config/locales/en.yml', "hello: \"Hello world\"\n", ''
+    random_password = Account.generate_password
+    assert_equal 10, random_password.length
+  end
 
-append_file 'config/locales/en.yml' do <<-CODE
-authorization:
-    error: 'You are not authorized to perform this action.'
-CODE
+  test 'expect random password of 20 characters' do
+    assert_equal 20, Account.generate_password(20).length
+  end
+end
+  S
+  end
+  git_commit 'Add account unit tests'
 end
 
-git add: '-A'
-git commit: "-m 'Add en i18n entries'"
-
-# ----- Modify the application controller -------------------------------------------------------------
-
-puts
-say_status  'db', 'Modifying the application controller...', :yellow
-puts        '-'*80, ''; sleep 0.25
+def add_current_user_alias
+  log_task __method__
 
-inject_into_file 'app/controllers/application_controller.rb', after: "::Base\n" do <<-'CODE'
+  inject_into_file 'app/controllers/application_controller.rb', after: "::Base\n" do <<-S
   alias_method :current_user, :current_account
 
-CODE
+  S
+  end
+  git_commit 'Add current_user alias'
 end
 
-git add: '-A'
-git commit: "-m 'Alias current_user to current_account to play nice with other gems'"
-
-inject_into_file 'app/controllers/application_controller.rb', before: "end\n" do <<-'CODE'
+def add_devise_controller_override
+  log_task __method__
+  inject_into_file 'app/controllers/application_controller.rb', before: "end\n" do <<-S
 
   private
 
-    # Override devise to customize the after sign in path.
+    # override devise to customize the after sign in path
     #def after_sign_in_path_for(resource)
     #  if resource.is? :admin
     #    admin_path
@@ -335,19 +413,15 @@ inject_into_file 'app/controllers/application_controller.rb', before: "end\n" do
     #    somewhere_path
     #  end
     #end
-CODE
+  S
+  end
+  git_commit 'Add devise after_sign_in_path_for override'
 end
 
-git add: '-A'
-git commit: "-m 'Change the application controller to allow overriding the devise sign in path'"
-
-# ----- Create the devise views -----------------------------------------------------------------------
-
-puts
-say_status  'views', 'Creating the devise views...', :yellow
-puts        '-'*80, ''; sleep 0.25
+def add_devise_views
+  log_task __method__
 
-file 'app/views/devise/confirmations/new.html.erb' do <<-HTML
+  file 'app/views/devise/confirmations/new.html.erb' do <<-S
 <%
   title 'Confirm'
   meta_description '...'
@@ -374,19 +448,19 @@ file 'app/views/devise/confirmations/new.html.erb' do <<-HTML
     <%= render 'devise/shared/links' %>
   </div>
 </div>
-HTML
-end
+  S
+  end
 
-file 'app/views/devise/mailer/confirmation_instructions.html.erb' do <<-HTML
+  file 'app/views/devise/mailer/confirmation_instructions.html.erb' do <<-S
 <p>Welcome <%= @email %>!</p>
 
 <p>You can confirm your account email through the link below:</p>
 
 <p><%= link_to 'Confirm my account', confirmation_url(@resource, confirmation_token: @token) %></p>
-HTML
-end
+  S
+  end
 
-file 'app/views/devise/mailer/reset_password_instructions.html.erb' do <<-HTML
+  file 'app/views/devise/mailer/reset_password_instructions.html.erb' do <<-S
 <p>Hello <%= @resource.email %>!</p>
 
 <p>Someone has requested a link to change your password. You can do this through the link below.</p>
@@ -395,10 +469,10 @@ file 'app/views/devise/mailer/reset_password_instructions.html.erb' do <<-HTML
 
 <p>If you didn't request this, please ignore this email.</p>
 <p>Your password won't change until you access the link above and create a new one.</p>
-HTML
-end
+  S
+  end
 
-file 'app/views/devise/mailer/unlock_instructions.html.erb' do <<-HTML
+  file 'app/views/devise/mailer/unlock_instructions.html.erb' do <<-S
 <p>Hello <%= @resource.email %>!</p>
 
 <p>Your account has been locked due to an excessive number of unsuccessful sign in attempts.</p>
@@ -406,10 +480,10 @@ file 'app/views/devise/mailer/unlock_instructions.html.erb' do <<-HTML
 <p>Click the link below to unlock your account:</p>
 
 <p><%= link_to 'Unlock my account', unlock_url(@resource, unlock_token: @token) %></p>
-HTML
-end
+  S
+  end
 
-file 'app/views/devise/passwords/edit.html.erb' do <<-HTML
+  file 'app/views/devise/passwords/edit.html.erb' do <<-S
 <%
   title 'Change your password'
   meta_description '...'
@@ -438,10 +512,10 @@ file 'app/views/devise/passwords/edit.html.erb' do <<-HTML
     <%= render 'devise/shared/links' %>
   </div>
 </div>
-HTML
-end
+  S
+  end
 
-file 'app/views/devise/passwords/new.html.erb' do <<-HTML
+  file 'app/views/devise/passwords/new.html.erb' do <<-S
 <%
   title 'Forgot your password?'
   meta_description '...'
@@ -468,10 +542,10 @@ file 'app/views/devise/passwords/new.html.erb' do <<-HTML
     <%= render 'devise/shared/links' %>
   </div>
 </div>
-HTML
-end
+  S
+  end
 
-file 'app/views/devise/registrations/edit.html.erb' do <<-HTML
+  file 'app/views/devise/registrations/edit.html.erb' do <<-S
 <%
   title 'Edit your account'
   meta_description '...'
@@ -522,10 +596,10 @@ file 'app/views/devise/registrations/edit.html.erb' do <<-HTML
     </p>
   </div>
 </div>
-HTML
-end
+  S
+  end
 
-file 'app/views/devise/registrations/new.html.erb' do <<-HTML
+  file 'app/views/devise/registrations/new.html.erb' do <<-S
 <%
   title 'Register a new account'
   meta_description '...'
@@ -557,10 +631,10 @@ file 'app/views/devise/registrations/new.html.erb' do <<-HTML
     <%= render 'devise/shared/links' %>
   </div>
 </div>
-HTML
-end
+  S
+  end
 
-file 'app/views/devise/sessions/new.html.erb' do <<-HTML
+  file 'app/views/devise/sessions/new.html.erb' do <<-S
 <%
   title 'Sign in'
   meta_description '...'
@@ -600,10 +674,10 @@ file 'app/views/devise/sessions/new.html.erb' do <<-HTML
     <%= render 'devise/shared/links' %>
   </div>
 </div>
-HTML
-end
+  S
+  end
 
-file 'app/views/devise/unlocks/new.html.erb' do <<-HTML
+  file 'app/views/devise/unlocks/new.html.erb' do <<-S
 <%
   title 'Re-send unlock instructions'
   meta_description '...'
@@ -630,10 +704,10 @@ file 'app/views/devise/unlocks/new.html.erb' do <<-HTML
     <%= render 'devise/shared/links' %>
   </div>
 </div>
-HTML
-end
+  S
+  end
 
-file 'app/views/devise/shared/_links.html.erb' do <<-'HTML'
+  file 'app/views/devise/shared/_links.html.erb' do <<-'S'
 <%= content_tag(:h4, 'Or do something else') if controller_name != 'sessions' %>
 <ul>
   <%- if controller_name != 'sessions' %>
@@ -672,19 +746,15 @@ file 'app/views/devise/shared/_links.html.erb' do <<-'HTML'
     <% end -%>
   <% end -%>
 </ul>
-HTML
+  S
+  end
+  git_commit 'Add devise views'
 end
 
-git add: '-A'
-git commit: "-m 'Add the devise views'"
-
-# ----- Modify the layout files ------------------------------------------------------------------------
-
-puts
-say_status  'views', 'Modifying the layout files...', :yellow
-puts        '-'*80, ''; sleep 0.25
+def add_auth_links_to_the_navbar
+  log_task __method__
 
-file 'app/views/layouts/_navigation_auth.html.erb', <<-HTML
+  file 'app/views/layouts/_navigation_auth.html.erb', <<-S
 <% if current_account %>
   <li>
     <%= link_to 'Settings', edit_account_registration_path %>
@@ -700,152 +770,54 @@ file 'app/views/layouts/_navigation_auth.html.erb', <<-HTML
     <%= link_to 'Register', new_account_registration_path %>
   </li>
 <% end %>
-HTML
+  S
 
-inject_into_file 'app/views/layouts/_navigation.html.erb', after: "</ul>\n" do <<-CODE
+  inject_into_file 'app/views/layouts/_navigation.html.erb', after: "</ul>\n" do <<-S
       <ul class="nav navbar-nav nav-auth">
         <%= render 'layouts/navigation_auth' %>
       </ul>
-CODE
-end
+  S
+  end
 
-append_file 'app/assets/stylesheets/application.css.scss' do <<-CODE
+  append_file 'app/assets/stylesheets/application.css.scss' do <<-S
 
 @media (min-width: $screen-sm) {
   .nav-auth {
     float: right;
   }
 }
-CODE
-end
-
-git add: '-A'
-git commit: "-m 'Add account management links to the layout and add the necessary css selectors'"
-
-# ----- Modify the .env file --------------------------------------------------------------------------
-
-puts
-say_status  'root', 'Modifying the .env file...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-inject_into_file '.env', before: "\nSMTP_ADDRESS" do <<-CODE
-TOKEN_DEVISE_SECRET: #{generate_token}
-TOKEN_DEVISE_PEPPER: #{generate_token}
-CODE
-end
-
-inject_into_file '.env', before: "\nDATABASE_NAME" do <<-CODE
-ACTION_MAILER_DEVISE_DEFAULT_FROM: info@#{app_name}.com
-CODE
-end
-
-git add: '-A'
-git commit: "-m 'Add the devise tokens and default email to the .env file'"
-
-# ----- Create the config files -----------------------------------------------------------------------
-
-puts
-say_status  'config', 'Creating the devise async initializer...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-file 'config/initializers/devise_async.rb', 'Devise::Async.backend = :sidekiq'
-generate 'devise:install'
-
-git add: '-A'
-git commit: "-m 'Add the devise and devise async initializers'"
-
-# ----- Modify the config files -----------------------------------------------------------------------
-
-puts
-say_status  'config', 'Modifying the devise initializer...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-gsub_file 'config/initializers/devise.rb',
-          "'please-change-me-at-config-initializers-devise@example.com'", "ENV['ACTION_MAILER_DEVISE_DEFAULT_EMAIL']"
-gsub_file 'config/initializers/devise.rb', /(?<=key = )'\w{128}'/, "ENV['TOKEN_DEVISE_SECRET']"
-gsub_file 'config/initializers/devise.rb', /(?<=pepper = )'\w{128}'/, "ENV['TOKEN_DEVISE_PEPPER']"
-
-gsub_file 'config/initializers/devise.rb', '# config.timeout_in = 30.minutes',
-          'config.timeout_in = 2.hours'
-
-gsub_file 'config/initializers/devise.rb', '# config.expire_auth_token_on_timeout = false',
-          'config.expire_auth_token_on_timeout = true'
-
-gsub_file 'config/initializers/devise.rb', '# config.lock_strategy = :failed_attempts',
-          'config.lock_strategy = :failed_attempts'
-
-gsub_file 'config/initializers/devise.rb', '# config.unlock_strategy = :both',
-          'config.unlock_strategy = :both'
-
-gsub_file 'config/initializers/devise.rb', '# config.maximum_attempts = 20',
-          'config.maximum_attempts = 7'
-
-gsub_file 'config/initializers/devise.rb', '# config.unlock_in = 1.hour',
-          'config.unlock_in = 2.hours'
-
-gsub_file 'config/initializers/devise.rb', '# config.last_attempt_warning = false',
-          'config.last_attempt_warning = true'
-
-git add: '-A'
-git commit: "-m 'Change the devise initializer default values'"
-
-# ----- Modify the routes file ------------------------------------------------------------------------
-
-puts
-say_status  'config', 'Modifying the routes file...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-inject_into_file 'config/routes.rb', after: "collection\n  end\n" do <<-CODE
-
-  # disable users from being able to register by uncommenting the lines below
-  # get 'accounts/sign_up(.:format)', to: redirect('/')
-  # post 'accounts(.:format)', to: redirect('/')
-
-  # disable users from deleting their own account by uncommenting the line below
-  # delete 'accounts(.:format)', to: redirect('/')
-
-  devise_for :accounts
-
-  authenticate :account, lambda { |account| account.is?(:admin) } do
-    mount Sidekiq::Web => '/sidekiq'
+  S
   end
-
-CODE
-end
-
-git add: '-A'
-git commit: "-m 'Add devise to the routes file'"
-
-# ----- Add pundit support ----------------------------------------------------------------------------
-
-puts
-say_status  'root', 'Adding pundit support...', :yellow
-puts        '-'*80, ''; sleep 0.25
-
-generate 'pundit:install'
-
-git add: '-A'
-git commit: "-m 'Add pundit application policy'"
-
-inject_into_file 'app/controllers/application_controller.rb', after: "::Base\n" do <<-'CODE'
-  include Pundit
-
-CODE
-end
-
-inject_into_file 'app/controllers/application_controller.rb', after: ":exception\n" do <<-'CODE'
-
-  rescue_from Pundit::NotAuthorizedError, with: :account_not_authorized
-CODE
-end
-
-inject_into_file 'app/controllers/application_controller.rb', after: "  #end\n" do <<-'CODE'
-
-    def account_not_authorized
-      redirect_to request.headers['Referer'] || root_path, flash: { error: I18n.t('authorization.error') }
-    end
-CODE
-end
-
-git add: '-A'
-git commit: "-m 'Add pundit logic to the application controller'"
+  git_commit 'Add authentication links to the layout'
+end
+
+def remove_unused_files_from_git
+  log_task __method__
+
+  git add: '-u'
+  git_commit 'Remove unused files'
+end
+
+# ---
+
+delete_app_css
+update_gemfile
+update_dotenv
+run_bundle_install
+add_pundit
+add_devise_initializers
+update_devise_initializer
+update_sidekiq_config
+update_routes
+add_en_locale_for_authorization
+add_devise_migration
+add_account_model
+add_seed_user
+update_test_helper
+add_account_fixtures
+add_account_unit_tests
+add_current_user_alias
+add_devise_controller_override
+add_devise_views
+add_auth_links_to_the_navbar
+remove_unused_files_from_git