decidim-accountability 0.1.0

data/config/locales/fi.yml

@@ -0,0 +1,77 @@
+fi:
+  activemodel:
+    attributes:
+      result:
+        decidim_category_id: Kategoria
+        decidim_scope_id: Konteksti
+        description: Kuvaus
+        proposal_ids: Sisällytetyt ehdotukset
+        title: Otsikko
+  decidim:
+    features:
+      accountability:
+        name: Tulokset
+        settings:
+          global:
+            comments_enabled: Kommentointi sallittu
+          step:
+            comments_blocked: Kommentointi estetty
+    resource_links:
+      included_proposals:
+        result_proposals: Projektit, jotka sisältyvät tähän tulokseen
+      meetings_through_proposals:
+        result_meetings: Liittyvät tapaamiset
+    accountability:
+      actions:
+        confirm_destroy: Oletko varma, että haluat poistaa tämän tuloksen?
+        destroy: Poista
+        edit: Muokkaa
+        new: Uusi %{name}
+        title: Toiminnot
+      admin:
+        models:
+          result:
+            name: Tulos
+        results:
+          create:
+            invalid: Tuloksen luonnissa tapahtui virhe
+            success: Tulos luotu onnistuneesti
+          destroy:
+            success: Tulos poistettu onnistuneesti
+          edit:
+            title: Muokkaa tulosta
+            update: Päivitä tulos
+          index:
+            title: Tulokset
+          new:
+            create: Luo tulos
+            title: Uusi tulos
+          update:
+            invalid: Tuloksen päivityksessä tapahtui virhe
+            success: Tulos päivitetty onnistuneesti
+      models:
+        result:
+          fields:
+            title: Otsikko
+      results:
+        count:
+          results_count:
+            one: 1 tulos
+            other: "%{count} tulosta"
+        filters:
+          category: Kategoria
+          scopes: Konteksti
+          search: Haku
+        filters_small_view:
+          close_modal: Sulje ikkuna
+          filter: Suodata
+          filter_by: Suodata
+          unfold: Avaa
+        show:
+          stats:
+            attendees: Osallistujat
+            comments: Kommentit
+            contributions: Kontribuutiot
+            meetings: Tapaamiset
+            proposals: Ehdotukset
+            votes: Kannatukset

data/db/migrate/20170425154712_create_accountability_statuses.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateAccountabilityStatuses < ActiveRecord::Migration[5.0]
+  def change
+    create_table :decidim_accountability_statuses do |t|
+      t.string :key
+      t.jsonb :name
+      t.references :decidim_feature, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20170426104125_create_accountability_results.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class CreateAccountabilityResults < ActiveRecord::Migration[5.0]
+  def change
+    create_table :decidim_accountability_results do |t|
+      t.jsonb :title
+      t.jsonb :description
+      t.string :reference
+      t.date :start_date
+      t.date :end_date
+      t.decimal :progress, precision: 5, scale: 2
+      t.string :external_id, index: true
+      t.references :parent, index: { name: :decidim_accountability_results_on_parent_id }
+      t.references :decidim_accountability_status, index: { name: :decidim_accountability_results_on_status_id }
+      t.references :decidim_feature, index: true
+      t.references :decidim_scope, index: true
+      t.references :decidim_category, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20170508104902_add_description_and_progress_to_statuses.rb

@@ -0,0 +1,6 @@
+class AddDescriptionAndProgressToStatuses < ActiveRecord::Migration[5.0]
+  def change
+    add_column :decidim_accountability_statuses, :description, :jsonb
+    add_column :decidim_accountability_statuses, :progress, :integer
+  end
+end

data/db/migrate/20170508161109_create_template_texts.rb

