decidim-consultations 0.11.0.pre1

data/db/migrate/20180129063438_add_i_frame_url_to_decidim_consultations_questions.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddIFrameUrlToDecidimConsultationsQuestions < ActiveRecord::Migration[5.1]
+  def change
+    add_column :decidim_consultations_questions, :i_frame_url, :string
+    add_column :decidim_consultations_questions, :external_voting, :boolean
+  end
+end

data/db/migrate/20180129063700_create_decidim_consultations_responses.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class CreateDecidimConsultationsResponses < ActiveRecord::Migration[5.1]
+  def change
+    create_table :decidim_consultations_responses do |t|
+      t.jsonb :title
+      t.references :decidim_consultations_questions,
+                   foreign_key: true,
+                   index: { name: "index_consultations_responses_on_consultation_questions" }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180129122226_rename_decidim_consultations_vote_to_decidim_consultations_endorsement.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class RenameDecidimConsultationsVoteToDecidimConsultationsEndorsement < ActiveRecord::Migration[5.1]
+  def change
+    rename_table :decidim_consultations_votes, :decidim_consultations_endorsements
+  end
+end

data/db/migrate/20180129122504_rename_decidim_consultations_questions_votes_count_to_endorsements_count.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class RenameDecidimConsultationsQuestionsVotesCountToEndorsementsCount < ActiveRecord::Migration[5.1]
+  def change
+    rename_column :decidim_consultations_questions, :votes_count, :endorsements_count
+  end
+end

data/db/migrate/20180130060754_add_responses_count_to_decidim_consultations_questions.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class AddResponsesCountToDecidimConsultationsQuestions < ActiveRecord::Migration[5.1]
+  def change
+    add_column :decidim_consultations_questions, :responses_count, :integer, null: false, default: 0
+
+    reversible do |dir|
+      dir.up { initialize_counter }
+    end
+  end
+
+  def initialize_counter
+    execute <<-SQL.squish
+      UPDATE decidim_consultations_questions
+         SET responses_count = (
+           select count(1)
+           from decidim_consultations_responses
+           where decidim_consultations_questions_id = decidim_consultations_questions.id
+         )
+    SQL
+  end
+end

data/db/migrate/20180130110449_rename_vote_related_attributes.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class RenameVoteRelatedAttributes < ActiveRecord::Migration[5.1]
+  def change
+    rename_column :decidim_consultations, :start_voting_date, :start_endorsing_date
+    rename_column :decidim_consultations, :end_voting_date, :end_endorsing_date
+    rename_column :decidim_consultations_questions, :external_voting, :external_endorsement
+  end
+end

data/db/migrate/20180130142018_add_decidim_user_group_id_to_decidim_consultations_endorsements.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddDecidimUserGroupIdToDecidimConsultationsEndorsements < ActiveRecord::Migration[5.1]
+  def change
+    add_column :decidim_consultations_endorsements, :decidim_user_group_id, :integer, index: true
+  end
+end

data/db/migrate/20180130142411_rename_vote_indexes_to_endorsement_indexes.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class RenameVoteIndexesToEndorsementIndexes < ActiveRecord::Migration[5.1]
+  def change
+    rename_index :decidim_consultations_endorsements,
+                 :index_consultations_votes_on_author,
+                 :index_consultations_endorsements_on_author
+
+    rename_index :decidim_consultations_endorsements,
+                 :index_consultations_votes_on_consultation_question,
+                 :index_consultations_endorsements_on_consultation_question
+
+    reversible do |dir|
+      dir.up { create_authorable_unique }
+      dir.down { create_author_unique }
+    end
+  end
+
+  def create_authorable_unique
+    remove_index :decidim_consultations_endorsements, name: "index_question_votes_author_unique"
+
+    add_index :decidim_consultations_endorsements,
+              %w(decidim_consultation_question_id decidim_author_id decidim_user_group_id),
+              name: "index_question_votes_author_unique",
+              unique: true
+  end
+
+  def create_author_unique
+    remove_index :decidim_consultations_endorsements, name: "index_question_votes_author_unique"
+
+    add_index :decidim_consultations_endorsements,
+              %w(decidim_consultation_question_id decidim_author_id),
+              name: "index_question_votes_author_unique",
+              unique: true
+  end
+end

