decidim-challenges 0.5.0

data/README.md

@@ -0,0 +1,49 @@
+# Decidim::Challenges
+
+Articulates the collective action of diverse actors in order to address common and shared challenges and the problems that derive from  them across the territory..
+
+## Usage
+
+Challenges will be available as a Component for a Participatory
+Space.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "decidim-challenges"
+```
+
+And then execute:
+
+```bash
+bundle install
+bundle exec rails decidim_challenges:install:migrations
+bundle exec rails db:migrate
+```
+
+### Run tests
+
+Create a dummy app in your application (if not present):
+
+```bash
+bin/rails decidim:generate_external_test_app
+cd spec/decidim_dummy_app/
+bundle exec rails decidim_challenges:install:migrations
+RAILS_ENV=test bundle exec rails db:migrate
+```
+
+And run tests:
+
+```bash
+bundle exec rspec spec
+```
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+## 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/challenges/challenge_cell.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Challenges
+    class ChallengeCell < Decidim::ViewModel
+      include ChallengeCellsHelper
+      include Decidim::SanitizeHelper
+      include Cell::ViewModel::Partial
+
+      def show
+        cell card_size, model, options
+      end
+
+      private
+
+      def card_size
+        "decidim/challenges/challenge_g"
+      end
+    end
+  end
+end

data/app/cells/decidim/challenges/challenge_g/show.erb

@@ -0,0 +1,47 @@
+<%= append_stylesheet_pack_tag "decidim_challenges" %>
+
+<%= link_to resource_path, class: "card__list", id: resource_id do %>
+  <div class="card__list-image">
+    <% if has_image? %>
+      <%= image_tag resource_image_url, class: "w-full h-full object-cover" %>
+    <% else %>
+      <div class="w-full h-full relative">
+        <div class="w-full h-full bg-primary opacity-10 absolute top-0 left-0 z-10">
+        </div>
+        <%= external_icon "media/images/placeholder-card-l.svg", class: "card__placeholder-l" %>
+      </div>
+    <% end %>
+  </div>
+
+  <div class="card__list-content">
+    <%= content_tag title_tag, class: "h4 card__list-title" do %>
+      <%= translated_attribute(title) %>
+    <% end %>
+    <div class="card__list-text">
+      <%= description %>
+      <% if has_sdgs? %>
+        <div class="card__sdg">
+          <div class="card_text--sdg--image">
+            <div class="ods challenges">
+              <% if resource_sdg_index %>
+                <%= image_pack_tag "media/images/ods-#{resource_sdg_index}.svg", alt: "Logo SDG #{resource_sdg_index}", class: "challenge--view" %>
+              <% end %>
+            </div>
+          </div>
+          <div class="card_text--sdg--text">
+            <% if resource_sdg %>
+              <strong><%= t_sdg(resource_sdg) %></strong>
+            <% end %>
+          </div>
+        </div>
+      <% end %>
+    </div>
+    <div class="card__list-metadata">
+      <div>
+        <span class="label challenge-status <%= resource_state %>">
+          <%= t(resource_state, scope: 'decidim.challenges.states') %>
+        </span>
+      </div>
+    </div>
+  </div>
+<% end %>

data/app/cells/decidim/challenges/challenge_g_cell.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Challenges
+    # This cell renders the Grid (:g) Challenge card
+    # for an given instance of a Challenge
+    class ChallengeGCell < Decidim::CardGCell
+      include ActiveSupport::NumberHelper
+      include Decidim::Challenges::ChallengesHelper
+      include Decidim::Sdgs::SdgsHelper
+      include ChallengeCellsHelper
+
+      private
+
+      def resource_icon
+        icon "challenges", class: "icon--big"
+      end
+
+      def resource_image_url
+        model.attached_uploader(:card_image).url
+      end
+
+      def has_image?
+        @has_image ||= model.component.settings.allow_card_image && model.card_image.attached?
+      end
+
+      def resource_image_path
+        @resource_image_path ||= has_image? ? model.attached_uploader(:card_image).path : nil
+      end
+
+      def description
+        text = translated_attribute(model.global_description)
+        decidim_sanitize(html_truncate(text, length: 100))
+      end
+
+      def challenge_path
+        resource_locator(model).path
+      end
+
+      def show
+        render
+      end
+
+      def resource_path
+        resource_locator(model).path
+      end
+
+      def resource_title
+        translated_attribute model.title
+      end
+
+      def resource_sdg
+        model.sdg_code
+      end
+
+      def resource_sdg_index
+        model.sdg_code ? (1 + Decidim::Sdgs::Sdg.index_from_code(model.sdg_code.to_sym)).to_s.rjust(2, "0") : nil
+      end
+
+      def resource_state
+        model.state
+      end
+
+      def current_organization
+        current_organization
+      end
+    end
+  end
+end

data/app/cells/decidim/problems/problem_cell.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Problems
+    # This cell renders the problem card for an instance of a problem
+    # the default size is the Medium Card (:m)
+    class ProblemCell < Decidim::ViewModel
+      include ProblemCellsHelper
+      include Decidim::SanitizeHelper
+      include Cell::ViewModel::Partial
+
+      def show
+        cell card_size, model, options
+      end
+
+      def card_size
+        "decidim/problems/problem_g"
+      end
+    end
+  end
+end

data/app/cells/decidim/problems/problem_g/show.erb

@@ -0,0 +1,35 @@
+<%= append_stylesheet_pack_tag "decidim_challenges" %>
+
+<%= link_to resource_path, class: "card__list", id: resource_id do %>
+  <div class="card__list-content">
+    <%= content_tag title_tag, class: "h4 card__list-title" do %>
+      <%= title %>
+    <% end %>
+    <div class="card__list-text">
+      <p><%= description %></p>
+      <% if has_sdgs? %>
+        <div class="card__sdg">
+          <div class="card_text--sdg--image">
+            <div class="ods challenges">
+              <% if resource_sdg_index %>
+                <%= image_pack_tag "media/images/ods-#{resource_sdg_index}.svg", alt: "Logo SDG #{resource_sdg_index}", class: "challenge--view" %>
+              <% end %>
+            </div>
+          </div>
+          <div class="card_text--sdg--text">
+            <% if resource_sdg %>
+              <strong><%= t_sdg(resource_sdg) %></strong>
+            <% end %>
+          </div>
+        </div>
+      <% end %>
+    </div>
+    <div class="card__list-metadata">
+      <div>
+        <span class="label problem-status <%= resource_state %>">
+          <%= t(resource_state, scope: 'decidim.challenges.states') %>
+        </span>
+      </div>
+    </div>
+  </div>
+<% end %>

data/app/cells/decidim/problems/problem_g_cell.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Problems
+    # This cell renders the Grid (:g) Problem card
+    # for an given instance of a Problem
+    class ProblemGCell < Decidim::CardGCell
+      include ActiveSupport::NumberHelper
+      include Decidim::Problems::ProblemsHelper
+      include Decidim::Sdgs::SdgsHelper
+      include ProblemCellsHelper
+
+      private
+
+      def resource_icon
+        icon "problems", class: "icon--big"
+      end
+
+      def show
+        render
+      end
+
+      def problem_path
+        resource_locator(model).path
+      end
+
+      def challenge_path
+        resource_locator(model.challenge).path
+      end
+
+      def resource_title
+        translated_attribute model.title
+      end
+
+      def resource_description
+        text = translated_attribute(model.description)
+        decidim_sanitize(html_truncate(text, length: 100))
+      end
+
+      def resource_state
+        model.state
+      end
+
+      def problem
+        model
+      end
+
+      def resource_challenge_title
+        translated_attribute model.challenge.title
+      end
+
+      def resource_sdg
+        model.challenge.sdg_code
+      end
+
+      def resource_sdg_index
+        model.challenge.sdg_code ? (1 + Decidim::Sdgs::Sdg.index_from_code(model.challenge.sdg_code.to_sym)).to_s.rjust(2, "0") : nil
+      end
+    end
+  end
+end

data/app/cells/decidim/solutions/solution_cell.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Solutions
+    class SolutionCell < Decidim::ViewModel
+      include SolutionCellsHelper
+      include Decidim::SanitizeHelper
+      include Cell::ViewModel::Partial
+
+      def show
+        cell card_size, model, options
+      end
+
+      private
+
+      def card_size
+        "decidim/solutions/solution_g"
+      end
+    end
+  end
+end

data/app/cells/decidim/solutions/solution_g/show.erb

@@ -0,0 +1,30 @@
+<%= append_stylesheet_pack_tag "decidim_challenges" %>
+
+<%= link_to resource_path, class: "card__list", id: resource_id do %>
+  <div class="card__list-content">
+    <%= content_tag resource_title, class: "h4 card__list-title" do %>
+      <%= title %>
+    <% end %>
+    <div class="card__list-text">
+      <%= description %>
+      <% if resource_sdg %>
+        <div class="card__sdg">
+          <div class="card_text--sdg--image">
+            <div class="ods challenges">
+              <% if resource_sdg_index %>
+                <%= image_pack_tag "media/images/ods-#{resource_sdg_index}.svg", alt: "Logo SDG #{resource_sdg_index}", class: "challenge--view" %>
+              <% end %>
+            </div>
+          </div>
+          <div class="card_text--sdg--text">
+            <% if resource_sdg %>
+              <strong><%= t_sdg(resource_sdg) %></strong>
+            <% end %>
+          </div>
+        </div>
+      <% end %>
+    </div>
+    <div class="card__list-metadata">
+    </div>
+  </div>
+<% end %>

data/app/cells/decidim/solutions/solution_g_cell.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Solutions
+    # This cell renders the Grid (:g) Solution card
+    # for an given instance of a Solution
+    class SolutionGCell < Decidim::CardGCell
+      include ActiveSupport::NumberHelper
+      include Decidim::Sdgs::SdgsHelper
+
+      private
+
+      def resource_problem_title
+        translated_attribute model.problem.title
+      end
+
+      def resource_challenge_title
+        if model.problem.present?
+          translated_attribute model.problem.challenge.title
+        else
+          translated_attribute model.challenge.title
+        end
+      end
+
+      def resource_icon
+        icon "solutions", class: "icon--big"
+      end
+
+      def description
+        text = translated_attribute(model.description)
+        decidim_sanitize(html_truncate(text, length: 100))
+      end
+
+      def solution_path
+        resource_locator(model).path
+      end
+
+      def show
+        render
+      end
+
+      def resource_path
+        resource_locator(model).path
+      end
+
+      def resource_title
+        translated_attribute model.title
+      end
+
+      def resource_id
+        model.id
+      end
+
+      def problem_path
+        resource_locator(model.problem).path if model.problem.present?
+      end
+
+      def challenge_path
+        if model.problem.present?
+          resource_locator(model.problem.challenge).path
+        else
+          resource_locator(model.challenge).path
+        end
+      end
+
+      def resource_sdg
+        if model.problem.present?
+          model.problem.challenge.sdg_code
+        else
+          model.challenge.sdg_code
+        end
+      end
+
+      def resource_sdg_index
+        challenge = model.problem ? model.problem.challenge : model.challenge
+        challenge.sdg_code ? (1 + Decidim::Sdgs::Sdg.index_from_code(challenge.sdg_code.to_sym)).to_s.rjust(2, "0") : nil
+      end
+
+      def current_organization
+        current_organization
+      end
+    end
+  end
+end

data/app/commands/decidim/challenges/admin/create_challenge.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Challenges
+    module Admin
+      # A command with all the business logic when a user creates a new challenge.
+      class CreateChallenge < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          super()
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid, together with the proposal.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          transaction do
+            create_challenge!
+          end
+
+          broadcast(:ok, challenge)
+        end
+
+        private
+
+        attr_reader :form, :challenge
+
+        def create_challenge!
+          parsed_title = Decidim::ContentProcessor.parse_with_processor(:hashtag, form.title, current_organization: form.current_organization).rewrite
+          parsed_local_description = Decidim::ContentProcessor.parse_with_processor(:hashtag, form.local_description, current_organization: form.current_organization).rewrite
+          parsed_global_description = Decidim::ContentProcessor.parse_with_processor(:hashtag, form.global_description, current_organization: form.current_organization).rewrite
+          params = {
+            title: parsed_title,
+            local_description: parsed_local_description,
+            global_description: parsed_global_description,
+            component: form.current_component,
+            tags: form.tags,
+            sdg_code: form.sdg_code,
+            scope: form.scope,
+            state: form.state,
+            start_date: form.start_date,
+            end_date: form.end_date,
+            coordinating_entities: form.coordinating_entities,
+            collaborating_entities: form.collaborating_entities,
+            questionnaire: Decidim::Forms::Questionnaire.new,
+            card_image: form.card_image,
+          }
+
+          @challenge = Decidim.traceability.create!(
+            Decidim::Challenges::Challenge,
+            form.current_user,
+            params,
+            visibility: "all"
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/challenges/admin/destroy_challenge.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Challenges
+    module Admin
+      # This command deals with destroying a Challenge from the admin panel.
+      class DestroyChallenge < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # page - The Challenge to be destroyed.
+        def initialize(challenge, current_user)
+          super()
+          @challenge = challenge
+          @current_user = current_user
+        end
+
+        # Public: Executes the command.
+        #
+        # Broadcasts :ok if it got destroyed
+        # Broadcasts :has_problems if not destroyed 'cause dependent
+        # Broadcasts :invalid if it not destroyed
+        def call
+          destroy_challenge
+          broadcast(:ok)
+        rescue ActiveRecord::DeleteRestrictionError
+          broadcast(:has_problems)
+        rescue ActiveRecord::RecordNotDestroyed
+          broadcast(:invalid)
+        end
+
+        private
+
+        attr_reader :challenge, :current_user
+
+        def destroy_challenge
+          transaction do
+            Decidim.traceability.perform_action!(
+              "delete",
+              challenge,
+              current_user
+            ) do
+              challenge.destroy!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/challenges/admin/export_challenge_surveys.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Challenges
+    module Admin
+      # This command is executed when the user exports the registrations of
+      # a Meeting from the admin panel.
+      class ExportChallengeSurveys < Decidim::Command
+        # challenge - The current instance of the page to be closed.
+        # format - a string representing the export format
+        # current_user - the user performing the action
+        def initialize(challenge, format, current_user)
+          super()
+          @challenge = challenge
+          @format = format
+          @current_user = current_user
+        end
+
+        # Exports the challenge registrations.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          broadcast(:ok, export_data)
+        end
+
+        private
+
+        attr_reader :current_user, :challenge, :format
+
+        def export_data
+          Decidim.traceability.perform_action!(
+            :export_surveys,
+            challenge,
+            current_user
+          ) do
+            Decidim::Exporters
+              .find_exporter(format)
+              .new(challenge.surveys, Decidim::Challenges::SurveySerializer)
+              .export
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/challenges/admin/publish_challenge.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Challenges
+    module Admin
+      # A command that sets a challenge as published.
+      class PublishChallenge < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # challenge - A Challenge that will be published
+        # current_user - the user performing the action
+        def initialize(challenge, current_user)
+          super()
+          @challenge = challenge
+          @current_user = current_user
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the data wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if challenge.nil? || challenge.published?
+
+          Decidim.traceability.perform_action!("publish", challenge, current_user, visibility: "all") do
+            challenge.publish!
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :challenge, :current_user
+      end
+    end
+  end
+end