decidim-decidim_awesome 0.6.0 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3401b18b924106ad65b4545904014b5c853485f897dc194affaa00665b07fe40
-  data.tar.gz: 68f73b33b0b31dc4addbd5f3f6dfa68b90ee5cd5ef56fa6f0ed91ee58c96fb73
+  metadata.gz: 2be39606cbd0f92bc8232bbd4a1c8b04a27aed18e9a0732668af6f37126d66f4
+  data.tar.gz: 5034f9d65042871ec4be47c313e90c46390e40751003666ea8a93166df087d31
 SHA512:
-  metadata.gz: 770a318ee4b9e08018709b7526cad4365ec373b75b2083d92e851a6f2eeb8eeee0e7ef51ed515a44a247b4129a4c929313434f99927f1eaa398cd25350151ca4
-  data.tar.gz: 5d3085dab5205c222eb52c57258b9cbdef9dfea5f1fa8a946700b40da53dea3d8514311672a48976def5a59408d52fd429f8864713361bbd68a97f5146e451db
+  metadata.gz: b2219e00f0a35206d772032e1f259e5283e2085a39bf5f45e47af09a784ece3776c0824ed7dc6d191cdcbf036b34a647fb5c9c172e13f86ef21394f54275fc9a
+  data.tar.gz: e2abb579c41c61b11377c986f692cba8b944671e1876616bf771309b8e62900a05b57582f72f1f458ef17309b55d8030c15727993ad99092c40ac4c4e31fd94a

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!
 
@@ -33,7 +33,7 @@ Each hack can be scoped to one or more specific participatory spaces or componen
 
 #### 1. Image support for the Quill editor
 
