template.rb 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. # Copied from: https://github.com/mattbrictson/rails-template
  2. # Add this template directory to source_paths so that Thor actions like
  3. # copy_file and template resolve against our source files. If this file was
  4. # invoked remotely via HTTP, that means the files are not present locally.
  5. # In that case, use `git clone` to download them to a local temporary dir.
  6. def add_template_repository_to_source_path
  7. if __FILE__ =~ %r{\Ahttps?://}
  8. require "tmpdir"
  9. source_paths.unshift(tempdir = Dir.mktmpdir("jumpstart-"))
  10. at_exit { FileUtils.remove_entry(tempdir) }
  11. git clone: [
  12. "--quiet",
  13. "https://github.com/excid3/jumpstart.git",
  14. tempdir
  15. ].map(&:shellescape).join(" ")
  16. if (branch = __FILE__[%r{jumpstart/(.+)/template.rb}, 1])
  17. Dir.chdir(tempdir) { git checkout: branch }
  18. end
  19. else
  20. source_paths.unshift(File.dirname(__FILE__))
  21. end
  22. end
  23. def add_gems
  24. gem 'administrate', '~> 0.8.1'
  25. gem 'data-confirm-modal', '~> 1.6.2'
  26. gem 'devise', '~> 4.4.3'
  27. gem 'devise-bootstrapped', github: 'excid3/devise-bootstrapped', branch: 'bootstrap4'
  28. gem 'devise_masquerade', '~> 0.6.0'
  29. gem 'font-awesome-sass', '~> 4.7'
  30. gem 'gravatar_image_tag', github: 'mdeering/gravatar_image_tag'
  31. gem 'jquery-rails', '~> 4.3.1'
  32. gem 'bootstrap', '~> 4.0.0.beta'
  33. gem 'mini_magick', '~> 4.8'
  34. gem 'webpacker', '~> 3.0'
  35. gem 'sidekiq', '~> 5.0'
  36. gem 'foreman', '~> 0.84.0'
  37. gem 'omniauth-facebook', '~> 4.0'
  38. gem 'omniauth-twitter', '~> 1.4'
  39. gem 'omniauth-github', '~> 1.3'
  40. gem 'whenever', require: false
  41. end
  42. def set_application_name
  43. # Add Application Name to Config
  44. environment "config.application_name = Rails.application.class.parent_name"
  45. # Announce the user where he can change the application name in the future.
  46. puts "You can change application name inside: ./config/application.rb"
  47. end
  48. def add_users
  49. # Install Devise
  50. generate "devise:install"
  51. # Configure Devise
  52. environment "config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }",
  53. env: 'development'
  54. route "root to: 'home#index'"
  55. # Devise notices are installed via Bootstrap
  56. generate "devise:views:bootstrapped"
  57. # Create Devise User
  58. generate :devise, "User",
  59. "name",
  60. "announcements_last_read_at:datetime",
  61. "admin:boolean"
  62. # Set admin default to false
  63. in_root do
  64. migration = Dir.glob("db/migrate/*").max_by{ |f| File.mtime(f) }
  65. gsub_file migration, /:admin/, ":admin, default: false"
  66. end
  67. requirement = Gem::Requirement.new("> 5.2")
  68. rails_version = Gem::Version.new(Rails::VERSION::STRING)
  69. if requirement.satisfied_by? rails_version
  70. gsub_file "config/initializers/devise.rb",
  71. / # config.secret_key = .+/,
  72. " config.secret_key = Rails.application.credentials.secret_key_base"
  73. end
  74. # Add Devise masqueradable to users
  75. inject_into_file("app/models/user.rb", "omniauthable, :masqueradable, :", after: "devise :")
  76. end
  77. def add_bootstrap
  78. # Remove Application CSS
  79. run "rm app/assets/stylesheets/application.css"
  80. # Add Bootstrap JS
  81. insert_into_file(
  82. "app/assets/javascripts/application.js",
  83. "\n//= require jquery\n//= require popper\n//= require bootstrap\n//= require data-confirm-modal",
  84. after: "//= require rails-ujs"
  85. )
  86. end
  87. def copy_templates
  88. directory "app", force: true
  89. directory "config", force: true
  90. directory "lib", force: true
  91. route "get '/terms', to: 'home#terms'"
  92. route "get '/privacy', to: 'home#privacy'"
  93. end
  94. def add_webpack
  95. rails_command 'webpacker:install'
  96. end
  97. def add_sidekiq
  98. environment "config.active_job.queue_adapter = :sidekiq"
  99. insert_into_file "config/routes.rb",
  100. "require 'sidekiq/web'\n\n",
  101. before: "Rails.application.routes.draw do"
  102. insert_into_file "config/routes.rb",
  103. " authenticate :user, lambda { |u| u.admin? } do\n mount Sidekiq::Web => '/sidekiq'\n end\n\n",
  104. after: "Rails.application.routes.draw do\n"
  105. end
  106. def add_foreman
  107. copy_file "Procfile"
  108. end
  109. def add_announcements
  110. generate "model Announcement published_at:datetime announcement_type name description:text"
  111. route "resources :announcements, only: [:index]"
  112. end
  113. def add_notifications
  114. generate "model Notification recipient_id:integer actor_id:integer read_at:datetime action:string notifiable_id:integer notifiable_type:string"
  115. route "resources :notifications, only: [:index]"
  116. end
  117. def add_administrate
  118. generate "administrate:install"
  119. gsub_file "app/dashboards/announcement_dashboard.rb",
  120. /announcement_type: Field::String/,
  121. "announcement_type: Field::Select.with_options(collection: Announcement::TYPES)"
  122. gsub_file "app/controllers/admin/application_controller.rb",
  123. /# TODO Add authentication logic here\./,
  124. "redirect_to '/', alert: 'Not authorized.' unless user_signed_in? && current_user.admin?"
  125. end
  126. def add_multiple_authentication
  127. insert_into_file "config/routes.rb",
  128. ', controllers: { omniauth_callbacks: "users/omniauth_callbacks" }',
  129. after: " devise_for :users"
  130. generate "model Service user:references provider uid access_token access_token_secret refresh_token expires_at:datetime auth:text"
  131. template = """
  132. if Rails.application.secrets.facebook_app_id.present? && Rails.application.secrets.facebook_app_secret.present?
  133. config.omniauth :facebook, Rails.application.secrets.facebook_app_id, Rails.application.secrets.facebook_app_secret, scope: 'email,user_posts'
  134. end
  135. if Rails.application.secrets.twitter_app_id.present? && Rails.application.secrets.twitter_app_secret.present?
  136. config.omniauth :twitter, Rails.application.secrets.twitter_app_id, Rails.application.secrets.twitter_app_secret
  137. end
  138. if Rails.application.secrets.github_app_id.present? && Rails.application.secrets.github_app_secret.present?
  139. config.omniauth :github, Rails.application.secrets.github_app_id, Rails.application.secrets.github_app_secret
  140. end
  141. """.strip
  142. insert_into_file "config/initializers/devise.rb", " " + template + "\n\n",
  143. before: " # ==> Warden configuration"
  144. end
  145. def add_whenever
  146. run "wheneverize ."
  147. end
  148. # Main setup
  149. add_template_repository_to_source_path
  150. add_gems
  151. after_bundle do
  152. set_application_name
  153. add_users
  154. add_bootstrap
  155. add_sidekiq
  156. add_foreman
  157. add_webpack
  158. add_announcements
  159. add_notifications
  160. add_multiple_authentication
  161. copy_templates
  162. # Migrate
  163. rails_command "db:create"
  164. rails_command "db:migrate"
  165. # Migrations must be done before this
  166. add_administrate
  167. add_whenever
  168. git :init
  169. git add: "."
  170. git commit: %Q{ -m 'Initial commit' }
  171. end