decidim-consultations 0.23.3 → 0.24.1

data/lib/decidim/api/consultation_type.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # This type represents a consultation.
+    class ConsultationType < Decidim::Api::Types::BaseObject
+      implements Decidim::Core::ParticipatorySpaceInterface
+
+      description "A consultation"
+
+      field :subtitle, Decidim::Core::TranslatedFieldType, "The subtitle of this consultation", null: true
+      field :description, Decidim::Core::TranslatedFieldType, "The description of this consultation", null: true
+      field :slug, GraphQL::Types::String, "Slug of this consultation", null: false
+      field :created_at, Decidim::Core::DateTimeType, "The time this consultation was created", null: false
+      field :updated_at, Decidim::Core::DateTimeType, "The time this consultation was updated", null: false
+      field :published_at, Decidim::Core::DateTimeType, "The time this consultation was published", null: false
+
+      field :introductory_video_url, GraphQL::Types::String, "The introductory video url for this consultation", null: true
+      field :introductory_image, GraphQL::Types::String, "The introductory image for this consultation", null: true
+      field :banner_image, GraphQL::Types::String, "The banner image for this consultation", null: true
+      field :highlighted_scope, Decidim::Core::ScopeApiType, "This is the highlighted scope of this consultation", null: true
+      field :start_voting_date, Decidim::Core::DateType, "Start date of the voting for this consultation", null: true
+      field :end_voting_date, Decidim::Core::DateType, "End date of the voting for this consultation", null: true
+      field :results_published_at, Decidim::Core::DateType, "Date when the results have been published", null: true
+
+      field :questions, [Decidim::Consultations::ConsultationQuestionType, { null: true }], "", null: true
+    end
+  end
+end

data/lib/decidim/consultations.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "decidim/consultations/admin"
+require "decidim/consultations/api"
 require "decidim/consultations/engine"
 require "decidim/consultations/admin_engine"
 require "decidim/consultations/participatory_space"

data/lib/decidim/consultations/admin_engine.rb

@@ -53,16 +53,40 @@ module Decidim
         end
       end
 
+      initializer "decidim_consultations.admin_consultation_menu" do
+        Decidim.menu :admin_consultation_menu do |menu|
+          menu.item I18n.t("info", scope: "decidim.admin.menu.consultations_submenu"),
+                    decidim_admin_consultations.edit_consultation_path(current_consultation),
+                    position: 1.0,
+                    active: is_active_link?(decidim_admin_consultations.edit_consultation_path(current_consultation)),
+                    if: allowed_to?(:update, :consultation, consultation: current_consultation)
+          menu.item I18n.t("questions", scope: "decidim.admin.menu.consultations_submenu"),
+                    decidim_admin_consultations.consultation_questions_path(current_consultation),
+                    position: 1.1,
+                    active: is_active_link?(decidim_admin_consultations.consultation_questions_path(current_consultation)),
+                    if: allowed_to?(:read, :question)
+          menu.item I18n.t("results", scope: "decidim.admin.menu.consultations_submenu"),
+                    decidim_admin_consultations.results_consultation_path(current_consultation),
+                    position: 1.0,
+                    active: is_active_link?(decidim_admin_consultations.results_consultation_path(current_consultation)),
+                    if: allowed_to?(:read, :question)
+        end
+      end
       initializer "decidim_consultations.admin_menu" do
         Decidim.menu :admin_menu do |menu|
           menu.item I18n.t("menu.consultations", scope: "decidim.admin"),
                     decidim_admin_consultations.consultations_path,
                     icon_name: "comment-square",
-                    position: 3.8,
+                    position: 2.65,
                     active: :inclusive,
                     if: allowed_to?(:enter, :space_area, space_name: :consultations)
         end
       end
+      initializer "decidim_consultations.action_controller" do |_app|
+        ActiveSupport.on_load :action_controller do
+          helper Decidim::Consultations::Admin::ConsultationMenuHelper if respond_to?(:helper)
+        end
+      end
     end
   end
 end

