decidim-posts 1.0.0

data/README.md

@@ -0,0 +1,40 @@
+# Decidim::Posts component (under development)
+
+This Feeds component adds social posts functionality to Decidim.
+
+**The module is currently in development and not yet ready.**
+
+## Usage
+
+Feeds will be available as a Component for a Participatory
+Space.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "decidim-posts", git: "https://github.com/DecidimAustria/decidim-module-posts.git", branch: "main"
+```
+
+And then execute:
+
+```bash
+bundle
+bundle exec rails decidim_posts:install:migrations
+bundle exec rails db:migrate
+```
+
+## Contributing
+
+Contributions are welcome !
+
+We expect the contributions to follow the [Decidim's contribution guide](https://github.com/decidim/decidim/blob/develop/CONTRIBUTING.adoc).
+
+## Security
+
+Security is very important to us. If you have any issue regarding security, please disclose the information responsibly by sending an email to __security [at] mitgestalten [dot] jetzt__ and not by creating a Github issue.
+
+## License
+
+This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+desc "Generates a dummy app for testing"
+task test_app: "decidim:generate_external_test_app"
+
+desc "Generates a development app."
+task development_app: "decidim:generate_external_development_app"

data/app/cells/decidim/posts/comments/add_comment.erb

@@ -0,0 +1,15 @@
+<div class="add-comment">
+  <% if user_signed_in? %>
+    <%== cell("decidim/comments/comment_form", model, root_depth:) %>
+  <% else %>
+    <p>
+      <span>
+        <%== t(
+          "decidim.components.add_comment_form.account_message",
+          sign_in_url: decidim.new_user_session_path,
+          sign_up_url: decidim.new_user_registration_path
+        ) %>
+      </span>
+    </p>
+  <% end %>
+</div>

data/app/cells/decidim/posts/comments/comments_loading.erb

@@ -0,0 +1 @@
+<%= cell("decidim/announcement", t("decidim.components.comments.loading"), callout_class: "primary loading-comments mb-4") %>

data/app/cells/decidim/posts/comments/order_control.erb

@@ -0,0 +1,13 @@
+<div class="comment-order-by">
+  <% available_orders.each do | order_value| %>
+    <div class="text-center">
+      <%= link_to(
+        t("decidim.components.comment_order_selector.order.#{order_value}"),
+        decidim_comments.comments_path(commentable_gid: model.to_signed_global_id.to_s, order: order_value, reload: 1),
+        class: "button button__sm button__text-secondary only:m-auto comment-order-by__item inline-block #{order_value == order ? "underline font-bold" : ""}",
+        remote: true,
+        aria: { controls: threads_node_id }
+      ) %>
+    </div>
+  <% end %>
+</div>

data/app/cells/decidim/posts/comments/show.erb

@@ -0,0 +1,31 @@
+<%= append_stylesheet_pack_tag "decidim_comments" %>
+<%= content_tag :div, id: node_id, data: { decidim_posts_comments: comments_data } do %>
+  <div id="comments">
+    <div class="comments">
+      <div class="comments__header">
+        <h2 class="h4">
+          <% if single_comment? %>
+            <%= t("decidim.components.comments.comment_details_title") %>
+          <% else %>
+            <%= icon "chat-1-line", class: "fill-tertiary w-6 h-6 inline-block align-middle" %>
+            <span class="comments-count inline-block align-middle">
+              <%= t("decidim.components.comments.title", count: comments_count) %>
+            </span>
+          <% end %>
+        </h2>
+        <%= render :order_control %>
+      </div>
+      <%= single_comment_warning %>
+      <%= blocked_comments_warning %>
+      <div class="comment-threads" id="<%= threads_node_id %>" aria-live="polite">
+        <%= comments_loading %>
+        <% comments.each do |comment| %>
+          <%= cell("decidim/comments/comment_thread", comment, order:) %>
+        <% end %>
+      </div>
+      <%= add_comment %>
+      <%= user_comments_blocked_warning %>
+    </div>
+    <%= cell("decidim/announcement", t("decidim.components.comments.loading"), callout_class: "primary loading-comments hidden") %>
+  </div>
+<% end %>

data/app/cells/decidim/posts/comments_cell.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Posts
+    # A cell to display a comments section for a commentable object.
+    class CommentsCell < Decidim::ViewModel
+      include Decidim::IconHelper
+
+      delegate :user_signed_in?, to: :controller
+
+      def add_comment
+        return if single_comment?
+        return if comments_blocked?
+        return if user_comments_blocked?
+
+        render :add_comment
+      end
+
+      def single_comment_warning
+        return unless single_comment?
+
+        render :single_comment_warning
+      end
+
+      def comments_loading
+        return if single_comment?
+
+        render :comments_loading
+      end
+
+      def blocked_comments_warning
+        return unless comments_blocked?
+        return unless user_comments_blocked?
+
+        render :blocked_comments_warning
+      end
+
+      def user_comments_blocked_warning
+        return if comments_blocked? # Shows already the general warning
+        return unless user_comments_blocked?
+
+        render :user_comments_blocked_warning
+      end
+
+      private
+
+      def decidim_comments
+        Decidim::Comments::Engine.routes.url_helpers
+      end
+
+      def comments
+        single_comment? ? [single_comment] : []
+      end
+
+      def comments_count
+        model.comments_count
+      end
+
+      def root_depth
+        return 0 unless single_comment?
+
+        single_comment.depth
+      end
+
+      def commentable_path(params = {})
+        return resource_locator(Array(options[:polymorphic]).push(model)).path(params) if options[:polymorphic]
+
+        resource_locator(model).path(params)
+      end
+
+      def alignment_enabled?
+        model.comments_have_alignment?
+      end
+
+      def available_orders
+        %w(best_rated recent older most_discussed)
+      end
+
+      def order
+        options[:order] || "older"
+      end
+
+      def decidim
+        Decidim::Core::Engine.routes.url_helpers
+      end
+
+      def node_id
+        "comments-for-#{commentable_type.demodulize}-#{model.id}"
+      end
+
+      def threads_node_id
+        "#{node_id}-threads"
+      end
+
+      def commentable_type
+        model.commentable_type
+      end
+
+      def comments_data
+        {
+          singleComment: single_comment?,
+          toggleTranslations: machine_translations_toggled?,
+          commentableGid: model.to_signed_global_id.to_s,
+          commentsUrl: decidim_comments.comments_path,
+          rootDepth: root_depth,
+          order:,
+          pollingInterval: 300000
+        }
+      end
+
+      def single_comment?
+        single_comment.present?
+      end
+
+      def single_comment
+        return if options[:single_comment].blank?
+
+        @single_comment ||= SortedComments.for(model, id: options[:single_comment], order_by: order).first
+      end
+
+      def machine_translations_toggled?
+        options[:machine_translations] == true
+      end
+
+      def comments_blocked?
+        !model.accepts_new_comments?
+      end
+
+      def user_comments_blocked?
+        return false unless user_signed_in?
+
+        !model.user_allowed_to_comment?(current_user)
+      end
+
+      def comment_permissions?
+        [model, current_component].any? do |resource|
+          resource.try(:permissions).try(:[], "comment")
+        end
+      end
+
+      # action_authorization_link expects current_component to be available
+      def current_component
+        model.try(:component)
+      end
+
+      def blocked_comments_for_unauthorized_user_warning_link
+        options = if current_component.present?
+                    { resource: model }
+                  else
+                    { resource: model, permissions_holder: model }
+                  end
+        action_authorized_link_to(:comment, commentable_path, options) do
+          t("decidim.components.comments.blocked_comments_for_unauthorized_user_warning")
+        end
+      end
+    end
+  end
+end

data/app/cells/decidim/posts/content_blocks/posts/show.erb

@@ -0,0 +1,3 @@
+<section id="feeds" class="home__section feeds">
+  <%= render partial: "decidim/posts/posts/index.html" %>
+</section>

data/app/cells/decidim/posts/content_blocks/posts_cell.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Posts
+    module ContentBlocks
+      class PostsCell < Decidim::ViewModel
+        include Cell::ViewModel::Partial
+        include FormFactory
+
+        def show
+          @posts = Decidim::Posts::Post
+                   .where(decidim_component_id: component_id)
+                   .filter_category(params[:filter_post_category])
+                   .order(created_at: :desc)
+                   .limit(10)
+          extra_context = {
+            current_component: component,
+            current_organization: component.organization,
+            current_user:,
+            current_participatory_space: component.participatory_space
+          }
+          @form = form(Decidim::Posts::PostForm).from_params(params, extra_context)
+          render :show
+        end
+
+        def decidim_feeds
+          Decidim::EngineRouter.main_proxy(component)
+        end
+
+        def posts_path
+          decidim_feeds.posts_path
+        end
+
+        private
+
+        def component_id
+          @component_id ||= model.settings.try(:component_id)
+        end
+
+        def component
+          @component ||= Decidim::Component.find(component_id)
+        end
+
+        def post_creation_params
+          params[:post]
+        end
+      end
+    end
+  end
+end

data/app/cells/decidim/posts/content_blocks/posts_settings_form/show.erb

@@ -0,0 +1,3 @@
+<% form.fields_for :settings, form.object.settings do |settings_fields| %>
+  <%= settings_fields.select :component_id, available_feeds_options, prompt: "", label: t(".component") %>
+<% end %>

data/app/cells/decidim/posts/content_blocks/posts_settings_form_cell.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Posts
+    module ContentBlocks
+      class PostsSettingsFormCell < Decidim::ViewModel
+        # Found in HighlightedElementsForComponentSettingsFormCell
+        #include Decidim::ContentBlocks::HasRelatedComponents
+        alias form model
+
+        def available_feeds_options
+          available_feeds.map do |component|
+            [translated_attribute(component.name), component.id]
+          end
+        end
+
+        def available_feeds
+          @available_feeds ||= Decidim::Component.where(manifest_name: "posts").where(participatory_space_id: current_organization.participatory_spaces.pluck(:id))
+        end
+      end
+    end
+  end
+end

data/app/cells/decidim/posts/feed_dropdown_metadata_cell.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Posts
+    class FeedDropdownMetadataCell < Decidim::ParticipatorySpaceDropdownMetadataCell
+      # include FeedsHelper
+      include Decidim::ComponentPathHelper
+      include ActiveLinkTo
+
+      def decidim_feeds
+        Decidim::Posts::Engine.routes.url_helpers
+      end
+
+      private
+
+      def nav_items_method = :assembly_nav_items
+    end
+  end
+end

data/app/cells/decidim/posts/meeting/show.erb

@@ -0,0 +1,65 @@
+<article class="card__grid posts__post" data-content="calendar">
+  <%= cell("decidim/posts/post_header", meeting) %>
+  <div class="flex gap-4 py-2 px-2">
+    <div class="card__grid-text--meta flex flex-col gap-2">
+      <time class="card__calendar" datetime="<%= meeting.start_time.iso8601 %>">
+        <span class="card__calendar-month"><%= l(meeting.start_time, format: "%b") %></span>
+        <span class="card__calendar-day"><%= l(meeting.start_time, format: "%d") %></span>
+        <span class="card__calendar-year"><%= l(meeting.start_time, format: "%Y") %></span>
+      </time>
+      <% if meeting.start_time.to_date != meeting.end_time.to_date %>
+        <span class="self-center font-bold text-xs"><%= t("decidim.components.posts.calendar.date_separator") %></span>
+        <time class="card__calendar" datetime="<%= meeting.end_time.iso8601 %>">
+          <span class="card__calendar-month"><%= l(meeting.end_time, format: "%b") %></span>
+          <span class="card__calendar-day"><%= l(meeting.end_time, format: "%d") %></span>
+          <span class="card__calendar-year"><%= l(meeting.end_time, format: "%Y") %></span>
+        </time>
+      <% end %>
+    </div>
+    <div class="card__grid-text p-0">
+      <h2 class="h3"><%= link_to meeting_title, Decidim::EngineRouter.main_proxy(meeting.component).meeting_path(meeting) %></h2>
+      <% should_truncate = strip_tags(meeting_description).length > 300 %>
+      <div class="content-block__description editor-content" <%= "data-component='accordion'" if should_truncate %>>
+        <% if should_truncate %>
+          <% seed = SecureRandom.hex(4) %>
+          <div id="panel-view-more-<%= seed %>" aria-hidden="true">
+            <%= meeting_description %>
+          </div>
+          <button class="button button__sm button__text-secondary mt-2" data-controls="panel-view-more-<%= seed %>" aria-expanded="false">
+            <span>
+              <%= t("view_more", scope: "layouts.decidim.announcements") %>
+            </span>
+            <%= icon "arrow-down-s-line" %>
+            <span>
+              <%= t("view_less", scope: "layouts.decidim.announcements") %>
+            </span>
+            <%= icon "arrow-up-s-line" %>
+          </button>
+        <% else %>
+          <%= meeting_description %>
+        <% end %>
+      </div>
+      <div class="flex gap-4 mt-auto flex-wrap">
+        <div class="bg-background p-2 rounded-md font-bold shrink">
+          <time datetime="<%= meeting.start_time.iso8601 %>">
+            <%= l(meeting.start_time, format: "%H:%M") %>
+          </time>
+          </time>
+          <% if meeting.start_time != meeting.end_time %>
+            <%= t("decidim.components.posts.calendar.end_time") %>
+            <time datetime="<%= meeting.end_time.iso8601 %>">
+              <%= l(meeting.end_time, format: "%H:%M") %>
+            </time>
+          <% end %>
+        </div>
+        <% if meeting_location != '' %>
+          <div class="bg-background p-2 rounded-md font-bold shrink">
+            <%= meeting_location %>
+          </div>
+        <% end %>
+      </div>
+    </div>
+  </div>
+  <%= cell("decidim/posts/post_comment", meeting) %>
+  <%= cell("decidim/posts/post_metadata", meeting) %>
+</article>

data/app/cells/decidim/posts/meeting_cell.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Posts
+    class MeetingCell < Decidim::ViewModel
+      include PostCellsHelper
+      include Decidim::Meetings::MeetingCellsHelper
+      include Cell::ViewModel::Partial
+
+      def show
+        render :show
+      end
+
+      def meeting
+        model
+      end
+
+      def meeting_author
+        model.decidim_author_id
+      end
+
+      def meeting_title
+        translated_attribute model.title
+      end
+
+      def meeting_description
+        translated_attribute model.description
+      end
+
+      def meeting_address
+        model.address
+      end
+
+      def meeting_location
+        translated_attribute model.location
+      end
+
+      def comments_enabled
+        model.comments_enabled?
+      end
+
+    end
+  end
+end

data/app/cells/decidim/posts/post/show.erb

@@ -0,0 +1,30 @@
+<%= cell("decidim/posts/post_header", post) %>
+<%= cell("decidim/posts/post_attachments", post) %>
+<div class="card__grid-text">
+  <% should_truncate = strip_tags(post_body).length > 300 %>
+  <div class="content-block__description editor-content" <%= "data-component='accordion'" if should_truncate %>>
+    <% if should_truncate %>
+      <% seed = SecureRandom.hex(4) %>
+      <div id="panel-view-more-<%= seed %>" aria-hidden="true">
+        <%= post_body %>
+      </div>
+      <button class="button button__sm button__text-secondary mt-2" data-controls="panel-view-more-<%= seed %>" aria-expanded="false">
+        <span>
+          <%= t("view_more", scope: "layouts.decidim.announcements") %>
+        </span>
+        <%= icon "arrow-down-s-line" %>
+        <span>
+          <%= t("view_less", scope: "layouts.decidim.announcements") %>
+        </span>
+        <%= icon "arrow-up-s-line" %>
+      </button>
+    <% else %>
+      <%= post_body %>
+    <% end %>
+  </div>
+</div>
+<% if post_category == 'survey' %>
+  <%= render :survey %>
+<% end %>
+<%= cell("decidim/posts/post_comment", post) %>
+<%= cell("decidim/posts/post_metadata", post) %>

data/app/cells/decidim/posts/post/survey.erb

@@ -0,0 +1,68 @@
+<div class="posts__post_survey" id="post_<%= post.id %>_survey">
+  <span class="text-right py-2">
+    <%= t("decidim.posts.survey.participated", count: post.survey_responses_count) %>
+  </span>
+  <% post.questions.each do |question| %>
+    <% if question.question_type == "single_choice" %>
+      <fieldset class="posts__post_survey-question">
+        <legend><%= translated_attribute question.title %></legend>
+        <% question.answers.each do |answer| %>
+          <div class="posts__post_survey-question-answer">
+            <div class="posts__post_survey-question-answerInput">
+              <%= radio_button_tag "post[questions][#{question.id}]", answer.id, answer.user_answers.find_by(decidim_posts_answer_id: answer.id, decidim_user_id: current_user.id).present?, class: "survey-answer-checkbox", data: { question_id: question.id, answer_id: answer.id } %>
+              <%= label_tag "post_questions_#{question.id}_#{answer.id}" do %>
+                <%= translated_attribute answer.title %>
+              <% end %>
+            </div>
+            <div class="posts__post_survey-question-answerProgressbar flex justify-between p-1 border border-gray rounded-full shadow-md">
+              <div class="w-full bg-background rounded-full">
+                <% percentage = post.survey_responses_count.zero? ? 0 : (answer.user_answers.count.to_f / post.survey_responses_count) * 100 %>
+                <div id="answer-<%= answer.id %>-progressbar" class="bg-success h-full rounded-full shadow-md" style="width: <%= percentage %>%"></div>
+              </div>
+              <span class="text-sm shrink-0 px-2">
+                <span id="answer-<%= answer.id %>-counter">
+                  <%= answer.user_answers.count %>
+                </span>
+                /
+                <span id="answer-<%= answer.id %>-total">
+                  <%= post.survey_responses_count %>
+                </span>
+                <span class="sr-only">haben geantwortet</span>
+              </span>
+            </div>
+          </div>
+        <% end %>
+      </fieldset>
+    <% elsif question.question_type == "multiple_choice" %>
+      <fieldset class="posts__post_survey-question">
+        <legend><%= translated_attribute question.title %></legend>
+        <% question.answers.each do |answer| %>
+          <div class="posts__post_survey-question-answer">
+            <div class="posts__post_survey-question-answerInput">
+              <%= check_box_tag "post[questions][#{question.id}][#{answer.id}]", answer.id, answer.user_answers.find_by(decidim_posts_answer_id: answer.id, decidim_user_id: current_user.id).present?, class: "survey-answer-checkbox", data: { question_id: question.id, answer_id: answer.id } %>
+              <%= label_tag "post_questions_#{question.id}_#{answer.id}" do %>
+                <%= translated_attribute answer.title %>
+              <% end %>
+            </div>
+            <div class="posts__post_survey-question-answerProgressbar flex justify-between p-1 border border-gray rounded-full shadow-md">
+              <div class="w-full bg-background rounded-full">
+                <% percentage = post.survey_responses_count.zero? ? 0 : (answer.user_answers.count.to_f / post.survey_responses_count) * 100 %>
+                <div id="answer-<%= answer.id %>-progressbar" class="bg-success h-full rounded-full shadow-md" style="width: <%= percentage %>%"></div>
+              </div>
+              <span class="text-sm shrink-0 px-2">
+                <span id="answer-<%= answer.id %>-counter">
+                  <%= answer.user_answers.count %>
+                </span>
+                /
+                <span id="answer-<%= answer.id %>-total">
+                  <%= post.survey_responses_count %>
+                </span>
+                <span class="sr-only">haben geantwortet</span>
+              </span>
+            </div>
+          </div>
+        <% end %>
+      </fieldset>
+    <% end %>
+  <% end %>
+</div>

data/app/cells/decidim/posts/post_attachments/show.erb

@@ -0,0 +1,40 @@
+<% if post.attachments.any? %>
+  <div class="feeds__attachments py-4 px-2">
+
+    <div class="flex flex-col items-center">
+      <ul id="galleryItems_<%= post.id %>" class="posts__post_gallery flex overflow-hidden">
+        <% post.attachments.select { |a| a.url.match(/\.(jpg|jpeg|png|svg|webp|mp4|webm)$/i) }.each_with_index do |attachment, index| %>
+          <li class="<%= attachment.url.match(/\.(mp4|webm)$/i) ? 'video' : 'image' %> <%= index.zero? ? 'active' : '' %> aspect-4/3 overflow-hidden flex justify-center items-center" data-src="<%= attachment.url %>">
+            <% if attachment.url.match(/\.(mp4|webm)$/i) %>
+              <%= video_tag(attachment.url, class: "object-cover w-full h-full", controls: true, preload: "auto") %>
+            <% else %>
+              <div class="w-full h-full flex justify-center items-center">
+                <%= image_tag(attachment.url, class: "max-w-full max-h-full object-contain", alt: translated_attribute(attachment.title), width: '400px', height: '300px' ) %>
+              </div>
+            <% end %>
+          </li>
+        <% end %>
+      </ul>
+      <% if post.attachments.select { |a| a.url.match(/\.(jpg|jpeg|png|svg|webp|mp4|webm)$/i) }.count > 1 %>
+        <div id="navDots_<%= post.id %>" class="nav-dots p-1 flex flex-wrap justify-center">
+          <% total = post.attachments.select { |a| a.url.match(/\.(jpg|jpeg|png|svg|webp|mp4|webm)$/i) }.count %>
+          <% post.attachments.select { |a| a.url.match(/\.(jpg|jpeg|png|svg|webp|mp4|webm)$/i) }.each_with_index do |_, index| %>
+            <div class="posts__post_gallery_nav_dot flex justify-center items-center cursor-pointer h-6 w-6" role="button" aria-label="<%= t('decidim.components.posts.gallery.navigation', number: index + 1, total: total) %>" data-target="galleryItems_<%= post.id %>" data-index="<%= index %>">
+              <span class="h-2 w-2 rounded-full ring-1 ring-offset-1 ring-feeds-notification <%= index.zero? ? 'bg-feeds-notification' : '' %>"></span>
+            </div>
+          <% end %>
+        </div>
+      <% end %>
+    </div>
+    <% non_media_attachments = post.attachments.reject { |a| a.url.match(/\.(jpg|jpeg|png|svg|webp|mp4|webm)$/i) } %>
+    <% if non_media_attachments.any? %>
+      <ul class="document-list space-y-2 mt-4">
+        <% non_media_attachments.each_with_index do |attachment, index| %>
+          <li class="<%= index.even? ? 'bg-feeds-formBody' : '' %> py-1 pl-2 pr-4 flex gap-1 items-center">
+            <%= icon "file-2-line" %> <%= link_to File.basename(attachment.url), attachment.url, class: 'text-sm break-all', style: 'overflow-wrap: break-word' %>
+          </li>
+        <% end %>
+      </ul>
+    <% end %>
+  </div>
+<% end %>

data/app/cells/decidim/posts/post_attachments_cell.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Posts
+    class PostAttachmentsCell < Decidim::ViewModel
+      include Cell::ViewModel::Partial
+      def show
+        render :show
+      end
+
+      def post
+        model
+      end
+      
+    end
+  end
+end