decidim-proposals 0.9.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c56ff21d3615e0cfe8ab8467e9ca5d23298868d09d689beec2eb0f50a52d54c
-  data.tar.gz: aac6fab0f26a702ede9b9f9d52d1ac6b9b166ad48552064669db6aba420e518e
+  metadata.gz: 9f936f41817cbb42ca4bdb52d9501300941433847adf1dbcda717d67a31c8892
+  data.tar.gz: 9671316b0995837019afe72384b2dae2c4bc514c785c2d4011cc0341303cf7ee
 SHA512:
-  metadata.gz: 5b6f958d8e5f2bde840f2b225db063ab0c9e4dcd34b04dc2bf16718a74470abb3860a02012ed5175b92d62eb884e9e14e2c591b2674cf14263a73de0c7ef6195
-  data.tar.gz: 3d49678e75ef26d74e8fd0dd08d639b25e34311d2f180363db155c97aebc56014d17c82db217dfa561f70d07c56bcd7a13846a78fe3ec9ce60c0e14521f3235c
+  metadata.gz: 4e0e027c43986db153e3a0dea73d24b951d9b766650f4eae49f35826c870bacc63cf42476650014be7158840b043cb7dbc0329d42c1d28c393d181e7f525d51f
+  data.tar.gz: c2dab6b2845c246cc9b8254222e584fd1bd37ca16b2d7d3f77f4a4ac7453a7fa294044cb8c997f9770523c50bce6ac3452b2a12f3d2090b7576a2ec0d027a046

data/README.md

@@ -11,7 +11,7 @@ Proposals will be available as a Feature for a Participatory Process.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'decidim-proposals
+gem 'decidim-proposals'
 ```
 
 And then execute:
@@ -20,6 +20,23 @@ And then execute:
 bundle
 ```
 
