decidim-generators 0.27.9 → 0.28.0.rc4

data/lib/decidim/generators/component_templates/app/controllers/decidim/component/admin/application_controller.rb.erb

@@ -9,6 +9,17 @@ module Decidim
       # Note that it inherits from `Decidim::Admin::Components::BaseController`, which
       # override its layout and provide all kinds of useful methods.
       class ApplicationController < Decidim::Admin::Components::BaseController
+        def permission_class_chain
+          [::Decidim::<%= component_module_name %>::Admin::Permissions] + super
+        end
+
+        def user_not_authorized_path
+          decidim.root_path
+        end
+
+        def user_has_no_permission_path
+          decidim.root_path
+        end
       end
     end
   end

data/lib/decidim/generators/component_templates/app/permissions/decidim/component/admin/permissions.rb.erb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module <%= component_module_name %>
+    module Admin
+      class Permissions < Decidim::DefaultPermissions
+        def permissions
+          return permission_action if permission_action.scope != :admin
+          return permission_action unless user&.admin?
+
+          allow! if can_access?
+
+          permission_action
+        end
+
+        def can_access?
+          permission_action.subject == :<%= component_name.to_sym %> &&
+            permission_action.action == :read
+        end
+      end
+    end
+  end
+end

data/lib/decidim/generators/component_templates/decidim-component.gemspec.erb

@@ -9,19 +9,21 @@ Gem::Specification.new do |s|
   s.authors = ["<%= %x[git config user.name].chomp %>"]
   s.email = ["<%= %x[git config user.email].chomp %>"]
   s.license = "AGPL-3.0"
-  s.homepage = "https://github.com/decidim/decidim-module-<%= component_name %>"
-  s.required_ruby_version = "~> <%= required_ruby_version %>"
+  s.homepage = "https://decidim.org"
+  s.metadata = {
+    "bug_tracker_uri" => "https://github.com/decidim/decidim/issues",
+    "documentation_uri" => "https://docs.decidim.org/",
+    "funding_uri" => "https://opencollective.com/decidim",
+    "homepage_uri" => "https://decidim.org",
+    "source_code_uri" => "https://github.com/decidim/decidim"
+  }
+  s.required_ruby_version = ">= <%= required_ruby_version %>"
 
   s.name = "decidim-<%= component_name %>"
   s.summary = "A decidim <%= component_name %> module"
   s.description = "<%= component_description %>."
 
-  s.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").select do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w(app/ config/ db/ lib/ LICENSE-AGPLv3.txt Rakefile README.md))
-    end
-  end
+  s.files = Dir["{app,config,lib}/**/*", "LICENSE-AGPLv3.txt", "Rakefile", "README.md"]
 
   s.add_dependency "decidim-core", Decidim::<%= component_module_name %>.version
 end

data/lib/decidim/generators/component_templates/github/ci.yml.erb