data/lib/decidim/consultations/api.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    autoload :ConsultationType, "decidim/api/consultation_type"
+    autoload :ConsultationQuestionType, "decidim/api/consultation_question_type"
+  end
+end

data/lib/decidim/consultations/engine.rb

@@ -4,6 +4,8 @@ require "rails"
 require "active_support/all"
 require "decidim/core"
 
+require "decidim/consultations/query_extensions"
+
 module Decidim
   module Consultations
     # Decidim"s Consultations Rails Engine.
@@ -72,7 +74,7 @@ module Decidim
         Decidim.menu :menu do |menu|
           menu.item I18n.t("menu.consultations", scope: "decidim"),
                     decidim_consultations.consultations_path,
-                    position: 2.7,
+                    position: 2.65,
                     if: Decidim::Consultation.where(organization: current_organization).published.any?,
                     active: :inclusive
         end
@@ -89,6 +91,10 @@ module Decidim
           end
         end
       end
+
+      initializer "decidim_consultations.query_extensions" do
+        Decidim::Api::QueryType.include Decidim::Consultations::QueryExtensions
+      end
     end
   end
 end

data/lib/decidim/consultations/participatory_space.rb

@@ -40,11 +40,11 @@ Decidim.register_participatory_space(:consultations) do |participatory_space|
 
     # Active consultation
     active_consultation_params = {
-      slug: Faker::Internet.unique.slug(nil, "-"),
-      title: Decidim::Faker::Localized.sentence(3),
-      subtitle: Decidim::Faker::Localized.sentence(3),
+      slug: Decidim::Faker::Internet.unique.slug(words: nil, glue: "-"),
+      title: Decidim::Faker::Localized.sentence(word_count: 3),
+      subtitle: Decidim::Faker::Localized.sentence(word_count: 3),
       description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
-        Decidim::Faker::Localized.paragraph(3)
+        Decidim::Faker::Localized.paragraph(sentence_count: 3)
       end,
       published_at: Time.now.utc,
       start_voting_date: Time.zone.today,
@@ -66,11 +66,11 @@ Decidim.register_participatory_space(:consultations) do |participatory_space|
     active_consultation.add_to_index_as_search_resource
 
     finished_consultation_params = {
-      slug: Faker::Internet.unique.slug(nil, "-"),
-      title: Decidim::Faker::Localized.sentence(3),
-      subtitle: Decidim::Faker::Localized.sentence(3),
+      slug: Decidim::Faker::Internet.unique.slug(words: nil, glue: "-"),
+      title: Decidim::Faker::Localized.sentence(word_count: 3),
+      subtitle: Decidim::Faker::Localized.sentence(word_count: 3),
       description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
-        Decidim::Faker::Localized.paragraph(3)
+        Decidim::Faker::Localized.paragraph(sentence_count: 3)
       end,
       published_at: Time.zone.today - 2.months,
       results_published_at: Time.zone.today - 1.month,
@@ -93,11 +93,11 @@ Decidim.register_participatory_space(:consultations) do |participatory_space|
     finished_consultation.add_to_index_as_search_resource
 
     upcoming_consultation_params = {
-      slug: Faker::Internet.unique.slug(nil, "-"),
-      title: Decidim::Faker::Localized.sentence(3),
-      subtitle: Decidim::Faker::Localized.sentence(3),
+      slug: Decidim::Faker::Internet.unique.slug(words: nil, glue: "-"),
+      title: Decidim::Faker::Localized.sentence(word_count: 3),
+      subtitle: Decidim::Faker::Localized.sentence(word_count: 3),
       description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
-        Decidim::Faker::Localized.paragraph(3)
+        Decidim::Faker::Localized.paragraph(sentence_count: 3)
       end,
       published_at: Time.zone.today + 1.month,
       start_voting_date: Time.zone.today + 1.month + 1.day,
@@ -122,21 +122,21 @@ Decidim.register_participatory_space(:consultations) do |participatory_space|
       4.times do
         params = {
           consultation: consultation,
-          slug: Faker::Internet.unique.slug(nil, "-"),
+          slug: Decidim::Faker::Internet.unique.slug(words: nil, glue: "-"),
           decidim_scope_id: Decidim::Scope.reorder(Arel.sql("RANDOM()")).first.id,
-          title: Decidim::Faker::Localized.sentence(3),
-          subtitle: Decidim::Faker::Localized.sentence(3),
+          title: Decidim::Faker::Localized.sentence(word_count: 3),
+          subtitle: Decidim::Faker::Localized.sentence(word_count: 3),
           what_is_decided: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
-            Decidim::Faker::Localized.paragraph(3)
+            Decidim::Faker::Localized.paragraph(sentence_count: 3)
           end,
           question_context: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
-            Decidim::Faker::Localized.paragraph(3)
+            Decidim::Faker::Localized.paragraph(sentence_count: 3)
           end,
           organization: organization,
           hero_image: File.new(File.join(seeds_root, "city.jpeg")), # Keep after organization
           banner_image: File.new(File.join(seeds_root, "city2.jpeg")), # Keep after organization
-          promoter_group: Decidim::Faker::Localized.sentence(3),
-          participatory_scope: Decidim::Faker::Localized.sentence(3),
+          promoter_group: Decidim::Faker::Localized.sentence(word_count: 3),
+          participatory_scope: Decidim::Faker::Localized.sentence(word_count: 3),
           published_at: Time.now.utc
         }
 
@@ -152,22 +152,22 @@ Decidim.register_participatory_space(:consultations) do |participatory_space|
         2.times do
           Decidim::Consultations::Response.create(
             question: question,
-            title: Decidim::Faker::Localized.sentence(3)
+            title: Decidim::Faker::Localized.sentence(word_count: 3)
           )
         end
 
         Decidim::Comments::Seed.comments_for(question)
 
         Decidim::Attachment.create!(
-          title: Decidim::Faker::Localized.sentence(2),
-          description: Decidim::Faker::Localized.sentence(5),
+          title: Decidim::Faker::Localized.sentence(word_count: 2),
+          description: Decidim::Faker::Localized.sentence(word_count: 5),
           attached_to: question,
           file: File.new(File.join(seeds_root, "city.jpeg")) # Keep after attached_to
         )
 
         Decidim::Attachment.create!(
-          title: Decidim::Faker::Localized.sentence(2),
-          description: Decidim::Faker::Localized.sentence(5),
+          title: Decidim::Faker::Localized.sentence(word_count: 2),
+          description: Decidim::Faker::Localized.sentence(word_count: 5),
           attached_to: question,
           file: File.new(File.join(seeds_root, "Exampledocument.pdf")) # Keep after attached_to
         )

data/lib/decidim/consultations/query_extensions.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Consultations
+    # This module's job is to extend the API with custom fields related to
+    # decidim-assemblies.
+    module QueryExtensions
+      # Public: Extends a type with `decidim-assemblies`'s fields.
+      #
+      # type - A GraphQL::BaseType to extend.
+      #
+      # Returns nothing.
+      def self.included(type)
+        type.field :consultations,
+                   [Decidim::Consultations::ConsultationType],
+                   null: true,
+                   description: "Lists all consultations" do
+          argument :filter, Decidim::ParticipatoryProcesses::ParticipatoryProcessInputFilter, "This argument let's you filter the results", required: false
+          argument :order, Decidim::ParticipatoryProcesses::ParticipatoryProcessInputSort, "This argument let's you order the results", required: false
+        end
+
+        type.field :consultation,
+                   Decidim::Consultations::ConsultationType,
+                   null: true,
+                   description: "Finds a consultation" do
+          argument :id, GraphQL::Types::ID, "The ID of the participatory space", required: false
+        end
+      end
+
+      def consultations(filter: {}, order: {})
+        manifest = Decidim.participatory_space_manifests.select { |m| m.name == :consultations }.first
+
+        Decidim::Core::ParticipatorySpaceListBase.new(manifest: manifest).call(object, { filter: filter, order: order }, context)
+      end
+
+      def consultation(id: nil)
+        manifest = Decidim.participatory_space_manifests.select { |m| m.name == :consultations }.first
+
+        Decidim::Core::ParticipatorySpaceFinderBase.new(manifest: manifest).call(object, { id: id }, context)
+      end
+    end
+  end
+end

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

@@ -5,11 +5,11 @@ require "decidim/dev"
 
 FactoryBot.define do
   sequence(:consultation_slug) do |n|
-    "#{Faker::Internet.slug(nil, "-")}-#{n}"
+    "#{Decidim::Faker::Internet.slug(words: nil, glue: "-")}-#{n}"
   end
 
   sequence(:question_slug) do |n|
-    "#{Faker::Internet.slug(nil, "-")}-#{n}"
+    "#{Decidim::Faker::Internet.slug(words: nil, glue: "-")}-#{n}"
   end
 
   factory :consultation, class: "Decidim::Consultation" do

data/lib/decidim/consultations/version.rb

@@ -3,7 +3,7 @@
 module Decidim
   module Consultations
     def self.version
-      "0.23.3"
+      "0.24.1"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-consultations
 version: !ruby/object:Gem::Version
-  version: 0.23.3
+  version: 0.24.1
 platform: ruby
 authors:
 - Juan Salvador Perez Garcia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-23 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-admin
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.3
+        version: 0.24.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.3
+        version: 0.24.1
 - !ruby/object:Gem::Dependency
   name: decidim-comments
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.3
+        version: 0.24.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.3
+        version: 0.24.1
 - !ruby/object:Gem::Dependency
   name: decidim-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.3
+        version: 0.24.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.3
+        version: 0.24.1
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.3
+        version: 0.24.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.3
+        version: 0.24.1
 description: Extends Decidim adding a first level public consultation component
 email:
 - jsperezg@gmail.com
@@ -165,6 +165,7 @@ files:
 - app/forms/decidim/consultations/admin/response_group_form.rb
 - app/forms/decidim/consultations/multi_vote_form.rb
 - app/forms/decidim/consultations/vote_form.rb
+- app/helpers/decidim/consultations/admin/consultation_menu_helper.rb
 - app/helpers/decidim/consultations/admin/consultations_helper.rb
 - app/helpers/decidim/consultations/admin/questions_helper.rb
 - app/helpers/decidim/consultations/consultations_helper.rb
@@ -185,8 +186,6 @@ files:
 - app/queries/decidim/consultations/organization_consultations.rb
 - app/queries/decidim/consultations/organization_questions.rb
 - app/services/decidim/consultations/consultation_search.rb
-- app/types/decidim/consultations/consultation_question_type.rb
-- app/types/decidim/consultations/consultation_type.rb
 - app/views/decidim/consultations/_consultation.html.erb
 - app/views/decidim/consultations/admin/consultations/_form.html.erb
 - app/views/decidim/consultations/admin/consultations/edit.html.erb
@@ -349,15 +348,20 @@ files:
 - db/migrate/20190710121122_add_free_instructions_field_to_consultations_questions.rb
 - db/migrate/20200320105916_index_foreign_keys_in_decidim_consultations_votes.rb
 - db/migrate/20200827154143_add_commentable_counter_cache_to_consultations.rb
+- db/migrate/20210310120626_add_followable_counter_cache_to_consultations.rb
 - db/seeds/Exampledocument.pdf
 - db/seeds/city.jpeg
 - db/seeds/city2.jpeg
 - db/seeds/homepage_image.jpg
+- lib/decidim/api/consultation_question_type.rb
+- lib/decidim/api/consultation_type.rb
 - lib/decidim/consultations.rb
 - lib/decidim/consultations/admin.rb
 - lib/decidim/consultations/admin_engine.rb
+- lib/decidim/consultations/api.rb
 - lib/decidim/consultations/engine.rb
 - lib/decidim/consultations/participatory_space.rb
+- lib/decidim/consultations/query_extensions.rb
 - lib/decidim/consultations/test/factories.rb
 - lib/decidim/consultations/version.rb
 homepage: https://github.com/decidim/decidim
@@ -372,14 +376,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Decidim consultations module

data/app/types/decidim/consultations/consultation_question_type.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module Decidim
-  module Consultations
-    # This type represents a consultation.
-    ConsultationQuestionType = GraphQL::ObjectType.define do
-      interfaces [
-        -> { Decidim::Core::ScopableInterface },
-        -> { Decidim::Core::AttachableInterface },
-        -> { Decidim::Comments::CommentableInterface }
-      ]
-
-      name "ConsultationQuestion"
-      description "A consultation question"
-
-      field :id, !types.ID, "Internal ID of the question"
-      field :title, Decidim::Core::TranslatedFieldType, "Title of the question"
-      field :subtitle, Decidim::Core::TranslatedFieldType, "The subtitle of this question"
-      field :slug, !types.String, "Slug of the question"
-      field :createdAt, !Decidim::Core::DateTimeType, "The time this question was created", property: :created_at
-      field :updatedAt, !Decidim::Core::DateTimeType, "The time this question was updated", property: :updated_at
-      field :publishedAt, !Decidim::Core::DateTimeType, "The time this question was published", property: :published_at
-
-      field :components, types[Decidim::Core::ComponentInterface] do
-        description "Lists the components this space contains."
-
-        resolve ->(participatory_space, _args, _ctx) {
-                  Decidim::Component.where(
-                    participatory_space: participatory_space
-                  ).published
-                }
-      end
-
-      field :bannerImage, types.String, "The banner image for this question", property: :banner_image
-      field :heroImage, types.String, "The hero image for this question", property: :hero_image
-
-      field :whatIsDecided, Decidim::Core::TranslatedFieldType, "What is decided in this question", property: :what_is_decided
-      field :promoterGroup, Decidim::Core::TranslatedFieldType, "The promoter group of this question", property: :promoter_group
-      field :participatoryScope, Decidim::Core::TranslatedFieldType, "The participatory scope of this question", property: :participatory_scope
-      field :questionContext, Decidim::Core::TranslatedFieldType, "The context for this question", property: :question_context
-      field :reference, types.String, "The reference for this question", property: :reference
-      field :hashtag, types.String, "The hashtag of this question", property: :hashtag
-      field :votesCount, types.Int, "The number of votes in this question", property: :votes_count
-      field :originScope, Decidim::Core::TranslatedFieldType, "The origin scope of this question", property: :origin_scope
-      field :originTitle, Decidim::Core::TranslatedFieldType, "The origin title of this question", property: :origin_title
-      field :originUrl, types.String, "The origin URL for this question", property: :origin_url
-      field :iFrameUrl, types.String, "The iframe URL for this question", property: :i_frame_url
-      field :externalVoting, types.Boolean, "If the question has external voting", property: :external_voting
-      field :responsesCount, types.Int, "The number of responses for this question", property: :responses_count
-      field :order, types.Int, "The order in which the question should be represented", property: :order
-      field :maxVotes, types.Int, "The maximum number of votes in this question", property: :max_votes
-      field :minVotes, types.Int, "The minimum number of votes in this question", property: :min_votes
-      field :responseGroupsCount, types.Int, "The number of group responses for this question", property: :response_groups_count
-      field :instructions, Decidim::Core::TranslatedFieldType, "Instructions for this question", property: :instructions
-    end
-  end
-end