decidim-navigation_maps 1.0.1

data/app/commands/decidim/navigation_maps/save_area.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    # This command creates or updates areas for a blueprints
+    class SaveArea < Rectify::Command
+      # Creates or updates an area for a blueprint.
+      #
+      # form - The form with the data.
+      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, form.errors.full_messages.join(", ")) if form.invalid?
+
+        initialize_area
+        update_area
+        save_area!
+
+        broadcast(:ok, @area)
+      end
+
+      private
+
+      attr_reader :form, :current_blueprint
+
+      def initialize_area
+        @area = BlueprintArea.find_or_initialize_by(area_id: form.area_id, blueprint: @form.context.current_blueprint)
+      end
+
+      def update_area
+        @area.link_type = link_type
+        @area.link = form.link
+        @area.title = form.title unless form.no_popup
+        @area.description = form.description unless form.no_popup
+        @area.color = form.color
+        @area.area_id = form.area_id if form.area_id
+        @area.area = form.area if form.area
+        @area.area_type = form.area_type if form.area_type
+      end
+
+      def save_area!
+        @area.save!
+      end
+
+      def link_type
+        form.no_popup ? "direct" : "link"
+      end
+    end
+  end
+end

data/app/commands/decidim/navigation_maps/save_blueprints.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    # This command creates or updates the blueprints for the organization.
+    class SaveBlueprints < Rectify::Command
+      # Creates a blueprint.
+      #
+      # forms - The form with the data.
+      def initialize(forms)
+        @forms = forms
+        @blueprints = forms.blueprints || {}
+      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
+        @blueprints.each do |form|
+          next if form.invalid?
+
+          initialize_blueprint(form)
+          if form.remove
+            destroy_blueprint!(form)
+          else
+            create_areas(form.blueprint) if form.blueprint
+            destroy_areas_except(form.blueprint.keys) if form.blueprint
+            update_blueprint!(form)
+          end
+        end
+
+        broadcast(:ok)
+      end
+
+      private
+
+      attr_reader :forms
+
+      def initialize_blueprint(form)
+        @blueprint = Blueprint.find_or_initialize_by(id: form.id) do |blueprint|
+          blueprint.organization = @forms.current_organization
+        end
+      end
+
+      def update_blueprint!(form)
+        @blueprint.image = form.image if form.image.present?
+        @blueprint.title = form.title
+        @blueprint.description = form.description
+        @blueprint.save!
+      end
+
+      def destroy_blueprint!(form)
+        @blueprint.destroy! if form.id
+      end
+
+      def destroy_areas_except(except)
+        @blueprint.areas.where.not(area_id: except).destroy_all
+      end
+
+      def create_areas(blueprint)
+        blueprint.each do |key, area|
+          a = BlueprintArea.find_or_initialize_by(area_id: key, blueprint: @blueprint)
+          a.area = area[:geometry]
+          a.area_type = area[:type]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    module Admin
+      # This controller is the abstract class from which all other controllers of
+      # this engine inherit.
+      #
+      class ApplicationController < ::Decidim::Admin::ApplicationController
+      end
+    end
+  end
+end

