decidim-reporting_proposals 0.2.0

data/README.md

@@ -0,0 +1,166 @@
+# Reporting proposals component for Decidim
+
+[![[CI] Lint](https://github.com/openpoke/decidim-module-reporting-proposals/actions/workflows/lint.yml/badge.svg)](https://github.com/openpoke/decidim-module-reporting-proposals/actions/workflows/lint.yml)
+[![[CI] Test (unit)](https://github.com/openpoke/decidim-module-reporting-proposals/actions/workflows/test_unit.yml/badge.svg)](https://github.com/openpoke/decidim-module-reporting-proposals/actions/workflows/test_unit.yml)
+[![[CI] Test (integration)](https://github.com/openpoke/decidim-module-reporting-proposals/actions/workflows/test_integration.yml/badge.svg)](https://github.com/openpoke/decidim-module-reporting-proposals/actions/workflows/test_integration.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/1b469dba958dedd29046/maintainability)](https://codeclimate.com/github/openpoke/decidim-module-reporting-proposals/maintainability)
+[![codecov](https://codecov.io/gh/openpoke/decidim-module-reporting-proposals/branch/main/graph/badge.svg?token=X11YWWSMO4)](https://codecov.io/gh/openpoke/decidim-module-reporting-proposals)
+[![Gem Version](https://badge.fury.io/rb/decidim-reporting_proposals.svg)](https://badge.fury.io/rb/decidim-reporting_proposals)
+
+This module creates a new component to be used in participatory spaces that allows to create proposals orientated to manage geolocated issues in a city. For instance Damages or new ideas of improving a particular street or public good.
+
+> NOTE: in development, not ready for production.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-reporting_proposals', git: "https://github.com/openpoke/decidim-module-reporting_proposals"
+```
+
+And then execute:
+
+```
+bundle
+And then execute:
+bundle exec rails decidim_reporting_proposals:install:migrations
+```
+
+## Usage
+
+TODO...
+
+```ruby
+# config/initializers/reporting_proposals.rb
+
+Decidim::ReportingProposals.configure do |config|
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/openpoke/decidim-module-reporting_proposals.
+
+### 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
+$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bin/rails s
+```
+
+Note that `bin/rails` is a convinient wrapper around the command `cd development_app; bundle exec rails`.
+
+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.
+
+#### Webpacker notes
+
+As latests versions of Decidim, this repository uses Webpacker for Rails. This means that compilation
+of assets is required everytime a Javascript or CSS file is modified. Usually, this happens
+automatically, but in some cases (specially when actively changes that type of files) you want to 
+speed up the process. 
+
+To do that, start in a separate terminal than the one with `bin/rails s`, and BEFORE it, the following command:
+
+```
+bin/webpack-dev-server
+```
+
+#### 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)
+
+#### Non-Ruby Code Styling
+
+There are other linters for Javascript and CSS. These run using NPM packages. You can
+run the following commands:
+
+1. `npm run lint`: Runs the linter for Javascript files.
+2. `npm run lint-fix`: Automatically fix issues for Javascript files (if possible).
+3. `npm run stylelint`: Runs the linter for SCSS files.
+4. `npm run stylelint-fix`: Automatically fix issues for SCSS files (if possible).
+
+### 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-reporting_proposals
+
+## License
+
+See [LICENSE-AGPLv3.txt](LICENSE-AGPLv3.txt).

data/Rakefile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+def install_module(path)
+  Dir.chdir(path) do
+    system("bundle exec rake decidim_reporting_proposals:install:migrations")
+    system("bundle exec rake db:migrate")
+  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/reporting_proposals/edit_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.reporting_proposals.admin.proposal_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_proposal_note" }) do |f| %>
+    <div class="row column">
+      <%= f.text_area :body, rows: 10, label: t("modal.body", scope: "decidim.reporting_proposals.admin.proposal_notes"), value: note_body %>
+    </div>
+    <div class="button--double">
+      <%= f.submit t("modal.update", scope: "decidim.reporting_proposals.admin.proposal_notes") %>
+    </div>
+  <% end %>
+</div>

data/app/cells/decidim/reporting_proposals/edit_note_modal_cell.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    class EditNoteModalCell < Decidim::ViewModel
+      include ActionView::Helpers::FormOptionsHelper
+
+      def show
+        render if note
+      end
+
+      def note
+        model
+      end
+
+      def proposal
+        Decidim::Proposals::Proposal.find(model.decidim_proposal_id)
+      end
+
+      def note_body
+        model.body
+      end
+
+      def modal_id
+        options[:modal_id] || "editNoteModal"
+      end
+
+      def notes_form
+        @notes_form = Decidim::Proposals::Admin::ProposalNoteForm.from_model(note)
+      end
+
+      def note_path
+        Decidim::ReportingProposals::AdminEngine.routes.url_helpers.proposal_note_path(proposal_id: proposal.id, id: note)
+      end
+    end
+  end
+end

data/app/commands/concerns/decidim/reporting_proposals/admin/create_category_override.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      module CreateCategoryOverride
+        extend ActiveSupport::Concern
+
+        included do
+          def call
+            return broadcast(:invalid) if form.invalid?
+
+            transaction do
+              @category = create_category
+              update_valuators
+            end
+
+            broadcast(:ok)
+          end
+
+          private
+
+          def update_valuators
+            @category.participatory_space.user_roles.where(id: form.valuator_ids).each do |valuator|
+              Decidim::ReportingProposals::CategoryValuator.create!(category: @category, valuator_role: valuator)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/concerns/decidim/reporting_proposals/admin/update_category_override.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      module UpdateCategoryOverride
+        extend ActiveSupport::Concern
+
+        included do
+          def call
+            return broadcast(:invalid) if form.invalid?
+
+            transaction do
+              update_category
+              update_valuators
+            end
+            broadcast(:ok)
+          end
+
+          private
+
+          def update_valuators
+            category.category_valuators.destroy_all
+            category.participatory_space.user_roles.where(id: form.valuator_ids).each do |valuator|
+              Decidim::ReportingProposals::CategoryValuator.create!(category: category, valuator_role: valuator)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/concerns/decidim/reporting_proposals/create_report_override.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module CreateReportOverride
+      extend ActiveSupport::Concern
+
+      included do
+        def send_hide_notification_to_moderators
+          participatory_space_moderators.each do |moderator|
+            next unless moderator.email_on_moderations
+
+            ReportedMailer.hide(moderator, @report).deliver_later unless @current_user == moderator
+          end
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/reporting_proposals/admin/update_proposal.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      # A command with all the business logic when a user updates a proposal.
+      class UpdateProposal < Decidim::Proposals::Admin::UpdateProposal
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        # proposal - the proposal to update.
+        def initialize(form, proposal)
+          @form = form
+          @proposal = proposal
+          @attached_to = proposal
+        end
+
+        # Executes the command. Broadcasts these events:
+        #
+        # - :ok when everything is valid, together with the proposal.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          if process_gallery?
+            build_gallery
+            return broadcast(:invalid) if gallery_invalid?
+          end
+
+          transaction do
+            create_gallery if process_gallery?
+            photo_cleanup!
+          end
+
+          broadcast(:ok, proposal)
+        end
+
+        private
+
+        attr_reader :form, :proposal, :gallery
+      end
+    end
+  end
+end

data/app/commands/decidim/reporting_proposals/admin/update_proposal_note.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      # A command with all the business logic when a user updates a proposal note.
+      class UpdateProposalNote < Rectify::Command
+        # Public: Initializes the command.
+        #
+        # form         - A form object with the params.
+        # note - the proposal_note to update.
+        def initialize(notes_form, note)
+          @notes_form = notes_form
+          @note = note
+        end
+
+        def call
+          return broadcast(:invalid) if notes_form.invalid?
+
+          update_proposal_note
+
+          broadcast(:ok, note)
+        end
+
+        private
+
+        attr_reader :notes_form, :note, :proposal
+
+        def update_proposal_note
+          note.body = notes_form.body
+          note.save!
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/reporting_proposals/create_reporting_proposal.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    class CreateReportingProposal < Decidim::Proposals::CreateProposal
+      include ::Decidim::MultipleAttachmentsMethods
+      include ::Decidim::Proposals::GalleryMethods
+
+      def call
+        return broadcast(:invalid) if form.invalid?
+
+        if process_attachments?
+          build_attachments
+          return broadcast(:invalid) if attachments_invalid?
+        end
+
+        if process_gallery?
+          build_gallery
+          return broadcast(:invalid) if gallery_invalid?
+        end
+
+        if proposal_limit_reached?
+          form.errors.add(:base, I18n.t("decidim.proposals.new.limit_reached"))
+          return broadcast(:invalid)
+        end
+
+        transaction do
+          create_reporting_proposal
+
+          @attached_to = @proposal
+          create_gallery if process_gallery?
+          create_attachments if process_attachments?
+        end
+
+        broadcast(:ok, proposal)
+      end
+
+      def create_reporting_proposal
+        PaperTrail.request(enabled: false) do
+          @proposal = Decidim.traceability.perform_action!(
+            :create,
+            Decidim::Proposals::Proposal,
+            @current_user,
+            visibility: "public-only"
+          ) do
+            proposal = Decidim::Proposals::Proposal.new(
+              title: {
+                I18n.locale => title_with_hashtags
+              },
+              body: {
+                I18n.locale => body_with_hashtags
+              },
+              category: form.category,
+              scope: form.scope,
+              address: form.address,
+              latitude: form.latitude,
+              longitude: form.longitude,
+              component: form.component
+            )
+            proposal.add_coauthor(@current_user, user_group: user_group)
+            proposal.save!
+            proposal
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/reporting_proposals/admin/categories_controller_override.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      # Exposes the proposal resource so users can view and create them.
+      module CategoriesControllerOverride
+        extend ActiveSupport::Concern
+
+        included do
+          helper Decidim::Proposals::Admin::ProposalBulkActionsHelper
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/reporting_proposals/admin/needs_header_snippets.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      # Exposes the proposal resource so users can view and create them.
+      module NeedsHeaderSnippets
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :snippets
+        end
+
+        def snippets
+          @snippets ||= Decidim::Snippets.new
+
+          unless @snippets.any?(:reporting_proposals_manage_component) && reporting_proposals_component?
+            @snippets.add(:reporting_proposals_manage_component, ActionController::Base.helpers.stylesheet_pack_tag("decidim_reporting_proposals_manage_component_admin"))
+            @snippets.add(:head, @snippets.for(:reporting_proposals_manage_component))
+          end
+
+          unless @snippets.any?(:reporting_proposals_list_component) && any_proposals_component?
+            @snippets.add(:reporting_proposals_list_component, ActionController::Base.helpers.stylesheet_pack_tag("decidim_reporting_proposals_list_component_admin"))
+            @snippets.add(:head, @snippets.for(:reporting_proposals_list_component))
+          end
+
+          @snippets
+        end
+
+        def reporting_proposals_component?
+          current_component&.manifest_name == "reporting_proposals"
+        end
+
+        def any_proposals_component?
+          current_component&.manifest_name.in? %w(proposals reporting_proposals)
+        end
+
+        def current_component
+          @current_component ||= begin
+            if defined?(query_scope) && query_scope.respond_to?(:find)
+              query_scope.find_by(id: params[:id])
+            elsif params.has_key?(:component_id)
+              Decidim::Component.find_by(id: params[:component_id])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/reporting_proposals/admin/proposal_answer_templates_controller_override.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      # Exposes the proposal resource so users can view and create them.
+      module ProposalAnswerTemplatesControllerOverride
+        extend ActiveSupport::Concern
+
+        included do
+          def accepted_components
+            [:proposals, :reporting_proposals]
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/reporting_proposals/admin/proposal_answers_controller_override.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      # Exposes the proposal resource so users can view and create them.
+      module ProposalAnswersControllerOverride
+        extend ActiveSupport::Concern
+
+        included do
+          helper Decidim::Proposals::Admin::ProposalBulkActionsHelper
+          def update
+            enforce_permission_to :create, :proposal_answer, proposal: proposal
+
+            @notes_form = form(Decidim::Proposals::Admin::ProposalNoteForm).instance
+            @answer_form = form(Decidim::Proposals::Admin::ProposalAnswerForm).from_params(params)
+            @photo_form = form(Decidim::ReportingProposals::Admin::ProposalPhotoForm).instance
+
+            Decidim::Proposals::Admin::AnswerProposal.call(@answer_form, proposal) do
+              on(:ok) do
+                flash[:notice] = I18n.t("proposals.answer.success", scope: "decidim.proposals.admin")
+                redirect_to proposals_path
+              end
+
+              on(:invalid) do
+                flash.keep[:alert] = I18n.t("proposals.answer.invalid", scope: "decidim.proposals.admin")
+                render template: "decidim/proposals/admin/proposals/show"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/decidim/reporting_proposals/admin/proposals_controller_override.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      # Exposes the proposal resource so users can view and create them.
+      module ProposalsControllerOverride
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :reporting_proposal?, :proposals, :query, :form_presenter, :proposal, :proposal_ids
+          def show
+            @notes_form = form(Decidim::Proposals::Admin::ProposalNoteForm).instance
+            @answer_form = form(Decidim::Proposals::Admin::ProposalAnswerForm).from_model(proposal)
+            @photo_form = form(Decidim::ReportingProposals::Admin::ProposalPhotoForm).instance
+          end
+
+          private
+
+          def reporting_proposal?
+            component = current_component || @photo_form.current_component
+            component.manifest_name == "reporting_proposals"
+          end
+        end
+      end
+    end
+  end
+end