decidim-transparent_trash 0.0.1

data/README.md

@@ -0,0 +1,62 @@
+# Decidim Transparent Trash module
+
+Module implements a new space in Decidim initiatives index where initiatives marked as **Invalidated** and **Illegal**
+are accessible.
+These previous states are only available with this module.
+
+> 🚧 Overrides
+>
+> This feature requires to extend components like commands, controllers, permission and views of the decidim-initiatives
+> engine. It may occur unexpected behaviours, an exhaustive list of overrides is available.
+
+## Usage
+
+TransparentTrash will be available as a Component for a Participatory
+Space.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "decidim-transparent_trash", git: "https://github.com/opensourcepolitics/decidim-module-transparent_trash.git"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+### Informations
+
+| _                            | Presence |
+|:-----------------------------|:--------:|
+| Database migrations          |    ❌     |
+| Webpacker assets             |    ❌     |
+| Env variables                |    ❌     |
+| Data structure changes       |    ❌     |
+| New states for initiatives   |    ✅     |
+| Changes on initiatives index |     ❌     |
+
+
+**Commands are available to have the list extends and overrides :**
+
+* `make extends`
+* `make overrides`
+
+## Contributing
+
+Contributions are welcome !
+
+We expect the contributions to follow
+the [Decidim's contribution guide](https://github.com/decidim/decidim/blob/develop/CONTRIBUTING.adoc).
+
+## Security
+
+Security is very important to us. If you have any issue regarding security, please disclose the information responsibly
+by sending an email to __security [at] opensourcepolitics [dot] eu__ and not by creating a Github issue.
+
+## License
+
+This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+desc "Generates a dummy app for testing"
+task test_app: "decidim:generate_external_test_app"
+
+desc "Generates a development app."
+task development_app: "decidim:generate_external_development_app"

data/app/cells/decidim/initiatives/initiative_m_cell.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Initiatives
+    # This cell renders the Medium (:m) initiative card
+    # for an given instance of an Initiative
+    class InitiativeMCell < Decidim::CardMCell
+      include Decidim::Initiatives::Engine.routes.url_helpers
+      include Decidim::TwitterSearchHelper
+
+      property :state
+
+      private
+
+      def title
+        return I18n.t("decidim.initiatives.initiatives.show.illegal.title") if model.illegal?
+
+        decidim_html_escape(translated_attribute(model.title))
+      end
+
+      def description
+        return I18n.t("decidim.initiatives.initiatives.show.illegal.description") if model.illegal?
+
+        super
+      end
+
+      def hashtag
+        decidim_html_escape(model.hashtag)
+      end
+
+      def has_state?
+        true
+      end
+
+      # Explicitely commenting the used I18n keys so their are not flagged as unused
+      # i18n-tasks-use t('decidim.initiatives.show.badge_name.accepted')
+      # i18n-tasks-use t('decidim.initiatives.show.badge_name.created')
+      # i18n-tasks-use t('decidim.initiatives.show.badge_name.discarded')
+      # i18n-tasks-use t('decidim.initiatives.show.badge_name.published')
+      # i18n-tasks-use t('decidim.initiatives.show.badge_name.rejected')
+      # i18n-tasks-use t('decidim.initiatives.show.badge_name.validating')
+      def badge_name
+        I18n.t(model.state, scope: "decidim.initiatives.show.badge_name")
+      end
+
+      def state_classes
+        case state
+        when "accepted", "published"
+          ["success"]
+        when "rejected", "discarded", "invalidated", "illegal"
+          ["alert"]
+        when "validating"
+          ["warning"]
+        else
+          ["muted"]
+        end
+      end
+
+      def resource_path
+        initiative_path(model)
+      end
+
+      def resource_icon
+        icon "initiatives", class: "icon--big"
+      end
+
+      def authors
+        [present(model).author] +
+          model.committee_members.approved.non_deleted.excluding_author.map { |member| present(member.user) }
+      end
+
+      def has_image?
+        image.present?
+      end
+
+      def image
+        @image ||= model.attachments.find(&:image?)
+      end
+
+      def resource_image_path
+        image.url if has_image?
+      end
+
+      def follow_status
+        return if model.invalidated? || model.illegal?
+
+        cell "decidim/follow_button", model, inline: true
+      end
+    end
+  end
+end

data/app/commands/decidim/initiatives/admin/illegal_initiative.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Initiatives
+    module Admin
+      # A command with all the business logic that unpublishes an
+      # existing initiative.
+      class IllegalInitiative < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # initiative - Decidim::Initiative
+        # current_user - the user performing the action
+        def initialize(initiative, current_user)
+          @initiative = initiative
+          @current_user = current_user
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if initiative.published?
+
+          @initiative = Decidim.traceability.perform_action!(
+            :illegal,
+            initiative,
+            current_user
+          ) do
+            initiative.components.each(&:unpublish!) if initiative.components.any?
+            initiative.illegal!
+            initiative
+          end
+          broadcast(:ok, initiative)
+        end
+
+        private
+
+        attr_reader :initiative, :current_user
+      end
+    end
+  end
+end

data/app/commands/decidim/initiatives/admin/invalidate_initiative.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Initiatives
+    module Admin
+      # A command with all the business logic that unpublishes an
+      # existing initiative.
+      class InvalidateInitiative < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # initiative - Decidim::Initiative
+        # current_user - the user performing the action
+        def initialize(initiative, current_user)
+          @initiative = initiative
+          @current_user = current_user
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if initiative.published?
+
+          @initiative = Decidim.traceability.perform_action!(
+            :invalidate,
+            initiative,
+            current_user
+          ) do
+            initiative.components.each(&:unpublish!) if initiative.components.any?
+            initiative.invalidate!
+            initiative
+          end
+          broadcast(:ok, initiative)
+        end
+
+        private
+
+        attr_reader :initiative, :current_user
+      end
+    end
+  end
+end

data/app/controllers/decidim/transparent_trash/admin/application_controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TransparentTrash
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # 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::TransparentTrash::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
+end

data/app/controllers/decidim/transparent_trash/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TransparentTrash
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Components::BaseController
+    end
+  end
+end

data/app/helpers/decidim/transparent_trash/application_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module TransparentTrash
+    # Custom helpers, scoped to the transparent_trash engine.
+    #
+    module ApplicationHelper
+    end
+  end
+end