Class: Decidim::Generators::AppGenerator

Inherits:
Rails::Generators::AppGenerator
  • Object
show all
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

Instance Method Details

#add_ignore_tailwind_configuration ⇒ Object 



335
336
337
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 335

def add_ignore_tailwind_configuration
  append_file ".gitignore", "\n\n# Ignore Tailwind configuration\ntailwind.config.js" unless options["skip_git"]
end

#add_production_gems(&block) ⇒ Object 



273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 273

def add_production_gems(&block)
  return if options[: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 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 226

def add_queue_adapter
  adapter = options[: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/development.rb",
            /Rails.application.configure do/,
            "Rails.application.configure do\n  config.active_job.queue_adapter = :sidekiq\n"
  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 "    authenticate :user, ->(u) { u.admin? } do\n      mount Sidekiq::Web => \"/sidekiq\"\n    end\n  RUBY\n\n  redis_version = begin\n    require \"redis\"\n    ver = Redis.new.call(\"INFO\").lines(chomp: true).find { |l| l.start_with?(\"redis_version:\") }.split(\":\", 2).last\n    Gem::Version.new(ver)\n  rescue LoadError, Redis::CannotConnectError\n    # This does not have to be the actual Redis version, it can be\n    # anything that is above any of the version checks below to default to\n    # the latest Sidekiq version.\n    Gem::Version.new(\"8.0.0\")\n  end\n\n  if redis_version < Gem::Version.new(\"6.2.0\")\n    # Sidekiq 7.x requires Redis 6.2.0 or newer\n    append_file \"Gemfile\", %(gem \"sidekiq\", \"~> 6.5\")\n  elsif redis_version < Gem::Version.new(\"7.0.0\")\n    # Sidekiq 8.x requires Redis 7.0.0 or newer\n    append_file \"Gemfile\", %(gem \"sidekiq\", \"~> 7.3\")\n  else\n    # Assume latest\n    append_file \"Gemfile\", %(gem \"sidekiq\")\n  end\nend\n"

#add_storage_provider ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 209

def add_storage_provider
  copy_file "storage.yml", "config/storage.yml", force: true

  providers = options[: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 = Decidim::Env.new("STORAGE_PROVIDER", "local").to_s}

  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 



385
386
387
388
389
390
391
392
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 385

def authorization_handler
  return unless options[:demo]

  copy_file "dummy_authorization_handler.rb", "app/services/dummy_authorization_handler.rb"
  copy_file "ephemeral_dummy_authorization_handler.rb", "app/services/ephemeral_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 



394
395
396
397
398
399
400
401
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 394

def budgets_workflows
  return unless options[: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 



156
157
158
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 156

def cable_yml
  template "cable.yml.erb", "config/cable.yml", force: true
end

#database_yml ⇒ Object 



139
140
141
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 139

def database_yml
  template "database.yml.erb", "config/database.yml", force: true
end

#decidim_controller ⇒ Object 



143
144
145
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 143

def decidim_controller
  template "decidim_controller.rb.erb", "app/controllers/decidim_controller.rb", force: true
end

#dev_performance_config ⇒ Object 



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 365

def dev_performance_config
  gsub_file "config/environments/development.rb", /^end\n$/, "\n      # Performance configs for local testing\n      if ENV.fetch(\"RAILS_BOOST_PERFORMANCE\", false).to_s == \"true\"\n        # Indicate boost performance mode\n        config.boost_performance = true\n        # Enable caching and eager load\n        config.eager_load = true\n        config.cache_classes = true\n        # Logging\n        config.log_level = :info\n        config.action_view.logger = nil\n        # Compress the HTML responses with gzip\n        config.middleware.use Rack::Deflater\n      end\n    end\n  CONFIG\nend\n"

#disable_annotate_rendered_view_on_development ⇒ Object 



132
133
134
135
136
137
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 132

def disable_annotate_rendered_view_on_development
  gsub_file "config/environments/development.rb", /config\.action_view\.annotate_rendered_view_with_filenames = true$/,
            "# Using annotate rendered view breaks rails-ujs functionality
  # @see https://github.com/decidim/decidim/issues/14912
  # config.action_view.annotate_rendered_view_with_filenames = true"
end

#docker ⇒ Object 



147
148
149
150
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 147

def docker
  template "Dockerfile.erb", "Dockerfile", force: true
  template "docker-compose.yml.erb", "docker-compose.yml"
end

#elections_census_manifest ⇒ Object 



403
404
405
406
407
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 403

def elections_census_manifest
  return unless options[:demo]

  copy_file "elections_initializer.rb", "config/initializers/decidim_elections.rb"
end

#etherpad ⇒ Object 



152
153
154
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 152

def etherpad
  template "docker-compose-etherpad.yml", "docker-compose-etherpad.yml"
end

#gemfile ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 180

def gemfile
  return if options[:skip_gemfile]

  if branch.present?
    get target_gemfile, "Gemfile", force: true
    append_file "Gemfile", %(\ngem "net-imap", "~> 0.5.0", group: :development)
    append_file "Gemfile", %(\ngem "net-pop", "~> 0.1.1", group: :development)
    append_file "Gemfile", %(\ngem "net-smtp", "~> 0.5.0", 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(ai collaborative_texts conferences demographics design elections initiatives templates).each do |component|
    if options[: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

#initiative_signatures_workflows ⇒ Object 



409
410
411
412
413
414
415
416
417
418
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 409

def initiative_signatures_workflows
  return unless options[:demo]

  copy_file "dummy_signature_handler.rb", "app/services/dummy_signature_handler.rb"
  copy_file "dummy_signature_handler_form.html.erb", "app/views/decidim/initiatives/initiative_signatures/dummy_signature/_form.html.erb"
  copy_file "dummy_signature_handler_form.html.erb", "app/views/decidim/initiatives/initiative_signatures/ephemeral_dummy_signature/_form.html.erb"
  copy_file "dummy_signature_handler_form.html.erb", "app/views/decidim/initiatives/initiative_signatures/dummy_signature_with_personal_data/_form.html.erb"
  copy_file "dummy_sms_mobile_phone_validator.rb", "app/services/dummy_sms_mobile_phone_validator.rb"
  copy_file "initiatives_initializer.rb", "config/initializers/decidim_initiatives.rb"
end

#install ⇒ Object 



420
421
422
423
424
425
426
427
428
429
430
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 420

def install
  Decidim::Generators::InstallGenerator.start(
    [
      "--recreate_db=#{options[:recreate_db]}",
      "--seed_db=#{options[:seed_db]}",
      "--skip_gemfile=#{options[:skip_gemfile]}",
      "--app_name=#{app_name}",
      "--profiling=#{options[:profiling]}"
    ]
  )
end

#license ⇒ Object 



164
165
166
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 164

def license
  template "LICENSE-AGPLv3.txt", "LICENSE-AGPLv3.txt"
end

#modify_gitignore ⇒ Object 



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 314

def modify_gitignore
  return if options[:skip_git]

  append_file ".gitignore", "\n    # Ignore env configuration files\n    .env\n    .envrc\n    .rbenv-vars\n\n    # Ignore the files and folders generated through Webpack\n    /public/decidim-packs\n    /public/packs-test\n    /public/sw.js\n    /public/sw.js.map\n\n    # Ignore node modules\n    /node_modules\n  GITIGNORE\nend\n"

#node_version ⇒ Object 



176
177
178
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 176

def node_version
  copy_file ".node-version", ".node-version"
end

#patch_test_file ⇒ Object 



123
124
125
126
127
128
129
130
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 123

def patch_test_file
  gsub_file "config/environments/test.rb", /config\.action_mailer\.default_url_options = { host: "www.example.com" }$/,
            "# config.action_mailer.default_url_options = { host: \"www.example.com\" }"
  gsub_file "config/environments/test.rb", /config\.action_controller\.raise_on_missing_callback_actions = true$/,
            "# config.action_controller.raise_on_missing_callback_actions = false"
  gsub_file "config/environments/development.rb", /config\.action_controller\.raise_on_missing_callback_actions = true$/,
            "# config.action_controller.raise_on_missing_callback_actions = false"
end

#production_environment ⇒ Object 



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 348

def production_environment
  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?"
  gsub_file "config/environments/production.rb", /# Log to STDOUT by default\n((.*)\n){3}/, "    if ENV[\"RAILS_LOG_TO_STDOUT\"].present?\n      config.logger = ActiveSupport::Logger.new(STDOUT)\n        .tap  { |logger| logger.formatter = ::Logger::Formatter.new }\n        .then { |logger| ActiveSupport::TaggedLogging.new(logger) }\n    end\n  CONFIG\nend\n"

#puma_ssl_options ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 296

def puma_ssl_options
  return unless options[:dev_ssl]

  append_file "config/puma.rb", "\n    # Development SSL\n    if ENV[\"DEV_SSL\"] && defined?(Bundler) && (dev_gem = Bundler.load.specs.find { |spec| spec.name == \"decidim-dev\" })\n      cert_dir = ENV.fetch(\"DEV_SSL_DIR\") { \"\\\#{dev_gem.full_gem_path}/lib/decidim/dev/assets\" }\n      ssl_bind(\n        \"0.0.0.0\",\n        ENV.fetch(\"DEV_SSL_PORT\") { 3443 },\n        cert_pem: File.read(\"\\\#{cert_dir}/ssl-cert.pem\"),\n        key_pem: File.read(\"\\\#{cert_dir}/ssl-key.pem\")\n      )\n    end\n  CONFIG\nend\n"

#readme ⇒ Object 



160
161
162
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 160

def readme
  template "README.md.erb", "README.md", force: true
end

#remove_default_error_pages ⇒ Object 



339
340
341
342
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 339

def remove_default_error_pages
  remove_file "public/404.html"
  remove_file "public/500.html"
end

#remove_default_favicon ⇒ Object 



344
345
346
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 344

def remove_default_favicon
  remove_file "public/favicon.ico"
end

#remove_old_assets ⇒ Object 



101
102
103
104
105
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 101

def remove_old_assets
  remove_file "config/initializers/assets.rb"
  remove_dir("app/assets")
  remove_dir("app/javascript")
end

#remove_sprockets_requirement ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 107

def remove_sprockets_requirement
  gsub_file "config/application.rb", %r{require ['"]rails/all['"]\R}, "    require \"decidim/rails\"\n\n    # Add the frameworks used by your app that are not loaded by Decidim.\n    # require \"action_mailbox/engine\"\n    # require \"action_text/engine\"\n    require \"action_cable/engine\"\n    require \"rails/test_unit/railtie\"\n  RUBY\n\n  gsub_file \"config/environments/development.rb\", /config\\.assets.*$/, \"\"\n  gsub_file \"config/environments/test.rb\", /config\\.assets.*$/, \"\"\n  gsub_file \"config/environments/production.rb\", /config\\.assets.*$/, \"\"\nend\n"

#rubocop ⇒ Object 



168
169
170
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 168

def rubocop
  copy_file ".rubocop.yml", ".rubocop.yml", force: true
end

#ruby_version ⇒ Object 



172
173
174
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 172

def ruby_version
  copy_file ".ruby-version", ".ruby-version", force: true
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

#tweak_csp_initializer ⇒ Object 



286
287
288
289
290
291
292
293
294
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 286

def tweak_csp_initializer
  return unless File.exist?("config/initializers/content_security_policy.rb")

  remove_file("config/initializers/content_security_policy.rb")
  create_file "config/initializers/content_security_policy.rb" do
    %(# For tuning the Content Security Policy, check the Decidim documentation site
# https://docs.decidim.org/develop/en/customize/content_security_policy)
  end
end

#webpacker_gemfile_entry ⇒ Object

we disable the webpacker installation as we will use shakapacker



97
98
99
 
# File 'decidim-generators/lib/decidim/generators/app_generator.rb', line 97

def webpacker_gemfile_entry
  []
end