decidim-decidim_geo 0.2.1

data/app/commands/decidim/admin/update_scope.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    # A command with all the business logic when updating a scope.
+    class UpdateScope < Decidim::Geo::Command
+      # Public: Initializes the command.
+      #
+      # scope - The Scope to update
+      # form - A form object with the params.
+      def initialize(scope, form)
+        @scope = scope
+        @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) if form.invalid?
+
+        update_scope
+        broadcast(:ok)
+      end
+
+      private
+
+      attr_reader :form
+
+      def update_scope
+        Decidim.traceability.update!(
+          @scope,
+          form.current_user,
+          attributes,
+          extra: {
+            parent_name: @scope.parent.try(:name),
+            scope_type_name: form.scope_type.try(:name)
+          }
+        )
+        @scope.shapedata = shapedata
+        @scope.save!
+      end
+
+      def shapedata
+        Decidim::Geo::Shapedata.find_by_id(form.shapedata)
+      end
+
+      def attributes
+        {
+          name: form.name,
+          code: form.code,
+          scope_type: form.scope_type
+        }
+      end
+    end
+  end
+end

data/app/commands/decidim/admin/update_scope_type.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    # A command with all the business logic when updating a scope type.
+    class UpdateScopeType < Decidim::Geo::Command
+      # Public: Initializes the command.
+      #
+      # scope_type - The ScopeType to update
+      # form - A form object with the params.
+      # current_user - nil for compatibility with 0.26
+      def initialize(scope_type, form, user = nil)
+        @scope_type = scope_type
+        @form = form
+        @user = user
+      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) if form.invalid?
+
+        update_scope_type
+        broadcast(:ok)
+      end
+
+      private
+
+      attr_reader :form
+
+      def update_scope_type
+        @scope_type.shapefile = shapefile
+        @scope_type.save!
+        @scope_type.update!(attributes)
+        traceability_update
+      end
+
+      def traceability_update
+        Decidim.traceability.update!(
+          @scope_type,
+          @user,
+          attributes
+        )
+      end
+
+      def shapefile
+        Decidim::Geo::Shapefile.find_by_id(form.shapefile)
+      end
+
+      def attributes
+        {
+          name: form.name,
+          plural: form.plural
+        }
+      end
+    end
+  end
+end

data/app/commands/decidim/geo/admin/create_shapefile.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Geo
+    module Admin
+    # A command with all the business logic when a user creates a new proposal.
+      class CreateShapefile < Decidim::Geo::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, together with the shapefile.
+        # - :invalid if the form wasn't valid and we couldn't proceed.
+        #
+        # Returns nothing.
+        def call
+          return broadcast(:invalid) if form.invalid?
+
+          create_shapefile
+          load_shapefile = LoadShp::AppLoadShp.new(@shapefile)
+          load_shapefile.run!
+          broadcast(:ok, @shapefile)
+
+        rescue Exception => e
+          @shapefile.destroy
+          broadcast(:invalid, "#{e}")
+        end
+
+        private
+
+        attr_reader :form
+
+        def create_shapefile
+          @shapefile = Decidim::Geo::Shapefile.create!(
+            title: form.title,
+            description: form.description,
+            shapefile: form.shapefile,
+            organization: form.organization
+          )
+        end
+
+
+      end
+    end
+  end
+end

data/app/commands/decidim/geo/admin/update_geo_config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Geo
+    module Admin
+      # A command with all the business logic when updating a geo_config.
+      class UpdateGeoConfig < Decidim::Geo::Command
+        # Public: Initializes the command.
+        #
+        # geo_config - The geo_config to update
+        # form - A form object with the params.
+        def initialize(geo_config, form)
+          @geo_config = geo_config
+          @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) if form.invalid?
+          @geo_config.nil? ? create_geo_config : update_geo_config
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :form
+
+        def update_geo_config
+          @geo_config.update(attributes)
+        end
+
+        def create_geo_config
+          @geo_config = Decidim::Geo::GeoConfig.create!(attributes)
+        end
+
+        def attributes
+          {
+            longitude: form.longitude,
+            latitude: form.latitude,
+            zoom: form.zoom,
+            tile: form.tile,
+            only_assemblies: form.only_assemblies,
+            only_processes: form.only_processes
+          }
+        end
+      end
+    end
+  end
+end