@@ -0,0 +1,77 @@
+name: "[CI] <%= component_module_name %>"
+on:
+  push:
+    branches:
+      - develop
+      - release/*
+      - "*-stable"
+  pull_request:
+    branches-ignore:
+      - "chore/l10n*"
+
+env:
+  CI: "true"
+  RUBY_VERSION: <%= RUBY_VERSION %>
+  NODE_VERSION: 18.17.1
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  main:
+    name: Tests
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    services:
+      postgres:
+        image: postgres:14
+        ports: ["5432:5432"]
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        env:
+          POSTGRES_PASSWORD: postgres
+    env:
+      DATABASE_USERNAME: postgres
+      DATABASE_PASSWORD: postgres
+      DATABASE_HOST: localhost
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: Get npm cache directory path
+        id: npm-cache-dir-path
+        run: echo "dir=$(npm get cache)-<%= component_name %>" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v3
+        id: npm-cache
+        with:
+          path: ${{ steps.npm-cache-dir-path.outputs.dir }}
+          key: npm-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            npm-
+      - run: bundle exec rake test_app
+        name: Create test app
+      - run: mkdir -p ./spec/decidim_dummy_app/tmp/screenshots
+        name: Create the screenshots folder
+      - uses: nanasess/setup-chromedriver@v2
+      - run: RAILS_ENV=test bundle exec rails assets:precompile
+        name: Precompile assets
+        working-directory: ./spec/decidim_dummy_app/
+      - run: bundle exec rspec
+        name: RSpec
+      - uses: codecov/codecov-action@v3
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: screenshots
+          path: ./spec/decidim_dummy_app/tmp/screenshots
+          if-no-files-found: ignore

data/lib/decidim/generators/component_templates/gitignore

@@ -10,6 +10,11 @@
 # rspec failure tracking
 .rspec-failures
 
+# env configuration files
+.env
+.envrc
+.rbenv-vars
+
 # default test application
 spec/decidim_dummy_app
 

data/lib/decidim/generators/component_templates/lib/decidim/component/test/factories.rb.erb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "decidim/components/namer"
 require "decidim/core/test/factories"
 
 FactoryBot.define do

data/lib/decidim/generators/component_templates/package.json.erb

@@ -0,0 +1,21 @@
+{
+  "name": "decidim-<%= component_name %>",
+  "version": "0.0.1",
+  "description": <%= JSON.generate(component_description || "") %>,
+  "private": true,
+  "license": "AGPL-3.0",
+  "scripts": {
+    "lint": "eslint -c .eslintrc.json --no-error-on-unmatched-pattern --ignore-pattern app/packs/vendor --ext .js app/packs",
+    "stylelint": "stylelint app/packs/**/*.scss"
+  },
+  "dependencies": {
+    "@decidim/browserslist-config": "<%= npm_package_version %>",
+    "@decidim/webpacker": "<%= npm_package_version %>"
+  },
+  "devDependencies": {
+    "@decidim/dev": "<%= npm_package_version %>",
+    "@decidim/eslint-config": "<%= npm_package_version %>",
+    "@decidim/stylelint-config": "<%= npm_package_version %>"
+  },
+  "browserslist": ["extends @decidim/browserslist-config"]
+}

data/lib/decidim/generators/component_templates/spec/lib/version_spec.rb.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim
+  describe <%= component_module_name %> do
+    subject { described_class }
+
+    it "has version" do
+      expect(subject.version).to eq("<%= core_version %>")
+    end
+  end
+end

data/lib/decidim/generators/component_templates/spec/permissions/admin/permissions_spec.rb.erb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module Decidim::<%= component_module_name %>::Admin
+  describe Permissions do
+    subject { described_class.new(user, permission_action, context).permissions.allowed? }
+
+    let(:organization) { create :organization }
+    let(:context) do
+      {
+        current_organization: organization
+      }
+    end
+    let(:action) do
+      { scope: :admin, action: :read, subject: :<%= component_name.to_sym %> }
+    end
+    let(:permission_action) { Decidim::PermissionAction.new(**action) }
+
+    context "when user is admin" do
+      let(:user) { create :user, :admin, organization: organization }
+
+      it { is_expected.to be_truthy }
+
+      context "when scope is not admin" do
+        let(:action) do
+          { scope: :foo, action: :read, subject: :<%= component_name.to_sym %> }
+        end
+
+        it_behaves_like "permission is not set"
+      end
+    end
+
+    context "when user is not admin" do
+      let(:user) { create :user, organization: organization }
+
+      it_behaves_like "permission is not set"
+    end
+  end
+end

data/lib/decidim/generators/install_generator.rb

@@ -28,7 +28,7 @@ module Decidim
 
       class_option :skip_gemfile, type: :boolean,
                                   default: false,
-                                  desc: "Don't generate a Gemfile for the application"
+                                  desc: "Do not generate a Gemfile for the application"
 
       class_option :profiling, type: :boolean,
                                default: false,
@@ -40,14 +40,13 @@ module Decidim
 
       def add_seeds
         append_file "db/seeds.rb", <<~RUBY
-          # You can remove the 'faker' gem if you don't want Decidim seeds.
+          # You can remove the 'faker' gem if you do not want Decidim seeds.
           Decidim.seed!
         RUBY
       end
 
       def copy_initializer
         copy_file "carrierwave.rb", "config/initializers/carrierwave.rb"
-        copy_file "social_share_button.rb", "config/initializers/social_share_button.rb"
       end
 
       def secrets
@@ -79,9 +78,8 @@ module Decidim
       end
 
       def install_decidim_webpacker
-        # Copy CSS files
+        # Copy CSS file
         copy_file "decidim_application.scss", "app/packs/stylesheets/decidim/decidim_application.scss"
-        copy_file "_decidim-settings.scss", "app/packs/stylesheets/decidim/_decidim-settings.scss"
 
         # Copy JS application file
         copy_file "decidim_application.js", "app/packs/src/decidim/decidim_application.js"
