decidim-navigation_maps 1.2.0 → 1.3.2

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

@@ -0,0 +1,43 @@
+import NavigationMapView from "src/decidim/navigation_maps/map_view.js";
+import "jsviews/jsrender";
+
+$(function() {
+
+  let $maps = $(".navigation_maps .map");
+  let $tabs = $("#navigation_maps-tabs");
+  let maps = {};
+  let tmpl = $.templates("#navigation_maps-popup");
+
+  $maps.each(function() {
+    let id = $(this).data("id");
+    maps[id] = new NavigationMapView(this);
+    maps[id].onSetLayerProperties(function(layer, props) {
+      if (!props.popup) {
+        let node = document.createElement("div");
+        let html = tmpl.render(props);
+        $(node).html(html);
+
+        layer.bindPopup(node, {
+          maxHeight: 400,
+          // autoPan: false,
+          maxWidth: 640,
+          minWidth: 200,
+          keepInView: true,
+          className: `navigation_map-info map-info-${id}-${layer._leaflet_id}`
+        });
+      }
+    });
+    maps[id].onClickArea(function(area) {
+      let popup = area.feature.properties && area.feature.properties.link && area.feature.properties.popup;
+      if (popup) {
+        location = area.feature.properties.link;
+      }
+    });
+  });
+
+  $tabs.on("change.zf.tabs", function(e, $tab, $content) {
+    let id = $content.find(".map").data("id");
+    maps[id].reload();
+  });
+
+});

data/app/{assets → packs}/stylesheets/decidim/navigation_maps/admin/navigation_maps.scss

@@ -2,10 +2,10 @@
 //= require leaflet-geoman
 //= require_self
 
