decidim-elections 0.22.0

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

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

data/app/models/decidim/elections/answer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # The data store for an Answer in the Decidim::Elections component. It stores a
+    # title, description and related resources and attachments.
+    class Answer < ApplicationRecord
+      include Decidim::Resourceable
+      include Decidim::HasAttachments
+      include Decidim::HasAttachmentCollections
+      include Traceable
+      include Loggable
+
+      delegate :component, to: :question
+      delegate :organization, :participatory_space, to: :component
+
+      belongs_to :question, foreign_key: "decidim_elections_question_id", class_name: "Decidim::Elections::Question", inverse_of: :answers
+
+      default_scope { order(weight: :asc, id: :asc) }
+
+      def proposals
+        linked_resources(:proposals, "related_proposals")
+      end
+    end
+  end
+end

data/app/models/decidim/elections/application_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/elections/election.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # The data store for an Election in the Decidim::Elections component. It stores a
+    # title, description and any other useful information to perform an election.
+    class Election < ApplicationRecord
+      include Decidim::Resourceable
+      include Decidim::HasComponent
+      include Traceable
+      include Loggable
+
+      component_manifest_name "elections"
+
+      has_many :questions, foreign_key: "decidim_elections_election_id", class_name: "Decidim::Elections::Question", inverse_of: :election, dependent: :destroy
+
+      def started?
+        start_time <= Time.current
+      end
+    end
+  end
+end

data/app/models/decidim/elections/question.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # The data store for a Question in the Decidim::Elections component. It stores a
+    # title, description and a maximum number of selection that voters can choose.
+    class Question < ApplicationRecord
+      include Decidim::Resourceable
+      include Traceable
+      include Loggable
+
+      delegate :component, to: :election
+
+      belongs_to :election, foreign_key: "decidim_elections_election_id", class_name: "Decidim::Elections::Election", inverse_of: :questions
+      has_many :answers, foreign_key: "decidim_elections_question_id", class_name: "Decidim::Elections::Answer", inverse_of: :question, dependent: :destroy
+
+      default_scope { order(weight: :asc, id: :asc) }
+    end
+  end
+end

data/app/permissions/decidim/elections/admin/permissions.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    module Admin
+      class Permissions < Decidim::DefaultPermissions
+        def permissions
+          return permission_action if permission_action.scope != :admin
+
+          case permission_action.subject
+          when :question, :answer
+            case permission_action.action
+            when :create, :update, :delete
+              allow_if_not_started
+            end
+          when :election
+            case permission_action.action
+            when :create, :read
+              allow!
+            when :update
+              toggle_allow(election)
+            when :delete
+              allow_if_not_started
+            end
+          end
+
+          permission_action
+        end
+
+        private
+
+        def election
+          @election ||= context.fetch(:election, nil)
+        end
+
+        def allow_if_not_started
+          toggle_allow(election && !election.started?)
+        end
+      end
+    end
+  end
+end

data/app/permissions/decidim/elections/permissions.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    class Permissions < Decidim::DefaultPermissions
+      def permissions
+        return permission_action unless user
+
+        # Delegate the admin permission checks to the admin permissions class
+        return Decidim::Elections::Admin::Permissions.new(user, permission_action, context).permissions if permission_action.scope == :admin
+
+        permission_action
+      end
+    end
+  end
+end

data/app/types/decidim/elections/election_answer_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # This type represents an answer to an election question.
+    # The name is different from the model because to enforce consistency with Question type name.
+    ElectionAnswerType = GraphQL::ObjectType.define do
+      interfaces [
+        -> { Decidim::Core::AttachableInterface },
+        -> { Decidim::Core::TraceableInterface }
+      ]
+
+      name "ElectionAnswer"
+      description "An answer for an election's question"
+
+      field :id, !types.ID, "The internal ID of this answer"
+      field :title, !Decidim::Core::TranslatedFieldType, "The title for this answer"
+      field :description, Decidim::Core::TranslatedFieldType, "The description for this answer"
+      field :weight, types.Int, "The ordering weight for this answer"
+
+      field :proposals, types[Decidim::Proposals::ProposalType], "The proposals related to this answer"
+    end
+  end
+end

data/app/types/decidim/elections/election_question_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # This type represents an election Question.
+    # The name is different from the model because the Question type is already defined on the Forms module.
+    ElectionQuestionType = GraphQL::ObjectType.define do
+      interfaces [
+        -> { Decidim::Core::TraceableInterface }
+      ]
+
+      name "ElectionQuestion"
+      description "A question for an election"
+
+      field :id, !types.ID, "The internal ID of this question"
+      field :title, !Decidim::Core::TranslatedFieldType, "The title for this question"
+      field :description, !Decidim::Core::TranslatedFieldType, "The description for this question"
+      field :maxSelections, !types.Int, "The maximum number of posible selections for this question", property: :max_selections
+      field :weight, types.Int, "The ordering weight for this question"
+      field :randomAnswersOrder, types.Boolean, "Should this question order answers in random order?", property: :random_answers_order
+
+      field :answers, !types[Decidim::Elections::ElectionAnswerType], "The answers for this question"
+    end
+  end
+end

