decidim-accountability 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9d0db9ff68db88ec5363e6fb2128c2940487bbe
+  data.tar.gz: ce9a332bd2dcde8d1a48ed9b3b3872b67a0202a4
+SHA512:
+  metadata.gz: ab4242241dc48f9af57673929a27e1e31ee2a50583de19cfed1128f5b2f8baf4fe4e8638edd2acd1e69b32416e8c0aa1c5af1f7ac47f92fb445926a17633c8db
+  data.tar.gz: 7d81f544cd7050f662fa60bceaca743e90f9604120d78604ec4f16eb7973b46c9b7ed55c61efa49f164a1d963cc5c536c952b719f95b37e513c8cfc75490195b

data/README.md

@@ -0,0 +1,46 @@
+# Decidim::Accountability
+
+[![Build Status](https://www.travis-ci.org/decidim/decidim-accountability.svg?branch=master)](https://www.travis-ci.org/decidim/decidim-accountability)
+
+
+The Accountability module adds results to any participatory process. It adds a CRUD engine to the admin and public views scoped inside the participatory process. Accountability will link to related meetings and proposals and will be used to show the progress on the related proposals.
+
+It also has a CSV importer for results, you can read [here](doc/csv_importer.md) about how it works, the CSV columns and what they mean.
+
+## Usage
+Accountability will be available as a Feature for a Participatory Process.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-accountability'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Migration from `Decidim::Results` module
+To migrate results from Decidim::Results to Decidim::Accountability you can use a rake task like [this one in decidim-barcelona](https://github.com/PopulateTools/decidim-barcelona/blob/accountability/lib/tasks/migrate_results_to_accountability.rake). The task asumes that the accountability feature for the process has already been created. It takes a process ID as an argument, and defaults to 1 if none is provided:
+```bash
+$ bundle exec rake migrate:results_to_accountability[PROCESS_ID]
+``` 
+
+
+## Local development setup
+Clone [decidim-barcelona](https://github.com/PopulateTools/decidim-barcelona), at the same directory level as this `decidim-accountability` clone, and then checkout the `accountability-localdev` branch.
+
+Inside the `decidim-barcelona` directory run:
+
+- `bundle exec rake db:setup`
+- `bundle exec rake test_data:load`
+
+Now you should be able to start a local server with `bundle exec rails s`.
+
+## Contributing
+See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).
+
+## License
+See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).

data/Rakefile

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

data/app/assets/config/decidim_accountability_admin_manifest.js

@@ -0,0 +1 @@
+//= link decidim/accountability/admin/accountability_admin.js

data/app/assets/config/decidim_accountability_manifest.js

@@ -0,0 +1 @@
+//= link decidim/accountability/accountability.js

data/app/assets/images/decidim/accountability/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 35 35"><path d="M17.5 35A17.5 17.5 0 1 1 35 17.5 17.52 17.52 0 0 1 17.5 35zm0-33.06A15.56 15.56 0 1 0 33.06 17.5 15.57 15.57 0 0 0 17.5 1.94zM16 22.48a1 1 0 0 1-.68-.28l-4.08-4a1 1 0 0 1 1.36-1.39l3.4 3.3 8-8.8a1 1 0 0 1 1.44 1.31l-8.69 9.55a1 1 0 0 1-.69.32z"/></svg>

data/app/assets/javascripts/decidim/accountability/accountability.js.es6

@@ -0,0 +1,10 @@
+// = require_self
+
+$(() => {
+  /* Show category list on click when we are on a small scren */
+  if ($(window).width() < 768) {
+    $('.category--section').click((e) => {
+      $(e.currentTarget).next('.category--elements').toggleClass('active');
+    });
+  }
+})

data/app/assets/javascripts/decidim/accountability/admin/accountability_admin.js

@@ -0,0 +1,8 @@
+// = require_self
+
+$("#result_decidim_accountability_status_id").change(function () {
+  progress = $(this).find(':selected').data('progress')
+  if (progress || progress == 0) {
+    $("#result_progress").val(progress);
+  }
+});

data/app/assets/stylesheets/decidim/accountability/_accountability.scss

@@ -0,0 +1 @@
+@import "accountability/*";

data/app/assets/stylesheets/decidim/accountability/accountability/_cards.scss

@@ -0,0 +1,13 @@
+.accountability {
+  .card__link--block {
+    display: block;
+  }
+  .card--list__data {
+    min-width: 7rem;
+  }
+  .card--meta {
+    span {
+      margin-right: 0.5rem;
+    }
+  }
+}

data/app/assets/stylesheets/decidim/accountability/accountability/_categories.scss

@@ -0,0 +1,109 @@
+.accountability {
+  .categories {
+    .categories--header {
+      border-bottom: 1px solid $medium-gray;
+      padding-bottom: 1rem;
+      margin-bottom: 1rem;
+      
+      .icon--arrow-bottom {
+        fill: lighten($dark-gray, 50);
+      }
+      
+      span {
+        text-transform: uppercase;
+        font-size: 1.15rem;
+        color: lighten($dark-gray, 50);
+      }
+    }
+    
+    .categories--group {
+      margin-bottom: 2rem;
+      
+      @include breakpoint(medium) {
+        display: flex;
+        margin-bottom: 4rem;
+      }
+      
+      .category--title {
+        background: $white;
+        padding: 1.5rem 2rem;
+        min-height: 9rem;
+        
+        @include breakpoint(medium) {
+          height: calc(100% - 1.875rem);
+        }
+        
+        p {
+          font-weight: 600;
+          margin-bottom: 0.75rem;
+        }
+
+        .progress {
+          margin-bottom: 0.5rem;
+        }
+        .progress-info {
+          position: relative;
+          margin-bottom: 1.5rem;
+          
+          .progress-figure {
+            display: inline-block;
+          }
+          .category--count {
+            position: absolute;
+            right: 0;
+            top: 0.5rem;
+            color: lighten($dark-gray, 50);
+          }
+        }
+      }
+      
+      .card__link {
+        .category--line {
+          background: $light-gray-dark;
+          border-radius: 4px;
+          min-height: 9rem;
+          padding: 1rem;
+          margin-bottom: 1.875rem;
+          position: relative;
+          
+          strong {
+            font-weight: 600;
+            color: $secondary;
+          }
+          
+          .progress-figure {
+            position: absolute;
+            bottom: 1rem;
+          }
+          .category--count {
+            color: lighten($dark-gray, 50);
+            position: absolute;
+            right: 1rem;
+            bottom: 1rem;
+            font-size: 80%;
+          }
+        }
+        &:hover {
+          .category--count {
+            color: lighten($dark-gray, 50);
+          }
+          strong {
+            color: scale-color($anchor-color, $lightness: -14%);
+          }
+        }
+      }
+    }
+
+    .category--elements.active {
+      display: block !important;
+      
+      .medium-4:first-child {
+        margin-top: 1rem;
+      }
+    }
+    
+    .progress-figure {
+      color: lighten($dark-gray, 50);
+    }
+  }
+}

data/app/assets/stylesheets/decidim/accountability/accountability/_lines_breadcrumb.scss

@@ -0,0 +1,29 @@
+.lines-breadcrumb {
+  margin-bottom: 2rem;
+  
+  .breadcrumb--separator {
+    color: darken($light-gray, 40);
+    padding: 0 0.25rem;
+  }
+  
+  div {
+    display: inline-block;
+  }
+  
+  a {
+    font-weight: 600;
+    color: $dark-gray;
+  }
+  
+  ul {
+    list-style: none;
+    margin-left: 0;
+  }
+  
+  .percentage {
+    color: darken($light-gray, 40);
+    font-weight: 400;
+    padding-left: 0.15rem;
+    display: inline-block;
+  }
+}

data/app/assets/stylesheets/decidim/accountability/accountability/_results.scss

@@ -0,0 +1,144 @@
+.accountability {
+  .intro {
+    ul {
+      margin-bottom: 1rem;
+    }
+    .progress-level {
+      background: $white;
+      padding: 1.5rem 1.75rem;
+
+      p {
+        font-weight: 600;
+        text-transform: uppercase;
+        margin-bottom: 0.25rem;
+        display: inline-block;
+        margin-right: 0.5rem;
+        font-size: 1.25rem;
+      }
+
+      .icon {
+        background: lighten($dark-gray, 50);
+        border-radius: 50%;
+        fill: white;
+        padding: 0.15rem;
+      }
+
+      .progress {
+        max-width: 85%;
+        margin-bottom: 0;
+      }
+
+      .progress-figure {
+        font-size: 2.5rem;
+        font-weight: 300;
+        color: lighten($dark-gray, 50);
+        
+        @include breakpoint(medium) {
+          font-size: 4rem;
+        }
+      }
+    }
+  }
+
+  .scope-filters {
+    div {
+      color: lighten($dark-gray, 50);
+      text-transform: uppercase;
+      margin-bottom: 0.15rem;
+    }
+    span {
+      margin-right: 0.5rem;
+    }
+    ul {
+      display: inline;
+    }
+    li.active {
+      background-color: $medium-gray;
+    }
+  }
+
+  .description {
+    margin-bottom: 1rem;
+  }
+  .title-action {
+    margin-bottom: 0.5rem;
+  }
+}
+
+.result-view {
+  .title {
+    display: flex;
+    align-items: flex-start;
+    margin-bottom: 1rem;
+    flex-direction: column;
+
+    .icon {
+      fill: $secondary;
+      min-width: 1.5rem;
+      min-height: 1.5rem;
+      margin-bottom: 0.5rem;
+      
+      @include breakpoint(medium) {
+        margin-right: 0.75rem;
+        margin-top: 0.5rem;
+      }
+    }
+    
+    @include breakpoint(medium) {
+      flex-direction: row;
+    }
+  }
+
+  .progress-level {
+    background: $white;
+    border-radius: 4px;
+    padding: 1.5rem;
+    border: 1px solid $medium-gray;
+
+    .progress-label {
+      display: flex;
+      justify-content: space-between;
+      align-items: flex-end;
+      margin-bottom: 0.5rem;
+
+      .progress-text {
+        text-transform: uppercase;
+        color: lighten($dark-gray, 30);
+      }
+      .progress-figure {
+        line-height: 1;
+        font-size: 2.25rem;
+        font-weight: 600;
+      }
+    }
+  }
+  
+  .result-description div {
+    margin-bottom: 1rem;
+  }
+
+  .result-meta {
+    margin-bottom: 0.5rem;
+    font-size: 1.25rem;
+
+    .result-meta--label {
+      font-weight: 600;
+      color: lighten($dark-gray, 30);
+    }
+    .result-meta--data {
+      font-size: 1.15rem;
+    }
+  }
+
+  hr {
+    width: 100%;
+    margin: 0 0 3rem 0;
+  }
+  
+  .timeline {
+    .timeline__info {
+      background-color: transparent;
+      border: none;
+    }
+  }
+}

data/app/commands/decidim/accountability/admin/create_result.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    module Admin
+      # This command is executed when the user creates a Result from the admin
+      # panel.
+      class CreateResult < Rectify::Command
+        def initialize(form)
+          @form = form
+        end
+
+        # Creates the result if valid.
+        #
+        # Broadcasts :ok if successful, :invalid otherwise.
+        def call
+          return broadcast(:invalid) if @form.invalid?
+
+          transaction do
+            create_result
+            link_meetings
+            link_proposals
+          end
+
+          broadcast(:ok)
+        end
+
+        private
+
+        attr_reader :result
+
+        def create_result
+          @result = Result.create!(
+            feature: @form.current_feature,
+            scope: @form.scope,
+            category: @form.category,
+            parent_id: @form.parent_id,
+            title: @form.title,
+            description: @form.description,
+            external_id: @form.external_id,
+            start_date: @form.start_date,
+            end_date: @form.end_date,
+            progress: @form.progress,
+            decidim_accountability_status_id: @form.decidim_accountability_status_id
+          )
+        end
+
+        def proposals
+          @proposals ||= result.sibling_scope(:proposals).where(id: @form.proposal_ids)
+        end
+
+        def meeting_ids
+          @meeting_ids ||= proposals.flat_map do |proposal|
+            proposal.linked_resources(:meetings, "proposals_from_meeting").pluck(:id)
+          end.uniq
+        end
+
+        def meetings
+          @meetings ||= result.sibling_scope(:meetings).where(id: meeting_ids)
+        end
+
+        def link_proposals
+          result.link_resources(proposals, "included_proposals")
+        end
+
+        def link_meetings
+          result.link_resources(meetings, "meetings_through_proposals")
+        end
+      end
+    end
+  end
+end