decidim-enhanced_textwork 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd03b51331f0a2832bd33cc372e8e43525b173429e7e01b995272725cf5ac479
+  data.tar.gz: 99b59e96c6a4e1dfa4ddecefc058f76a82808761c10e927e8841aad0a442434e
+SHA512:
+  metadata.gz: ba7f20ed5ccb967f177d9c737537a89cfceaff66fa0e25ff02a62c9f8c03c5f65272a88124060e51ad3e24efb39c6470c87ed75581017d7b12bfc08314aa0774
+  data.tar.gz: b9457fe3a96c9b8878bf1020bc90cc108db86f2372eb3c387b30d4c1d50efc12f63f3f4d23a0d0cd4aea1c8693888905a5e25c39b87252ac50670c874f8dfeb2

data/README.md

@@ -0,0 +1,64 @@
+# Decidim::EnhancedTextwork
+
+The EnhancedTextwork module allows users to contribute to a participatory process with text work by creating paragraphs.
+
+## Usage
+
+EnhancedTextwork will be available as a Component for a Participatory Process.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-enhanced_textwork'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+### Configuring Similarity
+
+`pg_trgm` is a PostgreSQL extension providing simple fuzzy string matching used in the Paragraph wizard to find similar published paragraphs (title and the body).
+
+Create config variables in your app's `/config/initializers/decidim-enhanced_textwork.rb`:
+
+```ruby
+Decidim::EnhancedTextwork.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.
+
+## Global Search
+
+This module includes the following models to Decidim's Global Search:
+
+- `Paragraphs`
+
+## Participatory Texts
+
+Participatory texts persist each section of the document in a Paragraph.
+
+When importing participatory texts all formats are first transformed into Markdown and is the markdown that is parsed and processed to generate the corresponding Paragraphs.
+
+When processing participatory text documents three kinds of secions are taken into account.
+
+- Section: each "Title 1" in the document becomes a section.
+- Subsection: the rest of the titles become subsections.
+- Article: paragraphs become articles.
+
+## Contributing
+
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+
+See [Decidim](https://github.com/decidim/decidim).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"

data/app/cells/decidim/enhanced_textwork/amendment/show.erb

@@ -0,0 +1,14 @@
+<div class="card emendation">
+  <div class="amendment__header">
+    <div class="amendment__author">
+      <%= cell('decidim/author', emendation_author, has_tooltip: true).(:profile_inline) %>
+    </div>
+    <div class="amendment__date">
+      <%= created_at %>
+    </div>
+  </div>
+
+  <div class="amendment__actions">
+    <%= link_to t('decidim.enhanced_textwork.actions.show_amendment'), compare_emendation_path, class: 'link' %>
+  </div>
+</div>

data/app/cells/decidim/enhanced_textwork/amendment_cell.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module EnhancedTextwork
+    class AmendmentCell < Decidim::ViewModel
+      include Cell::ViewModel::Partial
+      include Decidim::SanitizeHelper
+      include ParagraphCellsHelper
+
+      def show
+        render
+      end
+
+      private
+
+      def emendation
+        model.emendation
+      end
+
+      def emendation_author
+        present(model.emendation.authors.first)
+      end
+
+      def emendation_excerpt
+        truncate(decidim_sanitize(translated_attribute(model.emendation.body), strip_tags: true), length: 200)
+      end
+
+      def created_at
+        I18n.l model.created_at, format: :long
+      end
+
+      def compare_emendation_path
+        compare_paragraph_path(model.emendation)
+      end
+    end
+  end
+end

data/app/cells/decidim/enhanced_textwork/collaborative_draft_cell.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module EnhancedTextwork
+    # This cell renders the collaborative_draft card for an instance of a CollaborativeDraft
+    # the default size is the Medium Card (:m)
+    class CollaborativeDraftCell < Decidim::ViewModel
+      include CollaborativeDraftCellsHelper
+      include Cell::ViewModel::Partial
+      include Messaging::ConversationHelper
+
+      def show
+        cell card_size, model, @options
+      end
+
+      private
+
+      def card_size
+        "decidim/enhanced_textwork/collaborative_draft_m"
+      end
+
+      def resource_path
+        resource_locator(model).path(filter_link_params)
+      end
+
+      def current_participatory_space
+        model.component.participatory_space
+      end
+
+      def component_name
+        translated_attribute current_component.name
+      end
+
+      def component_type_name
+        model.class.model_name.human
+      end
+
+      def participatory_space_name
+        translated_attribute current_participatory_space.title
+      end
+
+      def participatory_space_type_name
+        translated_attribute current_participatory_space.model_name.human
+      end
+    end
+  end
+end

data/app/cells/decidim/enhanced_textwork/collaborative_draft_link_to_paragraph/show.erb

@@ -0,0 +1,13 @@
+<div>
+  <%= link_header %>
+</div>
+
+<div>
+  <%= link_help_text %>
+</div>
+
+<%= link_to_resource %>
+
+<div class="mt-xs">
+  <%= link_to_versions %>
+</div>

data/app/cells/decidim/enhanced_textwork/collaborative_draft_link_to_paragraph_cell.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module EnhancedTextwork
+    # This cell renders the link to the published paragraph of a collaborative draft.
+    class CollaborativeDraftLinkToParagraphCell < Decidim::ViewModel
+      def show
+        render if paragraph
+      end
+
+      private
+
+      def paragraph
+        @paragraph ||= model.linked_resources(:paragraph, "created_from_collaborative_draft").first
+      end
+
+      def link_to_resource
+        link_to resource_locator(paragraph).path, class: "button secondary light expanded button--sc mt-s" do
+          t("published_paragraph", scope: "decidim.enhanced_textwork.collaborative_drafts.show")
+        end
+      end
+
+      def link_header
+        tag.strong(class: "text-large") do
+          t("final_paragraph", scope: "decidim.enhanced_textwork.collaborative_drafts.show")
+        end
+      end
+
+      def link_help_text
+        tag.span(class: "text-medium") do
+          t("final_paragraph_help_text", scope: "decidim.enhanced_textwork.collaborative_drafts.show")
+        end
+      end
+
+      def link_to_versions
+        @path ||= decidim_enhanced_textwork.collaborative_draft_versions_path(
+          collaborative_draft_id: model.id
+        )
+        link_to @path, class: "text-medium" do
+          tag.u do
+            t("version_history", scope: "decidim.enhanced_textwork.collaborative_drafts.show")
+          end
+        end
+      end
+
+      def decidim
+        Decidim::Core::Engine.routes.url_helpers
+      end
+
+      def decidim_enhanced_textwork
+        Decidim::EngineRouter.main_proxy(model.component)
+      end
+    end
+  end
+end

data/app/cells/decidim/enhanced_textwork/collaborative_draft_m/footer.erb

@@ -0,0 +1,6 @@
+<div class="card__footer">
+  <div class="card__support">
+    <div class="card__support__data"></div>
+    <%= link_to t("decidim.enhanced_textwork.collaborative_drafts.collaborative_draft.view_collaborative_draft"), resource_path, class: "card__button button--sc light button small" %>
+  </div>
+</div>

data/app/cells/decidim/enhanced_textwork/collaborative_draft_m/tags.erb

@@ -0,0 +1 @@
+<%= render partial: "decidim/shared/tags.html", locals: { resource: model, tags_class_extra: "tags--paragraph" } %>

data/app/cells/decidim/enhanced_textwork/collaborative_draft_m_cell.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module EnhancedTextwork
+    # This cell renders a paragraph with its M-size card.
+    class CollaborativeDraftMCell < Decidim::CardMCell
+      include CollaborativeDraftCellsHelper
+
+      def badge
+        render
+      end
+
+      private
+
+      def has_state?
+        true
+      end
+
+      def title
+        decidim_html_escape(present(model).title)
+      end
+
+      def description
+        decidim_sanitize(present(model).body.truncate(100, separator: /\s/))
+      end
+
+      def has_badge?
+        true
+      end
+
+      def badge_classes
+        return super unless options[:full_badge]
+
+        state_classes.concat(["label", "collaborative-draft-status"]).join(" ")
+      end
+
+      def statuses
+        [:creation_date, :follow, :comments_count]
+      end
+    end
+  end
+end

data/app/cells/decidim/enhanced_textwork/collaborative_drafts/reported_content/show.erb

@@ -0,0 +1,3 @@
+<blockquote>
+  <p><%= render_value model.body %></p>
+</blockquote>

data/app/cells/decidim/enhanced_textwork/collaborative_drafts/reported_content_cell.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module CollaborativeDrafts
+      # This cells renders a small preview of the `CollaborativeDraft` that is
+      # used in the moderations panel.
+      class ReportedContentCell < Decidim::ReportedContentCell
+        def show
+          render :show
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+<%= content_tag :div, id: node_id, data: { decidim_comments: comments_data } do %>
+  <div class="comments-container" id="comments">
+    <div class="comments">
+      <div class="row collapse comments__header">
+        <h3 class="order-by__text section-heading">
+          <%= comments_count %> <%= Decidim::Comments::Comment.model_name.human(count: comments_count) %>
+        </h3>
+        <% if comments_count > 2 && current_component.settings.comments_enabled %>
+          <%= link_to '#add_comment', class: 'link' do %>
+            <%= icon "comment-square", class: "icon--small", role: "img", "aria-hidden": true %>
+            <span><%= t('decidim.enhanced_textwork.actions.add_comment') %></span>
+          <% end %>
+        <% end %>
+      </div>
+
+      <%= single_comment_warning %>
+      <%= blocked_comments_warning %>
+      <div class="comment-threads">
+        <% comments.each do |comment| %>
+          <%= cell("decidim/comments/comment_thread", comment, order: order) %>
+        <% end %>
+      </div>
+      <div id="add_comment">
+        <%= add_comment %>
+      </div>
+      <%= user_comments_blocked_warning %>
+    </div>
+    <div class="callout primary loading-comments hide">
+      <p><%= t("decidim.components.comments.loading") %></p>
+    </div>
+  </div>
+<% end %>
+<%= javascript_include_tag("decidim/comments/comments") %>

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    class CommentsCell < Decidim::Comments::CommentsCell
+    end
+  end
+end

data/app/cells/decidim/enhanced_textwork/content_blocks/highlighted_paragraphs/elements.erb

@@ -0,0 +1,5 @@
+<div class="row small-up-1 medium-up-2 mediumlarge-up-3 large-up-3 card-grid">
+  <% elements.each do |element| %>
+    <%= card_for element, context: { show_space: true } %>
+  <% end %>
+</div>

data/app/cells/decidim/enhanced_textwork/content_blocks/highlighted_paragraphs/heading.erb

@@ -0,0 +1 @@
+<h2 class="section-heading"><%= t("decidim.enhanced_textwork.content_blocks.highlighted_paragraphs.paragraphs") %></h2>

data/app/cells/decidim/enhanced_textwork/content_blocks/highlighted_paragraphs_cell.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module EnhancedTextwork
+    module ContentBlocks
+      class HighlightedParagraphsCell < Decidim::ContentBlocks::HighlightedElementsCell
+        def base_relation
+          @base_relation ||= Decidim::EnhancedTextwork::Paragraph.published.not_hidden.except_withdrawn.where(component: published_components)
+        end
+
+        private
+
+        def limit
+          Decidim::EnhancedTextwork.config.process_group_highlighted_paragraphs_limit
+        end
+      end
+    end
+  end
+end

data/app/cells/decidim/enhanced_textwork/cost_report/show.erb

@@ -0,0 +1,35 @@
+<div id="paragraph-costs" class="card card--secondary" data-toggler=".expanded-text">
+  <div class="card__content">
+    <div class="mb-s">
+      <div class="data-title">
+        <h3 class="data-title__over">
+          <%= t("decidim.enhanced_textwork.paragraphs.show.estimated_cost") %>
+        </h3>
+        <div>
+          <strong class="data-title__main">
+            <%= cost %>
+          </strong>
+        </div>
+        <div class="data-title__sub">
+          <%= execution_period %>
+        </div>
+      </div>
+    </div>
+    <div id="execution-cost-short" class="text-toggle__short">
+      <%= cost_report_short %>
+      <% if needs_text_toggle? %>
+      <button class="muted-link" data-toggle="paragraph-costs">
+        <%= t("decidim.enhanced_textwork.paragraphs.show.read_more") %>
+      </button>
+      <% end %>
+    </div>
+    <% if needs_text_toggle? %>
+    <div id="execution-cost-long" class="text-toggle__long">
+      <%= cost_report %>
+      <button class="muted-link" data-toggle="paragraph-costs">
+        <%= t("decidim.enhanced_textwork.paragraphs.show.read_less") %>
+      </button>
+    </div>
+    <% end %>
+  </div>
+</div>

data/app/cells/decidim/enhanced_textwork/cost_report_cell.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module EnhancedTextwork
+    # This cell renders the cost report for a paragraph.
+    class CostReportCell < Decidim::ViewModel
+      include ActionView::Helpers::NumberHelper
+      include Decidim::SanitizeHelper
+      include Decidim::LayoutHelper
+      include ParagraphCellsHelper
+
+      private
+
+      def cost
+        number_to_currency(model.cost, unit: Decidim.currency_unit)
+      end
+
+      def cost_report
+        decidim_sanitize(translated_attribute(model.cost_report).html_safe)
+      end
+
+      def needs_text_toggle?
+        cost_report != cost_report_short
+      end
+
+      def cost_report_short
+        decidim_sanitize(
+          html_truncate(
+            translated_attribute(model.cost_report).html_safe,
+            length: 200
+          )
+        )
+      end
+
+      def execution_period
+        decidim_sanitize(translated_attribute(model.execution_period).html_safe)
+      end
+    end
+  end
+end

data/app/cells/decidim/enhanced_textwork/highlighted_paragraphs/show.erb

@@ -0,0 +1,3 @@
+<% published_components.each do |component| %>
+  <%= cell "decidim/enhanced_textwork/highlighted_paragraphs_for_component", component %>
+<% end %>

data/app/cells/decidim/enhanced_textwork/highlighted_paragraphs_cell.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module EnhancedTextwork
+    # This cell renders the highlighted paragraphs for a given participatory
+    # space. It is intended to be used in the `participatory_space_highlighted_elements`
+    # view hook.
+    class HighlightedParagraphsCell < Decidim::ViewModel
+      include ParagraphCellsHelper
+
+      private
+
+      def published_components
+        Decidim::Component
+          .where(
+            participatory_space: model,
+            manifest_name: :enhanced_textwork
+          )
+          .published
+      end
+    end
+  end
+end

data/app/cells/decidim/enhanced_textwork/highlighted_paragraphs_for_component/show.erb

@@ -0,0 +1,19 @@
+<section class="section row collapse highlighted_paragraphs">
+  <h3 class="section-heading">
+    <%= translated_attribute(model.name) %>  <a href="<%= main_component_path(model) %>" class="text-small"><%= t("decidim.participatory_spaces.highlighted_paragraphs.see_all", count: paragraphs_count) %></a>
+  </h3>
+
+  <%= cell(
+    "decidim/collapsible_list",
+    paragraphs_to_render,
+    cell_options: {},
+    list_class: "row small-up-1 medium-up-2 card-grid",
+    size: paragraphs_count
+    ) %>
+
+  <%= link_to(
+    t("decidim.participatory_spaces.highlighted_paragraphs.see_all", count: paragraphs_count),
+    main_component_path(model),
+    class: "button button--sc hollow button--right"
+  ) %>
+</section>

data/app/cells/decidim/enhanced_textwork/highlighted_paragraphs_for_component_cell.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "cell/partial"
+
+module Decidim
+  module EnhancedTextwork
+    # This cell renders the highlighted paragraphs for a given component.
+    # It is intended to be used in the `participatory_space_highlighted_elements`
+    # view hook.
+    class HighlightedParagraphsForComponentCell < Decidim::ViewModel
+      include Decidim::ComponentPathHelper
+
+      def show
+        render unless paragraphs_count.zero?
+      end
+
+      private
+
+      def paragraphs
+        @paragraphs ||= if model.settings.participatory_texts_enabled?
+                         Decidim::EnhancedTextwork::Paragraph.published.not_hidden.except_withdrawn
+                                                    .only_emendations
+                                                    .where(component: model)
+                                                    .order_randomly(rand * 2 - 1)
+                       else
+                         Decidim::EnhancedTextwork::Paragraph.published.not_hidden.except_withdrawn
+                                                    .where(component: model)
+                                                    .order_randomly(rand * 2 - 1)
+                       end
+      end
+
+      def paragraphs_to_render
+        @paragraphs_to_render ||= paragraphs.includes([:amendable, :category, :component, :scope]).limit(Decidim::EnhancedTextwork.config.participatory_space_highlighted_paragraphs_limit)
+      end
+
+      def paragraphs_count
+        @paragraphs_count ||= paragraphs.count
+      end
+    end
+  end
+end

data/app/cells/decidim/enhanced_textwork/irreversible_action_modal/show.erb

@@ -0,0 +1,27 @@
+<%= button_reveal_modal %>
+
+<div id="<%= modal_id %>" class="reveal" data-reveal aria-labelledby="<%= modal_id %>-title" aria-hidden="true" role="dialog">
+  <div class="reveal__header">
+    <h3 id="<%= modal_id %>-title" class="reveal__title">
+      <%= modal_title %>
+    </h3>
+
+    <button class="close-button" data-close aria-label="<%= close_label %>" type="button">
+      <span aria-hidden="true">&times;</span>
+    </button>
+  </div>
+
+  <div class="row">
+    <div>
+      <p>
+        <%= modal_body %>
+      </p>
+    </div>
+  </div>
+
+  <div class="row">
+    <%= button_cancel %>
+
+    <%= button_continue %>
+  </div>
+</div>