+### Configuring Similarity
+
+`pg_trgm` is a PostgreSQL extension providing simple fuzzy string matching used in the Proposal wizard to find similar published proposals (title and the body).
+
+Create config variables in your app's `/config/initializers/decidim-proposals.rb`:
+
+```ruby
+Decidim::Proposals.configure do |config|
+  config.similarity_threshold = 0.25 # default value
+  config.similarity_limit = 10 # default value
+end
+```
+
+`similarity_threshold`(real): Sets the current similarity threshold that is used by the % operator. The threshold must be between 0 and 1 (default is 0.3).
+
+`similarity_limit`: number of maximum results.
+
 ## Contributing
 
 See [Decidim](https://github.com/decidim/decidim).

data/app/assets/config/admin/decidim_proposals_manifest.js

@@ -0,0 +1 @@
+//= link decidim/proposals/admin/proposals.js

data/app/assets/javascripts/decidim/proposals/admin/proposals.es6

@@ -0,0 +1,113 @@
+// = require_self
+$(document).ready(function () {
+  let selectedProposalsCount = function() {
+    return $('.table-list .js-check-all-proposal:checked').length
+  }
+
+  let selectedProposalsCountUpdate = function() {
+    if(selectedProposalsCount() == 0){
+      $("#js-recategorize-proposals-count").text("")
+    } else {
+      $("#js-recategorize-proposals-count").text(selectedProposalsCount());
+    }
+  }
+
+  let showBulkActionsButton = function() {
+    if(selectedProposalsCount() > 0){
+      $("#js-bulk-actions-button").removeClass('hide');
+    }
+  }
+
+  let hideBulkActionsButton = function(force = false) {
+    if(selectedProposalsCount() == 0 || force == true){
+      $("#js-bulk-actions-button").addClass('hide');
+      $("#js-bulk-actions-dropdown").removeClass('is-open');
+    }
+  }
+
+  let showOtherActionsButtons = function() {
+    $("#js-other-actions-wrapper").removeClass('hide');
+  }
+
+  let hideOtherActionsButtons = function() {
+    $("#js-other-actions-wrapper").addClass('hide');
+  }
+
+  let showRecategorizeProposalActions = function() {
+    $("#js-recategorize-proposals-actions").removeClass('hide');
+  }
+
+  let hideRecategorizeProposalActions = function() {
+    $("#js-recategorize-proposals-actions").addClass('hide');
+  }
+
+
+  if ($('#js-form-recategorize-proposals').length) {
+    hideRecategorizeProposalActions();
+    $("#js-bulk-actions-button").addClass('hide');
+
+    $("#js-bulk-actions-recategorize").click(function(e){
+      e.preventDefault();
+
+      $('#js-form-recategorize-proposals').submit(function(){
+        $('.layout-content > .callout-wrapper').html("");
+      })
+
+      showRecategorizeProposalActions();
+      hideBulkActionsButton(true);
+      hideOtherActionsButtons();
+    })
+
+    // select all checkboxes
+    $(".js-check-all").change(function() {
+      $(".js-check-all-proposal").prop('checked', $(this).prop("checked"));
+
+      if ($(this).prop("checked")) {
+        $(".js-check-all-proposal").closest('tr').addClass('selected');
+        showBulkActionsButton();
+      } else {
+        $(".js-check-all-proposal").closest('tr').removeClass('selected');
+        hideBulkActionsButton();
+      }
+
+      selectedProposalsCountUpdate();
+    });
+
+    // proposal checkbox change
+    $('.table-list').on('change', '.js-check-all-proposal', function (e) {
+      let proposal_id = $(this).val()
+      let checked = $(this).prop("checked")
+
+      // uncheck "select all", if one of the listed checkbox item is unchecked
+      if ($(this).prop("checked") === false) {
+        $(".js-check-all").prop('checked', false);
+      }
+      // check "select all" if all checkbox proposals are checked
+      if ($('.js-check-all-proposal:checked').length === $('.js-check-all-proposal').length) {
+        $(".js-check-all").prop('checked', true);
+        showBulkActionsButton();
+      }
+
+      if ($(this).prop("checked")) {
+        showBulkActionsButton();
+        $(this).closest('tr').addClass('selected');
+      } else {
+        hideBulkActionsButton();
+        $(this).closest('tr').removeClass('selected');
+      }
+
+      if ($('.js-check-all-proposal:checked').length === 0) {
+        hideBulkActionsButton();
+      }
+
+      $('#js-form-recategorize-proposals').find(".js-proposal-id-"+proposal_id).prop('checked', checked);
+      selectedProposalsCountUpdate();
+    });
+
+    $('#js-cancel-edit-category').on('click', function (e) {
+      hideRecategorizeProposalActions();
+      showBulkActionsButton();
+      showOtherActionsButtons();
+    });
+  }
+});

data/app/assets/javascripts/decidim/proposals/identity_selector_dialog.js.es6

@@ -0,0 +1,56 @@
+/**
+ * Makes the #select-identity-button to open a popup for the user to
+ * select with which identity he wants to perform an action.
+ *
+ */
+$(document).ready(function () {
+
+  let button = $('#select-identity-button'),
+      refreshUrl = null,
+      userIdentitiesDialog = $('#user-identities');
+
+  if (userIdentitiesDialog.length) {
+    refreshUrl = userIdentitiesDialog.data('refresh-url');
+
+    button.click(function () {
+      $.ajax(refreshUrl).done(function(response) {
+        userIdentitiesDialog.html(response).foundation('open');
+        button.trigger('ajax:success')
+      });
+    });
+  }
+});
+
+
+/**
+ * Manage the identity selector for endorsements.
+ *
+ */
+$(document).ready(function () {
+  $("#select-identity-button").on('ajax:success', function() {
+    // once reveal popup has been rendered register event callbacks
+    $("#user-identities ul.reveal__list li").each(function(index, elem) {
+      let liTag = $(elem)
+      liTag.on('click', function() {
+        let method = liTag.data('method')
+        let url = liTag.data('url')
+        $.ajax({
+          url: url,
+          method: method,
+          dataType: 'script',
+          success: function() {
+            if (liTag.hasClass('selected')) {
+              liTag.removeClass('selected')
+              liTag.find('.icon--circle-check').addClass('invisible')
+              liTag.data('method', 'post')
+            } else {
+              liTag.addClass('selected')
+              liTag.find('.icon--circle-check').removeClass('invisible')
+              liTag.data('method', 'delete')
+            }
+          }
+        })
+      })
+    });
+  });
+})

data/app/commands/decidim/proposals/admin/answer_proposal.rb

@@ -34,11 +34,17 @@ module Decidim
         attr_reader :form, :proposal
 
         def answer_proposal
-          proposal.update_attributes!(
-            state: @form.state,
-            answer: @form.answer,
-            answered_at: Time.current
-          )
+          Decidim.traceability.perform_action!(
+            "answer",
+            proposal,
+            form.current_user
+          ) do
+            proposal.update!(
+              state: @form.state,
+              answer: @form.answer,
+              answered_at: Time.current
+            )
+          end
         end
 
         def notify_followers

data/app/commands/decidim/proposals/admin/create_proposal.rb

@@ -29,6 +29,7 @@ module Decidim
           transaction do
             create_proposal
             create_attachment if process_attachments?
+            send_notification
           end
 
           broadcast(:ok, proposal)
@@ -39,7 +40,15 @@ module Decidim
         attr_reader :form, :proposal, :attachment
 
         def create_proposal
-          @proposal = Proposal.create!(
+          @proposal = Decidim.traceability.create!(
+            Proposal,
+            form.current_user,
+            attributes
+          )
+        end
+
+        def attributes
+          {
             title: form.title,
             body: form.body,
             category: form.category,
@@ -47,8 +56,9 @@ module Decidim
             feature: form.feature,
             address: form.address,
             latitude: form.latitude,
-            longitude: form.longitude
-          )
+            longitude: form.longitude,
+            published_at: Time.current
+          }
         end
 
         def build_attachment
@@ -82,6 +92,18 @@ module Decidim
         def process_attachments?
           attachments_allowed? && attachment_present?
         end
+
+        def send_notification
+          Decidim::EventsManager.publish(
+            event: "decidim.events.proposals.proposal_published",
+            event_class: Decidim::Proposals::PublishProposalEvent,
+            resource: proposal,
+            recipient_ids: @proposal.participatory_space.followers.pluck(:id),
+            extra: {
+              participatory_space: true
+            }
+          )
+        end
       end
     end
   end

data/app/commands/decidim/proposals/admin/create_proposal_note.rb

@@ -8,12 +8,10 @@ module Decidim
         # Public: Initializes the command.
         #
         # form         - A form object with the params.
-        # current_user - The current user.
         # proposal - the proposal to relate.
-        def initialize(form, proposal, current_user)
+        def initialize(form, proposal)
           @form = form
           @proposal = proposal
-          @current_user = current_user
         end
 
         # Executes the command. Broadcasts these events:
@@ -32,13 +30,20 @@ module Decidim
 
         private
 
-        attr_reader :form, :proposal_note
+        attr_reader :form, :proposal_note, :proposal
 
         def create_proposal_note
-          @proposal_note = ProposalNote.create!(
-            body: form.body,
-            proposal: @proposal,
-            author: @current_user
+          @proposal_note = Decidim.traceability.create!(
+            ProposalNote,
+            form.current_user,
+            {
+              body: form.body,
+              proposal: proposal,
+              author: form.current_user
+            },
+            resource: {
+              title: proposal.title
+            }
           )
         end
       end

data/app/commands/decidim/proposals/admin/import_proposals.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    module Admin
+      # A command with all the business logic when an admin imports proposals from
+      # one component to another.
+      class ImportProposals < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) unless form.valid?
+
+          broadcast(:ok, import_proposals)
+        end
+
+        private
+
+        attr_reader :form
+
+        def import_proposals
+          proposals.map do |original_proposal|
+            origin_attributes = original_proposal.attributes.except(
+              "id",
+              "created_at",
+              "updated_at",
+              "state",
+              "answer",
+              "answered_at",
+              "decidim_feature_id",
+              "reference",
+              "proposal_votes_count",
+              "proposal_notes_count"
+            )
+
+            proposal = Decidim::Proposals::Proposal.new(origin_attributes)
+            proposal.category = original_proposal.category
+            proposal.feature = target_feature
+            proposal.save!
+
+            proposal.link_resources([original_proposal], "copied_from_component")
+          end
+        end
+
+        def proposals
+          Decidim::Proposals::Proposal
+            .where(feature: origin_feature)
+            .where(state: proposal_states)
+        end
+
+        def proposal_states
+          @proposal_states = @form.states
+
+          if @form.states.include?("not_answered")
+            @proposal_states.delete("not_answered")
+            @proposal_states.push(nil)
+          end
+
+          @proposal_states
+        end
+
+        def origin_feature
+          @form.origin_feature
+        end
+
+        def target_feature
+          @form.current_feature
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/proposals/admin/update_proposal_category.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Proposals
+    module Admin
+      #  A command with all the business logic when an admin batch updates proposals category.
+      class UpdateProposalCategory < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # category_id - the category id to update
+        # proposal_ids - the proposals ids to update.
+        def initialize(category_id, proposal_ids)
+          @category = Decidim::Category.find_by id: category_id
+          @proposal_ids = proposal_ids
+          @response = { category_name: "", successful: [], errored: [] }
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :update_proposals_category - when everything is ok, returns @response.
+        # - :invalid_category - if the category is blank.
+        # - :invalid_proposal_ids - if the proposal_ids is blank.
+        #
+        # Returns @response hash:
+        #
+        # - :category_name - the translated_name of the category assigned
+        # - :successful - Array of names of the updated proposals
+        # - :errored - Array of names of the proposals not updated because they already had the category assigned
+        def call
+          return broadcast(:invalid_category) if @category.blank?
+          return broadcast(:invalid_proposal_ids) if @proposal_ids.blank?
+
+          @response[:category_name] = @category.translated_name
+          Proposal.where(id: @proposal_ids).find_each do |proposal|
+            if @category == proposal.category
+              @response[:errored] << proposal.title
+            else
+              transaction do
+                update_proposal_category proposal
+                notify_author proposal if proposal.author.present?
+              end
+              @response[:successful] << proposal.title
+            end
+          end
+
+          broadcast(:update_proposals_category, @response)
+        end
+
+        private
+
+        def update_proposal_category(proposal)
+          proposal.update!(
+            category: @category
+          )
+        end
+
+        def notify_author(proposal)
+          Decidim::EventsManager.publish(
+            event: "decidim.events.proposals.proposal_update_category",
+            event_class: Decidim::Proposals::Admin::UpdateProposalCategoryEvent,
+            resource: proposal,
+            recipient_ids: [proposal.decidim_author_id]
+          )
+        end
+      end
+    end
+  end
+end