decidim 0.10.1 → 0.11.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cee9b8fa8ccc00615b166cd9804132fa7885debed5e4c4d24e5e97e79111c33
-  data.tar.gz: d4ca342e72a009cdc9e891ad39a679a571a984f59f21030ed514b3538592073f
+  metadata.gz: 8869506923bb1b565c76cbe0463fd7b1f7d4083a5aa00da273c8a9cdde4d6dc2
+  data.tar.gz: 770aec669bd01da230f273005c91ebd93d72b097b967896db63aa2520d683394
 SHA512:
-  metadata.gz: a15f2c0a55c17e4f84ecb7f5911a6cca119123f06a4c7a9fded32a71ede4c6495fc59825bf00bcfd2920f8bb30e13d921a82bf75ebbac9c14f39cdf0decaeb4e
-  data.tar.gz: 6ac505e1fd2eeea48799bc3b39fcc63c42f91b59bdb9b04de365ca64be4e7375336b1743b61dc200c987b96766a300b65d4fecf02f28184091d2bdc4b020620b
+  metadata.gz: bc8449a22cb0385d2e3f07541ed922f5af8da6377a8a9aaf1c1711bfdf26ec325fb48c94451b980d4988ca4c9b6cf350ef070a7707ada051749930983346ecfa
+  data.tar.gz: c01c852c89029bc624042c33e6c8fbb1273232fc68d059d744b162ea9d45765f0e121edbe6979170b8f97773c341a1f9cb9e360a90e9e68c87d17e574260decf

data/README.md

