decidim-accountability 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: d1308279c907cde4a8e1693ea0d9dad5797457b39a1f0e8c0d17d5aebdabaab1
-  data.tar.gz: 1df0d17479ce96df917b398a000ca39da38d2066ac97e9405fdd0d8ececebf6e
+SHA1:
+  metadata.gz: b9e4ccd5f0cb93b7caf07991bf0f69d1de1002dc
+  data.tar.gz: fff3cc52314258d1d18d159be8ebf3b41854210b
 SHA512:
-  metadata.gz: 5f9a0dde58e5df4a1bcaee18ff6a354581564f59115cbb958877a9bc079f655752fd976b628d1d147abcfa815879a433ea791043c5eba43a3c874669f0cdb334
-  data.tar.gz: b5df2ad546c34657866b1d23f9619e4c95f8382ea26818ec84225cb7dfac56284c48dcdad29bdde57c6e9d2183c755487f525e267a51781f82b2cf507538ff37
+  metadata.gz: 9e615fb44d4e96e40555b689c2885652a7ba0ba6c7f7ad27663ad80019a86c96b6762c2f129a22c454e37c461b2f3eee990a539b0355ba6c705cfbd2ecdbc5b7
+  data.tar.gz: 107326f7daeefd26291889a25798a8e21a301c7abe0b6df8a5390b1e6ad421f68bc6ad233eb31345fbd862685ee3d9b68fc2ed01ad44ef7bd0eadead9fda76d6

data/README.md

@@ -2,12 +2,12 @@
 
 The Accountability module adds results to any participatory process. It adds a CRUD engine to the admin and public views scoped inside the participatory process. Accountability will link to related meetings and proposals and will be used to show the progress on the related proposals.
 
-
 ## Usage
 
 Accountability will be available as a Feature for a Participatory Process.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -15,12 +15,15 @@ gem 'decidim-accountability'
 ```
 
 And then execute:
+
 ```bash
