template.rb 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  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.0.rc.7'
  54. end
  55. end
  56. def set_application_name
  57. # Add Application Name to Config
  58. environment "config.application_name = Rails.application.class.parent_name"
  59. # Announce the user where he can change the application name in the future.
  60. puts "You can change application name inside: ./config/application.rb"
  61. end
  62. def add_users
  63. # Install Devise
  64. generate "devise:install"
  65. # Configure Devise
  66. environment "config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }",
  67. env: 'development'
  68. route "root to: 'home#index'"
  69. # Devise notices are installed via Bootstrap
  70. generate "devise:views:bootstrapped"
  71. # Create Devise User
  72. generate :devise, "User",
  73. "first_name",
  74. "last_name",
  75. "announcements_last_read_at:datetime",
  76. "admin:boolean"
  77. # Set admin default to false
  78. in_root do
  79. migration = Dir.glob("db/migrate/*").max_by{ |f| File.mtime(f) }
  80. gsub_file migration, /:admin/, ":admin, default: false"
  81. end
  82. if Gem::Requirement.new("> 5.2").satisfied_by? rails_version
  83. gsub_file "config/initializers/devise.rb",
  84. / # config.secret_key = .+/,
  85. " config.secret_key = Rails.application.credentials.secret_key_base"
  86. end
  87. # Add Devise masqueradable to users
  88. inject_into_file("app/models/user.rb", "omniauthable, :masqueradable, :", after: "devise :")
  89. end
  90. def add_webpack
  91. # Rails 6+ comes with webpacker by default, so we can skip this step
  92. return if rails_6?
  93. # Our application layout already includes the javascript_pack_tag,
  94. # so we don't need to inject it
  95. rails_command 'webpacker:install'
  96. end
  97. def add_javascript
  98. run "yarn add expose-loader jquery popper.js bootstrap data-confirm-modal local-time"
  99. if rails_5?
  100. run "yarn add @rails/actioncable@pre @rails/actiontext@pre @rails/activestorage@pre @rails/ujs@pre"
  101. end
  102. content = <<-JS
  103. const webpack = require('webpack')
  104. environment.plugins.append('Provide', new webpack.ProvidePlugin({
  105. $: 'jquery',
  106. jQuery: 'jquery',
  107. Rails: '@rails/ujs'
  108. }))
  109. JS
  110. insert_into_file 'config/webpack/environment.js', content + "\n", before: "module.exports = environment"
  111. end
  112. def copy_templates
  113. copy_file "Procfile"
  114. copy_file "Procfile.dev"
  115. copy_file ".foreman"
  116. directory "app", force: true
  117. directory "config", force: true
  118. directory "lib", force: true
  119. route "get '/terms', to: 'home#terms'"
  120. route "get '/privacy', to: 'home#privacy'"
  121. end
  122. def add_sidekiq
  123. environment "config.active_job.queue_adapter = :sidekiq"
  124. insert_into_file "config/routes.rb",
  125. "require 'sidekiq/web'\n\n",
  126. before: "Rails.application.routes.draw do"
  127. content = <<-RUBY
  128. authenticate :user, lambda { |u| u.admin? } do
  129. mount Sidekiq::Web => '/sidekiq'
  130. end
  131. RUBY
  132. insert_into_file "config/routes.rb", "#{content}\n\n", after: "Rails.application.routes.draw do\n"
  133. end
  134. def add_announcements
  135. generate "model Announcement published_at:datetime announcement_type name description:text"
  136. route "resources :announcements, only: [:index]"
  137. end
  138. def add_notifications
  139. generate "model Notification recipient_id:bigint actor_id:bigint read_at:datetime action:string notifiable_id:bigint notifiable_type:string"
  140. route "resources :notifications, only: [:index]"
  141. end
  142. def add_administrate
  143. generate "administrate:install"
  144. gsub_file "app/dashboards/announcement_dashboard.rb",
  145. /announcement_type: Field::String/,
  146. "announcement_type: Field::Select.with_options(collection: Announcement::TYPES)"
  147. gsub_file "app/dashboards/user_dashboard.rb",
  148. /email: Field::String/,
  149. "email: Field::String,\n password: Field::String.with_options(searchable: false)"
  150. gsub_file "app/dashboards/user_dashboard.rb",
  151. /FORM_ATTRIBUTES = \[/,
  152. "FORM_ATTRIBUTES = [\n :password,"
  153. gsub_file "app/controllers/admin/application_controller.rb",
  154. /# TODO Add authentication logic here\./,
  155. "redirect_to '/', alert: 'Not authorized.' unless user_signed_in? && current_user.admin?"
  156. environment do <<-RUBY
  157. # Expose our application's helpers to Administrate
  158. config.to_prepare do
  159. Administrate::ApplicationController.helper #{@app_name.camelize}::Application.helpers
  160. end
  161. RUBY
  162. end
  163. end
  164. def add_multiple_authentication
  165. insert_into_file "config/routes.rb",
  166. ', controllers: { omniauth_callbacks: "users/omniauth_callbacks" }',
  167. after: " devise_for :users"
  168. generate "model Service user:references provider uid access_token access_token_secret refresh_token expires_at:datetime auth:text"
  169. template = """
  170. env_creds = Rails.application.credentials[Rails.env.to_sym] || {}
  171. %w{ facebook twitter github }.each do |provider|
  172. if options = env_creds[provider]
  173. config.omniauth provider, options[:app_id], options[:app_secret], options.fetch(:options, {})
  174. end
  175. end
  176. """.strip
  177. insert_into_file "config/initializers/devise.rb", " " + template + "\n\n",
  178. before: " # ==> Warden configuration"
  179. end
  180. def add_whenever
  181. run "wheneverize ."
  182. end
  183. def add_friendly_id
  184. generate "friendly_id"
  185. insert_into_file(
  186. Dir["db/migrate/**/*friendly_id_slugs.rb"].first,
  187. "[5.2]",
  188. after: "ActiveRecord::Migration"
  189. )
  190. end
  191. def stop_spring
  192. run "spring stop"
  193. end
  194. def add_sitemap
  195. rails_command "sitemap:install"
  196. end
  197. # Main setup
  198. add_template_repository_to_source_path
  199. add_gems
  200. after_bundle do
  201. set_application_name
  202. stop_spring
  203. add_users
  204. add_webpack
  205. add_javascript
  206. add_announcements
  207. add_notifications
  208. add_multiple_authentication
  209. add_sidekiq
  210. add_friendly_id
  211. copy_templates
  212. add_whenever
  213. add_sitemap
  214. # Migrate
  215. rails_command "db:create"
  216. rails_command "db:migrate"
  217. # Migrations must be done before this
  218. add_administrate
  219. # Commit everything to git
  220. git :init
  221. git add: "."
  222. git commit: %Q{ -m 'Initial commit' }
  223. say
  224. say "Jumpstart app successfully created! 🙌", :blue
  225. say
  226. say "To get started with your new app:", :green
  227. say "cd #{app_name} - Switch to your new app's directory."
  228. say "foreman start - Run Rails, sidekiq, and webpack-dev-server."
  229. end