decidim-challenges 0.5.0

data/app/presenters/decidim/challenges/challenge_presenter.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Challenges
+    #
+    # Decorator for challenge
+    #
+    class ChallengePresenter < SimpleDelegator
+      include Rails.application.routes.mounted_helpers
+      include ActionView::Helpers::UrlHelper
+      include Decidim::SanitizeHelper
+      include Decidim::TranslatableAttributes
+
+      delegate :url, to: :card_image, prefix: true
+
+      def challenge
+        __getobj__
+      end
+
+      def challenge_path
+        Decidim::ResourceLocatorPresenter.new(challenge).path
+      end
+
+      def display_mention
+        link_to title, challenge_path
+      end
+
+      # Render the challenge title
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def title(links: false, extras: true, html_escape: false)
+        text = translated_attribute(challenge.title)
+        text = decidim_html_escape(text) if html_escape
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        renderer.render(links:, extras:).html_safe
+      end
+
+      def id_and_title(links: false, extras: true, html_escape: false)
+        "##{challenge.id} - #{title(links:, extras:, html_escape:)}"
+      end
+
+      # Render the challenge local_description
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def local_description(links: false, extras: true, strip_tags: false)
+        text = translated_attribute(challenge.local_description)
+
+        text = strip_tags(sanitize_text(text)) if strip_tags
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        text = renderer.render(links:, extras:).html_safe
+
+        text = Decidim::ContentRenderers::LinkRenderer.new(text).render if links
+        text
+      end
+
+      # Render the challenge global_description
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def global_description(links: false, extras: true, strip_tags: false)
+        text = translated_attribute(challenge.global_description)
+
+        text = strip_tags(sanitize_text(text)) if strip_tags
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        text = renderer.render(links:, extras:).html_safe
+
+        text = Decidim::ContentRenderers::LinkRenderer.new(text).render if links
+        text
+      end
+
+      def card_image_url
+        return if challenge.card_image.blank?
+
+        challenge.attached_uploader(:card_image).url(host: challenge.organization.host)
+      end
+
+      delegate :count, to: :versions, prefix: true
+
+      def resource_manifest
+        challenge.class.resource_manifest
+      end
+
+      private
+
+      def sanitize_unordered_lists(text)
+        text.gsub(%r{(?=.*</ul>)(?!.*?<li>.*?</ol>.*?</ul>)<li>}) { |li| "#{li}• " }
+      end
+
+      def sanitize_ordered_lists(text)
+        i = 0
+
+        text.gsub(%r{(?=.*</ol>)(?!.*?<li>.*?</ul>.*?</ol>)<li>}) do |li|
+          i += 1
+
+          li + "#{i}. "
+        end
+      end
+
+      def add_line_feeds_to_paragraphs(text)
+        text.gsub("</p>") { |p| "#{p}\n\n" }
+      end
+
+      def add_line_feeds_to_list_items(text)
+        text.gsub("</li>") { |li| "#{li}\n" }
+      end
+
+      # Adds line feeds after the paragraph and list item closing tags.
+      #
+      # Returns a String.
+      def add_line_feeds(text)
+        add_line_feeds_to_paragraphs(add_line_feeds_to_list_items(text))
+      end
+
+      # Maintains the paragraphs and lists separations with their bullet points and
+      # list numberings where appropriate.
+      #
+      # Returns a String.
+      def sanitize_text(text)
+        add_line_feeds(sanitize_ordered_lists(sanitize_unordered_lists(text)))
+      end
+    end
+  end
+end

