decidim-decidim_geo 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fff663b0c00ffc5bd8e6fca41045134fc1c3578b04afefa6adecaf675f45329
-  data.tar.gz: 6ed0021e49f2123cf49501336b210baff24d034f24a227c2bb541fe762255722
+  metadata.gz: 0c8fd6ca0dfb211b54315cb9bf8043235bc6e07e3afe0a2d6de344a2b2f8f562
+  data.tar.gz: 8d8a3b2271838abcc31dc4dde08daf54e7f40dba71cd82e37a1b96482db1a684
 SHA512:
-  metadata.gz: 4902ed257c74255621ba468996c4eae3b32bf369fec4f4c5d280d38ae41e47f5adf9ed628d5396cb03de427b1c73a2b36e9685cfcd936b1d4c854cf8ef963f41
-  data.tar.gz: ebb63d912ce774156e424321bf9b28b5a38fa89f499e3e3347bf2e52d173332244fcf595ca5562079dc5a92b2da6728799aef86c749e9378a57bd8c6f765ae36
+  metadata.gz: 0c5150d57349ff8388972ba2bb88adfde2e348ee5db834e13bf3fcf09ffb1aa3d0577ba3f045893efb99104f7b895c26ae98abf400fae3b5050931dc5bbced37
+  data.tar.gz: 369c1ba4eb4bc111f43ad6d6af3cb1a9fbbcf489bba7879e5145a9d275178e17bf5ee400b8e2cac6820bbafd7e5755d321aa26be3d4e9d909fbd7b3ed29758b1

data/README.md

@@ -1,4 +1,4 @@
-<h1 align="center"><img src="https://github.com/octree-gva/meta/blob/main/decidim/static/header.png?raw=true" alt="Decidim - Octree Participatory democracy on a robust and open source solution" /></h1>
+<h1 align="center"><img src="https://github.com/octree-gva/decidim-geo/blob/main/parners.png?raw=true" alt="Decidim - Octree Participatory democracy on a robust and open source solution" /></h1>
 <h4 align="center">
     <a href="https://octreegva.notion.site/Roadmap-Decidim-GEO-f191fcb9e220401f8135514a7bd41aab">Roadmap</a> |
     <a href="https://drive.google.com/file/d/1lfQJumDg0Ic-RZi-R3MM8frYtKN7PB_S/view?usp=sharing">Presentation</a> |
@@ -11,19 +11,6 @@
     <a href="https://meta.decidim.org">Participatory Governance (meta decidim)</a><br/><br/>
     <a href="https://matrix.to/#/+decidim:matrix.org">Decidim Community (Matrix+Element.io)</a>
 </h4>
-<p align="center">
-    <a href="https://participer.lausanne.ch">
-        <img
-            src="https://github.com/octree-gva/meta/blob/main/decidim/static/participer_lausanne/chip.png?raw=true"
-            alt="Lausanne Participe — Une plateforme de participation pour imaginer et réaliser ensemble" />
-    </a>
-    <a href="https://opencollective.com/voca">
-        <img
-            src="https://github.com/octree-gva/meta/blob/main/decidim/static/opencollective_chip.png?raw=true"
-            alt="Voca – Open-Source SaaS platform for Decidim" />
-    </a>
-</p>
-
 
 # Decidim::Geo
 Have you ever wondered to centralize all the participation in a map? Well, we do and that is the purpose of Decidim GEO. 
