decidim-department_admin 0.7.2

data/config/i18n-tasks.yml

@@ -0,0 +1,148 @@
+# i18n-tasks finds and manages missing and unused translations: https://github.com/glebm/i18n-tasks
+
+# The "main" locale.
+base_locale: en
+## All available locales are inferred from the data by default. Alternatively, specify them explicitly:
+# locales: [es, fr]
+## Reporting locale, default: en. Available: en, ru.
+# internal_locale: en
+
+# Read and write translations.
+data:
+  ## Translations are read from the file system. Supported format: YAML, JSON.
+  ## Provide a custom adapter:
+  # adapter: I18n::Tasks::Data::FileSystem
+
+  # Locale files or `File.find` patterns where translations are read from:
+  read:
+    ## Default:
+    # - config/locales/%{locale}.yml
+    ## More files:
+    # - config/locales/**/*.%{locale}.yml
+
+  # Locale files to write new keys to, based on a list of key pattern => file rules. Matched from top to bottom:
+  # `i18n-tasks normalize -p` will force move the keys according to these rules
+  write:
+    ## For example, write devise and simple form keys to their respective files:
+    # - ['{devise, simple_form}.*', 'config/locales/\1.%{locale}.yml']
+    ## Catch-all default:
+    # - config/locales/%{locale}.yml
+
+  # External locale data (e.g. gems).
+  # This data is not considered unused and is never written to.
+  external:
+    ## Example (replace %#= with %=):
+    # - "<%#= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml"
+
+  ## Specify the router (see Readme for details). Valid values: conservative_router, pattern_router, or a custom class.
+  # router: conservative_router
+
+  yaml:
+    write:
+      # do not wrap lines at 80 characters
+      line_width: -1
+
+  ## Pretty-print JSON:
+  # json:
+  #   write:
+  #     indent: '  '
+  #     space: ' '
+  #     object_nl: "\n"
+  #     array_nl: "\n"
+
+# Find translate calls
+search:
+  ## Paths or `File.find` patterns to search in:
+  # paths:
+  #  - app/
+
+  ## Root directories for relative keys resolution.
+  # relative_roots:
+  #   - app/controllers
+  #   - app/helpers
+  #   - app/mailers
+  #   - app/presenters
+  #   - app/views
+
+  ## Files or `File.fnmatch` patterns to exclude from search. Some files are always excluded regardless of this setting:
+  ##   %w(*.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less *.yml *.json)
+  exclude:
+    - app/assets/images
+    - app/assets/fonts
+    - app/assets/videos
+    - app/views/decidim/admin/users/_form.html.erb
+
+  ## Alternatively, the only files or `File.fnmatch patterns` to search in `paths`:
+  ## If specified, this settings takes priority over `exclude`, but `exclude` still applies.
+  # only: ["*.rb", "*.html.slim"]
+
+  ## If `strict` is `false`, guess usages such as t("categories.#{category}.title"). The default is `true`.
+  # strict: true
+
+  ## Multiple scanners can be used. Their results are merged.
+  ## The options specified above are passed down to each scanner. Per-scanner options can be specified as well.
+  ## See this example of a custom scanner: https://github.com/glebm/i18n-tasks/wiki/A-custom-scanner-example
+
+## Translation Services
+# translation:
+#   # Google Translate
+#   # Get an API key and set billing info at https://code.google.com/apis/console to use Google Translate
+#   google_translate_api_key: "AbC-dEf5"
+#   # DeepL Pro Translate
+#   # Get an API key and subscription at https://www.deepl.com/pro to use DeepL Pro
+#   deepl_api_key: "48E92789-57A3-466A-9959-1A1A1A1A1A1A"
+
+## Do not consider these keys missing:
+# ignore_missing:
+# - 'errors.messages.{accepted,blank,invalid,too_short,too_long}'
+# - '{devise,simple_form}.*'
+
+## Consider these keys used:
+ignore_unused:
+# - 'activerecord.attributes.*'
+# - '{devise,kaminari,will_paginate}.*'
+# - 'simple_form.{yes,no}'
+# - 'simple_form.{placeholders,hints,labels}.*'
+# - 'simple_form.{error_notification,required}.:'
+- 'decidim.admin.models.user.fields.roles.department_admin'
+- 'decidim.admin.users.form.area'
+- 'decidim.components.department_admin.name'
+- 'decidim.admin.models.user.fields.roles.department_admin'
+- 'decidim.admin.users.form.area'
+- 'decidim.components.department_admin.name'
+- 'decidim.admin.models.user.fields.roles.department_admin'
+- 'decidim.admin.users.form.area'
+- 'decidim.components.department_admin.name'
+- 'decidim.admin.shared.filters.filter.all'
+- 'decidim.admin.shared.filters.filter_by'
+- 'decidim.admin.users.index.filter.all'
+- 'decidim.admin.users.index.filter_by'
+- 'decidim.admin.users.index.search'
+
+## Exclude these keys from the `i18n-tasks eq-base' report:
+# ignore_eq_base:
+#   all:
+#     - common.ok
+#   fr,es:
+#     - common.brand
+
+## Exclude these keys from the `i18n-tasks check-consistent-interpolations` report:
+# ignore_inconsistent_interpolations:
+# - 'activerecord.attributes.*'
+
+## Ignore these keys completely:
+# ignore:
+#  - kaminari.*
+
+## Sometimes, it isn't possible for i18n-tasks to match the key correctly,
+## e.g. in case of a relative key defined in a helper method.
+## In these cases you can use the built-in PatternMapper to map patterns to keys, e.g.:
+#
+# <%# I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+#       only: %w(*.html.haml *.html.slim),
+#       patterns: [['= title\b', '.page_title']] %>
+#
+# The PatternMapper can also match key literals via a special %{key} interpolation, e.g.:
+#
+# <%# I18n::Tasks.add_scanner 'I18n::Tasks::Scanners::PatternMapper',
+#       patterns: [['\bSpree\.t[( ]\s*%{key}', 'spree.%{key}']] %>