data/app/presenters/decidim/problems/problem_presenter.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Problems
+    #
+    # Decorator for problem
+    #
+    class ProblemPresenter < SimpleDelegator
+      include Rails.application.routes.mounted_helpers
+      include ActionView::Helpers::UrlHelper
+      include Decidim::SanitizeHelper
+      include Decidim::TranslatableAttributes
+
+      def problem
+        __getobj__
+      end
+
+      def problem_path
+        Decidim::ResourceLocatorPresenter.new(problem).path
+      end
+
+      def display_mention
+        link_to title, problem_path
+      end
+
+      # Render the problem title
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def title(links: false, extras: true, html_escape: false)
+        text = translated_attribute(problem.title)
+        text = decidim_html_escape(text) if html_escape
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        renderer.render(links:, extras:).html_safe
+      end
+
+      def id_and_title(links: false, extras: true, html_escape: false)
+        "##{problem.id} - #{title(links:, extras:, html_escape:)}"
+      end
+
+      # Render the problem description
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def description(links: false, extras: true, strip_tags: false)
+        text = translated_attribute(problem.description)
+
+        text = strip_tags(sanitize_text(text)) if strip_tags
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        text = renderer.render(links:, extras:).html_safe
+
+        text = Decidim::ContentRenderers::LinkRenderer.new(text).render if links
+        text
+      end
+
+      delegate :count, to: :versions, prefix: true
+
+      def resource_manifest
+        problem.class.resource_manifest
+      end
+
+      private
+
+      def sanitize_unordered_lists(text)
+        text.gsub(%r{(?=.*</ul>)(?!.*?<li>.*?</ol>.*?</ul>)<li>}) { |li| "#{li}• " }
+      end
+
+      def sanitize_ordered_lists(text)
+        i = 0
+
+        text.gsub(%r{(?=.*</ol>)(?!.*?<li>.*?</ul>.*?</ol>)<li>}) do |li|
+          i += 1
+
+          li + "#{i}. "
+        end
+      end
+
+      def add_line_feeds_to_paragraphs(text)
+        text.gsub("</p>") { |p| "#{p}\n\n" }
+      end
+
+      def add_line_feeds_to_list_items(text)
+        text.gsub("</li>") { |li| "#{li}\n" }
+      end
+
+      # Adds line feeds after the paragraph and list item closing tags.
+      #
+      # Returns a String.
+      def add_line_feeds(text)
+        add_line_feeds_to_paragraphs(add_line_feeds_to_list_items(text))
+      end
+
+      # Maintains the paragraphs and lists separations with their bullet points and
+      # list numberings where appropriate.
+      #
+      # Returns a String.
+      def sanitize_text(text)
+        add_line_feeds(sanitize_ordered_lists(sanitize_unordered_lists(text)))
+      end
+    end
+  end
+end