@@ -20,7 +20,6 @@ Code quality
 
 [![Build Status](https://img.shields.io/circleci/project/github/decidim/decidim/master.svg)](https://circleci.com/gh/decidim/decidim)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ad8fa445086e491486b6/maintainability)](https://codeclimate.com/github/decidim/decidim/maintainability)
-[![codecov](https://img.shields.io/codecov/c/github/decidim/decidim.svg)](https://codecov.io/gh/decidim/decidim)
 [![Dependency Status](https://img.shields.io/gemnasium/decidim/decidim.svg)](https://gemnasium.com/github.com/decidim/decidim)
 [![Crowdin](https://d322cqt584bo4o.cloudfront.net/decidim/localized.svg)](https://crowdin.com/project/decidim)
 [![Inline docs](http://inch-ci.org/github/decidim/decidim.svg?branch=master)](http://inch-ci.org/github/decidim/decidim)
@@ -88,29 +87,31 @@ Also, if you want to verify yourself against the default authorization handler u
 | [Budgets](https://github.com/decidim/decidim/tree/master/decidim-budgets)                                 | Adds a participatory budgets system to any participatory space.                                                                                              |
 | [Comments](https://github.com/decidim/decidim/tree/master/decidim-comments)                               | The Comments module adds the ability to include comments to any resource which can be commentable by users.                                                  |
 | [Core](https://github.com/decidim/decidim/tree/master/decidim-core)                                       | The basics of Decidim: users, organizations, etc. This is the only required engine to run Decidim, all the others are optional.                              |
+| [Generators](https://github.com/decidim/decidim/tree/master/decidim-generators)                           | It helps you with generating decidim applications & new components. It provides the `decidim` executable.
 | [Participatory Processes](https://github.com/decidim/decidim/tree/master/decidim-participatory_processes) | The main concept of a Decidim installation: participatory processes.                                                                                         |
-| [Dev](https://github.com/decidim/decidim/tree/master/decidim-dev)                                         | Aids the local development of Decidim's features.                                                                                                            |
+| [Dev](https://github.com/decidim/decidim/tree/master/decidim-dev)                                         | Aids the local development of Decidim's components.                                                                                                            |
 | [Meeting](https://github.com/decidim/decidim/tree/master/decidim-meetings)                                | The Meeting module adds meeting to any participatory space. It adds a CRUD engine to the admin and public view scoped inside the participatory space.        |
 | [Pages](https://github.com/decidim/decidim/tree/master/decidim-pages)                                     | The Pages module adds static page capabilities to any participatory space. It basically provides an interface to include arbitrary HTML content to any step. |
-| [Proposals](https://github.com/decidim/decidim/tree/master/decidim-proposals)                             | The Proposals module adds one of the main features of Decidim: allows users to contribute to a participatory space by creating proposals.                    |
+| [Proposals](https://github.com/decidim/decidim/tree/master/decidim-proposals)                             | The Proposals module adds one of the main components of Decidim: allows users to contribute to a participatory space by creating proposals.                    |
 | [Surveys](https://github.com/decidim/decidim/tree/master/decidim-surveys)                                 | Adds the ability for admins to create arbitrary surveys.                                                                                                     |
 | [System](https://github.com/decidim/decidim/tree/master/decidim-system)                                   | Multitenant Admin to manage multiple organizations in a single installation.                                                                                 |
+| [Sortitions](https://github.com/decidim/decidim/tree/master/decidim-sortitions)                           |  This component makes possible to select randomly a number of proposals among a set of proposals (or a category of proposals within a set) maximizing guarantees of randomness and avoiding manipulation of results by the administrator.                                                                                              |
+| [Consultations](https://github.com/decidim/decidim/tree/master/decidim-consultations)                     |  This module creates a new space for decidim to host consultations: debates around critical questions and a proxy for eVoting                                |
+| [Initiatives](https://github.com/decidim/decidim/tree/master/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.                                                                                             |
+| [Blogs](https://github.com/decidim/decidim-module-blogs)                                                  |  This component makes possible to add posts ordered by publication time to spaces.                                                                           |
 
 ### Official (on development)
 
 | Module                                                                                                    | Description                                                                                                                                                  |
 | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | [Blogs](https://github.com/decidim/decidim-module-blogs)                                                  |  This component makes possible to add posts ordered by publication time to spaces.                                                                           |
-| [Consultations](https://github.com/decidim/decidim-module-consultations)                                  |  This module creates a new space for decidim to host consultations: debates around critical questions and a proxy for eVoting                                |
-| [Initiatives](https://github.com/decidim/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.                                                                                             |
-| [Sortitions](https://github.com/decidim/decidim-module-sortitions)                                        |  This component makes possible to select randomly a number of proposals among a set of proposals (or a category of proposals within a set) maximizing guarantees of randomness and avoiding manipulation of results by the administrator.                                                                                               |
 
 ### Community
 
 | Module                                                                                                    | Description                                                                                                                                                  |
 | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | [Census](https://github.com/diputacioBCN/decidim-diba/tree/master/decidim-census)                         | Allows to upload a census CSV file to perform authorizations against real users parameterised by their age.                                                  |
-| [Crowdfunding](https://github.com/podemos-info/decidim-module-crowdfundings)                              | This rails engine implements a Decidim feature that allows to the administrators to configure crowfunding campaigns for a participatory space.               |
+| [Crowdfunding](https://github.com/podemos-info/decidim-module-crowdfundings)                              | This rails engine implements a Decidim component that allows to the administrators to configure crowfunding campaigns for a participatory space.               |
 | [DataViz](https://github.com/AjuntamentdeBarcelona/decidim-barcelona/tree/master/decidim-dataviz)         | The Dataviz module adds the PAM data visualizations to any participatory process but it is intended to be used just for the PAM participatory process.       |
 | [Members](https://github.com/ElectricThings/decidim-members)                                              | Members list and search plugin for Decidim                                                                                                                   |
 | [Pol.is](https://github.com/OpenSourcePolitics/decidim-polis)                                             | Pol.is integration on Decidim                                                                                                                                |

data/Rakefile

@@ -2,8 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require "generators/decidim/app_generator"
-require "decidim/component_manager"
+require "decidim/gem_manager"
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -14,44 +13,21 @@ task test_all: [:test_main, :test_subgems]
 
 desc "Runs all tests in decidim subgems"
 task test_subgems: :test_app do
-  Decidim::ComponentManager.run_all("rake", include_root: false)
+  Decidim::GemManager.run_all("rake", include_root: false)
 end
 
 desc "Runs all tests in the main decidim gem"
 task :test_main do
-  Decidim::ComponentManager.new(__dir__).run("rake")
+  Decidim::GemManager.new(__dir__).run("rake")
 end
 
 desc "Update version in all gems to the one set in the `.decidim-version` file"
 task :update_versions do
-  Decidim::ComponentManager.replace_versions
+  Decidim::GemManager.replace_versions
 end
 
-desc "Installs all gems locally."
-task :install_all do
-  Decidim::ComponentManager.run_all(
-    "gem build %name && mv %name-%version.gem ..",
-    include_root: false
-  )
-
-  Decidim::ComponentManager.new(__dir__).run(
-    "gem build %name && gem install *.gem"
-  )
-end
-
-desc "Uninstalls all gems locally."
-task :uninstall_all do
-  Decidim::ComponentManager.run_all(
-    "gem uninstall %name -v %version --executables --force"
-  )
-
-  Decidim::ComponentManager.new(__dir__).run(
-    "rm decidim-*.gem"
-  )
-end
-
-Decidim::ComponentManager.all_dirs(include_root: false) do |dir|
-  manager = Decidim::ComponentManager.new(dir)
+Decidim::GemManager.all_dirs(include_root: false) do |dir|
+  manager = Decidim::GemManager.new(dir)
   name = manager.short_name
 
   desc "Runs tests on #{name}"
@@ -60,9 +36,19 @@ Decidim::ComponentManager.all_dirs(include_root: false) do |dir|
   end
 end
 
+desc "Runs tests for a random participatory space"
+task :test_participatory_space do
+  Decidim::GemManager.test_participatory_space
+end
+
+desc "Runs tests for a random component"
+task :test_component do
+  Decidim::GemManager.test_component
+end
+
 desc "Pushes a new build for each gem."
 task release_all: [:update_versions, :check_locale_completeness, :webpack] do
-  Decidim::ComponentManager.run_all("rake release")
+  Decidim::GemManager.run_all("rake release")
 end
 
 desc "Makes sure all official locales are complete and clean."

data/docs/add_authenticable_action.md

@@ -1,20 +1,27 @@
 # How to add a new authenticable action?
+
 ## Proposals example
+
 We're going to reproduce the steps to add an action (adhere) for a proposal step by step.
+
 ### Configuring a new 'adhere' action
-1. Edit decidim-proposals/lib/decidim/proposals/feature.rb
-1. Add the new 'adhere' action into the `feature.actions` array and save the file:
-```
-feature.actions = %w(adhere vote create)
+
+1. Edit decidim-proposals/lib/decidim/proposals/component.rb
+1. Add the new 'adhere' action into the `component.actions` array and save the file:
+
+```ruby
+component.actions = %w(adhere vote create)
 ```
 
-3. Translate the action for the corresponding key: `en.decidim.features.proposals.actions.adhere = Adhere`
+1. Translate the action for the corresponding key: `en.decidim.components.proposals.actions.adhere = Adhere`
 1. Edit `app/models/decidim/proposals/abilities/current_user_ability.rb` and add the corresponding cancancan ability like `can :adhere, Proposal do |_proposal| ...`.
 1. Restart the server to pick up the changes.
 1. Now the admin should be able to go to the Control Panel and edit `PROCESSES/Proposals/Permissions/Adhere` panel. There an `Authorization Handler` can be set.
 
 ### Using the new 'adhere' action
+
 With a user which has the selected permission verified:
+
 1. Go to a Proposal detail in the front-end
 1. Adhere to the current proposal (see ProposalAdhesionsController): the user should be able to perform an adhesion.
     - If the user had the required permission unverified, the 'adhere' button should block the action. You can check it with an unverified user.

data/docs/adding_fixtures_aka_dummy_content.md

@@ -1,7 +1,9 @@
 # How to add dummy content to a development application?
+
 ## Proposals example
-1. In decidim-proposals open `lib/decidim/proposals/feature.rb`.
-1. Find the `feature.seeds do...` block.
+
+1. In decidim-proposals open `lib/decidim/proposals/component.rb`.
+1. Find the `component.seeds do...` block.
 1. Create your dummy content as if you were in a `db/seed.rb` script.
   - Take advantage of the Faker gem, already in decidim.
   - You can use https://github.com/decidim/decidim/blob/master/decidim-core/lib/decidim/faker/localized.rb, which uses `Faker` internally, if you need content for i18n fields.

data/docs/advanced/components.md

@@ -0,0 +1,60 @@
+# Components
+
+Components are the core contract between external modules and the core. They're used to define pieces of functionality that are pluggable to participatory processes and can be enabled or disabled by the administrator.
+
+## How do I create a new component?
+
+Components are just gems with one or more Rails engines included in it. You can use as an example [decidim-pages](https://github.com/decidim/decidim/tree/master/decidim-pages).
+
+Check out the `lib/decidim/pages` folder: It includes several files, the most important of which is `component.rb`.
+
+## Defining a component manifest
+
+Components are defined in a manifest, along with its engine and admin engine counterpart.
+
+There's a DSL available to describe all this:
+
+```ruby
+# :my_component is the unique name of the component that will be globally registered.
+Decidim.register_component(:my_component) do |component|
+  # The user will be redirected to the component's engine when accessing it through
+  # the public page of a participatory process. A component's engine is isolated
+  # from the outside so it can deal with its own dependencies without having to
+  # know its render path or its parent resources.
+  component.engine = MyComponent::Engine
+
+  # A component's admin engine will get rendered on the admin panel and follows
+  # the same principles as the engine. It's isolated from the outside and
+  # doesn't care about external dependencies. It only needs to care about its
+  # underlying `component`.
+  component.admin_engine = MyComponent::AdminEngine
+
+  # Component hooks get called whenever relevant lifecycle events happen, like
+  # adding a new component o destroying it. You always get passed the instance
+  # so you can act on it. Creating or destroying a comoponent is transactional
+  # along with its hooks, so you can decide to halt the transaction by raising
+  # an exception.
+  #
+  # Valid hook names are :create and :destroy.
+  component.on(:create) do |component|
+    MyComponent::DoSomething.with(component)
+  end
+
+  # Export definitions allow components to declare any number of exportable files.
+  #
+  # An export definition needs a unique name, a collection, and a Serializer. If
+  # no serializer is provided, a default, naive one will be used.
+  #
+  # Exports are then exposed via the UI, so the implementer only needs to care
+  # about the export definitions.
+  component.exports :component_resources do |exports|
+    exports.collection do |component|
+      MyComponent::Resource.where(component: component)
+    end
+
+    exports.serializer MyComponent::ResourceSerializer
+  end
+end
+```
+
+Every model in a component doesn't have to (and should not) know about its parent participatory process, but instead should be scoped to the components.

data/docs/advanced/content_processors.md

@@ -12,6 +12,26 @@ Register the content processor in an `initializer`:
 Decidim.content_processors += [:special_words]
 ```
 
+This symbol will be used to instantiate parsers and processors using the following convention:
+
+- "Decidim::ContentParsers::#{type.to_s.camelize}Parser"
+- "Decidim::ContentRenderers::#{type.to_s.camelize}Renderer"
+
+Autoload parser and renderer if in the lib/ dir. For example if in proposals module edit `lib/decidim/proposals.rb`:
+
+```rb
+module Decidim
+  ...
+  module ContentParsers
+    autoload :ProposalParser, "decidim/content_parsers/proposal_parser"
+  end
+  module ContentRenderers
+    autoload :ProposalRenderer, "decidim/content_renderers/proposal_renderer"
+  end
+  ...
+end
+```
+
 Declare the parser class:
 
 ```rb

data/docs/advanced/followers.md

@@ -18,8 +18,8 @@ end; p 1
 Run the following script to make all resource authors follow the resource:
 
 ```ruby
-Decidim.feature_manifests.each do |feature_manifest|
-  feature_manifest.resource_manifests.each do |resource_manifest|
+Decidim.component_manifests.each do |component_manifest|
+  component_manifest.resource_manifests.each do |resource_manifest|
     klass = resource_manifest.model_class_name.constantize
     next unless klass.included_modules.include? Decidim::Authorable
 

data/docs/advanced/view_models_aka_cells.md

@@ -0,0 +1,91 @@
+# View Models (a.k.a. Cells)
+
+## General description
+
+A cell is an object that represent a fragment of your UI. The scope of that fragment can embrace an entire page, a single comment container in a thread or just an avatar image link.
+
+Cells are faster than ActionView. While exposing a better performance, you step-wise encapsulate fragments into cell widgets and enforce interfaces.
+
+### View Model
+
+Think of cells, or view models, as small Rails controllers, but without any HTTP coupling. Cells embrace all presentation and rendering logic to present a fragment of the UI.
+
+## Decidim Cards
+
+`card_for @instance` will render the corresponding default card for each component instance.
+If a `component.card` is not registered a _basic_ (deafult) card is shown.
+
+To render a specified size/variation include the `size` option as a `symbol`: `card_for @instance, size: :m`
+
+## Introducing a Card Cell to a `component`
+
+- add **dependency** to "decidim-*.gemspec"
+
+  ```rb
+  s.add_dependency "cells-erb", "~> 0.1.0"
+  s.add_dependency "cells-rails", "~> 0.0.8"
+  ```
+
+- **autoload** view_model to module `decidim-<module>/lib/decidim/<module>.rb`
+
+  ```rb
+  autoload :ViewModel, "decidim/<module>/view_model"
+  ```
+
+- **require** cells in `decidim-<module>/lib/decidim/<module>/engine.rb`
+
+  ```rb
+  require "cells/rails"
+  require "cells-erb"
+
+  initializer "decidim_<module>.add_cells_view_paths" do
+    Cell::ViewModel.view_paths << File.expand_path("#{Decidim::<Module>::Engine.root}/app/cells")
+    Cell::ViewModel.view_paths << File.expand_path("#{Decidim::<Module>::Engine.root}/app/views") # for partials
+  end
+  ```
+
+- add the *ViewModel* `decidim-<module>/lib/decidim/<module>/view_model.rb`
+
+  ```rb
+  module Decidim
+    module <Module>
+      class ViewModel < Decidim::ViewModel
+      end
+    end
+  end
+  ```
+
+- The attribute `card` of the Components is defined in `decidim-core/lib/decidim/component_manifest.rb`:
+
+  ```rb
+  # The cell to use to render the card of a resource.
+  attribute :card, String
+  ```
+
+  In your `decidim-<component>/lib/decidim/<component>/component.rb` register the cell value:
+
+  ```rb
+  component.card = "decidim/<component>s/<component>"
+  ```
+
+- The **Cell Class**, following the convention will reside in `decidim-<component>s/app/cells/decidim/<component>s/<component>_cell.rb`:
+
+  ```rb
+  module Decidim
+    module <Component>s
+      class <Component>Cell < Decidim::<Component>s::ViewModel
+        def show
+          render # renders decidim-<component>s/app/cells/decidim/<component>s/<component>
+        end
+      end
+    end
+  end
+  ```
+
+- The **Cell Views** will be in the `decidim-<component>s/app/cells/decidim/<component>s/<component>` and defaults to `show.erb`
+
+## More Info
+
+- [cells/README.md at master · trailblazer/cells](https://github.com/trailblazer/cells/blob/master/README.md)
+- [Trailblazer: Cells](http://trailblazer.to/gems/cells/) / [Trailblazer: Cells API](http://trailblazer.to/gems/cells/api.html)
+- [Introduction to Cells: A Better View Layer for Rails — SitePoint](https://www.sitepoint.com/introduction-to-cells-a-better-view-layer-for-rails/)

data/docs/checklist.md

@@ -0,0 +1,47 @@
+# Checklist
+
+As a technopolitical project, Decidim needs several things to work. This is a non comprehensive list that serves as a general recommendation of what things you need to have it working with the best practices:
+
+## Technological
+
+1. Choose a **domain** for your application. Some typical names involve "Participation" or "Decision" conjugations.
+
+1. Choose which **languages** do you want for your application. In case that your language isn't supported you should translate it on [Crowdin](https://crowdin.com/project/decidim).
+
+1. Customize the [**look and feel**](https://github.com/decidim/decidim/blob/master/docs/customization/styles.md) (colors, pictures, fonts, etc).
+
+1. Configure **SSL**. We recommend using at least [Let's Encrypt](https://letsencrypt.org/) for a minimum security.
+
+1. Configure your **SMTP** server.
+
+1. Setup the **geolocation** service. We recommend using [Here Maps](https://developer.here.com/), but you can use other kind of tiling server compatible with [Open Street Maps](https://www.openstreetmap.org/).
+
+1. Setup an **analytics** server. For better compliance with Decidim Social Contract, we recommend using [Matomo](https://matomo.org/).
+
+1. Setup **backup** on your server. The most important things to save are the `public/uploads` and the database.
+
+1. Decide and implement which kind of **[Authorization](docs/customization/authorization.md)** you're going to use.
+
+1. Comply with our License (Affero GPL 3) and **publish your code** to [GitHub](http://github.com) or wherever you want.
+
+1. Review your **decidim initializer** on your application (config/initializers/decidim.rb).
+
+1. Configure your [**ActiveJob**](https://github.com/decidim/decidim/blob/master/docs/services/activejob.md) background queue.
+
+1. If you want, configure your [**social providers**](https://github.com/decidim/decidim/blob/master/docs/services/social_providers.md) to enable login using external applications.
+
+## Contents
+
+1. Ideally you'll have a **Team** formed with experts on IT, Communication, Participation, Design and Law.
+
+1. Texts for at least, **terms of use, privacy policy and frequently asked questions**.
+
+1. Comply with your current **legal requirements**, like to registrate your privacy policy with the autorities (eg LOPD on Spain).
+
+1. Fill the **Participatory Processes Configuration Form** to prepare your Participatory Process for Decidim.
+
+1. Read the **[Administration manual](https://decidim.org/docs/)**.
+
+1. Participate on **[MetaDecidim](http://meta.decidim.barcelona)**.
+
+1. Read the Decidim **[Social Contract](https://decidim.org/contract/)**.

data/docs/customization/code.md

@@ -7,7 +7,7 @@ Decidim is multiple things:
 
 Most of the time, you should work with the generated application. That application (development_app on this docs) should be named as your project, for instance for Barcelona City Council is `DecidimBarcelona`, so for creating it should be:
 
-```
+```console
 decidim DecidimBarcelona
 ```
 
@@ -16,12 +16,14 @@ If you want to override/change anything (for instance the homepage), you can jus
 If you want to extend Decidim, the prefered way should be by having a Module. This is a Ruby on Rails Engine which provides ruby code (models, views, controllers, assets, etc). You can use it through multiple ways:
 
 * Putting it on the same directory as your app and pointing on the Gemfile. [See example on GitHub](https://github.com/AjuntamentdeBarcelona/decidim-barcelona/tree/c210b5338d7ba1338c9879627e081da1441f1946). For instance:
-```
+
+```ruby
 gem "decidim-debates", path: "decidim-debates"
 ```
 
 * Publishing on a git reposotory and pointing in on the Gemfile. For instance:
-```
+
+```ruby
 gem "decidim-consultations", git: "https://github.com/decidim/decidim-module-consultations"
 ```