data/config/initializers/user_roles.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+Decidim.user_roles << "department_admin"
+Decidim.user_roles.uniq!

data/config/locales/ca.yml

@@ -0,0 +1,61 @@
+---
+ca:
+  decidim:
+    admin:
+      models:
+        assembly:
+          fields:
+            assembly_role: Rol consell
+            department: Departament/Àrea
+            department_role: Rol departament
+        conference:
+          fields:
+            conference_role: Rol jornada
+            department: Departament/Àrea
+            department_role: Rol department
+        participatory_process:
+          fields:
+            department: Departament/Àrea
+            department_role: Rol departament
+            process_role: Rol procés
+        user:
+          fields:
+            administrated_spaces: Espais administrats
+            assembly_type: Consell
+            created_at: Data de creació
+            department: Departament/Àrea
+            private: Privat
+            process_type: Procés
+            published: Publicat
+            roles:
+              assembly_admin: Administradora de consell
+              department_admin: Administradora de departament
+              process_admin: Administradora de procés
+              space_admin: Administradora d'espai
+            search_field_admins: Administradores
+            search_field_processes: Processos
+            search_question: Què estàs cercant?
+            spaces: Procés / Normativa / Consell
+            title: Titol
+            type: Tipus
+      shared:
+        filters:
+          filter:
+            all: Totes
+          filter_by: Filtra per
+      users:
+        form:
+          area: Àrea
+        index:
+          filter:
+            all: Totes
+          filter_by: Filtra per
+          search: Cerca
+    components:
+      department_admin:
+        name: Admin de Departament
+    conferences:
+      admin:
+        conferences:
+          form:
+            select_an_area: Selecciona una Àrea

data/config/locales/cs.yml

