decidim-decidim_awesome 0.5.1 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d9259114807c3c7f0dca652e83f99013ca524a6c68cdb4ece408de7efdaa6f8
-  data.tar.gz: '0937b4bf68c2240a022d99e0b15f2bb05407134d3a71c05ee6d325500af06843'
+  metadata.gz: ca4e9a5883518e03b29844b430fe92343558ca88394a4e03334ebb387cf133dc
+  data.tar.gz: 2dbdc12ff4446debcf62641c8dc4fa788fc5a07011060216874d3811f526d4f5
 SHA512:
-  metadata.gz: 45c576b8359928d771d58f3b67a64ee4189ce36e7b252a08170abdd2b2eaccaf18754640cf7c9f591b0669b5b7335dc944330778e47c027e70b8d5833bdd21c5
-  data.tar.gz: b993edbf892739c8379baeba8e745117895cb09cf453345976cf9be6909e333a3855af3ff365f0a2677f8012e2944893884996fa8a9dd97bd8709898c5ddbe08
+  metadata.gz: eb94d6bb293ebf2ac77767d18721f7f59f674a6fcfa89b5d8c3a12b7a2c56f3c49629767e878ff0ef7c9f7dffb31b13c1a90c7d82e5ffea2893aa1d59b57b548
+  data.tar.gz: 1af64bdf1c90aa1bcfb296777726df9fe7ffe6e1b472cd057e2595376b9eac47e96bd3c3abc4a6ebc2aba20537ecaac4c6047f8d2d0039ed436b33bdfbac2f6f

data/README.md

@@ -6,7 +6,7 @@
 
 Usability and UX tweaks for Decidim.
 
-This plugin allows the administrators to expand the possibilities of Decidim beyond some existing limitations. 
+This plugin allows the administrators to expand the possibilities of Decidim beyond some existing limitations.
 All tweaks are provided in a optional fashion with granular permissions that let the administrator to choose exactly where to apply those mods. Some tweaks can be applied to any assembly, other in an specific participatory process or even in type of component only.
 
 **This in beta status, we do not accept any responsibility for breaking anything. Feedback is appreciated though.**