data/db/migrate/20180131083844_add_response_to_decidim_consultations_endorsements.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class AddResponseToDecidimConsultationsEndorsements < ActiveRecord::Migration[5.1]
+  def change
+    add_reference :decidim_consultations_endorsements,
+                  :decidim_consultations_response,
+                  foreign_key: true,
+                  index: { name: "index_consultations_endorsements_on_consultations_response_id" }
+  end
+end

data/db/migrate/20180201135823_rename_endorsement_to_vote.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class RenameEndorsementToVote < ActiveRecord::Migration[5.1]
+  def change
+    rename_table :decidim_consultations_endorsements, :decidim_consultations_votes
+    rename_column :decidim_consultations_questions, :endorsements_count, :votes_count
+    rename_column :decidim_consultations, :start_endorsing_date, :start_voting_date
+    rename_column :decidim_consultations, :end_endorsing_date, :end_voting_date
+    rename_column :decidim_consultations_questions, :external_endorsement, :external_voting
+
+    rename_index :decidim_consultations_votes,
+                 :index_consultations_endorsements_on_author,
+                 :index_consultations_votes_on_author
+
+    rename_index :decidim_consultations_votes,
+                 :index_consultations_endorsements_on_consultation_question,
+                 :index_consultations_votes_on_consultation_question
+
+    rename_index :decidim_consultations_votes,
+                 :index_consultations_endorsements_on_consultations_response_id,
+                 :index_consultations_votes_on_consultations_response_id
+  end
+end

data/db/migrate/20180202050920_add_hero_image_to_decidim_consultations_question.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddHeroImageToDecidimConsultationsQuestion < ActiveRecord::Migration[5.1]
+  def change
+    add_column :decidim_consultations_questions, :hero_image, :string
+    remove_column :decidim_consultations_questions, :introductory_video_url, :string
+  end
+end

data/db/migrate/20180202085309_add_results_published_at_to_decidim_consultations.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddResultsPublishedAtToDecidimConsultations < ActiveRecord::Migration[5.1]
+  def change
+    add_column :decidim_consultations, :results_published_at, :date, index: true
+  end
+end

data/db/migrate/20180202133655_add_votes_count_to_decidim_consultations_response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddVotesCountToDecidimConsultationsResponse < ActiveRecord::Migration[5.1]
+  def change
+    add_column :decidim_consultations_responses, :votes_count, :integer, null: false, default: 0
+  end
+end

data/db/migrate/20180212100503_remove_enable_highlighted_banner_flag.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class RemoveEnableHighlightedBannerFlag < ActiveRecord::Migration[5.1]
+  def change
+    remove_column :decidim_consultations, :enable_highlighted_banner, :boolean, null: false, default: true
+  end
+end

data/db/migrate/20180219092120_add_order_to_decidim_consultations_questions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddOrderToDecidimConsultationsQuestions < ActiveRecord::Migration[5.1]
+  def change
+    add_column :decidim_consultations_questions, :order, :integer, index: true
+  end
+end

data/db/migrate/20180320100658_add_introductory_image_to_decidim_consultations.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddIntroductoryImageToDecidimConsultations < ActiveRecord::Migration[5.1]
+  def change
+    add_column :decidim_consultations, :introductory_image, :string
+  end
+end

data/lib/decidim/consultations.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "decidim/consultations/admin"
+require "decidim/consultations/engine"
+require "decidim/consultations/admin_engine"
+require "decidim/consultations/participatory_space"
+
+module Decidim
+  # Base module for the consultations engine.
+  module Consultations
+    include ActiveSupport::Configurable
+
+    # Sets the expiration time for the statistic data.
+    config_accessor :stats_cache_expiration_time do
+      5.minutes
+    end
+  end
+end

