decidim-initiatives 0.9.1

data/README.md

@@ -0,0 +1,118 @@
+# Decidim::Initiatives
+
+Initiatives is the place on Decidim's where citizens can promote a civic initiative. Unlike
+participatory processes that must be created by an administrator, Civic initiatives can be
+created by any user of the platform.
+
+An initiative will contain attachments and comments from other users as well.
+
+Prior to be published an initiative must be technically validated. All the validation
+process and communication between the platform administrators and the sponsorship
+committee is managed via an administration UI.
+
+## Usage
+
+This plugin provides:
+
+* A CRUD engine to manage initiatives.
+
+* Public views for initiatives via a high level section in the main menu.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-initiatives'
+```
+
+And then execute:
+```bash
+$ bundle
+$ bundle exec rails decidim_initiatives:install:migrations
+$ bundle exec rails db:migrate
+```
+
+## Database
+
+The database requires the extension pg_trgm enabled. Contact your DBA to enable it.
+
+```sql
+CREATE EXTENSION pg_trgm;
+```
+
+## Rake tasks
+
+This engine comes with three rake tasks that should be executed on daily basis. The best 
+way to execute these tasks is using cron jobs. You can manage this cron jobs in your
+Rails application using the [Whenever GEM](https://github.com/javan/whenever) or even
+creating them by hand.
+
+### decidim_initiatives:check_validating
+
+This task move all initiatives in validation phase without changes for the amount of 
+time defined in __Decidim::Initiatives::max_time_in_validating_state__. These initiatives
+will be moved to __discarded__ state.
+
+### decidim_initiatives:check_published
+
+This task retrieves all published initiatives whose support method is online and the support
+period has expired. Initiatives that have reached the minimum supports required will pass
+to state __accepted__. The initiatives without enough supports will pass to __rejected__ state.
+
+Initiatives with offline support method enabled (pure offline or mixed) will get its status updated
+after the presential supports have been registered into the system.
+
+### decidim_initiatives:notify_progress
+
+This task sends notification mails when initiatives reaches the support percentages defined in
+__Decidim::Initiatives.first_notification_percentage__ and __Decidim::Initiatives.second_notification_percentage__.
+
+Author, members of the promoter committee and followers will receive it.
+
+## Exporting online votes.
+
+When the supporting method is set to any or face to face it may be necessary to implement
+a mechanism to validate that do not exist duplicated supports. To do so the engine provides
+a functionality that allows exporting the online votes to validate them against physical
+votes.
+
+The votes are exported as a hash string in order to preserve the identity of the voter. 
+Each hash is composed with the following criteria:
+
+* Algorithm used: SHA1
+* Format of the string hashed: "#{unique_id}#{title}#{description}"
+
+There are some considerations that you must keep in mind:
+
+* Title and description will be hashed using the same format included in the database, this is including html tags.
+* Title and description will be hashed using the same locale used by the initiative author. In case there is more
+  than one locale available be sure that you change your locale settings to be inline with
+  the locale used to generate the hashes outside Decidim.
+
+## Seeding example data
+
+In order to populate the database with example data proceed as usual in rails:
+```bash
+$ bundle exec rails db:seed
+```
+
+## Aditional considerations
+
+### Cookies
+This engine makes use of cookies to store large form data. You should change the 
+default session store or you might experience problems.
+
+Check the [Rails configuration guide](http://guides.rubyonrails.org/configuring.html#rails-general-configuration) 
+in order to get instructions about changing the default session store.
+
+### Translations
+There are some legal texts that are adapted for Barcelona's city council. You should
+adapt them for your decidim instance. The files that you need to check are:
+
+* app/views/decidim/initiatives/_legal_text.*.html.erb
+
+## Contributing
+See [Decidim](https://github.com/decidim/decidim).
+
+## License
+See [Decidim](https://github.com/decidim/decidim).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'decidim/dev/common_rake'

data/app/assets/config/admin_decidim_initiatives_manifest.js

@@ -0,0 +1,3 @@
+//= link decidim/initiatives/admin/invite_users.js
+//= link decidim/initiatives/scoped_type.js
+//= link decidim/initiatives/print-initiative.css

data/app/assets/config/decidim_initiatives_manifest.js

@@ -0,0 +1,7 @@
+//= link decidim/initiatives/social_share.js
+//= link decidim/initiatives/application.js
+//= link decidim/initiatives/application.css
+//= link decidim/initiatives/social_share.css
+//= link decidim/initiatives/identity_selector_dialog.js
+//= link decidim/initiatives/scoped_type.js
+//= link decidim/initiatives/admin/invite_users.js

data/app/assets/javascripts/decidim/initiatives/admin/invite_users.js

@@ -0,0 +1,24 @@
+(function () {
+  'use strict';
+
+  var inviteUsersButton = document.querySelector('.invite-users-link');
+
+  if (inviteUsersButton !== null) {
+    inviteUsersButton.addEventListener('click', function (event) {
+      var link = document.querySelector('#committee_link'),
+          range = document.createRange();
+
+      event.preventDefault();
+
+      range.selectNode(link);
+      window.getSelection().addRange(range);
+
+      try {
+        document.execCommand('copy');
+      } catch (err) {
+      }
+
+      window.getSelection().removeAllRanges();
+    });
+  }
+}());

data/app/assets/javascripts/decidim/initiatives/application.js

@@ -0,0 +1 @@
+// = require decidim/editor

data/app/assets/javascripts/decidim/initiatives/identity_selector_dialog.js

@@ -0,0 +1,17 @@
+$(document).ready(function () {
+  'use strict';
+
+  var userIdentitiesDialog = $('#user-identities'),
+      button = $('#select-identity-button'),
+      refreshUrl;
+
+  if (userIdentitiesDialog.length) {
+    refreshUrl = userIdentitiesDialog.data('refresh-url');
+
+    button.click(function () {
+      $.ajax(refreshUrl).done(function(response){
+        userIdentitiesDialog.html(response).foundation('open');
+      });
+    });
+  }
+});

data/app/assets/javascripts/decidim/initiatives/scoped_type.js

@@ -0,0 +1,35 @@
+$(document).ready(function () {
+  'use strict';
+
+  var typeSelector = $('[data-scope-selector]'),
+      refresh,
+      targetElement,
+      currentValue,
+      searchUrl;
+
+  if (typeSelector.length) {
+    targetElement = $('#' + typeSelector.data('scope-selector'));
+    currentValue = typeSelector.data('scope-id');
+    searchUrl = typeSelector.data('scope-search-url');
+
+    if (targetElement.length) {
+      refresh = function () {
+        $.ajax({
+          url: searchUrl,
+          cache: false,
+          dataType: 'html',
+          data: {
+            type_id: typeSelector.val(),
+            selected: currentValue
+          },
+          success: function (data) {
+            targetElement.html(data);
+          }
+        });
+      };
+
+      typeSelector.change(refresh);
+      refresh();
+    }
+  }
+});

data/app/assets/javascripts/decidim/initiatives/social_share.js

@@ -0,0 +1,2 @@
+// = require social-share-button
+// = require_self

data/app/assets/stylesheet/decidim/initiatives/admin.css.scss

@@ -0,0 +1,34 @@
+.committee_link {
+  border: 1px solid lightgray;
+
+  float: left;
+  padding: 0.85em 1em;
+  width: auto;
+}
+
+.invite-users-link {
+  padding: 0.85em 1em;
+}
+
+#initiatives_type_remove_banner_image {
+  display: none;
+}
+
+#initiatives_type_remove_banner_image + label {
+  display: none;
+}
+
+.text-right {
+  text-align: right !important;
+}
+
+.white-button {
+  color: #599aa6;
+  background: white;
+}
+
+.white-button:hover {
+  color: #599aa6;
+  background: white;
+  font-weight: bold;
+}

data/app/assets/stylesheet/decidim/initiatives/application.css.scss

@@ -0,0 +1,82 @@
+@import "decidim/editor";
+@import "popularity_item";
+@import "statistics";
+@import "admin";
+
+.ql-formats {
+  .ql-video {
+    margin: 0;
+  }
+}
+
+.initiative-status {
+  float: left;
+  margin-right: .5rem;
+}
+
+.supports-list {
+  .author {
+    margin-right: 15px;
+
+    .author__name {
+      color: #599aa6;
+    }
+  }
+}
+
+.initiative-authors {
+  padding-left: 0 !important;
+
+  .publish-date {
+    display: inline-block;
+    margin-left: -10px;
+  }
+
+  .author {
+    margin-right: 15px;
+  }
+
+  .author__avatar--small {
+    margin-left: 0 !important;
+  }
+
+  .author__name {
+    margin-left: 25px;
+  }
+}
+
+.pull-left {
+  float: left;
+}
+
+.pull-right {
+  float: right;
+}
+
+.lowercase {
+  text-transform: lowercase !important;
+}
+
+.initiative-creation-header__container {
+  position: relative;
+  z-index: 1;
+  padding: 0 0 0 1rem;
+  background: #fafafa;
+
+  .initiative-creation-header__phase {
+    background: #fafafa;
+    color: #fff;
+    text-align: center;
+    padding: 0 1rem;
+    margin-left: -1rem;
+
+    .caption {
+      color: #8c838a;
+      font-size: .9em;
+    }
+  }
+}
+
+.legal_text {
+  font-size: 8pt;
+}

data/app/assets/stylesheet/decidim/initiatives/popularity_item.css.scss

@@ -0,0 +1,61 @@
+.popularity {
+  min-width: 100px;
+  margin-top: 5px
+}
+
+.popularity::before, .popularity::after {
+  display: table;
+  content: ' '
+}
+
+.popularity::after {
+  clear: both
+}
+
+.popularity.extra__popularity {
+  margin-top: 1.5rem;
+  margin-bottom: 1.5rem
+}
+
+.popularity__desc {
+  color: #8c838a;
+  text-transform: uppercase;
+  font-size: 90%;
+  padding-top: .3rem;
+  display: block;
+  clear: both
+}
+
+.popularity__item {
+  float: left;
+  width: 18.4%;
+  height: 4px;
+  background-color: lightgrey;
+  margin-left: 2%
+}
+
+.popularity__item:first-of-type {
+  margin-left: 0
+}
+
+.popularity--level1 .popularity__item:first-of-type, .popularity--level2 .popularity__item:first-of-type, .popularity--level3 .popularity__item:first-of-type, .popularity--level4 .popularity__item:first-of-type, .popularity--level5 .popularity__item:first-of-type, .popularity--level6 .popularity__item:first-of-type {
+  background: #53c9c8
+}
+
+.popularity--level2 .popularity__item:nth-of-type(2), .popularity--level3 .popularity__item:nth-of-type(2), .popularity--level4 .popularity__item:nth-of-type(2), .popularity--level5 .popularity__item:nth-of-type(2), .popularity--level6 .popularity__item:nth-of-type(2) {
+  background: -webkit-linear-gradient(left, #53c9c8, #f9bc48);
+  background: linear-gradient(to right, #53c9c8, #f9bc48)
+}
+
+.popularity--level3 .popularity__item:nth-of-type(3), .popularity--level4 .popularity__item:nth-of-type(3), .popularity--level5 .popularity__item:nth-of-type(3), .popularity--level6 .popularity__item:nth-of-type(3) {
+  background: #f9bc48
+}
+
+.popularity--level4 .popularity__item:nth-of-type(4), .popularity--level5 .popularity__item:nth-of-type(4), .popularity--level6 .popularity__item:nth-of-type(4) {
+  background: -webkit-linear-gradient(left, #f9bc48 50%, #f85a39);
+  background: linear-gradient(to right, #f9bc48 50%, #f85a39)
+}
+
+.popularity--level5 .popularity__item:nth-of-type(5), .popularity--level6 .popularity__item:nth-of-type(5) {
+  background: #f85a39
+}

data/app/assets/stylesheet/decidim/initiatives/print-initiative.css.scss

@@ -0,0 +1,125 @@
+@media all {
+  .initiative-letterhead {
+    font-size: 14pt;
+    font-weight: bold;
+
+    img {
+      margin-right: 5pt;
+    }
+  }
+
+  .initiative-print-title {
+    border: 1pt solid black;
+    margin: 15pt 0;
+    font-size: 12pt;
+    font-weight: bold;
+    text-transform: uppercase;
+    text-align: center;
+  }
+
+  .print-table {
+    width: 100%;
+    display: block;
+    border: 1pt solid black;
+
+    .print-table-header {
+      background-color: lightgray;
+      display: inline-block;
+      width: 100%;
+      text-transform: uppercase;
+      padding-left: 5pt;
+      font-size: 12pt;
+      font-weight: bold;
+      border-bottom: 1pt solid black;
+    }
+
+    .print-table-row {
+      width: 100%;
+      display: inline-block;
+      min-height: 33pt;
+      border-bottom: 1pt solid black;
+    }
+
+    .print-table-row:after {
+      content: '';
+      display: inline-block;
+      clear: both;
+    }
+
+    .print-table-row:last-child {
+      border-bottom: 0;
+    }
+
+    .print-table-cell {
+      padding-left: 5pt;
+      display: inline-block;
+      float: left;
+      border-right: 1pt solid black;
+      min-height: 36pt;
+
+      .cell-content {
+        font-size: 10pt;
+        word-wrap: break-word;
+      }
+    }
+
+    .checkbox-cell {
+      width: 36pt;
+    }
+
+    .print-table-cell:last-child {
+      border-right: 0;
+    }
+
+    .w33 {
+      width: 33%;
+    }
+
+    .w66 {
+      width: 66%;
+    }
+
+    .w50 {
+      width: 50%;
+    }
+  }
+
+  .no-border {
+    border: none !important;
+  }
+
+  .print-section-title {
+    font-size: 12pt;
+    font-weight: bold;
+    margin-top: 15pt;
+    text-transform: uppercase;
+  }
+
+  .print-initiative-legal-text {
+    font-size: 10pt;
+    margin-top: 80pt;
+  }
+}
+
+@page {
+  size: A4;
+  margin: 17mm 17mm 11mm 11mm;
+}
+
+@media print {
+  .title-bar {
+    display: none;
+  }
+
+  .layout-nav {
+    display: none;
+  }
+
+  .button.expanded {
+    display: none;
+  }
+
+  .page-break {
+    page-break-before: auto;
+  }
+}