Class: Decidim::Generators::AppGenerator

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



333
334
335
 
# File 'lib/decidim/generators/app_generator.rb', line 333

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 



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

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 



225
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
 
# File 'lib/decidim/generators/app_generator.rb', line 225

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 <<~RUBY
    authenticate :user, ->(u) { u.admin? } do
      mount Sidekiq::Web => "/sidekiq"
    end
  RUBY

  redis_version = begin
    require "redis"
    ver = Redis.new.call("INFO").lines(chomp: true).find { |l| l.start_with?("redis_version:") }.split(":", 2).last
    Gem::Version.new(ver)
  rescue LoadError, Redis::CannotConnectError
    # This does not have to be the actual Redis version, it can be
    # anything that is above any of the version checks below to default to
    # the latest Sidekiq version.
    Gem::Version.new("8.0.0")
  end

  if redis_version < Gem::Version.new("6.2.0")
    # Sidekiq 7.x requires Redis 6.2.0 or newer
    append_file "Gemfile", %(gem "sidekiq", "~> 6.5")
  elsif redis_version < Gem::Version.new("7.0.0")
    # Sidekiq 8.x requires Redis 7.0.0 or newer
    append_file "Gemfile", %(gem "sidekiq", "~> 7.3")
  else
    # Assume latest
    append_file "Gemfile", %(gem "sidekiq")
  end
end

#add_storage_provider ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File '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 or gcs") unless (providers - %w(local s3 gcs)).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 "google-cloud-storage", "~> 1.11", require: false if providers.include?("gcs")
  end
end

#authorization_handler ⇒ Object 



379
380
381
382
383
384
385
386
 
# File 'lib/decidim/generators/app_generator.rb', line 379

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 



388
389
390
391
392
393
394
395
 
# File 'lib/decidim/generators/app_generator.rb', line 388

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 '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 '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 '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 



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/decidim/generators/app_generator.rb', line 355

def dev_performance_config
  gsub_file "config/environments/development.rb", /^end\n$/, <<~CONFIG

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

#disable_annotate_rendered_view_on_development ⇒ Object 



132
133
134
135
136
137
 
# File '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 '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 



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

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 '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 '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 



403
404
405
406
407
408
409
410
411
412
 
# File 'lib/decidim/generators/app_generator.rb', line 403

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 



414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/decidim/generators/app_generator.rb', line 414

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 'lib/decidim/generators/app_generator.rb', line 164

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

#modify_gitignore ⇒ Object 



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

def modify_gitignore
  return if options[: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*

    # Ignore node modules
    /node_modules
  GITIGNORE
end

#node_version ⇒ Object 



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

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

#patch_controller ⇒ Object 



375
376
377
 
# File 'lib/decidim/generators/app_generator.rb', line 375

def patch_controller
  gsub_file "app/controllers/application_controller.rb", /\n  stale_when_importmap_changes/, ""
end

#patch_production_file ⇒ Object 



122
123
124
125
 
# File 'lib/decidim/generators/app_generator.rb', line 122

def patch_production_file
  gsub_file "config/environments/production.rb", /config\.action_mailer\.default_url_options = { host: "example.com" }$/,
            "# config.action_mailer.default_url_options = { host: \"example.com\" }"
end

#patch_test_file ⇒ Object 



127
128
129
130
 
# File 'lib/decidim/generators/app_generator.rb', line 127

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

#production_environment ⇒ Object 



346
347
348
349
350
351
352
353
 
# File 'lib/decidim/generators/app_generator.rb', line 346

def production_environment
  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", /config\.logger\s*=\s*ActiveSupport::TaggedLogging\.logger\(STDOUT\)/, <<~CONFIG
    config.logger   = ActiveSupport::TaggedLogging.logger(STDOUT) if ENV["RAILS_LOG_TO_STDOUT"].present?
  CONFIG
end

#puma_ssl_options ⇒ Object 



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

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



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

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

#remove_default_error_pages ⇒ Object 



337
338
339
340
 
# File 'lib/decidim/generators/app_generator.rb', line 337

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

#remove_default_favicon ⇒ Object 



342
343
344
 
# File 'lib/decidim/generators/app_generator.rb', line 342

def remove_default_favicon
  remove_file "public/favicon.ico"
end

#remove_old_assets ⇒ Object 



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

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

#remove_old_github_files ⇒ Object 



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

def remove_old_github_files
  remove_dir(".github")
end

#remove_sprockets_requirement ⇒ Object 



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

def remove_sprockets_requirement
  gsub_file "config/application.rb", %r{require ['"]rails/all['"]\R}, <<~RUBY
    require "decidim/rails"

    # Add the frameworks used by your app that are not loaded by Decidim.
    # require "action_mailbox/engine"
    # require "action_text/engine"
    require "action_cable/engine"
    require "rails/test_unit/railtie"
  RUBY

  gsub_file "config/environments/development.rb", /config\.assets.*$/, ""
  gsub_file "config/environments/test.rb", /config\.assets.*$/, ""
  gsub_file "config/environments/production.rb", /config\.assets.*$/, ""
end

#rubocop ⇒ Object 



168
169
170
 
# File '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 '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 '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 



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

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/en/develop/customize/content_security_policy)
  end
end