-$ bundle
+bundle
 ```
 
 ## Contributing
+
 See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).
 
 ## License
+
 See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).

data/app/assets/config/decidim_accountability_manifest.js

@@ -1 +1,2 @@
 //= link decidim/accountability/accountability.js
+//= link diff.js

data/app/assets/javascripts/decidim/accountability/accountability.js.es6

@@ -1,3 +1,4 @@
+// = require_tree .
 // = require_self
 
 $(() => {

data/app/assets/javascripts/decidim/accountability/version_diff.js.es6

@@ -0,0 +1,37 @@
+/* global JsDiff */
+
+$(() => {
+  $(".diff-i18n_html, .diff-i18n").each(function(_index, element) {
+    const diffElement = $(element);
+    const valueElement = diffElement.find(".diff__value");
+    const oldValue = valueElement.data("old-value").
+          replace(/</g, "&lt;").
+          replace(/>/g, "&gt;");
+    const newValue = valueElement.data("new-value").
+          replace(/</g, "&lt;").
+          replace(/>/g, "&gt;");
+
+    const diff = JsDiff.diffChars(oldValue, newValue);
+    let outputHTML = "";
+
+    diff.forEach(({added, removed, value}) => {
+      let color = "";
+
+      if (added) {
+        color = "#89ffaa";
+      } else if (removed) {
+        color = "red";
+      }
+
+      if (added || removed) {
+        outputHTML += `<span style="background-color: ${color}">${value}</span>`;
+      } else {
+        outputHTML += value;
+      }
+    });
+
+    outputHTML = outputHTML.replace(/\n/g, "<br><br>");
+
+    valueElement.html(outputHTML);
+  });
+})

data/app/assets/stylesheets/decidim/accountability/accountability/_versions.scss

@@ -0,0 +1,8 @@
+.diff {
+  .addition {
+    background-color: #e6ffed;
+  }
+  .removal {
+    background-color: #ffeef0
+  }
+}

data/app/commands/decidim/accountability/admin/create_result.rb

@@ -30,7 +30,9 @@ module Decidim
         attr_reader :result
 
         def create_result
-          @result = Result.create!(
+          @result = Decidim.traceability.create!(
+            Result,
+            @form.current_user,
             feature: @form.current_feature,
             scope: @form.scope,
             category: @form.category,

data/app/commands/decidim/accountability/admin/update_result.rb

@@ -35,7 +35,9 @@ module Decidim
         attr_reader :result, :form
 
         def update_result
-          result.update_attributes!(
+          Decidim.traceability.update!(
+            result,
+            form.current_user,
             scope: @form.scope,
             category: @form.category,
             parent_id: @form.parent_id,

data/app/controllers/decidim/accountability/results_controller.rb

@@ -6,8 +6,10 @@ module Decidim
     class ResultsController < Decidim::Accountability::ApplicationController
       include FilterResource
       helper Decidim::WidgetUrlsHelper
+      helper Decidim::TraceabilityHelper
+      helper Decidim::Accountability::BreadcrumbHelper
 
-      helper_method :results, :result, :stats_calculator, :first_class_categories, :category, :progress_calculator, :count_calculator, :current_scope
+      helper_method :results, :result, :first_class_categories, :count_calculator
 
       private
 
@@ -20,10 +22,6 @@ module Decidim
         @result ||= Result.includes(:timeline_entries).where(feature: current_feature).find(params[:id])
       end
 
-      def stats_calculator
-        @stats_calculator ||= ResultStatsCalculator.new(result)
-      end
-
       def search_klass
         ResultSearch
       end
@@ -44,23 +42,9 @@ module Decidim
         @first_class_categories ||= current_participatory_space.categories.first_class
       end
 
-      def category
-        if params[:filter] && params[:filter][:category_id].present?
-          current_participatory_space.categories.find(params[:filter][:category_id])
-        end
-      end
-
-      def progress_calculator(scope_id, category_id)
-        Decidim::Accountability::ResultsCalculator.new(current_feature, scope_id, category_id).progress
-      end
-
       def count_calculator(scope_id, category_id)
         Decidim::Accountability::ResultsCalculator.new(current_feature, scope_id, category_id).count
       end
-
-      def current_scope
-        params[:filter][:scope_id] if params[:filter]
-      end
     end
   end
 end

data/app/controllers/decidim/accountability/versions_controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # Exposes result versions so users can see how a result
+    # has been updated through time.
+    class VersionsController < Decidim::Accountability::ApplicationController
+      helper Decidim::TraceabilityHelper
+      helper Decidim::Accountability::BreadcrumbHelper
+      helper_method :current_version, :result
+
+      private
+
+      def result
+        @result ||= Result.includes(:timeline_entries).where(feature: current_feature).find(params[:result_id])
+      end
+
+      def current_version
+        return nil if params[:id].to_i < 1
+        @current_version ||= result.versions[params[:id].to_i - 1]
+      end
+    end
+  end
+end

data/app/helpers/decidim/accountability/breadcrumb_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # Helpers needed to render the navigation breadcrumbs in results.
+    #
+    module BreadcrumbHelper
+      def stats_calculator
+        @stats_calculator ||= ResultStatsCalculator.new(result)
+      end
+
+      def current_scope
+        params[:filter][:scope_id] if params[:filter]
+      end
+
+      def progress_calculator(scope_id, category_id)
+        Decidim::Accountability::ResultsCalculator.new(current_feature, scope_id, category_id).progress
+      end
+
+      def category
+        if params[:filter] && params[:filter][:category_id].present?
+          current_participatory_space.categories.find(params[:filter][:category_id])
+        end
+      end
+    end
+  end
+end

data/app/models/decidim/accountability/result.rb

@@ -11,6 +11,7 @@ module Decidim
       include Decidim::HasCategory
       include Decidim::HasReference
       include Decidim::Comments::Commentable
+      include Decidim::Traceable
 
       feature_manifest_name "accountability"
 

data/app/models/decidim/accountability/status.rb

@@ -9,7 +9,7 @@ module Decidim
 
       feature_manifest_name "accountability"
 
-      has_many :results, foreign_key: "decidim_accountability_status_id", class_name: "Decidim::Accountability::Result", inverse_of: :status
+      has_many :results, foreign_key: "decidim_accountability_status_id", class_name: "Decidim::Accountability::Result", inverse_of: :status, dependent: :nullify
 
       validates :key, presence: true, uniqueness: { scope: :decidim_feature_id }
       validates :name, presence: true

data/app/services/decidim/accountability/diff_renderer.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    class DiffRenderer
+      def initialize(version)
+        @version = version
+      end
+
+      # Renders the diff of the given changeset. Takes into account translatable fields.
+      #
+      # Returns a Hash, where keys are the fields that have changed and values are an
+      # array, the first element being the previous value and the last being the new one.
+      def diff
+        version.changeset.inject({}) do |diff, (attribute, values)|
+          attribute = attribute.to_sym
+          type = attribute_types[attribute]
+
+          if type.blank?
+            diff
+          else
+            parse_changeset(attribute, values, type, diff)
+          end
+        end
+      end
+
+      private
+
+      attr_reader :version
+
+      # Lists which attributes will be diffable and how
+      # they should be rendered.
+      def attribute_types
+        {
+          start_date: :date,
+          end_date: :date,
+          description: :i18n_html,
+          title: :i18n,
+          decidim_scope_id: :scope,
+          progress: :percentage
+        }
+      end
+
+      def parse_i18n_changeset(attribute, values, type, diff)
+        values.last.each_key do |locale, _value|
+          first_value = values.first.try(:[], locale)
+          last_value = values.last.try(:[], locale)
+          next if first_value == last_value
+
+          attribute_locale = "#{attribute}_#{locale}".to_sym
+          diff.update(
+            attribute_locale => {
+              type: type,
+              label: generate_i18n_label(attribute, locale),
+              old_value: first_value,
+              new_value: last_value
+            }
+          )
+        end
+        diff
+      end
+
+      def parse_changeset(attribute, values, type, diff)
+        return parse_i18n_changeset(attribute, values, type, diff) if [:i18n, :i18n_html].include?(type)
+
+        diff.update(
+          attribute => {
+            type: type,
+            label: I18n.t(attribute, scope: "activemodel.attributes.result"),
+            old_value: values[0],
+            new_value: values[1]
+          }
+        )
+      end
+
+      def generate_i18n_label(attribute, locale)
+        label = I18n.t(attribute, scope: "activemodel.attributes.result")
+        locale_name = I18n.t("locale.name", locale: locale)
+        "#{label} (#{locale_name})"
+      end
+    end
+  end
+end

data/app/views/decidim/accountability/results/_show_parent.html.erb

@@ -6,13 +6,17 @@
   <div class="small-12 columns">
     <h2 class="heading2"><%= translated_attribute result.title %></h2>
 
-    <div class="small-12 medium-8 column row end">
-      <div class="section">
-        <div class="description">
-          <%== translated_attribute result.description %>
+    <div class="row">
+      <div class="mediumlarge-8 columns">
+        <div class="section">
+          <div class="description">
+            <%== translated_attribute result.description %>
+          </div>
+          <%= render partial: "decidim/shared/tags", locals: { resource: result, tags_class_extra: "tags--result" } %>
         </div>
-        <%= render partial: "decidim/shared/tags", locals: { resource: result, tags_class_extra: "tags--result" } %>
       </div>
+
+      <%= render partial: "stats_box" %>
     </div>
 
     <%= render partial: "results_leaf", locals: { results: result.children.page(1).per(result.children_count), total_count: result.children_count } %>

data/app/views/decidim/accountability/results/_stats_box.html.erb

@@ -1,31 +1,50 @@
-<div class="columns section view-side mediumlarge-4 large-3 end">
-  <% if result.linked_resources(:proposals, "included_proposals").any? %>
+<div class="columns section mediumlarge-4 large-3">
+  <% if result.versions.any? || result.linked_resources(:proposals, "included_proposals").any? %>
     <div class="card extra line-stats">
       <div class="definition-data">
-        <div class="definition-data__item definition-data__item--double">
-          <span class="definition-data__title"><%= t("results.show.stats.proposals", scope: "decidim.accountability") %></span>
-          <span class="definition-data__number"><%= stats_calculator.proposals_count %></span>
-        </div>
-        <div class="definition-data__item definition-data__item--double">
-          <span class="definition-data__title"><%= t("results.show.stats.meetings", scope: "decidim.accountability") %></span>
-          <span class="definition-data__number"><%= stats_calculator.meetings_count %></span>
-        </div>
-        <div class="definition-data__item definition-data__item--double">
-          <span class="definition-data__title"><%= t("results.show.stats.comments", scope: "decidim.accountability") %></span>
-          <span class="definition-data__number"><%= stats_calculator.comments_count %></span>
-        </div>
-        <div class="definition-data__item definition-data__item--double">
-          <span class="definition-data__title"><%= t("results.show.stats.attendees", scope: "decidim.accountability") %></span>
-          <span class="definition-data__number"><%= stats_calculator.attendees_count %></span>
-        </div>
-        <div class="definition-data__item definition-data__item--double">
-          <span class="definition-data__title"><%= t("results.show.stats.votes", scope: "decidim.accountability") %></span>
-          <span class="definition-data__number"><%= stats_calculator.votes_count %></span>
-        </div>
-        <div class="definition-data__item definition-data__item--double">
-          <span class="definition-data__title"><%= t("results.show.stats.contributions", scope: "decidim.accountability") %></span>
-          <span class="definition-data__number"><%= stats_calculator.contributions_count %></span>
-        </div>
+        <% if result.versions.any? %>
+          <div class="definition-data__item versions_count">
+            <span class="definition-data__title"><%= t("results.show.stats.version_number", scope: "decidim.accountability") %></span>
+            <%= result.versions.count %>
+            <%= link_to t("results.show.stats.show_all_versions", scope: "decidim.accountability"), result_versions_path(result), class: "button button--sc hollow secondary small expanded" %>
+          </div>
+          <% if result.last_editor.present? %>
+            <div class="definition-data__item last_revision_by">
+              <span class="definition-data__title"><%= t("results.show.stats.last_edited_by", scope: "decidim.accountability") %></span>
+              <%= render_resource_last_editor(result) %>
+            </div>
+          <% end %>
+          <div class="definition-data__item last_updated_at">
+            <span class="definition-data__title"><%= t("results.show.stats.last_updated_at", scope: "decidim.accountability") %></span>
+            <%= l result.versions.last.created_at, format: :decidim_short %>
+          </div>
+        <% end %>
+        <% if result.linked_resources(:proposals, "included_proposals").any? %>
+          <div class="definition-data__item definition-data__item--double">
+            <span class="definition-data__title"><%= t("results.show.stats.proposals", scope: "decidim.accountability") %></span>
+            <span class="definition-data__number"><%= stats_calculator.proposals_count %></span>
+          </div>
+          <div class="definition-data__item definition-data__item--double">
+            <span class="definition-data__title"><%= t("results.show.stats.meetings", scope: "decidim.accountability") %></span>
+            <span class="definition-data__number"><%= stats_calculator.meetings_count %></span>
+          </div>
+          <div class="definition-data__item definition-data__item--double">
+            <span class="definition-data__title"><%= t("results.show.stats.comments", scope: "decidim.accountability") %></span>
+            <span class="definition-data__number"><%= stats_calculator.comments_count %></span>
+          </div>
+          <div class="definition-data__item definition-data__item--double">
+            <span class="definition-data__title"><%= t("results.show.stats.attendees", scope: "decidim.accountability") %></span>
+            <span class="definition-data__number"><%= stats_calculator.attendees_count %></span>
+          </div>
+          <div class="definition-data__item definition-data__item--double">
+            <span class="definition-data__title"><%= t("results.show.stats.votes", scope: "decidim.accountability") %></span>
+            <span class="definition-data__number"><%= stats_calculator.votes_count %></span>
+          </div>
+          <div class="definition-data__item definition-data__item--double">
+            <span class="definition-data__title"><%= t("results.show.stats.contributions", scope: "decidim.accountability") %></span>
+            <span class="definition-data__number"><%= stats_calculator.contributions_count %></span>
+          </div>
+        <% end %>
       </div>
     </div>
   <% end %>
@@ -33,4 +52,4 @@
   <%= feature_reference(result) %>
   <%= render partial: "decidim/shared/share_modal" %>
   <%= embed_modal_for result_result_widget_url(result, format: :js) %>
-</div>
+</div>

data/app/views/decidim/accountability/versions/_version.html.erb

@@ -0,0 +1,20 @@
+<div class="card--list__item">
+  <div class="card--list__text">
+    <div>
+      <%= link_to result_version_path(result, index + 1) do %>
+        <h6 class="card--list__heading heading6">
+          <%= t(".version_index", index: index + 1) %>
+        </h6>
+      <% end %>
+      <div class="author-data">
+        <%= render_resource_editor(version) %>
+        <%= l version.created_at, format: :decidim_short %>
+      </div>
+    </div>
+  </div>
+  <div class="card--list__data">
+    <%= link_to result_version_path(result, index + 1), class: "card--list__data__icon" do %>
+      <%= icon "chevron-right" %>
+    <% end %>
+  </div>
+</div>