Generalize endorsements and apply to blog posts (decidim#5542)

* Generalize endorsements permissions and extract from proposals.

* [WIP] Extracting Endorsable concern

* [WIP] EndorseResource and UnendorseRerouce commands.

* [WIP] EndorsementsController tests.

* Add timestamps to decidim_endorsements db migration.

* [I18N] Update yamls.

* [WIP] Extract endorsements from proposals module. But keep funcionality for proposals.

* [DOC] Update changelog upgrade notes.

* Apply edlint.js style.

* normalize i18n files.

* [TEST|I18N] Pending development translations.

* [TEST] Update factory modifications to not break other tests.

* [TEST] Extract endorse_proposal_spec logic into system_endorse_resource_examples.

* [TEST] Rename shared system example.

* [REFACTOR] Separate logic and view in endorsement_buttons_cell#render_endorsements_button_card_part.

* Get rid of Decidim::Proposals::ProposalEndorsement.

* Remove uses of proposal_endorsement.

* Remove legady proposal endorsements related exclude from i8n normalization.

* Revert "Remove legady proposal endorsements related exclude from i8n normalization."

* Update tests.

* [TEST] Update endorsement permissions tests.

* Do not remove dummy_resources.coauthorships_count column, as factories depend on that.

* Extract endorser identities partial into a generic identities cell. (decidim#5564)

* Extract endorser identities partial into a generic identities cell. Check if some already exists.

* Remove Coauthorable to DummyResource

* Complete documentation and small refactors to extract helpers to invoke the cells.

* Update decidim-core/app/commands/decidim/endorse_resource.rb

Co-Authored-By: Txus <[email protected]>

* Update decidim-core/app/commands/decidim/endorse_resource.rb

Co-Authored-By: Txus <[email protected]>

* Update CHANGELOG.md

Co-Authored-By: Txus <[email protected]>

* Rubocopify.

* Rubocopify again.

* Provide migration to automatically move ProposalEndorsements into new decidim-core Endorsement db structures.

* Update decidim-proposals/db/migrate/20200120215928_move_proposal_endorsements_to_core_endorsements.rb

Co-Authored-By: Ivan Vergés <[email protected]>

* Fix mispellings in MoveProposalEndorsementsToCoreEndorsements migration

* Remove unneeded join clause in Proposal.newsletter_participant_ids(component)

* Allow legacy data on rollback move ProposalEndorsements to Endorsements

Allow to have rows in decidim_proposals_proposal_endorsements table when rolling back the
MoveProposalEndorsementsToCoreEndorsements. Use #find_or_create_by just in case a migrated
ProposalEndorsement is moved back to its original table.

* [Feature] Make Blog Posts endorsable (decidim#5668)

* Fix errors

* CHANGELOG entry added

* Review when creation_date and comments should be rendered

* Refactor author cell

* Model tests added

* Remove deprecated proposal_endorsement factory.

Co-authored-by: Oliver Valls <[email protected]>

* Make blog posts followable (decidim#5690)

* Make blog posts followable

* Notify followers when creating new comment

* Add CHANGELOG entry

* Generalize follow button partial

* Edit CHANGELOG entry

* Fix proposal tests

* Update tests after merging latest changes from develop

* Update proposal_input_sort_spec when sorting by endorsement_count

* Update changelog

Co-authored-by: jarvisct <[email protected]>
Co-authored-by: Txus <[email protected]>
Co-authored-by: Ivan Vergés <[email protected]>

Author: 4 people

CHANGELOG.md

@@ -4,17 +4,25 @@
 
 ### Upgrade notes
 
+- **Endorsements**
+
+This new version of Decidim has extracted the Endorsement feature into a generic concern that can now be applied to many resources.
+To keep current Decidim::Proposals::Proposal's endorsement information, endorsements are copied into the new `Decidim::Endorsable` tables and counter cache columns. This is done via migrations.
+
+After this, `Decidim::Proposals::ProposalEndorsement` and the corresponding counter cache column in `decidim_proposals_proposal.proposal_endorsements_count` should be removed. To do so, Decidim will provide the corresponding migration in the next release.
+
 ### Added
 
 - **decidim-core**: Now messages inside conversations have their urls identified as links. [\#5755](https://github.com/decidim/decidim/pull/5755)
 - **decidim-core**: Support node.js semver rules for release candidates. [\#5828](https://github.com/decidim/decidim/pull/5828)
+- **decidim-proposals**, **decidim-core**, **decidim-blogs**: Extract proposals' endorsements into a polymorphic concern that can now be applied no any resource. It has, in turn, been aplied to blog posts. [\#5542](https://github.com/decidim/decidim/pull/5542)
 
 ### Changed
 
 ### Fixed
 
-- **decidim-proposals**: Use simple_format to add a wrapper to proposals body [#5753](https://github.com/decidim/decidim/pull/5753)
-- **decidim-sortitions**: Fix incorrect proposals sortition. [\5620](https://github.com/decidim/decidim/pull/5620)
+- **decidim-proposals**: Use simple_format to add a wrapper to proposals body [\#5753](https://github.com/decidim/decidim/pull/5753)
+- **decidim-sortitions**: Fix incorrect proposals sortition. [\#5620](https://github.com/decidim/decidim/pull/5620)
 - **decidim-admin**: Fix: let components without step settings be added [\#5568](https://github.com/decidim/decidim/pull/5568)
 - **decidim-proposals**: Fix proposals that have their state not published [\#5832](https://github.com/decidim/decidim/pull/5832)
 

decidim-blogs/app/cells/decidim/blogs/post_m_cell.rb

@@ -10,6 +10,12 @@ class PostMCell < Decidim::CardMCell
       def has_actions?
         false
       end
+
+      def endorsements_count
+        with_tooltip t("decidim.endorsable.endorsements") do
+          icon("bullhorn", class: "icon--small") + " " + model.endorsements_count.to_s
+        end
+      end
     end
   end
 end

decidim-blogs/app/helpers/decidim/blogs/application_helper.rb

@@ -8,6 +8,8 @@ module ApplicationHelper
       include PaginateHelper
       include SanitizeHelper
       include Decidim::Blogs::PostsHelper
+      include ::Decidim::EndorsableHelper
+      include ::Decidim::FollowableHelper
       include Decidim::Comments::CommentsHelper
     end
   end

decidim-blogs/app/models/decidim/blogs/post.rb

@@ -12,6 +12,8 @@ class Post < Blogs::ApplicationRecord
       include Decidim::Authorable
       include Decidim::Comments::Commentable
       include Decidim::Searchable
+      include Decidim::Endorsable
+      include Decidim::Followable
       include Traceable
       include Loggable
 
@@ -56,6 +58,10 @@ def official?
       def user_allowed_to_comment?(user)
         can_participate_in_space?(user)
       end
+
+      def users_to_notify_on_comment_created
+        followers
+      end
     end
   end
 end

decidim-blogs/app/views/decidim/blogs/posts/show.html.erb

@@ -14,18 +14,39 @@
     blogpost: post
   )
 %>
+
+<div class="row column view-header">
+  <h2 class="heading2"><%= translated_attribute post.title %></h2>
+  <%= cell "decidim/author", present(post.author), from: post %>
+</div>
 <div class="row">
-  <div class="columns medium-7 mediumlarge-8">
-    <div class="row column view-header">
-      <h2 class="heading2"><%= translated_attribute post.title %></h2>
-      <%= cell "decidim/author", present(post.author), from: post %>
-    </div>
+  <% if show_endorsements_card? %>
+      <div class="columns section view-side mediumlarge-4 mediumlarge-push-8 large-3 large-push-9">
+        <div class="card">
+          <div class="card__content">
+            <div class="row collapse buttons__row">
+              <% if endorsements_enabled? %>
+                <div class="column small-9 collapse">
+                  <%= endorsement_buttons_cell(post) %>
+                </div>
+              <% end %>
+              <div class="column collapse <%= endorsements_enabled? ? "small-3" : "" %>">
+                <%= link_to "#comments", class: "button small compact hollow secondary button--nomargin expanded" do %>
+                    <%= icon "comment-square", class: "icon--small", aria_label: t(".comments"), role: "img" %> <%= post.comments.count %>
+                <% end %>
+              </div>
+            </div>
+            <br>
+            <%= follow_button_for(post) %>
+          </div>
+        </div>
+      </div>
+  <% end %>
+  <div class="columns mediumlarge-8 mediumlarge-pull-4">
     <div class="section">
       <p><%= decidim_sanitize translated_attribute post.body %></p>
     </div>
-  </div>
-  <div id="most-commented" class="columns medium-5 mediumlarge-4 large-4">
-    <%= render partial: "sidebar_blog", locals: { posts: posts_most_commented } %>
+    <%= cell "decidim/endorsers_list", post %>
   </div>
 </div>
 <%= attachments_for post %>

decidim-blogs/config/locales/en.yml

@@ -49,6 +49,7 @@ en:
             title: title
       posts:
         show:
+          comments: Comments
           view: View
         sidebar_blog:
           comments: comments
@@ -64,6 +65,8 @@ en:
           step:
             announcement: Announcement
             comments_blocked: Comments blocked
+            endorsements_blocked: Endorsements blocked
+            endorsements_enabled: Endorsements enabled
     events:
       blogs:
         post_created:

decidim-blogs/db/migrate/20200128094730_add_endorsements_counter_cache_to_blogs.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddEndorsementsCounterCacheToBlogs < ActiveRecord::Migration[5.2]
+  def change
+    add_column :decidim_blogs_posts, :endorsements_count, :integer, null: false, default: 0
+  end
+end

decidim-blogs/lib/decidim/blogs/component.rb

@@ -18,6 +18,8 @@
     Decidim::Blogs::Post.where(component: components).count
   end
 
+  component.actions = %w(endorse vote create withdraw amend)
+
   component.settings(:global) do |settings|
     settings.attribute :announcement, type: :text, translated: true, editor: true
     settings.attribute :comments_enabled, type: :boolean, default: true
@@ -26,11 +28,14 @@
   component.settings(:step) do |settings|
     settings.attribute :announcement, type: :text, translated: true, editor: true
     settings.attribute :comments_blocked, type: :boolean, default: false
+    settings.attribute :endorsements_enabled, type: :boolean, default: true
+    settings.attribute :endorsements_blocked, type: :boolean
   end
 
   component.register_resource(:blogpost) do |resource|
     resource.model_class_name = "Decidim::Blogs::Post"
     resource.card = "decidim/blogs/post"
+    resource.actions = %w(endorse vote amend)
     resource.searchable = true
   end
 

decidim-blogs/spec/models/decidim/blogs/post_spec.rb

@@ -39,5 +39,49 @@ module Decidim::Blogs
     it "has an associated component" do
       expect(post.component).to be_a(Decidim::Component)
     end
+
+    describe "#endorsed_by?" do
+      let(:user) { create(:user, organization: subject.organization) }
+
+      context "with User endorsement" do
+        it "returns false if the post is not endorsed by the given user" do
+          expect(subject).not_to be_endorsed_by(user)
+        end
+
+        it "returns true if the post is not endorsed by the given user" do
+          create(:endorsement, resource: subject, author: user)
+          expect(subject).to be_endorsed_by(user)
+        end
+      end
+
+      context "with Organization endorsement" do
+        let!(:user_group) { create(:user_group, verified_at: Time.current, organization: user.organization) }
+        let!(:membership) { create(:user_group_membership, user: user, user_group: user_group) }
+
+        before { user_group.reload }
+
+        it "returns false if the post is not endorsed by the given organization" do
+          expect(subject).not_to be_endorsed_by(user, user_group)
+        end
+
+        it "returns true if the post is not endorsed by the given organization" do
+          create(:endorsement, resource: subject, author: user, user_group: user_group)
+          expect(subject).to be_endorsed_by(user, user_group)
+        end
+      end
+    end
+
+    describe "#users_to_notify_on_comment_created" do
+      let!(:follows) { create_list(:follow, 3, followable: subject) }
+      let(:followers) { follows.map(&:user) }
+      let(:participatory_space) { subject.component.participatory_space }
+      let(:organization) { participatory_space.organization }
+
+      context "when creating new comment" do
+        it "returns the followers" do
+          expect(subject.users_to_notify_on_comment_created).to match_array(followers)
+        end
+      end
+    end
   end
 end

…roposals/identity_selector_dialog.js.es6 …/decidim/identity_selector_dialog.js.es6decidim-proposals/app/assets/javascripts/decidim/proposals/identity_selector_dialog.js.es6 renamed to decidim-core/app/assets/javascripts/decidim/identity_selector_dialog.js.es6 decidim-proposals/app/assets/javascripts/decidim/proposals/identity_selector_dialog.js.es6 renamed to decidim-core/app/assets/javascripts/decidim/identity_selector_dialog.js.es6

@@ -6,14 +6,14 @@
 $(document).ready(function () {
 
   let button = $("#select-identity-button"),
-      refreshUrl = null,
+      identitiesUrl = null,
       userIdentitiesDialog = $("#user-identities");
 
   if (userIdentitiesDialog.length) {
-    refreshUrl = userIdentitiesDialog.data("refresh-url");
+    identitiesUrl = userIdentitiesDialog.data("reveal-identities-url");
 
     button.click(function () {
-      $.ajax(refreshUrl).done(function(response) {
+      $.ajax(identitiesUrl).done(function(response) {
         userIdentitiesDialog.html(response).foundation("open");
         button.trigger("ajax:success")
       });
@@ -32,21 +32,26 @@ $(document).ready(function () {
     $("#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")
+        let method = liTag.data("method"),
+            urlDataAttr = null;
+        if (method === "POST") {
+          urlDataAttr = "create_url";
+        } else {
+          urlDataAttr = "destroy_url";
+        }
         $.ajax({
-          url: url,
+          url: liTag.data(urlDataAttr),
           method: method,
           dataType: "script",
           success: function() {
             if (liTag.hasClass("selected")) {
               liTag.removeClass("selected")
               liTag.find(".icon--circle-check").addClass("invisible")
-              liTag.data("method", "post")
+              liTag.data("method", "POST")
             } else {
               liTag.addClass("selected")
               liTag.find(".icon--circle-check").removeClass("invisible")
-              liTag.data("method", "delete")
+              liTag.data("method", "DELETE")
             }
           }
         })