@@ -94,10 +92,17 @@ module Decidim
         # Regenerate webpacker binstubs
         remove_file "bin/yarn"
         bundle_install
-        rails "webpacker:binstubs"
+        rails "shakapacker:binstubs"
 
         # Run Decidim custom webpacker installation
         rails "decidim:webpacker:install"
+
+        # Run Decidim custom procfile installation
+        rails "decidim:procfile:install"
+
+        # Replace robots.txt
+        remove_file "public/robots.txt"
+        rails "decidim:robots:replace"
       end
 
       def build_api_docs
@@ -185,7 +190,7 @@ module Decidim
         rails "db:test:prepare"
       end
 
-      # Runs rails commands in a subprocess, and aborts if it doesn't suceeed
+      # Runs rails commands in a subprocess, and aborts if it does not suceeed
       def rails(*args)
         abort unless system("bin/rails", *args)
       end

data/lib/decidim/generators/test/generator_examples.rb

@@ -1,12 +1,47 @@
 # frozen_string_literal: true
 
+shared_context "when generating a new application" do
+  let(:env) do |example|
+    #
+    # When tracking coverage, make sure the ruby environment points to the
+    # local version, so we get the benefits of running `decidim` directly
+    # without `bundler` (more realistic test), but also get code coverage
+    # properly measured (we track coverage on the local version and not on the
+    # installed version).
+    #
+    if ENV["SIMPLECOV"]
+      {
+        "RUBYOPT" => "-rsimplecov #{ENV.fetch("RUBYOPT", nil)}",
+        "RUBYLIB" => "#{repo_root}/decidim-generators/lib:#{ENV.fetch("RUBYLIB", nil)}",
+        "PATH" => "#{repo_root}/decidim-generators/exe:#{ENV.fetch("PATH", nil)}",
+        "COMMAND_NAME" => example.full_description.tr(" ", "_")
+      }
+    else
+      {}
+    end
+  end
+
+  let(:result) do
+    Bundler.with_original_env { Decidim::GemManager.capture(command, env:) }
+  end
+
+  # rubocop:disable RSpec/BeforeAfterAll
+  before(:all) do
+    Bundler.with_original_env { Decidim::GemManager.install_all(out: File::NULL) }
+  end
+
+  after(:all) do
+    Bundler.with_original_env { Decidim::GemManager.uninstall_all(out: File::NULL) }
+  end
+  # rubocop:enable RSpec/BeforeAfterAll
+end
+
 shared_examples_for "a new production application" do
   it "includes optional plugins commented out in Gemfile" do
     expect(result[1]).to be_success, result[0]
 
     expect(File.read("#{test_app}/Gemfile"))
       .to match(/^# gem "decidim-initiatives"/)
-      .and match(/^# gem "decidim-consultations"/)
       .and match(/^# gem "decidim-elections"/)
       .and match(/^# gem "decidim-conferences"/)
       .and match(/^# gem "decidim-templates"/)
@@ -19,7 +54,6 @@ shared_examples_for "a new development application" do
 
     expect(File.read("#{test_app}/Gemfile"))
       .to match(/^gem "decidim-initiatives"/)
-      .and match(/^gem "decidim-consultations"/)
       .and match(/^gem "decidim-elections"/)
       .and match(/^gem "decidim-conferences"/)
       .and match(/^gem "decidim-templates"/)
@@ -44,7 +78,7 @@ shared_examples_for "a new development application" do
     end
 
     # Check that important node modules were installed
-    expect(Pathname.new("#{test_app}/node_modules/@rails/webpacker")).to be_directory
+    expect(Pathname.new("#{test_app}/node_modules/shakapacker")).to be_directory
 
     # Check that the configuration tweaks are applied properly
     expect(File.read("#{test_app}/config/spring.rb")).to match(%r{^require "decidim/spring"})
@@ -166,7 +200,8 @@ shared_context "with application env vars" do
       "DECIDIM_SESSION_TIMEOUT_INTERVAL" => "33",
       "DECIDIM_FOLLOW_HTTP_X_FORWARDED_HOST" => "true",
       "DECIDIM_MAXIMUM_CONVERSATION_MESSAGE_LENGTH" => "1234",
-      "DECIDIM_PASSWORD_BLACKLIST" => "i-dont-like-this-password, i-dont,like,this,one,either, password123456",
+      "DECIDIM_PASSWORD_SIMILARITY_LENGTH" => "4",
+      "DECIDIM_DENIED_PASSWORDS" => "i-do-not-like-this-password, i-do-not,like,this,one,either, password123456",
       "DECIDIM_ALLOW_OPEN_REDIRECTS" => "true",
       "DECIDIM_ADMIN_PASSWORD_EXPIRATION_DAYS" => "93",
       "DECIDIM_ADMIN_PASSWORD_MIN_LENGTH" => "18",
@@ -195,7 +230,6 @@ shared_context "with application env vars" do
       "MEETINGS_EMBEDDABLE_SERVICES" => "www.youtube.com www.twitch.tv meet.jit.si 8x8.vc",
       "BUDGETS_ENABLE_PROPOSAL_LINKING" => "false",
       "ACCOUNTABILITY_ENABLE_PROPOSAL_LINKING" => "false",
-      "CONSULTATIONS_STATS_CACHE_EXPIRATION_TIME" => "7",
       "INITIATIVES_CREATION_ENABLED" => "false",
       "INITIATIVES_SIMILARITY_THRESHOLD" => "0.99",
       "INITIATIVES_SIMILARITY_LIMIT" => "10",
@@ -288,7 +322,8 @@ shared_examples_for "an application with configurable env vars" do
       %w(decidim session_timeout_interval) => 10,
       %w(decidim follow_http_x_forwarded_host) => false,
       %w(decidim maximum_conversation_message_length) => 1000,
-      %w(decidim password_blacklist) => [],
+      %w(decidim password_similarity_length) => 4,
+      %w(decidim denied_passwords) => [],
       %w(decidim allow_open_redirects) => false,
       %w(decidim admin_password expiration_days) => 90,
       %w(decidim admin_password min_length) => 15,
@@ -323,7 +358,6 @@ shared_examples_for "an application with configurable env vars" do
       %w(decidim meetings embeddable_services) => [],
       %w(decidim budgets enable_proposal_linking) => "auto",
       %w(decidim accountability enable_proposal_linking) => "auto",
-      %w(decidim consultations stats_cache_expiration_time) => 5,
       %w(decidim initiatives creation_enabled) => "auto",
       %w(decidim initiatives similarity_threshold) => 0.25,
       %w(decidim initiatives similarity_limit) => 5,
@@ -336,7 +370,7 @@ shared_examples_for "an application with configurable env vars" do
       %w(decidim initiatives max_time_in_validating_state) => 60,
       %w(decidim initiatives print_enabled) => "auto",
       %w(decidim initiatives do_not_require_authorization) => false,
-      %w(elections setup_minimum_hours_before_start) => 3,
+      %w(elections setup_minimum_hours_before_start) => 1,
       %w(elections start_vote_maximum_hours_before_start) => 6,
       %w(elections voter_token_expiration_minutes) => 120,
       %w(elections votings check_census_max_requests) => 5,
@@ -392,7 +426,8 @@ shared_examples_for "an application with configurable env vars" do
       %w(decidim session_timeout_interval) => 33,
       %w(decidim follow_http_x_forwarded_host) => true,
       %w(decidim maximum_conversation_message_length) => 1234,
-      %w(decidim password_blacklist) => ["i-dont-like-this-password", "i-dont,like,this,one,either", "password123456"],
+      %w(decidim password_similarity_length) => 4,
+      %w(decidim denied_passwords) => ["i-do-not-like-this-password", "i-do-not,like,this,one,either", "password123456"],
       %w(decidim allow_open_redirects) => true,
       %w(decidim admin_password expiration_days) => 93,
       %w(decidim admin_password min_length) => 18,
@@ -427,7 +462,6 @@ shared_examples_for "an application with configurable env vars" do
       %w(decidim meetings embeddable_services) => %w(www.youtube.com www.twitch.tv meet.jit.si 8x8.vc),
       %w(decidim budgets enable_proposal_linking) => false,
       %w(decidim accountability enable_proposal_linking) => false,
-      %w(decidim consultations stats_cache_expiration_time) => 7,
       %w(decidim initiatives creation_enabled) => false,
       %w(decidim initiatives similarity_threshold) => 0.99,
       %w(decidim initiatives similarity_limit) => 10,
@@ -486,7 +520,8 @@ shared_examples_for "an application with configurable env vars" do
       "session_timeout_interval" => 10,
       "follow_http_x_forwarded_host" => false,
       "maximum_conversation_message_length" => 1000,
-      "password_blacklist" => [],
+      "password_similarity_length" => 4,
+      "denied_passwords" => [],
       "allow_open_redirects" => false,
       "etherpad" => nil,
       "maps" => nil
@@ -522,7 +557,8 @@ shared_examples_for "an application with configurable env vars" do
       "session_timeout_interval" => 33,
       "follow_http_x_forwarded_host" => true,
       "maximum_conversation_message_length" => 1234,
-      "password_blacklist" => ["i-dont-like-this-password", "i-dont,like,this,one,either", "password123456"],
+      "password_similarity_length" => 4,
+      "denied_passwords" => ["i-do-not-like-this-password", "i-do-not,like,this,one,either", "password123456"],
       "allow_open_redirects" => true,
       "etherpad" => {
         "server" => "http://a-etherpad-server.com",
@@ -833,18 +869,6 @@ end
 shared_examples_for "an application with extra configurable env vars" do
   include_context "with application env vars"
 
-  let(:consultations_initializer_off) do
-    {
-      "stats_cache_expiration_time" => 300 # 5.minutes
-    }
-  end
-
-  let(:consultations_initializer_on) do
-    {
-      "stats_cache_expiration_time" => 420 # 7.minutes
-    }
-  end
-
   let(:initiatives_initializer_off) do
     {
       "creation_enabled" => true,
@@ -857,7 +881,7 @@ shared_examples_for "an application with extra configurable env vars" do
       "second_notification_percentage" => 66,
       "stats_cache_expiration_time" => 300, # 5.minutes
       "max_time_in_validating_state" => 5_184_000, # 60.days
-      "print_enabled" => true,
+      "print_enabled" => false,
       "do_not_require_authorization" => false
     }
   end
@@ -881,7 +905,7 @@ shared_examples_for "an application with extra configurable env vars" do
 
   let(:elections_initializer_off) do
     {
-      "setup_minimum_hours_before_start" => 3,
+      "setup_minimum_hours_before_start" => 1,
       "start_vote_maximum_hours_before_start" => 6,
       "voter_token_expiration_minutes" => 120
     }
@@ -924,20 +948,6 @@ shared_examples_for "an application with extra configurable env vars" do
   it "env vars generate secrets application" do
     expect(result[1]).to be_success, result[0]
 
-    # Test onto the initializer with ENV vars OFF for the Consultations module
-    json_off = initializer_config_for(test_app, env_off, "Decidim::Consultations")
-    consultations_initializer_off.each do |key, value|
-      current = json_off[key]
-      expect(current).to eq(value), "Consultations Initializer (#{key}) = (#{current}) expected to match Env (#{value})"
-    end
-
-    # Test onto the initializer with ENV vars ON for the Consultations module
-    json_on = initializer_config_for(test_app, env_on, "Decidim::Consultations")
-    consultations_initializer_on.each do |key, value|
-      current = json_on[key]
-      expect(current).to eq(value), "Consultations Initializer (#{key}) = (#{current}) expected to match Env (#{value})"
-    end
-
     # Test onto the initializer with ENV vars OFF for the Initiatives module
     json_off = initializer_config_for(test_app, env_off, "Decidim::Initiatives")
     initiatives_initializer_off.each do |key, value|
@@ -1072,3 +1082,25 @@ shared_examples_for "an application with storage and queue gems" do
     expect(current["queues"].flatten).to include(*queues), "sidekiq queues (#{current["queues"].flatten}) expected to eq containt (#{queues})"
   end
 end
+
+def json_secrets_for(path, env)
+  JSON.parse cmd_capture(path, "bin/rails runner 'puts Rails.application.secrets.to_json'", env:)
+end
+
+def initializer_config_for(path, env, mod = "Decidim")
+  JSON.parse cmd_capture(path, "bin/rails runner 'puts #{mod}.config.to_json'", env:)
+end
+
+def rails_value(value, path, env)
+  JSON.parse cmd_capture(path, "bin/rails runner 'puts #{value}.to_json'", env:)
+end
+
+def repo_root
+  File.expand_path(File.join("..", "..", "..", "..", ".."), __dir__)
+end
+
+def cmd_capture(path, cmd, env: {})
+  Bundler.with_unbundled_env do
+    Decidim::GemManager.new(path).capture(cmd, env:, with_stderr: false)[0]
+  end
+end

data/lib/decidim/generators/version.rb

@@ -4,7 +4,7 @@
 module Decidim
   module Generators
     def self.version
-      "0.27.9"
+      "0.28.0.rc4"
     end
   end
 end