template.rb 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
  1. require "fileutils"
  2. require "shellwords"
  3. # Copied from: https://github.com/mattbrictson/rails-template
  4. # Add this template directory to source_paths so that Thor actions like
  5. # copy_file and template resolve against our source files. If this file was
  6. # invoked remotely via HTTP, that means the files are not present locally.
  7. # In that case, use `git clone` to download them to a local temporary dir.
  8. def add_template_repository_to_source_path
  9. if __FILE__ =~ %r{\Ahttps?://}
  10. require "tmpdir"
  11. source_paths.unshift(tempdir = Dir.mktmpdir("jumpstart-"))
  12. at_exit { FileUtils.remove_entry(tempdir) }
  13. git clone: [
  14. "--quiet",
  15. "https://github.com/excid3/jumpstart.git",
  16. tempdir
  17. ].map(&:shellescape).join(" ")
  18. if (branch = __FILE__[%r{jumpstart/(.+)/template.rb}, 1])
  19. Dir.chdir(tempdir) { git checkout: branch }
  20. end
  21. else
  22. source_paths.unshift(File.dirname(__FILE__))
  23. end
  24. end
  25. def rails_version
  26. @rails_version ||= Gem::Version.new(Rails::VERSION::STRING)
  27. end
  28. def rails_5?
  29. Gem::Requirement.new(">= 5.2.0", "< 6.0.0.beta1").satisfied_by? rails_version
  30. end
  31. def rails_6?
  32. Gem::Requirement.new(">= 6.0.0.beta1", "< 7").satisfied_by? rails_version
  33. end
  34. def add_gems
  35. gem 'administrate', github: "excid3/administrate", branch: "zeitwerk"
  36. gem 'bootstrap', '~> 4.3', '>= 4.3.1'
  37. gem 'devise', '~> 4.6', '>= 4.6.1'
  38. gem 'devise-bootstrapped', github: 'excid3/devise-bootstrapped', branch: 'bootstrap4'
  39. gem 'devise_masquerade', '~> 0.6.2'
  40. gem 'font-awesome-sass', '~> 5.6', '>= 5.6.1'
  41. gem 'friendly_id', '~> 5.2', '>= 5.2.5'
  42. gem 'gravatar_image_tag', github: 'mdeering/gravatar_image_tag'
  43. gem 'mini_magick', '~> 4.9', '>= 4.9.2'
  44. gem 'name_of_person', '~> 1.1'
  45. gem 'omniauth-facebook', '~> 5.0'
  46. gem 'omniauth-github', '~> 1.3'
  47. gem 'omniauth-twitter', '~> 1.4'
  48. gem 'sidekiq', '~> 5.2', '>= 5.2.5'
  49. gem 'sitemap_generator', '~> 6.0', '>= 6.0.1'
  50. gem 'whenever', require: false
  51. if rails_5?
  52. gsub_file "Gemfile", /gem 'sqlite3'/, "gem 'sqlite3', '~> 1.3.0'"
  53. gem 'webpacker', '~> 4.0.1'
  54. end
  55. end
  56. def set_application_name
  57. # Add Application Name to Config
  58. if rails_5?
  59. environment "config.application_name = Rails.application.class.parent_name"
  60. else
  61. environment "config.application_name = Rails.application.class.module_parent_name"
  62. end
  63. # Announce the user where he can change the application name in the future.
  64. puts "You can change application name inside: ./config/application.rb"
  65. end
  66. def add_users
  67. # Install Devise
  68. generate "devise:install"
  69. # Configure Devise
  70. environment "config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }",
  71. env: 'development'
  72. route "root to: 'home#index'"
  73. # Devise notices are installed via Bootstrap
  74. generate "devise:views:bootstrapped"
  75. # Create Devise User
  76. generate :devise, "User",
  77. "first_name",
  78. "last_name",
  79. "announcements_last_read_at:datetime",
  80. "admin:boolean"
  81. # Set admin default to false
  82. in_root do
  83. migration = Dir.glob("db/migrate/*").max_by{ |f| File.mtime(f) }
  84. gsub_file migration, /:admin/, ":admin, default: false"
  85. end
  86. if Gem::Requirement.new("> 5.2").satisfied_by? rails_version
  87. gsub_file "config/initializers/devise.rb",
  88. / # config.secret_key = .+/,
  89. " config.secret_key = Rails.application.credentials.secret_key_base"
  90. end
  91. # Add Devise masqueradable to users
  92. inject_into_file("app/models/user.rb", "omniauthable, :masqueradable, :", after: "devise :")
  93. end
  94. def add_webpack
  95. # Rails 6+ comes with webpacker by default, so we can skip this step
  96. return if rails_6?
  97. # Our application layout already includes the javascript_pack_tag,
  98. # so we don't need to inject it
  99. rails_command 'webpacker:install'
  100. end
  101. def add_javascript
  102. run "yarn add expose-loader jquery popper.js bootstrap data-confirm-modal local-time"
  103. if rails_5?
  104. run "yarn add turbolinks @rails/actioncable@pre @rails/actiontext@pre @rails/activestorage@pre @rails/ujs@pre"
  105. end
  106. content = <<-JS
  107. const webpack = require('webpack')
  108. environment.plugins.append('Provide', new webpack.ProvidePlugin({
  109. $: 'jquery',
  110. jQuery: 'jquery',
  111. Rails: '@rails/ujs'
  112. }))
  113. JS
  114. insert_into_file 'config/webpack/environment.js', content + "\n", before: "module.exports = environment"
  115. end
  116. def copy_templates
  117. remove_file "app/assets/stylesheets/application.css"
  118. copy_file "Procfile"
  119. copy_file "Procfile.dev"
  120. copy_file ".foreman"
  121. directory "app", force: true
  122. directory "config", force: true
  123. directory "lib", force: true
  124. route "get '/terms', to: 'home#terms'"
  125. route "get '/privacy', to: 'home#privacy'"
  126. end
  127. def add_sidekiq
  128. environment "config.active_job.queue_adapter = :sidekiq"
  129. insert_into_file "config/routes.rb",
  130. "require 'sidekiq/web'\n\n",
  131. before: "Rails.application.routes.draw do"
  132. content = <<-RUBY
  133. authenticate :user, lambda { |u| u.admin? } do
  134. mount Sidekiq::Web => '/sidekiq'
  135. end
  136. RUBY
  137. insert_into_file "config/routes.rb", "#{content}\n\n", after: "Rails.application.routes.draw do\n"
  138. end
  139. def add_announcements
  140. generate "model Announcement published_at:datetime announcement_type name description:text"
  141. route "resources :announcements, only: [:index]"
  142. end
  143. def add_notifications
  144. generate "model Notification recipient_id:bigint actor_id:bigint read_at:datetime action:string notifiable_id:bigint notifiable_type:string"
  145. route "resources :notifications, only: [:index]"
  146. end
  147. def add_administrate
  148. generate "administrate:install"
  149. gsub_file "app/dashboards/announcement_dashboard.rb",
  150. /announcement_type: Field::String/,
  151. "announcement_type: Field::Select.with_options(collection: Announcement::TYPES)"
  152. gsub_file "app/dashboards/user_dashboard.rb",
  153. /email: Field::String/,
  154. "email: Field::String,\n password: Field::String.with_options(searchable: false)"
  155. gsub_file "app/dashboards/user_dashboard.rb",
  156. /FORM_ATTRIBUTES = \[/,
  157. "FORM_ATTRIBUTES = [\n :password,"
  158. gsub_file "app/controllers/admin/application_controller.rb",
  159. /# TODO Add authentication logic here\./,
  160. "redirect_to '/', alert: 'Not authorized.' unless user_signed_in? && current_user.admin?"
  161. environment do <<-RUBY
  162. # Expose our application's helpers to Administrate
  163. config.to_prepare do
  164. Administrate::ApplicationController.helper #{@app_name.camelize}::Application.helpers
  165. end
  166. RUBY
  167. end
  168. end
  169. def add_multiple_authentication
  170. insert_into_file "config/routes.rb",
  171. ', controllers: { omniauth_callbacks: "users/omniauth_callbacks" }',
  172. after: " devise_for :users"
  173. generate "model Service user:references provider uid access_token access_token_secret refresh_token expires_at:datetime auth:text"
  174. template = """
  175. env_creds = Rails.application.credentials[Rails.env.to_sym] || {}
  176. %w{ facebook twitter github }.each do |provider|
  177. if options = env_creds[provider]
  178. config.omniauth provider, options[:app_id], options[:app_secret], options.fetch(:options, {})
  179. end
  180. end
  181. """.strip
  182. insert_into_file "config/initializers/devise.rb", " " + template + "\n\n",
  183. before: " # ==> Warden configuration"
  184. end
  185. def add_whenever
  186. run "wheneverize ."
  187. end
  188. def add_friendly_id
  189. generate "friendly_id"
  190. insert_into_file(
  191. Dir["db/migrate/**/*friendly_id_slugs.rb"].first,
  192. "[5.2]",
  193. after: "ActiveRecord::Migration"
  194. )
  195. end
  196. def stop_spring
  197. run "spring stop"
  198. end
  199. def add_sitemap
  200. rails_command "sitemap:install"
  201. end
  202. # Main setup
  203. add_template_repository_to_source_path
  204. add_gems
  205. after_bundle do
  206. set_application_name
  207. stop_spring
  208. add_users
  209. add_webpack
  210. add_javascript
  211. add_announcements
  212. add_notifications
  213. add_multiple_authentication
  214. add_sidekiq
  215. add_friendly_id
  216. copy_templates
  217. add_whenever
  218. add_sitemap
  219. # Migrate
  220. rails_command "db:create"
  221. rails_command "db:migrate"
  222. # Migrations must be done before this
  223. add_administrate
  224. # Commit everything to git
  225. git :init
  226. git add: "."
  227. git commit: %Q{ -m 'Initial commit' }
  228. say
  229. say "Jumpstart app successfully created!", :blue
  230. say
  231. say "To get started with your new app:", :green
  232. say "cd #{app_name} - Switch to your new app's directory."
  233. say "foreman start - Run Rails, sidekiq, and webpack-dev-server."
  234. end