data/app/presenters/decidim/solutions/solution_presenter.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Solutions
+    #
+    # Decorator for solution
+    #
+    class SolutionPresenter < SimpleDelegator
+      include Rails.application.routes.mounted_helpers
+      include ActionView::Helpers::UrlHelper
+      include Decidim::SanitizeHelper
+      include Decidim::TranslatableAttributes
+
+      def solution
+        __getobj__
+      end
+
+      def solution_path
+        Decidim::ResourceLocatorPresenter.new(solution).path
+      end
+
+      def display_mention
+        link_to title, solution_path
+      end
+
+      # Render the solution title
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def title(links: false, extras: true, html_escape: false)
+        text = translated_attribute(solution.title)
+        text = decidim_html_escape(text) if html_escape
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        renderer.render(links:, extras:).html_safe
+      end
+
+      def id_and_title(links: false, extras: true, html_escape: false)
+        "##{solution.id} - #{title(links:, extras:, html_escape:)}"
+      end
+
+      # Render the solution description
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def description(links: false, extras: true, strip_tags: false)
+        text = translated_attribute(solution.description)
+
+        text = strip_tags(sanitize_text(text)) if strip_tags
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        text = renderer.render(links:, extras:).html_safe
+
+        text = Decidim::ContentRenderers::LinkRenderer.new(text).render if links
+        text
+      end
+
+      # Render the solution indicators
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def indicators(links: false, extras: true, strip_tags: false)
+        text = translated_attribute(solution.indicators)
+
+        text = strip_tags(sanitize_text(text)) if strip_tags
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        text = renderer.render(links:, extras:).html_safe
+
+        text = Decidim::ContentRenderers::LinkRenderer.new(text).render if links
+        text
+      end
+
+      # Render the solution beneficiaries
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def beneficiaries(links: false, extras: true, strip_tags: false)
+        text = translated_attribute(solution.beneficiaries)
+
+        text = strip_tags(sanitize_text(text)) if strip_tags
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        text = renderer.render(links:, extras:).html_safe
+
+        text = Decidim::ContentRenderers::LinkRenderer.new(text).render if links
+        text
+      end
+
+      # Render the solution requirements
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def requirements(links: false, extras: true, strip_tags: false)
+        text = translated_attribute(solution.requirements)
+
+        text = strip_tags(sanitize_text(text)) if strip_tags
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        text = renderer.render(links:, extras:).html_safe
+
+        text = Decidim::ContentRenderers::LinkRenderer.new(text).render if links
+        text
+      end
+
+      # Render the solution financing_type
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def financing_type(links: false, extras: true, strip_tags: false)
+        text = translated_attribute(solution.financing_type)
+
+        text = strip_tags(sanitize_text(text)) if strip_tags
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        text = renderer.render(links:, extras:).html_safe
+
+        text = Decidim::ContentRenderers::LinkRenderer.new(text).render if links
+        text
+      end
+
+      # Render the solution objectives
+      #
+      # links - should render hashtags as links?
+      # extras - should include extra hashtags?
+      #
+      # Returns a String.
+      def objectives(links: false, extras: true, strip_tags: false)
+        text = translated_attribute(solution.objectives)
+
+        text = strip_tags(sanitize_text(text)) if strip_tags
+
+        renderer = Decidim::ContentRenderers::HashtagRenderer.new(text)
+        text = renderer.render(links:, extras:).html_safe
+
+        text = Decidim::ContentRenderers::LinkRenderer.new(text).render if links
+        text
+      end
+
+      delegate :count, to: :versions, prefix: true
+
+      def resource_manifest
+        solution.class.resource_manifest
+      end
+
+      private
+
+      def sanitize_unordered_lists(text)
+        text.gsub(%r{(?=.*</ul>)(?!.*?<li>.*?</ol>.*?</ul>)<li>}) { |li| "#{li}• " }
+      end
+
+      def sanitize_ordered_lists(text)
+        i = 0
+
+        text.gsub(%r{(?=.*</ol>)(?!.*?<li>.*?</ul>.*?</ol>)<li>}) do |li|
+          i += 1
+
+          li + "#{i}. "
+        end
+      end
+
+      def add_line_feeds_to_paragraphs(text)
+        text.gsub("</p>") { |p| "#{p}\n\n" }
+      end
+
+      def add_line_feeds_to_list_items(text)
+        text.gsub("</li>") { |li| "#{li}\n" }
+      end
+
+      # Adds line feeds after the paragraph and list item closing tags.
+      #
+      # Returns a String.
+      def add_line_feeds(text)
+        add_line_feeds_to_paragraphs(add_line_feeds_to_list_items(text))
+      end
+
+      # Maintains the paragraphs and lists separations with their bullet points and
+      # list numberings where appropriate.
+      #
+      # Returns a String.
+      def sanitize_text(text)
+        add_line_feeds(sanitize_ordered_lists(sanitize_unordered_lists(text)))
+      end
+    end
+  end
+end

data/app/serializers/decidim/challenges/data_serializer.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Challenges
+    # This class serializes the specific data in each Survey.
+    # This is `Questionnaire->questions->answer_options` but not `answers`
+    # and `answer_choices`.
+    class DataSerializer < Decidim::Exporters::Serializer
+      # Returns: Array of Decidim::Forms::Questionnaire as a json hash,
+      #     or nil if none exists.
+      def serialize
+        component = resource
+        surveys = Decidim::Challenges::Survey.where(component:)
+        surveys.collect do |survey|
+          next if survey.questionnaire.nil?
+
+          json = serialize_survey(survey)
+          json.with_indifferent_access.merge(survey_id: survey.id)
+        end
+      end
+
+      def serialize_survey(survey)
+        questionnaire = survey.questionnaire
+        questionnaire_json = questionnaire.attributes.as_json
+        questionnaire_json[:questions] = serialize_questions(questionnaire.questions.order(:position))
+        json = survey.attributes.as_json
+        json[:questionnaire] = questionnaire_json
+        json
+      end
+
+      def serialize_questions(questions)
+        questions.collect do |question|
+          json = question.attributes.as_json
+          json[:answer_options] = serialize_answer_options(question.answer_options)
+          json
+        end
+      end
+
+      def serialize_answer_options(answer_options)
+        answer_options.collect do |option|
+          option.attributes.as_json
+        end
+      end
+    end
+  end
+end

