decidim-navigation_maps 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3095b1ee4ac0d8128711b37b7a59bcc5eb0b42d4ffebfb0021bcc1b549c80dab
-  data.tar.gz: 468c412868fb61196861df0aeceef155551d8f83e4d58dc556778ecbd2ebed2e
+  metadata.gz: 555b93edb92b69f19e3cc10841179b04fb57502a13d347fe69132d01833f88d6
+  data.tar.gz: 76da0880561f5e1e5b1201a048d90c8a862194134f3e485c1d2d045401f61551
 SHA512:
-  metadata.gz: b440bff8af84241131b5e5c11c0b8567d1667a379d1156ca0d3b49c96992366ec304bc394aa8e7382efd38b05d22908471cdf98daf1a181c6b6de436d13abe9b
-  data.tar.gz: af9064b540070fe4cb45b242a2445d8170f7bfda68457fc4ad5a3eae917d0254afc55c9241c30278bad64115783357c2cbdc645ec97289b5a95380373d42c71f
+  metadata.gz: d90681644ff2111df383e19b5e7e7568c97cc225aad75645dcd86369332e91d4ef0d0fcc0ea6413c7bcb83bab0239333fb926958d8a32e62df5e2b52bd7353d1
+  data.tar.gz: bbc246049572a74e697a0382bd084213cdff071149ea1c2ef1a93eae78da2d1ceeba110b394c16c9877b5c88ecd96fca0c674b1f72193b7b86b993a5707c6daf

data/README.md