data/app/commands/decidim/geo/command.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Geo
+    # maintains compatibility with v0.26 which uses Rectify
+    if defined? ::Decidim::Command
+      class Command < ::Decidim::Command
+      end
+    else
+      class Command < ::Rectify::Command
+      end
+    end
+  end
+end

data/app/controllers/decidim/admin/scopes_controller.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    # Controller that allows managing all scopes at the admin panel.
+    #
+    class ScopesController < Decidim::Admin::ApplicationController
+      helper_method :scope, :parent_scope, :add_scope_path, :current_scopes_path
+      layout "decidim/admin/settings"
+
+      def index
+        enforce_permission_to :read, :scope
+        field = Arel::Nodes::InfixOperation.new("->", Decidim::Scope.arel_table[:name], Arel::Nodes.build_quoted(I18n.locale))
+        @scopes = children_scopes.order(Arel::Nodes::InfixOperation.new("", field, Arel.sql("ASC")))
+      end
+
+      def new
+        enforce_permission_to :create, :scope
+        @form = form(ScopeForm).instance
+      end
+
+      def create
+        enforce_permission_to :create, :scope
+        @form = form(ScopeForm).from_params(params)
+        CreateScope.call(@form, parent_scope) do
+          on(:ok) do |scope|
+            flash[:notice] = I18n.t("scopes.create.success", scope: "decidim.admin")
+            if has_geo_scope_type? && !has_shapedata?
+              redirect_to Decidim::Admin::Engine.routes.url_helpers.edit_scope_path(scope[:scope])
+            else
+              redirect_to current_scopes_path
+            end
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("scopes.create.error", scope: "decidim.admin")
+            render :new
+          end
+        end
+      end
+
+      def edit
+        enforce_permission_to :update, :scope, scope: scope
+        @form = form(ScopeForm).from_model(scope)
+      end
+
+      def update
+        enforce_permission_to :update, :scope, scope: scope
+        @form = form(ScopeForm).from_params(params)
+
+        UpdateScope.call(scope, @form) do
+          on(:ok) do
+            flash[:notice] = I18n.t("scopes.update.success", scope: "decidim.admin")
+            redirect_to current_scopes_path
+          end
+
+          on(:invalid) do
+            flash.now[:alert] = I18n.t("scopes.update.error", scope: "decidim.admin")
+            render :edit
+          end
+        end
+      end
+
+      def destroy
+        enforce_permission_to :destroy, :scope, scope: scope
+
+        DestroyScope.call(scope, current_user) do
+          on(:ok) do
+            flash[:notice] = I18n.t("scopes.destroy.success", scope: "decidim.admin")
+            redirect_to current_scopes_path
+          end
+        end
+      end
+
+      private
+
+      def organization_scopes
+        current_organization.scopes
+      end
+
+      def parent_scope
+        return @parent_scope if defined?(@parent_scope)
+
+        @parent_scope = scope ? scope.parent : organization_scopes.find_by(id: params[:scope_id])
+      end
+
+      def scope
+        return @scope if defined?(@scope)
+
+        @scope = organization_scopes.find_by(id: params[:id])
+      end
+
+      def children_scopes
+        @children_scopes ||= parent_scope ? parent_scope.children : organization_scopes.top_level
+      end
+
+      def current_scopes_path
+        if parent_scope
+          scope_scopes_path(parent_scope)
+        else
+          scopes_path
+        end
+      end
+
+      def has_geo_scope_type?
+        @form.scope_type.present?
+      end
+
+      def has_shapedata?
+        @form.shapedata.present?
+      end
+    end
+  end
+end
+  

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

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

