template.rb

require "fileutils"
require "shellwords"
require 'open-uri'

RAILS_REQUIREMENT = ">= 6.0.0".freeze

def add_template_repository_to_source_path
  # Copied from: https://github.com/mattbrictson/rails-template
  # Add this template directory to source_paths so that Thor actions like
  # copy_file and template resolve against our source files. If this file was
  # invoked remotely via HTTP, that means the files are not present locally.
  # In that case, use `git clone` to download them to a local temporary dir.
  if __FILE__ =~ %r{\Ahttps?://}
    require "tmpdir"
    source_paths.unshift(tempdir = Dir.mktmpdir("rails-jumpstart-"))
    puts "source_paths = #{source_paths.inspect}"
    # at_exit { FileUtils.remove_entry(tempdir) }
    git clone: [
      "--quiet",
      "https://github.com/web-ascender/rails-jumpstart.git",
      tempdir
    ].map(&:shellescape).join(" ")

    if (branch = __FILE__[%r{rails-jumpstart/(.+)/template.rb}, 1])
      Dir.chdir(tempdir) { git checkout: branch }
    end
  else
    source_paths.unshift(File.dirname(__FILE__))
  end
end

def default_gemfile_gem_version(name)
  @original_gemfile ||= IO.read("Gemfile")
  req = @original_gemfile[/gem\s+['"]#{name}['"]\s*(,.+).*$/, 1]
  req && req.gsub('"', "'").strip.gsub(/^,\s*'/, ", '")
end

def assert_minimum_rails_version
  puts "\n**** JUMPSTART -> #{__method__}\n"
  requirement = Gem::Requirement.new(RAILS_REQUIREMENT)
  rails_version = Gem::Version.new(Rails::VERSION::STRING)
  return if requirement.satisfied_by?(rails_version)

  prompt = "This template requires Rails #{RAILS_REQUIREMENT}. "\
           "You are using #{rails_version}. Continue anyway?"
  exit 1 if no?(prompt)
end

def assert_postgresql
  puts "\n**** JUMPSTART -> #{__method__}\n"
  return if IO.read("Gemfile") =~ /^\s*gem ['"]pg['"]/
  fail Rails::Generators::Error,
       "This template requires PostgreSQL, "\
       "but the pg gem isn’t present in your Gemfile."
end

def set_application_name
  puts "\n**** JUMPSTART -> #{__method__}\n"
  # Add Application Name to Config
  environment "config.application_name = Rails.application.class.module_parent_name"

  # Announce where to change the application name in the future.
  puts "You can change application name inside: ./config/application.rb"
end

def setup_webpack
  puts "\n**** JUMPSTART -> #{__method__}\n"
  # rename app/javascript to app/webpacker
  inside "app" do
    run 'mv javascript webpacker'
  end
  directory "app/webpacker", force: true
  # change webpacker source path
  gsub_file 'config/webpacker.yml', /source_path: app\/javascript/, 'source_path: app/webpacker'
  # copy_file 'app/assets/javascripts/cable.js', 'app/webpacker/cable.js'
  remove_dir 'app/assets/javascripts'
  remove_dir 'app/assets/stylesheets'
end

def copy_app_templates
  puts "\n**** JUMPSTART -> #{__method__}\n"
  # https://github.com/excid3/jumpstart/blob/master/template.rb
  directory "app/views", force: true
  remove_file "app/views/layouts/application.html.erb"
  directory "app/controllers", force: true
  template "credentials.yml.example.tt", "config/credentials.yml.example"
end

def copy_devise_templates
  puts "\n**** JUMPSTART -> #{__method__}\n"
  directory "app/views/devise", force: true
end

def setup_bootstrap
  puts "\n**** JUMPSTART -> #{__method__}\n"
  # Bootstrap v4 requires jQuery and the Popper.js lib
  # jquery-ujs   Rails jQuery helpers
  # jquery-ui    Useful for date pickers
  run 'yarn add bootstrap jquery popper.js jquery-ujs jquery-ui'

  insert_into_file 'config/webpack/environment.js', "const webpack = require('webpack')\n", after: "const { environment } = require('@rails/webpacker')\n"

  # Provide plugin auto-imports libraries
  insert_into_file 'config/webpack/environment.js', before: "module.exports = environment" do
    <<-JS
environment.plugins.append(
  "Provide",
  new webpack.ProvidePlugin({
    $: "jquery",
    jQuery: "jquery",
    jquery: "jquery",
    Popper: ["popper.js", "default"]
  })
)

    JS
  end

  # add jQuery package path to webpacker resolved_paths config
  gsub_file 'config/webpacker.yml', /resolved_paths: \[\]/, "resolved_paths: ['node_modules/jquery/dist']"

  setup_expose_loader

  # Bootstrap Email
  append_to_file 'config/initializers/assets.rb' do
    <<-RUBY
    Rails.application.config.assets.precompile += %w[ application-mailer.scss ]
    RUBY
  end
end

def setup_expose_loader
  puts "\n**** JUMPSTART -> #{__method__}\n"
  run 'yarn add expose-loader'
  # expose-loader adds libraries to the window object (global scope)
  # this is useful for things like jQuery because many 3rd-party libs expect it as a global
  insert_into_file 'config/webpack/environment.js', before: "module.exports = environment" do
    <<-JS
environment.loaders.append("expose", {
  test: require.resolve('jquery'),
  use: [{
    loader: 'expose-loader',
    options: 'jQuery'
  }, {
    loader: 'expose-loader',
    options: '$'
  }]
})

    JS
  end
end

def setup_devise_with_user_models
  puts "\n**** JUMPSTART -> #{__method__}\n"
  # Install Devise
  generate "devise:install"

  # ActionMailer config for development environment
  insert_into_file 'config/environments/development.rb', before: /^end/ do
    <<-RUBY

  # ActionMailer config
  config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
  config.action_mailer.default_options = { from: 'no-reply@localhost.dev' }
    RUBY
  end

 # Create Devise User Model
  generate :devise, "User",
           "first_name",
           "last_name",
           "time_zone",
           "phone",
           "superuser:boolean"

  # Change some column defaults in the devise/user migration
  in_root do
    migration = Dir.glob("db/migrate/*").max_by{ |f| File.mtime(f) }
    gsub_file migration, /:superuser/, ":superuser, default: false"
    gsub_file migration, /:time_zone/, ":time_zone, default: 'UTC', null: false"
  end

  # Generate Devise Bootstrap Views
  # https://github.com/hisea/devise-bootstrap-views
  generate "devise:views:bootstrap_templates"

  # Point devise from: address at action_mailer config
  gsub_file 'config/initializers/devise.rb', "config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'", "config.mailer_sender = Rails.configuration.action_mailer&.default_options.dig(:from) || 'please-change-me-at-config-initializers-devise@example.com'"

  # Use special view layouts for devise controllers
  append_to_file 'config/initializers/devise.rb' do
    <<-RUBY
Rails.application.config.to_prepare do
  Devise::RegistrationsController.layout proc { |controller| user_signed_in? ? 'application' : 'devise_anonymous' }
  Devise::SessionsController.layout 'devise_anonymous'
  Devise::ConfirmationsController.layout 'devise_anonymous'
  Devise::UnlocksController.layout 'devise_anonymous'
  Devise::PasswordsController.layout 'devise_anonymous'
end
      RUBY
    end
end

# def setup_name_of_person
#   puts "\n**** JUMPSTART -> #{__method__}\n"
#   # https://github.com/basecamp/name_of_person
#   insert_into_file 'app/models/user.rb', "  has_person_name\n", after: "class User < ApplicationRecord\n"
# end

def setup_axios
  run 'yarn add axios'
end

def setup_simple_form
  puts "\n**** JUMPSTART -> #{__method__}\n"
  generate "simple_form:install --bootstrap"
  # tweak the generate simple_form_bootstrap.rb config
  # remove the individual field-level 'is-valid' CSS classes, to de-clutter
  gsub_file "config/initializers/simple_form_bootstrap.rb", /config.input_field_valid_class = 'is-valid'/, "config.input_field_valid_class = ''"
  gsub_file "config/initializers/simple_form_bootstrap.rb", /(\w*\.use\s:input.*),\svalid_class:\s'is-valid'/, "\\1"
end

def setup_local_time
  puts "\n**** JUMPSTART -> #{__method__}\n"
  run 'yarn add local-time'
end

def setup_cocoon
  puts "\n**** JUMPSTART -> #{__method__}\n"
  # Cocoon is stubborn, it requires jQuery AND the asset pipeline
  # so we have to do some gymnastics here with webpacker to load it
  # via an ERB JS loader so that the asset paths are pulled in correctly
  run 'yarn add rails-erb-loader'
  directory "config/webpack/loaders", force: true
  insert_into_file 'config/webpack/environment.js', after: "const { environment } = require('@rails/webpacker')\n" do
    <<-JS
const erb =  require('./loaders/erb')
environment.loaders.append('erb', erb)
    JS
  end
  insert_into_file 'config/webpacker.yml', "    - .erb\n", after: "  extensions:\n"
end

def setup_select2
  puts "\n**** JUMPSTART -> #{__method__}\n"
  # select2 and a Bootstrap v4 theme
  run 'yarn add select2 @ttskch/select2-bootstrap4-theme'
end

def setup_fontawesome
  puts "\n**** JUMPSTART -> #{__method__}\n"
  puts "checking for FontAwesome Pro config (npm config ls)..."
  npm_config_data = run "npm config ls", capture: true
  pro_available = npm_config_data.include?('@fortawesome:registry')
  if pro_available
    puts "found PRO in your npm config!"
    run 'yarn add @fortawesome/fontawesome-pro'
  else
    puts "could not detect PRO, falling back to FontAwesome FREE"
    puts "read more here:\n https://fontawesome.com/how-to-use/on-the-web/setup/using-package-managers"
    run 'yarn add @fortawesome/fontawesome-free'
    gsub_file "app/webpacker/shared.js", "fontawesome-pro", "fontawesome-free"
  end
end

def setup_datepicker
  puts "\n**** JUMPSTART -> #{__method__}\n"
  insert_into_file 'app/helpers/application_helper.rb', before: /^end/ do
    <<-RUBY
  def date_input(form, field)
    render partial: 'shared/date_input', locals: { f: form, field: field }
  end
    RUBY
  end
end

def setup_sidekiq
  puts "\n**** JUMPSTART -> #{__method__}\n"
  insert_into_file 'config/routes.rb', after: "Rails.application.routes.draw do\n" do
    <<-RUBY

  require 'sidekiq/web'
  mount Sidekiq::Web => '/admin/sidekiq'

    RUBY
  end
end

def setup_annotate
  puts "\n**** JUMPSTART -> #{__method__}\n"
  generate 'annotate:install'

  # adjust annotate config
  # change annotation position from 'before' to 'after'
  gsub_file 'lib/tasks/auto_annotate_models.rake', /(?<==> ')(before)(?=')/, 'after'
  gsub_file 'lib/tasks/auto_annotate_models.rake', /'routes'\s*=>\s*'false'/, "'routes' => 'true'"
  gsub_file 'lib/tasks/auto_annotate_models.rake', /'classified_sort'\s*=>\s*'true'/, "'classified_sort' => 'false'"
end

def setup_whenever
  puts "\n**** JUMPSTART -> #{__method__}\n"
  run "wheneverize ."
end

def setup_bullet
  puts "\n**** JUMPSTART -> #{__method__}\n"
  insert_into_file 'config/environments/development.rb', before: /^end/ do
    <<-RUBY

  # Bullet Config
  Bullet.enable = true
  Bullet.console = true
  Bullet.rails_logger = true
  Bullet.bullet_logger = true
  Bullet.rollbar = false
    RUBY
  end
end

def setup_routes
  puts "\n**** JUMPSTART -> #{__method__}\n"
  insert_into_file 'config/routes.rb', "  root to: 'home#index'\n", after: "Rails.application.routes.draw do\n"
  insert_into_file 'config/routes.rb', after: "devise_for :users" do
    <<-RUBY

  scope '/user' do
    get '/profile', to: 'user_profile#edit', as: 'user_profile'
    patch '/profile', to: 'user_profile#update', as: 'user_update_profile'
  end

  get '/home', to: 'home#index'
  get '/privacy', to: 'home#privacy'
  get '/terms', to: 'home#terms'
    RUBY
  end
end

def setup_procfile
  puts "\n**** JUMPSTART -> #{__method__}\n"
  template "foreman.tt", ".foreman"
  template "Procfile.dev.tt"
end

# def fix_bundler_binstub
#   puts "\n**** JUMPSTART -> #{__method__}\n"
#   # https://github.com/rails/rails/issues/31193
#   run 'bundle binstubs bundler --force'
# end

def convert_erb_to_haml
  puts "\n**** JUMPSTART -> #{__method__}\n"
  run 'HAML_RAILS_DELETE_ERB=true HAML_RAILS_OVERWRITE_HAML=false bundle exec rails hamlit:erb2haml'
end

def setup_devise_omniauth_google
  puts "\n**** JUMPSTART -> #{__method__}\n"
  # https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview

  # add omniauth google gem
  insert_into_file "Gemfile", "gem 'omniauth-google-oauth2'\n", before: /gem 'devise-i18n'/
  run "bundle"

  # update devise initializer
  insert_into_file "config/initializers/devise.rb", before: /# config.omniauth/ do
    <<-RUBY

  config.omniauth :google_oauth2, Rails.application.credentials.dig(:google, :client_id), Rails.application.credentials.dig(:google, :client_secret) #, hd: 'webascender.com'

    RUBY
  end

  # add migration for the 2 omniauth attributes on User model
  generate :migration, "AddOmniauthToUsers provider:string uid:string"

  # modify User model to know about omniauth & google_oauth2
  insert_into_file "app/models/user.rb", before: /^end/ do
    <<-RUBY

  devise :omniauthable, omniauth_providers: [:google_oauth2]

  def self.from_omniauth(auth)
    where(provider: auth.provider, uid: auth.uid).first_or_create do |user|
      user.email = auth.info.email
      user.password = Devise.friendly_token[0, 20]
      user.first_name = auth.info.first_name
      user.last_name = auth.info.last_name
      # user.name = auth.info.name   # assuming the user model has a name
      # user.image = auth.info.image # assuming the user model has an image
      # If you are using confirmable and the provider(s) you use validate emails,
      # uncomment the line below to skip the confirmation emails.
      # user.skip_confirmation!
    end
  end
    RUBY
  end

  # omniauth callbacks - controller
  template "omniauth_callbacks_controller.rb.tt", "app/controllers/users/omniauth_callbacks_controller.rb", force: true
  # omniauth callbacks - devise routes
  gsub_file "config/routes.rb", "devise_for :users", "devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }"

end

def ask_user_options
  puts "\n ####  Questions / Options  ####"
  @option_omniauth_google = yes? "\n Add Google OAuth2 (omniauth) support to Devise? [y/n] "
end

def apply_template!
  # spring causes issues with our template, just disable it
  ENV["DISABLE_SPRING"] = "1"

  print_banner
  ask_user_options

  assert_minimum_rails_version
  assert_postgresql
  add_template_repository_to_source_path

  template "Gemfile.tt", force: true

  after_bundle do
    print_banner
    set_application_name
    setup_webpack

    copy_app_templates

    setup_bootstrap
    setup_devise_with_user_models
    setup_simple_form
    setup_axios
    setup_local_time
    setup_cocoon
    setup_select2
    setup_fontawesome
    setup_datepicker
    setup_sidekiq
    setup_annotate
    setup_whenever
    setup_bullet
    setup_routes
    setup_procfile
    setup_devise_omniauth_google if @option_omniauth_google

    convert_erb_to_haml

    copy_devise_templates

    print_success
  end
end

def print_banner
  puts "~"*100
  puts "\n"*2
  puts "\tJUMPSTART!\n"
  puts "\thttps://github.com/web-ascender/rails-jumpstart"
  puts "\n"*2
  puts "~"*100
end

def print_success
  print_banner
  puts "\n POST-INSTALL NOTES:"
  if @option_omniauth_google
    puts "\n#{'#'*72}\n GOOGLE OAUTH2 SETUP REQUIRED! \n#{'#'*72}"
    puts "\n 1. https://github.com/zquestz/omniauth-google-oauth2/blob/master/README.md#google-api-setup"
    puts "\n 2. open your rails credentials file:"
    puts "\tEDITOR='code --wait' bin/rails credentials:edit"
    puts "\n 3. add your Google CLIENT_ID and CLIENT_SECRET (see config/credentials.yml.example)"
    puts "\n 4. edit config/initializers/devise.rb to pass any extra omniauth options you might want e.g. ""hd: 'webascender.com'"" "
  end
  puts "\n#{'#'*72}\n CREATE and MIGRATE your database \n#{'#'*72}"
  puts "\n $ bin/rails db:create db:migrate"
  puts "\n#{'#'*72}\n Start your app in DEVELOPMENT with Foreman \n#{'#'*72}"
  puts "\n $ foreman start"
  puts "-"*72
  puts "Happy coding!"
  terminal_notifier_installed = run "gem list -i '^terminal-notifier$'", capture: true, verbose: false
  if terminal_notifier_installed.strip == 'true'
    run "terminal-notifier -title 'WA Rails Jumpstart' -subtitle 'APP READY ✅' -message 'run it with foreman start' -sound 'default'", verbose: false
  end
end

# kill any spring instances, they don't play well with templates
run 'pgrep spring | xargs kill -9'

apply_template!