data/app/controllers/decidim/navigation_maps/admin/areas_controller.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    module Admin
+      class AreasController < ::Decidim::NavigationMaps::Admin::ApplicationController
+        layout false
+        helper_method :link_suggestions
+
+        before_action do
+          enforce_permission_to :update, :organization, organization: current_organization
+        end
+
+        def index
+          render json: blueprint.areas
+        end
+
+        def new
+          @form = form(AreaForm).instance(current_blueprint: blueprint)
+        end
+
+        def create
+          parse_areas
+          @form = form(AreaForm).from_params(params, current_blueprint: blueprint)
+
+          SaveArea.call(@form) do
+            on(:ok) do |area|
+              render json: { message: I18n.t("navigation_maps.admin.areas.create.success", scope: "decidim"),
+                             area_id: area.area_id,
+                             blueprint_id: area.blueprint.id,
+                             area: area.to_geoson }
+            end
+
+            on(:invalid) do |message|
+              render json: { message: I18n.t("navigation_maps.admin.areas.create.error", scope: "decidim"), error: message }, status: :unprocessable_entity
+            end
+          end
+        end
+
+        def show
+          @form = form(AreaForm).from_model(area)
+        end
+
+        def update
+          @form = form(AreaForm).from_params(params, current_blueprint: blueprint)
+          SaveArea.call(@form) do
+            on(:ok) do |area|
+              render json: { message: I18n.t("navigation_maps.admin.areas.update.success", scope: "decidim"),
+                             area_id: area.area_id,
+                             blueprint_id: area.blueprint.id,
+                             area: area.to_geoson }
+            end
+
+            on(:invalid) do |message|
+              render json: { message: I18n.t("navigation_maps.admin.areas.update.error", scope: "decidim"), error: message }, status: :unprocessable_entity
+            end
+          end
+        end
+
+        private
+
+        def link_suggestions
+          return if blueprints_count.zero?
+
+          maps = blueprints_count.times.collect do |n|
+            "<a href=\"#map#{n}\">#map#{n}</a>"
+          end
+          t("link_suggestions", scope: "decidim.navigation_maps.admin.areas.show", map: maps.join(",")).html_safe
+        end
+
+        def parse_areas
+          return unless params[:blueprint_area]
+          return if params[:blueprint_area][:area].blank?
+
+          feature = JSON.parse params[:blueprint_area][:area]
+          params[:blueprint_area][:area] = feature["geometry"] if feature["geometry"]
+          params[:blueprint_area][:area_type] = feature["type"] if feature["type"]
+        end
+
+        def blueprint
+          @blueprint ||= Blueprint.find(params[:blueprint_id])
+        end
+
+        def area
+          @area ||= BlueprintArea.find_by(area_id: params[:area_id], blueprint: blueprint)
+        end
+
+        def blueprints_count
+          @blueprints_count ||= Blueprint.where(organization: current_organization).count
+        end
+      end
+    end
+  end
+end

data/app/controllers/decidim/navigation_maps/admin/blueprints_controller.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    module Admin
+      class BlueprintsController < ::Decidim::NavigationMaps::Admin::ApplicationController
+        before_action do
+          enforce_permission_to :update, :organization, organization: current_organization
+        end
+
+        def index
+          render json: organization_blueprints
+        end
+
+        def show
+          render json: organization_blueprints.find(params[:id])
+        end
+
+        def create
+          save_settings
+          parse_blueprints
+          @form = form(BlueprintForms).from_params(params).with_context(current_organization: current_organization)
+          SaveBlueprints.call(@form) do
+            on(:ok) do
+              render plain: I18n.t("navigation_maps.create.success", scope: "decidim")
+            end
+
+            on(:invalid) do
+              render plain: I18n.t("navigation_maps.create.error", scope: "decidim"), status: :unprocessable_entity
+            end
+          end
+        end
+
+        private
+
+        # Manually save original settings if the settings array is present
+        def save_settings
+          return unless params[:content_block]
+          return unless params[:content_block][:settings]
+
+          @form = form(Decidim::Admin::ContentBlockForm).from_params(params)
+          Decidim::Admin::UpdateContentBlock.call(@form, content_block, :homepage)
+        end
+
+        def content_block
+          @content_block ||= Decidim::ContentBlock.for_scope(:homepage, organization: current_organization).find_by(manifest_name: :navigation_map)
+        end
+
+        # Convert blueprint data to an object
+        def parse_blueprints
+          return unless params[:blueprints]
+
+          params[:blueprints].each do |_key, data|
+            data[:blueprint] = JSON.parse data[:blueprint] if data[:blueprint].present?
+          end
+        end
+
+        def organization_blueprints
+          @organization_blueprints ||= OrganizationBlueprints.new(current_organization).query
+        end
+      end
+    end
+  end
+end

