decidim-lausanne-budgets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36a36d8d561f2ddd1be74dc244b39b5185a0b69ed24af6a2842eaca0992af3b7
+  data.tar.gz: 58c89964eb1be6b066ba4079ad74acb68a88556faf7b0d7365db35143057b17c
+SHA512:
+  metadata.gz: 192e193d94b61ba2774bd9df51731da31c8f8bc7024ae899c614d706e7ac67319cdb2ac95ba1ab7df93f46d7c277e616645e8052ad0c74afd6bc3eccf72f24ec
+  data.tar.gz: 3b2fb8897f35352b3dea61f696c42b05ba9ee588842d3ae02a3725b8db3e1a452b9b84ae496c744fa2c0fab8518173a0b4fc05459d4dd2fb534300225001733f

data/README.md

@@ -0,0 +1,141 @@
+<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>
+<h4 align="center">
+    <a href="https://www.octree.ch">Octree</a> |
+    <a href="https://octree.ch/en/contact-us/">Contact Us</a> |
+    <a href="https://blog.octree.ch">Our Blog (FR)</a><br/><br/>
+    <a href="https://decidim.org">Decidim</a> |
+    <a href="https://docs.decidim.org/en/">Decidim Docs</a> |
+    <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>
+</p>
+
+# Public Participatory Budgeting
+
+This repository create a new participatory component, cloned from participatory budgets. It is done on decidim version 0.24.3 exclusively for now.
+
+## Usage
+
+* As a non-connected user, I can insert my personal data, and use it to vote. This data will be checked oveer the official residentship database.
+* As a non-connected user, I have a clear view on the vote process. First insert my personal data, then vote, then finalize my vote.
+
+## Restrictions
+From the original budget component, the following features are not implemented: 
+
+1. Authorizations: You can not define authorizations for this component (as it authorized only registered user)
+2. Percentage rules: we improve the flow for `minimu_project` vote flow only. The others rules are un-tested and highly volatile
+
+## Warning
+This repository was done for the very specific use case of Lausanne City, you probably won't find any usage of this module. 
+
+## Why
+The data-protection law in Switzerland is clear: save the minimal data for a limited amount of time. 
+
+As at Lausanne we see PB have somehow lower participation rates, we decide to experiment around public access. We go through a another strategy than Authorization in order to: 
+
+- Keep the submissions in the context of a PB
+- Be able to remove user data without affecting behaviour
+- Having a nicer UX flow as we now know there is a first step process in PB. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "decidim-lausanne-budgets", git: "https://github.com/octree-gva/decidim-lausanne-budgets"
+```
+
+Then execute:
+
+```bash
+bundle
+bundle exec rails decidim_lausanne_budgets:install:migrations
+bundle exec rails db:migrate
+```
+
+## Testing
+
+The [Rakefile](Rakefile) is shipped with a
+`test_app` using `docker-compose` to run a database.
+If you haven't done it already, [install](https://docs.docker.com/get-docker/) docker](https://docs.docker.com/get-docker/).
+
+```bash
+    bundle exec rake test_app
+```
+## Local development
+For decidim version 0.27, use Gemfile.0.27. For version 0.26, use Gemfile.0.26
+```
+cp Gemfile.0.27 Gemfile
+``` 
+
+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
+# 841ae977c7da
+docker exec -it 841ae977c7da bash
+```
+You are now in bash, run manually. This will check your environment and do migrations if needed
+```
+bundle exec rake decidim_lausanne_budgets:install:migrations
+docker-entrypoint
+```
+
+You are now ready to use your container in the way you want for development:
+
+* Run a rails seed: `bundle exec rails db:seed`
+* Have live-reload on your assets: `bin/webpack-dev-server`
+* Execute tasks, like `bundle exec rails g migration AddSomeColumn`
+* Run the rails server: `bundle exec rails s -b 0.0.0.0`
+* 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
+# 0517244cbdde   decidim-module-lausanne_budgets-decidim-app   "sleep infinity"         20 hours ago   Up 20 hours             0.0.0.0:3000->3000/tcp, :::3000->3000/tcp, 0.0.0.0:3035->3035/tcp, :::3035->3035/tcp   decidim-lausanne-budgets-app
+# 5399fc0c0866   postgres:14-alpine                            "docker-entrypoint.s…"   20 hours ago   Up 20 hours (healthy)   0.0.0.0:5432->5432/tcp, :::5432->5432/tcp                                              decidim-module-lausanne_budgets-pg-1
+```
+
+2. In another terminal, run `docker exec -it 0517244cbdde 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_lausanne_budgets` to access the module directory
+    
+## Contributing
+
+This repository is not yet ready for contributions.
+
+## License
+
+This engine is distributed under the [GNU AFFERO GENERAL PUBLIC LICENSE](LICENSE.md).
+
+<br /><br />
+
+<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" />
+</p>

data/Rakefile

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "decidim/dev/common_rake"
+
+def install_module(path)
+  Dir.chdir(path) do
+    # system("bundle exec rake decidim_vocacity_gem_tasks:install:migrations")
+  end
+end
+
+def seed_db(path)
+  Dir.chdir(path) do
+    system("bundle exec rake db:seed")
+  end
+end
+
+def prepare_database(app_path)
+  # Remove previous existing db, and recreate one.
+  disable_docker_compose = ENV.fetch("DISABLED_DOCKER_COMPOSE", "false") == "true"
+  unless disable_docker_compose
+    system("docker-compose -f docker-compose.yml down -v")
+    system("docker-compose -f docker-compose.yml up -d --remove-orphans")
+  end
+  databaseYml = {
+    "development" => {
+      "adapter" => "postgresql",
+      "encoding" => "unicode",
+      "host" => ENV.fetch("DATABASE_HOST", "localhost"),
+      "port" => ENV.fetch("DATABASE_PORT", "5432").to_i,
+      "username" => ENV.fetch("DATABASE_USERNAME", "decidim"),
+      "password" => ENV.fetch("DATABASE_PASSWORD", "TEST-insecure-password"),
+      "database" => "decidim_dev"
+    },
+    "test" => {
+      "adapter" => "postgresql",
+      "encoding" => "unicode",
+      "host" => ENV.fetch("DATABASE_HOST", "localhost"),
+      "port" => ENV.fetch("DATABASE_PORT", "5432").to_i,
+      "username" => ENV.fetch("DATABASE_USERNAME", "decidim"),
+      "password" => ENV.fetch("DATABASE_PASSWORD", "TEST-insecure-password"),
+      "database" => "decidim_test"
+    }
+  }
+  config_file = File.expand_path("#{app_path}/config/database.yml", __dir__)
+  File.open(config_file, "w") { |f| YAML.dump(databaseYml, f) }
+  Dir.chdir("#{app_path}") do
+     system("bundle exec rails db:create")
+     system("bundle exec rails decidim_lausanne_budgets:install:migrations")
+     system("bundle exec rails db:migrate")
+   end
+end
+
+desc "Generates a dummy app for testing"
+task :test_app do
+  ENV["RAILS_ENV"] = "test"
+  Bundler.with_original_env do
+    generate_decidim_app(
+      "spec/dummy",
+        "--app_name",
+        "decidim_test",
+        "--path",
+        "../..",
+        "--skip_spring",
+        "--demo",
+        "--force_ssl",
+        "false",
+        "--locales",
+        "en,fr,es"
+    )
+    prepare_database("spec/dummy")
+  end
+end
+
+desc "Generates a development app"
+task :development_app do
+  ENV["RAILS_ENV"] = "development"
+  Bundler.with_original_env do
+    generate_decidim_app(
+      "development_app",
+        "--app_name",
+        "decidim_dev",
+        "--path",
+        "..",
+        "--skip_spring",
+        "--demo",
+        "--force_ssl",
+        "false",
+        "--locales",
+        "en,fr,es"
+    )
+    prepare_database("development_app")
+  end
+end

data/app/cells/decidim/lausanne/budgets/base_cell.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      # This cell has the commons for the budgets cells
+      class BaseCell < Decidim::ViewModel
+        include Decidim::LayoutHelper
+        include Decidim::SanitizeHelper
+        include Decidim::ComponentPathHelper
+        include Decidim::Lausanne::Budgets::Engine.routes.url_helpers
+
+        delegate :current_user, :current_settings, :current_component, :current_workflow, to: :controller
+        delegate :settings, to: :current_component
+
+        def budgets_link_list(budgets)
+          budgets.map { |budget| link_to(translated_attribute(budget.title), resource_locator(budget).path) }
+                 .to_sentence
+                 .html_safe
+        end
+      end
+    end
+  end
+end

data/app/cells/decidim/lausanne/budgets/budget_cell.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      # This cell renders the budget card for an instance of a budget
+      # the default size is the Medium Card (:m)
+      class BudgetCell < Decidim::ViewModel
+        include Cell::ViewModel::Partial
+
+        def show
+          cell card_size, model, options
+        end
+
+        private
+
+          def card_size
+            "decidim/lausanne/budgets/budget_m"
+          end
+      end
+    end
+  end
+end

data/app/cells/decidim/lausanne/budgets/budget_information_modal/show.erb

@@ -0,0 +1,21 @@
+<div id="budget-modal-info">
+  <div class="info__header">
+    <h3 class="info__title"><%= decidim_sanitize(component_name) %></h3>
+  </div>
+
+  <%= content_tag(:p, more_information) if more_information %>
+
+  <% unless current_workflow.single? %>
+    <p>
+      <%= link_to t(:back_to, scope: i18n_scope, component_name: component_name), lausanne_budgets_path %>
+    </p>
+  <% end %>
+
+  <div class="row">
+    <div class="columns medium-8 medium-offset-2">
+      <button class="button expanded" data-close>
+        <%= t(:continue, scope: i18n_scope) %>
+      </button>
+    </div>
+  </div>
+</div>

data/app/cells/decidim/lausanne/budgets/budget_information_modal_cell.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      # This cell renders the Budgets component "More information" modal dialog
+      class BudgetInformationModalCell < BaseCell
+        alias budget model
+
+        def more_information
+          translated_attribute(current_settings.more_information_modal).presence || translated_attribute(settings.more_information_modal)
+        end
+
+        def component_name
+          translated_attribute(current_component.name)
+        end
+
+        def i18n_scope
+          "decidim.lausanne_budgets.budget_information_modal"
+        end
+      end
+    end
+  end
+end

data/app/cells/decidim/lausanne/budgets/budget_list_item/show.erb

@@ -0,0 +1,21 @@
+<div class="<%= card_class %>">
+  <div class="card--list__text">
+    <%= link_to lausanne_budget_path(budget), class: link_class do %>
+      <% if voted? && !voting_finished? %>
+        <strong>
+          <%= translated_attribute(title) %>
+          </strong>
+        <span class="button tiny success card--list__check card--list__check--disabled">
+          <%= icon "check", class: "icon--small", role: "img" %>
+        </span>
+      <% else %>
+        <%= translated_attribute(title) %>
+        <% if progress? && !voting_finished? %>
+          <span class="button tiny hollow secondary card--list__check card--list__check--disabled">
+            <%= icon "bookmark", class: "icon--small", role: "img" %>
+          </span>
+        <% end %>
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/app/cells/decidim/lausanne/budgets/budget_list_item_cell.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      # This cell renders the budget item list in the budgets list
+      class BudgetListItemCell < BaseCell
+        delegate :voting_finished?, to: :controller
+
+        property :title
+        property :excerpt
+        alias budget model
+
+        private
+
+          def card_class
+            ["card--list__item"].tap do |list|
+              unless voting_finished?
+                list << "card--list__data-added" if voted?
+                list << "card--list__data-progress" if progress?
+              end
+            end.join(" ")
+          end
+
+          def link_class
+            "card__link card--list__heading"
+          end
+
+          def voted?
+            current_user && status == :voted
+          end
+
+          def progress?
+            current_user && status == :progress
+          end
+
+          def status
+            @status ||= current_workflow.status(budget)
+          end
+      end
+    end
+  end
+end

data/app/cells/decidim/lausanne/budgets/budget_m/data.erb

@@ -0,0 +1,12 @@
+<div class="card__icondata">
+  <ul class="card-data">
+    <li class="card-data__item">
+      <%= icon "euro-outline", class: "icon--big", role: "img", "aria-hidden": true %>
+    </li>
+    <li class="card-data__item">
+      <div class="text-left">
+        <strong class="heading4"><%= budget_to_currency model.total_budget %></strong>
+      </div>
+    </li>
+  </ul>
+</div>

data/app/cells/decidim/lausanne/budgets/budget_m/footer.erb

@@ -0,0 +1,5 @@
+<div class="card__footer">
+  <div class="card__support">
+    <%= link_to t("view", scope: "decidim.lausanne_budgets.budget"), resource_path, class: "card__button button button--sc small" %>
+  </div>
+</div>

data/app/cells/decidim/lausanne/budgets/budget_m_cell.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      # This cell renders the Medium (:m) budget card
+      # for an given instance of a Decidim::Lausanne::Budgets::LausanneBudget
+      class BudgetMCell < Decidim::CardMCell
+        include ActiveSupport::NumberHelper
+        include Decidim::Lausanne::Budgets::ProjectsHelper
+
+        def statuses
+          []
+        end
+      end
+    end
+  end
+end

data/app/cells/decidim/lausanne/budgets/budgets_header/show.erb

@@ -0,0 +1,7 @@
+<div class="row">
+  <div class="columns medium-7 mediumlarge-8">
+    <div class="section">
+      <%= decidim_sanitize(landing_page_content) %>
+    </div>
+  </div>
+</div>

data/app/cells/decidim/lausanne/budgets/budgets_header_cell.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      # This cell renders the Budgets component header
+      class BudgetsHeaderCell < BaseCell
+        private
+
+          def landing_page_content
+            translated_attribute(current_settings.landing_page_content).presence || translated_attribute(settings.landing_page_content)
+          end
+      end
+    end
+  end
+end

data/app/cells/decidim/lausanne/budgets/budgets_list/card_list.erb

@@ -0,0 +1,7 @@
+<div id="lausanne_budgets" class="card card--list card--list--mini">
+  <% budgets.each do |budget| %>
+    <% next if highlighted.include?(budget) && !voting_finished? %>
+
+    <%= cell("decidim/lausanne/budgets/budget_list_item", budget) %>
+  <% end %>
+</div>

data/app/cells/decidim/lausanne/budgets/budgets_list/highlighted.erb

@@ -0,0 +1,11 @@
+<% if highlighted? %>
+  <p id="highlighted-budget">
+    <% highlighted.each do |budget| %>
+      <%= link_to(
+            t("highlighted_cta", scope: i18n_scope,
+            name: translated_attribute(budget.title)),
+            resource_locator(budget).path,
+            class: :button ) %>
+    <% end %>
+  </p>
+<% end %>

data/app/cells/decidim/lausanne/budgets/budgets_list/show.erb

@@ -0,0 +1,20 @@
+<div class="row">
+  <div class="columns medium-7 mediumlarge-8">
+    <% if !voting_finished? && (highlighted? || voted?) %>
+      <div class="section">
+        <h3 class="section-heading">
+          <%= t(:my_budgets, scope: i18n_scope) %>
+        </h3>
+
+        <%= render :highlighted %>
+        <%= render :voted %>
+      </div>
+    <% end %>
+
+    <div class="row">
+      <div class="columns mediumlarge-6">
+        <%= render :card_list %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/cells/decidim/lausanne/budgets/budgets_list/voted.erb

@@ -0,0 +1,43 @@
+<% if voted? %>
+  <div id="voted-budgets">
+    <p class="lead">
+      <%= t(:voted_on, scope: i18n_scope, links: budgets_link_list(voted)) %>
+    </p>
+
+    <% if finished? %>
+      <p class="lead">
+        <%= t(:finished_message, scope: i18n_scope) %>
+      </p>
+    <% end %>
+
+    <% if voting_open? %>
+      <div>
+        <p>
+          <%= t(:if_change_opinion, scope: i18n_scope) %>
+          <%= link_to(
+          t("cancel_order.only_one", scope: i18n_scope),
+          budget_order_path(voted.first),
+          method: :delete,
+          data: { confirm: t("projects.budget_summary.are_you_sure", scope: "decidim.lausanne_budgets") }) if voted.one? %>
+        </p>
+
+        <% if !voted.one? && voted.any? %>
+          <ul>
+            <% voted.each do |budget| %>
+              <li>
+                <%= link_to(
+                            t("cancel_order.more_than_one", scope: i18n_scope, name: translated_attribute(budget.title)),
+                            budget_order_path(budget),
+                            method: :delete,
+                            class: "cancel-order",
+                            data: {
+                              confirm: t("projects.budget_summary.are_you_sure", scope: "decidim.lausanne_budgets")
+                            }) %>
+              </li>
+            <% end %>
+          </ul>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+<% end %>

data/app/cells/decidim/lausanne/budgets/budgets_list_cell.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      # This cell renders the budgets list of a Budget component
+      class BudgetsListCell < BaseCell
+        alias current_workflow model
+
+        delegate :allowed, :budgets, :highlighted, :voted, to: :current_workflow
+        delegate :voting_open?, :voting_finished?, to: :controller
+
+        def show
+          return unless budgets
+          render
+        end
+
+        private
+
+          def highlighted?
+            current_user && highlighted.any?
+          end
+
+          def voted?
+            current_user && voted.any?
+          end
+
+          def finished?
+            return unless budgets.any?
+
+            current_user && (allowed - voted).none?
+          end
+
+          def i18n_scope
+            "decidim.lausanne_budgets.budgets_list"
+          end
+      end
+    end
+  end
+end

data/app/cells/decidim/lausanne/budgets/limit_announcement_cell.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      # This cell renders information when current user can't create more budgets orders.
+      class LimitAnnouncementCell < BaseCell
+        alias budget model
+        delegate :voted?, :vote_allowed?, :discardable, :limit_reached?, to: :current_workflow
+        delegate :voting_open?, to: :controller
+
+        def show
+          cell("decidim/announcement", announcement_message, callout_class: "warning") if announce?
+        end
+
+        private
+
+          def announce?
+            return unless voting_open?
+            return unless current_user
+            return if vote_allowed?(budget)
+            return if voted?(budget)
+
+            discardable.any? || !vote_allowed?(budget, consider_progress: false)
+          end
+
+          def announcement_message
+            if discardable.any?
+              t(:limit_reached, scope: i18n_scope,
+                                links: budgets_link_list(discardable),
+                                landing_path: lausanne_budgets_path)
+            else
+              t(:cant_vote, scope: i18n_scope, landing_path: lausanne_budgets_path)
+            end
+          end
+
+          def should_discard_to_vote?
+            limit_reached? && discardable.any?
+          end
+
+          def i18n_scope
+            "decidim.lausanne_budgets.limit_announcement"
+          end
+      end
+    end
+  end
+end

data/app/cells/decidim/lausanne/budgets/project_cell.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Lausanne
+    module Budgets
+      # This cell renders the budget project card for an instance of a project
+      # the default size is the Medium Card (:m)
+      class ProjectCell < Decidim::ViewModel
+        include Cell::ViewModel::Partial
+
+        def show
+          cell card_size, model, options
+        end
+
+        private
+
+          def card_size
+            "decidim/lausanne/budgets/project_m"
+          end
+      end
+    end
+  end
+end