@@ -0,0 +1,46 @@
+---
+cs:
+  decidim:
+    admin:
+      models:
+        assembly:
+          fields:
+            assembly_role: Role ve shromáždění
+            department: Oddělení / oblast
+            department_role: Role oddělení
+        participatory_process:
+          fields:
+            department: Oddělení / oblast
+            department_role: Role oddělení
+            process_role: Role procesu
+        user:
+          fields:
+            administrated_spaces: Spravované prostory
+            assembly_type: Shromáždění
+            created_at: Vytvořeno v
+            department: Oddělení / oblast
+            private: Soukromí
+            process_type: Proces
+            published: Publikováno
+            roles:
+              assembly_admin: Správce shromáždění
+              department_admin: Správce oddělení
+              process_admin: Správce procesu
+              space_admin: Správce prostoru
+            search_field_admins: Správci
+            search_field_processes: Procesy
+            search_question: Co hledáte?
+            spaces: Proces / Pravidlo / Shromáždění
+            title: Název
+            type: Typ
+      users:
+        form:
+          area: Oblast
+        index:
+          filter:
+            all: Vše
+          filter_by: filtrovat podle
+          search: Hledat
+    components:
+      department_admin:
+        name: Správce oddělení

data/config/locales/en.yml

@@ -0,0 +1,61 @@
+---
+en:
+  decidim:
+    admin:
+      models:
+        assembly:
+          fields:
+            assembly_role: Assembly role
+            department: Department/Area
+            department_role: Department role
+        conference:
+          fields:
+            conference_role: Conference role
+            department: Department/Area
+            department_role: Department role
+        participatory_process:
+          fields:
+            department: Department/Area
+            department_role: Department role
+            process_role: Process role
+        user:
+          fields:
+            administrated_spaces: Administrated spaces
+            assembly_type: Assemby
+            created_at: Created at
+            department: Department/Area
+            private: Private
+            process_type: Process
+            published: Published
+            roles:
+              assembly_admin: Assembly Administrator
+              department_admin: Department Administrator
+              process_admin: Process Administrator
+              space_admin: Space Administrator
+            search_field_admins: Administrators
+            search_field_processes: Processes
+            search_question: What are you looking for?
+            spaces: Process / Regulations / Assemblies
+            title: Title
+            type: Type
+      shared:
+        filters:
+          filter:
+            all: All
+          filter_by: Filter by
+      users:
+        form:
+          area: Area
+        index:
+          filter:
+            all: All
+          filter_by: Filter by
+          search: Search
+    components:
+      department_admin:
+        name: Department Admin
+    conferences:
+      admin:
+        conferences:
+          form:
+            select_an_area: Select an area

data/config/locales/es.yml

@@ -0,0 +1,61 @@
+---
+es:
+  decidim:
+    admin:
+      models:
+        assembly:
+          fields:
+            assembly_role: Rol consejo
+            department: Departamento/Area
+            department_role: Rol departamento
+        conference:
+          fields:
+            conference_role: Rol jornada
+            department: Departamento/Area
+            department_role: Rol departamento
+        participatory_process:
+          fields:
+            department: Departamento/Area
+            department_role: Rol departamento
+            process_role: Rol proceso
+        user:
+          fields:
+            administrated_spaces: Espacios administrados
+            assembly_type: Consejo
+            created_at: Data de creación
+            department: Departamento/Área
+            private: Privado
+            process_type: Proceso
+            published: Publicado
+            roles:
+              assembly_admin: Administradora de consejo
+              department_admin: Administradora de departamento
+              process_admin: Administradora de proceso
+              space_admin: Administradora de espacio
+            search_field_admins: Administradoras
+            search_field_processes: Procesos
+            search_question: Que estás buscando?
+            spaces: Procesos / Normativas / Consejo
+            title: Título
+            type: Tipo
+      shared:
+        filters:
+          filter:
+            all: Todas
+          filter_by: Filtrado por
+      users:
+        form:
+          area: Area
+        index:
+          filter:
+            all: Todas
+          filter_by: Filtrado por
+          search: Buscar
+    components:
+      department_admin:
+        name: Admin de Departamento
+    conferences:
+      admin:
+        conferences:
+          form:
+            select_an_area: Selecciona una Area

data/db/migrate/20190328130102_create_department_admin_areas.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class CreateDepartmentAdminAreas < ActiveRecord::Migration[5.2]
+  def change
+    create_table :department_admin_areas do |t|
+      t.belongs_to :decidim_user, foreign_key: true
+      t.belongs_to :decidim_area, foreign_key: true
+    end
+  end
+end

data/db/migrate/20210420143021_add_area_to_conferences.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddAreaToConferences < ActiveRecord::Migration[5.2]
+  def change
+    add_reference :decidim_conferences, :decidim_area, index: true if Decidim::DepartmentAdmin.conferences_defined?
+  end
+end