data/app/controllers/decidim/geo/admin/geo_configs_controller.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Geo
+    module Admin
+      class GeoConfigsController < Decidim::Geo::Admin::ApplicationController
+        layout "decidim/decidim_geo/admin/application"
+
+        before_action :authenticate_user!
+        
+        def index
+          @form = form(Decidim::Geo::Admin::GeoConfigForm).from_model(geo_config_default)
+        end
+
+        def create
+          update
+        end
+
+        def update
+          @form = form(Decidim::Geo::Admin::GeoConfigForm).from_params(params)
+
+          Admin::UpdateGeoConfig.call(geo_config_default, @form) do
+            on(:ok) do
+              flash[:notice] = I18n.t("geo_configs.actions.update.success", scope: "decidim.geo.admin")
+            end
+
+            on(:invalid) do
+              flash.now[:alert] = @form.errors.full_messages_for(:base).join(',')
+            end
+
+            render action: "index"
+          end
+        end
+
+        private
+
+        def geo_config_default
+          Decidim::Geo::GeoConfig.geo_config_default
+        end
+
+      end
+    end
+  end
+end

data/app/controllers/decidim/geo/admin/shapefiles_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Geo
+    module Admin
+      class ShapefilesController < ApplicationController
+        layout "decidim/decidim_geo/admin/application"
+        before_action :authenticate_user!
+        
+        def index
+          #enforce_permission_to :list
+          @shapefiles = Decidim::Geo::Shapefile.all
+        end
+
+        def new
+          enforce_permission_to :new, :shapefile
+          @form = Decidim::Geo::Admin::ShapefileForm.new
+        end
+
+        def create
+          enforce_permission_to :create, :shapefile
+          @form = form(Decidim::Geo::Admin::ShapefileForm).from_params(params)
+
+          return Admin::CreateShapefile.call(@form) do
+            on(:invalid) do |message|
+              flash.now[:alert] = message || @form.errors.full_messages.join(',') || "Can not upload this shapefile"
+              render action: "new"
+            end
+
+            on(:ok) do
+              flash[:notice] = I18n.t("shapefiles.actions.create.success", scope: "decidim.geo.admin")
+              redirect_to shapefiles_path
+            end
+
+  
+          end
+        end
+      end
+    end
+  end
+end

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

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

data/app/controllers/decidim/geo/shapefile_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Geo
+    class ShapefileController < Decidim::Geo::ApplicationController
+      def index
+
+      end
+    end
+  end
+end

data/app/forms/decidim/admin/scope_form.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    # A form object to create or update scopes.
+    class ScopeForm < Form
+      include TranslatableAttributes
+
+      translatable_attribute :name, String
+      attribute :organization, Decidim::Organization
+      attribute :code, String
+      attribute :parent_id, Integer
+      attribute :scope_type_id, Integer
+
+      attribute :shapedata, Decidim::Geo::Shapedata
+
+      mimic :scope
+
+      validates :name, translatable_presence: true
+      validates :organization, :code, presence: true
+      validate :code, :code_uniqueness
+
+      alias organization current_organization
+
+      def scope_type
+        Decidim::ScopeType.find_by(id: scope_type_id) if scope_type_id
+      end
+
+      def map_model(model)
+        self.shapedata = model.shapedata.id unless model.shapedata.nil?
+      end
+
+      private
+
+      def code_uniqueness
+        return unless organization
+        return unless organization.scopes.where(code: code).where.not(id: id).any?
+
+        errors.add(:code, :taken)
+      end
+    end
+  end
+end

data/app/forms/decidim/admin/scope_type_form.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    # A form object to create or update scopes.
+    class ScopeTypeForm < Form
+      include TranslatableAttributes
+
+      translatable_attribute :name, String
+      translatable_attribute :plural, String
+      attribute :organization, Decidim::Organization
+
+      attribute :shapefile, Decidim::Geo::Shapefile
+
+      mimic :scope_type
+
+      validates :name, :plural, translatable_presence: true
+      validates :organization, presence: true
+
+      alias organization current_organization
+
+      def map_model(model)
+        self.shapefile = model.shapefile.id unless model.shapefile.nil?
+      end
+    end
+  end
+end