data/app/serializers/decidim/challenges/survey_serializer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Challenges
+    class SurveySerializer < Decidim::Exporters::Serializer
+      include Decidim::TranslationsHelper
+      # Serializes a registration
+      def serialize
+        {
+          id: resource.id,
+          user: {
+            name: resource.user.name,
+            email: resource.user.email,
+          },
+          survey_form_answers: serialize_answers,
+        }
+      end
+
+      private
+
+      def serialize_answers
+        questions = resource.challenge.questionnaire.questions
+        answers = resource.challenge.questionnaire.answers.where(user: resource.user)
+        questions.each_with_index.inject({}) do |serialized, (question, idx)|
+          answer = answers.find_by(question:)
+          serialized.update("#{idx + 1}. #{translated_attribute(question.body)}" => normalize_body(answer))
+        end
+      end
+
+      def normalize_body(answer)
+        return "" unless answer
+
+        answer.body || answer.choices.pluck(:body)
+      end
+    end
+  end
+end

data/app/types/decidim/challenges/challenge_type.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Challenges
+    class ChallengeType < Decidim::Api::Types::BaseObject
+      implements Decidim::Core::ScopableInterface
+      implements Decidim::Core::AttachableInterface
+      implements Decidim::Core::TraceableInterface
+      implements Decidim::Core::TimestampsInterface
+
+      graphql_name "Challenge"
+      description "A challenge"
+
+      field :id, GraphQL::Types::ID, null: false
+      field :title, Decidim::Core::TranslatedFieldType, "The title of this challenge (same as the component name).", null: false
+      field :local_description, Decidim::Core::TranslatedFieldType, "The local description of this challenge.", null: true
+      field :global_description, Decidim::Core::TranslatedFieldType, "The global description of this challenge.", null: true
+      field :tags, Decidim::Core::TranslatedFieldType, "The tags of this challenge.", null: true
+      field :sdg_code, GraphQL::Types::String, "The Sustainable Development Goal this challenge is associated with.", null: true
+      field :state, GraphQL::Types::String, "The state for this challenge.", null: true
+      field :start_date, Decidim::Core::DateType, "The start date", null: true
+      field :end_date, Decidim::Core::DateType, "The end date", null: true
+      field :published_at, Decidim::Core::DateTimeType, "The moment at which it was published", null: true
+      field :coordinating_entities, GraphQL::Types::String, "The entities coordinating this challenge.", null: true
+      field :collaborating_entities, GraphQL::Types::String, "The entities collaborating with this challenge.", null: true
+    end
+  end
+end

data/app/types/decidim/challenges/challenges_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Challenges
+    class ChallengesType < Decidim::Api::Types::BaseObject
+      implements Decidim::Core::ComponentInterface
+
+      graphql_name "Challenges"
+      description "A challenges component of a participatory space."
+
+      field :challenges, ChallengeType.connection_type, null: true, connection: true
+
+      def challenges
+        ChallengesTypeHelper.base_scope(object).includes(:component)
+      end
+
+      field(:challenge, ChallengeType, null: true) do
+        argument :id, GraphQL::Types::ID, required: true
+      end
+
+      def challenge(**args)
+        ChallengesTypeHelper.base_scope(object).find_by(id: args[:id])
+      end
+    end
+
+    module ChallengesTypeHelper
+      def self.base_scope(component)
+        Challenge.where(component:).published
+      end
+    end
+  end
+end

