decidim-participatory_documents 0.2.0

data/README.md

@@ -0,0 +1,166 @@
+# Decidim Participatory Documents
+
+[![[CI] Lint](https://github.com/openpoke/decidim-module-participatory-documents/actions/workflows/lint.yml/badge.svg)](https://github.com/openpoke/decidim-module-participatory-documents/actions/workflows/lint.yml)
+[![[CI] Test](https://github.com/openpoke/decidim-module-participatory-documents/actions/workflows/test.yml/badge.svg)](https://github.com/openpoke/decidim-module-participatory-documents/actions/workflows/test.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b55516d46671ac78a43f/maintainability)](https://codeclimate.com/github/openpoke/decidim-module-participatory-documents/maintainability)
+[![codecov](https://codecov.io/gh/openpoke/decidim-module-participatory-documents/branch/main/graph/badge.svg?token=TMZHD2XO6U)](https://codecov.io/gh/openpoke/decidim-module-participatory-documents)
+[![Gem Version](https://badge.fury.io/rb/decidim-participatory-documents.svg)](https://badge.fury.io/rb/decidim-participatory-documents)
+
+This module allows to upload PDF (and possibilty other formats) and define areas on top of it that will become spaces for suggestions, improvements and other participative activities.
+
+> NOTE: in development, not ready for production.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-participatory_documents', git: "https://github.com/openpoke/decidim-module-participatory-documents"
+```
+
+And then execute:
+
+```
+bundle
+bundle exec rails decidim_participatory_documents:install:migrations
+```
+
+## Usage
+
+TODO...
+
+
+Options such as `:max_suggestion_length`, `:min_suggestion_length` and etc. are configured at the component level in 
+the application. Defaults to the configured in the module:
+```ruby
+# lib/decidim/participatory_documents.rb
+
+module Decidim
+  # This namespace holds the logic of the `decidim-participatory_documents` module.
+  module ParticipatoryDocuments
+    include ActiveSupport::Configurable
+
+    # Public: The minimum length of a suggestion to be considered valid.
+    config_accessor :min_suggestion_length do
+      5
+    end
+    
+    # Public: The maximum length of a suggestion to be considered valid.
+    config_accessor :max_suggestion_length do
+      500
+    end
+  end
+end
+```
+
+```ruby
+# config/initializers/participatory_documents.rb
+
+Decidim::ParticipatoryDocuments.configure do |config|
+end
+```
+
+And, of course, having these values in your `config/secrets.yml` file.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/openpoke/decidim-module-participatory-documents.
+
+### Developing
+
+To start contributing to this project, first:
+
+- Install the basic dependencies (such as Ruby and PostgreSQL)
+- Clone this repository
+
+Decidim's main repository also provides a Docker configuration file if you
+prefer to use Docker instead of installing the dependencies locally on your
+machine.
+
+You can create the development app by running the following commands after
+cloning this project:
+
+```bash
+$ bundle
+$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake development_app
+```
+
+Note that the database user has to have rights to create and drop a database in
+order to create the dummy test app database.
+
+Then to test how the module works in Decidim, start the development server:
+
+```bash
+$ cd development_app
+$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rails s
+```
+
+In case you are using [rbenv](https://github.com/rbenv/rbenv) and have the
+[rbenv-vars](https://github.com/rbenv/rbenv-vars) plugin installed for it, you
+can add the environment variables to the root directory of the project in a file
+named `.rbenv-vars`. If these are defined for the environment, you can omit
+defining these in the commands shown above.
+
+#### Code Styling
+
+Please follow the code styling defined by the different linters that ensure we
+are all talking with the same language collaborating on the same project. This
+project is set to follow the same rules that Decidim itself follows.
+
+[Rubocop](https://rubocop.readthedocs.io/) linter is used for the Ruby language.
+
+You can run the code styling checks by running the following commands from the
+console:
+
+```
+$ bundle exec rubocop
+```
+
+To ease up following the style guide, you should install the plugin to your
+favorite editor, such as:
+
+- Atom - [linter-rubocop](https://atom.io/packages/linter-rubocop)
+- Sublime Text - [Sublime RuboCop](https://github.com/pderichs/sublime_rubocop)
+- Visual Studio Code - [Rubocop for Visual Studio Code](https://github.com/misogi/vscode-ruby-rubocop)
+
+### Testing
+
+To run the tests run the following in the gem development path:
+
+```bash
+$ bundle
+$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake test_app
+$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rspec
+```
+
+Note that the database user has to have rights to create and drop a database in
+order to create the dummy test app database.
+
+In case you are using [rbenv](https://github.com/rbenv/rbenv) and have the
+[rbenv-vars](https://github.com/rbenv/rbenv-vars) plugin installed for it, you
+can add these environment variables to the root directory of the project in a
+file named `.rbenv-vars`. In this case, you can omit defining these in the
+commands shown above.
+
+### Test code coverage
+
+If you want to generate the code coverage report for the tests, you can use
+the `SIMPLECOV=1` environment variable in the rspec command as follows:
+
+```bash
+$ SIMPLECOV=1 bundle exec rspec
+```
+
+This will generate a folder named `coverage` in the project root which contains
+the code coverage report.
+
+### Localization
+
+If you would like to see this module in your own language, you can help with its
+translation at Crowdin:
+
+https://crowdin.com/project/decidim-participatory-documents
+
+## License
+
+See [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt).

data/Rakefile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+require "fileutils"
+
+def install_module(path)
+  # maintain until https://github.com/decidim/decidim/commit/51b81b37004708ab72e70993fef4634eef18ee6c is in the decidim version used
+  FileUtils.cp("babel.config.json", "#{path}/babel.config.json")
+  Dir.chdir(path) do
+    system("bundle exec rake decidim_participatory_documents:install:migrations")
+    system("bundle exec rake db:migrate")
+    system("bundle exec rake decidim_participatory_documents:install_pdf_js")
+  end
+end
+
+def seed_db(path)
+  Dir.chdir(path) do
+    system("bundle exec rake db:seed")
+  end
+end
+
+desc "Generates a dummy app for testing"
+task test_app: "decidim:generate_external_test_app" do
+  ENV["RAILS_ENV"] = "test"
+  install_module("spec/decidim_dummy_app")
+end
+
+desc "Generates a development app."
+task :development_app do
+  Bundler.with_original_env do
+    generate_decidim_app(
+      "development_app",
+      "--app_name",
+      "#{base_app_name}_development_app",
+      "--path",
+      "..",
+      "--recreate_db",
+      "--demo"
+    )
+  end
+
+  install_module("development_app")
+  seed_db("development_app")
+end

data/app/cells/decidim/participatory_documents/edit_suggestion_note_modal/show.erb

@@ -0,0 +1,20 @@
+<div class="reveal edit-note-modal" id="<%= modal_id %>" data-reveal role="dialog" aria-modal="true"
+     aria-labelledby="<%= modal_id %>-label">
+  <div class="reveal__header">
+    <h3 id="<%= modal_id %>-label" class="reveal__title"><%= t("modal.title", scope: "decidim.participatory_documents.admin.suggestion_notes") %></h3>
+    <button class="close-button" data-close aria-label="Close" type="button">
+      <span aria-hidden="true">&times;</span>
+    </button>
+  </div>
+  <%= decidim_form_for(notes_form,
+                       url: note_path,
+                       method: :patch,
+                       html: { class: "form edit_suggestion_note" }) do |f| %>
+    <div class="row column">
+      <%= f.text_area :body, rows: 10, label: t("modal.body", scope: "decidim.participatory_documents.admin.suggestion_notes"), value: note_body %>
+    </div>
+    <div class="button--double">
+      <%= f.submit t("modal.update", scope: "decidim.participatory_documents.admin.suggestion_notes") %>
+    </div>
+  <% end %>
+</div>

data/app/cells/decidim/participatory_documents/edit_suggestion_note_modal_cell.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    class EditSuggestionNoteModalCell < Decidim::ViewModel
+      include ActionView::Helpers::FormOptionsHelper
+      include Decidim::ParticipatoryDocuments::AdminEngine.routes.url_helpers
+
+      def show
+        @suggestion = options[:suggestion]
+        render if note
+      end
+
+      def note
+        model
+      end
+
+      def note_body
+        model.body
+      end
+
+      def modal_id
+        options[:modal_id] || "editNoteModal"
+      end
+
+      def notes_form
+        @notes_form = Decidim::ParticipatoryDocuments::Admin::SuggestionNoteForm.from_model(note)
+      end
+
+      def note_path
+        document_suggestion_suggestion_note_path(suggestion_id: @suggestion.id, id: note)
+      end
+    end
+  end
+end

data/app/cells/decidim/participatory_documents/suggestion/admin_answer.erb

@@ -0,0 +1,7 @@
+<div class="comment__footer">
+    <div class="answer__title">
+      <strong><%= answered_at %></strong>
+      <strong><%= t("suggestion_answer", scope: "decidim.participatory_documents.document") %></strong>
+    </div>
+  <%= translated_attribute(model.answer) %>
+</div>

data/app/cells/decidim/participatory_documents/suggestion/show.erb

@@ -0,0 +1,11 @@
+<div class="comment">
+  <div class="comment__content">
+    <%= author_cell %>
+    <%= suggestion_content(model)[:text] %>
+    <% if suggestion_content(model)[:file_link] %>
+      <%= suggestion_content(model)[:file_link] %>
+    <% end %>
+  </div>
+  <%= render :admin_answer if has_answer? %>
+</div>
+<hr class="suggestion__bottom-line">

data/app/cells/decidim/participatory_documents/suggestion_author/avatar.erb

@@ -0,0 +1,3 @@
+<span class="author__avatar">
+  <%= image_tag author_avatar_url %>
+</span>

data/app/cells/decidim/participatory_documents/suggestion_author/date.erb

@@ -0,0 +1 @@
+<strong><%= creation_date %></strong>

data/app/cells/decidim/participatory_documents/suggestion_author/name.erb

@@ -0,0 +1,3 @@
+<span>
+  <strong> <%= link_to decidim_sanitize(author_name), author_profile_path, class: "author__name", target: "_top" %></strong>
+</span>

data/app/cells/decidim/participatory_documents/suggestion_author/show.erb

@@ -0,0 +1,9 @@
+<div class="author__info flex--sbc">
+  <span class="author__data">
+    <%= render :avatar %>
+    <%= render :name %>
+  </span>
+  <span class="author__data_date">
+    <%= render :date %>
+  </span>
+</div>

data/app/cells/decidim/participatory_documents/suggestion_author_cell.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    class SuggestionAuthorCell < Decidim::ViewModel
+      include Decidim::SanitizeHelper
+
+      def show
+        @suggestion = options[:suggestion]
+        render
+      end
+
+      def author_avatar_url
+        model.author.avatar.attached? ? avatar_url : default_avatar_url(:thumb)
+      end
+
+      def author_name
+        model.author.name
+      end
+
+      def avatar
+        model.author.avatar.attached? ? model.author.avatar : nil
+      end
+
+      def author_profile_path
+        decidim.profile_path(model.author.nickname)
+      end
+
+      def creation_date
+        date_at = model.try(:created_at)
+
+        l date_at, format: :decidim_short
+      end
+
+      def suggestion
+        model
+      end
+
+      private
+
+      def default_avatar_url(_variant = nil)
+        ActionController::Base.helpers.asset_pack_path("media/images/default-avatar.svg")
+      end
+
+      def avatar_url
+        Rails.application.routes.url_helpers.rails_representation_path(model.author.avatar.variant(resize_to_fit: [30, 30]), only_path: true)
+      end
+    end
+  end
+end

data/app/cells/decidim/participatory_documents/suggestion_cell.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    class SuggestionCell < Decidim::ViewModel
+      include Decidim::ParticipatoryDocuments::Admin::SuggestionHelper
+      include Decidim::IconHelper
+      include Decidim::Admin::IconLinkHelper
+
+      def show
+        render
+      end
+
+      def admin_answer
+        render
+      end
+
+      def answered_at
+        return unless has_answer?
+
+        l(model.answered_at, format: :decidim_short)
+      end
+
+      def humanize_suggestion_state
+        I18n.t(model.state, scope: "decidim.participatory_documents.suggestions.answers")
+      end
+
+      def author_cell
+        cell("decidim/participatory_documents/suggestion_author", model)
+      end
+
+      protected
+
+      def has_answer?
+        return false if %w(not_answered withdrawn).include?(model.state)
+
+        model.answered? && model.answer_is_published?
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/answer_suggestion.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class AnswerSuggestion < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form, suggestion)
+          @form = form
+          @suggestion = suggestion
+        end
+
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          store_initial_suggestion_state
+
+          suggestion.assign_attributes(attributes)
+          if (%w(state answer answer_is_published) & suggestion.changed).any?
+            transaction { answer_suggestion }
+            notify_suggestion_answer
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :form, :suggestion, :initial_state
+
+        def attributes
+          {
+            state: form.state,
+            answer: form.answer,
+            answer_is_published: form.answer_is_published,
+            answered_at: %w(not_answered withdrawn).include?(form.state) ? nil : Time.current
+          }
+        end
+
+        def answer_suggestion
+          Decidim.traceability.perform_action!("answer", suggestion, form.current_user) do
+            suggestion.save!
+            suggestion
+          end
+        end
+
+        def notify_suggestion_answer
+          suggestion.reload
+          return unless suggestion.has_answer? && suggestion.answered? && suggestion.answer_is_published?
+
+          NotifySuggestionAnswer.call(suggestion, initial_state)
+        end
+
+        def store_initial_suggestion_state
+          @initial_state = suggestion.state
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/assign_suggestions_to_valuator.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class AssignSuggestionsToValuator < Decidim::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?
+
+          assign_suggestions
+          broadcast(:ok)
+        rescue ActiveRecord::RecordInvalid
+          broadcast(:invalid)
+        end
+
+        private
+
+        attr_reader :form
+
+        def assign_suggestions
+          transaction do
+            form.suggestions.flat_map do |suggestion|
+              find_assignment(suggestion) || assign_suggestion(suggestion)
+            end
+          end
+        end
+
+        def find_assignment(suggestion)
+          Decidim::ParticipatoryDocuments::ValuationAssignment.find_by(
+            suggestion: suggestion,
+            valuator_role: form.valuator_role
+          )
+        end
+
+        def assign_suggestion(suggestion)
+          Decidim.traceability.create!(
+            Decidim::ParticipatoryDocuments::ValuationAssignment,
+            form.current_user,
+            suggestion: suggestion,
+            valuator_role: form.valuator_role
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/create_document.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class CreateDocument < Decidim::Command
+        include ::Decidim::AttachmentAttributesMethods
+
+        # Public: Initializes the command.
+        #
+        # form - A form object with the params.
+        def initialize(form)
+          @form = form
+        end
+
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          begin
+            transaction do
+              create_document
+            end
+            broadcast(:ok, document)
+          rescue ActiveRecord::RecordInvalid
+            form.errors.add(:file, document.errors[:file]) if document.errors.include? :file
+            broadcast(:invalid)
+          end
+        end
+
+        private
+
+        attr_reader :form, :document
+
+        def attributes
+          {
+            component: form.current_component,
+            author: form.current_user,
+            title: form.title,
+            description: form.description,
+            box_color: form.box_color,
+            box_opacity: form.box_opacity
+          }.merge(attachment_attributes(:file))
+        end
+
+        def create_document
+          @document = Decidim.traceability.create!(
+            Decidim::ParticipatoryDocuments::Document,
+            form.current_user,
+            **attributes
+          )
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/participatory_documents/admin/create_suggestion_note.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ParticipatoryDocuments
+    module Admin
+      class CreateSuggestionNote < Decidim::Command
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        # suggestion - the suggestion to relate.
+        def initialize(form, suggestion)
+          @form = form
+          @suggestion = suggestion
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid, together with the note proposal.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          create_suggestion_note
+          # notify_admins_and_valuators
+
+          broadcast(:ok, suggestion_note)
+        end
+
+        private
+
+        attr_reader :form, :suggestion_note, :suggestion
+
+        def create_suggestion_note
+          @suggestion_note = Decidim.traceability.create!(
+            SuggestionNote,
+            form.current_user,
+            {
+              body: form.body,
+              suggestion: suggestion,
+              author: form.current_user
+            }
+          )
+        end
+      end
+    end
+  end
+end