data/app/types/decidim/elections/election_type.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    # This type represents an Election.
+    ElectionType = GraphQL::ObjectType.define do
+      interfaces [
+        -> { Decidim::Core::TraceableInterface }
+      ]
+
+      name "Election"
+      description "An election"
+
+      field :id, !types.ID, "The internal ID of this election"
+      field :title, !Decidim::Core::TranslatedFieldType, "The title for this election"
+      field :subtitle, !Decidim::Core::TranslatedFieldType, "The subtitle for this election"
+      field :description, !Decidim::Core::TranslatedFieldType, "The description for this election"
+      field :startTime, !Decidim::Core::DateTimeType, "The start time for this election", property: :start_time
+      field :endTime, !Decidim::Core::DateTimeType, "The end time for this election", property: :end_time
+      field :createdAt, Decidim::Core::DateTimeType, "When this election was created", property: :created_at
+      field :updatedAt, Decidim::Core::DateTimeType, "When this election was updated", property: :updated_at
+
+      field :questions, !types[Decidim::Elections::ElectionQuestionType], "The questions for this election"
+    end
+  end
+end

data/app/types/decidim/elections/elections_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Elections
+    ElectionsType = GraphQL::ObjectType.define do
+      interfaces [-> { Decidim::Core::ComponentInterface }]
+
+      name "Elections"
+      description "An elections component of a participatory space."
+
+      connection :elections, ElectionType.connection_type do
+        resolve ->(component, _args, _ctx) {
+                  ElectionsTypeHelper.base_scope(component).includes(:component)
+                }
+      end
+
+      field(:election, ElectionType) do
+        argument :id, !types.ID
+
+        resolve ->(component, args, _ctx) {
+          ElectionsTypeHelper.base_scope(component).find_by(id: args[:id])
+        }
+      end
+    end
+
+    module ElectionsTypeHelper
+      def self.base_scope(component)
+        Election.where(component: component)
+      end
+    end
+  end
+end

data/app/views/decidim/elections/admin/answers/_form.html.erb

@@ -0,0 +1,25 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title"><%= title %></h2>
+  </div>
+
+  <div class="card-section">
+    <div class="row column">
+      <%= form.translated :text_field, :title, autofocus: true %>
+    </div>
+
+    <div class="row column">
+      <%= form.translated :editor, :description %>
+    </div>
+
+    <div class="row column">
+      <%= form.number_field :weight %>
+    </div>
+
+    <%= render partial: "decidim/admin/shared/gallery", locals: { form: form } %>
+
+    <div class="row column">
+      <%= proposals_picker(form, :proposals, proposals_picker_election_question_answers_path(election, question)) %>
+    </div>
+  </div>
+</div>

data/app/views/decidim/elections/admin/answers/edit.html.erb

@@ -0,0 +1,7 @@
+<%= decidim_form_for([election, question, @form], html: { class: "form edit_answer" }) do |f| %>
+  <%= render partial: "form", object: f, locals: { title: t(".title") } %>
+
+  <div class="button--double form-general-submit">
+    <%= f.submit t(".update") %>
+  </div>
+<% end %>

data/app/views/decidim/elections/admin/answers/index.html.erb

@@ -0,0 +1,46 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title">
+      <%= link_to translated_attribute(election.title), elections_path %> &gt;
+      <%= link_to translated_attribute(question.title), election_questions_path(election) %> &gt;
+      <%= t(".title") %>
+
+      <%= link_to t("actions.new", scope: "decidim.elections", name: t("models.answer.name", scope: "decidim.elections.admin")), new_election_question_answer_path(election, question), class: "button tiny button--title" if allowed_to? :create, :answer, election: election, question: question %>
+    </h2>
+  </div>
+
+  <div class="card-section">
+    <div class="table-scroll">
+      <table class="table-list">
+        <thead>
+          <tr>
+            <th><%= t("models.answer.fields.title", scope: "decidim.elections") %></th>
+            <th><%= t("models.answer.fields.proposals", scope: "decidim.elections") %></th>
+            <th class="actions"><%= t("actions.title", scope: "decidim.elections") %></th>
+          </tr>
+        </thead>
+        <tbody>
+          <% answers.each do |answer| %>
+            <tr data-id="<%= question.id %>">
+              <td>
+                <%= link_to translated_attribute(answer.title), edit_election_question_answer_path(election, question, answer) %>
+              </td>
+              <td>
+                <%= answer.linked_resources(:proposals, "related_proposals").count %>
+              </td>
+              <td class="table-list__actions">
+                <% if allowed_to? :update, :answer, election: election, question: question, answer: answer %>
+                  <%= icon_link_to "pencil", edit_election_question_answer_path(election, question, answer), t("actions.edit", scope: "decidim.elections"), class: "action-icon--edit" %>
+                <% end %>
+
+                <% if allowed_to? :delete, :answer, election: election, question: question, answer: answer %>
+                  <%= icon_link_to "circle-x", election_question_answer_path(election, question, answer), t("actions.destroy", scope: "decidim.elections"), method: :delete, class: "action-icon--remove", data: { confirm: t("actions.confirm_destroy", scope: "decidim.elections") } %>
+                <% end %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>