data/lib/decidim/consultations/admin.rb

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

data/lib/decidim/consultations/admin_engine.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "rails"
+require "active_support/all"
+require "decidim/core"
+
+module Decidim
+  module Consultations
+    # Decidim's Consultations Rails Admin Engine.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::Consultations::Admin
+
+      paths["db/migrate"] = nil
+
+      routes do
+        resources :consultations, param: :slug, except: :show do
+          resource :publish, controller: "consultation_publications", only: [:create, :destroy]
+          resource :publish_results, controller: "consultation_results_publications", only: [:create, :destroy]
+          resources :questions, param: :slug, except: :show, shallow: true do
+            resource :publish, controller: "question_publications", only: [:create, :destroy]
+          end
+        end
+
+        scope "/questions/:question_slug" do
+          resources :categories
+          resources :components do
+            resource :permissions, controller: "component_permissions"
+            member do
+              put :publish
+              put :unpublish
+            end
+            resources :exports, only: :create
+          end
+
+          resources :question_attachments
+          resources :responses, except: :show
+        end
+
+        scope "/questions/:question_slug/components/:component_id/manage" do
+          Decidim.component_manifests.each do |manifest|
+            next unless manifest.admin_engine
+
+            constraints CurrentComponent.new(manifest) do
+              mount manifest.admin_engine, at: "/", as: "decidim_admin_question_#{manifest.name}"
+            end
+          end
+        end
+      end
+
+      initializer "decidim_consultations.inject_abilities_to_user" do |_app|
+        Decidim.configure do |config|
+          config.admin_abilities += %w(
+            Decidim::Consultations::Abilities::Admin::ConsultationAdminAbility
+            Decidim::Consultations::Abilities::Admin::QuestionAdminAbility
+            Decidim::Consultations::Abilities::Admin::ResponseAdminAbility
+          )
+        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,
+                    active: :inclusive,
+                    if: can?(:index, Decidim::Consultation)
+        end
+      end
+    end
+  end
+end

data/lib/decidim/consultations/engine.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "rails"
+require "active_support/all"
+require "decidim/core"
+
+module Decidim
+  module Consultations
+    # Decidim"s Consultations Rails Engine.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::Consultations
+
+      routes do
+        get "/consultations/:consultation_id", to: redirect { |params, _request|
+          consultation = Decidim::Consultation.find(params[:consultation_id])
+          consultation ? "/consultations/#{consultation.slug}" : "/404"
+        }, constraints: { consultation_id: /[0-9]+/ }
+
+        get "/questions/:question_id", to: redirect { |params, _request|
+          question = Decidim::Consultations::Question.find(params[:question_id])
+          question ? "/questions/#{question.slug}" : "/404"
+        }, constraints: { question_id: /[0-9]+/ }
+
+        resources :consultations, only: [:index, :show], param: :slug, path: "consultations" do
+          get "finished", on: :collection
+          resource :consultation_widget, only: :show, path: "embed"
+
+          resources :questions, only: [:show], param: :slug, path: "questions", shallow: true do
+            resource :question_widget, only: :show, path: "embed"
+            resource :question_votes, only: [:create, :destroy], path: "vote"
+          end
+        end
+
+        get "/questions/:question_id/f/:component_id", to: redirect { |params, _request|
+          consultation = Decidim::Consultations::Question.find(params[:question_id])
+          consultation ? "/questions/#{question.slug}/f/#{params[:component_id]}" : "/404"
+        }, constraints: { question_id: /[0-9]+/ }
+
+        scope "/questions/:question_slug/f/:component_id" do
+          Decidim.component_manifests.each do |manifest|
+            next unless manifest.engine
+
+            constraints CurrentComponent.new(manifest) do
+              mount manifest.engine, at: "/", as: "decidim_question_#{manifest.name}"
+            end
+          end
+        end
+      end
+
+      initializer "decidim_consultations.assets" do |app|
+        app.config.assets.precompile += %w(
+          decidim_consultations_manifest.js
+          decidim_consultations_manifest.scss
+        )
+      end
+
+      initializer "decidim_consultations.inject_abilities_to_user" do |_app|
+        Decidim.configure do |config|
+          config.abilities += %w(
+            Decidim::Consultations::Abilities::EveryoneAbility
+            Decidim::Consultations::Abilities::CurrentUserAbility
+          )
+        end
+      end
+
+      initializer "decidim.stats" do
+        Decidim.stats.register :consultations_count, priority: StatsRegistry::HIGH_PRIORITY do |organization, _start_at, _end_at|
+          Decidim::Consultation.where(organization: organization).published.count
+        end
+      end
+
+      initializer "decidim_consultations.menu" do
+        Decidim.menu :menu do |menu|
+          menu.item I18n.t("menu.consultations", scope: "decidim"),
+                    decidim_consultations.consultations_path,
+                    position: 2.7,
+                    if: Decidim::Consultation.where(organization: current_organization).published.any?,
+                    active: :inclusive
+        end
+      end
+    end
+  end
+end

