decidim 0.0.2 → 0.0.3

data/decidim-results/app/commands/decidim/results/admin/update_result.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+module Decidim
+  module Results
+    module Admin
+      # This command is executed when the user changes a Result from the admin
+      # panel.
+      class UpdateResult < Rectify::Command
+        # Initializes an UpdateResult Command.
+        #
+        # form - The form from which to get the data.
+        # result - The current instance of the result to be updated.
+        def initialize(form, result)
+          @form = form
+          @result = result
+        end
+
+        # Updates the result if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          transaction do
+            update_result
+            link_proposals
+            link_meetings
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :result, :form
+
+        def update_result
+          result.update_attributes!(
+            scope: form.scope,
+            category: form.category,
+            title: form.title,
+            description: form.description
+          )
+        end
+
+        def proposals
+          @proposals ||= result.sibling_scope(:proposals).where(id: form.proposal_ids)
+        end
+
+        def meeting_ids
+          @meeting_ids ||= proposals.flat_map do |proposal|
+            proposal.linked_resources(:meetings, "proposals_from_meeting").pluck(:id)
+          end.uniq
+        end
+
+        def meetings
+          @meetings ||= result.sibling_scope(:meetings).where(id: meeting_ids)
+        end
+
+        def link_proposals
+          result.link_resources(proposals, "included_proposals")
+        end
+
+        def link_meetings
+          result.link_resources(meetings, "meetings_through_proposals")
+        end
+      end
+    end
+  end
+end

data/decidim-results/app/controllers/decidim/results/admin/application_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module Decidim
+  module Results
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Features::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::Features::BaseController
+      end
+    end
+  end
+end