data/app/views/decidim/elections/admin/answers/new.html.erb

@@ -0,0 +1,7 @@
+<%= decidim_form_for([election, question, @form], html: { class: "form new_answer" }) do |f| %>
+  <%= render partial: "form", object: f, locals: { title: t(".title") } %>
+
+  <div class="button--double form-general-submit">
+    <%= f.submit t(".create") %>
+  </div>
+<% end %>

data/app/views/decidim/elections/admin/answers/proposals_picker.html.erb

@@ -0,0 +1 @@
+<%= cell "decidim/proposals/proposals_picker", current_component %>

data/app/views/decidim/elections/admin/elections/_form.html.erb

@@ -0,0 +1,28 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title"><%= title %></h2>
+  </div>
+
+  <div class="card-section">
+    <div class="row column">
+      <%= form.translated :text_field, :title, autofocus: true %>
+    </div>
+
+    <div class="row column">
+      <%= form.translated :text_field, :subtitle %>
+    </div>
+
+    <div class="row column">
+      <%= form.translated :editor, :description %>
+    </div>
+
+    <div class="row">
+      <div class="column xlarge-6">
+        <%= form.datetime_field :start_time %>
+      </div>
+      <div class="column xlarge-6">
+        <%= form.datetime_field :end_time %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/decidim/elections/admin/elections/edit.html.erb

@@ -0,0 +1,7 @@
+<%= decidim_form_for(@form, html: { class: "form edit_election" }) do |f| %>
+  <%= render partial: "form", object: f, locals: { title: t(".title") } %>
+
+  <div class="button--double form-general-submit">
+    <%= f.submit t(".update") %>
+  </div>
+<% end %>

data/app/views/decidim/elections/admin/elections/index.html.erb

@@ -0,0 +1,54 @@
+<div class="card">
+  <div class="card-divider">
+    <h2 class="card-title">
+      <%= t(".title") %>
+
+      <%= link_to t("actions.new", scope: "decidim.elections", name: t("models.election.name", scope: "decidim.elections.admin")), new_election_path, class: "button tiny button--title" if allowed_to? :create, :election %>
+    </h2>
+  </div>
+
+  <div class="card-section">
+    <div class="table-scroll">
+      <table class="table-list">
+        <thead>
+          <tr>
+            <th><%= t("models.election.fields.title", scope: "decidim.elections") %></th>
+            <th><%= t("models.election.fields.start_time", scope: "decidim.elections") %></th>
+            <th><%= t("models.election.fields.end_time", scope: "decidim.elections") %></th>
+            <th class="actions"><%= t("actions.title", scope: "decidim.elections") %></th>
+          </tr>
+        </thead>
+        <tbody>
+          <% elections.each do |election| %>
+            <tr data-id="<%= election.id %>">
+              <td>
+                <%= link_to translated_attribute(election.title), election_questions_path(election) %>
+              </td>
+              <td>
+                <% if election.start_time %>
+                  <%= l election.start_time, format: :long %>
+                <% end %>
+              </td>
+              <td>
+                <% if election.end_time %>
+                  <%= l election.end_time, format: :long %>
+                <% end %>
+              </td>
+              <td class="table-list__actions">
+                <%= icon_link_to "eye", resource_locator(election).path, t("actions.preview", scope: "decidim.elections"), class: "action-icon--preview", target: :blank %>
+
+                <% if allowed_to? :update, :election, election: election %>
+                  <%= icon_link_to "pencil", edit_election_path(election), t("actions.edit", scope: "decidim.elections"), class: "action-icon--edit" %>
+                <% end %>
+
+                <% if allowed_to? :delete, :election, election: election %>
+                  <%= icon_link_to "circle-x", election_path(election), t("actions.destroy", scope: "decidim.elections"), method: :delete, class: "action-icon--remove", data: { confirm: t("actions.confirm_destroy", scope: "decidim.elections") } %>
+                <% end %>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>