data/lib/decidim/department_admin/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DepartmentAdmin
+    # This module contains all the domain logic associated to Decidim's DepartmentAdmin
+    # component admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/department_admin/admin_engine.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module DepartmentAdmin
+    # This is the engine that runs on the public interface of `DepartmentAdmin`.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::DepartmentAdmin::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        # Add admin engine routes here
+        # resources :department_admin do
+        #   collection do
+        #     resources :exports, only: [:create]
+        #   end
+        # end
+        # root to: "department_admin#index"
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/department_admin/engine.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require "rails"
+require "decidim/core"
+
+module Decidim
+  module DepartmentAdmin
+    # This is the engine that runs on the public interface of department_admin.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::DepartmentAdmin
+
+      # make decorators autoload in development env
+      config.autoload_paths << File.join(
+        Decidim::DepartmentAdmin::Engine.root, "app", "decorators", "{**}"
+      )
+
+      routes do
+        # Add engine routes here
+        # resources :department_admin
+        # root to: "department_admin#index"
+      end
+
+      initializer "department_admin.webpacker.assets_path" do
+        Decidim.register_assets_path File.expand_path("app/packs", root)
+      end
+
+      # rubocop: disable Lint/ConstantDefinitionInBlock
+      initializer "department_admin.permissions_registry" do
+        # activate Decidim LayoutHelper for the overriden views
+        ::Decidim::Admin::ApplicationController.helper ::Decidim::LayoutHelper
+        ::Decidim::ApplicationController.helper ::Decidim::LayoutHelper
+
+        # avoid webpacker to crash when executing before Decidim is loaded
+        next unless Rails.env.test? || defined? DecidimController
+
+        # **
+        # Modify decidim-admin permissions registry
+        # **
+        artifact = ::Decidim::Admin::ApplicationController
+        AdminApplicationControllerPermissions = Class.new(::Decidim::DepartmentAdmin::Permissions)
+        register_new_permissions_for(artifact, AdminApplicationControllerPermissions)
+
+        # **
+        # Modify decidim-particypatory_processes permissions registry
+        # **
+
+        # force the concern to be included so that registry is initialized
+        # we choose some random class already including it
+        require "decidim/participatory_processes/admin/categories_controller"
+        require "decidim/participatory_processes/admin/components_controller"
+        artifact = ::Decidim::ParticipatoryProcesses::Admin::Concerns::ParticipatoryProcessAdmin
+        ParticipatoryProcessesAdminConcernPermissions = Class.new(::Decidim::DepartmentAdmin::Permissions)
+        register_new_permissions_for(artifact, ParticipatoryProcessesAdminConcernPermissions)
+
+        artifact = Decidim::ParticipatoryProcesses::Admin::ApplicationController
+        ParticipatoryProcessesAdminApplicationControllerPermissions = Class.new(::Decidim::DepartmentAdmin::Permissions)
+        register_new_permissions_for(artifact, ParticipatoryProcessesAdminApplicationControllerPermissions)
+
+        # public views produce problems with Devise's current_user
+        # require 'decidim/participatory_processes/application_controller'
+        # artifact= 'Decidim::ParticipatoryProcesses::ApplicationController'
+        # chain= ::Decidim.permissions_registry.chain_for(artifact)
+        # chain << ::Decidim::DepartmentAdmin::Permissions
+
+        # **
+        # Modify decidim-assemblies permissions registry
+        # **
+        require "decidim/assemblies/admin/assembly_copies_controller"
+        require "decidim/assemblies/admin/components_controller"
+        artifact = ::Decidim::Assemblies::Admin::Concerns::AssemblyAdmin
+        AssembliesAdminConcernPermissions = Class.new(::Decidim::DepartmentAdmin::Permissions)
+        register_new_permissions_for(artifact, AssembliesAdminConcernPermissions)
+
+        artifact = Decidim::Assemblies::Admin::ApplicationController
+        AssembliesAdminApplicationControllerPermissions = Class.new(::Decidim::DepartmentAdmin::Permissions)
+        register_new_permissions_for(artifact, AssembliesAdminApplicationControllerPermissions)
+
+        if Decidim::DepartmentAdmin.conferences_defined?
+          # **
+          # Modify decidim-conferences permissions registry
+          # **
+          require "decidim/conferences/admin/conference_copies_controller"
+          require "decidim/conferences/admin/components_controller"
+          artifact = ::Decidim::Conferences::Admin::Concerns::ConferenceAdmin
+          ConferencesAdminConcernPermissions = Class.new(::Decidim::DepartmentAdmin::Permissions)
+          register_new_permissions_for(artifact, ConferencesAdminConcernPermissions)
+
+          artifact = Decidim::Conferences::Admin::ApplicationController
+          ConferencesAdminApplicationControllerPermissions = Class.new(::Decidim::DepartmentAdmin::Permissions)
+          register_new_permissions_for(artifact, ConferencesAdminApplicationControllerPermissions)
+        end
+      end
+      # rubocop: enable Lint/ConstantDefinitionInBlock
+
+      # make decorators available to applications that use this Engine
+      config.to_prepare do
+        decorators = "#{Decidim::DepartmentAdmin::Engine.root}/app/decorators"
+        Dir.glob("#{decorators}/**/*_decorator.rb").each do |decorator|
+          require_dependency(decorator)
+        end
+      end
+
+      config.after_initialize do
+        require "decidim/participatory_processes/participatory_space"
+        # override participatory_processes space manifest permissions with DepartmentAdmin's one
+        manifest = Decidim.find_participatory_space_manifest(:participatory_processes)
+        manifest.permissions_class_name = "Decidim::ParticipatoryProcesses::ParticipatorySpacePermissions"
+        # override assemblies space manifest permissions with DepartmentAdmin's one
+        manifest = Decidim.find_participatory_space_manifest(:assemblies)
+        manifest.permissions_class_name = "Decidim::Assemblies::ParticipatorySpacePermissions"
+        if Decidim::DepartmentAdmin.conferences_defined?
+          # override conferences space manifest permissions with DepartmentAdmin's one
+          manifest = Decidim.find_participatory_space_manifest(:conferences)
+          manifest.permissions_class_name = "Decidim::Conferences::ParticipatorySpacePermissions"
+        end
+      end
+
+      #------------------------------------------------------
+
+      private
+
+      #------------------------------------------------------
+
+      # Modifies the permissions registry for the given +artifact+ with +new_permissions_class+.
+      # NOTE: Previous permissions are cleared and setted to the +new_permissions_class+ for delegation.
+      def register_new_permissions_for(artifact, new_permissions_class)
+        chain = ::Decidim.permissions_registry.chain_for(artifact)
+        # configure old chain, in case new permissions has to delegate
+        new_permissions_class.delegate_chain = chain.dup
+        # re-set the permissions classes to DepartmentAdmin::Permissions' subclass
+        chain.clear
+        chain << new_permissions_class
+        Rails.logger.info("Registered new permissions for #{artifact} to: #{::Decidim.permissions_registry.chain_for(artifact)}")
+      end
+    end
+  end
+end

data/lib/decidim/department_admin/test/factories.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "decidim/core/test/factories"
+
+FactoryBot.define do
+  factory :department_admin, parent: :user do
+    roles { ["department_admin"] }
+    admin_terms_accepted_at { Time.zone.now }
+    transient do
+      area { nil }
+    end
+
+    after(:build) do |user, evaluator|
+      user.areas << evaluator.area if evaluator.area.present?
+    end
+  end
+end

data/lib/decidim/department_admin/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This holds the decidim-module-department_admin version.
+  module DepartmentAdmin
+    # see CHANGELOG.md
+    def self.version
+      "0.7.2"
+    end
+  end
+end

data/lib/decidim/department_admin.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "decidim/department_admin/admin"
+require "decidim/department_admin/engine"
+require "decidim/department_admin/admin_engine"
+
+module Decidim
+  # This namespace holds the logic of the `DepartmentAdmin` module. This module
+  # allows users to create department_admin in a participatory space.
+  module DepartmentAdmin
+    def self.conferences_defined?
+      defined?(Decidim::Conferences::QueryExtensions)
+    end
+  end
+end