data/decidim-results/app/controllers/decidim/results/admin/results_controller.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+module Decidim
+  module Results
+    module Admin
+      # This controller allows an admin to manage results from a Participatory Process
+      class ResultsController < Admin::ApplicationController
+        helper_method :results
+
+        def new
+          @form = form(ResultForm).instance
+        end
+
+        def create
+          @form = form(ResultForm).from_params(params)
+
+          CreateResult.call(@form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("results.create.success", scope: "decidim.results.admin")
+              redirect_to results_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("results.create.invalid", scope: "decidim.results.admin")
+              render action: "new"
+            end
+          end
+        end
+
+        def edit
+          @form = form(ResultForm).from_model(result)
+        end
+
+        def update
+          @form = form(ResultForm).from_params(params)
+
+          UpdateResult.call(@form, result) do
+            on(:ok) do
+              flash[:notice] = I18n.t("results.update.success", scope: "decidim.results.admin")
+              redirect_to results_path
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("results.update.invalid", scope: "decidim.results.admin")
+              render action: "edit"
+            end
+          end
+        end
+
+        def destroy
+          result.destroy!
+
+          flash[:notice] = I18n.t("results.destroy.success", scope: "decidim.results.admin")
+
+          redirect_to results_path
+        end
+
+        private
+
+        def results
+          @results ||= Result.where(feature: current_feature)
+        end
+
+        def result
+          @result ||= results.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/decidim-results/app/controllers/decidim/results/application_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Results
+    # This controller is the abstract class from which all other controllers of
+    # this engine inherit.
+    #
+    # Note that it inherits from `Decidim::Components::BaseController`, which
+    # override its layout and provide all kinds of useful methods.
+    class ApplicationController < Decidim::Features::BaseController
+    end
+  end
+end

data/decidim-results/app/controllers/decidim/results/results_controller.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Results
+    # Exposes the result resource so users can view them
+    class ResultsController < Decidim::Results::ApplicationController
+      include FilterResource
+
+      helper_method :results, :result, :stats_calculator
+
+      private
+
+      def results
+        @results ||= search.results.page(params[:page]).per(12)
+      end
+
+      def result
+        @result ||= results.find(params[:id])
+      end
+
+      def stats_calculator
+        @stats_calculator ||= ResultStatsCalculator.new(result)
+      end
+
+      def search_klass
+        ResultSearch
+      end
+
+      def default_filter_params
+        {
+          search_text: "",
+          scope_id: "",
+          category_id: ""
+        }
+      end
+
+      def context_params
+        { feature: current_feature, organization: current_organization }
+      end
+    end
+  end
+end

data/decidim-results/app/forms/decidim/results/admin/result_form.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module Decidim
+  module Results
+    module Admin
+      # This class holds a Form to create/update results from Decidim's admin panel.
+      class ResultForm < Decidim::Form
+        include TranslatableAttributes
+        include TranslationsHelper
+
+        translatable_attribute :title, String
+        translatable_attribute :description, String
+        attribute :decidim_scope_id, Integer
+        attribute :decidim_category_id, Integer
+        attribute :proposal_ids, Array[Integer]
+
+        validates :title, translatable_presence: true
+        validates :description, translatable_presence: true
+
+        validates :scope, presence: true, if: ->(form) { form.decidim_scope_id.present? }
+        validates :category, presence: true, if: ->(form) { form.decidim_category_id.present? }
+
+        def map_model(model)
+          self.proposal_ids = model.linked_resources(:proposals, "included_proposals").pluck(:id)
+        end
+
+        def proposals
+          @proposals ||= Decidim.find_resource_manifest(:proposals).try(:resource_scope, context.current_feature)&.order(title: :asc)&.pluck(:title, :id)
+        end
+
+        def scope
+          @scope ||= context.current_feature.scopes.where(id: decidim_scope_id).first
+        end
+
+        def category
+          @category ||= context.current_feature.categories.where(id: decidim_category_id).first
+        end
+      end
+    end
+  end
+end

data/decidim-results/app/helpers/decidim/results/application_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module Decidim
+  module Results
+    # Custom helpers, scoped to the meetings engine.
+    #
+    module ApplicationHelper
+      include PaginateHelper
+      include Decidim::Comments::CommentsHelper
+    end
+  end
+end

data/decidim-results/app/models/decidim/results/application_record.rb

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

data/decidim-results/app/models/decidim/results/result.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Decidim
+  module Results
+    # The data store for a Result in the Decidim::Results component. It stores a
+    # title, description and any other useful information to render a custom result.
+    class Result < Results::ApplicationRecord
+      include Decidim::Resourceable
+      include Decidim::HasFeature
+      include Decidim::HasScope
+      include Decidim::HasCategory
+
+      feature_manifest_name "results"
+    end
+  end
+end

data/decidim-results/app/services/decidim/results/result_search.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module Decidim
+  module Results
+    # This class handles search and filtering of results. Needs a
+    # `current_feature` param with a `Decidim::Feature` in order to
+    # find the results.
+    class ResultSearch < ResourceSearch
+      # Public: Initializes the service.
+      # feature     - A Decidim::Feature to get the results from.
+      # page        - The page number to paginate the results.
+      # per_page    - The number of proposals to return per page.
+      def initialize(options = {})
+        super(Result.all, options)
+      end
+
+      # Handle the search_text filter
+      def search_search_text
+        query
+          .where(localized_search_text_in(:title), text: "%#{search_text}%")
+          .or(query.where(localized_search_text_in(:description), text: "%#{search_text}%"))
+      end
+
+      # Handle the scope_id filter
+      def search_scope_id
+        query.where(decidim_scope_id: scope_id)
+      end
+
+      private
+
+      # Internal: builds the needed query to search for a text in the organization's
+      # available locales. Note that it is intended to be used as follows:
+      #
+      # Example:
+      #   Resource.where(localized_search_text_for(:title, text: "my_query"))
+      #
+      # The Hash with the `:text` key is required or it won't work.
+      def localized_search_text_in(field)
+        options[:organization].available_locales.map do |l|
+          "#{field} ->> '#{l}' ILIKE :text"
+        end.join(" OR ")
+      end
+    end
+  end
+end

data/decidim-results/app/services/decidim/results/result_stats_calculator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+module Decidim
+  module Results
+    # This class handles statistics of results. Needs a `result` in
+    # order to find the stats.
+    class ResultStatsCalculator
+      # Public: Initializes the service.
+      # result - The result from which to calculate the stats.
+      def initialize(result)
+        @result = result
+      end
+
+      def proposals_count
+        proposals.count
+      end
+
+      def votes_count
+        return 0 unless proposals
+        proposals.sum { |proposal| proposal.votes.size }
+      end
+
+      def comments_count
+        Decidim::Comments::Comment.where(commentable: proposals).count
+      end
+
+      def attendees_count
+        meetings.where("attendees_count > 0").sum(:attendees_count)
+      end
+
+      def contributions_count
+        meetings.where("contributions_count > 0").sum(:contributions_count)
+      end
+
+      def meetings_count
+        meetings.count
+      end
+
+      private
+
+      attr_reader :result
+
+      def proposals
+        @proposals ||= result.linked_resources(:proposals, "included_proposals")
+      end
+
+      def meetings
+        @meetings ||= result.linked_resources(:meetings, "meetings_through_proposals")
+      end
+    end
+  end
+end

data/decidim-results/app/views/decidim/results/admin/results/_form.html.erb

@@ -0,0 +1,23 @@
+<div class="field" >
+  <%= form.translated :text_field, :title, autofocus: true %>
+</div>
+
+<div class="field" >
+  <%= form.translated :editor, :description %>
+</div>
+
+<div class="field" >
+  <%= form.collection_select :decidim_scope_id, current_organization.scopes, :id, :name, include_blank: true %>
+</div>
+
+<div class="field" >
+  <%= form.categories_select :decidim_category_id, current_participatory_process.categories, include_blank: true, disable_parents: false %>
+</div>
+
+<% if @form.proposals %>
+  <%= form.select :proposal_ids,
+                  @form.proposals,
+                  {},
+                  { multiple: true, class: "chosen-select" }
+  %>
+<% end %>

data/decidim-results/app/views/decidim/results/admin/results/edit.html.erb

@@ -0,0 +1,9 @@
+<h3><%= t ".title" %></h3>
+
+<%= form_for(@form) do |f| %>
+  <%= render partial: 'form', object: f %>
+
+  <div class="actions">
+    <%= f.submit t(".update") %>
+  </div>
+<% end %>

data/decidim-results/app/views/decidim/results/admin/results/index.html.erb

@@ -0,0 +1,27 @@
+<h2><%= t(".title") %></h2>
+
+<div class="actions title">
+  <%= link_to t("actions.new", scope: "decidim.results", name: t("models.result.name", scope: "decidim.results.admin")), new_result_path, class: 'new' if can? :manage, current_feature %>
+</div>
+
+<table class="stack">
+  <thead>
+    <tr>
+      <th><%= t("models.result.fields.title", scope: "decidim.results") %></th>
+      <th class="actions"><%= t("actions.title", scope: "decidim.results") %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% results.each do |result| %>
+      <tr data-id="<%= result.id %>">
+        <td>
+          <%= link_to translated_attribute(result.title), decidim_results.result_path(id: result, feature_id: current_feature, participatory_process_id: current_participatory_process), target: :blank %><br />
+        </td>
+        <td class="actions">
+          <%= link_to t("actions.edit", scope: "decidim.results"), edit_result_path(result) if can? :update, current_feature %>
+          <%= link_to t("actions.destroy", scope: "decidim.results"), result_path(result), method: :delete, class: "small alert button", data: { confirm: t("actions.confirm_destroy", scope: "decidim.results") } if can? :destroy, current_feature %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>