@@ -37,10 +24,65 @@ This project is its early stage, and has it is quiet ambicious, we open CO-FUNDI
 If you are curious on how it started, [we've made some slide to present the project](https://drive.google.com/file/d/1lfQJumDg0Ic-RZi-R3MM8frYtKN7PB_S/view?usp=sharing).
 
 
-## How it works?
+## Features
+
+**Link shapes to a scope**<br />
+On the admin side, you can now upload a zip shapefile in the `WGS 84` format.
+Once uploaded, you can assign a scope type to the shapefile.
+
+Example of use: 
+- Add a shapefile to the admin with the shapes of the city neighborhoods
+- Create a scope type called "neighborhoods"
+- For each neighborhood, create a scope of type "neighborhoods"
+- Link related meetings, assemblies, processes, and proposals to these scopes
+- See the magic: the maps now display the neighborhoods, allowing you to navigate the platform through maps. 
+
+---
+
+**Homepage block**<br />
+In the homepage settings, you can now drag a Decidim Geo block to display a map
+with all the points of the platform.
+Once the Decidim Geo homepage block is active, the map will provide an entry point to
+navigate through the participatory platform.
+
+---
+**Default map center and zoom**<br />
+You can now customize all Decidim Geo maps at once by defining a default center and zoom level. 
+This provides a better experience when loading the map, already having the right perspective to start navigating.
+
+To update the map's center and zoom, go to the Geo tab in the administration and click on Configuration.
+
+---
+
+**Custom Tiles**<br />
+You can now define custom tiles to change the underlying appearance of the map.
+Displaying custom tiles allows more precise control over what is viewed, and can, for example, increase map contrast for better accessibility.
+
+---
+
+**Hide maps when there is nothing to show**<br />
+Maps will be hidden if there is no point to show. For example, a meeting without a location won't display a map in its details. 
+Taxonomies that do not contain any data will also be hidden, preventing the user from filtering something when there is no data to display.
+
+**Highlight points**<br />
+We've defined some rules to highlight points displayed on the current page:
+
+- When you are on a meeting detail page that is geolocated, the current point will be highlighted.
+- When you are on a meeting page, all geolocated points will be highlighted.
+
+Same for proposals, debates etc.
+
+---
+
+**Discover points around**<br />
+If you have multiple processes linked to the same geolocated scope, points will appear to suggest navigating through the area you are currently in. 
+
+Imagine the following situation:
+- A participatory budget is running in the neighborhood.
+- In the same neighborhood, another process is gathering projects.
+
+From the participatory budget page, you will see all the points in the neighborhood, providing a quick overview of what is happening there.
 
-Postgis can load Shapefiles that can represents anything: neighbourghoods, cities, states, trees, public spaces.
-We use this module to map a shape to an application zone, to be able to geo-references all the participatory processes of the platform. This way we can offer better consultation experience, and open new perspective for participation.
 
 <img
     src="https://github.com/octree-gva/meta/blob/main/decidim/static/geo/admin.png?raw=true"
@@ -50,123 +92,24 @@ We use this module to map a shape to an application zone, to be able to geo-refe
     alt="Administration of the GEO space" />
 
 
-## Installation
-This gem supports decidim version `0.26.x` and `0.27.x`.
-
-Read the [needed dependancies for `rgeo` gem](https://github.com/rgeo/rgeo?tab=readme-ov-file#dependencies). If you have `libgeos-dev`, be sure you have a postgis database with postgres > 14.0.
-
-Add this line to your application's Gemfile:
-```ruby
-gem "decidim-decidim_geo"
-```
-
-Update your database adapter to postgis adapter (already installed as dependancy of this gem): 
-```
-# config/database.yml
-default: &default
-  adapter: postgis
-```
-
-Update your `DATABASE_URL` environment with `postgis://`: 
-```
-DATABASE_URL="postgis://myuser:mypass@localhost/somedatabase"
-```
-
-And then execute:
-
-```bash
-bundle
-bundle exec rails decidim_geo:install:migrations
-bundle exec rails db:migrate
-```
-
-## Testing
-```
-bundle exec rake test_app
-```
-
-## Local development
-First, you need to run an empty database with a decidim dev container which runs nothing.
-```
-docker-compose down -v --remove-orphans
-docker-compose up -d
-```
-Once created, you access the decidim container
-```
-# Get the id of the decidim dev container
-docker ps --format {{.ID}} --filter=label=org.label-schema.name=decidim
-# f16bd5314386
-docker exec -it f16bd5314386 bash
-```
-You are now in bash, run manually `docker-entrypoint`.
-```
-# Will check your environment and do migrations if needed
-docker-entrypoint
-```
-You are now ready to use your container in the way you want for development:
-
-* Run a rails server: `bundle exec rails s -b 0.0.0.0`
-* Have live-reload on your assets: `bin/webpack-dev-server`
-* Execute tasks, like `bundle exec rails g migration AddSomeColumn`
-* etc.
-```
-bundle exec rails s -b 0.0.0.0 # rails server
-bin/webpack-dev-server
-etc.
-```
-
-To stop everything, uses:
-- `docker-compose down` to stop the containers
-- `docker-compose down -v` to stop the containers and remove all previously saved data.
-
-### Debugging
-To debug something on the container:
-1. Ensure `decidim-app` is running
-```bash
-    docker ps --all
-#   CONTAINER ID   IMAGE                           COMMAND                  CREATED        STATUS        PORTS                                            NAMES
-#   f16bd5314386   decidim-geo-development-app     "sleep infinity"   13 hours ago   Up 13 hours   0.0.0.0:3000->3000/tcp, 0.0.0.0:3035->3035/tcp   decidim-app <-------- THIS ONE
-#   b56adf6404d8   decidim-geo-development-app     "bin/webpack-dev-ser…"   54 seconds ago   Up 46 seconds   0.0.0.0:3035->3035/tcp   decidim-webpacker                                       decidim-installer
-#   bc1e912c3d8a   postgis/postgis:14-3.3-alpine   "docker-entrypoint.s…"   13 hours ago   Up 13 hours   0.0.0.0:5432->5432/tcp                           decidim-module-geo-pg-1
-```
-
-2. Run `docker exec -it decidim-app bash`
-3. Run
-    - `tail -f $ROOT/log/development.log` to **access logs**
-    - `bundle exec rails restart` to **restart rails server AND keeps webpacker running**
-    - `cd $ROOT` to access the `development_app`
-    - `cd $ROOT/../decidim_module_geo` to access the module directory
-
-### FAQ
-
-**I can't see logs on the `decidim-app`?**
-`decidim-app` runs here in development `webpacker-dev-server` AND a puma server, on the same container. 
-Thus, we just run both, and only one will be displayed on STDOUT. To see puma log: `docker exec decidim-app tail -f /home/app/decidim/log/development.log`
-
-**It takes for ever to pull the image?**
-Try to pull from docker hub before doing your install script. `docker pull hfroger/decidim:0.26.8-dev` can help. 
-
-**Why must I access to `127.0.0.1` and not `localhost`?**
-`webpack-dev-server` run a websocket server on port 3535, and the rails server needs to connect to it. 
-`localhost` won't make the trick, and you need to use a "real" ip, like `127.0.0.1`.  [More info](https://stackoverflow.com/a/54102318)
-
-## Contributing
-
-We are not yet ready for contributions, but we are working on a goood workflow
-
-# Why it's not on MetaDecidim?
-We think Decidim is already over complicated to install and setup. This module uses PosGis extensions on a postgres database, that can be hard to install. We block the proposal to metadecidim until these points are solved:
-
-- We have stable release.
-- We have feedbacks from participants that it is actually usefull.
-- We have feedbacks from Decidim's admins that this is actually improving participation.
-- Decidim run primarly on docker, with an updated documentation on installation. (We, at Octree is working on it for a while)
+## Documentation
+You can consult our documentation on the [decidim-geo documentation website](https://octree-gva.github.io/decidim-module-geo/)
+
+## Contributions
+
+New ideas are welcome on our [feedback page](https://feedback.voca.city/?tags=decidim-geo). We manage there co-financing and release planning.
+For technical aspects (contributions, code, issues), take a look at our [gitlab](https://git.octree.ch/decidim/decidim-module-geo).
 
 ## License
 
 This engine is distributed under the [GNU AFFERO GENERAL PUBLIC LICENSE](LICENSE-AGPLv3.txt)
 
 <br /><br />
+
+<h3 align="center">With the support of</h3>
 <p align="center">
-    <img src="https://raw.githubusercontent.com/octree-gva/meta/main/decidim/static/octree_and_decidim.png" height="90" alt="Decidim Installation by Octree" />
+        <img
+            src="https://git.octree.ch/decidim/decidim-module-geo/-/raw/main/partners.png?raw=true"
+            alt="Lausanne Participe — Une plateforme de participation pour imaginer et réaliser ensemble" />
 </p>
+

data/Rakefile

@@ -4,7 +4,10 @@ require "decidim/dev/common_rake"
 
 def install_module(path)
   Dir.chdir(path) do
-    system("bundle exec rake decidim_geo:install:migrations")
+    Bundler.with_unbundled_env do
+      sh "bundle exec rails decidim_toggle:install:migrations"
+    end
+    system("bundle exec rails decidim:update")
   end
 end
 
@@ -21,16 +24,17 @@ end
 desc "Prepare for testing"
 task :prepare_tests do
   # Remove previous existing db, and recreate one.
-  Dir.chdir("development_app") do
-    system("bundle exec rake db:drop")
-    system("bundle exec rake db:create")
+  Dir.chdir("spec/decidim_dummy_app") do
+    Bundler.with_unbundled_env do
+      sh "env BUNDLE_GEMFILE=#{File.expand_path("Gemfile", __dir__)} RAILS_ENV=test DISABLE_SPRING=1 bundle exec rails db:drop db:create"
+    end
   end
   ENV["RAILS_ENV"] = "test"
-  databaseYml = {
+  database_yml = {
     "test" => {
       "adapter" => "postgis",
       "encoding" => "unicode",
-      "host" => ENV.fetch("DATABASE_HOST", "localhost"),
+      "host" => ENV.fetch("DATABASE_HOST", "pg"),
       "port" => ENV.fetch("DATABASE_PORT", "5432").to_i,
       "username" => ENV.fetch("DATABASE_USERNAME", "decidim"),
       "password" => ENV.fetch("DATABASE_PASSWORD", "insecure-password"),
@@ -38,27 +42,30 @@ task :prepare_tests do
     }
   }
   config_file = File.expand_path("spec/decidim_dummy_app/config/database.yml", __dir__)
-  File.open(config_file, "w") { |f| YAML.dump(databaseYml, f) }
+  File.open(config_file, "w") { |f| YAML.dump(database_yml, f) }
   Dir.chdir("spec/decidim_dummy_app") do
-     system("bundle exec rails db:migrate")
-   end
+    Bundler.with_unbundled_env do
+      sh "env BUNDLE_GEMFILE=#{File.expand_path("Gemfile", __dir__)} RAILS_ENV=test DISABLE_SPRING=1 bundle exec rails db:migrate"
+    end
+  end
 end
 
 desc "Generates a decidim_dummy_app app for testing"
 task :test_app do
+  ENV["DISABLE_SPRING"] = "true"
   Bundler.with_original_env do
     generate_decidim_app(
       "spec/decidim_dummy_app",
-        "--app_name",
-        "#{base_app_name}",
-        "--path",
-        "../..",
-        "--skip_spring",
-        "--demo",
-        "--force_ssl",
-        "false",
-        "--locales",
-        "en,fr,es"
+      "--app_name",
+      base_app_name.to_s,
+      "--path",
+      "../..",
+      "--skip_spring",
+      "--demo",
+      "--force_ssl",
+      "false",
+      "--locales",
+      "en,fr,es"
     )
   end
   install_module("spec/decidim_dummy_app")
@@ -77,7 +84,7 @@ task :prepare_dev do
     system("bundle exec rake db:create")
   end
   ENV["RAILS_ENV"] = "development"
-  databaseYml = {
+  database_yml = {
     "development" => {
       "adapter" => "postgis",
       "encoding" => "unicode",
@@ -85,14 +92,13 @@ task :prepare_dev do
       "port" => ENV.fetch("DATABASE_PORT", "5432").to_i,
       "username" => ENV.fetch("DATABASE_USERNAME", "decidim"),
       "password" => ENV.fetch("DATABASE_PASSWORD", "insecure-password"),
-      "database" => "#{base_app_name}_development",
+      "database" => "#{base_app_name}_development"
     }
   }
   config_file = File.expand_path("development_app/config/database.yml", __dir__)
-  File.open(config_file, "w") { |f| YAML.dump(databaseYml, f) }
+  File.open(config_file, "w") { |f| YAML.dump(database_yml, f) }
   Dir.chdir("development_app") do
     system("bundle exec rake db:migrate")
-    system("npm install -D webpack-dev-server")
   end
 end
 
@@ -102,7 +108,7 @@ task :development_app do
     generate_decidim_app(
       "development_app",
       "--app_name",
-      "#{base_app_name}",
+      base_app_name.to_s,
       "recreate_db",
       "--path",
       "..",

data/app/cells/decidim/geo/content_blocks/geo_maps/show.erb

@@ -1,15 +1,14 @@
-<link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.2/dist/leaflet.css" integrity="sha256-sA+zWATbFveLLNqWO2gtiw3HL/lh1giY/Inf1BJ0z14=" crossorigin="">
-<script src="https://unpkg.com/leaflet@1.9.2/dist/leaflet.js" integrity="sha256-o9N1jGDZrf5tS+Ft4gbIK7mYMipq9lqpVJ91xHSyKhg=" crossorigin=""></script>
+<%= content_tag :div, "",
+                id: "Geo#{id}", 
+                class: [
+                  "decidimGeo__container", 
+                  options[:container_classnames] || "", 
+                  "decidimGeo__container--" + params[:controller].split("/").last.underscore,
+                  options[:id].present? ? "decidimGeo__container--#{options[:id].underscore}" : ""
+                ] do %>
+  <div class="decidimGeo__mobile_btn__mobile_btn">
+    <span><%= t("decidim.geo.mobile.open_fullscreen") %></span>
+  </div>
+  <%= insert_map %>
+<% end %>
 
-<style>
-  .decidimgeo__map {
-    height: 640px;
-    width: 100%;
-    max-width: 100%;
-    max-height: 100%;
-  }  
-</style>
-
-<%= javascript_pack_tag "decidim_geo" %>
-
-<%= insert_map %>