data/app/forms/decidim/navigation_maps/area_form.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    # A form object used to configure the blueprint content block from the admin panel.
+    #
+    class AreaForm < Decidim::Form
+      include TranslatableAttributes
+
+      mimic :blueprint_area
+
+      attribute :area, Object
+      attribute :area_type, String
+      attribute :area_id, String
+      attribute :link, String
+      attribute :link_type, String
+      attribute :no_popup, String
+      attribute :color, String
+      translatable_attribute :title, String
+      translatable_attribute :description, String
+
+      def no_popup
+        return link_type == "direct" unless super
+
+        super.to_i.nonzero?
+      end
+
+      def color
+        return "#2262cc" if super.blank?
+
+        return "#" + super unless super.match?(/^#/)
+
+        super
+      end
+    end
+  end
+end

data/app/forms/decidim/navigation_maps/blueprint_form.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    # A form object used to configure the blueprint content block from the admin panel.
+    #
+    class BlueprintForm < Decidim::Form
+      include TranslatableAttributes
+
+      mimic :blueprint
+
+      attribute :blueprint, Object
+      attribute :id, Integer
+      attribute :remove, Boolean
+      attribute :image
+      translatable_attribute :title, String
+      translatable_attribute :description, String
+
+      # validate :check_image_or_blueprint
+      validates :title, translatable_presence: true
+
+      # def check_image_or_blueprint
+      #   return if image.present? || blueprint.present?
+
+      #   errors.add(:image, "no image") unless image.present?
+      #   errors.add(:blueprint, "no blueprint") unless blueprint.present?
+      # end
+
+      def ident
+        id || "_"
+      end
+
+      def image?
+        return unless image && image.respond_to?(:url)
+        return image.content_type.start_with? "image" if image.content_type.present?
+      end
+    end
+  end
+end

data/app/forms/decidim/navigation_maps/blueprint_forms.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    class BlueprintForms < Decidim::Form
+      attribute :blueprints, Array[BlueprintForm]
+    end
+  end
+end

data/app/models/decidim/navigation_maps/application_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    # Abstract class from which all models in this engine inherit.
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/decidim/navigation_maps/blueprint.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    # Abstract class from which all models in this engine inherit.
+    class Blueprint < ApplicationRecord
+      self.table_name = "decidim_navigation_maps_blueprints"
+
+      belongs_to :organization, foreign_key: :decidim_organization_id, class_name: "Decidim::Organization"
+      has_many :areas,
+               foreign_key: "decidim_navigation_maps_blueprint_id",
+               class_name: "Decidim::NavigationMaps::BlueprintArea",
+               dependent: :destroy
+
+      validates :organization, presence: true
+      validates :image,
+                file_size: { less_than_or_equal_to: ->(_record) { Decidim.maximum_attachment_size } },
+                file_content_type: { allow: ["image/jpeg", "image/png", "image/svg+xml"] }
+
+      mount_uploader :image, Decidim::NavigationMaps::BlueprintUploader
+
+      def blueprint
+        areas.map { |area| [area.area_id.to_s, area.to_geoson] }.to_h
+      end
+    end
+  end
+end

data/app/models/decidim/navigation_maps/blueprint_area.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    # Abstract class from which all models in this engine inherit.
+    class BlueprintArea < ApplicationRecord
+      include Decidim::TranslatableAttributes
+
+      self.table_name = "decidim_navigation_maps_blueprint_areas"
+
+      belongs_to :blueprint, foreign_key: :decidim_navigation_maps_blueprint_id, class_name: "Decidim::NavigationMaps::Blueprint"
+
+      attribute :link_type, :string, default: "link"
+
+      validates :blueprint, presence: true
+
+      def to_geoson
+        {
+          type: area_type,
+          geometry: area,
+          properties: {
+            link: link,
+            popup: link_type == "direct",
+            color: color,
+            title: translated_attribute(title),
+            description: translated_attribute(description)
+          }
+        }
+      end
+    end
+  end
+end