data/app/forms/decidim/geo/admin/geo_config_form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Geo
+    module Admin
+      # A form object to be used when admin configure default .
+      class GeoConfigForm < Form
+   
+        attribute :longitude, Float
+        attribute :latitude, Float
+        attribute :zoom, Integer
+        attribute :tile, String
+        attribute :only_assemblies, Boolean
+        attribute :only_processes, Boolean
+
+        alias organization current_organization
+      end
+    end
+  end
+end

data/app/forms/decidim/geo/admin/shapefile_form.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Geo
+    module Admin
+      # A form object to be used when admin users want to upload a shapefile.
+      class ShapefileForm < Form
+        include Decidim::HasUploadValidations
+   
+        attribute :title, String
+        attribute :description, String
+        attribute :shapefile
+
+        validates :title, :description, :presence => true
+        validates :shapefile, passthru: { to: Decidim::Geo::Shapefile }, if: ->(form) { form.shapefile.present? }
+
+        validates_upload :shapefile, uploader: Decidim::Geo::ShapefileUploader
+
+        alias organization current_organization
+      end
+    end
+  end
+end

data/app/helpers/decidim/admin/scopes_helper.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Admin
+    # This module includes helpers to show scopes in admin
+    module ScopesHelper
+      Option = Struct.new(:id, :name)
+
+      # Public: This helper shows the path to the given scope, linking each ancestor.
+      #
+      # current_scope - Scope object to show
+      #
+      def scope_breadcrumbs(current_scope)
+        current_scope.part_of_scopes.map do |scope|
+          if scope == current_scope
+            translated_attribute(scope.name)
+          else
+            link_to translated_attribute(scope.name), scope_scopes_path(scope)
+          end
+        end
+      end
+
+      # Public: A formatted collection of scopes for a given organization to be used
+      # in forms.
+      #
+      # organization - Organization object
+      #
+      # Returns an Array.
+      def organization_scope_types(organization = current_organization)
+        [Option.new("", "-")] +
+          organization.scope_types.map do |scope_type|
+            Option.new(scope_type.id, translated_attribute(scope_type.name))
+          end
+      end
+
+      def organization_scope_depths(organization = current_organization)
+        organization.scope_types.map do |scope_type|
+          Option.new(scope_type.id, translated_attribute(scope_type.name))
+        end.reverse
+      end
+
+      def shapedata_scope(scope)
+        return nil if scope.scope_type.shapefile.nil?
+
+        shapefile = scope.scope_type.shapefile
+        shapedata = shapedata_version_compat(shapefile)
+        
+        shapedata.map do |shp|
+          Option.new(shp.id, shp.data)
+        end
+      end
+
+      def shapedata_name(scope)
+        Decidim::Geo::Shapedata
+          .select("data['NAME']")
+          .find_by_id(scope.shapedata.id).data
+      end
+
+      private
+
+      def shapedata_version_compat(shapefile)
+        return Decidim::Geo::Shapedata
+                .select("id", "data['NAME']")
+                .where(decidim_geo_shapefiles_id: shapefile.id).order(:data.name) if Decidim.version.to_f >= 0.27
+        
+        Decidim::Geo::Shapedata
+          .select("id", "data['NAME']")
+          .where(decidim_geo_shapefiles_id: shapefile.id).order("data['NAME'] ASC")
+      end
+    end
+  end
+end

data/app/jobs/decidim/geo/shp2pgsql_job.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Geo
+    class Shp2pgsqlJob < ApplicationJob
+      queue_as :shapefile_loader
+
+      def perform(shapefile)
+        load_shapefile = LoadShp::AppLoadShp.new(shapefile)
+        load_shapefile.run!
+      end
+    end
+  end
+end