-Modifies the WYSIWYG editor in Decidim by adding the possibility to insert images. When uploading images, Drag & Drop is supported. Images will be uploaded to the server and inserted as external resources (it doesn't use base64 inline encoding).
+Modifies the WYSIWYG editor in Decidim by adding the possibility to insert images. When uploading images, Drag & Drop is supported. Images will be uploaded to the server and inserted as external resources (it doesn't use base64 in-line encoding).
 
 This feature allows you use images in newsletters as well.
 
@@ -71,13 +71,13 @@ Many scopes can be defined for every tweak.
 
 This is a component you can add in any participatory space. It retrieves all the geolocated content in that participatory space (meetings or proposals) and displays it in a big map.
 
-It also provides a simple search by category, each category is assignated to a different color.
+It also provides a simple search by category, each category is assigned to a different color.
 
 ![Awesome map](examples/awesome-map.png)
 
 #### 7. Allow Decidim to use custom CSS themes for every tenant
 
-When customizind CSS for a Decidim installation, each change affects all the organizations (tenant).
+When customizing CSS for a Decidim installation, each change affects all the organizations (tenant).
 
 This feature allows to customize each organization css without affecting the others in the same Decidim installation.
 
@@ -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,28 @@ 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 scoped restrictions
+
+With this feature you can create directly in 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)
+
+#### 11. Change the main menu of Decidim entirely!
+
+Feel free to hide, modify or add items in the Decidim's main menu. You can also change the order, establish some conditions (like showing only for logged users) or open in a new window.
+
+![Menu hacks screenshot](examples/menu-1.png)
+![Menu hacks screenshot](examples/menu-2.png)
+![Menu hacks screenshot](examples/menu-3.png)
+![Menu hacks screenshot](examples/menu-4.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 +135,7 @@ Some things in the road-map:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "decidim-decidim_awesome", "~> 0.6.0"
+gem "decidim-decidim_awesome", "~> 0.6.5"
 ```
 
 And then execute:
@@ -141,7 +155,7 @@ Depending on your Decidim version, choose the corresponding Awesome version to e
 
 ## 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 +258,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:
+
 ```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 +298,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 manually 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/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/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

@@ -1,7 +1,8 @@
+// = require jsrender.min
 // = require decidim/map
 // = require leaflet.featuregroup.subgroup
 // = require decidim/decidim_awesome/awesome_map/categories
-// = require decidim/decidim_awesome/awesome_map/proposals
+// = require decidim/decidim_awesome/awesome_map/legacy_proposals
 // = require decidim/decidim_awesome/awesome_map/meetings
 // = require_self
 
@@ -9,9 +10,16 @@
   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 = "marker-proposal-popup";
+  const popupProposalTemplateId = "legacy-marker-proposal-popup";
 
   const cluster = L.markerClusterGroup();
   const amendments = [];
@@ -30,7 +38,7 @@
     let tmpl = component.type === "proposals" ? popupProposalTemplateId : popupMeetingTemplateId,
         node = document.createElement("div");
 
-    $.tmpl($(`#${tmpl}`), element).appendTo(node);
+    $($.templates(`#${tmpl}`).render(element)).appendTo(node);
     
     marker.bindPopup(node, {
       maxwidth: 640,
@@ -99,7 +107,9 @@
         }
 
         fetchProposals(component, '', (element, marker) => {
-            drawMarker(element, marker, component).addTo(layers.proposals.group);
+            if(show[element.state || 'notAnswered']) {
+              drawMarker(element, marker, component).addTo(layers.proposals.group)   
+            }
           }, () => {
             // finall call
             map.fitBounds(cluster.getBounds(), { padding: [50, 50] });

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);

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

@@ -1,3 +1,4 @@
+// = require jsrender.min
 // = require leaflet.featuregroup.subgroup
 // = require decidim/decidim_awesome/awesome_map/categories
 // = require decidim/decidim_awesome/awesome_map/proposals
@@ -8,6 +9,13 @@
   const { fetchProposals, fetchMeetings, getCategory } = exports.AwesomeMap;
 
   const collapsedMenu = $("#awesome-map").data("collapsed");
+  const show = {
+    withdrawn: $("#awesome-map").data("show-withdrawn"),
+    accepted: $("#awesome-map").data("show-accepted"),
+    evaluating: $("#awesome-map").data("show-evaluating"),
+    notAnswered: $("#awesome-map").data("show-not-answered"),
+    rejected: $("#awesome-map").data("show-rejected")
+  };
   const components = $("#awesome-map").data("components");
   const popupMeetingTemplateId = "marker-meeting-popup";
   const popupProposalTemplateId = "marker-proposal-popup";
@@ -29,7 +37,7 @@
     let tmpl = component.type === "proposals" ? popupProposalTemplateId : popupMeetingTemplateId,
         node = document.createElement("div");
 
-    $.tmpl($(`#${tmpl}`), element).appendTo(node);
+    $($.templates(`#${tmpl}`).render(element)).appendTo(node);
     
     marker.bindPopup(node, {
       maxwidth: 640,
@@ -98,7 +106,10 @@
         }
 
         fetchProposals(component, '', (element, marker) => {
-            drawMarker(element, marker, component).addTo(layers.proposals.group);
+            console.log(element.state, show[element.state || 'notAnswered'], show, element);
+            if(show[element.state || 'notAnswered']) {
+              drawMarker(element, marker, component).addTo(layers.proposals.group)   
+            }
           }, () => {
             // finall call
             map.fitBounds(cluster.getBounds(), { padding: [50, 50] });

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

@@ -93,7 +93,7 @@
     });
 
     element.title.translation = ApiFetcher.findTranslation(element.title.translations);
-    element.description.translation = ApiFetcher.findTranslation(element.description.translations);
+    element.description.translation = ApiFetcher.findTranslation(element.description.translations).replace(/\n/g, "<br>");;
     element.location.translation = ApiFetcher.findTranslation(element.location.translations);
     element.locationHints.translation = ApiFetcher.findTranslation(element.locationHints.translations);
     callback(element, marker);
@@ -107,19 +107,21 @@
     };
     const api = new ApiFetcher(query, variables);
     api.fetchAll((result) => {
-      result.component.meetings.edges.forEach((element) => {
-        if(!element.node) return;
-        
-        if(element.node.coordinates) {
-          element.node.link = component.url + '/meetings/' + element.node.id;
-          createMarker(element.node, callback);
-        }
-      });
+      if(result) {
+        result.component.meetings.edges.forEach((element) => {
+          if(!element.node) return;
+          
+          if(element.node.coordinates) {
+            element.node.link = component.url + '/meetings/' + element.node.id;
+            createMarker(element.node, callback);
+          }
+        });
 
-      if (result.component.meetings.pageInfo.hasNextPage) {
-        fetchMeetings(component, result.component.meetings.pageInfo.endCursor, callback, finalCall);
-      } else {
-        finalCall();
+        if (result.component.meetings.pageInfo.hasNextPage) {
+          fetchMeetings(component, result.component.meetings.pageInfo.endCursor, callback, finalCall);
+        } else {
+          finalCall();
+        }
       }
     });
   };

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

@@ -16,8 +16,19 @@
             edges {
               node {  
                 id
-                title
-                body
+                state
+                title {
+                  translations {
+                    text
+                    locale
+                  }
+                }
+                body {
+                  translations {
+                    text
+                    locale
+                  }
+                }
                 address
                 coordinates {
                   latitude
@@ -47,6 +58,9 @@
       })
     });
 
+    element.title.translation = ApiFetcher.findTranslation(element.title.translations);
+    element.body.translation = ApiFetcher.findTranslation(element.body.translations).replace(/\n/g, "<br>");
+
     callback(element, marker);
   };
 
@@ -57,18 +71,20 @@
     };
     const api = new ApiFetcher(query, variables);
     api.fetchAll((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) {
+        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();
         }
-      });
-      if (result.component.proposals.pageInfo.hasNextPage) {
-        fetchProposals(component, result.component.proposals.pageInfo.endCursor, callback, finalCall);
-      } else {
-        finalCall();
       }
     });
   };