@@ -0,0 +1,14 @@
+class CreateTemplateTexts < ActiveRecord::Migration[5.0]
+  def change
+    create_table :decidim_accountability_template_texts do |t|
+      t.jsonb :intro
+      t.jsonb :categories_label
+      t.jsonb :subcategories_label
+      t.jsonb :heading_parent_level_results
+      t.jsonb :heading_leaf_level_results
+      t.references :decidim_feature, index: { name: :decidim_accountability_template_texts_on_feature_id }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20170606102902_add_index_to_accountability_results_on_external_id.rb

@@ -0,0 +1,5 @@
+class AddIndexToAccountabilityResultsOnExternalId < ActiveRecord::Migration[5.0]
+  def change
+    add_index :decidim_accountability_results, [:decidim_feature_id, :external_id], unique: true, name: :decidim_accountability_results_on_external_id
+  end
+end

data/db/migrate/20170620154712_create_accountability_timeline_entries.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateAccountabilityTimelineEntries < ActiveRecord::Migration[5.0]
+  def change
+    create_table :decidim_accountability_timeline_entries do |t|
+      t.date :entry_date, index: true
+      t.jsonb :description
+      t.references :decidim_accountability_result, index: { name: :index_decidim_accountability_timeline_entries_on_results_id }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20170623094200_migrate_accountability_results_category.rb