@@ -16,7 +16,7 @@ All tweaks are provided in a optional fashion with granular permissions that let
 At Platoniq, we like to explore and combine open tools for enriching democracy in many levels. And also for organizations or companies, not only governments.
 Currently we are working very closely with the team behind [Decidim](https://decidim.org) because we believe that it is a great software.
 
-However in Platoniq we have this slogan: "Democracy is fun if you take it seriously" (feel free to ask for T-shirts 😉). 
+However in Platoniq we have this slogan: "Democracy is fun if you take it seriously" (feel free to ask for T-shirts 😉).
 And, let's face it, sometimes we feel that Decidim lacks a bit of the "fun" part so we created this.
 Because Decidim is awesome and so is this!
 
@@ -89,7 +89,7 @@ This feature allows to customize each organization css without affecting the oth
 4. Modify that file as you like, you can use any SASS function available (such as `@import`)
 5. Restart your server, enjoy!
 
-See an example here: 
+See an example here:
 https://github.com/Platoniq/decidim-demo/tree/master/app/assets/themes
 
 NOTE: Files presents in the `app/assets/themes` folder are added automatically into the precompile list of Rails by this plugin.
@@ -106,14 +106,20 @@ With this feature you can have a support chat in Decidim. It is linked to a [Tel
 
 ![Intergram screenshot](examples/intergram.png)
 
+#### 10. Custom CSS applied only according scopes restrictions
+
+For instance, with this feature you can create directly from the admin a CSS snipped that is only applied globally, in a particular assembly or even a single proposal!
+
+![CSS screenshot](examples/custom_styles.png)
+
 
 #### To be continued...
 
-Some things in the road-map: 
+Some things in the road-map:
 
 1. Improve the conversation in comments by allowing images
-1. Direct export of surveys in PDF
-1. Allow to create surveys where the responding user is known
+1. Allow to create non-private surveys where the responding user is known by admins
+1. Manipulate menus (reorder, change texts, add new items)
 1. Propose something! or even better send a PR!
 
 ## Installation
@@ -121,7 +127,7 @@ Some things in the road-map:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "decidim-decidim_awesome", "~> 0.5.1"
+gem "decidim-decidim_awesome", "~> 0.6.4"
 ```
 
 And then execute:
@@ -135,13 +141,13 @@ bundle exec rails db:migrate
 Depending on your Decidim version, choose the corresponding Awesome version to ensure compatibility:
 
 | Awesome version | Compatible Decidim versions |
-|---|---|---|---|---|
+|---|---|
 | 0.5.x | 0.21.x, 0.22.x |
-
+| 0.6.x | 0.22.x, 0.23.x |
 
 ## Configuration
 
-Each tweak can be enabled or disabled by default. It also can be deactivated so 
+Each tweak can be enabled or disabled by default. It also can be deactivated so
 admins do not even see it.
 
 In order to personalize default values, create an initializer such as:
@@ -244,15 +250,23 @@ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake test_
 DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rspec
 ```
 
-However, this project also make use of the gem [Appraisals](https://github.com/thoughtbot/appraisal) in order to test againts several versions of Decidim. The idea is to suport same supported versions of Decidim.
+However, this project also make use of the gem [Appraisals](https://github.com/thoughtbot/appraisal) in order to test against several versions of Decidim. The idea is to support same supported versions of Decidim.
+
+You can run run all tests against all Decidim versions by using:
 
-You can run run all tests againts all Decidim versions by using:
 ```bash
 bundle exec appraisal install
-DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake test_app
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec appraisal rake test_app
 DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec appraisal rspec
 ```
 
+To test a specific apprasail configured version do the following:
+
+```
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec appraisal decidim-0.23 rake test_app
+DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec appraisal decidim-0.23 rspec
+```
+
 Note that the database user has to have rights to create and drop a database in
 order to create the dummy test app database.
 
@@ -276,13 +290,15 @@ the code coverage report.
 
 ### Appraisals commands
 
+The [Appraisals](Appraisals) file contains the supported versions. In i each version defines the changes respect to the main `Gemfile`.
+
 Appraisal uses custom gems for testing in the folder `gemfiles`, these gemfiles are generated from the file `Appraisals`. To update definitions do:
 
 ```
 bundle exec appraisal install
 ```
 
-To update the Appraisal definitions maually do the following:
+The former command will take care of updating all configured version. To update the Appraisal definitions manually (not usually necessary) do the following:
 
 ```
 cd gemfiles

data/Rakefile

@@ -20,6 +20,11 @@ def copy_themes
   FileUtils.cp_r "lib/decidim/decidim_awesome/test/themes", "spec/decidim_dummy_app/app/assets/themes", verbose: true
 end
 
+def copy_headers
+  FileUtils.mkdir_p "spec/decidim_dummy_app/app/views/v0.11", verbose: true
+  FileUtils.cp_r "lib/decidim/decidim_awesome/test/layouts", "spec/decidim_dummy_app/app/views/v0.11/layouts", verbose: true
+end
+
 desc "copy test theme files"
 task :copy_themes do
   copy_themes
@@ -30,6 +35,7 @@ task test_app: "decidim:generate_external_test_app" do
   ENV["RAILS_ENV"] = "test"
   install_module("spec/decidim_dummy_app")
   copy_themes
+  copy_headers
 end
 
 desc "Generates a development app."

data/app/assets/config/decidim_admin_decidim_awesome_manifest.js

@@ -1 +1,2 @@
 // = link decidim/decidim_awesome/admin.js
+// = link decidim/decidim_awesome/admin/form_exit_warn.js

data/app/assets/config/decidim_decidim_awesome_manifest.js

@@ -1,2 +1,3 @@
 // = link decidim/decidim_awesome/application.js
+// = link decidim/decidim_awesome/awesome_map/legacy_map.js
 // = link decidim/decidim_awesome/awesome_map/map.js

data/app/assets/javascripts/decidim/decidim_awesome/admin/form_exit_warn.js.es6

@@ -0,0 +1,30 @@
+// = require_self
+
+$(() => {
+  const $form = $("form.awesome-edit-config");
+  if ($form.length > 0) {
+    $form.find("input, textarea, select").on("change", () => {
+      $form.data("changed", true);
+    });
+
+    const safePath = $form.data("safe-path").split("?")[0];
+    $(document).on("click", "a", (event) => {
+      window.exitUrl = event.currentTarget.href;
+    });
+    $(document).on("submit", "form", (event) => {
+      window.exitUrl = event.currentTarget.action;
+    });
+
+    window.addEventListener("beforeunload", (event) => {
+      const exitUrl = window.exitUrl;
+      const hasChanged = $form.data("changed");
+      window.exitUrl = null;
+
+      if (!hasChanged || (exitUrl && exitUrl.includes(safePath))) {
+        return null;
+      }
+
+      event.returnValue = true;
+    });
+  }
+});

data/app/assets/javascripts/decidim/decidim_awesome/awesome_map/legacy_map.js.es6

@@ -0,0 +1,225 @@
+// = require jsrender.min
+// = require decidim/map
+// = require leaflet.featuregroup.subgroup
+// = require decidim/decidim_awesome/awesome_map/categories
+// = require decidim/decidim_awesome/awesome_map/legacy_proposals
+// = require decidim/decidim_awesome/awesome_map/meetings
+// = require_self
+
+((exports) => {
+  const { fetchProposals, fetchMeetings, getCategory } = exports.AwesomeMap;
+
+  const collapsedMenu = $("#map").data("collapsed");
+  const show = {
+    withdrawn: $("#map").data("show-withdrawn"),
+    accepted: $("#map").data("show-accepted"),
+    evaluating: $("#map").data("show-evaluating"),
+    notAnswered: $("#map").data("show-not-answered"),
+    rejected: $("#map").data("show-rejected")
+  };
+  const components = $("#map").data("components");
+  const popupMeetingTemplateId = "marker-meeting-popup";
+  const popupProposalTemplateId = "legacy-marker-proposal-popup";
+
+  const cluster = L.markerClusterGroup();
+  const amendments = [];
+
+  const layers = {};
+
+  const control = L.control.layers(null, null, {
+    position: 'topleft', 
+    sortLayers: false,
+    collapsed: collapsedMenu, 
+    // hideSingleBase: true
+  });
+  const allMarkers = [];
+
+  const drawMarker = (element, marker, component) => {
+    let tmpl = component.type === "proposals" ? popupProposalTemplateId : popupMeetingTemplateId,
+        node = document.createElement("div");
+
+    $($.templates(`#${tmpl}`).render(element)).appendTo(node);
+    
+    marker.bindPopup(node, {
+      maxwidth: 640,
+      minWidth: 500,
+      keepInView: true,
+      className: "map-info"
+    }).openPopup();
+    
+    allMarkers.push({
+      marker: marker,
+      component: component,
+      element: element
+    });
+
+    // Check if it has amendments, add it to a list
+    if(element.amendments && element.amendments.length) {
+      element.amendments.forEach((amendment) => {
+        amendments.push(amendment.emendation.id);
+      });
+    }
+    // Add to category layer
+    let cat = getCategory(element.category);
+    if(layers[cat.id]) {
+      marker.addTo(layers[cat.id].group);
+      // show category if hidden
+      const $label = $(`.awesome_map-category_${cat.id}`).closest("label");
+      const $parent = $(`.awesome_map-category_${cat.parent}`).closest("label");
+      $label.show();
+      // update number of items
+      $label.attr("title", parseInt($label.attr("title") || 0) + 1);
+      // show parent if apply
+      $parent.show();
+      $parent.attr("title", parseInt($parent.attr("title") || 0) + 1);
+      // update component stats
+      const $component = $(`#awesome_map-component-${component.id}`);
+      $component.attr("title", parseInt($component.attr("title") || 0) + 1);
+    }
+
+    return marker;
+  };
+
+  const loadElements = (map) => {
+    // legends
+    control.addTo(map);
+    cluster.addTo(map);
+
+    // Load markers
+    components.forEach((component) => {  
+      if(component.type == "proposals") {
+        // add control layer for proposals
+        layers.proposals = {
+          label: `<span id="awesome_map-component-${component.id}" title="0">${component.name || window.DecidimAwesome.texts.proposals}</span>`,
+          group: L.featureGroup.subGroup(cluster)
+        };
+        control.addOverlay(layers.proposals.group, layers.proposals.label);
+        layers.proposals.group.addTo(map);
+
+        // add control layer for amendments if any
+        if(component.amendments) {
+          layers.amendments = {
+            label: `<span id="awesome_map-component-${component.d}" title="0">${window.DecidimAwesome.texts.amendments}</span>`,
+            group: L.featureGroup.subGroup(cluster)
+          }
+          control.addOverlay(layers.amendments.group, layers.amendments.label);
+          layers.amendments.group.addTo(map);
+        }
+
+        fetchProposals(component, '', (element, marker) => {
+            if(show[element.state || 'notAnswered']) {
+              drawMarker(element, marker, component).addTo(layers.proposals.group)   
+            }
+          }, () => {
+            // finall call
+            map.fitBounds(cluster.getBounds(), { padding: [50, 50] });
+            allMarkers.forEach((item) => {
+              // add marker to amendments layers if it's an amendment
+              if(amendments.find((a) => a == item.element.id)) {
+                item.marker.removeFrom(layers.proposals.group);
+                item.marker.addTo(layers.amendments.group);
+              }
+            });
+          });
+      }
+      
+      if(component.type == "meetings") {
+        // add control layer for meetings
+        layers.meetings = {
+          label: `<span id="awesome_map-component-${component.id}" title="0">${component.name || window.DecidimAwesome.texts.meetings}</span>`,
+          group: L.featureGroup.subGroup(cluster)
+        };
+        control.addOverlay(layers.meetings.group, layers.meetings.label);
+        layers.meetings.group.addTo(map);
+      
+        fetchMeetings(component, '', (element, marker) => {
+            drawMarker(element, marker, component).addTo(layers.meetings.group);
+          }, () => {
+            map.fitBounds(cluster.getBounds(), { padding: [50, 50] });
+          });
+      }
+    });
+
+
+    // add categories control layers
+    if(window.AwesomeMap.categories.length) {
+      let lastLayer = layers[Object.keys(layers)[Object.keys(layers).length - 1]];
+      // Add Categories "title"
+      if(lastLayer) {
+        lastLayer.label = `${lastLayer.label}<hr><b>${window.DecidimAwesome.texts.categories}</b>`;
+        control.removeLayer(lastLayer.group);
+        control.addOverlay(lastLayer.group, lastLayer.label);
+      }
+
+      window.AwesomeMap.categories.forEach((category) => {
+        // add control layer for this category
+        layers[category.id] = {
+          label: `<i class="awesome_map-category_${category.id}"></i> ${category.name}`,
+          group: L.featureGroup.subGroup(cluster)
+        };
+        layers[category.id].group.addTo(map);
+        control.addOverlay(layers[category.id].group, layers[category.id].label);
+        // hide layer by default, it will be activated if there's any marker in it
+        setTimeout(() => {
+          $(`.awesome_map-category_${category.id}`).closest("label").hide();
+        });
+      });
+
+      // watch events for subcategories syncronitzation
+      const getCatFromClass = (name) => {
+        let id = name.match(/awesome_map-category_(\d+)/) 
+        if(!id) return;
+        const cat = getCategory(id[1]);
+        if(!cat || !cat.name) return;
+
+        return cat;        
+      };
+
+      const indeterminateInput = (id) => {
+        $('[class^="awesome_map-category_"]').parent().prev().prop("indeterminate", false);
+        if(id) {
+          let $input = $(`.awesome_map-category_${id}`).parent().prev();
+          if(!$input.prop("checked")) {
+            $input.prop("indeterminate", true);
+          }
+        }
+      };
+
+      map.on('overlayadd', (e) => {
+        const cat = getCatFromClass(e.name);
+        if(!cat) return;
+        // if it's a children, put the parent to indeterminate
+        indeterminateInput(cat.parent);
+      });
+
+      // on remove a parent category, remove all children
+      map.on('overlayremove', (e) => {
+        const cat = getCatFromClass(e.name);
+        if(!cat) return;
+        cat.children().forEach((c) => {
+          let $el = $(`.awesome_map-category_${c.id}`);
+          if($el.parent().prev().prop("checked")) {
+            $el.click();
+          }
+        });
+      });
+
+    }
+
+  };
+
+  // currentMap might not be loaded yet so let's delay a bit
+  // TODO: improve this
+  const waitMap = () => {
+    if(exports.Decidim && exports.Decidim.currentMap) {
+      loadElements(exports.Decidim.currentMap);
+    } else {
+      setTimeout(() => {
+        waitMap();
+      }, 100);
+    }
+  };
+
+  waitMap();
+
+})(window);

data/app/assets/javascripts/decidim/decidim_awesome/awesome_map/legacy_proposals.js.es6

@@ -0,0 +1,82 @@
+// = require decidim/decidim_awesome/awesome_map/api_fetcher
+// = require decidim/decidim_awesome/awesome_map/categories
+
+((exports) => {
+  const { getCategory } = exports.AwesomeMap;
+  const query = `query ($id: ID!, $after: String!) {
+    component(id: $id) {
+        id
+        __typename
+        ... on Proposals {
+          proposals(first: 50, after: $after){
+            pageInfo {
+              hasNextPage
+              endCursor
+            }
+            edges {
+              node {  
+                id
+                state
+                title
+                body
+                address
+                coordinates {
+                  latitude
+                  longitude
+                }
+                amendments {
+                  emendation {
+                    id
+                  }
+                }
+                category {
+                  id
+                }
+              }
+            }
+          }
+        }
+      }
+    }`;
+
+  const ProposalIcon = L.DivIcon.SVGIcon.DecidimIcon;
+
+  const createMarker = (element, callback) => {
+    const marker = L.marker([element.coordinates.latitude, element.coordinates.longitude], {
+      icon: new ProposalIcon({
+        fillColor: getCategory(element.category).color
+      })
+    });
+
+    element.body = element.body.replace(/\n/g, "<br>");
+    callback(element, marker);
+  };
+
+  const fetchProposals = (component, after, callback, finalCall = () => {}) => {
+    const variables = {
+      "id": component.id,
+      "after": after
+    };
+    const api = new ApiFetcher(query, variables);
+    api.fetchAll((result) => {
+      if(result) {
+        result.component.proposals.edges.forEach((element) => {
+          if(!element.node) return;
+          
+          if(element.node.coordinates) {
+            element.node.link = component.url + '/proposals/' + element.node.id;
+            createMarker(element.node, callback);
+          }
+        });
+        if (result.component.proposals.pageInfo.hasNextPage) {
+          fetchProposals(component, result.component.proposals.pageInfo.endCursor, callback, finalCall);
+        } else {
+          finalCall();
+        }
+      }
+    });
+  };
+
+  exports.AwesomeMap = exports.AwesomeMap || {};
+  exports.AwesomeMap.fetchProposals = fetchProposals;
+})(window);