@@ -4,9 +4,9 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/f69b2b0ab0ffcd26f002/maintainability)](https://codeclimate.com/github/Platoniq/decidim-module-navigation_maps/maintainability)
 [![Codecov](https://codecov.io/gh/Platoniq/decidim-module-navigation_maps/branch/master/graph/badge.svg?token=XhzWO0IiWt)](https://codecov.io/gh/Platoniq/decidim-module-navigation_maps)
 
-Allows to map processes to image parts using maps.
+This module allows admins to upload any arbitrary image and draw sensible zones over it with direct links to other places (ie: a specific participatory process) or display a popup explaining something.
 
-> NOTE: This module is ready to use but in Beta status. Feel free to report any bug!
+Maps can be displayed in the homepage or as part of a process group landing.
 
 ## Usage
 
@@ -24,23 +24,43 @@ homepage only).
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "decidim-navigation_maps", "~> 1.1.0"
+gem "decidim-navigation_maps"
 ```
 
-And then execute:
+And then execute (remember to repeat this if you are upgrading from version 1.1):
 
 ```bash
 bundle
 bundle exec rails decidim_navigation_maps:install:migrations
+bundle exec rails decidim_navigation_maps:webpacker:install
 bundle exec rails db:migrate
 ```
 
+> NOTE: the `decidim_notify:webpacker:install` is only necessary for Decidim versions starting at 0.25.
+
+If you are upgrading from a version prior to 1.3, make sure that you migrate your existing images to Active Storae:
+
+```
+RAILS_ENV=production bin/rails navigation_maps:active_storage_migrations:migrate_from_carrierwave
+```
+
+Or check your migration status with:
+```
+RAILS_ENV=production bin/rails navigation_maps:active_storage_migrations:check_migration_from_carrierwave
+```
+
+The correct version of Navigation Maps should resolved automatically by the Bundler.
+However you can force some specific version using `gem "decidim-navigation_maps", "~> 1.3.0"` in the Gemfile.
+
+
 Depending on your Decidim version, choose the corresponding Plugin version to ensure compatibility:
 
 | Navigation Maps version | Compatible Decidim versions |
 |---|---|
-| 1.0.x | 0.18.x - 0.21.x |
+| 1.3.x | 0.25.x, 0.26.x |
+| 1.2.x | 0.24.x |
 | 1.1.x | 0.22.x, 0.23.x |
+| 1.0.x | 0.18.x - 0.21.x |
 
 ## Contributing
 
@@ -134,6 +154,13 @@ 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/translate/decidim-module-navigation_maps
+
 ## License
 
 This engine is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE.

data/Rakefile

@@ -9,16 +9,29 @@ def install_module(path)
   end
 end
 
+def override_webpacker_config_files(path)
+  Dir.chdir(path) do
+    system("bundle exec rake decidim_navigation_maps:webpacker:install")
+  end
+end
+
 def seed_db(path)
   Dir.chdir(path) do
     system("bundle exec rake db:seed")
   end
 end
 
+def seed_module_db(path)
+  Dir.chdir(path) do
+    system("bundle exec rake decidim_navigation_maps: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")
+  override_webpacker_config_files("spec/decidim_dummy_app")
 end
 
 desc "Generates a development app"
@@ -36,5 +49,10 @@ task :development_app do
   end
 
   install_module("development_app")
+  override_webpacker_config_files("development_app")
+  ENV["SKIP_MODULE_SEEDS"] = "1"
   seed_db("development_app")
+  # manually seed navigation maps to ensure participatory process groups are created
+  ENV.delete "SKIP_MODULE_SEEDS"
+  seed_module_db("development_app")
 end

data/app/cells/decidim/navigation_maps/content_blocks/groups_navigation_map_cell.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    module ContentBlocks
+      class GroupsNavigationMapCell < NavigationMapCell
+        def section_classes
+          "section"
+        end
+
+        def wrapper_classes
+          nil
+        end
+
+        def row_classes
+          "row column"
+        end
+      end
+    end
+  end
+end

data/app/cells/decidim/navigation_maps/content_blocks/navigation_map/_tabs_content.erb

@@ -2,7 +2,7 @@
 <div class="tabs-content admin" data-tabs-content="navigation_maps-tabs">
   <% tabs.each_with_index do |item, index| %>
     <div class="tabs-panel<%= " is-active" if index.zero? %>" id="map<%= index %>">
-      <%= content_tag(:div, "", id: "navigation_maps-map-#{item.id}", class: "map", style: "height: #{item.height}px", data: { id: item.id, image: item.image.url, blueprint: item.blueprint }) %>
+      <%= content_tag(:div, "", id: "navigation_maps-map-#{item.id}", class: "map", style: "height: #{item.height}px", data: { id: item.id, image: image_path(item.image), blueprint: item.blueprint }) %>
     </div>
   <% end %>
 </div>

data/app/cells/decidim/navigation_maps/content_blocks/navigation_map/show.erb

@@ -1,16 +1,16 @@
-<%= stylesheet_link_tag "decidim/navigation_maps/navigation_maps" %>
+<%= stylesheet_pack_tag "decidim_navigation_maps" %>
 <%= render partial: "styles", locals: { blueprints: valid_blueprints } %>
 
-<section class="extended home-section">
-  <div class="wrapper-home">
-    <div class="row column text-center">
+<section<%= class_tag(section_classes) %>>
+  <div<%= class_tag(wrapper_classes) %>>
+    <div<%= class_tag(row_classes) %>>
 
       <% if translated_title.present? %>
         <h3 class="heading3"><%= decidim_sanitize translated_title %></h3>
       <% end %>
 
       <div class="navigation_maps">
-        <%= render partial: "tabs", locals: { tabs: valid_blueprints } %>
+        <%= tabs %>
         <%= render partial: "tabs_content", locals: { tabs: valid_blueprints } %>
       </div>
     </div>
@@ -18,4 +18,4 @@
 </section>
 
 <%= render partial: "template" %>
-<%= javascript_include_tag "decidim/navigation_maps/navigation_maps" %>
+<%= javascript_pack_tag "decidim_navigation_maps" %>

data/app/cells/decidim/navigation_maps/content_blocks/navigation_map_cell.rb

@@ -7,15 +7,46 @@ module Decidim
         include NavigationMaps::NavigationMapCellHelpers
         include Decidim::SanitizeHelper
 
+        alias content_block model
+
         view_paths << "#{Decidim::NavigationMaps::Engine.root}/app/cells/decidim/navigation_maps/content_blocks/navigation_map"
 
         def show
           render if valid_blueprints?
         end
 
+        def tabs
+          return if model.settings.autohide_tabs? && valid_blueprints.count < 2
+
+          render partial: "tabs", locals: { tabs: valid_blueprints }
+        end
+
         def translated_title
           translated_attribute(model.settings.title)
         end
+
+        def section_classes
+          "extended home-section"
+        end
+
+        def wrapper_classes
+          "wrapper-home"
+        end
+
+        def row_classes
+          "row column text-center"
+        end
+
+        def class_tag(class_string)
+          return if class_string.blank?
+
+          " class=\"#{class_string}\""
+        end
+
+        def image_path(image, options = {})
+          options.merge!({ only_path: true })
+          Rails.application.routes.url_helpers.rails_blob_url(image, options)
+        end
       end
     end
   end

data/app/cells/decidim/navigation_maps/content_blocks/navigation_map_settings_form/_form.erb

@@ -1,5 +1,5 @@
 <ul class="accordion" data-accordion>
-  <li class="accordion-item<%= " is-active" unless form.image? %>" data-accordion-item>
+  <li class="accordion-item<%= " is-active" unless image?(form) %>" data-accordion-item>
     <a href="#" class="accordion-title"><%= t("navigation_map_settings_form.info", scope: "decidim.navigation_maps.content_blocks") %></a>
 
     <div class="accordion-content" data-tab-content>
@@ -9,7 +9,7 @@
 
       <%= label_tag t("navigation_map_settings_form.blueprint_image", scope: "decidim.navigation_maps.content_blocks") %>
       <div class="thumbnail">
-        <%= image_tag form.image.thumbnail.url if form.image? %>
+        <%= image_tag image_path(form.image, variant: :thumbnail) if image?(form) %>
       </div>
       <%= file_field_tag "blueprints[#{form.ident}][image]", { id: "blueprints_#{form.ident}_image", label: t("navigation_map_settings_form.title", scope: "decidim.navigation_maps.content_blocks") } %>
 
@@ -25,12 +25,12 @@
   </div>
   </li>
 
-  <% if form.image? %>
+  <% if image?(form) %>
   <li class="accordion-item is-active" data-accordion-item>
     <a href="#" class="accordion-title"><%= t("navigation_map_settings_form.editor", scope: "decidim.navigation_maps.content_blocks") %></a>
     <div class="accordion-content navigation_maps-content" data-tab-content>
 
-      <%= content_tag(:div, "", id: "navigation_maps-map-#{form.ident}", class: "map", data: { id: form.ident, image: form.image.url, blueprint: form.blueprint }) %>
+      <%= content_tag(:div, "", id: "navigation_maps-map-#{form.ident}", class: "map", data: { id: form.ident, image: image_path(form.image), blueprint: form.blueprint }) %>
 
     </div>
   </li>

data/app/cells/decidim/navigation_maps/content_blocks/navigation_map_settings_form/_tabs_content.erb

@@ -1,4 +1,3 @@
-
 <div class="tabs-content" data-tabs-content="navigation_maps-tabs">
   <% tabs.each_with_index do |item, index| %>
     <div class="tabs-panel<%= " is-active" if index.zero? %>" id="map<%= index %>">

data/app/cells/decidim/navigation_maps/content_blocks/navigation_map_settings_form/show.erb

@@ -1,11 +1,13 @@
 <!-- Original settings -->
 <% form.fields_for :settings, form.object.settings do |settings_fields| %>
-  <%= settings_fields.translated :text_field, :title %>
+  <%= settings_fields.translated :text_field, :title, label: t("content_blocks.navigation_map_settings_form.title", scope: "decidim.navigation_maps") %>
+  <%= settings_fields.check_box :autohide_tabs, label: t("content_blocks.navigation_map_settings_form.autohide_tabs", scope: "decidim.navigation_maps") %>
 <% end %>
 
 <!-- Override rails default patch (using post via ajax) -->
 <%= hidden_field_tag :_method, "post" %>
 <%= hidden_field_tag :action, blueprints_path %>
+<%= hidden_field_tag :content_block_id, content_block.id %>
 
 <div class="navigation_maps admin">
   <div class="callout" style="display:none" data-closable>
@@ -31,6 +33,7 @@
 </div>
 
 <%= render partial: "modal" %>
-<%= javascript_include_tag "decidim/navigation_maps/admin/navigation_maps" %>
-<%= stylesheet_link_tag "decidim/navigation_maps/admin/navigation_maps" %>
-      <% console %>
+<%# we need to rely on a CDN due a bug in webpacker that renders twice jquery if importing a plugin %>
+<%= javascript_include_tag "https://cdnjs.cloudflare.com/ajax/libs/jquery.form/4.3.0/jquery.form.min.js", integrity: "sha384-qlmct0AOBiA2VPZkMY3+2WqkHtIQ9lSdAsAn5RUJD/3vA5MKDgSGcdmIv4ycVxyn", crossorigin: "anonymous" %>
+<%= javascript_pack_tag "decidim_admin_navigation_maps" %>
+<%= stylesheet_pack_tag "decidim_admin_navigation_maps" %>

data/app/cells/decidim/navigation_maps/content_blocks/navigation_map_settings_form_cell.rb

@@ -10,7 +10,7 @@ module Decidim
         view_paths << "#{Decidim::NavigationMaps::Engine.root}/app/cells/decidim/navigation_maps/content_blocks/navigation_map_settings_form"
 
         def blueprint_form(blueprint = nil)
-          blueprint ||= Blueprint.new
+          blueprint ||= Blueprint.new(content_block: content_block)
           BlueprintForm.from_model(blueprint).with_context(organization: current_organization)
         end
 
@@ -26,6 +26,15 @@ module Decidim
         def label
           I18n.t("decidim.content_blocks.html.html_content")
         end
+
+        def image?(frm)
+          frm.image.attached?
+        end
+
+        def image_path(image, options = {})
+          options.merge!({ only_path: true })
+          Rails.application.routes.url_helpers.rails_blob_url(image, options)
+        end
       end
     end
   end

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

@@ -2,7 +2,8 @@
 
 module Decidim
   module NavigationMaps
-    # This command creates or updates the blueprints for the organization.
+    # This command creates or updates the blueprints for the organization and
+    # content block.
     class SaveBlueprints < Rectify::Command
       # Creates a blueprint.
       #
@@ -42,6 +43,7 @@ module Decidim
       def initialize_blueprint(form)
         @blueprint = Blueprint.find_or_initialize_by(id: form.id) do |blueprint|
           blueprint.organization = @forms.current_organization
+          blueprint.content_block = content_block
         end
       end
 
@@ -61,6 +63,10 @@ module Decidim
         @blueprint.areas.where.not(area_id: except).destroy_all
       end
 
+      def content_block
+        Decidim::ContentBlock.where(organization: @forms.current_organization, manifest_name: :navigation_map).find_by(id: @forms.content_block_id)
+      end
+
       def create_areas(blueprint)
         blueprint.each do |key, area|
           a = BlueprintArea.find_or_initialize_by(area_id: key, blueprint: @blueprint)

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

@@ -13,7 +13,7 @@ module Decidim
         end
 
         def show
-          render json: organization_blueprints.find(params[:id])
+          render json: organization_blueprints.find(params[:id]).to_json(except: :image)
         end
 
         def create
@@ -39,11 +39,11 @@ module Decidim
           return unless params[:content_block][:settings]
 
           @form = form(Decidim::Admin::ContentBlockForm).from_params(params)
-          Decidim::Admin::UpdateContentBlock.call(@form, content_block, :homepage)
+          Decidim::Admin::UpdateContentBlock.call(@form, content_block, content_block.scope_name&.to_sym)
         end
 
         def content_block
-          @content_block ||= Decidim::ContentBlock.for_scope(:homepage, organization: current_organization).find_by(manifest_name: :navigation_map)
+          @content_block ||= Decidim::ContentBlock.where(organization: current_organization, manifest_name: :navigation_map).find(params[:content_block_id])
         end
 
         # Convert blueprint data to an object

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

@@ -28,7 +28,7 @@ module Decidim
       def color
         return "#2262cc" if super.blank?
 
-        return "#" + super unless super.match?(/^#/)
+        return "##{super}" unless super.match?(/^#/)
 
         super
       end

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

@@ -11,6 +11,7 @@ module Decidim
 
       attribute :blueprint, Object
       attribute :id, Integer
+      attribute :decidim_content_block_id, Integer
       attribute :remove, Boolean
       attribute :image
       translatable_attribute :title, String

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

@@ -4,6 +4,7 @@ module Decidim
   module NavigationMaps
     class BlueprintForms < Decidim::Form
       attribute :blueprints, Array[BlueprintForm]
+      attribute :content_block_id, Integer
     end
   end
 end

data/app/jobs/decidim/navigation_maps/migrate_legacy_images_job.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    class MigrateLegacyImagesJob < ApplicationJob
+      queue_as :default
+
+      def perform(organization_id, mappings = [], logger = Rails.logger)
+        @organization_id = organization_id
+        @routes_mappings = mappings
+        @logger = logger
+
+        migrate_all!
+      end
+
+      private
+
+      attr_reader :routes_mappings, :logger
+
+      def migrate_all!
+        Decidim::CarrierWaveMigratorService.migrate_attachment!(
+          klass: Decidim::NavigationMaps::BluePrint,
+          cw_attribute: "image",
+          cw_uploader: Decidim::NavigationMaps::Cw::ImageUploader,
+          as_attribute: "image",
+          logger: @logger,
+          routes_mappings: routes_mappings
+        )
+      end
+    end
+  end
+end

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

@@ -4,22 +4,24 @@ module Decidim
   module NavigationMaps
     # Abstract class from which all models in this engine inherit.
     class Blueprint < ApplicationRecord
+      include Decidim::HasUploadValidations
+
       self.table_name = "decidim_navigation_maps_blueprints"
 
       attribute :height, :integer, default: 475
 
       belongs_to :organization, foreign_key: :decidim_organization_id, class_name: "Decidim::Organization"
+      belongs_to :content_block, foreign_key: :decidim_content_block_id, class_name: "Decidim::ContentBlock"
       has_many :areas,
                foreign_key: "decidim_navigation_maps_blueprint_id",
                class_name: "Decidim::NavigationMaps::BlueprintArea",
                dependent: :destroy
 
       validates :organization, presence: true
-      validates :image,
-                file_content_type: { allow: ["image/jpeg", "image/png", "image/svg+xml"] }
       validates :height, numericality: { greater_than: 0 }
 
-      mount_uploader :image, Decidim::NavigationMaps::BlueprintUploader
+      has_one_attached :image
+      validates_upload :image, uploader: Decidim::NavigationMaps::BlueprintUploader
 
       def blueprint
         areas.map { |area| [area.area_id.to_s, area.to_geoson] }.to_h

data/app/packs/entrypoints/decidim_admin_navigation_maps.js

@@ -0,0 +1,4 @@
+import "src/decidim/navigation_maps/admin/navigation_maps.js"
+
+// CSS
+import "entrypoints/decidim_admin_navigation_maps.scss";

data/app/packs/entrypoints/decidim_admin_navigation_maps.scss

@@ -0,0 +1 @@
+@import "stylesheets/decidim/navigation_maps/admin/navigation_maps";

data/app/packs/entrypoints/decidim_navigation_maps.js

@@ -0,0 +1,7 @@
+import "src/decidim/navigation_maps/navigation_maps.js"
+
+// Images
+require.context("../images", true)
+
+// CSS
+import "entrypoints/decidim_navigation_maps.scss";

data/app/packs/entrypoints/decidim_navigation_maps.scss

@@ -0,0 +1 @@
+@import "stylesheets/decidim/navigation_maps/navigation_maps";

data/app/packs/src/decidim/navigation_maps/admin/map_editor.js

@@ -0,0 +1,83 @@
+// Creates a map
+import NavigationMapView from "src/decidim/navigation_maps/map_view.js";
+
+export default class NavigationMapEditor extends NavigationMapView {
+  constructor(map_object, table_object) {
+    // Call constructor of superclass to initialize superclass-derived members.
+    super(map_object, () => {
+      this.createControls();
+      if (this.blueprint) {
+        this.createAreas();
+      }
+    });
+    this.table_object = table_object;
+    this.createAreaCallback = function () {};
+    this.editAreaCallback = function () {};
+    this.removeAreaCallback = function () {};
+  }
+
+  createControls() {
+    this.map.pm.addControls({
+      position: "topleft",
+      drawCircle: false,
+      drawMarker: false,
+      drawCircleMarker: false,
+      drawPolyline: false,
+      cutPolygon: false
+    });
+
+    this.map.on("pm:create", (e) => {
+      let geojson = e.layer.toGeoJSON();
+      this.blueprint[e.layer._leaflet_id] = geojson;
+      this.attachEditorEvents(e.layer);
+      this.createAreaCallback(e.layer._leaflet_id, e.layer, this);
+    });
+
+    this.map.on("pm:remove", (e) => {
+      delete this.blueprint[e.layer._leaflet_id];
+      this.removeAreaCallback(e.layer._leaflet_id, e.layer, this);
+    });
+  };
+
+  editing() {
+    let pm = this.map.pm;
+    return pm.globalRemovalEnabled() || pm.globalDragModeEnabled() || pm.globalEditEnabled();
+  };
+
+  // register callback to handle area edits,removals and creations
+  onCreateArea(callback) {
+    this.createAreaCallback = callback;
+  };
+  onEditArea(callback) {
+    this.editAreaCallback = callback;
+  };
+  onRemoveArea(callback) {
+    this.removeCreateCallback = callback;
+  };
+
+  attachEditorEvents (layer) {
+    layer.on("mouseover", (e) => {
+      e.target.getElement().classList.add("selected")
+    });
+
+    layer.on("mouseout", (e) => {
+      e.target.getElement().classList.remove("selected")
+    });
+
+    layer.on("pm:edit", (e) => {
+      this.blueprint[e.target._leaflet_id] = e.target.toGeoJSON();
+      this.editAreaCallback(e.target._leaflet_id, e.target, this);
+    });
+
+    layer.on("click", (e) => {
+      if (!this.editing()) {
+        this.clickAreaCallback(e.target._leaflet_id, e.target, this);
+      }
+    });
+  };
+
+  getBlueprint () {
+    return this.blueprint;
+  };
+
+}