Class: Decidim::Generators::AppGenerator
- Inherits:
-
Rails::Generators::AppGenerator
- Object
- Rails::Generators::AppGenerator
- Decidim::Generators::AppGenerator
- Defined in:
- decidim-generators/lib/decidim/generators/app_generator.rb
Overview
Generates a Rails app and installs decidim to it. Uses the default Rails generator for most of the work.
Remember that, for how generators work, actions are executed based on the definition order of the public methods.
Instance Method Summary collapse
- #add_ignore_tailwind_configuration ⇒ Object
- #add_production_gems(&block) ⇒ Object
- #add_queue_adapter ⇒ Object
- #add_storage_provider ⇒ Object
- #authorization_handler ⇒ Object
- #budgets_workflows ⇒ Object
- #cable_yml ⇒ Object
- #database_yml ⇒ Object
- #decidim_controller ⇒ Object
- #decidim_initializer ⇒ Object
- #docker ⇒ Object
- #etherpad ⇒ Object
- #gemfile ⇒ Object
- #install ⇒ Object
- #license ⇒ Object
- #machine_translation_service ⇒ Object
- #modify_gitignore ⇒ Object
- #pdf_signature_service ⇒ Object
- #puma_ssl_options ⇒ Object
- #readme ⇒ Object
- #remove_default_error_pages ⇒ Object
- #remove_default_favicon ⇒ Object
- #sms_gateway ⇒ Object
- #source_paths ⇒ Object
- #timestamp_service ⇒ Object
- #tweak_bootsnap ⇒ Object
- #tweak_spring ⇒ Object
Instance Method Details
#add_ignore_tailwind_configuration ⇒ Object
270 271 272 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 270 def add_ignore_tailwind_configuration append_file ".gitignore", "\n\n# Ignore Tailwind configuration\ntailwind.config.js" unless ["skip_git"] end |
#add_production_gems(&block) ⇒ Object
196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 196 def add_production_gems(&block) return if [:skip_gemfile] if block @production_gems ||= [] @production_gems << block elsif @production_gems.present? gem_group :production do @production_gems.map(&:call) end end end |
#add_queue_adapter ⇒ Object
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 171 def add_queue_adapter adapter = [:queue] abort("#{adapter} is not supported as a queue adapter, please use sidekiq for the moment") unless adapter.in?(["", "sidekiq"]) return unless adapter == "sidekiq" template "sidekiq.yml.erb", "config/sidekiq.yml", force: true gsub_file "config/environments/production.rb", /# config.active_job.queue_adapter = :resque/, "config.active_job.queue_adapter = ENV['QUEUE_ADAPTER'] if ENV['QUEUE_ADAPTER'].present?" prepend_file "config/routes.rb", "require \"sidekiq/web\"\n\n" route <<~RUBY authenticate :user, ->(u) { u.admin? } do mount Sidekiq::Web => "/sidekiq" end RUBY add_production_gems do gem "sidekiq" end end |
#add_storage_provider ⇒ Object
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 154 def add_storage_provider template "storage.yml.erb", "config/storage.yml", force: true providers = [:storage].split(",") abort("#{providers} is not supported as storage provider, please use local, s3, gcs or azure") unless (providers - %w(local s3 gcs azure)).empty? gsub_file "config/environments/production.rb", /config.active_storage.service = :local/, "config.active_storage.service = Rails.application.secrets.dig(:storage, :provider) || :local" add_production_gems do gem "aws-sdk-s3", require: false if providers.include?("s3") gem "azure-storage-blob", require: false if providers.include?("azure") gem "google-cloud-storage", "~> 1.11", require: false if providers.include?("gcs") end end |
#authorization_handler ⇒ Object
309 310 311 312 313 314 315 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 309 def return unless [:demo] copy_file "dummy_authorization_handler.rb", "app/services/dummy_authorization_handler.rb" copy_file "another_dummy_authorization_handler.rb", "app/services/another_dummy_authorization_handler.rb" copy_file "verifications_initializer.rb", "config/initializers/decidim_verifications.rb" end |
#budgets_workflows ⇒ Object
325 326 327 328 329 330 331 332 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 325 def budgets_workflows return unless [:demo] copy_file "budgets_workflow_random.rb", "lib/budgets_workflow_random.rb" copy_file "budgets_workflow_random.en.yml", "config/locales/budgets_workflow_random.en.yml" copy_file "budgets_initializer.rb", "config/initializers/decidim_budgets.rb" end |
#cable_yml ⇒ Object
113 114 115 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 113 def cable_yml template "cable.yml.erb", "config/cable.yml", force: true end |
#database_yml ⇒ Object
96 97 98 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 96 def database_yml template "database.yml.erb", "config/database.yml", force: true end |
#decidim_controller ⇒ Object
100 101 102 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 100 def decidim_controller template "decidim_controller.rb.erb", "app/controllers/decidim_controller.rb", force: true end |
#decidim_initializer ⇒ Object
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 283 def decidim_initializer copy_file "initializer.rb", "config/initializers/decidim.rb" gsub_file "config/environments/production.rb", /config.log_level = :info/, "config.log_level = %w(debug info warn error fatal).include?(ENV['RAILS_LOG_LEVEL']) ? ENV['RAILS_LOG_LEVEL'] : :info" gsub_file "config/environments/production.rb", %r{# config.asset_host = 'http://assets.example.com'}, "config.asset_host = ENV['RAILS_ASSET_HOST'] if ENV['RAILS_ASSET_HOST'].present?" if [:force_ssl] == "false" gsub_file "config/initializers/decidim.rb", /# config.force_ssl = true/, "config.force_ssl = false" end return if [:locales].blank? gsub_file "config/initializers/decidim.rb", /#{Regexp.escape("# config.available_locales = %w(en ca es)")}/, "config.available_locales = %w(#{[:locales].gsub(",", " ")})" gsub_file "config/initializers/decidim.rb", /#{Regexp.escape("config.available_locales = Rails.application.secrets.decidim[:available_locales].presence || [:en]")}/, "# config.available_locales = Rails.application.secrets.decidim[:available_locales].presence || [:en]" end |
#docker ⇒ Object
104 105 106 107 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 104 def docker template "Dockerfile.erb", "Dockerfile" template "docker-compose.yml.erb", "docker-compose.yml" end |
#etherpad ⇒ Object
109 110 111 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 109 def etherpad template "docker-compose-etherpad.yml", "docker-compose-etherpad.yml" end |
#gemfile ⇒ Object
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 125 def gemfile return if [:skip_gemfile] if branch.present? get target_gemfile, "Gemfile", force: true append_file "Gemfile", %(\ngem "net-imap", "~> 0.2.3", group: :development) append_file "Gemfile", %(\ngem "net-pop", "~> 0.1.1", group: :development) append_file "Gemfile", %(\ngem "net-smtp", "~> 0.3.1", group: :development) get "#{target_gemfile}.lock", "Gemfile.lock", force: true else copy_file target_gemfile, "Gemfile", force: true copy_file "#{target_gemfile}.lock", "Gemfile.lock", force: true end gsub_file "Gemfile", /gem "#{current_gem}".*/, "gem \"#{current_gem}\", #{gem_modifier}" return unless current_gem == "decidim" gsub_file "Gemfile", /gem "decidim-dev".*/, "gem \"decidim-dev\", #{gem_modifier}" %w(conferences consultations elections initiatives templates).each do |component| if [:demo] gsub_file "Gemfile", /gem "decidim-#{component}".*/, "gem \"decidim-#{component}\", #{gem_modifier}" else gsub_file "Gemfile", /gem "decidim-#{component}".*/, "# gem \"decidim-#{component}\", #{gem_modifier}" end end end |
#install ⇒ Object
358 359 360 361 362 363 364 365 366 367 368 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 358 def install Decidim::Generators::InstallGenerator.start( [ "--recreate_db=#{[:recreate_db]}", "--seed_db=#{[:seed_db]}", "--skip_gemfile=#{[:skip_gemfile]}", "--app_name=#{app_name}", "--profiling=#{[:profiling]}" ] ) end |
#license ⇒ Object
121 122 123 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 121 def license template "LICENSE-AGPLv3.txt", "LICENSE-AGPLv3.txt" end |
#machine_translation_service ⇒ Object
350 351 352 353 354 355 356 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 350 def machine_translation_service return unless [:demo] gsub_file "config/initializers/decidim.rb", /# config.machine_translation_service = "MyTranslationService"/, "config.machine_translation_service = 'Decidim::Dev::DummyTranslator'" end |
#modify_gitignore ⇒ Object
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 249 def modify_gitignore return if [:skip_git] append_file ".gitignore", <<~GITIGNORE # Ignore env configuration files .env .envrc .rbenv-vars # Ignore the files and folders generated through Webpack /public/decidim-packs /public/packs-test /public/sw.js /public/sw.js.map # Ignore node modules /node_modules GITIGNORE end |
#pdf_signature_service ⇒ Object
342 343 344 345 346 347 348 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 342 def pdf_signature_service return unless [:demo] gsub_file "config/initializers/decidim.rb", /# config.pdf_signature_service = "MyPDFSignatureService"/, "config.pdf_signature_service = \"Decidim::Initiatives::PdfSignatureExample\"" end |
#puma_ssl_options ⇒ Object
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 231 def return unless [:dev_ssl] append_file "config/puma.rb", <<~CONFIG # Development SSL if ENV["DEV_SSL"] && defined?(Bundler) && (dev_gem = Bundler.load.specs.find { |spec| spec.name == "decidim-dev" }) cert_dir = ENV.fetch("DEV_SSL_DIR") { "\#{dev_gem.full_gem_path}/lib/decidim/dev/assets" } ssl_bind( "0.0.0.0", ENV.fetch("DEV_SSL_PORT") { 3443 }, cert_pem: File.read("\#{cert_dir}/ssl-cert.pem"), key_pem: File.read("\#{cert_dir}/ssl-key.pem") ) end CONFIG end |
#readme ⇒ Object
117 118 119 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 117 def readme template "README.md.erb", "README.md", force: true end |
#remove_default_error_pages ⇒ Object
274 275 276 277 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 274 def remove_default_error_pages remove_file "public/404.html" remove_file "public/500.html" end |
#remove_default_favicon ⇒ Object
279 280 281 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 279 def remove_default_favicon remove_file "public/favicon.ico" end |
#sms_gateway ⇒ Object
317 318 319 320 321 322 323 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 317 def sms_gateway return unless [:demo] gsub_file "config/initializers/decidim.rb", /# config.sms_gateway_service = "MySMSGatewayService"/, "config.sms_gateway_service = 'Decidim::Verifications::Sms::ExampleGateway'" end |
#source_paths ⇒ Object
19 20 21 22 23 24 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 19 def source_paths [ self.class.source_root, Rails::Generators::AppGenerator.source_root ] end |
#timestamp_service ⇒ Object
334 335 336 337 338 339 340 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 334 def return unless [:demo] gsub_file "config/initializers/decidim.rb", /# config.timestamp_service = "MyTimestampService"/, "config.timestamp_service = \"Decidim::Initiatives::DummyTimestamp\"" end |
#tweak_bootsnap ⇒ Object
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 209 def tweak_bootsnap gsub_file "config/boot.rb", %r{require 'bootsnap/setup'.*$}, <<~RUBY.rstrip require "bootsnap" env = ENV["RAILS_ENV"] || "development" Bootsnap.setup( cache_dir: File.expand_path(File.join("..", "tmp", "cache"), __dir__), development_mode: env == "development", load_path_cache: true, compile_cache_iseq: !ENV["SIMPLECOV"], compile_cache_yaml: true ) RUBY end |
#tweak_spring ⇒ Object
225 226 227 228 229 |
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 225 def tweak_spring return unless File.exist?("config/spring.rb") prepend_to_file "config/spring.rb", "require \"decidim/spring\"\n\n" end |