decidim 0.10.1 → 0.11.0.pre1

data/docs/customization/gemfile.md

@@ -1,8 +1,8 @@
 # Gemfile
 
-You can add and change your Gemfile as you want, this is a classic Ruby on Rails application. For example to add[ rails-footnotes](https://github.com/josevalim/rails-footnotes) gem you would just add:
+You can add and change your Gemfile as you want, this is a classic Ruby on Rails application. For example to add [rails-footnotes](https://github.com/josevalim/rails-footnotes) gem you would just add:
 
-```
+```ruby
 gem 'rails-footnotes', '~> 4.0'
 ```
 

data/docs/customization/javascript.md

@@ -2,7 +2,7 @@
 
 If you want to add some custom Javascript code, just add it to app/assets/javascripts/application.js. For example to create a new alert just add:
 
-```
+```javascript
 $(function(){
   alert('foobar');
 });

data/docs/customization/oauth.md

@@ -0,0 +1,23 @@
+# OAuth
+
+Decidim is both and OAuth client (via [omniauth](https://github.com/omniauth/omniauth)) and an OAuth provider (via [doorkeeper](https://github.com/doorkeeper-gem/doorkeeper)).
+
+Check the [Social Providers](https://github.com/decidim/decidim/blob/master/docs/services/social_providers.md) document to check the client configuration.
+
+## Decidim as an OAuth provider
+
+You can use your own Decidim application to log in to other applications that support OAuth 2. To do it you need to create an OAuth application from the admin panel for each client that wants to use Decidim.
+
+To create a new OAuth application you need:
+
+* Name: The name of the client application that will be shown to the user when authorizing it from your Decidim application.
+* Redirect URI: The URI where the Decidim application should redirect the user after authorizing it. It is usually where you handle the OAUth callback in your client application. If you're using `omniauth-decidim` the value should be `YOUR_APPLICATION_HOST/users/auth/decidim/callback`.
+* Organization name: The name of the organization that owns the client application.
+* Organization URL: The URL of the organization that owns the client application.
+* Organization logo: An image of the logo of the organization that owns the client application.
+
+All the organization data will be used during the authorization process so the users know to who they're giving their data.
+
+Once you've created your application you'll get the settings to setup your client.
+
+Check [omniauth-decidim](https://github.com/decidim/omniauth-decidim) in order to configure your client application.

data/docs/customization/styles.md

@@ -2,14 +2,10 @@
 
 One of the first things you’ll want to do after you install Decidim is applying your own corporative image. To do this, you can go to app/assets/stylesheets/application.css.sass on your generated application with your own colors. There you can override any class using CSS with SASS.
 
-We use [SASS, with SCSS syntax](http://sass-lang.com/guide) as CSS preprocessor.
-
-Also you can check your scss files syntax with
+In [decidim-core/app/assets/stylesheets/decidim/_variables.scss](https://github.com/decidim/decidim/blob/master/decidim-core/app/assets/stylesheets/decidim/_variables.scss) you can find the `variables` that can be overriden in your `sass`.
 
-```
-scss-lint
-```
+We use [SASS, with SCSS syntax](http://sass-lang.com/guide) as CSS preprocessor.
 
 ## **Accesibility**
 
-To maintain accesibility level, if you add new colors use a[ Color contrast checker](http://webaim.org/resources/contrastchecker/) (WCAG AA is mandatory, WCAG AAA is recommended)
+To maintain accesibility level, if you add new colors use a [Color contrast checker](http://webaim.org/resources/contrastchecker/) (WCAG AA is mandatory, WCAG AAA is recommended)

data/docs/data-picker.md

@@ -7,14 +7,19 @@ Current Decidim's selector is inspired on [this](https://medium.com/@mibosc/resp
 Data Picker is a selector thought to be reusable in many contexts and kinds of data. The idea behind it is a reusable widget that opens a popup where the user will perform a given selection and, on finish, this selection is returned to the source widget in the main page. The popup is accompained by a semitransparent layer behind it to blur the background and keep the user concentrated in the current action, the selection.
 
 ## Artifacts
+
 Data Picker is composed by 2 visual artifacts, plus the javascript and one controller action for each selection type:
+
 - **widget**: the first visual artifact is the widget that encapsulates the main Data Picker functionality. This widget manages the rendering of __the button__ that opens the selector and __the popup__. This button is managed via ujs (Unobtrusive JavaScript). The popup is empty and must be filled with a selection partial.
 - **selection functionality** partial: There are many ways to select things (and many kinds of things to select). Thus, the selection functionality can be customized via a selection partial which will be rendered inside the widget's popup. This partial is supplied to the widget via ajax.
 - **controller ajax action**: An ajax action will send the content of the popup in an html partial.
 
 ## How to
-### Placing the Data Picker widget:
+
+### Placing the Data Picker widget
+
 The Data Picker widget structure is as follows:
+
 ```html
 <div id="some-unique-id" class="data-picker <%= picker_options[:class]%>" data-picker-name="<%=picker_options[:name]%>">
   <div class="picker-values"><% @form.proposals.each do |proposal, params| %>
@@ -27,13 +32,14 @@ The Data Picker widget structure is as follows:
 Placing the widget in a form requires two steps:
 
 It is a good way to implement the widget to think that it is a component that takes parameters.
+
 1. Prepare Data Picker parameters
-Data Picker takes two arguments the `picker_params` hash (to fill the main div) and the `prompt_params` hash (for the `picker-prompt` div).
+  Data Picker takes two arguments the `picker_params` hash (to fill the main div) and the `prompt_params` hash (for the `picker-prompt` div).
   - `picker_params.id`: the html unique id of the widget instance, required by the JavaScript.
   - `picker_params.name`: the html name of the widget which will be sent by the form.
   - `picker_params.class`: one of `picker-multiple`, when user can select multiple data, or `picker-single`, when only one data is to be selected.
 
-2. Html for the Data Picker widget
+1. Html for the Data Picker widget
 
 ### Selector popup content
 
@@ -45,4 +51,5 @@ picker-value: the selected value
 picker-text (optional): The text to be shown in the picker button.
 
 ### Returning the selection to the widget
+
 To return the selection to the widget in the main page use javascript to set the data-picker-value in the #proposal-picker-choose button.

data/docs/getting_started.md

@@ -16,7 +16,7 @@ If you want to start your own installation of Decidim, you don't need to clone t
 
 We've made an script for Ubuntu 16.04 LTS and macos sierra 10.2. It's a BETA and as such you should be aware that this could break your environment (if you have any). It'll install rbenv, postgresql, nodejs and install decidim on this directory. It should take 15 minutes depending on your network connection.
 
-```
+```console
 wget http://get.decidim.org -O install_decidim.bash
 bash install_decidim.bash
 ```
@@ -25,28 +25,55 @@ Read more about the [installation script](https://github.com/alabs/decidim-insta
 
 ### B. Using Docker [experimental]
 
-> *Please note that this is **experimental***
+You can also use [docker] && [docker-compose] to develop decidim. You'll
+need to install those but in exchange you don't need to install any other
+dependency in your computer, not even Ruby!
 
-Make sure you [have Docker v17 at least](https://docs.docker.com/engine/installation/). `cd` to your preferred folder and run this command:
+To get started, first clone the decidim repo
 
+```console
+git clone https://github.com/decidim/decidim
 ```
-docker run --rm -v $(pwd):/tmp codegram/decidim bash -c "bundle exec decidim /tmp/decidim_application"
+
+Switch to the cloned folder
+
+```console
+cd decidim
 ```
 
-This will create a `decidim_application` Ruby on Rails app using Decidim in the current folder. It will install the latest released version of the gem.
+Then create a development application
+
+```console
+d/bundle install
+d/rake development_app
+cd development_app
+bin/rails server
+```
 
+In general, to use the docker development environment, change any instruction in
+the docs to use its equivalent docker binstub.  So for example, instead of
+running `bundle install`, you would run `d/bundle install`.
 
 ### C. Step by step
 
+In order to develop on decidim, you'll need:
+
+* **Git** 2.15+
+* **PostgreSQL** 9.4+
+* **Ruby** 2.5.0 (2.3+ should work just fine, but that's the version we test against)
+* **NodeJS** 9.x.x
+* **ImageMagick**
+* **Chrome** browser and [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/).
+
 First of all, you need to install the `decidim` gem:
 
-```
+```console
 gem install decidim
 ```
 
 afterwards, you can create an application with the nice `decidim` executable:
 
-```
+```console
 decidim decidim_application
 cd decidim_application
 bundle install
@@ -57,8 +84,8 @@ rails server
 
 You should now setup your database:
 
-```
-$ bin/rails db:create db:migrate db:seed
+```console
+bin/rails db:create db:migrate db:seed
 ```
 
 This will also create some default data so you can start testing the app:
@@ -67,12 +94,13 @@ This will also create some default data so you can start testing the app:
 * A `Decidim::Organization` named `Decidim Staging`. You probably want to change its name and hostname to match your needs.
 * A `Decidim::User` acting as an admin for the organization, with email `admin@example.org` and password `decidim123456`.
 * A `Decidim::User` that also belongs to the organization but it's a regular user, with email `user@example.org` and password `decidim123456`.
+
 This data won't be created in production environments, if you still want to do it, run: ``` $ SEED=true rails db:setup ```
 
 You can now start your server!
 
-```
-$ bin/rails s
+```console
+bin/rails s
 ```
 
 Visit [http://localhost:3000](http://localhost:3000) to see your app running.
@@ -81,12 +109,12 @@ Visit [http://localhost:3000](http://localhost:3000) to see your app running.
 
 Decidim comes pre-configured with some safe defaults, but can be changed through the `config/initializers/decidim.rb` file in your app. Check the comments there or read the comments in [the source file](https://github.com/decidim/decidim/blob/master/decidim-core/lib/decidim/core.rb) (the part with the `config_accessor` calls) for more up-to-date info.
 
-We also have other guides on how to configure some extra features:
+We also have other guides on how to configure some extra components:
 
-- [ActiveJob](https://github.com/decidim/decidim/blob/master/docs/services/activejob.md)
-- [Analytics](https://github.com/decidim/decidim/blob/master/docs/services/analytics.md): How to enable analytics
-- [Geocoding](https://github.com/decidim/decidim/blob/master/docs/services/geocoding.md): How to enable geocoding for proposals and meetings
-- [Social providers integration](https://github.com/decidim/decidim/blob/master/docs/services/social_providers.md): Enable sign up from social networks.
+* [ActiveJob](https://github.com/decidim/decidim/blob/master/docs/services/activejob.md)
+* [Analytics](https://github.com/decidim/decidim/blob/master/docs/services/analytics.md): How to enable analytics
+* [Geocoding](https://github.com/decidim/decidim/blob/master/docs/services/geocoding.md): How to enable geocoding for proposals and meetings
+* [Social providers integration](https://github.com/decidim/decidim/blob/master/docs/services/social_providers.md): Enable sign up from social networks.
 
 ## Deploy
 
@@ -109,8 +137,8 @@ You can check the [`decidim-system` README file](https://github.com/decidim/deci
 
 If you want, you can create seed data in production. Run this command in your production console:
 
-```
-$ SEED=true rails db:seed
+```console
+SEED=true rails db:seed
 ```
 
 You'll need to login as system user and edit the host for the organization. Set it to you production host, without the protocol and the port (so if your host is `https://my.host:3001`, you need to write `my.host`).
@@ -119,23 +147,30 @@ You'll need to login as system user and edit the host for the organization. Set
 
 We keep releasing new versions of Decidim. In order to get the latest one, update your dependencies:
 
-```
-$ bundle update decidim
+```console
+bundle update decidim
 ```
 
 And make sure you get all the latest migrations:
 
-```
-$ bin/rails decidim:upgrade
-$ bin/rails db:migrate
+```console
+bin/rails decidim:upgrade
+bin/rails db:migrate
 ```
 
 You can also make sure new translations are complete for all languages in your
 application with:
 
-```
-$ bin/rails decidim:check_locales
+```console
+bin/rails decidim:check_locales
 ```
 
 Be aware that this task might not be able to detect everything, so make sure you
 also manually check your application before upgrading.
+
+## Checklist
+
+There are several things you need to check before making your putting your application on production. See the [checklist](docs/checklist.md).
+
+[docker]: https://docs.docker.com/engine/installation/
+[docker-compose]: https://docs.docker.com/compose/install/

data/docs/services/analytics.md

@@ -6,7 +6,7 @@ Adding analytics is quite easy. We've set up a partial in place for that. Just c
 
 Here's an example for Piwik:
 
-```
+```javascript
 <script type="text/javascript">
   var _paq = _paq || [];
   // tracker methods like "setCustomDimension" should be called before "trackPageView"

data/docs/services/geocoding.md

@@ -2,7 +2,7 @@
 
 ## Configuring geocoding
 
-Decidim has the ability to geocode proposals and meetings using the [Here](http://here.com) service, and no other provider is officially supported.
+Decidim has the ability to geocode proposals and meetings using Open Street Maps, for instance, you can use [Here](http://here.com) service. We can't use the OSM server by their [tile usage policy](https://operations.osmfoundation.org/policies/tiles/). As an alternative, you may also want to use your own [self-hosted tile server](https://opentileserver.org/).
 
 After generating your app, you'll see that your `config/initializers/decidim.rb` file has come commented code about geocoding:
 
@@ -18,7 +18,7 @@ After generating your app, you'll see that your `config/initializers/decidim.rb`
 If you want to enable geocoding in your app:
 
 1. Uncomment or add the previous code in your `config/initializers/decidim.rb`.
-1. Make sure your `config/secrets.yml` file has the needed section (it should be added by the genertator automatically).
+1. Make sure your `config/secrets.yml` file has the needed section (it should be added by the generator automatically).
 1. Get your app ID and code from Here.com and set them as environment variables, as required by your `config/secrets.yml` file.
 1. If you had your Rails server running, restart it so the changes apply.
 
@@ -28,8 +28,8 @@ Once geocoding is configured, you'll need to activate it. As of April 2017, only
 
 ### Proposals
 
-In order to enable geocoding for proposals you'll need to edit the fature configuration and set the global flag to true. This works for that specific feature, so you can have geocoding enabled for meetings in a participatory process, and disabled for another one.
+In order to enable geocoding for proposals you'll need to edit the feature configuration and set the global flag to true. This works for that specific component, so you can have geocoding enabled for meetings in a participatory process, and disabled for another one.
 
 ### Meetings
 
-Meetings do not have a configuration option for geocoding. Instead, if geocoding is configured it will try to geocode the address every time you create or update a meeting.. As of April 2017 there's no way to enable or disable geocoding per meetings feature.
+Meetings do not have a configuration option for geocoding. Instead, if geocoding is configured it will try to geocode the address every time you create or update a meeting.. As of April 2017 there's no way to enable or disable geocoding per meetings component.

data/docs/services/social_providers.md

@@ -5,37 +5,37 @@ If you want to enable sign up through social providers like Facebook you will ne
 ## Facebook
 
 1. Navigate to [Facebook Developers Page](https://developers.facebook.com/)
-2. Follow the "Add a New App" link.
-3. Click the "Website" option.
-4. Fill in your application name and click "Create New Facebook App ID" button.
-5. Fill in the contact email info and category.
-6. Validate the captcha.
-7. Ignore the source code and fill in the URL field.
-8. Navigate to the application dashboard and copy the APP_ID and APP_SECRET
-9. Paste credentials in `config/secrets.yml`. Ensure the `enabled` attribute is `true`.
+1. Follow the "Add a New App" link.
+1. Click the "Website" option.
+1. Fill in your application name and click "Create New Facebook App ID" button.
+1. Fill in the contact email info and category.
+1. Validate the captcha.
+1. Ignore the source code and fill in the URL field.
+1. Navigate to the application dashboard and copy the APP_ID and APP_SECRET
+1. Paste credentials in `config/secrets.yml`. Ensure the `enabled` attribute is `true`.
 
 ## Twitter
 
 1. Navigate to [Twitter Developers Page](https://dev.twitter.com/)
-2. Follow the "My apps" link.
-3. Click the "Create New App" button.
-4. Fill in the `Name`, `Description` fields.
-5. Fill in the `Website` and `Callback URL` fields with the same value. If you are working on a development app you need to use `http://127.0.0.1:3000/` instead of `http://localhost:3000/`.
-5. Check the 'Developer Agreement' checkbox and click the 'Create your Twitter application' button.
-6. Navigate to the "Keys and Access Tokens" tab and copy the API_KEY and API_SECRET.
-8. (Optional) Navigate to the "Permissions" tab and check the "Request email addresses from users" checkbox.
-9. Paste credentials in `config/secrets.yml`. Ensure the `enabled` attribute is `true`.
+1. Follow the "My apps" link.
+1. Click the "Create New App" button.
+1. Fill in the `Name`, `Description` fields.
+1. Fill in the `Website` and `Callback URL` fields with the same value. If you are working on a development app you need to use `http://127.0.0.1:3000/` instead of `http://localhost:3000/`.
+1. Check the 'Developer Agreement' checkbox and click the 'Create your Twitter application' button.
+1. Navigate to the "Keys and Access Tokens" tab and copy the API_KEY and API_SECRET.
+1. (Optional) Navigate to the "Permissions" tab and check the "Request email addresses from users" checkbox.
+1. Paste credentials in `config/secrets.yml`. Ensure the `enabled` attribute is `true`.
 
 ## Google
 
 1. Navigate to [Google Developers Page](https://console.developers.google.com)
-2. Follow the 'Create projecte' link.
-3. Fill in the name of your app.
-4. Navigate to the projecte dashboard and click on "Enable API"
-5. Click on `Google+ API` and then "Enable"
-6. Navigate to the project credentials page and click on `OAuth consent screen`.
-7. Fill in the `Product name` field
-8. Click on `Credentials` tab and click on "Create credentials" button. Select `OAuth client ID`.
-9. Select `Web applications`. Fill in the `Authorized Javascript origins` with your url. Then fill in the `Authorized redirect URIs` with your url and append the path `/users/auth/google_oauth2/callback`.
-10. Copy the CLIENT_ID AND CLIENT_SECRET
-11. Paste credentials in `config/secrets.yml`. Ensure the `enabled` attribute is `true`.
+1. Follow the 'Create projecte' link.
+1. Fill in the name of your app.
+1. Navigate to the projecte dashboard and click on "Enable API"
+1. Click on `Google+ API` and then "Enable"
+1. Navigate to the project credentials page and click on `OAuth consent screen`.
+1. Fill in the `Product name` field
+1. Click on `Credentials` tab and click on "Create credentials" button. Select `OAuth client ID`.
+1. Select `Web applications`. Fill in the `Authorized Javascript origins` with your url. Then fill in the `Authorized redirect URIs` with your url and append the path `/users/auth/google_oauth2/callback`.
+1. Copy the CLIENT_ID AND CLIENT_SECRET
+1. Paste credentials in `config/secrets.yml`. Ensure the `enabled` attribute is `true`.

data/lib/decidim.rb

@@ -19,6 +19,8 @@ require "decidim/budgets"
 require "decidim/surveys"
 require "decidim/accountability"
 require "decidim/debates"
+require "decidim/sortitions"
+require "decidim/blogs"
 
 # Module declaration.
 module Decidim

data/lib/decidim/{component_manager.rb → gem_manager.rb}

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "open3"
+
 module Decidim
   #
   # Handles a decidim components.
@@ -15,7 +17,25 @@ module Decidim
   # * Updating version files from the main `.decidim-version` file in the root
   #   of the repository.
   #
-  class ComponentManager
+  class GemManager
+    PARTICIPATORY_SPACES = %w(
+      participatory_processes
+      assemblies
+      consultations
+    ).freeze
+
+    COMPONENTS = %w(
+      accountability
+      budgets
+      debates
+      meetings
+      pages
+      proposals
+      surveys
+      sortitions
+      blogs
+    ).freeze
+
     def initialize(dir)
       @dir = File.expand_path(dir)
     end
@@ -23,8 +43,7 @@ module Decidim
     def run(command, out: STDOUT)
       Dir.chdir(@dir) do
         command = command.gsub("%version", version).gsub("%name", name)
-        status = system(command, out: out)
-        abort unless status || ENV["FAIL_FAST"] == "false"
+        self.class.run(command, out: out)
       end
     end
 
@@ -43,6 +62,28 @@ module Decidim
     end
 
     class << self
+      def run(cmd, out: STDOUT)
+        output, status = Open3.capture2e(cmd)
+
+        STDOUT.puts output if out == STDOUT || !continue?(status)
+
+        abort unless continue?(status)
+
+        [output, status]
+      end
+
+      def continue?(status)
+        status.success? || ENV["FAIL_FAST"] == "false"
+      end
+
+      def test_participatory_space
+        new("decidim-#{PARTICIPATORY_SPACES.sample}").run("rake")
+      end
+
+      def test_component
+        new("decidim-#{COMPONENTS.sample}").run("rake")
+      end
+
       def replace_versions
         replace_file(
           "package.json",
@@ -76,7 +117,11 @@ module Decidim
       end
 
       def all_dirs(include_root: true)
-        Dir.glob(include_root ? "{decidim-*,.}" : "decidim-*")
+        root = File.expand_path(File.join("..", ".."), __dir__)
+
+        glob = "#{root}/#{include_root ? "{decidim-*,.}" : "decidim-*"}"
+
+        Dir.glob(glob)
            .select { |f| File.directory?(f) }
            .each { |dir| yield(dir) }
       end