data/app/types/decidim/problems/problem_type.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Problems
+    class ProblemType < Decidim::Api::Types::BaseObject
+      implements Decidim::Core::TraceableInterface
+      implements Decidim::Core::TimestampsInterface
+
+      graphql_name "Problem"
+      description "A problem"
+
+      field :id, GraphQL::Types::ID, null: false
+      field :title, Decidim::Core::TranslatedFieldType, "The title of this problem (same as the component name).", null: false
+      field :description, Decidim::Core::TranslatedFieldType, "The description of this problem.", null: true
+      field :challenge, Decidim::Challenges::ChallengeType, "The related Challenge", null: true
+      field :sectorial_scope, Decidim::Core::ScopeApiType, "The object's sectorial scope", null: true
+      field :technological_scope, Decidim::Core::ScopeApiType, "The object's technological scope", null: true
+      field :tags, Decidim::Core::TranslatedFieldType, "The tags of this problem.", null: true
+      field :state, GraphQL::Types::String, "The state for this problem.", null: true
+      field :start_date, Decidim::Core::DateType, "The start date", null: true
+      field :end_date, Decidim::Core::DateType, "The end date", null: true
+      field :published_at, Decidim::Core::DateTimeType, "The moment at which it was published", null: true
+      field :causes, GraphQL::Types::String, "The entities proposing this problem.", null: true
+      field :groups_affected, GraphQL::Types::String, "The entities proposing this problem.", null: true
+      field :proposing_entities, GraphQL::Types::String, "The entities proposing this problem.", null: true
+      field :collaborating_entities, GraphQL::Types::String, "The entities collaborating with this problem.", null: true
+    end
+  end
+end

data/app/types/decidim/problems/problems_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Problems
+    class ProblemsType < Decidim::Api::Types::BaseObject
+      implements Decidim::Core::ComponentInterface
+
+      graphql_name "Problems"
+      description "A problems component of a participatory space."
+
+      field :problems, ProblemType.connection_type, null: true, connection: true
+
+      def problems
+        ProblemsTypeHelper.base_scope(object).includes(:component)
+      end
+
+      field(:problem, ProblemType, null: true) do
+        argument :id, GraphQL::Types::ID, required: true
+      end
+
+      def problem(**args)
+        ProblemsTypeHelper.base_scope(object).find_by(id: args[:id])
+      end
+    end
+
+    module ProblemsTypeHelper
+      def self.base_scope(component)
+        Problem.where(component:).published
+      end
+    end
+  end
+end

data/app/types/decidim/solutions/solution_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Solutions
+    class SolutionType < Decidim::Api::Types::BaseObject
+      implements Decidim::Core::TraceableInterface
+      implements Decidim::Core::TimestampsInterface
+
+      graphql_name "Solution"
+      description "A solution"
+
+      field :id, GraphQL::Types::ID, null: false
+      field :title, Decidim::Core::TranslatedFieldType, "The title of this solution (same as the component name).", null: false
+      field :description, Decidim::Core::TranslatedFieldType, "The description of this solution.", null: true
+      field :problem, Decidim::Problems::ProblemType, "The related Problem", null: true
+      field :tags, Decidim::Core::TranslatedFieldType, "The tags of this solution.", null: true
+      field :indicators, Decidim::Core::TranslatedFieldType, "The indicators of this solution.", null: true
+      field :beneficiaries, Decidim::Core::TranslatedFieldType, "The beneficiaries of this solution.", null: true
+      field :requirements, Decidim::Core::TranslatedFieldType, "The requirements of this solution.", null: true
+      field :financing_type, Decidim::Core::TranslatedFieldType, "The financing_type of this solution.", null: true
+      field :objectives, Decidim::Core::TranslatedFieldType, "The objectives of this solution.", null: true
+      field :published_at, Decidim::Core::DateTimeType, "The moment at which it was published", null: true
+    end
+  end
+end