data/lib/decidim/consultations/participatory_space.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+Decidim.register_participatory_space(:consultations) do |participatory_space|
+  participatory_space.icon = "decidim/consultations/icon.svg"
+  participatory_space.model_class_name = "Decidim::Consultations::Question"
+
+  participatory_space.participatory_spaces do |organization|
+    Decidim::Consultations::Question.where(organization: organization)
+  end
+
+  participatory_space.context(:public) do |context|
+    context.engine = Decidim::Consultations::Engine
+    context.layout = "layouts/decidim/question"
+    context.helper = "Decidim::Consultations::ConsultationsHelper"
+  end
+
+  participatory_space.context(:admin) do |context|
+    context.engine = Decidim::Consultations::AdminEngine
+    context.layout = "layouts/decidim/admin/question"
+  end
+
+  participatory_space.seeds do
+    seeds_root = File.join(__dir__, "..", "..", "..", "db", "seeds")
+    organization = Decidim::Organization.first
+
+    # Active consultation
+    consultation = Decidim::Consultation.create!(
+      slug: Faker::Internet.unique.slug(nil, "-"),
+      title: Decidim::Faker::Localized.sentence(3),
+      subtitle: Decidim::Faker::Localized.sentence(3),
+      description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+        Decidim::Faker::Localized.paragraph(3)
+      end,
+      published_at: Time.now.utc,
+      start_voting_date: Time.zone.today,
+      end_voting_date: Time.zone.today + 1.month,
+      banner_image: File.new(File.join(seeds_root, "city2.jpeg")),
+      introductory_video_url: "https://www.youtube.com/embed/zhMMW0TENNA",
+      decidim_highlighted_scope_id: Decidim::Scope.reorder("RANDOM()").first.id,
+      organization: organization
+    )
+
+    4.times do
+      question = Decidim::Consultations::Question.create!(
+        consultation: consultation,
+        slug: Faker::Internet.unique.slug(nil, "-"),
+        decidim_scope_id: Decidim::Scope.reorder("RANDOM()").first.id,
+        title: Decidim::Faker::Localized.sentence(3),
+        subtitle: Decidim::Faker::Localized.sentence(3),
+        what_is_decided: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+          Decidim::Faker::Localized.paragraph(3)
+        end,
+        question_context: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+          Decidim::Faker::Localized.paragraph(3)
+        end,
+        hero_image: File.new(File.join(seeds_root, "city.jpeg")),
+        banner_image: File.new(File.join(seeds_root, "city2.jpeg")),
+        promoter_group: Decidim::Faker::Localized.sentence(3),
+        participatory_scope: Decidim::Faker::Localized.sentence(3),
+        published_at: Time.now.utc,
+        organization: organization
+      )
+
+      2.times do
+        Decidim::Consultations::Response.create(
+          question: question,
+          title: Decidim::Faker::Localized.sentence(3)
+        )
+      end
+
+      Decidim::Comments::Seed.comments_for(question)
+
+      Decidim::Attachment.create!(
+        title: Decidim::Faker::Localized.sentence(2),
+        description: Decidim::Faker::Localized.sentence(5),
+        file: File.new(File.join(seeds_root, "city.jpeg")),
+        attached_to: question
+      )
+
+      Decidim::Attachment.create!(
+        title: Decidim::Faker::Localized.sentence(2),
+        description: Decidim::Faker::Localized.sentence(5),
+        file: File.new(File.join(seeds_root, "Exampledocument.pdf")),
+        attached_to: question
+      )
+    end
+
+    # Finished consultations
+    consultation = Decidim::Consultation.create!(
+      slug: Faker::Internet.unique.slug(nil, "-"),
+      title: Decidim::Faker::Localized.sentence(3),
+      subtitle: Decidim::Faker::Localized.sentence(3),
+      description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+        Decidim::Faker::Localized.paragraph(3)
+      end,
+      published_at: Time.zone.today - 2.months,
+      results_published_at: Time.zone.today - 1.month,
+      start_voting_date: Time.zone.today - 2.months,
+      end_voting_date: Time.zone.today - 1.month,
+      banner_image: File.new(File.join(seeds_root, "city2.jpeg")),
+      introductory_video_url: "https://www.youtube.com/embed/zhMMW0TENNA",
+      decidim_highlighted_scope_id: Decidim::Scope.reorder("RANDOM()").first.id,
+      organization: organization
+    )
+
+    4.times do
+      question = Decidim::Consultations::Question.create!(
+        consultation: consultation,
+        slug: Faker::Internet.unique.slug(nil, "-"),
+        decidim_scope_id: Decidim::Scope.reorder("RANDOM()").first.id,
+        title: Decidim::Faker::Localized.sentence(3),
+        subtitle: Decidim::Faker::Localized.sentence(3),
+        what_is_decided: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+          Decidim::Faker::Localized.paragraph(3)
+        end,
+        question_context: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+          Decidim::Faker::Localized.paragraph(3)
+        end,
+        banner_image: File.new(File.join(seeds_root, "city.jpeg")),
+        promoter_group: Decidim::Faker::Localized.sentence(3),
+        participatory_scope: Decidim::Faker::Localized.sentence(3),
+        hero_image: File.new(File.join(seeds_root, "city.jpeg")),
+        published_at: Time.now.utc,
+        organization: organization
+      )
+
+      2.times do |i|
+        response = Decidim::Consultations::Response.create(
+          question: question,
+          title: Decidim::Faker::Localized.sentence(3)
+        )
+
+        email = "question_vote_#{question.id}_#{response.id}_#{i}@example.org"
+
+        author = Decidim::User.find_or_initialize_by(email: email)
+        author.update!(
+          name: Faker::Name.name,
+          nickname: Faker::Twitter.unique.screen_name,
+          password: "decidim123456",
+          password_confirmation: "decidim123456",
+          organization: organization,
+          confirmed_at: Time.current,
+          locale: I18n.default_locale,
+          tos_agreement: true
+        )
+
+        Decidim::Consultations::Vote.create(
+          question: question,
+          response: response,
+          author: author
+        )
+      end
+
+      Decidim::Comments::Seed.comments_for(question)
+
+      Decidim::Attachment.create!(
+        title: Decidim::Faker::Localized.sentence(2),
+        description: Decidim::Faker::Localized.sentence(5),
+        file: File.new(File.join(seeds_root, "city.jpeg")),
+        attached_to: question
+      )
+
+      Decidim::Attachment.create!(
+        title: Decidim::Faker::Localized.sentence(2),
+        description: Decidim::Faker::Localized.sentence(5),
+        file: File.new(File.join(seeds_root, "Exampledocument.pdf")),
+        attached_to: question
+      )
+    end
+  end
+end