decidim-reporting_proposals 0.2.0

data/app/controllers/concerns/decidim/reporting_proposals/needs_proposal_extra_validations_snippets.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    # Exposes the proposal resource so users can view and create them.
+    module NeedsProposalExtraValidationsSnippets
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :snippets
+      end
+
+      def snippets
+        @snippets ||= Decidim::Snippets.new
+
+        unless @snippets.any?(:reporting_proposals_js_validations)
+          @snippets.add(:reporting_proposals_js_validations, ActionController::Base.helpers.javascript_pack_tag("decidim_reporting_proposals_js_validations"))
+          @snippets.add(:reporting_proposals_js_validations, rules_tag)
+          @snippets.add(:head, @snippets.for(:reporting_proposals_js_validations))
+        end
+        @snippets
+      end
+
+      def rules_tag
+        content_tag(:script, "Decidim.ProposalRules = #{rules.to_json};".html_safe)
+      end
+
+      # caps rules are not explicitly used in the JS validations
+      def rules
+        model = Decidim::Proposals::Proposal.new(title: "title", body: "body")
+        etiquette_validator = EtiquetteValidator.new(attributes: [:title, :body])
+        etiquette_validator.validate(model)
+        {
+          genericError: I18n.t("decidim.forms.errors.error"),
+          title: {
+            caps: {
+              enabled: model.errors.details[:title].to_s.include?(":must_start_with_caps"),
+              error: I18n.t("errors.messages.must_start_with_caps")
+            }
+          },
+          body: {
+            caps: {
+              enabled: model.errors.details[:body].to_s.include?(":must_start_with_caps"),
+              error: I18n.t("errors.messages.must_start_with_caps")
+            }
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    # Exposes the proposal resource so users can view and create them.
+    module ProposalsControllerOverride
+      extend ActiveSupport::Concern
+      include NeedsProposalExtraValidationsSnippets
+
+      included do
+        helper_method :reporting_proposal?, :geocoding_comparison?
+
+        def new
+          enforce_permission_to :create, :proposal
+          @step = :step_1
+          if proposal_draft.present?
+            redirect_to edit_draft_proposal_path(proposal_draft, component_id: proposal_draft.component.id, question_slug: proposal_draft.component.participatory_space.slug)
+          else
+            @form = form(new_proposal_form).from_params(body: translated_proposal_body_template)
+          end
+        end
+
+        def create
+          enforce_permission_to :create, :proposal
+          @step = :step_1
+          @form = form(new_proposal_form).from_params(proposal_creation_params)
+
+          create_proposal_command.call(@form, current_user) do
+            on(:ok) do |proposal|
+              flash[:notice] = I18n.t("proposals.create.success", scope: "decidim")
+
+              redirect_to "#{Decidim::ResourceLocatorPresenter.new(proposal).path}/compare"
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("proposals.create.error", scope: "decidim")
+              render :new
+            end
+          end
+        end
+
+        # change comparison class if geocoding comparison is enabled
+        def compare
+          enforce_permission_to :edit, :proposal, proposal: @proposal
+          @step = :step_2
+          klass = if geocoding_comparison?
+                    Decidim::ReportingProposals::NearbyProposals
+                  else
+                    Decidim::Proposals::SimilarProposals
+                  end
+          @similar_proposals ||= klass
+                                 .for(current_component, @proposal)
+                                 .all
+
+          if @similar_proposals.blank?
+            flash[:notice] = I18n.t("proposals.proposals.compare.no_similars_found", scope: "decidim")
+            redirect_to "#{Decidim::ResourceLocatorPresenter.new(@proposal).path}/complete"
+          end
+        end
+
+        # disable this step for reporting proposals
+        def complete
+          enforce_permission_to :edit, :proposal, proposal: @proposal
+          @step = :step_3
+
+          @form = form_proposal_model
+
+          @form.attachment = form_attachment_new
+
+          redirect_to "#{Decidim::ResourceLocatorPresenter.new(@proposal).path}/preview" if reporting_proposal?
+        end
+
+        def edit_draft
+          @step = reporting_proposal? ? :step_1 : :step_3
+          enforce_permission_to :edit, :proposal, proposal: @proposal
+        end
+
+        private
+
+        def form_proposal_params
+          form(edit_proposal_form).from_params(params)
+        end
+
+        def form_proposal_model
+          form(edit_proposal_form).from_model(@proposal)
+        end
+
+        def edit_proposal_form
+          reporting_proposal? ? Decidim::ReportingProposals::ProposalForm : Decidim::Proposals::ProposalForm
+        end
+
+        def new_proposal_form
+          reporting_proposal? ? Decidim::ReportingProposals::ProposalForm : Decidim::Proposals::ProposalWizardCreateStepForm
+        end
+
+        def create_proposal_command
+          reporting_proposal? ? CreateReportingProposal : Decidim::Proposals::CreateProposal
+        end
+
+        def reporting_proposal?
+          component = current_component || @form.component
+          component.manifest_name == "reporting_proposals"
+        end
+
+        def geocoding_comparison?
+          if Decidim::Map.configured? && component_settings.geocoding_enabled? && component_settings.geocoding_comparison_enabled?
+            @proposal ? @proposal.geocoded? : true
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/reporting_proposals/admin/application_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      # Note that it inherits from `Decidim::Admin::Components::BaseController`, which
+      # override its layout and provide all kinds of useful methods.
+      class ApplicationController < Decidim::Admin::ApplicationController
+        def permission_class_chain
+          [::Decidim::ReportingProposals::Admin::Permissions] + super
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/reporting_proposals/admin/proposal_notes_controller.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      class ProposalNotesController < Admin::ApplicationController
+        helper_method :note
+
+        def edit
+          enforce_permission_to :edit_note, :proposal_note, proposal_note: note
+          @notes_form = form(Decidim::Proposals::Admin::ProposalNoteForm).from_model(note)
+        end
+
+        def update
+          enforce_permission_to :edit_note, :proposal_note, proposal_note: note
+          @notes_form = form(Decidim::Proposals::Admin::ProposalNoteForm).from_params(params)
+
+          Decidim::ReportingProposals::Admin::UpdateProposalNote.call(@notes_form, note) do
+            on(:ok) do
+              flash[:notice] = I18n.t("proposal_notes.update.success", scope: "decidim.reporting_proposals.admin")
+            end
+
+            on(:invalid) do
+              flash[:alert] = I18n.t("proposal_notes.update.invalid", scope: "decidim.reporting_proposals.admin")
+            end
+            redirect_back(fallback_location: decidim_admin.root_path)
+          end
+        end
+
+        private
+
+        def note
+          @note ||= Decidim::Proposals::ProposalNote.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/reporting_proposals/admin/proposals_controller.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      class ProposalsController < Admin::ApplicationController
+        def hide_proposal
+          enforce_permission_to :hide_proposal, :proposals, proposal: proposal
+
+          Decidim::Admin::HideResource.call(proposal, current_user) do
+            on(:ok) do
+              flash[:notice] = I18n.t("reportable.hide.success", scope: "decidim.moderations.admin")
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = I18n.t("reportable.hide.invalid", scope: "decidim.moderations.admin")
+            end
+          end
+          redirect_back(fallback_location: decidim_admin.root_path)
+        end
+
+        def add_photos
+          enforce_permission_to :edit_photos, :proposals, proposal: proposal
+
+          @photo_form = form(Decidim::ReportingProposals::Admin::ProposalPhotoForm).from_params(params)
+
+          Decidim::ReportingProposals::Admin::UpdateProposal.call(@photo_form, proposal) do
+            on(:ok) do |_proposal|
+              flash[:notice] = t("proposals.update.success", scope: "decidim")
+            end
+
+            on(:invalid) do
+              flash[:alert] = t("proposals.update.error", scope: "decidim")
+            end
+          end
+          redirect_to Decidim::ResourceLocatorPresenter.new(proposal).show
+        end
+
+        def remove_photo
+          enforce_permission_to :edit_photos, :proposals, proposal: proposal
+
+          attachment = proposal.attachments.find_by(id: params[:photo_id])
+          if attachment.try(:photo?)
+            attachment.destroy!
+            flash[:notice] = t("proposals.update.success", scope: "decidim")
+          else
+            flash[:alert] = t("proposals.update.error", scope: "decidim")
+          end
+
+          redirect_to Decidim::ResourceLocatorPresenter.new(proposal).show
+        end
+
+        private
+
+        def proposal
+          @proposal ||= Decidim::Proposals::Proposal.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/reporting_proposals/application_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    class ApplicationController < Decidim::ApplicationController
+      def permission_class_chain
+        [::Decidim::ReportingProposals::Permissions] + super
+      end
+    end
+  end
+end

data/app/controllers/decidim/reporting_proposals/geolocation_controller.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    class GeolocationController < Decidim::ReportingProposals::ApplicationController
+      # overwrite original rescue_from to ensure we print messages from ajax methods (update)
+      rescue_from Decidim::ActionForbidden, with: :ajax_user_has_no_permission
+
+      def locate
+        enforce_permission_to :locate, :geolocation
+
+        unless Decidim::Map.configured?
+          return render(json: { message: I18n.t("unconfigured", scope: "decidim.application.geocoding"), found: false }, status: :unprocessable_entity)
+        end
+
+        geocoder = Decidim::Map.utility(:geocoding, organization: current_organization)
+        address = geocoder.address([params[:latitude], params[:longitude]])
+        render json: { address: address, found: address.present? }
+      end
+
+      private
+
+      # Rescue ajax calls and print the update.js view which prints the info on the message ajax form
+      # Only if the request is AJAX, otherwise behave as Decidim standards
+      def ajax_user_has_no_permission
+        return user_has_no_permission unless request.xhr?
+
+        render json: { message: I18n.t("actions.unauthorized", scope: "decidim.core") }, status: :unprocessable_entity
+      end
+    end
+  end
+end

data/app/forms/concerns/decidim/reporting_proposals/admin/category_form_override.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      module CategoryFormOverride
+        extend ActiveSupport::Concern
+
+        included do
+          attribute :valuator_ids, Array[Integer]
+
+          def map_model(model)
+            self.valuator_ids = model.category_valuators.pluck(:valuator_role_id)
+          end
+        end
+      end
+    end
+  end
+end

data/app/forms/concerns/decidim/reporting_proposals/form_builder_override.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module FormBuilderOverride
+      extend ActiveSupport::Concern
+      include Decidim::LayoutHelper
+
+      # These methods are used in deeper levels and might not be available in this context when this is called, thus the delegation
+      delegate :asset_pack_path, to: :@template
+
+      included do
+        def file_field(object_name, method, options = {})
+          return super(object_name, method, options) unless use_camera_button?(object_name)
+
+          unless @template.snippets.any?(:reporting_proposals_camera_addons)
+            @template.snippets.add(:reporting_proposals_camera_addons, @template.javascript_pack_tag("decidim_reporting_proposals_camera"))
+            @template.snippets.add(:reporting_proposals_camera_addons, @template.stylesheet_pack_tag("decidim_reporting_proposals_camera"))
+
+            # This will display the snippets in the <head> part of the page.
+            @template.snippets.add(:head, @template.snippets.for(:reporting_proposals_camera_addons))
+          end
+
+          content_tag(:div, class: "input-group") do
+            super(object_name, method, options) +
+              content_tag(:div, class: "input-group-button") do
+                content_tag(:button, class: "button secondary user-device-camera", type: "button", data: { input: "#{object_name}_#{method}" }) do
+                  icon("camera-slr", role: "img", "aria-hidden": true) + " #{I18n.t("use_my_camera", scope: "decidim.reporting_proposals.forms")}"
+                end
+              end
+          end
+        end
+
+        private
+
+        def use_camera_button?(object_name)
+          return unless @template.respond_to?(:current_component)
+
+          return unless Decidim::ReportingProposals.use_camera_button.include?(@template.current_component.manifest_name.to_sym)
+
+          return object_name == :add_photos unless Decidim::ReportingProposals.camera_button_on_attachments
+
+          true
+        end
+      end
+    end
+  end
+end

data/app/forms/concerns/decidim/reporting_proposals/map_builder_override.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module MapBuilderOverride
+      extend ActiveSupport::Concern
+      include Decidim::LayoutHelper
+
+      # These methods are used in deeper levels and might not be available in this context when this is called, thus the delegation
+      delegate :content_tag, :asset_pack_path, to: :template
+
+      included do
+        alias_method :original_geocoding_field, :geocoding_field
+
+        def geocoding_field(object_name, method, options = {})
+          return original_geocoding_field(object_name, method, options) unless show_my_location_button?
+
+          unless template.snippets.any?(:reporting_proposals_geocoding_addons)
+            template.snippets.add(:reporting_proposals_geocoding_addons, template.javascript_pack_tag("decidim_reporting_proposals_geocoding"))
+            template.snippets.add(:reporting_proposals_geocoding_addons, template.stylesheet_pack_tag("decidim_reporting_proposals_geocoding"))
+
+            # This will display the snippets in the <head> part of the page.
+            template.snippets.add(:head, template.snippets.for(:reporting_proposals_geocoding_addons))
+          end
+
+          options[:autocomplete] ||= "off"
+          options[:class] ||= "input-group-field"
+
+          template.content_tag(:div, class: "input-group") do
+            template.text_field(
+              object_name,
+              method,
+              options.merge("data-decidim-geocoding" => view_options.to_json)
+            ) +
+              template.content_tag(:div, class: "input-group-button user-device-location") do
+                template.content_tag(:button, class: "button secondary", type: "button", data: {
+                                       input: "#{object_name}_#{method}",
+                                       latitude: "#{object_name}_latitude",
+                                       longitude: "#{object_name}_longitude",
+                                       error_no_location: I18n.t("errors.no_device_location", scope: "decidim.reporting_proposals.forms"),
+                                       error_unsupported: I18n.t("errors.device_not_supported", scope: "decidim.reporting_proposals.forms"),
+                                       url: Decidim::ReportingProposals::Engine.routes.url_helpers.locate_path
+                                     }) do
+                  icon("location", role: "img", "aria-hidden": true) + " #{I18n.t("use_my_location", scope: "decidim.reporting_proposals.forms")}"
+                end
+              end
+          end
+        end
+
+        private
+
+        def show_my_location_button?
+          return unless template.respond_to?(:current_component)
+
+          Decidim::ReportingProposals.show_my_location_button.include?(template.current_component.manifest_name.to_sym)
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/reporting_proposals/admin/proposal_photo_form.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      class ProposalPhotoForm < Decidim::Form
+        include Decidim::AttachmentAttributes
+        attribute :attachment, AttachmentForm
+        attachments_attribute :photos
+
+        validates :add_photos, presence: true
+
+        def proposal
+          @proposal ||= Decidim::Proposals::Proposal.find(id)
+        end
+
+        def current_component
+          @current_component ||= proposal&.component
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/reporting_proposals/proposal_form.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    class ProposalForm < Decidim::Proposals::ProposalForm
+      attribute :address, String
+      attribute :has_no_address, Boolean
+      attribute :has_no_image, Boolean
+
+      validates :add_photos, presence: true, if: ->(form) { form.has_camera? && form.photos.blank? }
+
+      # Set the has no address
+      def map_model(model)
+        super(model)
+
+        self.has_no_address = true if model.address.blank?
+        self.has_no_image = true if model.photo.blank?
+      end
+
+      def has_address?
+        return if has_no_address
+
+        geocoding_enabled?
+      end
+
+      def has_camera?
+        return if has_no_image
+
+        current_component.settings.attachments_allowed?
+      end
+    end
+  end
+end

data/app/helpers/concerns/decidim/reporting_proposals/admin/proposals_helper_override.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    module Admin
+      # Exposes the proposal resource so users can view and create them.
+      module ProposalsHelperOverride
+        extend ActiveSupport::Concern
+
+        included do
+          # Helpers for overdue proposals
+          include ActionView::Helpers::DateHelper
+
+          def unanswered_proposals_overdue?(proposal)
+            grace_period = days_unanswered(proposal)
+            !grace_period.zero? &&
+              proposal.state.blank? && (Time.current - grace_period.days).to_date > proposal.published_at
+          end
+
+          def evaluating_proposals_overdue?(proposal)
+            grace_period = days_evaluating(proposal)
+            !grace_period.zero? &&
+              proposal.evaluating? && proposal.answered? &&
+              (Time.current - grace_period.days).to_date > proposal.answered_at
+          end
+
+          def grace_period_unanswered?(proposal)
+            !proposal.answered? && Time.current < last_day_to_answer(proposal)
+          end
+
+          def days_unanswered(proposal)
+            return proposal.component.settings.unanswered_proposals_overdue.to_i if proposal.component&.settings
+
+            Decidim::ReportingProposals.unanswered_proposals_overdue.to_i
+          end
+
+          def days_evaluating(proposal)
+            return proposal.component.settings.evaluating_proposals_overdue.to_i if proposal.component&.settings
+
+            Decidim::ReportingProposals.evaluating_proposals_overdue.to_i
+          end
+
+          def grace_period_evaluating?(proposal)
+            proposal.evaluating? && Time.current < last_day_to_evaluate(proposal)
+          end
+
+          def last_day_to_answer(proposal)
+            (proposal.published_at + days_unanswered(proposal).days).to_date
+          end
+
+          def last_day_to_evaluate(proposal)
+            (proposal.answered_at + days_evaluating(proposal).days).to_date if proposal.answered?
+          end
+
+          def time_elapsed_to_answer(proposal)
+            distance_of_time_in_words(proposal.answered_at, proposal.created_at,
+                                      scope: "decidim.reporting_proposals.admin.time_elapsed.datetime.distance_in_words")
+          end
+        end
+      end
+    end
+  end
+end

data/app/helpers/concerns/decidim/reporting_proposals/proposal_wizard_helper_override.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Decidim
+  module ReportingProposals
+    # Exposes the proposal resource so users can view and create them.
+    module ProposalWizardHelperOverride
+      extend ActiveSupport::Concern
+
+      included do
+        def proposal_wizard_stepper(current_step)
+          steps = %(
+            #{proposal_wizard_stepper_step(:step_1, current_step)}
+            #{proposal_wizard_stepper_step(:step_2, current_step)}
+          )
+          steps = %(#{steps} #{proposal_wizard_stepper_step(:step_3, current_step)}) unless reporting_proposals_component?
+          steps = %(#{steps} #{proposal_wizard_stepper_step(:step_4, current_step)})
+
+          content_tag :ol, class: "wizard__steps" do
+            steps.html_safe
+          end
+        end
+
+        def proposal_wizard_current_step_of(step)
+          current_step_num = proposal_wizard_step_number(step)
+          current_step_num = 3 if current_step_num == 4 && reporting_proposals_component?
+          see_steps = content_tag(:span, class: "hide-for-large") do
+            concat " ("
+            concat content_tag :a, t(:"decidim.proposals.proposals.wizard_steps.see_steps"), "data-toggle": "steps"
+            concat ")"
+          end
+          content_tag :span, class: "text-small" do
+            concat t(:"decidim.proposals.proposals.wizard_steps.step_of", current_step_num: current_step_num, total_steps: total_steps)
+            concat see_steps
+          end
+        end
+
+        # rubocop:disable Rails/HelperInstanceVariable:
+        def distance(meters = nil)
+          meters = @proposal.component.settings.geocoding_comparison_radius.to_f if meters.nil?
+
+          return "#{meters.round}m" if meters < 1000
+
+          "#{(meters / 1000).round}Km"
+        end
+
+        private
+
+        def total_steps
+          reporting_proposals_component? ? 3 : 4
+        end
+
+        def reporting_proposals_component?
+          return unless @form&.component&.manifest_name
+
+          @form.component.manifest_name == "reporting_proposals"
+        end
+        # rubocop:enable Rails/HelperInstanceVariable:
+      end
+    end
+  end
+end