@@ -0,0 +1,13 @@
+class MigrateAccountabilityResultsCategory < ActiveRecord::Migration[5.1]
+  def change
+    # Create categorizations ensuring database integrity
+    execute('
+      INSERT INTO decidim_categorizations(decidim_category_id, categorizable_id, categorizable_type, created_at, updated_at)
+        SELECT decidim_category_id, decidim_accountability_results.id, \'Decidim::Accountability::Result\', NOW(), NOW()
+        FROM decidim_accountability_results
+        INNER JOIN decidim_categories ON decidim_categories.id = decidim_accountability_results.decidim_category_id
+    ')
+    # Remove unused column
+    remove_column :decidim_accountability_results, :decidim_category_id
+  end
+end

data/db/migrate/20170623144902_add_children_counter_cache_to_results.rb

@@ -0,0 +1,5 @@
+class AddChildrenCounterCacheToResults < ActiveRecord::Migration[5.0]
+  def change
+    add_column :decidim_accountability_results, :children_count, :integer, default: 0
+  end
+end

data/lib/decidim/accountability.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "decidim/accountability/admin"
+require "decidim/accountability/list_engine"
+require "decidim/accountability/admin_engine"
+require "decidim/accountability/feature"
+
+module Decidim
+  # Base module for this engine.
+  module Accountability
+  end
+end

data/lib/decidim/accountability/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # This module contains all the domain logic associated to Decidim's Results
+    # component admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/accountability/admin_engine.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Accountability
+    # This is the engine that runs on the admin interface of `decidim-accountability`.
+    # It mostly handles rendering the created results and projects associated to a
+    # participatory process.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::Accountability::Admin
+
+      paths["db/migrate"] = nil
+
+      routes do
+        resource :template_texts
+        resources :statuses
+        resources :results, except: [:show] do
+          resources :timeline_entries, except: [:show]
+        end
+        resource :import, only: [:new, :create]
+        root to: "results#index"
+      end
+
+      def load_seed
+        nil
+      end
+
+      initializer "decidim_accountability.assets" do |app|
+        app.config.assets.precompile += %w(decidim_accountability_admin_manifest.js)
+      end
+    end
+  end
+end

data/lib/decidim/accountability/feature.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_dependency "decidim/features/namer"
+
+Decidim.register_feature(:accountability) do |feature|
+  feature.engine = Decidim::Accountability::ListEngine
+  feature.admin_engine = Decidim::Accountability::AdminEngine
+  feature.icon = "decidim/accountability/icon.svg"
+  feature.stylesheet = "decidim/accountability/accountability"
+
+  feature.on(:before_destroy) do |instance|
+    raise StandardError, "Can't remove this feature" if Decidim::Accountability::Result.where(feature: instance).any?
+  end
+
+  feature.register_resource do |resource|
+    resource.model_class_name = "Decidim::Accountability::Result"
+    resource.template = "decidim/accountability/results/linked_results"
+  end
+
+  feature.settings(:global) do |settings|
+    settings.attribute :comments_enabled, type: :boolean, default: true
+  end
+
+  feature.settings(:step) do |settings|
+    settings.attribute :comments_blocked, type: :boolean, default: false
+  end
+
+  feature.seeds do
+    Decidim::ParticipatoryProcess.all.each do |process|
+      next unless process.steps.any?
+
+      feature = Decidim::Feature.create!(
+        name: Decidim::Features::Namer.new(process.organization.available_locales, :accountability).i18n_name,
+        manifest_name: :accountability,
+        published_at: Time.current,
+        participatory_process: process
+      )
+
+      5.times do |i|
+        Decidim::Accountability::Status.create!(
+          feature: feature,
+          name: Decidim::Faker::Localized.word,
+          key: "status_#{i}"
+        )
+      end
+
+      3.times do
+        result = Decidim::Accountability::Result.create!(
+          feature: feature,
+          scope: process.organization.scopes.sample,
+          category: process.categories.sample,
+          title: Decidim::Faker::Localized.sentence(2),
+          description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+            Decidim::Faker::Localized.paragraph(3)
+          end
+        )
+
+        Decidim::Comments::Seed.comments_for(result)
+
+        3.times do
+          child_result = Decidim::Accountability::Result.create!(
+            feature: feature,
+            parent: result,
+            start_date: Date.today,
+            end_date: Date.today + 10,
+            status: Decidim::Accountability::Status.all.sample,
+            progress: rand(1..100),
+            title: Decidim::Faker::Localized.sentence(2),
+            description: Decidim::Faker::Localized.wrapped("<p>", "</p>") do
+              Decidim::Faker::Localized.paragraph(3)
+            end
+          )
+
+          rand(0..5).times do |i|
+            child_result.timeline_entries.create!(
+              entry_date: child_result.start_date + i.days,
+              description: Decidim::Faker::Localized.sentence(2)
+            )
+          end
+
+          Decidim::Comments::Seed.comments_for(child_result)
+        end
+      end
+    end
+  end
+end

data/lib/decidim/accountability/list_engine.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "searchlight"
+require "kaminari"
+
+module Decidim
+  module Accountability
+    # This is the engine that runs on the public interface of `decidim-accountability`.
+    # It mostly handles rendering the created results associated to a participatory
+    # process.
+    class ListEngine < ::Rails::Engine
+      isolate_namespace Decidim::Accountability
+
+      routes do
+        resources :results, only: [:index, :show] do
+          resource :result_widget, only: :show, path: "embed"
+        end
+        get "csv", to: "results#csv"
+        root to: "results#home"
+      end
+
+      initializer "decidim_accountability.assets" do |app|
+        app.config.assets.precompile += %w(decidim_accountability_manifest.js)
+      end
+    end
+  end
+end

data/lib/decidim/accountability/test/factories.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "decidim/faker/localized"
+require "decidim/dev"
+
+FactoryGirl.define do
+  factory :accountability_feature, parent: :feature do
+    name { Decidim::Features::Namer.new(participatory_space.organization.available_locales, :accountability).i18n_name }
+    manifest_name :accountability
+    participatory_space { create(:participatory_process, :with_steps, organization: organization) }
+  end
+
+  factory :accountability_template_texts, class: Decidim::Accountability::TemplateTexts do
+    feature { build(:feature, manifest_name: "accountability") }
+    intro { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(4) } }
+    categories_label { Decidim::Faker::Localized.word }
+    subcategories_label { Decidim::Faker::Localized.word }
+    heading_parent_level_results { Decidim::Faker::Localized.word }
+    heading_leaf_level_results { Decidim::Faker::Localized.word }
+  end
+
+  factory :accountability_status, class: Decidim::Accountability::Status do
+    feature { build(:feature, manifest_name: "accountability") }
+    sequence(:key) { |n| "status_#{n}" }
+    name { Decidim::Faker::Localized.word }
+    description { Decidim::Faker::Localized.sentence(3) }
+    progress { rand(1..100) }
+  end
+
+  factory :accountability_result, class: Decidim::Accountability::Result do
+    feature { build(:feature, manifest_name: "accountability") }
+    title { Decidim::Faker::Localized.sentence(3) }
+    description { Decidim::Faker::Localized.wrapped("<p>", "</p>") { Decidim::Faker::Localized.sentence(4) } }
+    start_date { "12/7/2017" }
+    end_date { "30/9/2017" }
+    status { create :accountability_status, feature: feature }
+    progress { rand(1..100) }
+  end
+
+  factory :accountability_timeline_entry, class: Decidim::Accountability::TimelineEntry do
+    result { build(:accountability_result) }
+    entry_date { "12/7/2017" }
+    description { Decidim::Faker::Localized.sentence(2) }
+  end
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: decidim-accountability
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amaia Castro
+- Josep Jaume Rey Peroy
+- Marc Riera Casals
+- Oriol Gual Oliva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: decidim-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: decidim-comments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: decidim-dev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: decidim-comments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: decidim-meetings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: decidim-proposals
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An accountability component for decidim's participatory processes.
+email:
+- amaia.castro@gmail.com
+- josepjaume@gmail.com
+- mrc2407@gmail.com
+- oriolgual@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/decidim_accountability_admin_manifest.js
+- app/assets/config/decidim_accountability_manifest.js
+- app/assets/images/decidim/accountability/icon.svg
+- app/assets/javascripts/decidim/accountability/accountability.js.es6
+- app/assets/javascripts/decidim/accountability/admin/accountability_admin.js
+- app/assets/stylesheets/decidim/accountability/_accountability.scss
+- app/assets/stylesheets/decidim/accountability/accountability/_cards.scss
+- app/assets/stylesheets/decidim/accountability/accountability/_categories.scss
+- app/assets/stylesheets/decidim/accountability/accountability/_lines_breadcrumb.scss
+- app/assets/stylesheets/decidim/accountability/accountability/_results.scss
+- app/commands/decidim/accountability/admin/create_result.rb
+- app/commands/decidim/accountability/admin/create_status.rb
+- app/commands/decidim/accountability/admin/create_timeline_entry.rb
+- app/commands/decidim/accountability/admin/update_result.rb
+- app/commands/decidim/accountability/admin/update_status.rb
+- app/commands/decidim/accountability/admin/update_template_texts.rb
+- app/commands/decidim/accountability/admin/update_timeline_entry.rb
+- app/controllers/decidim/accountability/admin/application_controller.rb
+- app/controllers/decidim/accountability/admin/imports_controller.rb
+- app/controllers/decidim/accountability/admin/results_controller.rb
+- app/controllers/decidim/accountability/admin/statuses_controller.rb
+- app/controllers/decidim/accountability/admin/template_texts_controller.rb
+- app/controllers/decidim/accountability/admin/timeline_entries_controller.rb
+- app/controllers/decidim/accountability/application_controller.rb
+- app/controllers/decidim/accountability/result_widgets_controller.rb
+- app/controllers/decidim/accountability/results_controller.rb
+- app/forms/decidim/accountability/admin/result_form.rb
+- app/forms/decidim/accountability/admin/status_form.rb
+- app/forms/decidim/accountability/admin/template_texts_form.rb
+- app/forms/decidim/accountability/admin/timeline_entry_form.rb
+- app/helpers/decidim/accountability/application_helper.rb
+- app/models/decidim/accountability/application_record.rb
+- app/models/decidim/accountability/result.rb
+- app/models/decidim/accountability/status.rb
+- app/models/decidim/accountability/template_texts.rb
+- app/models/decidim/accountability/timeline_entry.rb
+- app/services/decidim/accountability/csv_exporter.rb
+- app/services/decidim/accountability/csv_importer.rb
+- app/services/decidim/accountability/result_search.rb
+- app/services/decidim/accountability/result_stats_calculator.rb
+- app/services/decidim/accountability/results_calculator.rb
+- app/views/decidim/accountability/admin/imports/new.html.erb
+- app/views/decidim/accountability/admin/results/_form.html.erb
+- app/views/decidim/accountability/admin/results/edit.html.erb
+- app/views/decidim/accountability/admin/results/index.html.erb
+- app/views/decidim/accountability/admin/results/new.html.erb
+- app/views/decidim/accountability/admin/shared/_subnav.html.erb
+- app/views/decidim/accountability/admin/statuses/_form.html.erb
+- app/views/decidim/accountability/admin/statuses/edit.html.erb
+- app/views/decidim/accountability/admin/statuses/index.html.erb
+- app/views/decidim/accountability/admin/statuses/new.html.erb
+- app/views/decidim/accountability/admin/template_texts/_form.html.erb
+- app/views/decidim/accountability/admin/template_texts/edit.html.erb
+- app/views/decidim/accountability/admin/timeline_entries/_form.html.erb
+- app/views/decidim/accountability/admin/timeline_entries/edit.html.erb
+- app/views/decidim/accountability/admin/timeline_entries/index.html.erb
+- app/views/decidim/accountability/admin/timeline_entries/new.html.erb
+- app/views/decidim/accountability/result_widgets/show.html.erb
+- app/views/decidim/accountability/results/_home_categories.html.erb
+- app/views/decidim/accountability/results/_home_header.html.erb
+- app/views/decidim/accountability/results/_linked_results.html.erb
+- app/views/decidim/accountability/results/_nav_breadcrumb.html.erb
+- app/views/decidim/accountability/results/_results_leaf.html.erb
+- app/views/decidim/accountability/results/_results_parent.html.erb
+- app/views/decidim/accountability/results/_scope_filters.html.erb
+- app/views/decidim/accountability/results/_search.html.erb
+- app/views/decidim/accountability/results/_show_leaf.html.erb
+- app/views/decidim/accountability/results/_show_parent.html.erb
+- app/views/decidim/accountability/results/_stats.html.erb
+- app/views/decidim/accountability/results/_stats_box.html.erb
+- app/views/decidim/accountability/results/_tags.html.erb
+- app/views/decidim/accountability/results/_timeline.html.erb
+- app/views/decidim/accountability/results/home.html.erb
+- app/views/decidim/accountability/results/index.html.erb
+- app/views/decidim/accountability/results/index.js.erb
+- app/views/decidim/accountability/results/show.html.erb
+- config/i18n-tasks.yml
+- config/locales/ca.yml
+- config/locales/en.yml
+- config/locales/es.yml
+- config/locales/eu.yml
+- config/locales/fi.yml
+- db/migrate/20170425154712_create_accountability_statuses.rb
+- db/migrate/20170426104125_create_accountability_results.rb
+- db/migrate/20170508104902_add_description_and_progress_to_statuses.rb
+- db/migrate/20170508161109_create_template_texts.rb
+- db/migrate/20170606102902_add_index_to_accountability_results_on_external_id.rb
+- db/migrate/20170620154712_create_accountability_timeline_entries.rb
+- db/migrate/20170623094200_migrate_accountability_results_category.rb
+- db/migrate/20170623144902_add_children_counter_cache_to_results.rb
+- lib/decidim/accountability.rb
+- lib/decidim/accountability/admin.rb
+- lib/decidim/accountability/admin_engine.rb
+- lib/decidim/accountability/feature.rb
+- lib/decidim/accountability/list_engine.rb
+- lib/decidim/accountability/test/factories.rb
+homepage: https://github.com/AjuntamentdeBarcelona/decidim
+licenses:
+- AGPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: An accountability component for decidim's participatory processes.
+test_files: []