-@import "decidim/variables";
-@import "decidim/utils/settings";
-@import "decidim/utils/mixins";
-@import "decidim/navigation_maps/variables";
+@import "stylesheets/decidim/variables";
+@import "stylesheets/decidim/utils/settings";
+@import "stylesheets/decidim/utils/mixins";
+@import "stylesheets/decidim/navigation_maps/variables";
 
 .navigation_maps.admin {
   .accordion-item {

data/app/{assets → packs}/stylesheets/decidim/navigation_maps/navigation_maps.scss

@@ -1,8 +1,7 @@
 //= require leaflet
 //= require leaflet-geoman
 //= require_self
-
-@import "decidim/navigation_maps/variables";
+@import "stylesheets/decidim/navigation_maps/variables";
 
 .home-section {
   .navigation_maps {

data/app/uploaders/decidim/navigation_maps/blueprint_uploader.rb

@@ -4,18 +4,10 @@ module Decidim
   module NavigationMaps
     # This class deals with uploading images to a Blueprints.
     class BlueprintUploader < Decidim::ImageUploader
-      process :validate_size, :validate_dimensions
-
-      version :thumbnail do
-        process resize_to_fit: [nil, 237]
-      end
-
-      def extension_white_list
-        %w(jpg jpeg png svg)
-      end
-
-      def max_image_height_or_width
-        8000
+      set_variants do
+        {
+          thumbnail: { resize_to_fit: [nil, 237] }
+        }
       end
     end
   end

data/app/uploaders/decidim/navigation_maps/cw/blueprint_uploader.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module NavigationMaps
+    module Cw
+      # This class deals with uploading images to a Blueprints.
+      class BlueprintUploader < Decidim::Cw::ImageUploader
+        process :validate_size, :validate_dimensions
+
+        version :thumbnail do
+          process resize_to_fit: [nil, 237]
+        end
+
+        def extension_white_list
+          %w(jpg jpeg png svg)
+        end
+
+        def max_image_height_or_width
+          8000
+        end
+      end
+    end
+  end
+end

data/config/assets.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# This file is located at `config/assets.rb` of your module.
+
+# Define the base path of your module. Please note that `Rails.root` may not be
+# used because we are not inside the Rails environment when this file is loaded.
+base_path = File.expand_path("..", __dir__)
+
+# Register an additional load path for webpack. All the assets within these
+# directories will be available for inclusion within the Decidim assets. For
+# example, if you have `app/packs/src/decidim/foo.js`, you can include that file
+# in your JavaScript entrypoints (or other JavaScript files within Decidim)
+# using `import "src/decidim/foo"` after you have registered the additional path
+# as follows.
+Decidim::Webpacker.register_path("#{base_path}/app/packs")
+
+# Register the entrypoints for your module. These entrypoints can be included
+# within your application using `javascript_pack_tag` and if you include any
+# SCSS files within the entrypoints, they become available for inclusion using
+# `stylesheet_pack_tag`.
+Decidim::Webpacker.register_entrypoints(
+  decidim_navigation_maps: "#{base_path}/app/packs/entrypoints/decidim_navigation_maps.js",
+  decidim_admin_navigation_maps: "#{base_path}/app/packs/entrypoints/decidim_admin_navigation_maps.js"
+)
+
+# If you want to import some extra SCSS files in the Decidim main SCSS file
+# without adding any extra stylesheet inclusion tags, you can use the following
+# method to register the stylesheet import for the main application.
+# Decidim::Webpacker.register_stylesheet_import("stylesheets/decidim/navigation_maps/navigation_maps")
+
+# If you want to do the same but include the SCSS file for the admin panel's
+# main SCSS file, you can use the following method.
+# Decidim::Webpacker.register_stylesheet_import("stylesheets/decidim/navigation_maps/admin", group: :admin)
+
+# If you want to override some SCSS variables/settings for Foundation from the
+# module, you can add the following registered import.
+# Decidim::Webpacker.register_stylesheet_import("stylesheets/decidim/foo/settings", type: :settings)
+
+# If you want to do the same but override the SCSS variables of the admin
+# panel's styles, you can use the following method.
+# Decidim::Webpacker.register_stylesheet_import("stylesheets/decidim/foo/admin_settings", type: :settings, group: :admin)

data/config/locales/cs.yml

@@ -29,7 +29,7 @@ cs:
           view: Zapojte se
         navigation_map_settings_form:
           add: Přidat
-          autohide_tabs: Hide tabs navigation if there's only one map
+          autohide_tabs: Skrýt navigaci v záložkách, pokud je pouze jedna mapa
           blueprint_image: Obrázek plánu
           description: Popis
           editor: Editor mapy

data/db/seeds.rb

@@ -24,18 +24,19 @@ if !ENV["SKIP_MODULE_SEEDS"] && (!Rails.env.production? || ENV["SEED"])
   blueprint1 = Decidim::NavigationMaps::Blueprint.create(
     organization: organization,
     content_block: content_block,
-    image: File.new(File.join(seeds_root, "antarctica.png")),
     title: Decidim::Faker::Localized.sentence(word_count: 2),
     description: Decidim::Faker::Localized.sentence(word_count: 10)
   )
 
-  Decidim::NavigationMaps::Blueprint.create(
+  blueprint2 = Decidim::NavigationMaps::Blueprint.create(
     organization: organization,
-    image: File.new(File.join(seeds_root, "penguins.jpg")),
     title: Decidim::Faker::Localized.sentence(word_count: 2),
     description: Decidim::Faker::Localized.sentence(word_count: 10)
   )
 
+  blueprint1.image.attach(io: File.open(File.join(seeds_root, "antarctica.png")), filename: "antarctica.png", content_type: "image/png")
+  blueprint2.image.attach(io: File.open(File.join(seeds_root, "penguins.jpg")), filename: "penguins.jpg", content_type: "image/jpeg")
+
   Decidim::NavigationMaps::BlueprintArea.create(
     blueprint: blueprint1,
     area_id: "10",
@@ -84,7 +85,7 @@ if !ENV["SKIP_MODULE_SEEDS"] && (!Rails.env.production? || ENV["SEED"])
     link_type: "link",
     color: "#ffbb00",
     title: { en: "Penguins" },
-    description: { en: "Penguins are beatiful animals" }
+    description: { en: "Penguins are beautiful animals" }
   )
 
   Decidim::NavigationMaps::BlueprintArea.create(
@@ -121,10 +122,10 @@ if !ENV["SKIP_MODULE_SEEDS"] && (!Rails.env.production? || ENV["SEED"])
     blueprint = Decidim::NavigationMaps::Blueprint.create(
       organization: organization,
       content_block: content_block,
-      image: File.new(File.join(seeds_root, "pla-cerda.jpg")),
       title: Decidim::Faker::Localized.sentence(word_count: 2),
       description: Decidim::Faker::Localized.sentence(word_count: 10)
     )
+    blueprint1.image.attach(io: File.open(File.join(seeds_root, "pla-cerda.jpg")), filename: "pla-cerda.jpg", content_type: "image/jpeg")
 
     Decidim::NavigationMaps::BlueprintArea.create(
       blueprint: blueprint,

data/lib/decidim/navigation_maps/admin_engine.rb

@@ -22,10 +22,6 @@ module Decidim
         end
       end
 
-      initializer "decidim_navigation_maps.admin_assets" do |app|
-        app.config.assets.precompile += %w(admin/decidim_navigation_maps_manifest.js admin/decidim_navigation_maps_manifest.css)
-      end
-
       def load_seed
         nil
       end

data/lib/decidim/navigation_maps/engine.rb

@@ -9,10 +9,6 @@ module Decidim
     class Engine < ::Rails::Engine
       isolate_namespace Decidim::NavigationMaps
 
-      initializer "decidim_navigation_maps.assets" do |app|
-        app.config.assets.precompile += %w(decidim_navigation_maps_manifest.js decidim_navigation_maps_manifest.css)
-      end
-
       initializer "decidim.navigation_maps.content_blocks" do
         Decidim.content_blocks.register(:homepage, :navigation_map) do |content_block|
           content_block.cell = "decidim/navigation_maps/content_blocks/navigation_map"
@@ -41,6 +37,10 @@ module Decidim
         Cell::ViewModel.view_paths << File.expand_path("#{Decidim::NavigationMaps::Engine.root}/app/cells")
         Cell::ViewModel.view_paths << File.expand_path("#{Decidim::NavigationMaps::Engine.root}/app/views") # for partials
       end
+
+      initializer "decidim_notify.webpacker.assets_path" do
+        Decidim.register_assets_path File.expand_path("app/packs", root)
+      end
     end
   end
 end

data/lib/decidim/navigation_maps/navigation_map_cell_helpers.rb

@@ -7,7 +7,7 @@ module Decidim
       delegate :available_locales, to: :current_organization
 
       def valid_blueprints
-        content_block_blueprints.where.not(image: [nil, ""]).order(:created_at)
+        content_block_blueprints.joins(:image_attachment).order(:created_at)
       end
 
       def valid_blueprints?

data/lib/decidim/navigation_maps/version.rb

@@ -3,7 +3,7 @@
 module Decidim
   # This holds the decidim-meetings version.
   module NavigationMaps
-    VERSION = "1.2.0"
-    DECIDIM_VERSION = [">= 0.24", "< 0.25"].freeze
+    VERSION = "1.3.2"
+    DECIDIM_VERSION = [">= 0.25", "< 0.27"].freeze
   end
 end

data/lib/decidim/navigation_maps.rb

@@ -5,8 +5,6 @@ require "decidim/navigation_maps/engine"
 require "decidim/navigation_maps/admin_engine"
 
 module Decidim
-  # This namespace holds the logic of the `NavigationMaps` component. This component
-  # allows users to create navigation_maps in a participatory space.
   module NavigationMaps
     autoload :NavigationMapCellHelpers, "decidim/navigation_maps/navigation_map_cell_helpers"
   end

data/lib/tasks/decidim_navigation_maps_webpacker_tasks.rake

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "decidim/gem_manager"
+
+namespace :decidim_navigation_maps do
+  namespace :webpacker do
+    desc "Installs Decidim Awesome webpacker files in Rails instance application"
+    task install: :environment do
+      raise "Decidim gem is not installed" if decidim_path.nil?
+
+      install_navigation_maps_npm
+    end
+
+    desc "Adds Decidim Awesome dependencies in package.json"
+    task upgrade: :environment do
+      raise "Decidim gem is not installed" if decidim_path.nil?
+
+      install_navigation_maps_npm
+    end
+
+    def install_navigation_maps_npm
+      navigation_maps_npm_dependencies.each do |type, packages|
+        system! "npm i --save-#{type} #{packages.join(" ")}"
+      end
+    end
+
+    def navigation_maps_npm_dependencies
+      @navigation_maps_npm_dependencies ||= begin
+        package_json = JSON.parse(File.read(navigation_maps_path.join("package.json")))
+
+        {
+          prod: package_json["dependencies"].map { |package, version| "#{package}@#{version}" },
+          dev: package_json["devDependencies"].map { |package, version| "#{package}@#{version}" }
+        }.freeze
+      end
+    end
+
+    def navigation_maps_path
+      @navigation_maps_path ||= Pathname.new(navigation_maps_gemspec.full_gem_path) if Gem.loaded_specs.has_key?(gem_name)
+    end
+
+    def navigation_maps_gemspec
+      @navigation_maps_gemspec ||= Gem.loaded_specs[gem_name]
+    end
+
+    def rails_app_path
+      @rails_app_path ||= Rails.root
+    end
+
+    def system!(command)
+      system("cd #{rails_app_path} && #{command}") || abort("\n== Command #{command} failed ==")
+    end
+
+    def gem_name
+      "decidim-navigation_maps"
+    end
+  end
+end

data/lib/tasks/navigation_maps_active_storage_migration_tasks.rake

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+namespace :navigation_maps do
+  namespace :active_storage_migrations do
+    desc "Migrates editor images from Carrierwave to ActiveStorage"
+    task migrate_from_carrierwave: :environment do
+      stdout = Logger.new($stdout)
+      stdout.level = Logger::INFO
+      Rails.logger.extend(ActiveSupport::Logger.broadcast(stdout))
+      Decidim::Organization.find_each do |organization|
+        puts "Migrating Organization #{organization.id} (#{organization.host})..."
+        routes_mappings = []
+        Decidim::NavigationMaps::MigrateLegacyImagesJob.perform_now(organization.id, routes_mappings)
+
+        path = Rails.root.join("tmp/navigation_maps_editor_images_mappings.csv")
+        dirname = File.dirname(path)
+        FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+        File.open(path, "wb") do |file|
+          file.write(Decidim::Exporters::CSV.new(routes_mappings).export.read)
+        end
+      end
+    end
+
+    desc "Checks editor images migrated from Carrierwave to ActiveStorage"
+    task check_migration_from_carrierwave: :environment do
+      logger = ActiveSupport::TaggedLogging.new(Logger.new($stdout))
+
+      Decidim::CarrierWaveMigratorService.check_migration(
+        klass: Decidim::NavigationMaps::Blueprint,
+        cw_attribute: "image",
+        cw_uploader: Decidim::NavigationMaps::Cw::BlueprintUploader,
+        as_attribute: "image",
+        logger: logger
+      )
+    end
+  end
+end

data/package.json

@@ -0,0 +1,197 @@
+{
+  "name": "decidim-module-navigation_maps",
+  "version": "1.0.0",
+  "description": "A Blueprint/Map navigation for Decidim",
+  "scripts": {
+    "lint": "eslint -c .eslintrc.json --ext .js app/packs/",
+    "lint-fix": "eslint -c .eslintrc.json --ext .js app/packs/ --fix",
+    "stylelint": "stylelint **/*.scss",
+    "stylelint-fix": "stylelint **/*.scss --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Platoniq/decidim-module-navigation_maps.git"
+  },
+  "keywords": [
+    "decidim"
+  ],
+  "author": "Ivan Verges <ivan@platoniq.net>",
+  "license": "AGPL-3.0-or-later",
+  "bugs": {
+    "url": "https://github.com/Platoniq/decidim-module-navigation_maps/issues"
+  },
+  "homepage": "https://github.com/Platoniq/decidim-module-navigation_maps#readme",
+  "stylelint": {
+    "rules": {
+      "at-rule-empty-line-before": [
+        "always",
+        {
+          "except": [
+            "blockless-after-same-name-blockless",
+            "first-nested"
+          ],
+          "ignore": [
+            "after-comment"
+          ],
+          "ignoreAtRules": [
+            "else"
+          ]
+        }
+      ],
+      "at-rule-name-case": "lower",
+      "at-rule-semicolon-newline-after": "always",
+      "block-closing-brace-empty-line-before": "never",
+      "block-closing-brace-newline-after": "always",
+      "block-closing-brace-newline-before": "always-multi-line",
+      "block-closing-brace-space-before": "always-single-line",
+      "block-no-empty": true,
+      "block-opening-brace-newline-after": "always-multi-line",
+      "block-opening-brace-space-after": "always-single-line",
+      "block-opening-brace-space-before": "never",
+      "color-hex-case": "lower",
+      "color-hex-length": "short",
+      "color-no-invalid-hex": true,
+      "comment-empty-line-before": [
+        "always",
+        {
+          "except": [
+            "first-nested"
+          ],
+          "ignore": [
+            "stylelint-commands"
+          ]
+        }
+      ],
+      "comment-no-empty": true,
+      "comment-whitespace-inside": "always",
+      "custom-property-empty-line-before": [
+        "always",
+        {
+          "except": [
+            "after-custom-property",
+            "first-nested"
+          ],
+          "ignore": [
+            "after-comment",
+            "inside-single-line-block"
+          ]
+        }
+      ],
+      "declaration-bang-space-after": "never",
+      "declaration-bang-space-before": "always",
+      "declaration-block-no-duplicate-properties": [
+        true,
+        {
+          "ignore": [
+            "consecutive-duplicates-with-different-values"
+          ]
+        }
+      ],
+      "declaration-block-no-redundant-longhand-properties": true,
+      "declaration-block-no-shorthand-property-overrides": true,
+      "declaration-block-semicolon-newline-after": "always-multi-line",
+      "declaration-block-semicolon-space-after": "always-single-line",
+      "declaration-block-semicolon-space-before": "never",
+      "declaration-block-single-line-max-declarations": 1,
+      "declaration-block-trailing-semicolon": "always",
+      "declaration-colon-newline-after": "always-multi-line",
+      "declaration-colon-space-after": "always-single-line",
+      "declaration-colon-space-before": "never",
+      "declaration-empty-line-before": [
+        "always",
+        {
+          "except": [
+            "after-declaration",
+            "first-nested"
+          ],
+          "ignore": [
+            "after-comment",
+            "inside-single-line-block"
+          ]
+        }
+      ],
+      "function-calc-no-unspaced-operator": true,
+      "function-comma-newline-after": "always-multi-line",
+      "function-comma-space-after": "always-single-line",
+      "function-comma-space-before": "never",
+      "function-linear-gradient-no-nonstandard-direction": true,
+      "function-max-empty-lines": 0,
+      "function-name-case": "lower",
+      "function-parentheses-newline-inside": "always-multi-line",
+      "function-parentheses-space-inside": "never-single-line",
+      "function-whitespace-after": "always",
+      "indentation": 2,
+      "keyframe-declaration-no-important": true,
+      "length-zero-no-unit": true,
+      "max-empty-lines": 1,
+      "media-feature-colon-space-after": "always",
+      "media-feature-colon-space-before": "never",
+      "media-feature-name-case": "lower",
+      "media-feature-name-no-unknown": true,
+      "media-feature-parentheses-space-inside": "never",
+      "media-feature-range-operator-space-after": "always",
+      "media-feature-range-operator-space-before": "always",
+      "media-query-list-comma-newline-after": "always-multi-line",
+      "media-query-list-comma-space-after": "always-single-line",
+      "media-query-list-comma-space-before": "never",
+      "no-empty-source": true,
+      "no-eol-whitespace": true,
+      "no-extra-semicolons": true,
+      "no-invalid-double-slash-comments": true,
+      "no-missing-end-of-source-newline": true,
+      "number-leading-zero": "never",
+      "number-no-trailing-zeros": true,
+      "property-case": "lower",
+      "property-no-unknown": true,
+      "rule-empty-line-before": [
+        "always-multi-line",
+        {
+          "except": [
+            "first-nested"
+          ],
+          "ignore": [
+            "after-comment"
+          ]
+        }
+      ],
+      "selector-attribute-brackets-space-inside": "never",
+      "selector-attribute-operator-space-after": "never",
+      "selector-attribute-operator-space-before": "never",
+      "selector-combinator-space-after": "always",
+      "selector-combinator-space-before": "always",
+      "selector-descendant-combinator-no-non-space": true,
+      "selector-list-comma-newline-after": "always",
+      "selector-list-comma-space-before": "never",
+      "selector-max-empty-lines": 0,
+      "selector-pseudo-class-case": "lower",
+      "selector-pseudo-class-no-unknown": true,
+      "selector-pseudo-class-parentheses-space-inside": "never",
+      "selector-pseudo-element-case": "lower",
+      "selector-pseudo-element-colon-notation": "double",
+      "selector-pseudo-element-no-unknown": true,
+      "selector-type-case": "lower",
+      "selector-type-no-unknown": true,
+      "shorthand-property-no-redundant-values": true,
+      "string-no-newline": true,
+      "unit-case": "lower",
+      "unit-no-unknown": true,
+      "value-list-comma-newline-after": "always-multi-line",
+      "value-list-comma-space-after": "always-single-line",
+      "value-list-comma-space-before": "never",
+      "value-list-max-empty-lines": 0
+    }
+  },
+  "dependencies": {
+    "@geoman-io/leaflet-geoman-free": "^2.11.4",
+    "jquery-form": "^4.3.0",
+    "jsviews": "^1.0.11"
+  },
+  "devDependencies": {
+    "eslint": "^7.32.0",
+    "eslint": "^7.25.0",
+    "eslint-config-prettier": "^8.2.0",
+    "eslint-config-standard": "^11.0.0",
+    "eslint-plugin-import": "^2.22.0",
+    "stylelint": "13.11.0"
+  }
+}