template.rb 9.1 KB

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